MailSlurp JS

Globals / ContactControllerApi

# Class: ContactControllerApi

ContactControllerApi - object-oriented interface

export

# Hierarchy

# Index

# Constructors

# Properties

# Methods

# Constructors

# constructor

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

Inherited from BaseAPI.constructor

Defined in src/generated/api.ts:57 (opens new window)

# Parameters:

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

Returns: ContactControllerApi

# Properties

# basePath

Protected basePath: string

Inherited from BaseAPI.basePath

Defined in src/generated/api.ts:61 (opens new window)


# configuration

Protected configuration: Configuration

Inherited from BaseAPI.configuration

Defined in src/generated/api.ts:57 (opens new window)


# fetch

Protected fetch: FetchAPI

Inherited from BaseAPI.fetch

Defined in src/generated/api.ts:62 (opens new window)

# Methods

# createContact

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

Defined in src/generated/api.ts:5807 (opens new window)

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:5825 (opens new window)

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:5842 (opens new window)

summary Get all contacts

throws {RequiredError}

memberof ContactControllerApi

# Parameters:

Name Type
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:5864 (opens new window)

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:5878 (opens new window)

summary Get all contacts

throws {RequiredError}

memberof ContactControllerApi

# Parameters:

Name Type
options? any

Returns: Promise<ContactProjection[]>