Package com.ringcentral.paths.restapi.account.extension.addressbook.contact

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.extension.addressbook.contact.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	contactId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String contactId)

Method Summary

Modifier and Type	Method	Description
String	delete()	Deletes the user personal contact(s).
PersonalContactResource	get()	Returns the user personal contact(s).
ContactList	list()
ContactList	list(ListContactsParameters queryParams)	Returns the user personal contacts.
PersonalContactResource	patch(PersonalContactRequest personalContactRequest)
PersonalContactResource	patch(PersonalContactRequest personalContactRequest, PatchContactParameters queryParams)	Updates particular values of a personal contact attributes specified in request (partial resource update).
String	path()
String	path(Boolean withParameter)
PersonalContactResource	post(PersonalContactRequest personalContactRequest)
PersonalContactResource	post(PersonalContactRequest personalContactRequest, CreateContactParameters queryParams)	Creates the user personal contact.
PersonalContactResource	put(PersonalContactRequest personalContactRequest)
PersonalContactResource	put(PersonalContactRequest personalContactRequest, UpdateContactParameters queryParams)	Updates the user personal contact(s) (full resource update).

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

contactId

public String contactId

Constructor Details

Index

public Index(Index parent,
 String contactId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

list

public ContactList list(ListContactsParameters queryParams)
                 throws RestException,
IOException

Returns the user personal contacts.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact Rate Limit Group: Heavy App Permission: ReadContacts User Permission: ReadPersonalContacts

Throws:

RestException

IOException

list

public ContactList list()
                 throws RestException,
IOException

Throws:

RestException

IOException

post

public PersonalContactResource post(PersonalContactRequest personalContactRequest,
 CreateContactParameters queryParams)
                             throws RestException,
IOException

Creates the user personal contact.

HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact Rate Limit Group: Heavy App Permission: Contacts User Permission: EditPersonalContacts

Throws:

RestException

IOException

post

public PersonalContactResource post(PersonalContactRequest personalContactRequest)
                             throws RestException,
IOException

Throws:

RestException

IOException

get

public PersonalContactResource get()
                            throws RestException,
IOException

Returns the user personal contact(s). [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} Rate Limit Group: Heavy App Permission: ReadContacts User Permission: ReadPersonalContacts

Throws:

RestException

IOException

put

public PersonalContactResource put(PersonalContactRequest personalContactRequest,
 UpdateContactParameters queryParams)
                            throws RestException,
IOException

Updates the user personal contact(s) (full resource update). [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.

HTTP Method: put Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} Rate Limit Group: Heavy App Permission: Contacts User Permission: EditPersonalContacts

Throws:

RestException

IOException

put

public PersonalContactResource put(PersonalContactRequest personalContactRequest)
                            throws RestException,
IOException

Throws:

RestException

IOException

delete

public String delete()
              throws RestException,
IOException

Deletes the user personal contact(s). [Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.

HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} Rate Limit Group: Heavy App Permission: Contacts User Permission: EditPersonalContacts

Throws:

RestException

IOException

patch

public PersonalContactResource patch(PersonalContactRequest personalContactRequest,
 PatchContactParameters queryParams)
                              throws RestException,
IOException

Updates particular values of a personal contact attributes specified in request (partial resource update). Omitted attributes will remain unchanged. If any attribute is passed in request body with the null value, then this attribute value will be removed.

HTTP Method: patch Endpoint: /restapi/{apiVersion}/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} Rate Limit Group: Heavy App Permission: Contacts User Permission: EditPersonalContacts

Throws:

RestException

IOException

patch

public PersonalContactResource patch(PersonalContactRequest personalContactRequest)
                              throws RestException,
IOException

Throws:

RestException

IOException