Package com.ringcentral.paths.restapi.account.messagethreads.notes

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.messagethreads.notes.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	noteId
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent, String noteId)

Method Summary

Modifier and Type	Method	Description
String	delete(ThreadNotesDeleteRequest threadNotesDeleteRequest)	Deletes thread note(s).
ThreadNoteList	get()
ThreadNoteList	get(MthListNotesParameters queryParams)	Returns a list of notes from one or more threads.
ThreadNoteModel	patch(ThreadNoteUpdateRequest threadNoteUpdateRequest)	Updates the text of a note.
String	path()
String	path(Boolean withParameter)
ThreadNoteModel	post(ThreadNoteCreateRequest threadNoteCreateRequest)	Creates a new note in the thread.

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

noteId

public String noteId

Constructor Details

Index

public Index(Index parent,
 String noteId)

Method Details

path

public String path(Boolean withParameter)

path

public String path()

get

public ThreadNoteList get(MthListNotesParameters queryParams)
                   throws RestException,
IOException

Returns a list of notes from one or more threads. All filters are applied as "AND" conditions.

The records are sorted by `creationTime` in ascending order.

HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads/notes Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException

get

public ThreadNoteList get()
                   throws RestException,
IOException

Throws:

RestException

IOException

post

public ThreadNoteModel post(ThreadNoteCreateRequest threadNoteCreateRequest)
                     throws RestException,
IOException

Creates a new note in the thread.

The thread must be in `Open` status and the current user must be in the list of thread monitors for this operation to succeed.

HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads/notes Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException

delete

public String delete(ThreadNotesDeleteRequest threadNotesDeleteRequest)
              throws RestException,
IOException

Deletes thread note(s).

The corresponding threads must be in `Open` status and the calling user must be the notes' author for this operation to succeed.

HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads/notes Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException

patch

public ThreadNoteModel patch(ThreadNoteUpdateRequest threadNoteUpdateRequest)
                      throws RestException,
IOException

Updates the text of a note.

The thread must be in `Open` status and the calling user must be the note's author for this operation to succeed.

HTTP Method: patch Endpoint: /restapi/{apiVersion}/account/{accountId}/message-threads/notes/{noteId} Rate Limit Group: Medium App Permission: SMS

Throws:

RestException

IOException