Package com.seeq.api

Class DisplayTemplatesApi

java.lang.Object
com.seeq.api.DisplayTemplatesApi

public class DisplayTemplatesApi extends Object
  • Constructor Details

    • DisplayTemplatesApi

      public DisplayTemplatesApi()
    • DisplayTemplatesApi

      public DisplayTemplatesApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • archiveDisplayTemplate

      public void archiveDisplayTemplate(String id) throws ApiException
      Archive a display template
      Parameters:
      id - ID of the display template to archive. (required)
      Throws:
      ApiException - if fails to make API call
    • archiveDisplayTemplateWithHttpInfo

      public void archiveDisplayTemplateWithHttpInfo(String id) throws ApiException
      Archive a display template
      Parameters:
      id - ID of the display template to archive. (required)
      Throws:
      ApiException - if fails to make API call
    • archiveDisplayTemplateWithHeadersAndHttpInfo

      public void archiveDisplayTemplateWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Archive a display template
      Parameters:
      id - ID of the display template to archive. (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createDisplayTemplate

      public DisplayTemplateOutputV1 createDisplayTemplate(DisplayTemplateInputV1 body) throws ApiException
      Create a new template item for a display
      Parameters:
      body - (required)
      Returns:
      DisplayTemplateOutputV1
      Throws:
      ApiException - if fails to make API call
    • createDisplayTemplateWithHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputV1> createDisplayTemplateWithHttpInfo(DisplayTemplateInputV1 body) throws ApiException
      Create a new template item for a display
      Parameters:
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • createDisplayTemplateWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputV1> createDisplayTemplateWithHeadersAndHttpInfo(DisplayTemplateInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a new template item for a display
      Parameters:
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getDisplayTemplate

      public DisplayTemplateOutputV1 getDisplayTemplate(String id) throws ApiException
      Get a display template item
      Parameters:
      id - The Seeq ID for the display template (required)
      Returns:
      DisplayTemplateOutputV1
      Throws:
      ApiException - if fails to make API call
    • getDisplayTemplateWithHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputV1> getDisplayTemplateWithHttpInfo(String id) throws ApiException
      Get a display template item
      Parameters:
      id - The Seeq ID for the display template (required)
      Throws:
      ApiException - if fails to make API call
    • getDisplayTemplateWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputV1> getDisplayTemplateWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get a display template item
      Parameters:
      id - The Seeq ID for the display template (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getDisplayTemplates

      public DisplayTemplateOutputListV1 getDisplayTemplates(Integer offset, Integer limit) throws ApiException
      Get a list of display template items
      Parameters:
      offset - The pagination offset, the index of the first display template item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of display template items that will be returned in this page of results (optional, default to 40)
      Returns:
      DisplayTemplateOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getDisplayTemplatesWithHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputListV1> getDisplayTemplatesWithHttpInfo(Integer offset, Integer limit) throws ApiException
      Get a list of display template items
      Parameters:
      offset - The pagination offset, the index of the first display template item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of display template items that will be returned in this page of results (optional, default to 40)
      Throws:
      ApiException - if fails to make API call
    • getDisplayTemplatesWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputListV1> getDisplayTemplatesWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a list of display template items
      Parameters:
      offset - The pagination offset, the index of the first display template item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of display template items that will be returned in this page of results (optional, default to 40)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateTemplate

      public DisplayTemplateOutputV1 updateTemplate(String id, DisplayTemplateInputV1 body) throws ApiException
      Update a template item for a display
      Parameters:
      id - The Seeq ID for the display template (required)
      body - (required)
      Returns:
      DisplayTemplateOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateTemplateWithHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputV1> updateTemplateWithHttpInfo(String id, DisplayTemplateInputV1 body) throws ApiException
      Update a template item for a display
      Parameters:
      id - The Seeq ID for the display template (required)
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • updateTemplateWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<DisplayTemplateOutputV1> updateTemplateWithHeadersAndHttpInfo(String id, DisplayTemplateInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a template item for a display
      Parameters:
      id - The Seeq ID for the display template (required)
      body - (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call