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

Class Index

java.lang.Object

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

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	forwardingNumberId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String forwardingNumberId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes a forwarding number from the forwarding number list by its ID.
String	deleteAll(DeleteForwardingNumbersRequest deleteForwardingNumbersRequest)	Deletes multiple forwarding numbers from the forwarding number list by IDs.
ForwardingNumberResource	get()	Returns a specific forwarding number.
GetExtensionForwardingNumberListResponse	list()
GetExtensionForwardingNumberListResponse	list(ListForwardingNumbersParameters queryParams)	Returns the list of extension phone numbers used for call forwarding and call flip.
String	path()
String	path(Boolean withParameter)
ForwardingNumberInfo	post(CreateForwardingNumberRequest createForwardingNumberRequest)	Adds a new forwarding number to the forwarding number list.
ForwardingNumberInfo	put(UpdateForwardingNumberRequest updateForwardingNumberRequest)	Updates the existing forwarding number from the forwarding number list.

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

forwardingNumberId

public String forwardingNumberId

Constructor Details

Index

public Index(Index parent,
 String forwardingNumberId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public GetExtensionForwardingNumberListResponse list(ListForwardingNumbersParameters queryParams)
                                              throws RestException,
IOException

Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers used for call forwarding and call flip.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/forwarding-number Rate Limit Group: Light App Permission: ReadAccounts User Permission: ReadUserForwardingFlipNumbers

Throws:

RestException

IOException

list

public GetExtensionForwardingNumberListResponse list()
                                              throws RestException,
IOException

Throws:

RestException

IOException

post

public ForwardingNumberInfo post(CreateForwardingNumberRequest createForwardingNumberRequest)
                          throws RestException,
IOException

Adds a new forwarding number to the forwarding number list. HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/forwarding-number Rate Limit Group: Medium App Permission: EditExtensions User Permission: EditUserForwardingFlipNumbers

Throws:

RestException

IOException

deleteAll

public String deleteAll(DeleteForwardingNumbersRequest deleteForwardingNumbersRequest)
                 throws RestException,
IOException

Deletes multiple forwarding numbers from the forwarding number list by IDs. HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/forwarding-number Rate Limit Group: Medium App Permission: EditExtensions User Permission: EditUserForwardingFlipNumbers

Throws:

RestException

IOException

get

public ForwardingNumberResource get()
                             throws RestException,
IOException

Returns a specific forwarding number. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} Rate Limit Group: Light App Permission: ReadAccounts User Permission: ReadUserForwardingFlipNumbers

Throws:

RestException

IOException

put

public ForwardingNumberInfo put(UpdateForwardingNumberRequest updateForwardingNumberRequest)
                         throws RestException,
IOException

Updates the existing forwarding number from the forwarding number list. HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} Rate Limit Group: Medium App Permission: EditExtensions User Permission: EditUserForwardingFlipNumbers

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a forwarding number from the forwarding number list by its ID. HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId} Rate Limit Group: Medium App Permission: EditExtensions User Permission: EditUserForwardingFlipNumbers

Throws:

RestException

IOException