Package software.xdev.brevo.api

Class NotesApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.NotesApi

public class NotesApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

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
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

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

crmNotesGet

public List<Note> crmNotesGet(@Nullable
 String entity,
 @Nullable
 String entityIds,
 @Nullable
 Integer dateFrom,
 @Nullable
 Integer dateTo,
 @Nullable
 Long offset,
 @Nullable
 Long limit,
 @Nullable
 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(@Nullable
 String entity,
 @Nullable
 String entityIds,
 @Nullable
 Integer dateFrom,
 @Nullable
 Integer dateTo,
 @Nullable
 Long offset,
 @Nullable
 Long limit,
 @Nullable
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 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(@Nonnull
 String id,
 @Nonnull
 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(@Nonnull
 String id,
 @Nonnull
 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(@Nonnull
 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(@Nonnull
 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

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.