Constructor Detail

• SectionsApi

  SectionsApi()

• SectionsApi

  SectionsApi(ApiClient apiClient)

Method Detail

• getApiClient

   ApiClient getApiClient()

• setApiClient

   void setApiClient(ApiClient apiClient)

• createSection

   Section createSection(Boolean _public, String title, Long parentId, String partialPath, String systemName)

  Create Section Create section within the 3scale CMS

  Parameters:

  _public - Whether the section is viewable by users not logged in (optional)

  title - Title of the section; must be unique within parent section.

  parentId - Unique identifier for a `Section` (optional)

  partialPath - (optional)

  systemName - Unique name for an object in 3scale CMS (optional)

  Returns:

  Section

• createSection

   Section createSection(Boolean _public, String title, Long parentId, String partialPath, String systemName, Map<String, String> additionalHeaders)

  Create Section Create section within the 3scale CMS

  Parameters:

  _public - Whether the section is viewable by users not logged in (optional)

  title - Title of the section; must be unique within parent section.

  parentId - Unique identifier for a `Section` (optional)

  partialPath - (optional)

  systemName - Unique name for an object in 3scale CMS (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Section

• deleteSection

   void deleteSection(Long sectionId)

  Delete Section Delete a section from 3scale CMS

  Parameters:

  sectionId - (required)

• deleteSection

   void deleteSection(Long sectionId, Map<String, String> additionalHeaders)

  Delete Section Delete a section from 3scale CMS

  Parameters:

  sectionId - (required)

  additionalHeaders - additionalHeaders for this call

• deleteSectionBySystemName

   void deleteSectionBySystemName(String systemName)

  Delete Section by System Name Delete a section from 3scale CMS

  Parameters:

  systemName - (required)

• deleteSectionBySystemName

   void deleteSectionBySystemName(String systemName, Map<String, String> additionalHeaders)

  Delete Section by System Name Delete a section from 3scale CMS

  Parameters:

  systemName - (required)

  additionalHeaders - additionalHeaders for this call

• getSection

   Section getSection(Long sectionId)

  Get Section Get section descriptor

  Parameters:

  sectionId - (required)

  Returns:

  Section

• getSection

   Section getSection(Long sectionId, Map<String, String> additionalHeaders)

  Get Section Get section descriptor

  Parameters:

  sectionId - (required)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Section

• getSectionBySystemName

   Section getSectionBySystemName(String systemName)

  Get Section by System Name Get section descriptor

  Parameters:

  systemName - (required)

  Returns:

  Section

• getSectionBySystemName

   Section getSectionBySystemName(String systemName, Map<String, String> additionalHeaders)

  Get Section by System Name Get section descriptor

  Parameters:

  systemName - (required)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Section

• listSections

   SectionList listSections(Integer page, Integer perPage)

  List Sections List sections held within the 3scale CMS

  Parameters:

  page - The number for the page of results to retrieve, starting from page 1; defaults to 1 (optional, default to 1)

  perPage - The number of items to retrieve per page of results; defaults to 20 (optional, default to 20)

  Returns:

  SectionList

• listSections

   SectionList listSections(Integer page, Integer perPage, Map<String, String> additionalHeaders)

  List Sections List sections held within the 3scale CMS

  Parameters:

  page - The number for the page of results to retrieve, starting from page 1; defaults to 1 (optional, default to 1)

  perPage - The number of items to retrieve per page of results; defaults to 20 (optional, default to 20)

  additionalHeaders - additionalHeaders for this call

  Returns:

  SectionList

• updateSection

   Section updateSection(Long sectionId, Boolean _public, String title, Long parentId)

  Update Section Update section descriptor

  Parameters:

  sectionId - (required)

  _public - Whether the section is viewable by users not logged in (optional)

  title - Title of the section; must be unique within parent section.

  parentId - Unique identifier for a `Section` (optional)

  Returns:

  Section

• updateSection

   Section updateSection(Long sectionId, Boolean _public, String title, Long parentId, Map<String, String> additionalHeaders)

  Update Section Update section descriptor

  Parameters:

  sectionId - (required)

  _public - Whether the section is viewable by users not logged in (optional)

  title - Title of the section; must be unique within parent section.

  parentId - Unique identifier for a `Section` (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Section

• updateSectionBySystemName

   Section updateSectionBySystemName(String systemName, Boolean _public, String title, Long parentId)

  Update Section by System Name Update section descriptor

  Parameters:

  systemName - (required)

  _public - Whether the section is viewable by users not logged in (optional)

  title - Title of the section; must be unique within parent section.

  parentId - Unique identifier for a `Section` (optional)

  Returns:

  Section

• updateSectionBySystemName

   Section updateSectionBySystemName(String systemName, Boolean _public, String title, Long parentId, Map<String, String> additionalHeaders)

  Update Section by System Name Update section descriptor

  Parameters:

  systemName - (required)

  _public - Whether the section is viewable by users not logged in (optional)

  title - Title of the section; must be unique within parent section.

  parentId - Unique identifier for a `Section` (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Section