Package com.stackone.stackone_client_java

Class Crm

java.lang.Object

com.stackone.stackone_client_java.Crm

public class Crm
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
CrmCreateContactRequestBuilder	createContact()	Creates a new Contact
CrmCreateContactResponse	createContact(java.lang.String xAccountId, CrmCreateContactRequestDto crmCreateContactRequestDto)	Creates a new Contact
CrmCreateContactResponse	createContact(java.lang.String xAccountId, CrmCreateContactRequestDto crmCreateContactRequestDto, java.util.Optional<Options> options)	Creates a new Contact
CrmGetAccountRequestBuilder	getAccount()	Get Account
CrmGetAccountResponse	getAccount(CrmGetAccountRequest request)	Get Account
CrmGetAccountResponse	getAccount(CrmGetAccountRequest request, java.util.Optional<Options> options)	Get Account
CrmGetContactRequestBuilder	getContact()	Get Contact
CrmGetContactResponse	getContact(CrmGetContactRequest request)	Get Contact
CrmGetContactResponse	getContact(CrmGetContactRequest request, java.util.Optional<Options> options)	Get Contact
CrmGetContactCustomFieldDefinitionRequestBuilder	getContactCustomFieldDefinition()	Get Contact Custom Field Definition
CrmGetContactCustomFieldDefinitionResponse	getContactCustomFieldDefinition(CrmGetContactCustomFieldDefinitionRequest request)	Get Contact Custom Field Definition
CrmGetContactCustomFieldDefinitionResponse	getContactCustomFieldDefinition(CrmGetContactCustomFieldDefinitionRequest request, java.util.Optional<Options> options)	Get Contact Custom Field Definition
CrmGetListRequestBuilder	getList()	Get List
CrmGetListResponse	getList(CrmGetListRequest request)	Get List
CrmGetListResponse	getList(CrmGetListRequest request, java.util.Optional<Options> options)	Get List
CrmListAccountsRequestBuilder	listAccounts()	List Accounts
CrmListAccountsResponse	listAccounts(CrmListAccountsRequest request)	List Accounts
CrmListAccountsResponse	listAccounts(CrmListAccountsRequest request, java.util.Optional<Options> options)	List Accounts
CrmListContactCustomFieldDefinitionsRequestBuilder	listContactCustomFieldDefinitions()	List Contact Custom Field Definitions
CrmListContactCustomFieldDefinitionsResponse	listContactCustomFieldDefinitions(CrmListContactCustomFieldDefinitionsRequest request)	List Contact Custom Field Definitions
CrmListContactCustomFieldDefinitionsResponse	listContactCustomFieldDefinitions(CrmListContactCustomFieldDefinitionsRequest request, java.util.Optional<Options> options)	List Contact Custom Field Definitions
CrmListContactsRequestBuilder	listContacts()	List Contacts
CrmListContactsResponse	listContacts(CrmListContactsRequest request)	List Contacts
CrmListContactsResponse	listContacts(CrmListContactsRequest request, java.util.Optional<Options> options)	List Contacts
CrmListListsRequestBuilder	listLists()	Get all Lists
CrmListListsResponse	listLists(CrmListListsRequest request)	Get all Lists
CrmListListsResponse	listLists(CrmListListsRequest request, java.util.Optional<Options> options)	Get all Lists
CrmUpdateContactRequestBuilder	updateContact()	Update Contact (early access)
CrmUpdateContactResponse	updateContact(java.lang.String xAccountId, java.lang.String id, CrmCreateContactRequestDto crmCreateContactRequestDto)	Update Contact (early access)
CrmUpdateContactResponse	updateContact(java.lang.String xAccountId, java.lang.String id, CrmCreateContactRequestDto crmCreateContactRequestDto, java.util.Optional<Options> options)	Update Contact (early access)

Methods inherited from class java.lang.Object

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

Method Detail

listContacts

public CrmListContactsRequestBuilder listContacts()

List Contacts

Returns:

The call builder

listContacts

public CrmListContactsResponse listContacts(CrmListContactsRequest request)
                                     throws java.lang.Exception

List Contacts

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listContacts

public CrmListContactsResponse listContacts(CrmListContactsRequest request,
                                            java.util.Optional<Options> options)
                                     throws java.lang.Exception

List Contacts

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createContact

public CrmCreateContactRequestBuilder createContact()

Creates a new Contact

Returns:

The call builder

createContact

public CrmCreateContactResponse createContact(java.lang.String xAccountId,
                                              CrmCreateContactRequestDto crmCreateContactRequestDto)
                                       throws java.lang.Exception

Creates a new Contact

Parameters:

xAccountId - The account identifier

crmCreateContactRequestDto -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

createContact

public CrmCreateContactResponse createContact(java.lang.String xAccountId,
                                              CrmCreateContactRequestDto crmCreateContactRequestDto,
                                              java.util.Optional<Options> options)
                                       throws java.lang.Exception

Creates a new Contact

Parameters:

xAccountId - The account identifier

crmCreateContactRequestDto -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getContact

public CrmGetContactRequestBuilder getContact()

Get Contact

Returns:

The call builder

getContact

public CrmGetContactResponse getContact(CrmGetContactRequest request)
                                 throws java.lang.Exception

Get Contact

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getContact

public CrmGetContactResponse getContact(CrmGetContactRequest request,
                                        java.util.Optional<Options> options)
                                 throws java.lang.Exception

Get Contact

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

updateContact

public CrmUpdateContactRequestBuilder updateContact()

Update Contact (early access)

Returns:

The call builder

updateContact

public CrmUpdateContactResponse updateContact(java.lang.String xAccountId,
                                              java.lang.String id,
                                              CrmCreateContactRequestDto crmCreateContactRequestDto)
                                       throws java.lang.Exception

Update Contact (early access)

Parameters:

xAccountId - The account identifier

id -

crmCreateContactRequestDto -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

updateContact

public CrmUpdateContactResponse updateContact(java.lang.String xAccountId,
                                              java.lang.String id,
                                              CrmCreateContactRequestDto crmCreateContactRequestDto,
                                              java.util.Optional<Options> options)
                                       throws java.lang.Exception

Update Contact (early access)

Parameters:

xAccountId - The account identifier

id -

crmCreateContactRequestDto -

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listAccounts

public CrmListAccountsRequestBuilder listAccounts()

List Accounts

Returns:

The call builder

listAccounts

public CrmListAccountsResponse listAccounts(CrmListAccountsRequest request)
                                     throws java.lang.Exception

List Accounts

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listAccounts

public CrmListAccountsResponse listAccounts(CrmListAccountsRequest request,
                                            java.util.Optional<Options> options)
                                     throws java.lang.Exception

List Accounts

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getAccount

public CrmGetAccountRequestBuilder getAccount()

Get Account

Returns:

The call builder

getAccount

public CrmGetAccountResponse getAccount(CrmGetAccountRequest request)
                                 throws java.lang.Exception

Get Account

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getAccount

public CrmGetAccountResponse getAccount(CrmGetAccountRequest request,
                                        java.util.Optional<Options> options)
                                 throws java.lang.Exception

Get Account

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listLists

public CrmListListsRequestBuilder listLists()

Get all Lists

Returns:

The call builder

listLists

public CrmListListsResponse listLists(CrmListListsRequest request)
                               throws java.lang.Exception

Get all Lists

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listLists

public CrmListListsResponse listLists(CrmListListsRequest request,
                                      java.util.Optional<Options> options)
                               throws java.lang.Exception

Get all Lists

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getList

public CrmGetListRequestBuilder getList()

Get List

Returns:

The call builder

getList

public CrmGetListResponse getList(CrmGetListRequest request)
                           throws java.lang.Exception

Get List

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getList

public CrmGetListResponse getList(CrmGetListRequest request,
                                  java.util.Optional<Options> options)
                           throws java.lang.Exception

Get List

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listContactCustomFieldDefinitions

public CrmListContactCustomFieldDefinitionsRequestBuilder listContactCustomFieldDefinitions()

List Contact Custom Field Definitions

Returns:

The call builder

listContactCustomFieldDefinitions

public CrmListContactCustomFieldDefinitionsResponse listContactCustomFieldDefinitions(CrmListContactCustomFieldDefinitionsRequest request)
                                                                               throws java.lang.Exception

List Contact Custom Field Definitions

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

listContactCustomFieldDefinitions

public CrmListContactCustomFieldDefinitionsResponse listContactCustomFieldDefinitions(CrmListContactCustomFieldDefinitionsRequest request,
                                                                                      java.util.Optional<Options> options)
                                                                               throws java.lang.Exception

List Contact Custom Field Definitions

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getContactCustomFieldDefinition

public CrmGetContactCustomFieldDefinitionRequestBuilder getContactCustomFieldDefinition()

Get Contact Custom Field Definition

Returns:

The call builder

getContactCustomFieldDefinition

public CrmGetContactCustomFieldDefinitionResponse getContactCustomFieldDefinition(CrmGetContactCustomFieldDefinitionRequest request)
                                                                           throws java.lang.Exception

Get Contact Custom Field Definition

Parameters:

request - The request object containing all the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getContactCustomFieldDefinition

public CrmGetContactCustomFieldDefinitionResponse getContactCustomFieldDefinition(CrmGetContactCustomFieldDefinitionRequest request,
                                                                                  java.util.Optional<Options> options)
                                                                           throws java.lang.Exception

Get Contact Custom Field Definition

Parameters:

request - The request object containing all the parameters for the API call.

options - additional options

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails