Class DomainMonitorPostmasterControllerApi

Hierarchy

BaseAPI
- DomainMonitorPostmasterControllerApi

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

createDomainMonitorPostmasterConnection

createDomainMonitorPostmasterConnection(requestParameters: CreateDomainMonitorPostmasterConnectionRequest, initOverrides?: RequestInit): Promise<CreatePostmasterConnectionResult>
Create Postmaster OAuth connection URL
Parameters
- requestParameters: CreateDomainMonitorPostmasterConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<CreatePostmasterConnectionResult>

createDomainMonitorPostmasterConnectionRaw

createDomainMonitorPostmasterConnectionRaw(requestParameters: CreateDomainMonitorPostmasterConnectionRequest, initOverrides?: RequestInit): Promise<ApiResponse<CreatePostmasterConnectionResult>>
Create Postmaster OAuth connection URL
Parameters
- requestParameters: CreateDomainMonitorPostmasterConnectionRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CreatePostmasterConnectionResult>>

deleteDomainMonitorPostmasterConnection

deleteDomainMonitorPostmasterConnection(initOverrides?: RequestInit): Promise<void>
Disconnect Postmaster OAuth
Parameters
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteDomainMonitorPostmasterConnectionRaw

deleteDomainMonitorPostmasterConnectionRaw(initOverrides?: RequestInit): Promise<ApiResponse<void>>
Disconnect Postmaster OAuth
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

exchangeDomainMonitorPostmasterCode

exchangeDomainMonitorPostmasterCode(requestParameters: ExchangeDomainMonitorPostmasterCodeRequest, initOverrides?: RequestInit): Promise<PostmasterConnectionDto>
Exchange Postmaster OAuth authorization code
Parameters
- requestParameters: ExchangeDomainMonitorPostmasterCodeRequest
- Optional initOverrides: RequestInit
Returns Promise<PostmasterConnectionDto>

exchangeDomainMonitorPostmasterCodeRaw

exchangeDomainMonitorPostmasterCodeRaw(requestParameters: ExchangeDomainMonitorPostmasterCodeRequest, initOverrides?: RequestInit): Promise<ApiResponse<PostmasterConnectionDto>>
Exchange Postmaster OAuth authorization code
Parameters
- requestParameters: ExchangeDomainMonitorPostmasterCodeRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PostmasterConnectionDto>>

getDomainMonitorPostmasterConnection

getDomainMonitorPostmasterConnection(initOverrides?: RequestInit): Promise<PostmasterConnectionStatusDto>
Get Postmaster connection status
Parameters
- Optional initOverrides: RequestInit
Returns Promise<PostmasterConnectionStatusDto>

getDomainMonitorPostmasterConnectionRaw

getDomainMonitorPostmasterConnectionRaw(initOverrides?: RequestInit): Promise<ApiResponse<PostmasterConnectionStatusDto>>
Get Postmaster connection status
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PostmasterConnectionStatusDto>>

getDomainMonitorPostmasterDomains

getDomainMonitorPostmasterDomains(initOverrides?: RequestInit): Promise<PostmasterDomainDto[]>
List local Postmaster domain snapshots
Parameters
- Optional initOverrides: RequestInit
Returns Promise<PostmasterDomainDto[]>

getDomainMonitorPostmasterDomainsRaw

getDomainMonitorPostmasterDomainsRaw(initOverrides?: RequestInit): Promise<ApiResponse<PostmasterDomainDto[]>>
List local Postmaster domain snapshots
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PostmasterDomainDto[]>>

getDomainMonitorPostmasterTrafficStats

getDomainMonitorPostmasterTrafficStats(requestParameters: GetDomainMonitorPostmasterTrafficStatsRequest, initOverrides?: RequestInit): Promise<PostmasterTrafficStatsListDto>
Get local Postmaster traffic stats
Parameters
- requestParameters: GetDomainMonitorPostmasterTrafficStatsRequest
- Optional initOverrides: RequestInit
Returns Promise<PostmasterTrafficStatsListDto>

getDomainMonitorPostmasterTrafficStatsRaw

getDomainMonitorPostmasterTrafficStatsRaw(requestParameters: GetDomainMonitorPostmasterTrafficStatsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PostmasterTrafficStatsListDto>>
Get local Postmaster traffic stats
Parameters
- requestParameters: GetDomainMonitorPostmasterTrafficStatsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PostmasterTrafficStatsListDto>>

`Protected` request

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

Inherited from BaseAPI.request

syncDomainMonitorPostmasterDomains

syncDomainMonitorPostmasterDomains(initOverrides?: RequestInit): Promise<PostmasterDomainDto[]>
Sync Postmaster domains
Parameters
- Optional initOverrides: RequestInit
Returns Promise<PostmasterDomainDto[]>

syncDomainMonitorPostmasterDomainsRaw

syncDomainMonitorPostmasterDomainsRaw(initOverrides?: RequestInit): Promise<ApiResponse<PostmasterDomainDto[]>>
Sync Postmaster domains
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PostmasterDomainDto[]>>

syncDomainMonitorPostmasterTrafficStats

syncDomainMonitorPostmasterTrafficStats(requestParameters: SyncDomainMonitorPostmasterTrafficStatsRequest, initOverrides?: RequestInit): Promise<PostmasterTrafficStatsListDto>
Sync Postmaster traffic stats
Parameters
- requestParameters: SyncDomainMonitorPostmasterTrafficStatsRequest
- Optional initOverrides: RequestInit
Returns Promise<PostmasterTrafficStatsListDto>

syncDomainMonitorPostmasterTrafficStatsRaw

syncDomainMonitorPostmasterTrafficStatsRaw(requestParameters: SyncDomainMonitorPostmasterTrafficStatsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PostmasterTrafficStatsListDto>>
Sync Postmaster traffic stats
Parameters
- requestParameters: SyncDomainMonitorPostmasterTrafficStatsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PostmasterTrafficStatsListDto>>

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