telnyx 7.11.0 → 7.13.0

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

@@ -0,0 +1,255 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as ImportAPI from "./import.mjs";
+import { EmailBlockImportResponse, Import, ImportCreateParams } from "./import.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Recipient suppression records (`/v2/email_blocks`).
+ */
+export declare class EmailBlocks extends APIResource {
+    import: ImportAPI.Import;
+    /**
+     * Account-scoped list. Two mutually exclusive pagination modes:
+     *
+     * - **Offset**: `page[number]` (default 1) + `page[size]` (default 25, max 100).
+     *   `meta` contains `total_pages`.
+     * - **Cursor**: `page[after]` and/or `page[before]` (opaque `Base.url_encode64` of
+     *   `{"created_at","id"}`). Cannot combine with `page[number]`; `after`+`before`
+     *   together is an error. `meta` contains `next_cursor` / `previous_cursor`
+     *   (omitted when their flag is false).
+     *
+     * Sort defaults to `-created_at` (desc); only `created_at` is sortable. A `--`
+     * prefix is an error. `nil`/empty filter values are silently dropped.
+     */
+    list(query?: EmailBlockListParams | null | undefined, options?: RequestOptions): PagePromise<EmailBlocksDefaultFlatPagination, EmailBlock>;
+    /**
+     * Creates a suppression with `reason: manual_block` and `source: manual`.
+     * Caller-supplied `reason` / `source` are **ignored**; `scope` is **derived**
+     * server-side from `domain_id` / `from` and is never trusted. Idempotent: if a
+     * matching row already exists (NULL-safe dedupe key: account_id, scope, to,
+     * reason, domain_id, from), returns the existing record with `200` (no new audit
+     * event).
+     *
+     * `bounce_category`, `dsn_code`, `meta`, and `group_id` are **not accepted** on
+     * the public surface. Use the unsubscribe-group suppression endpoint or the
+     * internal create surface for those.
+     */
+    create(body: EmailBlockCreateParams, options?: RequestOptions): APIPromise<EmailBlockResponse>;
+    /**
+     * Streams the account's suppressions as a chunked CSV (server-side cursor; never
+     * materialized). Content-type `text/csv`, header
+     * `Content-Disposition: attachment; filename="email_blocks_export.csv"`.
+     *
+     * Filters (`filter[reason]`, `filter[domain_id]`, `filter[created_after]`,
+     * `filter[created_before]`) are the only params that affect output. `sort` and
+     * `page[*]` are **parsed** (bad values still produce `400`) but **ignored** — rows
+     * stream `ORDER BY created_at ASC, id ASC` with no pagination.
+     *
+     * CSV columns:
+     * `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id`.
+     * The CSV carries the `group_id` column so group-scoped suppressions' group link
+     * survives the export (empty for account-scope rows).
+     */
+    retrieveExport(query?: EmailBlockRetrieveExportParams | null | undefined, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Soft-deletes (status → `removed`; tombstone retained). A `removed` audit event
+     * is appended unless the block was already `removed` (idempotent — returns the
+     * existing row with `200` and no new event). Mutates `updated_at`.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<EmailBlockResponse>;
+    /**
+     * Retrieve a suppression
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<EmailBlockResponse>;
+    /**
+     * Offset pagination only (`page[number]` default 1, `page[size]` default **50**,
+     * max 100). No `sort`, no `filter`, no cursor — ordering is fixed
+     * `desc occurred_at, desc id`. Verifies the block belongs to the account first
+     * (cross-account → 404).
+     */
+    retrieveEvents(id: string, query?: EmailBlockRetrieveEventsParams | null | undefined, options?: RequestOptions): APIPromise<EmailBlockRetrieveEventsResponse>;
+}
+export type EmailBlocksDefaultFlatPagination = DefaultFlatPagination<EmailBlock>;
+/**
+ * Suppression record. Schema fields hidden by the view: `account_id`,
+ * `bounce_category`, `dsn_code`, `meta`.
+ */
+export interface EmailBlock {
+    id: string;
+    created_at: string;
+    reason: 'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block';
+    /**
+     * View-only discriminator.
+     */
+    record_type: 'email_block';
+    /**
+     * Derived server-side from `domain_id`/`from`; never trusted from the caller.
+     */
+    scope: 'account' | 'domain' | 'address';
+    source: 'feedback' | 'manual' | 'import' | 'system';
+    status: 'active' | 'expired' | 'removed';
+    /**
+     * Normalized recipient. (schema: to_address)
+     */
+    to: string;
+    updated_at: string;
+    /**
+     * `null` ⇒ account scope. Stored on the row; exposed here.
+     */
+    domain_id?: string | null;
+    expires_at?: string | null;
+    /**
+     * `null` ⇒ not address-scope. (schema: from_address)
+     */
+    from?: string | null;
+    /**
+     * `null` ⇒ global; set ⇒ group-scoped opt-out.
+     */
+    group_id?: string | null;
+}
+export interface EmailBlockResponse {
+    /**
+     * Suppression record. Schema fields hidden by the view: `account_id`,
+     * `bounce_category`, `dsn_code`, `meta`.
+     */
+    data: EmailBlock;
+}
+export interface OffsetMeta {
+    page_number: number;
+    page_size: number;
+    total_pages: number;
+    total_results: number;
+}
+export interface EmailBlockRetrieveEventsResponse {
+    data: Array<EmailBlockRetrieveEventsResponse.Data>;
+    meta: OffsetMeta;
+}
+export declare namespace EmailBlockRetrieveEventsResponse {
+    interface Data {
+        id: string;
+        /**
+         * Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
+         */
+        actor: string;
+        event_type: 'created' | 'removed' | 'expired' | 'override_used';
+        occurred_at: string;
+        /**
+         * Free-text snapshot of the block's reason at event time.
+         */
+        reason: string;
+        /**
+         * View-only.
+         */
+        record_type: 'email_block_event';
+        /**
+         * Free-text snapshot of the block's source at event time.
+         */
+        source: string;
+        /**
+         * `null` when the schema field is nil (the context usually sets it to `{}`).
+         */
+        meta?: {
+            [key: string]: unknown;
+        } | null;
+    }
+}
+/**
+ * CSV with header row
+ * `id,to,from,reason,source,scope,status,domain_id,created_at,updated_at,expires_at,group_id`.
+ */
+export type EmailBlockRetrieveExportResponse = string;
+export interface EmailBlockListParams extends DefaultFlatPaginationParams {
+    /**
+     * `created_at > value` (ISO 8601).
+     */
+    'filter[created_after]'?: string;
+    /**
+     * `created_at < value` (ISO 8601).
+     */
+    'filter[created_before]'?: string;
+    /**
+     * Exact-match filter on domain_id (UUID).
+     */
+    'filter[domain_id]'?: string;
+    /**
+     * Exact-match filter on reason.
+     */
+    'filter[reason]'?: 'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block';
+    /**
+     * Opaque cursor (`Base.url_encode64` of `{"created_at","id"}`). Cursor mode;
+     * mutually exclusive with `page[number]` and `page[before]`.
+     */
+    'page[after]'?: string;
+    /**
+     * Opaque cursor (see `page[after]`). Mutually exclusive with `page[after]` and
+     * `page[number]`.
+     */
+    'page[before]'?: string;
+    /**
+     * Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+     * `-created_at`. `--` is an error.
+     */
+    sort?: 'created_at' | '-created_at';
+}
+export interface EmailBlockCreateParams {
+    /**
+     * Recipient address (normalized: trim + lower-case).
+     */
+    to: string;
+    /**
+     * `null` ⇒ account scope.
+     */
+    domain_id?: string | null;
+    expires_at?: string | null;
+    /**
+     * Sender address (normalized). `null` ⇒ account/domain scope.
+     */
+    from?: string | null;
+}
+export interface EmailBlockRetrieveExportParams {
+    /**
+     * `created_at > value` (ISO 8601).
+     */
+    'filter[created_after]'?: string;
+    /**
+     * `created_at < value` (ISO 8601).
+     */
+    'filter[created_before]'?: string;
+    /**
+     * Exact-match filter on domain_id (UUID).
+     */
+    'filter[domain_id]'?: string;
+    /**
+     * Exact-match filter on reason.
+     */
+    'filter[reason]'?: 'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block';
+    /**
+     * Offset page number (≥1, default 1).
+     */
+    'page[number]'?: number;
+    /**
+     * Page size (1–100, default 25).
+     */
+    'page[size]'?: number;
+    /**
+     * Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+     * `-created_at`. `--` is an error.
+     */
+    sort?: 'created_at' | '-created_at';
+}
+export interface EmailBlockRetrieveEventsParams {
+    /**
+     * Offset page number (≥1, default 1).
+     */
+    'page[number]'?: number;
+    /**
+     * Page size (default 50, max 100).
+     */
+    'page[size]'?: number;
+}
+export declare namespace EmailBlocks {
+    export { type EmailBlock as EmailBlock, type EmailBlockResponse as EmailBlockResponse, type OffsetMeta as OffsetMeta, type EmailBlockRetrieveEventsResponse as EmailBlockRetrieveEventsResponse, type EmailBlockRetrieveExportResponse as EmailBlockRetrieveExportResponse, type EmailBlocksDefaultFlatPagination as EmailBlocksDefaultFlatPagination, type EmailBlockListParams as EmailBlockListParams, type EmailBlockCreateParams as EmailBlockCreateParams, type EmailBlockRetrieveExportParams as EmailBlockRetrieveExportParams, type EmailBlockRetrieveEventsParams as EmailBlockRetrieveEventsParams, };
+    export { Import as Import, type EmailBlockImportResponse as EmailBlockImportResponse, type ImportCreateParams as ImportCreateParams, };
+}
+//# sourceMappingURL=email-blocks.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email-blocks.d.mts","sourceRoot":"","sources":["../../src/resources/email-blocks/email-blocks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EAAE,wBAAwB,EAAE,MAAM,EAAE,kBAAkB,EAAE,qBAAiB;AAChF,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,kCAA8B;AAE7G,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,UAAU,CAAC;IAI5D;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9F;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAQrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI5E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9E;;;;;OAKG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAGhD;AAED,MAAM,MAAM,gCAAgC,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,aAAa,GAAG,gBAAgB,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;IAEtF;;OAEG;IACH,WAAW,EAAE,aAAa,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAExC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEpD,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC;IAEnD,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,eAAe,CAAC;QAEhE,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC;QAEjC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC1C;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,MAAM,CAAC;AAEtD,MAAM,WAAW,oBAAqB,SAAQ,2BAA2B;IACvE;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;IAEjG;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CACrC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;IAEjG;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CACrC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

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

@@ -0,0 +1,255 @@
+import { APIResource } from "../../core/resource.js";
+import * as ImportAPI from "./import.js";
+import { EmailBlockImportResponse, Import, ImportCreateParams } from "./import.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Recipient suppression records (`/v2/email_blocks`).
+ */
+export declare class EmailBlocks extends APIResource {
+    import: ImportAPI.Import;
+    /**
+     * Account-scoped list. Two mutually exclusive pagination modes:
+     *
+     * - **Offset**: `page[number]` (default 1) + `page[size]` (default 25, max 100).
+     *   `meta` contains `total_pages`.
+     * - **Cursor**: `page[after]` and/or `page[before]` (opaque `Base.url_encode64` of
+     *   `{"created_at","id"}`). Cannot combine with `page[number]`; `after`+`before`
+     *   together is an error. `meta` contains `next_cursor` / `previous_cursor`
+     *   (omitted when their flag is false).
+     *
+     * Sort defaults to `-created_at` (desc); only `created_at` is sortable. A `--`
+     * prefix is an error. `nil`/empty filter values are silently dropped.
+     */
+    list(query?: EmailBlockListParams | null | undefined, options?: RequestOptions): PagePromise<EmailBlocksDefaultFlatPagination, EmailBlock>;
+    /**
+     * Creates a suppression with `reason: manual_block` and `source: manual`.
+     * Caller-supplied `reason` / `source` are **ignored**; `scope` is **derived**
+     * server-side from `domain_id` / `from` and is never trusted. Idempotent: if a
+     * matching row already exists (NULL-safe dedupe key: account_id, scope, to,
+     * reason, domain_id, from), returns the existing record with `200` (no new audit
+     * event).
+     *
+     * `bounce_category`, `dsn_code`, `meta`, and `group_id` are **not accepted** on
+     * the public surface. Use the unsubscribe-group suppression endpoint or the
+     * internal create surface for those.
+     */
+    create(body: EmailBlockCreateParams, options?: RequestOptions): APIPromise<EmailBlockResponse>;
+    /**
+     * Streams the account's suppressions as a chunked CSV (server-side cursor; never
+     * materialized). Content-type `text/csv`, header
+     * `Content-Disposition: attachment; filename="email_blocks_export.csv"`.
+     *
+     * Filters (`filter[reason]`, `filter[domain_id]`, `filter[created_after]`,
+     * `filter[created_before]`) are the only params that affect output. `sort` and
+     * `page[*]` are **parsed** (bad values still produce `400`) but **ignored** — rows
+     * stream `ORDER BY created_at ASC, id ASC` with no pagination.
+     *
+     * CSV columns:
+     * `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id`.
+     * The CSV carries the `group_id` column so group-scoped suppressions' group link
+     * survives the export (empty for account-scope rows).
+     */
+    retrieveExport(query?: EmailBlockRetrieveExportParams | null | undefined, options?: RequestOptions): APIPromise<string>;
+    /**
+     * Soft-deletes (status → `removed`; tombstone retained). A `removed` audit event
+     * is appended unless the block was already `removed` (idempotent — returns the
+     * existing row with `200` and no new event). Mutates `updated_at`.
+     */
+    delete(id: string, options?: RequestOptions): APIPromise<EmailBlockResponse>;
+    /**
+     * Retrieve a suppression
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<EmailBlockResponse>;
+    /**
+     * Offset pagination only (`page[number]` default 1, `page[size]` default **50**,
+     * max 100). No `sort`, no `filter`, no cursor — ordering is fixed
+     * `desc occurred_at, desc id`. Verifies the block belongs to the account first
+     * (cross-account → 404).
+     */
+    retrieveEvents(id: string, query?: EmailBlockRetrieveEventsParams | null | undefined, options?: RequestOptions): APIPromise<EmailBlockRetrieveEventsResponse>;
+}
+export type EmailBlocksDefaultFlatPagination = DefaultFlatPagination<EmailBlock>;
+/**
+ * Suppression record. Schema fields hidden by the view: `account_id`,
+ * `bounce_category`, `dsn_code`, `meta`.
+ */
+export interface EmailBlock {
+    id: string;
+    created_at: string;
+    reason: 'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block';
+    /**
+     * View-only discriminator.
+     */
+    record_type: 'email_block';
+    /**
+     * Derived server-side from `domain_id`/`from`; never trusted from the caller.
+     */
+    scope: 'account' | 'domain' | 'address';
+    source: 'feedback' | 'manual' | 'import' | 'system';
+    status: 'active' | 'expired' | 'removed';
+    /**
+     * Normalized recipient. (schema: to_address)
+     */
+    to: string;
+    updated_at: string;
+    /**
+     * `null` ⇒ account scope. Stored on the row; exposed here.
+     */
+    domain_id?: string | null;
+    expires_at?: string | null;
+    /**
+     * `null` ⇒ not address-scope. (schema: from_address)
+     */
+    from?: string | null;
+    /**
+     * `null` ⇒ global; set ⇒ group-scoped opt-out.
+     */
+    group_id?: string | null;
+}
+export interface EmailBlockResponse {
+    /**
+     * Suppression record. Schema fields hidden by the view: `account_id`,
+     * `bounce_category`, `dsn_code`, `meta`.
+     */
+    data: EmailBlock;
+}
+export interface OffsetMeta {
+    page_number: number;
+    page_size: number;
+    total_pages: number;
+    total_results: number;
+}
+export interface EmailBlockRetrieveEventsResponse {
+    data: Array<EmailBlockRetrieveEventsResponse.Data>;
+    meta: OffsetMeta;
+}
+export declare namespace EmailBlockRetrieveEventsResponse {
+    interface Data {
+        id: string;
+        /**
+         * Free-text (`user_id`/`org_id`/`api_key`/`dev_bypass`/`system`/`manual`).
+         */
+        actor: string;
+        event_type: 'created' | 'removed' | 'expired' | 'override_used';
+        occurred_at: string;
+        /**
+         * Free-text snapshot of the block's reason at event time.
+         */
+        reason: string;
+        /**
+         * View-only.
+         */
+        record_type: 'email_block_event';
+        /**
+         * Free-text snapshot of the block's source at event time.
+         */
+        source: string;
+        /**
+         * `null` when the schema field is nil (the context usually sets it to `{}`).
+         */
+        meta?: {
+            [key: string]: unknown;
+        } | null;
+    }
+}
+/**
+ * CSV with header row
+ * `id,to,from,reason,source,scope,status,domain_id,created_at,updated_at,expires_at,group_id`.
+ */
+export type EmailBlockRetrieveExportResponse = string;
+export interface EmailBlockListParams extends DefaultFlatPaginationParams {
+    /**
+     * `created_at > value` (ISO 8601).
+     */
+    'filter[created_after]'?: string;
+    /**
+     * `created_at < value` (ISO 8601).
+     */
+    'filter[created_before]'?: string;
+    /**
+     * Exact-match filter on domain_id (UUID).
+     */
+    'filter[domain_id]'?: string;
+    /**
+     * Exact-match filter on reason.
+     */
+    'filter[reason]'?: 'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block';
+    /**
+     * Opaque cursor (`Base.url_encode64` of `{"created_at","id"}`). Cursor mode;
+     * mutually exclusive with `page[number]` and `page[before]`.
+     */
+    'page[after]'?: string;
+    /**
+     * Opaque cursor (see `page[after]`). Mutually exclusive with `page[after]` and
+     * `page[number]`.
+     */
+    'page[before]'?: string;
+    /**
+     * Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+     * `-created_at`. `--` is an error.
+     */
+    sort?: 'created_at' | '-created_at';
+}
+export interface EmailBlockCreateParams {
+    /**
+     * Recipient address (normalized: trim + lower-case).
+     */
+    to: string;
+    /**
+     * `null` ⇒ account scope.
+     */
+    domain_id?: string | null;
+    expires_at?: string | null;
+    /**
+     * Sender address (normalized). `null` ⇒ account/domain scope.
+     */
+    from?: string | null;
+}
+export interface EmailBlockRetrieveExportParams {
+    /**
+     * `created_at > value` (ISO 8601).
+     */
+    'filter[created_after]'?: string;
+    /**
+     * `created_at < value` (ISO 8601).
+     */
+    'filter[created_before]'?: string;
+    /**
+     * Exact-match filter on domain_id (UUID).
+     */
+    'filter[domain_id]'?: string;
+    /**
+     * Exact-match filter on reason.
+     */
+    'filter[reason]'?: 'hard_bounce' | 'spam_complaint' | 'unsubscribe' | 'invalid' | 'manual_block';
+    /**
+     * Offset page number (≥1, default 1).
+     */
+    'page[number]'?: number;
+    /**
+     * Page size (1–100, default 25).
+     */
+    'page[size]'?: number;
+    /**
+     * Sort field. Leading `-` = desc; only `created_at` is sortable. Default
+     * `-created_at`. `--` is an error.
+     */
+    sort?: 'created_at' | '-created_at';
+}
+export interface EmailBlockRetrieveEventsParams {
+    /**
+     * Offset page number (≥1, default 1).
+     */
+    'page[number]'?: number;
+    /**
+     * Page size (default 50, max 100).
+     */
+    'page[size]'?: number;
+}
+export declare namespace EmailBlocks {
+    export { type EmailBlock as EmailBlock, type EmailBlockResponse as EmailBlockResponse, type OffsetMeta as OffsetMeta, type EmailBlockRetrieveEventsResponse as EmailBlockRetrieveEventsResponse, type EmailBlockRetrieveExportResponse as EmailBlockRetrieveExportResponse, type EmailBlocksDefaultFlatPagination as EmailBlocksDefaultFlatPagination, type EmailBlockListParams as EmailBlockListParams, type EmailBlockCreateParams as EmailBlockCreateParams, type EmailBlockRetrieveExportParams as EmailBlockRetrieveExportParams, type EmailBlockRetrieveEventsParams as EmailBlockRetrieveEventsParams, };
+    export { Import as Import, type EmailBlockImportResponse as EmailBlockImportResponse, type ImportCreateParams as ImportCreateParams, };
+}
+//# sourceMappingURL=email-blocks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email-blocks.d.ts","sourceRoot":"","sources":["../../src/resources/email-blocks/email-blocks.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,SAAS,oBAAiB;AACtC,OAAO,EAAE,wBAAwB,EAAE,MAAM,EAAE,kBAAkB,EAAE,oBAAiB;AAChF,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,iCAA8B;AAE7G,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,gCAAgC,EAAE,UAAU,CAAC;IAI5D;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9F;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAQrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI5E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAI9E;;;;;OAKG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,8BAA8B,GAAG,IAAI,GAAG,SAAc,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;CAGhD;AAED,MAAM,MAAM,gCAAgC,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,MAAM,EAAE,aAAa,GAAG,gBAAgB,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;IAEtF;;OAEG;IACH,WAAW,EAAE,aAAa,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAExC,MAAM,EAAE,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEpD,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,EAAE,MAAM,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAElB,WAAW,EAAE,MAAM,CAAC;IAEpB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,KAAK,CAAC,gCAAgC,CAAC,IAAI,CAAC,CAAC;IAEnD,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,yBAAiB,gCAAgC,CAAC;IAChD,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,UAAU,EAAE,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,eAAe,CAAC;QAEhE,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,WAAW,EAAE,mBAAmB,CAAC;QAEjC;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC1C;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,gCAAgC,GAAG,MAAM,CAAC;AAEtD,MAAM,WAAW,oBAAqB,SAAQ,2BAA2B;IACvE;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;IAEjG;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CACrC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,aAAa,GAAG,gBAAgB,GAAG,aAAa,GAAG,SAAS,GAAG,cAAc,CAAC;IAEjG;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;CACrC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAID,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}

package/resources/email-blocks/email-blocks.js

@@ -0,0 +1,99 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailBlocks = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const resource_1 = require("../../core/resource.js");
+const ImportAPI = tslib_1.__importStar(require("./import.js"));
+const import_1 = require("./import.js");
+const pagination_1 = require("../../core/pagination.js");
+const headers_1 = require("../../internal/headers.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Recipient suppression records (`/v2/email_blocks`).
+ */
+class EmailBlocks extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.import = new ImportAPI.Import(this._client);
+    }
+    /**
+     * Account-scoped list. Two mutually exclusive pagination modes:
+     *
+     * - **Offset**: `page[number]` (default 1) + `page[size]` (default 25, max 100).
+     *   `meta` contains `total_pages`.
+     * - **Cursor**: `page[after]` and/or `page[before]` (opaque `Base.url_encode64` of
+     *   `{"created_at","id"}`). Cannot combine with `page[number]`; `after`+`before`
+     *   together is an error. `meta` contains `next_cursor` / `previous_cursor`
+     *   (omitted when their flag is false).
+     *
+     * Sort defaults to `-created_at` (desc); only `created_at` is sortable. A `--`
+     * prefix is an error. `nil`/empty filter values are silently dropped.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/email_blocks', (pagination_1.DefaultFlatPagination), { query, ...options });
+    }
+    /**
+     * Creates a suppression with `reason: manual_block` and `source: manual`.
+     * Caller-supplied `reason` / `source` are **ignored**; `scope` is **derived**
+     * server-side from `domain_id` / `from` and is never trusted. Idempotent: if a
+     * matching row already exists (NULL-safe dedupe key: account_id, scope, to,
+     * reason, domain_id, from), returns the existing record with `200` (no new audit
+     * event).
+     *
+     * `bounce_category`, `dsn_code`, `meta`, and `group_id` are **not accepted** on
+     * the public surface. Use the unsubscribe-group suppression endpoint or the
+     * internal create surface for those.
+     */
+    create(body, options) {
+        return this._client.post('/email_blocks', { body, ...options });
+    }
+    /**
+     * Streams the account's suppressions as a chunked CSV (server-side cursor; never
+     * materialized). Content-type `text/csv`, header
+     * `Content-Disposition: attachment; filename="email_blocks_export.csv"`.
+     *
+     * Filters (`filter[reason]`, `filter[domain_id]`, `filter[created_after]`,
+     * `filter[created_before]`) are the only params that affect output. `sort` and
+     * `page[*]` are **parsed** (bad values still produce `400`) but **ignored** — rows
+     * stream `ORDER BY created_at ASC, id ASC` with no pagination.
+     *
+     * CSV columns:
+     * `id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id`.
+     * The CSV carries the `group_id` column so group-scoped suppressions' group link
+     * survives the export (empty for account-scope rows).
+     */
+    retrieveExport(query = {}, options) {
+        return this._client.get('/email_blocks/export', {
+            query,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: 'text/csv' }, options?.headers]),
+        });
+    }
+    /**
+     * Soft-deletes (status → `removed`; tombstone retained). A `removed` audit event
+     * is appended unless the block was already `removed` (idempotent — returns the
+     * existing row with `200` and no new event). Mutates `updated_at`.
+     */
+    delete(id, options) {
+        return this._client.delete((0, path_1.path) `/email_blocks/${id}`, options);
+    }
+    /**
+     * Retrieve a suppression
+     */
+    retrieve(id, options) {
+        return this._client.get((0, path_1.path) `/email_blocks/${id}`, options);
+    }
+    /**
+     * Offset pagination only (`page[number]` default 1, `page[size]` default **50**,
+     * max 100). No `sort`, no `filter`, no cursor — ordering is fixed
+     * `desc occurred_at, desc id`. Verifies the block belongs to the account first
+     * (cross-account → 404).
+     */
+    retrieveEvents(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/email_blocks/${id}/events`, { query, ...options });
+    }
+}
+exports.EmailBlocks = EmailBlocks;
+EmailBlocks.Import = import_1.Import;
+//# sourceMappingURL=email-blocks.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email-blocks.js","sourceRoot":"","sources":["../../src/resources/email-blocks/email-blocks.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAClD,+DAAsC;AACtC,wCAAgF;AAEhF,yDAA6G;AAC7G,uDAAsD;AAEtD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,WAAY,SAAQ,sBAAW;IAA5C;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6FhE,CAAC;IA3FC;;;;;;;;;;;;OAYG;IACH,IAAI,CACF,QAAiD,EAAE,EACnD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,kCAAiC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAA4B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE;YAC9C,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAClE,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,cAAc,CACZ,EAAU,EACV,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AA9FD,kCA8FC;AAoOD,WAAW,CAAC,MAAM,GAAG,eAAM,CAAC"}