Class EmailVerificationControllerApi

Hierarchy

BaseAPI
- EmailVerificationControllerApi

Index

Constructors

Properties

Methods

deleteAllValidationRequests deleteAllValidationRequestsRaw deleteValidationRequest deleteValidationRequestRaw getValidationRequests getValidationRequestsRaw request validateEmailAddressList validateEmailAddressListRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteAllValidationRequests

deleteAllValidationRequests(initOverrides?: RequestInit): Promise<void>
Delete all validation requests
Parameters
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteAllValidationRequestsRaw

deleteAllValidationRequestsRaw(initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete all validation requests
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

deleteValidationRequest

deleteValidationRequest(requestParameters: DeleteValidationRequestRequest, initOverrides?: RequestInit): Promise<void>
Delete a validation record
Parameters
- requestParameters: DeleteValidationRequestRequest
- Optional initOverrides: RequestInit
Returns Promise<void>

deleteValidationRequestRaw

deleteValidationRequestRaw(requestParameters: DeleteValidationRequestRequest, initOverrides?: RequestInit): Promise<ApiResponse<void>>
Delete a validation record
Parameters
- requestParameters: DeleteValidationRequestRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>

getValidationRequests

getValidationRequests(requestParameters: GetValidationRequestsRequest, initOverrides?: RequestInit): Promise<PageEmailValidationRequest>
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- requestParameters: GetValidationRequestsRequest
- Optional initOverrides: RequestInit
Returns Promise<PageEmailValidationRequest>

getValidationRequestsRaw

getValidationRequestsRaw(requestParameters: GetValidationRequestsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageEmailValidationRequest>>
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- requestParameters: GetValidationRequestsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageEmailValidationRequest>>

`Protected` request

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

Inherited from BaseAPI.request

validateEmailAddressList

validateEmailAddressList(requestParameters: ValidateEmailAddressListRequest, initOverrides?: RequestInit): Promise<ValidateEmailAddressListResult>
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- requestParameters: ValidateEmailAddressListRequest
- Optional initOverrides: RequestInit
Returns Promise<ValidateEmailAddressListResult>

validateEmailAddressListRaw

validateEmailAddressListRaw(requestParameters: ValidateEmailAddressListRequest, initOverrides?: RequestInit): Promise<ApiResponse<ValidateEmailAddressListResult>>
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- requestParameters: ValidateEmailAddressListRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ValidateEmailAddressListResult>>

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