Package com.seeq.api

Class DisplaysApi

java.lang.Object
com.seeq.api.DisplaysApi

public class DisplaysApi extends Object
  • Constructor Details

    • DisplaysApi

      public DisplaysApi()
    • DisplaysApi

      public DisplaysApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • archiveDisplay

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

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

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

      public DisplayOutputV1 createDisplay(DisplayInputV1 body) throws ApiException
      Create a new display item
      Parameters:
      body - (required)
      Returns:
      DisplayOutputV1
      Throws:
      ApiException - if fails to make API call
    • createDisplayWithHttpInfo

      public ApiClient.ApiResponse<DisplayOutputV1> createDisplayWithHttpInfo(DisplayInputV1 body) throws ApiException
      Create a new display item
      Parameters:
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • createDisplayWithHeadersAndHttpInfo

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

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

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

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

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

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

      public ApiClient.ApiResponse<DisplayOutputListV1> getDisplaysWithHeadersAndHttpInfo(Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a list of display items
      Parameters:
      offset - The pagination offset, the index of the first display item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of display 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
    • updateDisplay

      public DisplayOutputV1 updateDisplay(String id, DisplayInputV1 body) throws ApiException
      Update a display
      Parameters:
      id - The Seeq ID for the display (required)
      body - (required)
      Returns:
      DisplayOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateDisplayWithHttpInfo

      public ApiClient.ApiResponse<DisplayOutputV1> updateDisplayWithHttpInfo(String id, DisplayInputV1 body) throws ApiException
      Update a display
      Parameters:
      id - The Seeq ID for the display (required)
      body - (required)
      Throws:
      ApiException - if fails to make API call
    • updateDisplayWithHeadersAndHttpInfo

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