Class EmailAuditControllerApi

Hierarchy

BaseAPI
- EmailAuditControllerApi

Index

Constructors

Properties

Methods

compareEmailAudits compareEmailAuditsRaw createEmailAudit createEmailAuditRaw deleteEmailAudit deleteEmailAuditRaw getEmailAudit getEmailAuditRaw getEmailAudits getEmailAuditsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

compareEmailAudits

compareEmailAudits(requestParameters: CompareEmailAuditsRequest, initOverrides?: RequestInit): Promise<EmailAuditComparisonDto>
Compare two email audits
Parameters
- requestParameters: CompareEmailAuditsRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailAuditComparisonDto>

compareEmailAuditsRaw

compareEmailAuditsRaw(requestParameters: CompareEmailAuditsRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailAuditComparisonDto>>
Compare two email audits
Parameters
- requestParameters: CompareEmailAuditsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailAuditComparisonDto>>

createEmailAudit

createEmailAudit(requestParameters: CreateEmailAuditRequest, initOverrides?: RequestInit): Promise<EmailAuditDto>
Create email audit
Parameters
- requestParameters: CreateEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailAuditDto>

createEmailAuditRaw

createEmailAuditRaw(requestParameters: CreateEmailAuditRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailAuditDto>>
Create email audit
Parameters
- requestParameters: CreateEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailAuditDto>>

deleteEmailAudit

deleteEmailAudit(requestParameters: DeleteEmailAuditRequest, initOverrides?: RequestInit): Promise<void>
Delete email audit
Parameters
- requestParameters: DeleteEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteEmailAuditRaw

deleteEmailAuditRaw(requestParameters: DeleteEmailAuditRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete email audit
Parameters
- requestParameters: DeleteEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getEmailAudit

getEmailAudit(requestParameters: GetEmailAuditRequest, initOverrides?: RequestInit): Promise<EmailAuditDto>
Get email audit
Parameters
- requestParameters: GetEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailAuditDto>

getEmailAuditRaw

getEmailAuditRaw(requestParameters: GetEmailAuditRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailAuditDto>>
Get email audit
Parameters
- requestParameters: GetEmailAuditRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailAuditDto>>

getEmailAudits

getEmailAudits(requestParameters: GetEmailAuditsRequest, initOverrides?: RequestInit): Promise<EmailAuditDto[]>
List email audits
Parameters
- requestParameters: GetEmailAuditsRequest
- Optional initOverrides: RequestInit
Returns Promise<EmailAuditDto[]>

getEmailAuditsRaw

getEmailAuditsRaw(requestParameters: GetEmailAuditsRequest, initOverrides?: RequestInit): Promise<ApiResponse<EmailAuditDto[]>>
List email audits
Parameters
- requestParameters: GetEmailAuditsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<EmailAuditDto[]>>

`Protected` request

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

Inherited from BaseAPI.request

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