Package com.ringcentral.paths.restapi.v2.accounts.sms.consents

Class Index

java.lang.Object

com.ringcentral.paths.restapi.v2.accounts.sms.consents.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent)

Method Summary

Modifier and Type	Method	Description
OptRecordsModificationSummary	delete(DeleteOptRecordList deleteOptRecordList)	Deletes SMS consent records.
Index	export()
OptRecordList	get()
OptRecordList	get(ListSmsConsentRecordsParameters queryParams)	Returns a list of account-level SMS consent records for opted-out and/or opted-in phone numbers.
OptRecordsModificationSummary	patch(UpdateOptRecordList updateOptRecordList)	Adds or updates SMS consent records.
String	path()
String	path(Boolean withParameter)

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

Constructor Details

Index

public Index(Index parent)

Method Details

path

public String path()

path

public String path(Boolean withParameter)

get

public OptRecordList get(ListSmsConsentRecordsParameters queryParams)
                  throws RestException,
IOException

Returns a list of account-level SMS consent records for opted-out and/or opted-in phone numbers.

HTTP Method: get Endpoint: /restapi/v2/accounts/{accountId}/sms/consents Rate Limit Group: Light App Permission: SMS

Throws:

RestException

IOException

get

public OptRecordList get()
                  throws RestException,
IOException

Throws:

RestException

IOException

delete

public OptRecordsModificationSummary delete(DeleteOptRecordList deleteOptRecordList)
                                     throws RestException,
IOException

Deletes SMS consent records.

HTTP Method: delete Endpoint: /restapi/v2/accounts/{accountId}/sms/consents Rate Limit Group: Light App Permission: SMS

Throws:

RestException

IOException

patch

public OptRecordsModificationSummary patch(UpdateOptRecordList updateOptRecordList)
                                    throws RestException,
IOException

Adds or updates SMS consent records.

HTTP Method: patch Endpoint: /restapi/v2/accounts/{accountId}/sms/consents Rate Limit Group: Light App Permission: SMS

Throws:

RestException

IOException

export

public Index export()