Package software.xdev.brevo.api

Class NotesApi

java.lang.Object

software.xdev.brevo.api.NotesApi

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class NotesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
NotesApi()
NotesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<Note>	crmNotesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort)	Get all notes
List<Note>	crmNotesGet(String entity, String entityIds, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, Map<String,String> additionalHeaders)	Get all notes
void	crmNotesIdDelete(String id)	Delete a note
void	crmNotesIdDelete(String id, Map<String,String> additionalHeaders)	Delete a note
Note	crmNotesIdGet(String id)	Get a note
Note	crmNotesIdGet(String id, Map<String,String> additionalHeaders)	Get a note
void	crmNotesIdPatch(String id, NoteData noteData)	Update a note
void	crmNotesIdPatch(String id, NoteData noteData, Map<String,String> additionalHeaders)	Update a note
NoteId	crmNotesPost(NoteData noteData)	Create a note
NoteId	crmNotesPost(NoteData noteData, Map<String,String> additionalHeaders)	Create a note
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NotesApi

public NotesApi()

NotesApi

public NotesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

crmNotesGet

public List<Note> crmNotesGet(String entity,
 String entityIds,
 Integer dateFrom,
 Integer dateTo,
 Long offset,
 Long limit,
 String sort)
                       throws ApiException

Get all notes

Parameters:

entity - Filter by note entity type (optional)

entityIds - Filter by note entity IDs (optional)

dateFrom - dateFrom to date range filter type (timestamp in milliseconds) (optional)

dateTo - dateTo to date range filter type (timestamp in milliseconds) (optional)

offset - Index of the first document of the page (optional)

limit - Number of documents per page (optional, default to 50)

sort - Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)

Returns:

List<Note>

Throws:

ApiException - if fails to make API call

crmNotesGet

public List<Note> crmNotesGet(String entity,
 String entityIds,
 Integer dateFrom,
 Integer dateTo,
 Long offset,
 Long limit,
 String sort,
 Map<String,String> additionalHeaders)
                       throws ApiException

Get all notes

Parameters:

entity - Filter by note entity type (optional)

entityIds - Filter by note entity IDs (optional)

dateFrom - dateFrom to date range filter type (timestamp in milliseconds) (optional)

dateTo - dateTo to date range filter type (timestamp in milliseconds) (optional)

offset - Index of the first document of the page (optional)

limit - Number of documents per page (optional, default to 50)

sort - Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<Note>

Throws:

ApiException - if fails to make API call

crmNotesIdDelete

public void crmNotesIdDelete(String id)
                      throws ApiException

Delete a note

Parameters:

id - Note ID to delete (required)

Throws:

ApiException - if fails to make API call

crmNotesIdDelete

public void crmNotesIdDelete(String id,
 Map<String,String> additionalHeaders)
                      throws ApiException

Delete a note

Parameters:

id - Note ID to delete (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmNotesIdGet

public Note crmNotesIdGet(String id)
                   throws ApiException

Get a note

Parameters:

id - Note ID to get (required)

Returns:

Note

Throws:

ApiException - if fails to make API call

crmNotesIdGet

public Note crmNotesIdGet(String id,
 Map<String,String> additionalHeaders)
                   throws ApiException

Get a note

Parameters:

id - Note ID to get (required)

additionalHeaders - additionalHeaders for this call

Returns:

Note

Throws:

ApiException - if fails to make API call

crmNotesIdPatch

public void crmNotesIdPatch(String id,
 NoteData noteData)
                     throws ApiException

Update a note

Parameters:

id - Note ID to update (required)

noteData - Note data to update a note. (required)

Throws:

ApiException - if fails to make API call

crmNotesIdPatch

public void crmNotesIdPatch(String id,
 NoteData noteData,
 Map<String,String> additionalHeaders)
                     throws ApiException

Update a note

Parameters:

id - Note ID to update (required)

noteData - Note data to update a note. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmNotesPost

public NoteId crmNotesPost(NoteData noteData)
                    throws ApiException

Create a note

Parameters:

noteData - Note data to create a note. (required)

Returns:

NoteId

Throws:

ApiException - if fails to make API call

crmNotesPost

public NoteId crmNotesPost(NoteData noteData,
 Map<String,String> additionalHeaders)
                    throws ApiException

Create a note

Parameters:

noteData - Note data to create a note. (required)

additionalHeaders - additionalHeaders for this call

Returns:

NoteId

Throws:

ApiException - if fails to make API call