MailSlurp JS

Globals / ContactControllerApi

Class: ContactControllerApi

ContactControllerApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57

Parameters:

NameTypeDefault value
configuration?Configuration-
basePathstringBASE_PATH
fetchFetchAPIportableFetch

Returns: ContactControllerApi

Properties

basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61


configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57


fetch

Protected 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:9700

summary Create a contact

throws {RequiredError}

memberof ContactControllerApi

Parameters:

NameTypeDescription
createContactOptionsCreateContactOptionscreateContactOptions
options?any-

Returns: Promise<ContactDto>


deleteContact

deleteContact(contactId: string, options?: any): Promise

Defined in src/generated/api.ts:9718

summary Delete contact

throws {RequiredError}

memberof ContactControllerApi

Parameters:

NameTypeDescription
contactIdstringcontactId
options?any-

Returns: Promise


getAllContacts

getAllContacts(page?: number, size?: number, sort?: “ASC” | “DESC”, options?: any): Promise<PageContactProjection>

Defined in src/generated/api.ts:9735

summary Get all contacts

throws {RequiredError}

memberof ContactControllerApi

Parameters:

NameType
page?number
size?number
sort?“ASC”
options?any

Returns: Promise<PageContactProjection>


getContact

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

Defined in src/generated/api.ts:9757

summary Get contact

throws {RequiredError}

memberof ContactControllerApi

Parameters:

NameTypeDescription
contactIdstringcontactId
options?any-

Returns: Promise<ContactDto>


getContactVCard

getContactVCard(contactId: string, options?: any): Promise

Defined in src/generated/api.ts:9772

summary Get contact vCard vcf file

throws {RequiredError}

memberof ContactControllerApi

Parameters:

NameTypeDescription
contactIdstringcontactId
options?any-

Returns: Promise


getContacts

getContacts(options?: any): Promise<ContactProjection[]>

Defined in src/generated/api.ts:9786

summary Get all contacts

throws {RequiredError}

memberof ContactControllerApi

Parameters:

NameType
options?any

Returns: Promise<ContactProjection[]>