hanzoai 8.5.889 → 8.5.911

package/dist/api/email-api.d.ts

@@ -0,0 +1,399 @@
+/**
+ * Hanzo Cloud API
+ * The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator\'s admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
+ *
+ * The version of the OpenAPI document: v1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { EmailDispatch } from '../models';
+import type { EmailListMessagesResult } from '../models';
+import type { EmailMessageRecord } from '../models';
+import type { EmailSESStatusResult } from '../models';
+import type { EmailSendGridStatusResult } from '../models';
+import type { EmailSendMessageInput } from '../models';
+import type { EmailVerificationInput } from '../models';
+import type { EmailVerificationResult } from '../models';
+/**
+ * EmailApi - axios parameter creator
+ * @export
+ */
+export declare const EmailApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieves sent email messages for the authenticated organization.  GET /v1/email
+     * @summary Retrieves sent email messages for the authenticated organization.
+     * @param {number} [limit] Limit is the maximum number of messages to return (default 50, max 200).
+     * @param {string} [status] Status filters messages by delivery status.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmail: (limit?: number, status?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves message delivery status by ID for the authenticated organization.  GET /v1/email/:id
+     * @summary Retrieves message delivery status by ID for the authenticated organization.
+     * @param {string} id ID is the unique identifier of the message to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailById: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.  GET /v1/email/sendgrid/status
+     * @summary Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.
+     * @param {string} [domain] Domain is an optional sending domain to generate SendGrid whitelabel DKIM, Return-Path, and DMARC records for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailSendgridStatus: (domain?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.  GET /v1/email/ses/status
+     * @summary Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.
+     * @param {string} [domain] Domain optionally specifies the sending domain to generate Easy DKIM and MAIL FROM records for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailSesStatus: (domain?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058). Every recipient is first asked of the one suppression check (marketing_clearance): an address the org\'s list holds, whose company unsubscribed, or that the platform blocks is not sent to, and is answered in refused with status 422 and the reason; when every recipient is refused the request is 422. A list that cannot answer sends nothing (503). Every message, sent or refused, goes on the CRM record of the person the org holds for the address. Transactional mail — a code, a receipt — is not this route\'s: it goes by /v1/notify, which no opt-out stops.  POST /v1/email
+     * @summary Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058).
+     * @param {EmailSendMessageInput} emailSendMessageInput
+     * @param {string} [idempotencyKey] IdempotencyKey prevents duplicate message dispatches on network retries.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmail: (emailSendMessageInput: EmailSendMessageInput, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Evaluates an email address using explicitly selected, composable checks.  A signed-in caller only: the SMTP check connects to the address\'s mail server from ours, so an anonymous caller could probe mailboxes and get our addresses blocked. Each caller may run 120 checks an hour and 20 of them SMTP probes, and the deployment 6,000 and 400; past either is 429.  POST /v1/email/verify
+     * @summary Evaluates an email address using explicitly selected, composable checks.
+     * @param {EmailVerificationInput} emailVerificationInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailVerify: (emailVerificationInput: EmailVerificationInput, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential). A delivery signed more than ten minutes from now is refused, so a captured one cannot be replayed.  POST /v1/email/webhooks/sendgrid?org=<org>
+     * @summary Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailWebhooksSendgrid: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Receives Amazon SES events as an SNS HTTPS subscription delivers them. The organization is named in the address (?org=) and holds the SNS topic its events arrive on (the sns-topic-arn credential): a message is accepted when it is signed by SNS, is from that topic, and its certificate comes from that topic\'s region. A subscription confirmation is completed the same way and records nothing.  POST /v1/email/webhooks/ses?org=<org>
+     * @summary Receives Amazon SES events as an SNS HTTPS subscription delivers them.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailWebhooksSes: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EmailApi - functional programming interface
+ * @export
+ */
+export declare const EmailApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieves sent email messages for the authenticated organization.  GET /v1/email
+     * @summary Retrieves sent email messages for the authenticated organization.
+     * @param {number} [limit] Limit is the maximum number of messages to return (default 50, max 200).
+     * @param {string} [status] Status filters messages by delivery status.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmail(limit?: number, status?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailListMessagesResult>>;
+    /**
+     * Retrieves message delivery status by ID for the authenticated organization.  GET /v1/email/:id
+     * @summary Retrieves message delivery status by ID for the authenticated organization.
+     * @param {string} id ID is the unique identifier of the message to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailById(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailMessageRecord>>;
+    /**
+     * Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.  GET /v1/email/sendgrid/status
+     * @summary Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.
+     * @param {string} [domain] Domain is an optional sending domain to generate SendGrid whitelabel DKIM, Return-Path, and DMARC records for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailSendgridStatus(domain?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailSendGridStatusResult>>;
+    /**
+     * Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.  GET /v1/email/ses/status
+     * @summary Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.
+     * @param {string} [domain] Domain optionally specifies the sending domain to generate Easy DKIM and MAIL FROM records for.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailSesStatus(domain?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailSESStatusResult>>;
+    /**
+     * Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058). Every recipient is first asked of the one suppression check (marketing_clearance): an address the org\'s list holds, whose company unsubscribed, or that the platform blocks is not sent to, and is answered in refused with status 422 and the reason; when every recipient is refused the request is 422. A list that cannot answer sends nothing (503). Every message, sent or refused, goes on the CRM record of the person the org holds for the address. Transactional mail — a code, a receipt — is not this route\'s: it goes by /v1/notify, which no opt-out stops.  POST /v1/email
+     * @summary Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058).
+     * @param {EmailSendMessageInput} emailSendMessageInput
+     * @param {string} [idempotencyKey] IdempotencyKey prevents duplicate message dispatches on network retries.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmail(emailSendMessageInput: EmailSendMessageInput, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailDispatch>>;
+    /**
+     * Evaluates an email address using explicitly selected, composable checks.  A signed-in caller only: the SMTP check connects to the address\'s mail server from ours, so an anonymous caller could probe mailboxes and get our addresses blocked. Each caller may run 120 checks an hour and 20 of them SMTP probes, and the deployment 6,000 and 400; past either is 429.  POST /v1/email/verify
+     * @summary Evaluates an email address using explicitly selected, composable checks.
+     * @param {EmailVerificationInput} emailVerificationInput
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailVerify(emailVerificationInput: EmailVerificationInput, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmailVerificationResult>>;
+    /**
+     * Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential). A delivery signed more than ten minutes from now is refused, so a captured one cannot be replayed.  POST /v1/email/webhooks/sendgrid?org=<org>
+     * @summary Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailWebhooksSendgrid(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Receives Amazon SES events as an SNS HTTPS subscription delivers them. The organization is named in the address (?org=) and holds the SNS topic its events arrive on (the sns-topic-arn credential): a message is accepted when it is signed by SNS, is from that topic, and its certificate comes from that topic\'s region. A subscription confirmation is completed the same way and records nothing.  POST /v1/email/webhooks/ses?org=<org>
+     * @summary Receives Amazon SES events as an SNS HTTPS subscription delivers them.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailWebhooksSes(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * EmailApi - factory interface
+ * @export
+ */
+export declare const EmailApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Retrieves sent email messages for the authenticated organization.  GET /v1/email
+     * @summary Retrieves sent email messages for the authenticated organization.
+     * @param {EmailApiGetEmailRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmail(requestParameters?: EmailApiGetEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailListMessagesResult>;
+    /**
+     * Retrieves message delivery status by ID for the authenticated organization.  GET /v1/email/:id
+     * @summary Retrieves message delivery status by ID for the authenticated organization.
+     * @param {EmailApiGetEmailByIdRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailById(requestParameters: EmailApiGetEmailByIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailMessageRecord>;
+    /**
+     * Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.  GET /v1/email/sendgrid/status
+     * @summary Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.
+     * @param {EmailApiGetEmailSendgridStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailSendgridStatus(requestParameters?: EmailApiGetEmailSendgridStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailSendGridStatusResult>;
+    /**
+     * Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.  GET /v1/email/ses/status
+     * @summary Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.
+     * @param {EmailApiGetEmailSesStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEmailSesStatus(requestParameters?: EmailApiGetEmailSesStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailSESStatusResult>;
+    /**
+     * Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058). Every recipient is first asked of the one suppression check (marketing_clearance): an address the org\'s list holds, whose company unsubscribed, or that the platform blocks is not sent to, and is answered in refused with status 422 and the reason; when every recipient is refused the request is 422. A list that cannot answer sends nothing (503). Every message, sent or refused, goes on the CRM record of the person the org holds for the address. Transactional mail — a code, a receipt — is not this route\'s: it goes by /v1/notify, which no opt-out stops.  POST /v1/email
+     * @summary Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058).
+     * @param {EmailApiPostEmailRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmail(requestParameters: EmailApiPostEmailRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailDispatch>;
+    /**
+     * Evaluates an email address using explicitly selected, composable checks.  A signed-in caller only: the SMTP check connects to the address\'s mail server from ours, so an anonymous caller could probe mailboxes and get our addresses blocked. Each caller may run 120 checks an hour and 20 of them SMTP probes, and the deployment 6,000 and 400; past either is 429.  POST /v1/email/verify
+     * @summary Evaluates an email address using explicitly selected, composable checks.
+     * @param {EmailApiPostEmailVerifyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailVerify(requestParameters: EmailApiPostEmailVerifyRequest, options?: RawAxiosRequestConfig): AxiosPromise<EmailVerificationResult>;
+    /**
+     * Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential). A delivery signed more than ten minutes from now is refused, so a captured one cannot be replayed.  POST /v1/email/webhooks/sendgrid?org=<org>
+     * @summary Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailWebhooksSendgrid(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Receives Amazon SES events as an SNS HTTPS subscription delivers them. The organization is named in the address (?org=) and holds the SNS topic its events arrive on (the sns-topic-arn credential): a message is accepted when it is signed by SNS, is from that topic, and its certificate comes from that topic\'s region. A subscription confirmation is completed the same way and records nothing.  POST /v1/email/webhooks/ses?org=<org>
+     * @summary Receives Amazon SES events as an SNS HTTPS subscription delivers them.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postEmailWebhooksSes(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * Request parameters for getEmail operation in EmailApi.
+ * @export
+ * @interface EmailApiGetEmailRequest
+ */
+export interface EmailApiGetEmailRequest {
+    /**
+     * Limit is the maximum number of messages to return (default 50, max 200).
+     * @type {number}
+     * @memberof EmailApiGetEmail
+     */
+    readonly limit?: number;
+    /**
+     * Status filters messages by delivery status.
+     * @type {string}
+     * @memberof EmailApiGetEmail
+     */
+    readonly status?: string;
+}
+/**
+ * Request parameters for getEmailById operation in EmailApi.
+ * @export
+ * @interface EmailApiGetEmailByIdRequest
+ */
+export interface EmailApiGetEmailByIdRequest {
+    /**
+     * ID is the unique identifier of the message to retrieve.
+     * @type {string}
+     * @memberof EmailApiGetEmailById
+     */
+    readonly id: string;
+}
+/**
+ * Request parameters for getEmailSendgridStatus operation in EmailApi.
+ * @export
+ * @interface EmailApiGetEmailSendgridStatusRequest
+ */
+export interface EmailApiGetEmailSendgridStatusRequest {
+    /**
+     * Domain is an optional sending domain to generate SendGrid whitelabel DKIM, Return-Path, and DMARC records for.
+     * @type {string}
+     * @memberof EmailApiGetEmailSendgridStatus
+     */
+    readonly domain?: string;
+}
+/**
+ * Request parameters for getEmailSesStatus operation in EmailApi.
+ * @export
+ * @interface EmailApiGetEmailSesStatusRequest
+ */
+export interface EmailApiGetEmailSesStatusRequest {
+    /**
+     * Domain optionally specifies the sending domain to generate Easy DKIM and MAIL FROM records for.
+     * @type {string}
+     * @memberof EmailApiGetEmailSesStatus
+     */
+    readonly domain?: string;
+}
+/**
+ * Request parameters for postEmail operation in EmailApi.
+ * @export
+ * @interface EmailApiPostEmailRequest
+ */
+export interface EmailApiPostEmailRequest {
+    /**
+     *
+     * @type {EmailSendMessageInput}
+     * @memberof EmailApiPostEmail
+     */
+    readonly emailSendMessageInput: EmailSendMessageInput;
+    /**
+     * IdempotencyKey prevents duplicate message dispatches on network retries.
+     * @type {string}
+     * @memberof EmailApiPostEmail
+     */
+    readonly idempotencyKey?: string;
+}
+/**
+ * Request parameters for postEmailVerify operation in EmailApi.
+ * @export
+ * @interface EmailApiPostEmailVerifyRequest
+ */
+export interface EmailApiPostEmailVerifyRequest {
+    /**
+     *
+     * @type {EmailVerificationInput}
+     * @memberof EmailApiPostEmailVerify
+     */
+    readonly emailVerificationInput: EmailVerificationInput;
+}
+/**
+ * EmailApi - object-oriented interface
+ * @export
+ * @class EmailApi
+ * @extends {BaseAPI}
+ */
+export declare class EmailApi extends BaseAPI {
+    /**
+     * Retrieves sent email messages for the authenticated organization.  GET /v1/email
+     * @summary Retrieves sent email messages for the authenticated organization.
+     * @param {EmailApiGetEmailRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    getEmail(requestParameters?: EmailApiGetEmailRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EmailListMessagesResult, any, {}>>;
+    /**
+     * Retrieves message delivery status by ID for the authenticated organization.  GET /v1/email/:id
+     * @summary Retrieves message delivery status by ID for the authenticated organization.
+     * @param {EmailApiGetEmailByIdRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    getEmailById(requestParameters: EmailApiGetEmailByIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EmailMessageRecord, any, {}>>;
+    /**
+     * Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.  GET /v1/email/sendgrid/status
+     * @summary Inspects the authenticated organization\'s dedicated SendGrid outreach configuration (separate from standard Twilio notify) and whitelabel DNS records.
+     * @param {EmailApiGetEmailSendgridStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    getEmailSendgridStatus(requestParameters?: EmailApiGetEmailSendgridStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EmailSendGridStatusResult, any, {}>>;
+    /**
+     * Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.  GET /v1/email/ses/status
+     * @summary Inspects the authenticated organization\'s Amazon SES configuration, sending limits, and Easy DKIM / MAIL FROM DNS records.
+     * @param {EmailApiGetEmailSesStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    getEmailSesStatus(requestParameters?: EmailApiGetEmailSesStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EmailSESStatusResult, any, {}>>;
+    /**
+     * Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058). Every recipient is first asked of the one suppression check (marketing_clearance): an address the org\'s list holds, whose company unsubscribed, or that the platform blocks is not sent to, and is answered in refused with status 422 and the reason; when every recipient is refused the request is 422. A list that cannot answer sends nothing (503). Every message, sent or refused, goes on the CRM record of the person the org holds for the address. Transactional mail — a code, a receipt — is not this route\'s: it goes by /v1/notify, which no opt-out stops.  POST /v1/email
+     * @summary Sends commercial email from the org: one message per recipient, each carrying its own signed unsubscribe link in the footer and in List-Unsubscribe and List-Unsubscribe-Post (RFC 8058).
+     * @param {EmailApiPostEmailRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    postEmail(requestParameters: EmailApiPostEmailRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EmailDispatch, any, {}>>;
+    /**
+     * Evaluates an email address using explicitly selected, composable checks.  A signed-in caller only: the SMTP check connects to the address\'s mail server from ours, so an anonymous caller could probe mailboxes and get our addresses blocked. Each caller may run 120 checks an hour and 20 of them SMTP probes, and the deployment 6,000 and 400; past either is 429.  POST /v1/email/verify
+     * @summary Evaluates an email address using explicitly selected, composable checks.
+     * @param {EmailApiPostEmailVerifyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    postEmailVerify(requestParameters: EmailApiPostEmailVerifyRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EmailVerificationResult, any, {}>>;
+    /**
+     * Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential). A delivery signed more than ten minutes from now is refused, so a captured one cannot be replayed.  POST /v1/email/webhooks/sendgrid?org=<org>
+     * @summary Receives SendGrid\'s Signed Event Webhook: the delivery is an array of events, signed (ECDSA P-256, SHA-256) over its timestamp header followed by the body, under the public key the organization holds (the webhook-public-key credential).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    postEmailWebhooksSendgrid(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
+    /**
+     * Receives Amazon SES events as an SNS HTTPS subscription delivers them. The organization is named in the address (?org=) and holds the SNS topic its events arrive on (the sns-topic-arn credential): a message is accepted when it is signed by SNS, is from that topic, and its certificate comes from that topic\'s region. A subscription confirmation is completed the same way and records nothing.  POST /v1/email/webhooks/ses?org=<org>
+     * @summary Receives Amazon SES events as an SNS HTTPS subscription delivers them.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EmailApi
+     */
+    postEmailWebhooksSes(options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<void, any, {}>>;
+}