Package com.ringcentral.paths.restapi.account.extension.messagestoretemplates

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.extension.messagestoretemplates.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	templateId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String templateId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes a user personal text message template.
MessageTemplateResponse	get()	Returns a user personal text message template by ID.
MessageTemplatesListResponse	list()
MessageTemplatesListResponse	list(ListUserMessageTemplatesParameters queryParams)	Returns a list of user's personal text message templates.
String	path()
String	path(Boolean withParameter)
MessageTemplateResponse	post(MessageTemplateRequest messageTemplateRequest)	Creates a user personal text message template.
MessageTemplateResponse	put(MessageTemplateUpdateRequest messageTemplateUpdateRequest)	Updates a user personal text message template.

Methods inherited from class java.lang.Object

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

Field Details

rc

public RestClient rc

parent

public Index parent

templateId

public String templateId

Constructor Details

Index

public Index(Index parent,
 String templateId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public MessageTemplatesListResponse list(ListUserMessageTemplatesParameters queryParams)
                                  throws RestException,
IOException

Returns a list of user's personal text message templates. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates Rate Limit Group: Light App Permission: ReadAccounts

Throws:

RestException

IOException

list

public MessageTemplatesListResponse list()
                                  throws RestException,
IOException

Throws:

RestException

IOException

post

public MessageTemplateResponse post(MessageTemplateRequest messageTemplateRequest)
                             throws RestException,
IOException

Creates a user personal text message template. Maximum number of personal templates is 25 per user. Max length of the `body` property is 1000 symbols (2-byte UTF-16 encoded).

HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates Rate Limit Group: Medium App Permission: EditExtensions

Throws:

RestException

IOException

get

public MessageTemplateResponse get()
                            throws RestException,
IOException

Returns a user personal text message template by ID. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates/{templateId} Rate Limit Group: Light App Permission: ReadAccounts

Throws:

RestException

IOException

put

public MessageTemplateResponse put(MessageTemplateUpdateRequest messageTemplateUpdateRequest)
                            throws RestException,
IOException

Updates a user personal text message template. HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates/{templateId} Rate Limit Group: Medium App Permission: EditExtensions

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a user personal text message template. HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/message-store-templates/{templateId} Rate Limit Group: Medium App Permission: EditExtensions

Throws:

RestException

IOException