Globals / BulkActionsControllerApi
# Class: BulkActionsControllerApi
BulkActionsControllerApi - object-oriented interface
export
# Hierarchy
-
↳ BulkActionsControllerApi
# Index
# Constructors
# Properties
# Methods
# Constructors
# constructor
+ new BulkActionsControllerApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): BulkActionsControllerApi
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: BulkActionsControllerApi
# 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
Defined in src/generated/api.ts:62 (opens new window)
# Methods
# bulkCreateInboxes
▸ bulkCreateInboxes(count: number, options?: any): Promise<Inbox[]>
Defined in src/generated/api.ts:6315 (opens new window)
summary Bulk create Inboxes (email addresses)
throws {RequiredError}
memberof BulkActionsControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
count | number | Number of inboxes to be created in bulk |
options? | any | - |
Returns: Promise<Inbox[]>
# bulkDeleteInboxes
▸ bulkDeleteInboxes(ids: Array<string>, options?: any): Promise<Response>
Defined in src/generated/api.ts:6330 (opens new window)
summary Bulk Delete Inboxes
throws {RequiredError}
memberof BulkActionsControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
ids | Array<string> | ids |
options? | any | - |
Returns: Promise<Response>
# bulkSendEmails
▸ bulkSendEmails(bulkSendEmailOptions: BulkSendEmailOptions, options?: any): Promise<Response>
Defined in src/generated/api.ts:6345 (opens new window)
summary Bulk Send Emails
throws {RequiredError}
memberof BulkActionsControllerApi
# Parameters:
| Name | Type | Description |
|---|---|---|
bulkSendEmailOptions | BulkSendEmailOptions | bulkSendEmailOptions |
options? | any | - |
Returns: Promise<Response>
