Package software.xdev.brevo.api

Class TasksApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.TasksApi

public class TasksApi
extends BaseApi

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
TasksApi()
TasksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
TaskList	crmTasksGet(String filterType, String filterStatus, String filterDate, String filterAssignTo, String filterContacts, String filterDeals, String filterCompanies, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, String sortBy)	Get all tasks
TaskList	crmTasksGet(String filterType, String filterStatus, String filterDate, String filterAssignTo, String filterContacts, String filterDeals, String filterCompanies, Integer dateFrom, Integer dateTo, Long offset, Long limit, String sort, String sortBy, Map<String,String> additionalHeaders)	Get all tasks
void	crmTasksIdDelete(String id)	Delete a task
void	crmTasksIdDelete(String id, Map<String,String> additionalHeaders)	Delete a task
Task	crmTasksIdGet(String id)	Get a task
Task	crmTasksIdGet(String id, Map<String,String> additionalHeaders)	Get a task
void	crmTasksIdPatch(String id, CrmTasksIdPatchRequest crmTasksIdPatchRequest)	Update a task
void	crmTasksIdPatch(String id, CrmTasksIdPatchRequest crmTasksIdPatchRequest, Map<String,String> additionalHeaders)	Update a task
CrmTasksPost201Response	crmTasksPost(CrmTasksPostRequest crmTasksPostRequest)	Create a task
CrmTasksPost201Response	crmTasksPost(CrmTasksPostRequest crmTasksPostRequest, Map<String,String> additionalHeaders)	Create a task
TaskTypes	crmTasktypesGet()	Get all task types
TaskTypes	crmTasktypesGet(Map<String,String> additionalHeaders)	Get all task types
<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

TasksApi

public TasksApi()

TasksApi

public TasksApi(ApiClient apiClient)

Method Details

crmTasksGet

public TaskList crmTasksGet(@Nullable
 String filterType,
 @Nullable
 String filterStatus,
 @Nullable
 String filterDate,
 @Nullable
 String filterAssignTo,
 @Nullable
 String filterContacts,
 @Nullable
 String filterDeals,
 @Nullable
 String filterCompanies,
 @Nullable
 Integer dateFrom,
 @Nullable
 Integer dateTo,
 @Nullable
 Long offset,
 @Nullable
 Long limit,
 @Nullable
 String sort,
 @Nullable
 String sortBy)
                     throws ApiException

Get all tasks

Parameters:

filterType - Filter by task type (ID) (optional)

filterStatus - Filter by task status (optional)

filterDate - Filter by date (optional)

filterAssignTo - Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute. (optional)

filterContacts - Filter by contact ids (optional)

filterDeals - Filter by deals ids (optional)

filterCompanies - Filter by companies 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)

sortBy - The field used to sort field names. (optional)

Returns:

TaskList

Throws:

ApiException - if fails to make API call

crmTasksGet

public TaskList crmTasksGet(@Nullable
 String filterType,
 @Nullable
 String filterStatus,
 @Nullable
 String filterDate,
 @Nullable
 String filterAssignTo,
 @Nullable
 String filterContacts,
 @Nullable
 String filterDeals,
 @Nullable
 String filterCompanies,
 @Nullable
 Integer dateFrom,
 @Nullable
 Integer dateTo,
 @Nullable
 Long offset,
 @Nullable
 Long limit,
 @Nullable
 String sort,
 @Nullable
 String sortBy,
 Map<String,String> additionalHeaders)
                     throws ApiException

Get all tasks

Parameters:

filterType - Filter by task type (ID) (optional)

filterStatus - Filter by task status (optional)

filterDate - Filter by date (optional)

filterAssignTo - Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute. (optional)

filterContacts - Filter by contact ids (optional)

filterDeals - Filter by deals ids (optional)

filterCompanies - Filter by companies 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)

sortBy - The field used to sort field names. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

TaskList

Throws:

ApiException - if fails to make API call

crmTasksIdDelete

public void crmTasksIdDelete(@Nonnull
 String id)
                      throws ApiException

Delete a task

Parameters:

id - (required)

Throws:

ApiException - if fails to make API call

crmTasksIdDelete

public void crmTasksIdDelete(@Nonnull
 String id,
 Map<String,String> additionalHeaders)
                      throws ApiException

Delete a task

Parameters:

id - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmTasksIdGet

public Task crmTasksIdGet(@Nonnull
 String id)
                   throws ApiException

Get a task

Parameters:

id - (required)

Returns:

Task

Throws:

ApiException - if fails to make API call

crmTasksIdGet

public Task crmTasksIdGet(@Nonnull
 String id,
 Map<String,String> additionalHeaders)
                   throws ApiException

Get a task

Parameters:

id - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Task

Throws:

ApiException - if fails to make API call

crmTasksIdPatch

public void crmTasksIdPatch(@Nonnull
 String id,
 @Nonnull
 CrmTasksIdPatchRequest crmTasksIdPatchRequest)
                     throws ApiException

Update a task

Parameters:

id - (required)

crmTasksIdPatchRequest - Updated task details. (required)

Throws:

ApiException - if fails to make API call

crmTasksIdPatch

public void crmTasksIdPatch(@Nonnull
 String id,
 @Nonnull
 CrmTasksIdPatchRequest crmTasksIdPatchRequest,
 Map<String,String> additionalHeaders)
                     throws ApiException

Update a task

Parameters:

id - (required)

crmTasksIdPatchRequest - Updated task details. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmTasksPost

public CrmTasksPost201Response crmTasksPost(@Nonnull
 CrmTasksPostRequest crmTasksPostRequest)
                                     throws ApiException

Create a task

Parameters:

crmTasksPostRequest - Task name. (required)

Returns:

CrmTasksPost201Response

Throws:

ApiException - if fails to make API call

crmTasksPost

public CrmTasksPost201Response crmTasksPost(@Nonnull
 CrmTasksPostRequest crmTasksPostRequest,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Create a task

Parameters:

crmTasksPostRequest - Task name. (required)

additionalHeaders - additionalHeaders for this call

Returns:

CrmTasksPost201Response

Throws:

ApiException - if fails to make API call

crmTasktypesGet

public TaskTypes crmTasktypesGet()
                          throws ApiException

Get all task types

Returns:

TaskTypes

Throws:

ApiException - if fails to make API call

crmTasktypesGet

public TaskTypes crmTasktypesGet(Map<String,String> additionalHeaders)
                          throws ApiException

Get all task types

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

TaskTypes

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.