Class ApiEmailWarmupControllerApi

Hierarchy

BaseAPI
- ApiEmailWarmupControllerApi

Index

Constructors

Properties

Methods

createEmailWarmupProgram createEmailWarmupProgramRaw deleteEmailWarmupProgram deleteEmailWarmupProgramRaw deleteEmailWarmupSenderSeats deleteEmailWarmupSenderSeatsRaw getEmailWarmupOverview getEmailWarmupOverviewRaw getEmailWarmupPlacementChecks getEmailWarmupPlacementChecksRaw getEmailWarmupProgram getEmailWarmupProgramAnalytics getEmailWarmupProgramAnalyticsRaw getEmailWarmupProgramRaw getEmailWarmupPrograms getEmailWarmupProgramsRaw getEmailWarmupReadiness getEmailWarmupReadinessRaw getEmailWarmupSlots getEmailWarmupSlotsRaw getEmailWarmupUsage getEmailWarmupUsageRaw pauseEmailWarmupProgram pauseEmailWarmupProgramRaw request resumeEmailWarmupProgram resumeEmailWarmupProgramRaw retryEmailWarmupProgram retryEmailWarmupProgramRaw startEmailWarmupProgram startEmailWarmupProgramRaw stopEmailWarmupProgram stopEmailWarmupProgramRaw updateEmailWarmupProgram updateEmailWarmupProgramRaw updateEmailWarmupSenderSeats updateEmailWarmupSenderSeatsRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createEmailWarmupProgram

createEmailWarmupProgram(requestParameters: CreateEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Create an email warmup program
Parameters
- requestParameters: CreateEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

createEmailWarmupProgramRaw

createEmailWarmupProgramRaw(requestParameters: CreateEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Create an email warmup program
Parameters
- requestParameters: CreateEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

deleteEmailWarmupProgram

deleteEmailWarmupProgram(requestParameters: DeleteEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<void>
Delete an email warmup program
Parameters
- requestParameters: DeleteEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteEmailWarmupProgramRaw

deleteEmailWarmupProgramRaw(requestParameters: DeleteEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete an email warmup program
Parameters
- requestParameters: DeleteEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteEmailWarmupSenderSeats

deleteEmailWarmupSenderSeats(initOverrides?: RequestInit): Promise<EmailWarmupUsageSummaryDto>
Cancel purchased email warmup sender seats
Parameters
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupUsageSummaryDto>

deleteEmailWarmupSenderSeatsRaw

deleteEmailWarmupSenderSeatsRaw(initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupUsageSummaryDto>>
Cancel purchased email warmup sender seats
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupUsageSummaryDto>>

getEmailWarmupOverview

getEmailWarmupOverview(requestParameters: GetEmailWarmupOverviewRequest, initOverrides?: RequestInit): Promise<EmailWarmupOverviewDto>
Get operational email warmup activity and program progress
Parameters
- requestParameters: GetEmailWarmupOverviewRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupOverviewDto>

getEmailWarmupOverviewRaw

getEmailWarmupOverviewRaw(requestParameters: GetEmailWarmupOverviewRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupOverviewDto>>
Get operational email warmup activity and program progress
Parameters
- requestParameters: GetEmailWarmupOverviewRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupOverviewDto>>

getEmailWarmupPlacementChecks

getEmailWarmupPlacementChecks(requestParameters: GetEmailWarmupPlacementChecksRequest, initOverrides?: RequestInit): Promise<EmailWarmupPlacementCheckDto[]>
List Gmail and Outlook placement checks for an email warmup program
Parameters
- requestParameters: GetEmailWarmupPlacementChecksRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupPlacementCheckDto[]>

getEmailWarmupPlacementChecksRaw

getEmailWarmupPlacementChecksRaw(requestParameters: GetEmailWarmupPlacementChecksRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupPlacementCheckDto[]>>
List Gmail and Outlook placement checks for an email warmup program
Parameters
- requestParameters: GetEmailWarmupPlacementChecksRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupPlacementCheckDto[]>>

getEmailWarmupProgram

getEmailWarmupProgram(requestParameters: GetEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Get an email warmup program
Parameters
- requestParameters: GetEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

getEmailWarmupProgramAnalytics

getEmailWarmupProgramAnalytics(requestParameters: GetEmailWarmupProgramAnalyticsRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramAnalyticsDto>
Get email warmup program progress and daily activity
Parameters
- requestParameters: GetEmailWarmupProgramAnalyticsRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramAnalyticsDto>

getEmailWarmupProgramAnalyticsRaw

getEmailWarmupProgramAnalyticsRaw(requestParameters: GetEmailWarmupProgramAnalyticsRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramAnalyticsDto>>
Get email warmup program progress and daily activity
Parameters
- requestParameters: GetEmailWarmupProgramAnalyticsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramAnalyticsDto>>

getEmailWarmupProgramRaw

getEmailWarmupProgramRaw(requestParameters: GetEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Get an email warmup program
Parameters
- requestParameters: GetEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

getEmailWarmupPrograms

getEmailWarmupPrograms(requestParameters: GetEmailWarmupProgramsRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramPageDto>
List email warmup programs
Parameters
- requestParameters: GetEmailWarmupProgramsRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramPageDto>

getEmailWarmupProgramsRaw

getEmailWarmupProgramsRaw(requestParameters: GetEmailWarmupProgramsRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramPageDto>>
List email warmup programs
Parameters
- requestParameters: GetEmailWarmupProgramsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramPageDto>>

getEmailWarmupReadiness

getEmailWarmupReadiness(requestParameters: GetEmailWarmupReadinessRequest, initOverrides?: RequestInit): Promise<EmailWarmupReadinessDto>
Get warmup readiness, adaptive pacing, and sender-health signals
Parameters
- requestParameters: GetEmailWarmupReadinessRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupReadinessDto>

getEmailWarmupReadinessRaw

getEmailWarmupReadinessRaw(requestParameters: GetEmailWarmupReadinessRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupReadinessDto>>
Get warmup readiness, adaptive pacing, and sender-health signals
Parameters
- requestParameters: GetEmailWarmupReadinessRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupReadinessDto>>

getEmailWarmupSlots

getEmailWarmupSlots(requestParameters: GetEmailWarmupSlotsRequest, initOverrides?: RequestInit): Promise<EmailWarmupSendSlotPageDto>
List scheduled email warmup slots
Parameters
- requestParameters: GetEmailWarmupSlotsRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupSendSlotPageDto>

getEmailWarmupSlotsRaw

getEmailWarmupSlotsRaw(requestParameters: GetEmailWarmupSlotsRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupSendSlotPageDto>>
List scheduled email warmup slots
Parameters
- requestParameters: GetEmailWarmupSlotsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupSendSlotPageDto>>

getEmailWarmupUsage

getEmailWarmupUsage(initOverrides?: RequestInit): Promise<EmailWarmupUsageSummaryDto>
Get email warmup sender capacity, included credits, and billable usage
Parameters
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupUsageSummaryDto>

getEmailWarmupUsageRaw

getEmailWarmupUsageRaw(initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupUsageSummaryDto>>
Get email warmup sender capacity, included credits, and billable usage
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupUsageSummaryDto>>

pauseEmailWarmupProgram

pauseEmailWarmupProgram(requestParameters: PauseEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Pause an email warmup program
Parameters
- requestParameters: PauseEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

pauseEmailWarmupProgramRaw

pauseEmailWarmupProgramRaw(requestParameters: PauseEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Pause an email warmup program
Parameters
- requestParameters: PauseEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

`Protected` request

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

Inherited from BaseAPI.request

resumeEmailWarmupProgram

resumeEmailWarmupProgram(requestParameters: ResumeEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Resume an email warmup program
Parameters
- requestParameters: ResumeEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

resumeEmailWarmupProgramRaw

resumeEmailWarmupProgramRaw(requestParameters: ResumeEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Resume an email warmup program
Parameters
- requestParameters: ResumeEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

retryEmailWarmupProgram

retryEmailWarmupProgram(requestParameters: RetryEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Retry a system-paused email warmup program
Parameters
- requestParameters: RetryEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

retryEmailWarmupProgramRaw

retryEmailWarmupProgramRaw(requestParameters: RetryEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Retry a system-paused email warmup program
Parameters
- requestParameters: RetryEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

startEmailWarmupProgram

startEmailWarmupProgram(requestParameters: StartEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Start an email warmup program
Parameters
- requestParameters: StartEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

startEmailWarmupProgramRaw

startEmailWarmupProgramRaw(requestParameters: StartEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Start an email warmup program
Parameters
- requestParameters: StartEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

stopEmailWarmupProgram

stopEmailWarmupProgram(requestParameters: StopEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Stop an email warmup program
Parameters
- requestParameters: StopEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

stopEmailWarmupProgramRaw

stopEmailWarmupProgramRaw(requestParameters: StopEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Stop an email warmup program
Parameters
- requestParameters: StopEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

updateEmailWarmupProgram

updateEmailWarmupProgram(requestParameters: UpdateEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<EmailWarmupProgramDto>
Update a draft email warmup program
Parameters
- requestParameters: UpdateEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupProgramDto>

updateEmailWarmupProgramRaw

updateEmailWarmupProgramRaw(requestParameters: UpdateEmailWarmupProgramRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupProgramDto>>
Update a draft email warmup program
Parameters
- requestParameters: UpdateEmailWarmupProgramRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupProgramDto>>

updateEmailWarmupSenderSeats

updateEmailWarmupSenderSeats(requestParameters: UpdateEmailWarmupSenderSeatsRequest, initOverrides?: RequestInit): Promise<EmailWarmupUsageSummaryDto>
Update purchased email warmup sender seats
Parameters
- requestParameters: UpdateEmailWarmupSenderSeatsRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailWarmupUsageSummaryDto>

updateEmailWarmupSenderSeatsRaw

updateEmailWarmupSenderSeatsRaw(requestParameters: UpdateEmailWarmupSenderSeatsRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailWarmupUsageSummaryDto>>
Update purchased email warmup sender seats
Parameters
- requestParameters: UpdateEmailWarmupSenderSeatsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailWarmupUsageSummaryDto>>

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