Package com.seeq.api
Class DisplaysApi
java.lang.Object
com.seeq.api.DisplaysApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
archiveDisplay
(String id) Archive a display itemvoid
archiveDisplayWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive a display itemvoid
Archive a display itemcreateDisplay
(DisplayInputV1 body) Create a new display itemcreateDisplayWithHeadersAndHttpInfo
(DisplayInputV1 body, Map<String, String> customHeaders) Create a new display itemCreate a new display itemgetDisplay
(String id) Get a display itemgetDisplays
(Integer offset, Integer limit) Get a list of display itemsGet a list of display itemsgetDisplaysWithHttpInfo
(Integer offset, Integer limit) Get a list of display itemsgetDisplayWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a display itemGet a display itemlong
void
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) updateDisplay
(String id, DisplayInputV1 body) Update a displayupdateDisplayWithHeadersAndHttpInfo
(String id, DisplayInputV1 body, Map<String, String> customHeaders) Update a displayupdateDisplayWithHttpInfo
(String id, DisplayInputV1 body) Update a display
-
Constructor Details
-
DisplaysApi
public DisplaysApi() -
DisplaysApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveDisplay
Archive a display item- Parameters:
id
- ID of the display item to archive. (required)- Throws:
ApiException
- if fails to make API call
-
archiveDisplayWithHttpInfo
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 ApiExceptionArchive 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
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 ApiExceptionCreate 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
Get a display item- Parameters:
id
- The Seeq ID for the display (required)- Returns:
- DisplayOutputV1
- Throws:
ApiException
- if fails to make API call
-
getDisplayWithHttpInfo
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 ApiExceptionGet 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
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 ApiExceptionGet 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
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 ApiExceptionUpdate 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
-