Constructor Detail

Method Detail

• withRawResponse

   abstract NotificationServiceAsync.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract NotificationServiceAsync withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• checks

   abstract CheckServiceAsync checks()

• create

   CompletableFuture<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 CompletableFuture<NotificationTemplateMutationResponse> create(NotificationCreateParams params, RequestOptions requestOptions)

• create

   CompletableFuture<NotificationTemplateMutationResponse> create(NotificationTemplateCreateRequest notificationTemplateCreateRequest, RequestOptions requestOptions)

• create

   CompletableFuture<NotificationTemplateMutationResponse> create(NotificationTemplateCreateRequest notificationTemplateCreateRequest)

• retrieve

   CompletableFuture<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

   CompletableFuture<NotificationTemplateGetResponse> retrieve(String id, NotificationRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<NotificationTemplateGetResponse> retrieve(String id, NotificationRetrieveParams params)

• retrieve

   abstract CompletableFuture<NotificationTemplateGetResponse> retrieve(NotificationRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompletableFuture<NotificationTemplateGetResponse> retrieve(NotificationRetrieveParams params)

• retrieve

   CompletableFuture<NotificationTemplateGetResponse> retrieve(String id, RequestOptions requestOptions)

• list

   CompletableFuture<NotificationListResponse> list()

  List notification templates in your workspace.

• list

   abstract CompletableFuture<NotificationListResponse> list(NotificationListParams params, RequestOptions requestOptions)

• list

   CompletableFuture<NotificationListResponse> list(NotificationListParams params)

• list

   CompletableFuture<NotificationListResponse> list(RequestOptions requestOptions)

• archive

   CompletableFuture<Void> archive(String id)

  Archive a notification template.

• archive

   CompletableFuture<Void> archive(String id, NotificationArchiveParams params, RequestOptions requestOptions)

• archive

   CompletableFuture<Void> archive(String id, NotificationArchiveParams params)

• archive

   abstract CompletableFuture<Void> archive(NotificationArchiveParams params, RequestOptions requestOptions)

• archive

   CompletableFuture<Void> archive(NotificationArchiveParams params)

• archive

   CompletableFuture<Void> archive(String id, RequestOptions requestOptions)

• listVersions

   CompletableFuture<NotificationTemplateVersionListResponse> listVersions(String id)

  List versions of a notification template.

• listVersions

   CompletableFuture<NotificationTemplateVersionListResponse> listVersions(String id, NotificationListVersionsParams params, RequestOptions requestOptions)

• listVersions

   CompletableFuture<NotificationTemplateVersionListResponse> listVersions(String id, NotificationListVersionsParams params)

• listVersions

   abstract CompletableFuture<NotificationTemplateVersionListResponse> listVersions(NotificationListVersionsParams params, RequestOptions requestOptions)

• listVersions

   CompletableFuture<NotificationTemplateVersionListResponse> listVersions(NotificationListVersionsParams params)

• listVersions

   CompletableFuture<NotificationTemplateVersionListResponse> listVersions(String id, RequestOptions requestOptions)

• publish

   CompletableFuture<Void> 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

   CompletableFuture<Void> publish(String id, NotificationPublishParams params, RequestOptions requestOptions)

• publish

   CompletableFuture<Void> publish(String id, NotificationPublishParams params)

• publish

   abstract CompletableFuture<Void> publish(NotificationPublishParams params, RequestOptions requestOptions)

• publish

   CompletableFuture<Void> publish(NotificationPublishParams params)

• publish

   CompletableFuture<Void> publish(String id, RequestOptions requestOptions)

• putContent

   CompletableFuture<NotificationContentMutationResponse> putContent(String id, NotificationPutContentParams params)

  Replace the elemental content of a notification template. Overwrites all elements in the template with the provided content. Only supported for V2 (elemental) templates.

• putContent

   CompletableFuture<NotificationContentMutationResponse> putContent(String id, NotificationPutContentParams params, RequestOptions requestOptions)

• putContent

   CompletableFuture<NotificationContentMutationResponse> putContent(NotificationPutContentParams params)

• putContent

   abstract CompletableFuture<NotificationContentMutationResponse> putContent(NotificationPutContentParams params, RequestOptions requestOptions)

• putElement

   CompletableFuture<NotificationContentMutationResponse> putElement(String elementId, NotificationPutElementParams params)

  Update a single element within a notification template. Only supported for V2 (elemental) templates.

• putElement

   CompletableFuture<NotificationContentMutationResponse> putElement(String elementId, NotificationPutElementParams params, RequestOptions requestOptions)

• putElement

   CompletableFuture<NotificationContentMutationResponse> putElement(NotificationPutElementParams params)

• putElement

   abstract CompletableFuture<NotificationContentMutationResponse> putElement(NotificationPutElementParams params, RequestOptions requestOptions)

• putLocale

   CompletableFuture<NotificationContentMutationResponse> putLocale(String localeId, NotificationPutLocaleParams params)

  Set locale-specific content overrides for a notification template. Each element override must reference an existing element by ID. Only supported for V2 (elemental) templates.

• putLocale

   CompletableFuture<NotificationContentMutationResponse> putLocale(String localeId, NotificationPutLocaleParams params, RequestOptions requestOptions)

• putLocale

   CompletableFuture<NotificationContentMutationResponse> putLocale(NotificationPutLocaleParams params)

• putLocale

   abstract CompletableFuture<NotificationContentMutationResponse> putLocale(NotificationPutLocaleParams params, RequestOptions requestOptions)

• replace

   CompletableFuture<NotificationTemplateMutationResponse> replace(String id, NotificationReplaceParams params)

  Replace a notification template. All fields are required.

• replace

   CompletableFuture<NotificationTemplateMutationResponse> replace(String id, NotificationReplaceParams params, RequestOptions requestOptions)

• replace

   CompletableFuture<NotificationTemplateMutationResponse> replace(NotificationReplaceParams params)

• replace

   abstract CompletableFuture<NotificationTemplateMutationResponse> replace(NotificationReplaceParams params, RequestOptions requestOptions)

• retrieveContent

   CompletableFuture<NotificationRetrieveContentResponse> retrieveContent(String id)

  Retrieve the content of a notification template. The response shape depends on whether the template uses V1 (blocks/channels) or V2 (elemental) content. Use the version query parameter to select draft, published, or a specific historical version.

• retrieveContent

   CompletableFuture<NotificationRetrieveContentResponse> retrieveContent(String id, NotificationRetrieveContentParams params, RequestOptions requestOptions)

• retrieveContent

   CompletableFuture<NotificationRetrieveContentResponse> retrieveContent(String id, NotificationRetrieveContentParams params)

• retrieveContent

   abstract CompletableFuture<NotificationRetrieveContentResponse> retrieveContent(NotificationRetrieveContentParams params, RequestOptions requestOptions)

• retrieveContent

   CompletableFuture<NotificationRetrieveContentResponse> retrieveContent(NotificationRetrieveContentParams params)

• retrieveContent

   CompletableFuture<NotificationRetrieveContentResponse> retrieveContent(String id, RequestOptions requestOptions)