Package com.ringcentral.paths.restapi.account.customfields

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.customfields.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	fieldId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String fieldId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes custom field(s) by ID(s) with the corresponding values.
CustomFieldList	get()	Returns the list of created custom fields.
String	path()
String	path(Boolean withParameter)
CustomFieldModel	post(CustomFieldCreateRequest customFieldCreateRequest)	Creates custom field attached to the object.
CustomFieldModel	put(CustomFieldUpdateRequest customFieldUpdateRequest)	Updates custom field by ID 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

fieldId

public String fieldId

Constructor Details

Index

public Index(Index parent,
 String fieldId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

get

public CustomFieldList get()
                    throws RestException,
IOException

Returns the list of created custom fields. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/custom-fields Rate Limit Group: Light App Permission: ReadAccounts User Permission: ReadUserInfo

Throws:

RestException

IOException

post

public CustomFieldModel post(CustomFieldCreateRequest customFieldCreateRequest)
                      throws RestException,
IOException

Creates custom field attached to the object. HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/custom-fields Rate Limit Group: Medium App Permission: EditAccounts User Permission: Users

Throws:

RestException

IOException

put

public CustomFieldModel put(CustomFieldUpdateRequest customFieldUpdateRequest)
                     throws RestException,
IOException

Updates custom field by ID specified in path. HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/custom-fields/{fieldId} Rate Limit Group: Medium App Permission: EditAccounts User Permission: Users

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes custom field(s) by ID(s) with the corresponding values. HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/custom-fields/{fieldId} Rate Limit Group: Medium App Permission: EditAccounts User Permission: Users

Throws:

RestException

IOException