Constructor Detail

• TemplateControllerApi

  TemplateControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• createTemplate

   final TemplateDto createTemplate(CreateTemplateOptions createTemplateOptions)

  Create a Template Create an email template with variables for use with templated transactional emails.

• createTemplateRequestConfig

   final RequestConfig createTemplateRequestConfig(CreateTemplateOptions createTemplateOptions)

  To obtain the request config of the operation createTemplate

• deleteTemplate

   final Unit deleteTemplate(UUID templateId)

  Delete email template Delete template

  Parameters:

  templateId - Template ID

• deleteTemplateRequestConfig

   final RequestConfig deleteTemplateRequestConfig(UUID templateId)

  To obtain the request config of the operation deleteTemplate

  Parameters:

  templateId - Template ID

• getAllTemplates

   final PageTemplateProjection getAllTemplates(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  List templates Get all templates in paginated format

  Parameters:

  page - Optional page index in list pagination (optional, default to 0)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getAllTemplatesRequestConfig

   final RequestConfig getAllTemplatesRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getAllTemplates

  Parameters:

  page - Optional page index in list pagination (optional, default to 0)

  size - Optional page size in list pagination (optional, default to 20)

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  since - Filter by created at after the given timestamp (optional)

  before - Filter by created at before the given timestamp (optional)

• getTemplate

   final TemplateDto getTemplate(UUID templateId)

  Get template Get email template

  Parameters:

  templateId - Template ID

• getTemplateRequestConfig

   final RequestConfig getTemplateRequestConfig(UUID templateId)

  To obtain the request config of the operation getTemplate

  Parameters:

  templateId - Template ID

• getTemplatePreviewHtml

   final String getTemplatePreviewHtml(UUID templateId)

  Get template preview HTML Get email template preview with passed template variables in HTML format for browsers. Pass template variables as query params.

  Parameters:

  templateId - Template ID

• getTemplatePreviewHtmlRequestConfig

   final RequestConfig getTemplatePreviewHtmlRequestConfig(UUID templateId)

  To obtain the request config of the operation getTemplatePreviewHtml

  Parameters:

  templateId - Template ID

• getTemplatePreviewJson

   final TemplatePreview getTemplatePreviewJson(UUID templateId)

  Get template preview Json Get email template preview with passed template variables in JSON format. Pass template variables as query params.

  Parameters:

  templateId - Template ID

• getTemplatePreviewJsonRequestConfig

   final RequestConfig getTemplatePreviewJsonRequestConfig(UUID templateId)

  To obtain the request config of the operation getTemplatePreviewJson

  Parameters:

  templateId - Template ID

• getTemplates

   final List<TemplateProjection> getTemplates()

  List templates Get all templates

• getTemplatesRequestConfig

   final RequestConfig getTemplatesRequestConfig()

  To obtain the request config of the operation getTemplates

• updateTemplate

   final TemplateDto updateTemplate(UUID templateId, CreateTemplateOptions createTemplateOptions)

  Update template Update email template

  Parameters:

  templateId - Template ID

• updateTemplateRequestConfig

   final RequestConfig updateTemplateRequestConfig(UUID templateId, CreateTemplateOptions createTemplateOptions)

  To obtain the request config of the operation updateTemplate

  Parameters:

  templateId - Template ID