Skip to content

Class: ContactControllerApi

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ContactControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createContact

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

Create a contact

Parameters

Name Type
requestParameters CreateContactRequest
initOverrides? RequestInit

Returns

Promise<ContactDto>


createContactRaw

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

Create a contact

Parameters

Name Type
requestParameters CreateContactRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<ContactDto>>


deleteContact

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

Delete contact

Parameters

Name Type
requestParameters DeleteContactRequest
initOverrides? RequestInit

Returns

Promise<void>


deleteContactRaw

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

Delete contact

Parameters

Name Type
requestParameters DeleteContactRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>


getAllContacts

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

Get all contacts

Parameters

Name Type
requestParameters GetAllContactsRequest
initOverrides? RequestInit

Returns

Promise<PageContactProjection>


getAllContactsRaw

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

Get all contacts

Parameters

Name Type
requestParameters GetAllContactsRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<PageContactProjection>>


getContact

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

Get contact

Parameters

Name Type
requestParameters GetContactRequest
initOverrides? RequestInit

Returns

Promise<ContactDto>


getContactRaw

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

Get contact

Parameters

Name Type
requestParameters GetContactRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<ContactDto>>


getContactVCard

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

Get contact vCard vcf file

Parameters

Name Type
requestParameters GetContactVCardRequest
initOverrides? RequestInit

Returns

Promise<string[]>


getContactVCardRaw

getContactVCardRaw(requestParameters, initOverrides?): Promise<ApiResponse<string[]>>

Get contact vCard vcf file

Parameters

Name Type
requestParameters GetContactVCardRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<string[]>>


getContacts

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

Get all contacts

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ContactProjection[]>


getContactsRaw

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

Get all contacts

Parameters

Name Type
initOverrides? RequestInit

Returns

Promise<ApiResponse<ContactProjection[]>>


request

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

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
this T
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware