Package com.ringcentral.paths.restapi.account.sites

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.sites.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc
String	siteId

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String siteId)

Method Summary

Modifier and Type	Method	Description
Index	bulkAssign()
String	delete()	Deletes a site specified in path.
SiteInfo	get()	Returns a site by ID.
Index	ivr()
SitesList	list()	Returns a list of sites for the specified account.
Index	members()
String	path()
String	path(Boolean withParameter)
SiteInfo	post(CreateSiteRequest createSiteRequest)	Creates a site for the specified account.
SiteInfo	put(SiteUpdateRequest siteUpdateRequest)	Updates a site specified in path.

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

siteId

public String siteId

Constructor Details

Index

public Index(Index parent,
 String siteId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public SitesList list()
               throws RestException,
IOException

Returns a list of sites for the specified account.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/sites Rate Limit Group: Light App Permission: ReadAccounts User Permission: ReadExtensions

Throws:

RestException

IOException

post

public SiteInfo post(CreateSiteRequest createSiteRequest)
              throws RestException,
IOException

Creates a site for the specified account.

HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/sites Rate Limit Group: Medium App Permission: EditAccounts

Throws:

RestException

IOException

get

public SiteInfo get()
             throws RestException,
IOException

Returns a site by ID.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/sites/{siteId} Rate Limit Group: Light App Permission: ReadAccounts User Permission: ReadExtensions

Throws:

RestException

IOException

put

public SiteInfo put(SiteUpdateRequest siteUpdateRequest)
             throws RestException,
IOException

Updates a site specified in path.

HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/sites/{siteId} Rate Limit Group: Light App Permission: EditExtensions User Permission: Sites

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes a site specified in path.

HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/sites/{siteId} Rate Limit Group: Light App Permission: EditAccounts User Permission: Sites

Throws:

RestException

IOException

ivr

public Index ivr()

members

public Index members()

bulkAssign

public Index bulkAssign()