# Class: ContactControllerApi

ContactControllerApi - object-oriented interface

export

class ContactControllerApi

extends {BaseAPI}

# Hierarchy

# Constructors

# constructor

+ new ContactControllerApi(configuration?: Configuration, basePath: string, fetch: FetchAPI): ContactControllerApi

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

Name Type Default
configuration? Configuration -
basePath string BASE_PATH
fetch FetchAPI portableFetch

Returns: ContactControllerApi

# Properties

# Protected basePath

basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


# Protected configuration

configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


# Protected fetch

fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62

# Methods

# createContact

createContact(createContactOptions: CreateContactOptions, options?: any): Promise‹ContactDto

Defined in src/generated/api.ts:5203

summary Create a contact

throws {RequiredError}

memberof ContactControllerApi

Parameters:

Name Type Description
createContactOptions CreateContactOptions createContactOptions
options? any -

Returns: Promise‹ContactDto


# deleteContact

deleteContact(contactId: string, options?: any): Promise‹Response›

Defined in src/generated/api.ts:5221

summary Delete contact

throws {RequiredError}

memberof ContactControllerApi

Parameters:

Name Type Description
contactId string contactId
options? any -

Returns: Promise‹Response›


# getAllContacts

getAllContacts(page?: number, size?: number, sort?: "ASC" | "DESC", options?: any): Promise‹PageContactProjection

Defined in src/generated/api.ts:5238

summary Get all contacts

throws {RequiredError}

memberof ContactControllerApi

Parameters:

Name Type
page? number
size? number
sort? "ASC" | "DESC"
options? any

Returns: Promise‹PageContactProjection


# getContact

getContact(contactId: string, options?: any): Promise‹ContactDto

Defined in src/generated/api.ts:5260

summary Get contact

throws {RequiredError}

memberof ContactControllerApi

Parameters:

Name Type Description
contactId string contactId
options? any -

Returns: Promise‹ContactDto


# getContacts

getContacts(options?: any): Promise‹ContactProjection[]›

Defined in src/generated/api.ts:5274

summary Get all contacts

throws {RequiredError}

memberof ContactControllerApi

Parameters:

Name Type
options? any

Returns: Promise‹ContactProjection[]›