Package software.xdev.brevo.api

Class DealsApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.DealsApi

public class DealsApi
extends BaseApi

Field Summary

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

apiClient

Constructor Summary

Constructors

Constructor	Description
DealsApi()
DealsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
List<DealAttributesInner>	crmAttributesDealsGet()	Get deal attributes
List<DealAttributesInner>	crmAttributesDealsGet(Map<String,String> additionalHeaders)	Get deal attributes
DealsList	crmDealsGet(String filtersAttributesDealName, String filtersLinkedCompaniesIds, String filtersLinkedContactsIds, Long offset, Long limit, String sort)	Get all deals
DealsList	crmDealsGet(String filtersAttributesDealName, String filtersLinkedCompaniesIds, String filtersLinkedContactsIds, Long offset, Long limit, String sort, Map<String,String> additionalHeaders)	Get all deals
void	crmDealsIdDelete(String id)	Delete a deal
void	crmDealsIdDelete(String id, Map<String,String> additionalHeaders)	Delete a deal
Deal	crmDealsIdGet(String id)	Get a deal
Deal	crmDealsIdGet(String id, Map<String,String> additionalHeaders)	Get a deal
void	crmDealsIdPatch(String id, CrmDealsIdPatchRequest crmDealsIdPatchRequest)	Update a deal
void	crmDealsIdPatch(String id, CrmDealsIdPatchRequest crmDealsIdPatchRequest, Map<String,String> additionalHeaders)	Update a deal
void	crmDealsLinkUnlinkIdPatch(String id, CrmDealsLinkUnlinkIdPatchRequest crmDealsLinkUnlinkIdPatchRequest)	Link and Unlink a deal with contacts and companies
void	crmDealsLinkUnlinkIdPatch(String id, CrmDealsLinkUnlinkIdPatchRequest crmDealsLinkUnlinkIdPatchRequest, Map<String,String> additionalHeaders)	Link and Unlink a deal with contacts and companies
CrmDealsPost201Response	crmDealsPost(CrmDealsPostRequest crmDealsPostRequest)	Create a deal
CrmDealsPost201Response	crmDealsPost(CrmDealsPostRequest crmDealsPostRequest, Map<String,String> additionalHeaders)	Create a deal
List<Pipeline>	crmPipelineDetailsAllGet()	Get all pipelines
List<Pipeline>	crmPipelineDetailsAllGet(Map<String,String> additionalHeaders)	Get all pipelines
Pipeline	crmPipelineDetailsGet()	Deprecated.
Pipeline	crmPipelineDetailsGet(Map<String,String> additionalHeaders)	Deprecated.
List<Pipeline>	crmPipelineDetailsPipelineIDGet(String pipelineID)	Get a pipeline
List<Pipeline>	crmPipelineDetailsPipelineIDGet(String pipelineID, Map<String,String> additionalHeaders)	Get a pipeline
<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

DealsApi

public DealsApi()

DealsApi

public DealsApi(ApiClient apiClient)

Method Details

crmAttributesDealsGet

public List<DealAttributesInner> crmAttributesDealsGet()
                                                throws ApiException

Get deal attributes

Returns:

List<DealAttributesInner>

Throws:

ApiException - if fails to make API call

crmAttributesDealsGet

public List<DealAttributesInner> crmAttributesDealsGet(Map<String,String> additionalHeaders)
                                                throws ApiException

Get deal attributes

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<DealAttributesInner>

Throws:

ApiException - if fails to make API call

crmDealsGet

public DealsList crmDealsGet(String filtersAttributesDealName,
 String filtersLinkedCompaniesIds,
 String filtersLinkedContactsIds,
 Long offset,
 Long limit,
 String sort)
                      throws ApiException

Get all deals

Parameters:

filtersAttributesDealName - Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`. (optional)

filtersLinkedCompaniesIds - Filter by linked companies ids (optional)

filtersLinkedContactsIds - Filter by linked companies ids (optional)

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

limit - Number of documents per page (optional)

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

Returns:

DealsList

Throws:

ApiException - if fails to make API call

crmDealsGet

public DealsList crmDealsGet(String filtersAttributesDealName,
 String filtersLinkedCompaniesIds,
 String filtersLinkedContactsIds,
 Long offset,
 Long limit,
 String sort,
 Map<String,String> additionalHeaders)
                      throws ApiException

Get all deals

Parameters:

filtersAttributesDealName - Filter by attributes. If you have filter for owner on your side please send it as `filters[attributes.deal_owner]`. (optional)

filtersLinkedCompaniesIds - Filter by linked companies ids (optional)

filtersLinkedContactsIds - Filter by linked companies ids (optional)

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

limit - Number of documents per page (optional)

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:

DealsList

Throws:

ApiException - if fails to make API call

crmDealsIdDelete

public void crmDealsIdDelete(String id)
                      throws ApiException

Delete a deal

Parameters:

id - (required)

Throws:

ApiException - if fails to make API call

crmDealsIdDelete

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

Delete a deal

Parameters:

id - (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmDealsIdGet

public Deal crmDealsIdGet(String id)
                   throws ApiException

Get a deal

Parameters:

id - (required)

Returns:

Deal

Throws:

ApiException - if fails to make API call

crmDealsIdGet

public Deal crmDealsIdGet(String id,
 Map<String,String> additionalHeaders)
                   throws ApiException

Get a deal

Parameters:

id - (required)

additionalHeaders - additionalHeaders for this call

Returns:

Deal

Throws:

ApiException - if fails to make API call

crmDealsIdPatch

public void crmDealsIdPatch(String id,
 CrmDealsIdPatchRequest crmDealsIdPatchRequest)
                     throws ApiException

Update a deal

Parameters:

id - (required)

crmDealsIdPatchRequest - Updated deal details. (required)

Throws:

ApiException - if fails to make API call

crmDealsIdPatch

public void crmDealsIdPatch(String id,
 CrmDealsIdPatchRequest crmDealsIdPatchRequest,
 Map<String,String> additionalHeaders)
                     throws ApiException

Update a deal

Parameters:

id - (required)

crmDealsIdPatchRequest - Updated deal details. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmDealsLinkUnlinkIdPatch

public void crmDealsLinkUnlinkIdPatch(String id,
 CrmDealsLinkUnlinkIdPatchRequest crmDealsLinkUnlinkIdPatchRequest)
                               throws ApiException

Link and Unlink a deal with contacts and companies

Parameters:

id - (required)

crmDealsLinkUnlinkIdPatchRequest - Linked / Unlinked contacts and companies ids. (required)

Throws:

ApiException - if fails to make API call

crmDealsLinkUnlinkIdPatch

public void crmDealsLinkUnlinkIdPatch(String id,
 CrmDealsLinkUnlinkIdPatchRequest crmDealsLinkUnlinkIdPatchRequest,
 Map<String,String> additionalHeaders)
                               throws ApiException

Link and Unlink a deal with contacts and companies

Parameters:

id - (required)

crmDealsLinkUnlinkIdPatchRequest - Linked / Unlinked contacts and companies ids. (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

crmDealsPost

public CrmDealsPost201Response crmDealsPost(CrmDealsPostRequest crmDealsPostRequest)
                                     throws ApiException

Create a deal

Parameters:

crmDealsPostRequest - Deal create data. (required)

Returns:

CrmDealsPost201Response

Throws:

ApiException - if fails to make API call

crmDealsPost

public CrmDealsPost201Response crmDealsPost(CrmDealsPostRequest crmDealsPostRequest,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Create a deal

Parameters:

crmDealsPostRequest - Deal create data. (required)

additionalHeaders - additionalHeaders for this call

Returns:

CrmDealsPost201Response

Throws:

ApiException - if fails to make API call

crmPipelineDetailsAllGet

public List<Pipeline> crmPipelineDetailsAllGet()
                                        throws ApiException

Get all pipelines

Returns:

List<Pipeline>

Throws:

ApiException - if fails to make API call

crmPipelineDetailsAllGet

public List<Pipeline> crmPipelineDetailsAllGet(Map<String,String> additionalHeaders)
                                        throws ApiException

Get all pipelines

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<Pipeline>

Throws:

ApiException - if fails to make API call

crmPipelineDetailsGet

@Deprecated
public Pipeline crmPipelineDetailsGet()
                               throws ApiException

Deprecated.

Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/{pipelineID} instead.

Returns:

Pipeline

Throws:

ApiException - if fails to make API call

crmPipelineDetailsGet

@Deprecated
public Pipeline crmPipelineDetailsGet(Map<String,String> additionalHeaders)
                               throws ApiException

Deprecated.

Get pipeline stages This endpoint is deprecated. Prefer /crm/pipeline/details/{pipelineID} instead.

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

Pipeline

Throws:

ApiException - if fails to make API call

crmPipelineDetailsPipelineIDGet

public List<Pipeline> crmPipelineDetailsPipelineIDGet(String pipelineID)
                                               throws ApiException

Get a pipeline

Parameters:

pipelineID - (required)

Returns:

List<Pipeline>

Throws:

ApiException - if fails to make API call

crmPipelineDetailsPipelineIDGet

public List<Pipeline> crmPipelineDetailsPipelineIDGet(String pipelineID,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Get a pipeline

Parameters:

pipelineID - (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<Pipeline>

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.