Skip to content

Class: BulkActionsControllerApi

Hierarchy

  • BaseAPI

    ↳ BulkActionsControllerApi

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new BulkActionsControllerApi(configuration?)

Parameters

Name Type
configuration Configuration

Inherited from

BaseAPI.constructor

Properties

configuration

• Protected configuration: Configuration

Inherited from

BaseAPI.configuration

Methods

bulkCreateInboxes

▸ bulkCreateInboxes(requestParameters, initOverrides?): Promise<InboxDto[]>

Bulk create Inboxes (email addresses)

Parameters

Name Type
requestParameters BulkCreateInboxesRequest
initOverrides? RequestInit

Returns

Promise<InboxDto[]>

bulkCreateInboxesRaw

▸ bulkCreateInboxesRaw(requestParameters, initOverrides?): Promise<ApiResponse<InboxDto[]>>

Bulk create Inboxes (email addresses)

Parameters

Name Type
requestParameters BulkCreateInboxesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<InboxDto[]>>

bulkDeleteInboxes

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

Bulk Delete Inboxes

Parameters

Name Type
requestParameters BulkDeleteInboxesRequest
initOverrides? RequestInit

Returns

Promise<void>

bulkDeleteInboxesRaw

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

Bulk Delete Inboxes

Parameters

Name Type
requestParameters BulkDeleteInboxesRequest
initOverrides? RequestInit

Returns

Promise<ApiResponse<void>>

bulkSendEmails

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

Bulk Send Emails

Parameters

Name Type
requestParameters BulkSendEmailsRequest
initOverrides? RequestInit

Returns

Promise<void>

bulkSendEmailsRaw

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

Bulk Send Emails

Parameters

Name Type
requestParameters BulkSendEmailsRequest
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

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