Interface NotificationService
-
- All Implemented Interfaces:
public interface NotificationService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceNotificationService.WithRawResponseA view of NotificationService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract NotificationService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract NotificationService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
draft
abstract DraftService draft()
-
checks
abstract CheckService checks()
-
create
NotificationTemplateMutationResponse create(NotificationCreateParams params)
Create a notification template. Requires all fields in the notification object. Templates are created in draft state by default.
-
create
abstract NotificationTemplateMutationResponse create(NotificationCreateParams params, RequestOptions requestOptions)
-
create
NotificationTemplateMutationResponse create(NotificationTemplateCreateRequest notificationTemplateCreateRequest, RequestOptions requestOptions)
-
create
NotificationTemplateMutationResponse create(NotificationTemplateCreateRequest notificationTemplateCreateRequest)
-
retrieve
NotificationTemplateGetResponse retrieve(String id)
Retrieve a notification template by ID. Returns the published version by default. Pass version=draft to retrieve an unpublished template.
-
retrieve
NotificationTemplateGetResponse retrieve(String id, NotificationRetrieveParams params, RequestOptions requestOptions)
-
retrieve
NotificationTemplateGetResponse retrieve(String id, NotificationRetrieveParams params)
-
retrieve
abstract NotificationTemplateGetResponse retrieve(NotificationRetrieveParams params, RequestOptions requestOptions)
-
retrieve
NotificationTemplateGetResponse retrieve(NotificationRetrieveParams params)
-
retrieve
NotificationTemplateGetResponse retrieve(String id, RequestOptions requestOptions)
-
list
NotificationListResponse list()
List notification templates in your workspace.
-
list
abstract NotificationListResponse list(NotificationListParams params, RequestOptions requestOptions)
-
list
NotificationListResponse list(NotificationListParams params)
-
list
NotificationListResponse list(RequestOptions requestOptions)
-
archive
Unit archive(String id, NotificationArchiveParams params, RequestOptions requestOptions)
-
archive
Unit archive(String id, NotificationArchiveParams params)
-
archive
abstract Unit archive(NotificationArchiveParams params, RequestOptions requestOptions)
-
archive
Unit archive(NotificationArchiveParams params)
-
archive
Unit archive(String id, RequestOptions requestOptions)
-
listVersions
NotificationTemplateVersionListResponse listVersions(String id)
List versions of a notification template.
-
listVersions
NotificationTemplateVersionListResponse listVersions(String id, NotificationListVersionsParams params, RequestOptions requestOptions)
-
listVersions
NotificationTemplateVersionListResponse listVersions(String id, NotificationListVersionsParams params)
-
listVersions
abstract NotificationTemplateVersionListResponse listVersions(NotificationListVersionsParams params, RequestOptions requestOptions)
-
listVersions
NotificationTemplateVersionListResponse listVersions(NotificationListVersionsParams params)
-
listVersions
NotificationTemplateVersionListResponse listVersions(String id, RequestOptions requestOptions)
-
publish
Unit publish(String id)
Publish a notification template. Publishes the current draft by default. Pass a version in the request body to publish a specific historical version.
-
publish
Unit publish(String id, NotificationPublishParams params, RequestOptions requestOptions)
-
publish
Unit publish(String id, NotificationPublishParams params)
-
publish
abstract Unit publish(NotificationPublishParams params, RequestOptions requestOptions)
-
publish
Unit publish(NotificationPublishParams params)
-
publish
Unit publish(String id, RequestOptions requestOptions)
-
replace
NotificationTemplateMutationResponse replace(String id, NotificationReplaceParams params)
Replace a notification template. All fields are required.
-
replace
NotificationTemplateMutationResponse replace(String id, NotificationReplaceParams params, RequestOptions requestOptions)
-
replace
NotificationTemplateMutationResponse replace(NotificationReplaceParams params)
-
replace
abstract NotificationTemplateMutationResponse replace(NotificationReplaceParams params, RequestOptions requestOptions)
-
retrieveContent
NotificationGetContent retrieveContent(String id)
-
retrieveContent
NotificationGetContent retrieveContent(String id, NotificationRetrieveContentParams params, RequestOptions requestOptions)
-
retrieveContent
NotificationGetContent retrieveContent(String id, NotificationRetrieveContentParams params)
-
retrieveContent
abstract NotificationGetContent retrieveContent(NotificationRetrieveContentParams params, RequestOptions requestOptions)
-
retrieveContent
NotificationGetContent retrieveContent(NotificationRetrieveContentParams params)
-
retrieveContent
NotificationGetContent retrieveContent(String id, RequestOptions requestOptions)
-
-
-
-