
public final class ContactControllerApi
extends ApiClient

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`ContactControllerApi.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`baseUrl`

Constructor Summary

Constructors
Constructor	Description
`ContactControllerApi(String xApiKey, String basePath)`

Method Summary

Modifier and Type	Method	Description
`final String`	`getBaseUrl()`
`final ContactDto`	`createContact(CreateContactOptions createContactOptions)`	Create a contact
`final RequestConfig`	`createContactRequestConfig(CreateContactOptions createContactOptions)`	To obtain the request config of the operation createContact
`final Unit`	`deleteContact(UUID contactId)`	Delete contact
`final RequestConfig`	`deleteContactRequestConfig(UUID contactId)`	To obtain the request config of the operation deleteContact
`final PageContactProjection`	`getAllContacts(Integer page, Integer size, String sort)`	Get all contacts
`final RequestConfig`	`getAllContactsRequestConfig(Integer page, Integer size, String sort)`	To obtain the request config of the operation getAllContacts
`final ContactDto`	`getContact(UUID contactId)`	Get contact
`final RequestConfig`	`getContactRequestConfig(UUID contactId)`	To obtain the request config of the operation getContact
`final ByteArray`	`getContactVCard(UUID contactId)`	Get contact vCard vcf file
`final RequestConfig`	`getContactVCardRequestConfig(UUID contactId)`	To obtain the request config of the operation getContactVCard
`final List<ContactProjection>`	`getContacts()`	Get all contacts
`final RequestConfig`	`getContactsRequestConfig()`	To obtain the request config of the operation getContacts

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ContactControllerApi
```
ContactControllerApi(String xApiKey, String basePath)
```
- Method Detail
  - getBaseUrl
```
 final String getBaseUrl()
```
  - createContact
```
 final ContactDto createContact(CreateContactOptions createContactOptions)
```
    Create a contact
    
    Parameters:
    
    createContactOptions - createContactOptions
  - createContactRequestConfig
```
 final RequestConfig createContactRequestConfig(CreateContactOptions createContactOptions)
```
    To obtain the request config of the operation createContact
    
    Parameters:
    
    createContactOptions - createContactOptions
  - deleteContact
```
 final Unit deleteContact(UUID contactId)
```
    Delete contact
    
    Parameters:
    
    contactId - contactId
  - deleteContactRequestConfig
```
 final RequestConfig deleteContactRequestConfig(UUID contactId)
```
    To obtain the request config of the operation deleteContact
    
    Parameters:
    
    contactId - contactId
  - getAllContacts
```
 final PageContactProjection getAllContacts(Integer page, Integer size, String sort)
```
    Get all contacts
    
    Parameters:
    
    page - Optional page index in inbox list pagination (optional, default to 0)
    
    size - Optional page size in inbox list pagination (optional, default to 20)
    
    sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)
  - getAllContactsRequestConfig
```
 final RequestConfig getAllContactsRequestConfig(Integer page, Integer size, String sort)
```
    To obtain the request config of the operation getAllContacts
    
    Parameters:
    
    page - Optional page index in inbox list pagination (optional, default to 0)
    
    size - Optional page size in inbox list pagination (optional, default to 20)
    
    sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)
  - getContact
```
 final ContactDto getContact(UUID contactId)
```
    Get contact
    
    Parameters:
    
    contactId - contactId
  - getContactRequestConfig
```
 final RequestConfig getContactRequestConfig(UUID contactId)
```
    To obtain the request config of the operation getContact
    
    Parameters:
    
    contactId - contactId
  - getContactVCard
```
 final ByteArray getContactVCard(UUID contactId)
```
    Get contact vCard vcf file
    
    Parameters:
    
    contactId - contactId
  - getContactVCardRequestConfig
```
 final RequestConfig getContactVCardRequestConfig(UUID contactId)
```
    To obtain the request config of the operation getContactVCard
    
    Parameters:
    
    contactId - contactId
  - getContacts
```
 final List<ContactProjection> getContacts()
```
    Get all contacts
  - getContactsRequestConfig
```
 final RequestConfig getContactsRequestConfig()
```
    To obtain the request config of the operation getContacts

Class ContactControllerApi

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ContactControllerApi

Method Detail

getBaseUrl

createContact

createContactRequestConfig

deleteContact

deleteContactRequestConfig

getAllContacts

getAllContactsRequestConfig

getContact

getContactRequestConfig

getContactVCard

getContactVCardRequestConfig

getContacts

getContactsRequestConfig