org.openapitools.client.api

Class TemplateApi

java.lang.Object

org.openapitools.client.api.TemplateApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T23:40:43.026Z[Etc/UTC]")
public class TemplateApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TemplateApi()
TemplateApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SmsTemplate	createSmsTemplate(SmsTemplate smsTemplate) Create an SMS Template Creates a new custom SMS template
SmsTemplate	createSmsTemplate(SmsTemplate smsTemplate, Map<String,String> additionalHeaders) Create an SMS Template Creates a new custom SMS template
void	deleteSmsTemplate(String templateId) Delete an SMS Template Deletes an SMS template
void	deleteSmsTemplate(String templateId, Map<String,String> additionalHeaders) Delete an SMS Template Deletes an SMS template
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
SmsTemplate	getSmsTemplate(String templateId) Retrieve an SMS Template Retrieves a specific template by `id`
SmsTemplate	getSmsTemplate(String templateId, Map<String,String> additionalHeaders) Retrieve an SMS Template Retrieves a specific template by `id`
List<SmsTemplate>	listSmsTemplates(SmsTemplateType templateType) List all SMS Templates Lists all custom SMS templates.
List<SmsTemplate>	listSmsTemplates(SmsTemplateType templateType, Map<String,String> additionalHeaders) List all SMS Templates Lists all custom SMS templates.
SmsTemplate	replaceSmsTemplate(String templateId, SmsTemplate smsTemplate) Replace an SMS Template Replaces the SMS template
SmsTemplate	replaceSmsTemplate(String templateId, SmsTemplate smsTemplate, Map<String,String> additionalHeaders) Replace an SMS Template Replaces the SMS template
void	setApiClient(ApiClient apiClient)
SmsTemplate	updateSmsTemplate(String templateId, SmsTemplate smsTemplate) Update an SMS Template Updates an SMS template
SmsTemplate	updateSmsTemplate(String templateId, SmsTemplate smsTemplate, Map<String,String> additionalHeaders) Update an SMS Template Updates an SMS template

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateApi

public TemplateApi()

TemplateApi

public TemplateApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSmsTemplate

public SmsTemplate createSmsTemplate(SmsTemplate smsTemplate)
                              throws ApiException

Create an SMS Template Creates a new custom SMS template

Parameters:

smsTemplate - (required)

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

createSmsTemplate

public SmsTemplate createSmsTemplate(SmsTemplate smsTemplate,
                                     Map<String,String> additionalHeaders)
                              throws ApiException

Create an SMS Template Creates a new custom SMS template

Parameters:

smsTemplate - (required)

additionalHeaders - additionalHeaders for this call

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

deleteSmsTemplate

public void deleteSmsTemplate(String templateId)
                       throws ApiException

Delete an SMS Template Deletes an SMS template

Parameters:

templateId - `id` of the Template (required)

Throws:

ApiException - if fails to make API call

deleteSmsTemplate

public void deleteSmsTemplate(String templateId,
                              Map<String,String> additionalHeaders)
                       throws ApiException

Delete an SMS Template Deletes an SMS template

Parameters:

templateId - `id` of the Template (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getSmsTemplate

public SmsTemplate getSmsTemplate(String templateId)
                           throws ApiException

Retrieve an SMS Template Retrieves a specific template by `id`

Parameters:

templateId - `id` of the Template (required)

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

getSmsTemplate

public SmsTemplate getSmsTemplate(String templateId,
                                  Map<String,String> additionalHeaders)
                           throws ApiException

Retrieve an SMS Template Retrieves a specific template by `id`

Parameters:

templateId - `id` of the Template (required)

additionalHeaders - additionalHeaders for this call

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

listSmsTemplates

public List<SmsTemplate> listSmsTemplates(SmsTemplateType templateType)
                                   throws ApiException

List all SMS Templates Lists all custom SMS templates. A subset of templates can be returned that match a template type.

Parameters:

templateType - (optional)

Returns:

List<SmsTemplate>

Throws:

ApiException - if fails to make API call

listSmsTemplates

public List<SmsTemplate> listSmsTemplates(SmsTemplateType templateType,
                                          Map<String,String> additionalHeaders)
                                   throws ApiException

List all SMS Templates Lists all custom SMS templates. A subset of templates can be returned that match a template type.

Parameters:

templateType - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<SmsTemplate>

Throws:

ApiException - if fails to make API call

replaceSmsTemplate

public SmsTemplate replaceSmsTemplate(String templateId,
                                      SmsTemplate smsTemplate)
                               throws ApiException

Replace an SMS Template Replaces the SMS template

Parameters:

templateId - `id` of the Template (required)

smsTemplate - (required)

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

replaceSmsTemplate

public SmsTemplate replaceSmsTemplate(String templateId,
                                      SmsTemplate smsTemplate,
                                      Map<String,String> additionalHeaders)
                               throws ApiException

Replace an SMS Template Replaces the SMS template

Parameters:

templateId - `id` of the Template (required)

smsTemplate - (required)

additionalHeaders - additionalHeaders for this call

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

updateSmsTemplate

public SmsTemplate updateSmsTemplate(String templateId,
                                     SmsTemplate smsTemplate)
                              throws ApiException

Update an SMS Template Updates an SMS template

Parameters:

templateId - `id` of the Template (required)

smsTemplate - (required)

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

updateSmsTemplate

public SmsTemplate updateSmsTemplate(String templateId,
                                     SmsTemplate smsTemplate,
                                     Map<String,String> additionalHeaders)
                              throws ApiException

Update an SMS Template Updates an SMS template

Parameters:

templateId - `id` of the Template (required)

smsTemplate - (required)

additionalHeaders - additionalHeaders for this call

Returns:

SmsTemplate

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()