Package com.seeq.api
Class NotificationConfigurationsApi
java.lang.Object
com.seeq.api.NotificationConfigurationsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Delete a notification configurationvoid
deleteNotificationConfigurationWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Delete a notification configurationvoid
Delete a notification configurationgetConditionNotifications
(List<String> creatorIds, String nameSearch, String workbookSearch, List<String> conditionIds, Boolean enabledFilter, Integer offset, Integer limit, String sortField, Boolean sortAsc) Get a list of condition notificationsgetConditionNotificationsWithHeadersAndHttpInfo
(List<String> creatorIds, String nameSearch, String workbookSearch, List<String> conditionIds, Boolean enabledFilter, Integer offset, Integer limit, String sortField, Boolean sortAsc, Map<String, String> customHeaders) Get a list of condition notificationsgetConditionNotificationsWithHttpInfo
(List<String> creatorIds, String nameSearch, String workbookSearch, List<String> conditionIds, Boolean enabledFilter, Integer offset, Integer limit, String sortField, Boolean sortAsc) Get a list of condition notificationsGet a notification configurationgetNotificationConfigurationWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get a notification configurationGet a notification configurationlong
void
setApiClient
(ApiClient apiClient) setNotificationConfigurationForConditionMonitor
(String id, ConditionMonitorNotificationConfigurationInputV1 body) Create or update a notification configuration on a condition monitorsetNotificationConfigurationForConditionMonitorWithHeadersAndHttpInfo
(String id, ConditionMonitorNotificationConfigurationInputV1 body, Map<String, String> customHeaders) Create or update a notification configuration on a condition monitorsetNotificationConfigurationForConditionMonitorWithHttpInfo
(String id, ConditionMonitorNotificationConfigurationInputV1 body) Create or update a notification configuration on a condition monitorCreate or update a notification configuration on a reportsetNotificationConfigurationForReportWithHeadersAndHttpInfo
(String id, ReportNotificationConfigurationInputV1 body, Map<String, String> customHeaders) Create or update a notification configuration on a reportsetNotificationConfigurationForReportWithHttpInfo
(String id, ReportNotificationConfigurationInputV1 body) Create or update a notification configuration on a reportvoid
setRetryTimeout
(long retryTimeout) void
Unsubscribe the current user from the notification on the specified itemvoid
unsubscribeFromItemWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Unsubscribe the current user from the notification on the specified itemvoid
Unsubscribe the current user from the notification on the specified item
-
Constructor Details
-
NotificationConfigurationsApi
public NotificationConfigurationsApi() -
NotificationConfigurationsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
deleteNotificationConfiguration
Delete a notification configuration- Parameters:
id
- The Seeq ID of the notifiable item (required)- Throws:
ApiException
- if fails to make API call
-
deleteNotificationConfigurationWithHttpInfo
Delete a notification configuration- Parameters:
id
- The Seeq ID of the notifiable item (required)- Throws:
ApiException
- if fails to make API call
-
deleteNotificationConfigurationWithHeadersAndHttpInfo
public void deleteNotificationConfigurationWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionDelete a notification configuration- Parameters:
id
- The Seeq ID of the notifiable item (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getConditionNotifications
public ConditionNotificationOutputListV1 getConditionNotifications(List<String> creatorIds, String nameSearch, String workbookSearch, List<String> conditionIds, Boolean enabledFilter, Integer offset, Integer limit, String sortField, Boolean sortAsc) throws ApiException Get a list of condition notifications- Parameters:
creatorIds
- Filter items to only those created by the specified user IDs (optional)nameSearch
- Filter the items to those whose name match any part of the specified string (optional)workbookSearch
- Filter the items to those whose condition are scoped to workbooks that match any part of the specified string (optional)conditionIds
- Filter items to only those that are monitoring one of the specified conditions as specified by the list of IDs (optional)enabledFilter
- Filter items by their enabled status (optional)offset
- Whether to filter items to only users who are enabled. (optional, default to 0)limit
- The pagination limit, the total number of items that will be returned in this page of results (optional, default to 40)sortField
- Order the items by either name or createdAt (optional, default to Name)sortAsc
- Sorts the sort field in ascending order when true and descending when false (optional, default to true)- Returns:
- ConditionNotificationOutputListV1
- Throws:
ApiException
- if fails to make API call
-
getConditionNotificationsWithHttpInfo
public ApiClient.ApiResponse<ConditionNotificationOutputListV1> getConditionNotificationsWithHttpInfo(List<String> creatorIds, String nameSearch, String workbookSearch, List<String> conditionIds, Boolean enabledFilter, Integer offset, Integer limit, String sortField, Boolean sortAsc) throws ApiException Get a list of condition notifications- Parameters:
creatorIds
- Filter items to only those created by the specified user IDs (optional)nameSearch
- Filter the items to those whose name match any part of the specified string (optional)workbookSearch
- Filter the items to those whose condition are scoped to workbooks that match any part of the specified string (optional)conditionIds
- Filter items to only those that are monitoring one of the specified conditions as specified by the list of IDs (optional)enabledFilter
- Filter items by their enabled status (optional)offset
- Whether to filter items to only users who are enabled. (optional, default to 0)limit
- The pagination limit, the total number of items that will be returned in this page of results (optional, default to 40)sortField
- Order the items by either name or createdAt (optional, default to Name)sortAsc
- Sorts the sort field in ascending order when true and descending when false (optional, default to true)- Throws:
ApiException
- if fails to make API call
-
getConditionNotificationsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<ConditionNotificationOutputListV1> getConditionNotificationsWithHeadersAndHttpInfo(List<String> creatorIds, String nameSearch, String workbookSearch, List<String> conditionIds, Boolean enabledFilter, Integer offset, Integer limit, String sortField, Boolean sortAsc, Map<String, String> customHeaders) throws ApiExceptionGet a list of condition notifications- Parameters:
creatorIds
- Filter items to only those created by the specified user IDs (optional)nameSearch
- Filter the items to those whose name match any part of the specified string (optional)workbookSearch
- Filter the items to those whose condition are scoped to workbooks that match any part of the specified string (optional)conditionIds
- Filter items to only those that are monitoring one of the specified conditions as specified by the list of IDs (optional)enabledFilter
- Filter items by their enabled status (optional)offset
- Whether to filter items to only users who are enabled. (optional, default to 0)limit
- The pagination limit, the total number of items that will be returned in this page of results (optional, default to 40)sortField
- Order the items by either name or createdAt (optional, default to Name)sortAsc
- Sorts the sort field in ascending order when true and descending when false (optional, default to true)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getNotificationConfiguration
public NotificationConfigurationOutputV1 getNotificationConfiguration(String id) throws ApiException Get a notification configuration- Parameters:
id
- The Seeq ID of the notifiable item (required)- Returns:
- NotificationConfigurationOutputV1
- Throws:
ApiException
- if fails to make API call
-
getNotificationConfigurationWithHttpInfo
public ApiClient.ApiResponse<NotificationConfigurationOutputV1> getNotificationConfigurationWithHttpInfo(String id) throws ApiException Get a notification configuration- Parameters:
id
- The Seeq ID of the notifiable item (required)- Throws:
ApiException
- if fails to make API call
-
getNotificationConfigurationWithHeadersAndHttpInfo
public ApiClient.ApiResponse<NotificationConfigurationOutputV1> getNotificationConfigurationWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet a notification configuration- Parameters:
id
- The Seeq ID of the notifiable item (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
setNotificationConfigurationForConditionMonitor
public NotificationConfigurationOutputV1 setNotificationConfigurationForConditionMonitor(String id, ConditionMonitorNotificationConfigurationInputV1 body) throws ApiException Create or update a notification configuration on a condition monitor- Parameters:
id
- The Seeq ID of the condition monitor (required)body
- (required)- Returns:
- NotificationConfigurationOutputV1
- Throws:
ApiException
- if fails to make API call
-
setNotificationConfigurationForConditionMonitorWithHttpInfo
public ApiClient.ApiResponse<NotificationConfigurationOutputV1> setNotificationConfigurationForConditionMonitorWithHttpInfo(String id, ConditionMonitorNotificationConfigurationInputV1 body) throws ApiException Create or update a notification configuration on a condition monitor- Parameters:
id
- The Seeq ID of the condition monitor (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
setNotificationConfigurationForConditionMonitorWithHeadersAndHttpInfo
public ApiClient.ApiResponse<NotificationConfigurationOutputV1> setNotificationConfigurationForConditionMonitorWithHeadersAndHttpInfo(String id, ConditionMonitorNotificationConfigurationInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update a notification configuration on a condition monitor- Parameters:
id
- The Seeq ID of the condition monitor (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
setNotificationConfigurationForReport
public NotificationConfigurationOutputV1 setNotificationConfigurationForReport(String id, ReportNotificationConfigurationInputV1 body) throws ApiException Create or update a notification configuration on a report- Parameters:
id
- The Seeq ID of the report (required)body
- (required)- Returns:
- NotificationConfigurationOutputV1
- Throws:
ApiException
- if fails to make API call
-
setNotificationConfigurationForReportWithHttpInfo
public ApiClient.ApiResponse<NotificationConfigurationOutputV1> setNotificationConfigurationForReportWithHttpInfo(String id, ReportNotificationConfigurationInputV1 body) throws ApiException Create or update a notification configuration on a report- Parameters:
id
- The Seeq ID of the report (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
setNotificationConfigurationForReportWithHeadersAndHttpInfo
public ApiClient.ApiResponse<NotificationConfigurationOutputV1> setNotificationConfigurationForReportWithHeadersAndHttpInfo(String id, ReportNotificationConfigurationInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate or update a notification configuration on a report- Parameters:
id
- The Seeq ID of the report (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
unsubscribeFromItem
Unsubscribe the current user from the notification on the specified item- Parameters:
id
- The ID of the item to unsubscribe from (required)- Throws:
ApiException
- if fails to make API call
-
unsubscribeFromItemWithHttpInfo
Unsubscribe the current user from the notification on the specified item- Parameters:
id
- The ID of the item to unsubscribe from (required)- Throws:
ApiException
- if fails to make API call
-
unsubscribeFromItemWithHeadersAndHttpInfo
public void unsubscribeFromItemWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionUnsubscribe the current user from the notification on the specified item- Parameters:
id
- The ID of the item to unsubscribe from (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-