Skip to content

Class: CommonActionsControllerApi

Hierarchy

  • BaseAPI

    ↳ CommonActionsControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new CommonActionsControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

• Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

createNewEmailAddress

▸ createNewEmailAddress(requestParameters, initOverrides?): Promise<InboxDto>

Returns an Inbox with an id and an emailAddress Create new random inbox

Parameters

Name Type
requestParameters CreateNewEmailAddressRequest
initOverrides? RequestInit

Returns

Promise<InboxDto>

createNewEmailAddressRaw

▸ createNewEmailAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxDto>>

Returns an Inbox with an id and an emailAddress Create new random inbox

Parameters

Name Type
requestParameters CreateNewEmailAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxDto>>

createRandomInbox

▸ createRandomInbox(requestParameters, initOverrides?): Promise<InboxDto>

Returns an Inbox with an id and an emailAddress Create new random inbox

Parameters

Name Type
requestParameters CreateRandomInboxRequest
initOverrides? RequestInit

Returns

Promise<InboxDto>

createRandomInboxRaw

▸ createRandomInboxRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxDto>>

Returns an Inbox with an id and an emailAddress Create new random inbox

Parameters

Name Type
requestParameters CreateRandomInboxRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxDto>>

deleteEmailAddress

▸ deleteEmailAddress(requestParameters, initOverrides?): Promise<void>

Deletes inbox email address Delete inbox email address by inbox id

Parameters

Name Type
requestParameters DeleteEmailAddressRequest
initOverrides? RequestInit

Returns

Promise<void>

deleteEmailAddressRaw

▸ deleteEmailAddressRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Deletes inbox email address Delete inbox email address by inbox id

Parameters

Name Type
requestParameters DeleteEmailAddressRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

emptyInbox

▸ emptyInbox(requestParameters, initOverrides?): Promise<void>

Deletes all emails Delete all emails in an inbox

Parameters

Name Type
requestParameters EmptyInboxRequest
initOverrides? RequestInit

Returns

Promise<void>

emptyInboxRaw

▸ emptyInboxRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Deletes all emails Delete all emails in an inbox

Parameters

Name Type
requestParameters EmptyInboxRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

request

▸ Protected request(context, initOverrides?): Promise<Response>

Parameters

Name Type
context RequestOpts
initOverrides? RequestInit

Returns

Promise<Response>

Inherited from

BaseAPI.request

sendEmailSimple

▸ sendEmailSimple(requestParameters, initOverrides?): Promise<void>

If no senderId or inboxId provided a random email address will be used to send from. Send an email

Parameters

Name Type
requestParameters SendEmailSimpleRequest
initOverrides? RequestInit

Returns

Promise<void>

sendEmailSimpleRaw

▸ sendEmailSimpleRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

If no senderId or inboxId provided a random email address will be used to send from. Send an email

Parameters

Name Type
requestParameters SendEmailSimpleRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

withMiddleware

▸ withMiddleware<T>(...middlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...middlewares Middleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware

withPostMiddleware

▸ withPostMiddleware<T>(...postMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...postMiddlewares (context: ResponseContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPostMiddleware

withPreMiddleware

▸ withPreMiddleware<T>(...preMiddlewares): T

Type parameters

Name Type
T extends BaseAPI<T>

Parameters

Name Type
...preMiddlewares (context: RequestContext) => Promise<void

Returns

T

Inherited from

BaseAPI.withPreMiddleware