Interface TemplateService
-
- All Implemented Interfaces:
public interface TemplateService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceTemplateService.WithRawResponseA view of TemplateService that provides access to raw HTTP responses for each method.
-
Method Summary
-
-
Method Detail
-
withRawResponse
abstract TemplateService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
withOptions
abstract TemplateService withOptions(Consumer<ClientOptions.Builder> modifier)
Returns a view of this service with the given option modifications applied.
The original service is not modified.
-
create
JourneyTemplateGetResponse create(String templateId, TemplateCreateParams params)
Create a notification template scoped to this journey. Defaults to
DRAFTstate; passstate: "PUBLISHED"to publish on create.
-
create
JourneyTemplateGetResponse create(String templateId, TemplateCreateParams params, RequestOptions requestOptions)
-
create
JourneyTemplateGetResponse create(TemplateCreateParams params)
-
create
abstract JourneyTemplateGetResponse create(TemplateCreateParams params, RequestOptions requestOptions)
-
retrieve
JourneyTemplateGetResponse retrieve(String notificationId, TemplateRetrieveParams params)
Fetch a journey-scoped notification template by id. Pass
?version=draft(defaultpublished) to retrieve the working draft, or?version=vNfor a historical version.
-
retrieve
JourneyTemplateGetResponse retrieve(String notificationId, TemplateRetrieveParams params, RequestOptions requestOptions)
-
retrieve
JourneyTemplateGetResponse retrieve(TemplateRetrieveParams params)
-
retrieve
abstract JourneyTemplateGetResponse retrieve(TemplateRetrieveParams params, RequestOptions requestOptions)
-
list
JourneyTemplateListResponse list(String templateId)
List notification templates scoped to this journey. Journey-scoped notification templates can only be referenced from
sendnodes within the same journey.
-
list
JourneyTemplateListResponse list(String templateId, TemplateListParams params, RequestOptions requestOptions)
-
list
JourneyTemplateListResponse list(String templateId, TemplateListParams params)
-
list
abstract JourneyTemplateListResponse list(TemplateListParams params, RequestOptions requestOptions)
-
list
JourneyTemplateListResponse list(TemplateListParams params)
-
list
JourneyTemplateListResponse list(String templateId, RequestOptions requestOptions)
-
archive
Unit archive(String notificationId, TemplateArchiveParams params)
Archive the journey-scoped notification template. Archived templates cannot be sent.
-
archive
Unit archive(String notificationId, TemplateArchiveParams params, RequestOptions requestOptions)
-
archive
Unit archive(TemplateArchiveParams params)
-
archive
abstract Unit archive(TemplateArchiveParams params, RequestOptions requestOptions)
-
listVersions
NotificationTemplateVersionListResponse listVersions(String notificationId, TemplateListVersionsParams params)
List published versions of the journey-scoped notification template, ordered most recent first.
-
listVersions
NotificationTemplateVersionListResponse listVersions(String notificationId, TemplateListVersionsParams params, RequestOptions requestOptions)
-
listVersions
NotificationTemplateVersionListResponse listVersions(TemplateListVersionsParams params)
-
listVersions
abstract NotificationTemplateVersionListResponse listVersions(TemplateListVersionsParams params, RequestOptions requestOptions)
-
publish
Unit publish(String notificationId, TemplatePublishParams params)
Publish the current draft of the journey-scoped notification template as a new version. Optionally roll back to a prior version by passing
{ "version": "vN" }.
-
publish
Unit publish(String notificationId, TemplatePublishParams params, RequestOptions requestOptions)
-
publish
Unit publish(TemplatePublishParams params)
-
publish
abstract Unit publish(TemplatePublishParams params, RequestOptions requestOptions)
-
replace
JourneyTemplateGetResponse replace(String notificationId, TemplateReplaceParams params)
Replace the journey-scoped notification template draft.
-
replace
JourneyTemplateGetResponse replace(String notificationId, TemplateReplaceParams params, RequestOptions requestOptions)
-
replace
JourneyTemplateGetResponse replace(TemplateReplaceParams params)
-
replace
abstract JourneyTemplateGetResponse replace(TemplateReplaceParams params, RequestOptions requestOptions)
-
-
-
-