Uses of Class
com.mypurecloud.sdk.v2.model.Note

Packages that use Note

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.api.request
com.mypurecloud.sdk.v2.model

Uses of Note in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return Note

Modifier and Type	Method	Description
Note	ExternalContactsApi.getExternalcontactsContactNote(GetExternalcontactsContactNoteRequest request)	Fetch a note for an external contact
Note	ExternalContactsApi.getExternalcontactsContactNote(String contactId, String noteId, List<String> expand)	Fetch a note for an external contact
Note	ExternalContactsApi.getExternalcontactsOrganizationNote(GetExternalcontactsOrganizationNoteRequest request)	Fetch a note for an external organization
Note	ExternalContactsApi.getExternalcontactsOrganizationNote(String externalOrganizationId, String noteId, List<String> expand)	Fetch a note for an external organization
Note	ExternalContactsApi.postExternalcontactsContactNotes(PostExternalcontactsContactNotesRequest request)	Create a note for an external contact
Note	ExternalContactsApi.postExternalcontactsContactNotes(String contactId, Note body)	Create a note for an external contact
Note	ExternalContactsApi.postExternalcontactsOrganizationNotes(PostExternalcontactsOrganizationNotesRequest request)	Create a note for an external organization
Note	ExternalContactsApi.postExternalcontactsOrganizationNotes(String externalOrganizationId, Note body)	Create a note for an external organization
Note	ExternalContactsApi.putExternalcontactsContactNote(PutExternalcontactsContactNoteRequest request)	Update a note for an external contact
Note	ExternalContactsApi.putExternalcontactsContactNote(String contactId, String noteId, Note body)	Update a note for an external contact
Note	ExternalContactsApi.putExternalcontactsOrganizationNote(PutExternalcontactsOrganizationNoteRequest request)	Update a note for an external organization
Note	ExternalContactsApi.putExternalcontactsOrganizationNote(String externalOrganizationId, String noteId, Note body)	Update a note for an external organization

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type Note

Modifier and Type	Method	Description
ApiResponse<Note>	ExternalContactsApi.getExternalcontactsContactNote(ApiRequest<Void> request)	Fetch a note for an external contact
Future<Note>	ExternalContactsApiAsync.getExternalcontactsContactNoteAsync(GetExternalcontactsContactNoteRequest request, AsyncApiCallback<Note> callback)	Fetch a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.getExternalcontactsContactNoteAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Note>> callback)	Fetch a note for an external contact
ApiResponse<Note>	ExternalContactsApi.getExternalcontactsContactNoteWithHttpInfo(String contactId, String noteId, List<String> expand)	Fetch a note for an external contact
ApiResponse<Note>	ExternalContactsApi.getExternalcontactsOrganizationNote(ApiRequest<Void> request)	Fetch a note for an external organization
Future<Note>	ExternalContactsApiAsync.getExternalcontactsOrganizationNoteAsync(GetExternalcontactsOrganizationNoteRequest request, AsyncApiCallback<Note> callback)	Fetch a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.getExternalcontactsOrganizationNoteAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Note>> callback)	Fetch a note for an external organization
ApiResponse<Note>	ExternalContactsApi.getExternalcontactsOrganizationNoteWithHttpInfo(String externalOrganizationId, String noteId, List<String> expand)	Fetch a note for an external organization
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsContactNotes(ApiRequest<Note> request)	Create a note for an external contact
Future<Note>	ExternalContactsApiAsync.postExternalcontactsContactNotesAsync(PostExternalcontactsContactNotesRequest request, AsyncApiCallback<Note> callback)	Create a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.postExternalcontactsContactNotesAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Create a note for an external contact
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsContactNotesWithHttpInfo(String contactId, Note body)	Create a note for an external contact
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsOrganizationNotes(ApiRequest<Note> request)	Create a note for an external organization
Future<Note>	ExternalContactsApiAsync.postExternalcontactsOrganizationNotesAsync(PostExternalcontactsOrganizationNotesRequest request, AsyncApiCallback<Note> callback)	Create a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.postExternalcontactsOrganizationNotesAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Create a note for an external organization
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsOrganizationNotesWithHttpInfo(String externalOrganizationId, Note body)	Create a note for an external organization
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsContactNote(ApiRequest<Note> request)	Update a note for an external contact
Future<Note>	ExternalContactsApiAsync.putExternalcontactsContactNoteAsync(PutExternalcontactsContactNoteRequest request, AsyncApiCallback<Note> callback)	Update a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.putExternalcontactsContactNoteAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Update a note for an external contact
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsContactNoteWithHttpInfo(String contactId, String noteId, Note body)	Update a note for an external contact
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsOrganizationNote(ApiRequest<Note> request)	Update a note for an external organization
Future<Note>	ExternalContactsApiAsync.putExternalcontactsOrganizationNoteAsync(PutExternalcontactsOrganizationNoteRequest request, AsyncApiCallback<Note> callback)	Update a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.putExternalcontactsOrganizationNoteAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Update a note for an external organization
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsOrganizationNoteWithHttpInfo(String externalOrganizationId, String noteId, Note body)	Update a note for an external organization

Methods in com.mypurecloud.sdk.v2.api with parameters of type Note

Modifier and Type	Method	Description
Note	ExternalContactsApi.postExternalcontactsContactNotes(String contactId, Note body)	Create a note for an external contact
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsContactNotesWithHttpInfo(String contactId, Note body)	Create a note for an external contact
Note	ExternalContactsApi.postExternalcontactsOrganizationNotes(String externalOrganizationId, Note body)	Create a note for an external organization
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsOrganizationNotesWithHttpInfo(String externalOrganizationId, Note body)	Create a note for an external organization
Note	ExternalContactsApi.putExternalcontactsContactNote(String contactId, String noteId, Note body)	Update a note for an external contact
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsContactNoteWithHttpInfo(String contactId, String noteId, Note body)	Update a note for an external contact
Note	ExternalContactsApi.putExternalcontactsOrganizationNote(String externalOrganizationId, String noteId, Note body)	Update a note for an external organization
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsOrganizationNoteWithHttpInfo(String externalOrganizationId, String noteId, Note body)	Update a note for an external organization

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type Note

Modifier and Type	Method	Description
Future<Note>	ExternalContactsApiAsync.getExternalcontactsContactNoteAsync(GetExternalcontactsContactNoteRequest request, AsyncApiCallback<Note> callback)	Fetch a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.getExternalcontactsContactNoteAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Note>> callback)	Fetch a note for an external contact
Future<Note>	ExternalContactsApiAsync.getExternalcontactsOrganizationNoteAsync(GetExternalcontactsOrganizationNoteRequest request, AsyncApiCallback<Note> callback)	Fetch a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.getExternalcontactsOrganizationNoteAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Note>> callback)	Fetch a note for an external organization
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsContactNotes(ApiRequest<Note> request)	Create a note for an external contact
Future<Note>	ExternalContactsApiAsync.postExternalcontactsContactNotesAsync(PostExternalcontactsContactNotesRequest request, AsyncApiCallback<Note> callback)	Create a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.postExternalcontactsContactNotesAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Create a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.postExternalcontactsContactNotesAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Create a note for an external contact
ApiResponse<Note>	ExternalContactsApi.postExternalcontactsOrganizationNotes(ApiRequest<Note> request)	Create a note for an external organization
Future<Note>	ExternalContactsApiAsync.postExternalcontactsOrganizationNotesAsync(PostExternalcontactsOrganizationNotesRequest request, AsyncApiCallback<Note> callback)	Create a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.postExternalcontactsOrganizationNotesAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Create a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.postExternalcontactsOrganizationNotesAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Create a note for an external organization
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsContactNote(ApiRequest<Note> request)	Update a note for an external contact
Future<Note>	ExternalContactsApiAsync.putExternalcontactsContactNoteAsync(PutExternalcontactsContactNoteRequest request, AsyncApiCallback<Note> callback)	Update a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.putExternalcontactsContactNoteAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Update a note for an external contact
Future<ApiResponse<Note>>	ExternalContactsApiAsync.putExternalcontactsContactNoteAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Update a note for an external contact
ApiResponse<Note>	ExternalContactsApi.putExternalcontactsOrganizationNote(ApiRequest<Note> request)	Update a note for an external organization
Future<Note>	ExternalContactsApiAsync.putExternalcontactsOrganizationNoteAsync(PutExternalcontactsOrganizationNoteRequest request, AsyncApiCallback<Note> callback)	Update a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.putExternalcontactsOrganizationNoteAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Update a note for an external organization
Future<ApiResponse<Note>>	ExternalContactsApiAsync.putExternalcontactsOrganizationNoteAsync(ApiRequest<Note> request, AsyncApiCallback<ApiResponse<Note>> callback)	Update a note for an external organization

Uses of Note in com.mypurecloud.sdk.v2.api.request

Methods in com.mypurecloud.sdk.v2.api.request that return Note

Modifier and Type	Method	Description
Note	PostExternalcontactsContactNotesRequest.getBody()
Note	PostExternalcontactsOrganizationNotesRequest.getBody()
Note	PutExternalcontactsContactNoteRequest.getBody()
Note	PutExternalcontactsOrganizationNoteRequest.getBody()

Methods in com.mypurecloud.sdk.v2.api.request that return types with arguments of type Note

Modifier and Type	Method	Description
ApiRequest<Note>	PostExternalcontactsContactNotesRequest.withHttpInfo()
ApiRequest<Note>	PostExternalcontactsOrganizationNotesRequest.withHttpInfo()
ApiRequest<Note>	PutExternalcontactsContactNoteRequest.withHttpInfo()
ApiRequest<Note>	PutExternalcontactsOrganizationNoteRequest.withHttpInfo()

Methods in com.mypurecloud.sdk.v2.api.request with parameters of type Note

Modifier and Type	Method	Description
static PostExternalcontactsContactNotesRequest.Builder	PostExternalcontactsContactNotesRequest.builder(String contactId, Note body)
static PostExternalcontactsOrganizationNotesRequest.Builder	PostExternalcontactsOrganizationNotesRequest.builder(String externalOrganizationId, Note body)
static PutExternalcontactsContactNoteRequest.Builder	PutExternalcontactsContactNoteRequest.builder(String contactId, String noteId, Note body)
static PutExternalcontactsOrganizationNoteRequest.Builder	PutExternalcontactsOrganizationNoteRequest.builder(String externalOrganizationId, String noteId, Note body)
void	PostExternalcontactsContactNotesRequest.setBody(Note body)
void	PostExternalcontactsOrganizationNotesRequest.setBody(Note body)
void	PutExternalcontactsContactNoteRequest.setBody(Note body)
void	PutExternalcontactsOrganizationNoteRequest.setBody(Note body)
PostExternalcontactsContactNotesRequest.Builder	PostExternalcontactsContactNotesRequest.Builder.withBody(Note body)
PostExternalcontactsContactNotesRequest	PostExternalcontactsContactNotesRequest.withBody(Note body)
PostExternalcontactsOrganizationNotesRequest.Builder	PostExternalcontactsOrganizationNotesRequest.Builder.withBody(Note body)
PostExternalcontactsOrganizationNotesRequest	PostExternalcontactsOrganizationNotesRequest.withBody(Note body)
PutExternalcontactsContactNoteRequest.Builder	PutExternalcontactsContactNoteRequest.Builder.withBody(Note body)
PutExternalcontactsContactNoteRequest	PutExternalcontactsContactNoteRequest.withBody(Note body)
PutExternalcontactsOrganizationNoteRequest.Builder	PutExternalcontactsOrganizationNoteRequest.Builder.withBody(Note body)
PutExternalcontactsOrganizationNoteRequest	PutExternalcontactsOrganizationNoteRequest.withBody(Note body)
PostExternalcontactsContactNotesRequest.Builder	PostExternalcontactsContactNotesRequest.Builder.withRequiredParams(String contactId, Note body)
PostExternalcontactsOrganizationNotesRequest.Builder	PostExternalcontactsOrganizationNotesRequest.Builder.withRequiredParams(String externalOrganizationId, Note body)
PutExternalcontactsContactNoteRequest.Builder	PutExternalcontactsContactNoteRequest.Builder.withRequiredParams(String contactId, String noteId, Note body)
PutExternalcontactsOrganizationNoteRequest.Builder	PutExternalcontactsOrganizationNoteRequest.Builder.withRequiredParams(String externalOrganizationId, String noteId, Note body)

Uses of Note in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return Note

Modifier and Type	Method	Description
Note	Note.createDate(Date createDate)	Date time is represented as an ISO-8601 string.
Note	Note.createdBy(User createdBy)	When creating or updating a note, only User.id is required.
Note	Note.division(WritableStarrableDivision division)	The division to which this entity belongs.
Note	Note.entityId(String entityId)	The id of the contact or organization to which this note refers.
Note	Note.entityType(Note.EntityTypeEnum entityType)	This is only need to be set when using Bulk API.
Note	BulkEntityErrorNote.getEntity()
Note	BulkResponseResultNoteEntityBulkEntityErrorEntity.getEntity()
Note	BulkResponseResultNoteNoteBulkEntityErrorNote.getEntity()
Note	Note.modifyDate(Date modifyDate)	Date time is represented as an ISO-8601 string.
Note	Note.noteText(String noteText)	Between 1 and 32,000 characters.

Methods in com.mypurecloud.sdk.v2.model that return types with arguments of type Note

Modifier and Type	Method	Description
List<Note>	BulkNotesRequest.getEntities()
List<Note>	CursorNoteListing.getEntities()
List<Note>	NoteListing.getEntities()

Methods in com.mypurecloud.sdk.v2.model with parameters of type Note

Modifier and Type	Method	Description
BulkEntityErrorNote	BulkEntityErrorNote.entity(Note entity)	The entity body specified in the Bulk request operation that caused this error.
BulkResponseResultNoteEntityBulkEntityErrorEntity	BulkResponseResultNoteEntityBulkEntityErrorEntity.entity(Note entity)	The entity which was affected by this Bulk operation.
BulkResponseResultNoteNoteBulkEntityErrorNote	BulkResponseResultNoteNoteBulkEntityErrorNote.entity(Note entity)	The entity which was affected by this Bulk operation.
void	BulkEntityErrorNote.setEntity(Note entity)
void	BulkResponseResultNoteEntityBulkEntityErrorEntity.setEntity(Note entity)
void	BulkResponseResultNoteNoteBulkEntityErrorNote.setEntity(Note entity)

Method parameters in com.mypurecloud.sdk.v2.model with type arguments of type Note

Modifier and Type	Method	Description
BulkNotesRequest	BulkNotesRequest.entities(List<Note> entities)
CursorNoteListing	CursorNoteListing.entities(List<Note> entities)
NoteListing	NoteListing.entities(List<Note> entities)
void	BulkNotesRequest.setEntities(List<Note> entities)
void	CursorNoteListing.setEntities(List<Note> entities)
void	NoteListing.setEntities(List<Note> entities)