Class ApiAutomatedInboxPlacementControllerApi

Hierarchy

BaseAPI
- ApiAutomatedInboxPlacementControllerApi

Index

Constructors

Properties

Methods

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createAutomatedInboxPlacementConnection

createAutomatedInboxPlacementConnection(requestParameters: CreateAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementConnectionDto>
Create an encrypted sender connection
Parameters
- requestParameters: CreateAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementConnectionDto>

createAutomatedInboxPlacementConnectionRaw

createAutomatedInboxPlacementConnectionRaw(requestParameters: CreateAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>
Create an encrypted sender connection
Parameters
- requestParameters: CreateAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

createAutomatedInboxPlacementSchedule

createAutomatedInboxPlacementSchedule(requestParameters: CreateAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementScheduleDto>
Create an automated inbox placement schedule
Parameters
- requestParameters: CreateAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementScheduleDto>

createAutomatedInboxPlacementScheduleRaw

createAutomatedInboxPlacementScheduleRaw(requestParameters: CreateAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>
Create an automated inbox placement schedule
Parameters
- requestParameters: CreateAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>

deleteAutomatedInboxPlacementConnection

deleteAutomatedInboxPlacementConnection(requestParameters: DeleteAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<void>
Disconnect a sender connection
Parameters
- requestParameters: DeleteAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteAutomatedInboxPlacementConnectionRaw

deleteAutomatedInboxPlacementConnectionRaw(requestParameters: DeleteAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Disconnect a sender connection
Parameters
- requestParameters: DeleteAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteAutomatedInboxPlacementSchedule

deleteAutomatedInboxPlacementSchedule(requestParameters: DeleteAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<void>
Delete an automated inbox placement schedule
Parameters
- requestParameters: DeleteAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteAutomatedInboxPlacementScheduleRaw

deleteAutomatedInboxPlacementScheduleRaw(requestParameters: DeleteAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete an automated inbox placement schedule
Parameters
- requestParameters: DeleteAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getAutomatedInboxPlacementConnection

getAutomatedInboxPlacementConnection(requestParameters: GetAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementConnectionDto>
Get a sender connection
Parameters
- requestParameters: GetAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementConnectionDto>

getAutomatedInboxPlacementConnectionRaw

getAutomatedInboxPlacementConnectionRaw(requestParameters: GetAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>
Get a sender connection
Parameters
- requestParameters: GetAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

getAutomatedInboxPlacementConnections

getAutomatedInboxPlacementConnections(initOverrides?: RequestInit): Promise<AutomatedInboxPlacementConnectionDto[]>
List sender connections
Parameters
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementConnectionDto[]>

getAutomatedInboxPlacementConnectionsRaw

getAutomatedInboxPlacementConnectionsRaw(initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementConnectionDto[]>>
List sender connections
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto[]>>

getAutomatedInboxPlacementExecutionEvents

getAutomatedInboxPlacementExecutionEvents(requestParameters: GetAutomatedInboxPlacementExecutionEventsRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementEventDto[]>
List non-secret execution events
Parameters
- requestParameters: GetAutomatedInboxPlacementExecutionEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementEventDto[]>

getAutomatedInboxPlacementExecutionEventsRaw

getAutomatedInboxPlacementExecutionEventsRaw(requestParameters: GetAutomatedInboxPlacementExecutionEventsRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementEventDto[]>>
List non-secret execution events
Parameters
- requestParameters: GetAutomatedInboxPlacementExecutionEventsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementEventDto[]>>

getAutomatedInboxPlacementExecutions

getAutomatedInboxPlacementExecutions(requestParameters: GetAutomatedInboxPlacementExecutionsRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementExecutionDto[]>
List schedule executions
Parameters
- requestParameters: GetAutomatedInboxPlacementExecutionsRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementExecutionDto[]>

getAutomatedInboxPlacementExecutionsRaw

getAutomatedInboxPlacementExecutionsRaw(requestParameters: GetAutomatedInboxPlacementExecutionsRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementExecutionDto[]>>
List schedule executions
Parameters
- requestParameters: GetAutomatedInboxPlacementExecutionsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementExecutionDto[]>>

getAutomatedInboxPlacementProviders

getAutomatedInboxPlacementProviders(initOverrides?: RequestInit): Promise<AutomatedInboxPlacementProviderDto[]>
List automated inbox placement sender providers
Parameters
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementProviderDto[]>

getAutomatedInboxPlacementProvidersRaw

getAutomatedInboxPlacementProvidersRaw(initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementProviderDto[]>>
List automated inbox placement sender providers
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementProviderDto[]>>

getAutomatedInboxPlacementSchedule

getAutomatedInboxPlacementSchedule(requestParameters: GetAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementScheduleDto>
Get an automated inbox placement schedule
Parameters
- requestParameters: GetAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementScheduleDto>

getAutomatedInboxPlacementScheduleAnalyticsSeries

getAutomatedInboxPlacementScheduleAnalyticsSeries(requestParameters: GetAutomatedInboxPlacementScheduleAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise<InboxPlacementAnalyticsSeriesDto>
Returns chart-ready metrics for billed placement runs created by this schedule only. Get automation inbox placement analytics over time
Parameters
- requestParameters: GetAutomatedInboxPlacementScheduleAnalyticsSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<InboxPlacementAnalyticsSeriesDto>

getAutomatedInboxPlacementScheduleAnalyticsSeriesRaw

getAutomatedInboxPlacementScheduleAnalyticsSeriesRaw(requestParameters: GetAutomatedInboxPlacementScheduleAnalyticsSeriesRequest, initOverrides?: RequestInit): Promise<ApiResponse<InboxPlacementAnalyticsSeriesDto>>
Returns chart-ready metrics for billed placement runs created by this schedule only. Get automation inbox placement analytics over time
Parameters
- requestParameters: GetAutomatedInboxPlacementScheduleAnalyticsSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<InboxPlacementAnalyticsSeriesDto>>

getAutomatedInboxPlacementScheduleRaw

getAutomatedInboxPlacementScheduleRaw(requestParameters: GetAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>
Get an automated inbox placement schedule
Parameters
- requestParameters: GetAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>

getAutomatedInboxPlacementSchedules

getAutomatedInboxPlacementSchedules(initOverrides?: RequestInit): Promise<AutomatedInboxPlacementScheduleDto[]>
List automated inbox placement schedules
Parameters
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementScheduleDto[]>

getAutomatedInboxPlacementSchedulesRaw

getAutomatedInboxPlacementSchedulesRaw(initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementScheduleDto[]>>
List automated inbox placement schedules
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementScheduleDto[]>>

`Protected` request

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

Inherited from BaseAPI.request

rotateAutomatedInboxPlacementConnectionCredentials

rotateAutomatedInboxPlacementConnectionCredentials(requestParameters: RotateAutomatedInboxPlacementConnectionCredentialsRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementConnectionDto>
Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged. Rotate sender connection credentials
Parameters
- requestParameters: RotateAutomatedInboxPlacementConnectionCredentialsRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementConnectionDto>

rotateAutomatedInboxPlacementConnectionCredentialsRaw

rotateAutomatedInboxPlacementConnectionCredentialsRaw(requestParameters: RotateAutomatedInboxPlacementConnectionCredentialsRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>
Verifies the replacement SMTP settings before atomically replacing the encrypted credential envelope. A failed verification leaves the existing connection unchanged. Rotate sender connection credentials
Parameters
- requestParameters: RotateAutomatedInboxPlacementConnectionCredentialsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

runAutomatedInboxPlacementSchedule

runAutomatedInboxPlacementSchedule(requestParameters: RunAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementExecutionDto>
Run an automated inbox placement schedule now
Parameters
- requestParameters: RunAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementExecutionDto>

runAutomatedInboxPlacementScheduleRaw

runAutomatedInboxPlacementScheduleRaw(requestParameters: RunAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementExecutionDto>>
Run an automated inbox placement schedule now
Parameters
- requestParameters: RunAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementExecutionDto>>

updateAutomatedInboxPlacementConnection

updateAutomatedInboxPlacementConnection(requestParameters: UpdateAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementConnectionDto>
Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings. Update a sender connection
Parameters
- requestParameters: UpdateAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementConnectionDto>

updateAutomatedInboxPlacementConnectionRaw

updateAutomatedInboxPlacementConnectionRaw(requestParameters: UpdateAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>
Updates non-secret connection metadata. Use the credentials endpoint to replace SMTP credentials or transport settings. Update a sender connection
Parameters
- requestParameters: UpdateAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

updateAutomatedInboxPlacementSchedule

updateAutomatedInboxPlacementSchedule(requestParameters: UpdateAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementScheduleDto>
Update an automated inbox placement schedule
Parameters
- requestParameters: UpdateAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementScheduleDto>

updateAutomatedInboxPlacementScheduleRaw

updateAutomatedInboxPlacementScheduleRaw(requestParameters: UpdateAutomatedInboxPlacementScheduleRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>
Update an automated inbox placement schedule
Parameters
- requestParameters: UpdateAutomatedInboxPlacementScheduleRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>

verifyAutomatedInboxPlacementConnection

verifyAutomatedInboxPlacementConnection(requestParameters: VerifyAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<AutomatedInboxPlacementConnectionDto>
Verify a sender connection
Parameters
- requestParameters: VerifyAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<AutomatedInboxPlacementConnectionDto>

verifyAutomatedInboxPlacementConnectionRaw

verifyAutomatedInboxPlacementConnectionRaw(requestParameters: VerifyAutomatedInboxPlacementConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>
Verify a sender connection
Parameters
- requestParameters: VerifyAutomatedInboxPlacementConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

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

Class ApiAutomatedInboxPlacementControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns ApiAutomatedInboxPlacementControllerApi

Properties

Protected configuration

Methods

createAutomatedInboxPlacementConnection

Parameters

requestParameters: CreateAutomatedInboxPlacementConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<AutomatedInboxPlacementConnectionDto>

createAutomatedInboxPlacementConnectionRaw

Parameters

requestParameters: CreateAutomatedInboxPlacementConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

createAutomatedInboxPlacementSchedule

Parameters

requestParameters: CreateAutomatedInboxPlacementScheduleRequest

Optional initOverrides: RequestInit

Returns Promise<AutomatedInboxPlacementScheduleDto>

createAutomatedInboxPlacementScheduleRaw

Parameters

requestParameters: CreateAutomatedInboxPlacementScheduleRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<AutomatedInboxPlacementScheduleDto>>

deleteAutomatedInboxPlacementConnection

Parameters

requestParameters: DeleteAutomatedInboxPlacementConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteAutomatedInboxPlacementConnectionRaw

Parameters

requestParameters: DeleteAutomatedInboxPlacementConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

deleteAutomatedInboxPlacementSchedule

Parameters

requestParameters: DeleteAutomatedInboxPlacementScheduleRequest

Optional initOverrides: RequestInit

Returns Promise<void>

deleteAutomatedInboxPlacementScheduleRaw

Parameters

requestParameters: DeleteAutomatedInboxPlacementScheduleRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<void>>

getAutomatedInboxPlacementConnection

Parameters

requestParameters: GetAutomatedInboxPlacementConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<AutomatedInboxPlacementConnectionDto>

getAutomatedInboxPlacementConnectionRaw

Parameters

requestParameters: GetAutomatedInboxPlacementConnectionRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto>>

getAutomatedInboxPlacementConnections

Parameters

Optional initOverrides: RequestInit

Returns Promise<AutomatedInboxPlacementConnectionDto[]>

getAutomatedInboxPlacementConnectionsRaw

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<AutomatedInboxPlacementConnectionDto[]>>

getAutomatedInboxPlacementExecutionEvents

Parameters

requestParameters: GetAutomatedInboxPlacementExecutionEventsRequest

Optional initOverrides: RequestInit

Returns Promise<AutomatedInboxPlacementEventDto[]>

getAutomatedInboxPlacementExecutionEventsRaw

Parameters

requestParameters: GetAutomatedInboxPlacementExecutionEventsRequest

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit