Class CommonActionsControllerApi

Hierarchy

BaseAPI
- CommonActionsControllerApi

Index

Constructors

Properties

Methods

createNewEmailAddress createNewEmailAddressRaw createRandomInbox createRandomInboxRaw deleteEmailAddress deleteEmailAddressRaw emptyInbox emptyInboxRaw request sendEmailQuery sendEmailQueryRaw sendEmailSimple sendEmailSimpleRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new CommonActionsControllerApi(configuration?: Configuration): CommonActionsControllerApi
Parameters
- configuration: Configuration = ...
Returns CommonActionsControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createNewEmailAddress

createNewEmailAddress(requestParameters: CreateNewEmailAddressRequest, initOverrides?: RequestInit): Promise<InboxDto>
Returns an Inbox with an id and an emailAddress Create new random inbox
Parameters
- requestParameters: CreateNewEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxDto>

createNewEmailAddressRaw

createNewEmailAddressRaw(requestParameters: CreateNewEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxDto>>
Returns an Inbox with an id and an emailAddress Create new random inbox
Parameters
- requestParameters: CreateNewEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxDto>>

createRandomInbox

createRandomInbox(requestParameters: CreateRandomInboxRequest, initOverrides?: RequestInit): Promise<InboxDto>
Returns an Inbox with an id and an emailAddress Create new random inbox
Parameters
- requestParameters: CreateRandomInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxDto>

createRandomInboxRaw

createRandomInboxRaw(requestParameters: CreateRandomInboxRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxDto>>
Returns an Inbox with an id and an emailAddress Create new random inbox
Parameters
- requestParameters: CreateRandomInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxDto>>

deleteEmailAddress

deleteEmailAddress(requestParameters: DeleteEmailAddressRequest, initOverrides?: RequestInit): Promise<void>
Deletes inbox email address Delete inbox email address by inbox id
Parameters
- requestParameters: DeleteEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteEmailAddressRaw

deleteEmailAddressRaw(requestParameters: DeleteEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Deletes inbox email address Delete inbox email address by inbox id
Parameters
- requestParameters: DeleteEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

emptyInbox

emptyInbox(requestParameters: EmptyInboxRequest, initOverrides?: RequestInit): Promise<void>
Deletes all emails Delete all emails in an inbox
Parameters
- requestParameters: EmptyInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

emptyInboxRaw

emptyInboxRaw(requestParameters: EmptyInboxRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Deletes all emails Delete all emails in an inbox
Parameters
- requestParameters: EmptyInboxRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

sendEmailQuery

sendEmailQuery(requestParameters: SendEmailQueryRequest, initOverrides?: RequestInit): Promise<void>
If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. Send an email using query parameters
Parameters
- requestParameters: SendEmailQueryRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

sendEmailQueryRaw

sendEmailQueryRaw(requestParameters: SendEmailQueryRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded. Send an email using query parameters
Parameters
- requestParameters: SendEmailQueryRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

sendEmailSimple

sendEmailSimple(requestParameters: SendEmailSimpleRequest, initOverrides?: RequestInit): Promise<void>
If no senderId or inboxId provided a random email address will be used to send from. Send an email
Parameters
- requestParameters: SendEmailSimpleRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

sendEmailSimpleRaw

sendEmailSimpleRaw(requestParameters: SendEmailSimpleRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
If no senderId or inboxId provided a random email address will be used to send from. Send an email
Parameters
- requestParameters: SendEmailSimpleRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware