telnyx 7.12.0 → 7.13.0

package/resources/email-validations/batch.d.mts

@@ -0,0 +1,136 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as BatchAPI from "./batch.mjs";
+import * as EmailValidationsAPI from "./email-validations.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+export declare class Batch extends APIResource {
+    /**
+     * Creates an asynchronous batch validation job for up to 1,000 email addresses.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.create({
+     *   emails: ['user@example.com', 'admin@example.org'],
+     *   webhook_url:
+     *     'https://example.com/webhooks/email-validation',
+     * });
+     * ```
+     */
+    create(params: BatchCreateParams, options?: RequestOptions): APIPromise<BatchCreateResponse>;
+    /**
+     * Retrieves the current status and, once completed, validation results for a batch
+     * job.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<BatchRetrieveResponse>;
+}
+export type EmailValidationBatchStatus = 'pending' | 'processing' | 'completed' | 'failed';
+export interface BatchCreateResponse {
+    /**
+     * Shape returned by the create endpoint. Includes duplicates_removed.
+     */
+    data: BatchCreateResponse.Data;
+}
+export declare namespace BatchCreateResponse {
+    /**
+     * Shape returned by the create endpoint. Includes duplicates_removed.
+     */
+    interface Data {
+        id: string;
+        duplicates_removed: number;
+        record_type: 'email_validation_batch';
+        status: BatchAPI.EmailValidationBatchStatus;
+        total: number;
+        webhook_url?: string;
+    }
+}
+export interface BatchRetrieveResponse {
+    /**
+     * Shape returned by the GET endpoint. Does not include duplicates_removed.
+     */
+    data: BatchRetrieveResponse.Data;
+}
+export declare namespace BatchRetrieveResponse {
+    /**
+     * Shape returned by the GET endpoint. Does not include duplicates_removed.
+     */
+    interface Data {
+        id: string;
+        record_type: 'email_validation_batch';
+        status: BatchAPI.EmailValidationBatchStatus;
+        total: number;
+        completed_at?: string;
+        /**
+         * Map keyed by original email address. Present only when the batch is completed.
+         */
+        results?: {
+            [key: string]: Data.Results;
+        };
+        webhook_url?: string;
+    }
+    namespace Data {
+        interface Results {
+            checks: Results.Checks;
+            email: string;
+            risk_score: number;
+            valid: boolean;
+            /**
+             * Suggested correction for typo. Omitted when nil.
+             */
+            did_you_mean?: string;
+        }
+        namespace Results {
+            interface Checks {
+                disposable: EmailValidationsAPI.EmailValidationCheck;
+                mx: EmailValidationsAPI.EmailValidationCheck;
+                role_based: EmailValidationsAPI.EmailValidationCheck;
+                syntax: EmailValidationsAPI.EmailValidationCheck;
+                typo: Checks.Typo;
+            }
+            namespace Checks {
+                interface Typo extends EmailValidationsAPI.EmailValidationCheck {
+                    /**
+                     * Suggested correction for common typos. Omitted when nil.
+                     */
+                    suggestion?: string;
+                }
+            }
+        }
+    }
+}
+export interface BatchCreateParams {
+    /**
+     * Body param
+     */
+    emails: Array<string>;
+    /**
+     * Body param: URL for batch completion webhook. Empty string is treated as
+     * omitted. SSRF-protected; private/reserved IPs and internal hostnames are
+     * rejected.
+     */
+    webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export declare namespace Batch {
+    export { type EmailValidationBatchStatus as EmailValidationBatchStatus, type BatchCreateResponse as BatchCreateResponse, type BatchRetrieveResponse as BatchRetrieveResponse, type BatchCreateParams as BatchCreateParams, };
+}
+//# sourceMappingURL=batch.d.mts.map

package/resources/email-validations/batch.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.d.mts","sourceRoot":"","sources":["../../src/resources/email-validations/batch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGlF;AAED,MAAM,MAAM,0BAA0B,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE3F,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,kBAAkB,EAAE,MAAM,CAAC;QAE3B,WAAW,EAAE,wBAAwB,CAAC;QAEtC,MAAM,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAE5C,KAAK,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,wBAAwB,CAAC;QAEtC,MAAM,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAE5C,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;SAAE,CAAC;QAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,OAAO;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;YAEvB,KAAK,EAAE,MAAM,CAAC;YAEd,UAAU,EAAE,MAAM,CAAC;YAEnB,KAAK,EAAE,OAAO,CAAC;YAEf;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,MAAM;gBACrB,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAErD,EAAE,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAE7C,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAErD,MAAM,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAEjD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;aACnB;YAED,UAAiB,MAAM,CAAC;gBACtB,UAAiB,IAAK,SAAQ,mBAAmB,CAAC,oBAAoB;oBACpE;;uBAEG;oBACH,UAAU,CAAC,EAAE,MAAM,CAAC;iBACrB;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/email-validations/batch.d.ts

@@ -0,0 +1,136 @@
+import { APIResource } from "../../core/resource.js";
+import * as BatchAPI from "./batch.js";
+import * as EmailValidationsAPI from "./email-validations.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+export declare class Batch extends APIResource {
+    /**
+     * Creates an asynchronous batch validation job for up to 1,000 email addresses.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.create({
+     *   emails: ['user@example.com', 'admin@example.org'],
+     *   webhook_url:
+     *     'https://example.com/webhooks/email-validation',
+     * });
+     * ```
+     */
+    create(params: BatchCreateParams, options?: RequestOptions): APIPromise<BatchCreateResponse>;
+    /**
+     * Retrieves the current status and, once completed, validation results for a batch
+     * job.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<BatchRetrieveResponse>;
+}
+export type EmailValidationBatchStatus = 'pending' | 'processing' | 'completed' | 'failed';
+export interface BatchCreateResponse {
+    /**
+     * Shape returned by the create endpoint. Includes duplicates_removed.
+     */
+    data: BatchCreateResponse.Data;
+}
+export declare namespace BatchCreateResponse {
+    /**
+     * Shape returned by the create endpoint. Includes duplicates_removed.
+     */
+    interface Data {
+        id: string;
+        duplicates_removed: number;
+        record_type: 'email_validation_batch';
+        status: BatchAPI.EmailValidationBatchStatus;
+        total: number;
+        webhook_url?: string;
+    }
+}
+export interface BatchRetrieveResponse {
+    /**
+     * Shape returned by the GET endpoint. Does not include duplicates_removed.
+     */
+    data: BatchRetrieveResponse.Data;
+}
+export declare namespace BatchRetrieveResponse {
+    /**
+     * Shape returned by the GET endpoint. Does not include duplicates_removed.
+     */
+    interface Data {
+        id: string;
+        record_type: 'email_validation_batch';
+        status: BatchAPI.EmailValidationBatchStatus;
+        total: number;
+        completed_at?: string;
+        /**
+         * Map keyed by original email address. Present only when the batch is completed.
+         */
+        results?: {
+            [key: string]: Data.Results;
+        };
+        webhook_url?: string;
+    }
+    namespace Data {
+        interface Results {
+            checks: Results.Checks;
+            email: string;
+            risk_score: number;
+            valid: boolean;
+            /**
+             * Suggested correction for typo. Omitted when nil.
+             */
+            did_you_mean?: string;
+        }
+        namespace Results {
+            interface Checks {
+                disposable: EmailValidationsAPI.EmailValidationCheck;
+                mx: EmailValidationsAPI.EmailValidationCheck;
+                role_based: EmailValidationsAPI.EmailValidationCheck;
+                syntax: EmailValidationsAPI.EmailValidationCheck;
+                typo: Checks.Typo;
+            }
+            namespace Checks {
+                interface Typo extends EmailValidationsAPI.EmailValidationCheck {
+                    /**
+                     * Suggested correction for common typos. Omitted when nil.
+                     */
+                    suggestion?: string;
+                }
+            }
+        }
+    }
+}
+export interface BatchCreateParams {
+    /**
+     * Body param
+     */
+    emails: Array<string>;
+    /**
+     * Body param: URL for batch completion webhook. Empty string is treated as
+     * omitted. SSRF-protected; private/reserved IPs and internal hostnames are
+     * rejected.
+     */
+    webhook_url?: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export declare namespace Batch {
+    export { type EmailValidationBatchStatus as EmailValidationBatchStatus, type BatchCreateResponse as BatchCreateResponse, type BatchRetrieveResponse as BatchRetrieveResponse, type BatchCreateParams as BatchCreateParams, };
+}
+//# sourceMappingURL=batch.d.ts.map

package/resources/email-validations/batch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.d.ts","sourceRoot":"","sources":["../../src/resources/email-validations/batch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGlF;AAED,MAAM,MAAM,0BAA0B,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE3F,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;CAChC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,kBAAkB,EAAE,MAAM,CAAC;QAE3B,WAAW,EAAE,wBAAwB,CAAC;QAEtC,MAAM,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAE5C,KAAK,EAAE,MAAM,CAAC;QAEd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,EAAE,wBAAwB,CAAC;QAEtC,MAAM,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAE5C,KAAK,EAAE,MAAM,CAAC;QAEd,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,OAAO,CAAA;SAAE,CAAC;QAE1C,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,OAAO;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;YAEvB,KAAK,EAAE,MAAM,CAAC;YAEd,UAAU,EAAE,MAAM,CAAC;YAEnB,KAAK,EAAE,OAAO,CAAC;YAEf;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,MAAM;gBACrB,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAErD,EAAE,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAE7C,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAErD,MAAM,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;gBAEjD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;aACnB;YAED,UAAiB,MAAM,CAAC;gBACtB,UAAiB,IAAK,SAAQ,mBAAmB,CAAC,oBAAoB;oBACpE;;uBAEG;oBACH,UAAU,CAAC,EAAE,MAAM,CAAC;iBACrB;aACF;SACF;KACF;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/email-validations/batch.js

@@ -0,0 +1,51 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Batch = void 0;
+const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+class Batch extends resource_1.APIResource {
+    /**
+     * Creates an asynchronous batch validation job for up to 1,000 email addresses.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.create({
+     *   emails: ['user@example.com', 'admin@example.org'],
+     *   webhook_url:
+     *     'https://example.com/webhooks/email-validation',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/email_validations/batch', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves the current status and, once completed, validation results for a batch
+     * job.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/email_validations/batch/${id}`, options);
+    }
+}
+exports.Batch = Batch;
+//# sourceMappingURL=batch.js.map

package/resources/email-validations/batch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.js","sourceRoot":"","sources":["../../src/resources/email-validations/batch.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,KAAM,SAAQ,sBAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF;AAvCD,sBAuCC"}

package/resources/email-validations/batch.mjs

@@ -0,0 +1,47 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+export class Batch extends APIResource {
+    /**
+     * Creates an asynchronous batch validation job for up to 1,000 email addresses.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.create({
+     *   emails: ['user@example.com', 'admin@example.org'],
+     *   webhook_url:
+     *     'https://example.com/webhooks/email-validation',
+     * });
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/email_validations/batch', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+    /**
+     * Retrieves the current status and, once completed, validation results for a batch
+     * job.
+     *
+     * @example
+     * ```ts
+     * const batch = await client.emailValidations.batch.retrieve(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/email_validations/batch/${id}`, options);
+    }
+}
+//# sourceMappingURL=batch.mjs.map

package/resources/email-validations/batch.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.mjs","sourceRoot":"","sources":["../../src/resources/email-validations/batch.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAyB,EAAE,OAAwB;QACxD,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0BAA0B,EAAE;YACnD,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,4BAA4B,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzE,CAAC;CACF"}

package/resources/email-validations/email-validations.d.mts

@@ -0,0 +1,87 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as EmailValidationsAPI from "./email-validations.mjs";
+import * as BatchAPI from "./batch.mjs";
+import { Batch, BatchCreateParams, BatchCreateResponse, BatchRetrieveResponse, EmailValidationBatchStatus } from "./batch.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+export declare class EmailValidations extends APIResource {
+    batch: BatchAPI.Batch;
+    /**
+     * Validates a single email address and returns deliverability checks.
+     *
+     * @example
+     * ```ts
+     * const emailValidation =
+     *   await client.emailValidations.create({
+     *     email: 'user@example.com',
+     *   });
+     * ```
+     */
+    create(params: EmailValidationCreateParams, options?: RequestOptions): APIPromise<EmailValidationCreateResponse>;
+}
+export interface EmailValidationCheck {
+    pass: boolean;
+    /**
+     * Human-readable check detail. Omitted when nil.
+     */
+    details?: string;
+}
+export interface EmailValidationCreateResponse {
+    data: EmailValidationCreateResponse.Data;
+}
+export declare namespace EmailValidationCreateResponse {
+    interface Data {
+        checks: Data.Checks;
+        email: string;
+        record_type: 'email_validation';
+        risk_score: number;
+        valid: boolean;
+        /**
+         * Suggested correction for typo. Omitted when nil.
+         */
+        did_you_mean?: string;
+    }
+    namespace Data {
+        interface Checks {
+            disposable: EmailValidationsAPI.EmailValidationCheck;
+            mx: EmailValidationsAPI.EmailValidationCheck;
+            role_based: EmailValidationsAPI.EmailValidationCheck;
+            syntax: EmailValidationsAPI.EmailValidationCheck;
+            typo: Checks.Typo;
+        }
+        namespace Checks {
+            interface Typo extends EmailValidationsAPI.EmailValidationCheck {
+                /**
+                 * Suggested correction for common typos. Omitted when nil.
+                 */
+                suggestion?: string;
+            }
+        }
+    }
+}
+export interface EmailValidationCreateParams {
+    /**
+     * Body param: Email address to validate. Any non-empty string is accepted; invalid
+     * syntax returns valid=false rather than a request error.
+     */
+    email: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export declare namespace EmailValidations {
+    export { type EmailValidationCheck as EmailValidationCheck, type EmailValidationCreateResponse as EmailValidationCreateResponse, type EmailValidationCreateParams as EmailValidationCreateParams, };
+    export { Batch as Batch, type EmailValidationBatchStatus as EmailValidationBatchStatus, type BatchCreateResponse as BatchCreateResponse, type BatchRetrieveResponse as BatchRetrieveResponse, type BatchCreateParams as BatchCreateParams, };
+}
+//# sourceMappingURL=email-validations.d.mts.map

package/resources/email-validations/email-validations.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-validations.d.mts","sourceRoot":"","sources":["../../src/resources/email-validations/email-validations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,QAAQ,oBAAgB;AACpC,OAAO,EACL,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC3B,oBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAEhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;OAUG;IACH,MAAM,CACJ,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAW7C;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,WAAW,EAAE,kBAAkB,CAAC;QAEhC,UAAU,EAAE,MAAM,CAAC;QAEnB,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAErD,EAAE,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAE7C,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAErD,MAAM,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAEjD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;SACnB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,IAAK,SAAQ,mBAAmB,CAAC,oBAAoB;gBACpE;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;aACrB;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/email-validations/email-validations.d.ts

@@ -0,0 +1,87 @@
+import { APIResource } from "../../core/resource.js";
+import * as EmailValidationsAPI from "./email-validations.js";
+import * as BatchAPI from "./batch.js";
+import { Batch, BatchCreateParams, BatchCreateResponse, BatchRetrieveResponse, EmailValidationBatchStatus } from "./batch.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+export declare class EmailValidations extends APIResource {
+    batch: BatchAPI.Batch;
+    /**
+     * Validates a single email address and returns deliverability checks.
+     *
+     * @example
+     * ```ts
+     * const emailValidation =
+     *   await client.emailValidations.create({
+     *     email: 'user@example.com',
+     *   });
+     * ```
+     */
+    create(params: EmailValidationCreateParams, options?: RequestOptions): APIPromise<EmailValidationCreateResponse>;
+}
+export interface EmailValidationCheck {
+    pass: boolean;
+    /**
+     * Human-readable check detail. Omitted when nil.
+     */
+    details?: string;
+}
+export interface EmailValidationCreateResponse {
+    data: EmailValidationCreateResponse.Data;
+}
+export declare namespace EmailValidationCreateResponse {
+    interface Data {
+        checks: Data.Checks;
+        email: string;
+        record_type: 'email_validation';
+        risk_score: number;
+        valid: boolean;
+        /**
+         * Suggested correction for typo. Omitted when nil.
+         */
+        did_you_mean?: string;
+    }
+    namespace Data {
+        interface Checks {
+            disposable: EmailValidationsAPI.EmailValidationCheck;
+            mx: EmailValidationsAPI.EmailValidationCheck;
+            role_based: EmailValidationsAPI.EmailValidationCheck;
+            syntax: EmailValidationsAPI.EmailValidationCheck;
+            typo: Checks.Typo;
+        }
+        namespace Checks {
+            interface Typo extends EmailValidationsAPI.EmailValidationCheck {
+                /**
+                 * Suggested correction for common typos. Omitted when nil.
+                 */
+                suggestion?: string;
+            }
+        }
+    }
+}
+export interface EmailValidationCreateParams {
+    /**
+     * Body param: Email address to validate. Any non-empty string is accepted; invalid
+     * syntax returns valid=false rather than a request error.
+     */
+    email: string;
+    /**
+     * Header param: Optional opaque, unquoted key for safely retrying the same logical
+     * request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores.
+     * Generate a unique UUID v4 for each operation and reuse it only when retrying
+     * that operation with the same request. Invalid headers—including duplicate,
+     * empty, malformed, or overlong values—return 400 with error code 10015. A request
+     * already in progress with the same key returns 409; reusing the key with a
+     * different request returns 422. Only successful responses are replayed, for up to
+     * 24 hours. Do not include sensitive data in the key.
+     */
+    'Idempotency-Key'?: string;
+}
+export declare namespace EmailValidations {
+    export { type EmailValidationCheck as EmailValidationCheck, type EmailValidationCreateResponse as EmailValidationCreateResponse, type EmailValidationCreateParams as EmailValidationCreateParams, };
+    export { Batch as Batch, type EmailValidationBatchStatus as EmailValidationBatchStatus, type BatchCreateResponse as BatchCreateResponse, type BatchRetrieveResponse as BatchRetrieveResponse, type BatchCreateParams as BatchCreateParams, };
+}
+//# sourceMappingURL=email-validations.d.ts.map

package/resources/email-validations/email-validations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-validations.d.ts","sourceRoot":"","sources":["../../src/resources/email-validations/email-validations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,EACL,KAAK,EACL,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,0BAA0B,EAC3B,mBAAgB;AACjB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAEhE;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,WAAW;IAC/C,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAoC;IAEzD;;;;;;;;;;OAUG;IACH,MAAM,CACJ,MAAM,EAAE,2BAA2B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,6BAA6B,CAAC;CAW7C;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,OAAO,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,6BAA6B;IAC5C,IAAI,EAAE,6BAA6B,CAAC,IAAI,CAAC;CAC1C;AAED,yBAAiB,6BAA6B,CAAC;IAC7C,UAAiB,IAAI;QACnB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAEpB,KAAK,EAAE,MAAM,CAAC;QAEd,WAAW,EAAE,kBAAkB,CAAC;QAEhC,UAAU,EAAE,MAAM,CAAC;QAEnB,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAErD,EAAE,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAE7C,UAAU,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAErD,MAAM,EAAE,mBAAmB,CAAC,oBAAoB,CAAC;YAEjD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;SACnB;QAED,UAAiB,MAAM,CAAC;YACtB,UAAiB,IAAK,SAAQ,mBAAmB,CAAC,oBAAoB;gBACpE;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;aACrB;SACF;KACF;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,2BAA2B,IAAI,2BAA2B,GAChE,CAAC;IAEF,OAAO,EACL,KAAK,IAAI,KAAK,EACd,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/email-validations/email-validations.js

@@ -0,0 +1,43 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailValidations = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const BatchAPI = tslib_1.__importStar(require("./batch.js"));
+const batch_1 = require("./batch.js");
+const headers_1 = require("../../internal/headers.js");
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+class EmailValidations extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.batch = new BatchAPI.Batch(this._client);
+    }
+    /**
+     * Validates a single email address and returns deliverability checks.
+     *
+     * @example
+     * ```ts
+     * const emailValidation =
+     *   await client.emailValidations.create({
+     *     email: 'user@example.com',
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/email_validations', {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([
+                { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+exports.EmailValidations = EmailValidations;
+EmailValidations.Batch = batch_1.Batch;
+//# sourceMappingURL=email-validations.js.map

package/resources/email-validations/email-validations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-validations.js","sourceRoot":"","sources":["../../src/resources/email-validations/email-validations.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,6DAAoC;AACpC,sCAMiB;AAEjB,uDAAsD;AAGtD;;GAEG;AACH,MAAa,gBAAiB,SAAQ,sBAAW;IAAjD;;QACE,UAAK,GAAmB,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2B3D,CAAC;IAzBC;;;;;;;;;;OAUG;IACH,MAAM,CACJ,MAAmC,EACnC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE;YAC7C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC;gBACpB,EAAE,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE;gBACnF,OAAO,EAAE,OAAO;aACjB,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,4CA4BC;AA6ED,gBAAgB,CAAC,KAAK,GAAG,aAAK,CAAC"}

package/resources/email-validations/email-validations.mjs

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import * as BatchAPI from "./batch.mjs";
+import { Batch, } from "./batch.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
+/**
+ * Validate email addresses synchronously or in asynchronous batches.
+ */
+export class EmailValidations extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.batch = new BatchAPI.Batch(this._client);
+    }
+    /**
+     * Validates a single email address and returns deliverability checks.
+     *
+     * @example
+     * ```ts
+     * const emailValidation =
+     *   await client.emailValidations.create({
+     *     email: 'user@example.com',
+     *   });
+     * ```
+     */
+    create(params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post('/email_validations', {
+            body,
+            ...options,
+            headers: buildHeaders([
+                { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+                options?.headers,
+            ]),
+        });
+    }
+}
+EmailValidations.Batch = Batch;
+//# sourceMappingURL=email-validations.mjs.map