-
public final class ContactControllerApi extends ApiClient
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classContactControllerApi.Companion
-
Constructor Summary
Constructors Constructor Description ContactControllerApi(String xApiKey, String basePath)
-
Method Summary
Modifier and Type Method Description final StringgetBaseUrl()final ContactDtocreateContact(CreateContactOptions createContactOptions)Create a contact final RequestConfigcreateContactRequestConfig(CreateContactOptions createContactOptions)To obtain the request config of the operation createContact final UnitdeleteContact(UUID contactId)Delete contact final RequestConfigdeleteContactRequestConfig(UUID contactId)To obtain the request config of the operation deleteContact final PageContactProjectiongetAllContacts(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)Get all contacts final RequestConfiggetAllContactsRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)To obtain the request config of the operation getAllContacts final ContactDtogetContact(UUID contactId)Get contact final RequestConfiggetContactRequestConfig(UUID contactId)To obtain the request config of the operation getContact final List<ByteArray>getContactVCard(UUID contactId)Get contact vCard vcf file final RequestConfiggetContactVCardRequestConfig(UUID contactId)To obtain the request config of the operation getContactVCard final List<ContactProjection>getContacts()Get all contacts final RequestConfiggetContactsRequestConfig()To obtain the request config of the operation getContacts -
-
Method Detail
-
getBaseUrl
final String getBaseUrl()
-
createContact
final ContactDto createContact(CreateContactOptions createContactOptions)
Create a contact
-
createContactRequestConfig
final RequestConfig createContactRequestConfig(CreateContactOptions createContactOptions)
To obtain the request config of the operation createContact
-
deleteContact
final Unit deleteContact(UUID contactId)
Delete contact
-
deleteContactRequestConfig
final RequestConfig deleteContactRequestConfig(UUID contactId)
To obtain the request config of the operation deleteContact
-
getAllContacts
final PageContactProjection getAllContacts(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
Get all contacts
- Parameters:
page- Optional page index in list pagination (optional, default to 0)size- Optional page size in list pagination (optional, default to 20)sort- Optional createdAt sort direction ASC or DESC (optional, default to ASC)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getAllContactsRequestConfig
final RequestConfig getAllContactsRequestConfig(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before)
To obtain the request config of the operation getAllContacts
- Parameters:
page- Optional page index in list pagination (optional, default to 0)size- Optional page size in list pagination (optional, default to 20)sort- Optional createdAt sort direction ASC or DESC (optional, default to ASC)since- Filter by created at after the given timestamp (optional)before- Filter by created at before the given timestamp (optional)
-
getContact
final ContactDto getContact(UUID contactId)
Get contact
-
getContactRequestConfig
final RequestConfig getContactRequestConfig(UUID contactId)
To obtain the request config of the operation getContact
-
getContactVCard
final List<ByteArray> getContactVCard(UUID contactId)
Get contact vCard vcf file
-
getContactVCardRequestConfig
final RequestConfig getContactVCardRequestConfig(UUID contactId)
To obtain the request config of the operation getContactVCard
-
getContacts
final List<ContactProjection> getContacts()
Get all contacts
-
getContactsRequestConfig
final RequestConfig getContactsRequestConfig()
To obtain the request config of the operation getContacts
-
-
-
-