org.openapitools.client.api

Class TemplateApi

java.lang.Object

org.openapitools.client.api.TemplateApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.TemplateApi")
public class TemplateApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TemplateApi()
TemplateApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createSmsTemplate(Class<?> T, SmsTemplate smsTemplate) Create an SMS Template Creates a new custom SMS template
SmsTemplate	createSmsTemplate(SmsTemplate smsTemplate) Create an SMS Template Creates a new custom SMS template
PagedList	createSmsTemplateWithPaginationInfo(SmsTemplate smsTemplate) Create an SMS Template Creates a new custom SMS template
void	deleteSmsTemplate(String templateId) Delete an SMS Template Deletes an SMS template
ApiClient	getApiClient()
SmsTemplate	getSmsTemplate(String templateId) Retrieve an SMS Template Retrieves a specific template by `id`
PagedList	getSmsTemplateWithPaginationInfo(String templateId) Retrieve an SMS Template Retrieves a specific template by `id`
List<SmsTemplate>	listSmsTemplates(SmsTemplateType templateType) List all SMS Templates Lists all custom SMS templates.
PagedList	listSmsTemplatesWithPaginationInfo(SmsTemplateType templateType) List all SMS Templates Lists all custom SMS templates.
<T> T	replaceSmsTemplate(Class<?> T, String templateId, SmsTemplate smsTemplate) Replace an SMS Template Replaces the SMS template
SmsTemplate	replaceSmsTemplate(String templateId, SmsTemplate smsTemplate) Replace an SMS Template Replaces the SMS template
PagedList	replaceSmsTemplateWithPaginationInfo(String templateId, SmsTemplate smsTemplate) Replace an SMS Template Replaces the SMS template
void	setApiClient(ApiClient apiClient)
<T> T	updateSmsTemplate(Class<?> T, String templateId, SmsTemplate smsTemplate) Update an SMS Template Updates an SMS template
SmsTemplate	updateSmsTemplate(String templateId, SmsTemplate smsTemplate) Update an SMS Template Updates an SMS template
PagedList	updateSmsTemplateWithPaginationInfo(String templateId, SmsTemplate smsTemplate) 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

@Autowired
public TemplateApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createSmsTemplate

public SmsTemplate createSmsTemplate(SmsTemplate smsTemplate)
                              throws org.springframework.web.client.RestClientException

Create an SMS Template Creates a new custom SMS template

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

smsTemplate - (required)

Returns:

SmsTemplate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createSmsTemplate

public <T> T createSmsTemplate(Class<?> T,
                               SmsTemplate smsTemplate)
                        throws org.springframework.web.client.RestClientException

Create an SMS Template Creates a new custom SMS template

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

smsTemplate - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createSmsTemplateWithPaginationInfo

public PagedList createSmsTemplateWithPaginationInfo(SmsTemplate smsTemplate)
                                              throws org.springframework.web.client.RestClientException

Create an SMS Template Creates a new custom SMS template

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

smsTemplate - (required)

Returns:

ResponseEntity<SmsTemplate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteSmsTemplate

public void deleteSmsTemplate(String templateId)
                       throws org.springframework.web.client.RestClientException

Delete an SMS Template Deletes an SMS template

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getSmsTemplate

public SmsTemplate getSmsTemplate(String templateId)
                           throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

Returns:

SmsTemplate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getSmsTemplateWithPaginationInfo

public PagedList getSmsTemplateWithPaginationInfo(String templateId)
                                           throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

Returns:

ResponseEntity<SmsTemplate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSmsTemplates

public List<SmsTemplate> listSmsTemplates(SmsTemplateType templateType)
                                   throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

templateType - (optional)

Returns:

List<SmsTemplate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSmsTemplatesWithPaginationInfo

public PagedList listSmsTemplatesWithPaginationInfo(SmsTemplateType templateType)
                                             throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

templateType - (optional)

Returns:

ResponseEntity<List<SmsTemplate>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceSmsTemplate

public SmsTemplate replaceSmsTemplate(String templateId,
                                      SmsTemplate smsTemplate)
                               throws org.springframework.web.client.RestClientException

Replace an SMS Template Replaces the SMS template

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

smsTemplate - (required)

Returns:

SmsTemplate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceSmsTemplate

public <T> T replaceSmsTemplate(Class<?> T,
                                String templateId,
                                SmsTemplate smsTemplate)
                         throws org.springframework.web.client.RestClientException

Replace an SMS Template Replaces the SMS template

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

templateId - (required)

smsTemplate - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceSmsTemplateWithPaginationInfo

public PagedList replaceSmsTemplateWithPaginationInfo(String templateId,
                                                      SmsTemplate smsTemplate)
                                               throws org.springframework.web.client.RestClientException

Replace an SMS Template Replaces the SMS template

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

smsTemplate - (required)

Returns:

ResponseEntity<SmsTemplate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateSmsTemplate

public SmsTemplate updateSmsTemplate(String templateId,
                                     SmsTemplate smsTemplate)
                              throws org.springframework.web.client.RestClientException

Update an SMS Template Updates an SMS template

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

smsTemplate - (required)

Returns:

SmsTemplate

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateSmsTemplate

public <T> T updateSmsTemplate(Class<?> T,
                               String templateId,
                               SmsTemplate smsTemplate)
                        throws org.springframework.web.client.RestClientException

Update an SMS Template Updates an SMS template

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

templateId - (required)

smsTemplate - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

updateSmsTemplateWithPaginationInfo

public PagedList updateSmsTemplateWithPaginationInfo(String templateId,
                                                     SmsTemplate smsTemplate)
                                              throws org.springframework.web.client.RestClientException

Update an SMS Template Updates an SMS template

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

templateId - (required)

smsTemplate - (required)

Returns:

ResponseEntity<SmsTemplate>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API