Constructor Detail

• TemplatesApi

  TemplatesApi()

• TemplatesApi

  TemplatesApi(ApiClient apiClient)

Method Detail

• getApiClient

   ApiClient getApiClient()

• setApiClient

   void setApiClient(ApiClient apiClient)

• createTemplate

   Template createTemplate(EnumTemplateType type, String systemName, String title, String path, String draft, Long sectionId, String layoutName, Long layoutId, Boolean liquidEnabled, EnumHandler handler, String contentType)

  Create Template Create template with the 3scale CMS

  Parameters:

  type - (required)

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

  title - (optional)

  path - (optional)

  draft - (optional)

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

  layoutName - (optional)

  layoutId - (optional)

  liquidEnabled - (optional)

  handler - (optional)

  contentType - (optional)

  Returns:

  Template

• createTemplate

   Template createTemplate(EnumTemplateType type, String systemName, String title, String path, String draft, Long sectionId, String layoutName, Long layoutId, Boolean liquidEnabled, EnumHandler handler, String contentType, Map<String, String> additionalHeaders)

  Create Template Create template with the 3scale CMS

  Parameters:

  type - (required)

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

  title - (optional)

  path - (optional)

  draft - (optional)

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

  layoutName - (optional)

  layoutId - (optional)

  liquidEnabled - (optional)

  handler - (optional)

  contentType - (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Template

• deleteTemplate

   void deleteTemplate(Long templateId)

  Delete Template Delete a template from 3scale CMS

  Parameters:

  templateId - (required)

• deleteTemplate

   void deleteTemplate(Long templateId, Map<String, String> additionalHeaders)

  Delete Template Delete a template from 3scale CMS

  Parameters:

  templateId - (required)

  additionalHeaders - additionalHeaders for this call

• getTemplate

   Template getTemplate(Long templateId)

  Get Template Retrieve a template of any kind from 3scale (TODO: double-check response)

  Parameters:

  templateId - (required)

  Returns:

  Template

• getTemplate

   Template getTemplate(Long templateId, Map<String, String> additionalHeaders)

  Get Template Retrieve a template of any kind from 3scale (TODO: double-check response)

  Parameters:

  templateId - (required)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Template

• listTemplates

   TemplateList listTemplates(Integer page, Integer perPage, Boolean content)

  List Templates List all templates contained in 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)

  content - Whether to include the draft and published content in listed templates (optional)

  Returns:

  TemplateList

• listTemplates

   TemplateList listTemplates(Integer page, Integer perPage, Boolean content, Map<String, String> additionalHeaders)

  List Templates List all templates contained in 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)

  content - Whether to include the draft and published content in listed templates (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  TemplateList

• publishTemplate

   Template publishTemplate(Long templateId)

  Publish Template Move a template draft to be \"published\"

  Parameters:

  templateId - (required)

  Returns:

  Template

• publishTemplate

   Template publishTemplate(Long templateId, Map<String, String> additionalHeaders)

  Publish Template Move a template draft to be \"published\"

  Parameters:

  templateId - (required)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Template

• updateTemplate

   Template updateTemplate(Long templateId, String systemName, String title, String path, String draft, Long sectionId, String layoutName, Long layoutId, Boolean liquidEnabled, EnumHandler handler, String contentType)

  Update Template Update a template draft (TODO: double-check response)

  Parameters:

  templateId - (required)

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

  title - (optional)

  path - (optional)

  draft - (optional)

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

  layoutName - (optional)

  layoutId - (optional)

  liquidEnabled - (optional)

  handler - (optional)

  contentType - (optional)

  Returns:

  Template

• updateTemplate

   Template updateTemplate(Long templateId, String systemName, String title, String path, String draft, Long sectionId, String layoutName, Long layoutId, Boolean liquidEnabled, EnumHandler handler, String contentType, Map<String, String> additionalHeaders)

  Update Template Update a template draft (TODO: double-check response)

  Parameters:

  templateId - (required)

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

  title - (optional)

  path - (optional)

  draft - (optional)

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

  layoutName - (optional)

  layoutId - (optional)

  liquidEnabled - (optional)

  handler - (optional)

  contentType - (optional)

  additionalHeaders - additionalHeaders for this call

  Returns:

  Template