Class: ContactControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ContactControllerApi(configuration?)

Parameters

NameType
configurationConfiguration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createContact

createContact(requestParameters, initOverrides?): Promise<ContactDto>

Create a contact

Parameters

NameType
requestParametersCreateContactRequest
initOverrides?RequestInit

Returns

Promise<ContactDto>


createContactRaw

createContactRaw(requestParameters, initOverrides?): Promise<ApiResponse<ContactDto»

Create a contact

Parameters

NameType
requestParametersCreateContactRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<ContactDto»


deleteContact

deleteContact(requestParameters, initOverrides?): Promise<void>

Delete contact

Parameters

NameType
requestParametersDeleteContactRequest
initOverrides?RequestInit

Returns

Promise<void>


deleteContactRaw

deleteContactRaw(requestParameters, initOverrides?): Promise<ApiResponse<void»

Delete contact

Parameters

NameType
requestParametersDeleteContactRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<void»


getAllContacts

getAllContacts(requestParameters, initOverrides?): Promise<PageContactProjection>

Get all contacts

Parameters

NameType
requestParametersGetAllContactsRequest
initOverrides?RequestInit

Returns

Promise<PageContactProjection>


getAllContactsRaw

getAllContactsRaw(requestParameters, initOverrides?): Promise<ApiResponse<PageContactProjection»

Get all contacts

Parameters

NameType
requestParametersGetAllContactsRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<PageContactProjection»


getContact

getContact(requestParameters, initOverrides?): Promise<ContactDto>

Get contact

Parameters

NameType
requestParametersGetContactRequest
initOverrides?RequestInit

Returns

Promise<ContactDto>


getContactRaw

getContactRaw(requestParameters, initOverrides?): Promise<ApiResponse<ContactDto»

Get contact

Parameters

NameType
requestParametersGetContactRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<ContactDto»


getContactVCard

getContactVCard(requestParameters, initOverrides?): Promise<string>

Get contact vCard vcf file

Parameters

NameType
requestParametersGetContactVCardRequest
initOverrides?RequestInit

Returns

Promise<string>


getContactVCardRaw

getContactVCardRaw(requestParameters, initOverrides?): Promise<ApiResponse<string»

Get contact vCard vcf file

Parameters

NameType
requestParametersGetContactVCardRequest
initOverrides?RequestInit

Returns

Promise<ApiResponse<string»


getContacts

getContacts(initOverrides?): Promise<ContactProjection[]>

Get all contacts

Parameters

NameType
initOverrides?RequestInit

Returns

Promise<ContactProjection[]>


getContactsRaw

getContactsRaw(initOverrides?): Promise<ApiResponse<ContactProjection[]»

Get all contacts

Parameters

NameType
initOverrides?RequestInit

Returns

Promise<ApiResponse<ContactProjection[]»


request

Protected request(context, initOverrides?): Promise<Response>

Parameters

NameType
contextRequestOpts
initOverrides?RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(…middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(…postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...postMiddlewares(context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(…preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
...preMiddlewares(context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware