Class ContactControllerApi

Hierarchy

BaseAPI
- ContactControllerApi

Index

Constructors

Properties

Methods

createContact createContactRaw deleteContact deleteContactRaw getAllContacts getAllContactsRaw getContact getContactRaw getContactVCard getContactVCardRaw getContacts getContactsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ContactControllerApi(configuration?: Configuration): ContactControllerApi
Parameters
- configuration: Configuration = ...
Returns ContactControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createContact

createContact(requestParameters: CreateContactRequest, initOverrides?: RequestInit): Promise<ContactDto>
Create a contact
Parameters
- requestParameters: CreateContactRequest
- Optional initOverrides: RequestInit
Returns Promise<ContactDto>

createContactRaw

createContactRaw(requestParameters: CreateContactRequest, initOverrides?: RequestInit): Promise<ApiResponse<ContactDto>>
Create a contact
Parameters
- requestParameters: CreateContactRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ContactDto>>

deleteContact

deleteContact(requestParameters: DeleteContactRequest, initOverrides?: RequestInit): Promise<void>
Delete contact
Parameters
- requestParameters: DeleteContactRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteContactRaw

deleteContactRaw(requestParameters: DeleteContactRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete contact
Parameters
- requestParameters: DeleteContactRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getAllContacts

getAllContacts(requestParameters: GetAllContactsRequest, initOverrides?: RequestInit): Promise<PageContactProjection>
Get all contacts
Parameters
- requestParameters: GetAllContactsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageContactProjection>

getAllContactsRaw

getAllContactsRaw(requestParameters: GetAllContactsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageContactProjection>>
Get all contacts
Parameters
- requestParameters: GetAllContactsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageContactProjection>>

getContact

getContact(requestParameters: GetContactRequest, initOverrides?: RequestInit): Promise<ContactDto>
Get contact
Parameters
- requestParameters: GetContactRequest
- Optional initOverrides: RequestInit
Returns Promise<ContactDto>

getContactRaw

getContactRaw(requestParameters: GetContactRequest, initOverrides?: RequestInit): Promise<ApiResponse<ContactDto>>
Get contact
Parameters
- requestParameters: GetContactRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ContactDto>>

getContactVCard

getContactVCard(requestParameters: GetContactVCardRequest, initOverrides?: RequestInit): Promise<void>
Get contact vCard vcf file
Parameters
- requestParameters: GetContactVCardRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

getContactVCardRaw

getContactVCardRaw(requestParameters: GetContactVCardRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Get contact vCard vcf file
Parameters
- requestParameters: GetContactVCardRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getContacts

getContacts(initOverrides?: RequestInit): Promise<ContactProjection[]>
Get all contacts
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ContactProjection[]>

getContactsRaw

getContactsRaw(initOverrides?: RequestInit): Promise<ApiResponse<ContactProjection[]>>
Get all contacts
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ContactProjection[]>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware