# Class: AliasControllerApi

AliasControllerApi - object-oriented interface

export

class AliasControllerApi

extends {BaseAPI}

# Hierarchy

# Constructors

# constructor

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

Inherited from BaseAPI.constructor

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

Parameters:

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

Returns: AliasControllerApi

# Properties

# Protected basePath

basePath: string

Inherited from BaseAPI.basePath

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


# Protected configuration

configuration: Configuration

Inherited from BaseAPI.configuration

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


# Protected fetch

fetch: FetchAPI

Inherited from BaseAPI.fetch

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

# Methods

# createAlias

createAlias(createOwnedAliasOptions: CreateOwnedAliasOptions, options?: any): Promise‹Response›

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

Create an email alias belonging to a user ID. To create anonymous aliases use the createAnonymousAlias method.

summary Create an email alias

throws {RequiredError}

memberof AliasControllerApi

Parameters:

Name Type Description
createOwnedAliasOptions CreateOwnedAliasOptions createOwnedAliasOptions
options? any -

Returns: Promise‹Response›


# createAnonymousAlias

createAnonymousAlias(createAnonymousAliasOptions: CreateAnonymousAliasOptions, options?: any): Promise‹Alias

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

summary Create an anonymous email alias

throws {RequiredError}

memberof AliasControllerApi

Parameters:

Name Type Description
createAnonymousAliasOptions CreateAnonymousAliasOptions createAnonymousAliasOptions
options? any -

Returns: Promise‹Alias


# deleteAlias

deleteAlias(aliasId: string, options?: any): Promise‹Response›

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

summary Delete an owned alias

throws {RequiredError}

memberof AliasControllerApi

Parameters:

Name Type Description
aliasId string aliasId
options? any -

Returns: Promise‹Response›


# getAlias

getAlias(aliasId: string, options?: any): Promise‹Alias

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

Get an email alias by ID

summary Get an email alias

throws {RequiredError}

memberof AliasControllerApi

Parameters:

Name Type Description
aliasId string aliasId
options? any -

Returns: Promise‹Alias


# getAliases

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

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

Get all email aliases in paginated form

summary Get all email aliases

throws {RequiredError}

memberof AliasControllerApi

Parameters:

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

Returns: Promise‹PageAlias


# updateAlias

updateAlias(aliasId: string, createOwnedAliasOptions: CreateOwnedAliasOptions, options?: any): Promise‹Response›

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

summary Update an owned alias

throws {RequiredError}

memberof AliasControllerApi

Parameters:

Name Type Description
aliasId string aliasId
createOwnedAliasOptions CreateOwnedAliasOptions createOwnedAliasOptions
options? any -

Returns: Promise‹Response›