telnyx 6.83.0 → 7.1.0

package/resources/enterprises/dir.d.mts

@@ -0,0 +1,167 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as DirAPI from "../dir/dir.mjs";
+import { DirsDefaultFlatPagination } from "../dir/dir.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * A Display Identity Record (DIR) is the verified calling identity (display name, logo, call reasons) shown to recipients on outbound calls.
+ */
+export declare class Dir extends APIResource {
+    /**
+     * Create a new DIR under the given enterprise. The DIR starts in `draft` status;
+     * it must be submitted (`POST .../submit`) and approved by Telnyx before any phone
+     * number can be attached.
+     *
+     * **Field rules**
+     *
+     * - `display_name`: 1–35 characters, no emoji or whitespace-only strings; this is
+     *   the name shown to recipients.
+     * - `call_reasons`: 1–10 strings, each ≤64 characters; describe why your business
+     *   calls customers (e.g. 'Appointment reminders', 'Billing inquiries'). Validate
+     *   the wording against `POST /call_reasons/validate`.
+     * - `logo_url`: HTTPS URL (max 128 chars) to a 256×256 BMP (max 1 MB). The image
+     *   is downloaded and hashed at submission time.
+     * - `documents`: up to 20 entries; each `document_id` must be obtained by
+     *   uploading the file via the Telnyx Documents API first. Within one DIR a
+     *   `document_id` may only appear once.
+     * - `certify_brand_is_accurate`, `certify_no_shaft_content`,
+     *   `certify_ip_ownership` MUST all be `true`.
+     *
+     * **Failure modes**
+     *
+     * - `422` - validation error; `errors[].source.pointer` names the offending field.
+     * - `403` - Branded Calling not activated on this enterprise (see
+     *   `POST /enterprises/{id}/branded_calling`).
+     * - `404` - enterprise does not exist or does not belong to your account.
+     *
+     * @example
+     * ```ts
+     * const dirWrapped = await client.enterprises.dir.create(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *   {
+     *     authorizer_email: 'sam@acmeplumbing.example.com',
+     *     authorizer_name: 'Sam Owner',
+     *     certify_brand_is_accurate: true,
+     *     certify_ip_ownership: true,
+     *     certify_no_shaft_content: true,
+     *     display_name: 'Acme Plumbing',
+     *     call_reasons: [
+     *       'Appointment reminders',
+     *       'Billing inquiries',
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    create(enterpriseID: string, body: DirCreateParams, options?: RequestOptions): APIPromise<DirAPI.DirWrapped>;
+    /**
+     * Return the DIRs (Display Identity Records) belonging to a single enterprise.
+     * Pagination is JSON:API style (`page[number]`, `page[size]`, max 250). Supports
+     * `filter[]` query params: `filter[status]`, `filter[display_name][contains]`,
+     * `filter[call_reason][contains]`, plus the renewal-window filters
+     * `filter[expiring_at][gte]` / `filter[expiring_at][lte]` and the convenience
+     * `filter[expiring_within_days]` (mutually exclusive with the explicit gte/lte
+     * form). Sortable by `created_at`, `updated_at`, `display_name`, `status`,
+     * `submitted_at`, `verified_at`, `expiring_at` (prefix `-` for descending; default
+     * `-created_at`).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const dir of client.enterprises.dir.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(enterpriseID: string, query?: DirListParams | null | undefined, options?: RequestOptions): PagePromise<DirsDefaultFlatPagination, DirAPI.Dir>;
+}
+export interface DirCreateParams {
+    /**
+     * Contact email of the authorizer. Telnyx may send verification or
+     * infringement-notice email here; use a monitored mailbox.
+     */
+    authorizer_email: string;
+    /**
+     * Name of the person at your enterprise who is authorizing this DIR registration.
+     * Must be a real individual (used for audit and trademark-claim contests).
+     */
+    authorizer_name: string;
+    /**
+     * Must be `true`.
+     */
+    certify_brand_is_accurate: true;
+    /**
+     * Must be `true`. Confirms ownership of any logos/trademarks shown.
+     */
+    certify_ip_ownership: true;
+    /**
+     * Must be `true`. Confirms this DIR is not used for SHAFT content (Sex, Hate,
+     * Alcohol, Firearms, Tobacco) where prohibited.
+     */
+    certify_no_shaft_content: true;
+    /**
+     * Name shown to call recipients. No emoji; not whitespace-only.
+     */
+    display_name: string;
+    /**
+     * 1–10 reasons your business calls customers. Validate phrasing against
+     * `POST /call_reasons/validate`.
+     */
+    call_reasons?: Array<string>;
+    /**
+     * Supporting documents. Each `document_id` may appear at most once on a DIR.
+     */
+    documents?: Array<DirAPI.Document>;
+    /**
+     * Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
+     */
+    logo_url?: string;
+    /**
+     * Set to true if your organization places calls on behalf of other enterprises
+     * (BPO/reseller).
+     */
+    reselling?: boolean;
+}
+export interface DirListParams extends DefaultFlatPaginationParams {
+    /**
+     * Case-insensitive partial match on call reason.
+     */
+    'filter[call_reason][contains]'?: string;
+    /**
+     * Case-insensitive partial match on display name.
+     */
+    'filter[display_name][contains]'?: string;
+    /**
+     * Return only DIRs whose `expiring_at` is at or after this ISO-8601 timestamp.
+     */
+    'filter[expiring_at][gte]'?: string;
+    /**
+     * Return only DIRs whose `expiring_at` is at or before this ISO-8601 timestamp.
+     */
+    'filter[expiring_at][lte]'?: string;
+    /**
+     * Convenience: returns DIRs whose `expiring_at` falls within the next N days
+     * (1–365). Equivalent to setting `filter[expiring_at][gte]=<now>` +
+     * `filter[expiring_at][lte]=<now+N>`. Mutually exclusive with the explicit
+     * `[gte]`/`[lte]` filters - combining returns 400.
+     */
+    'filter[expiring_within_days]'?: number;
+    /**
+     * Filter by DIR status.
+     */
+    'filter[status]'?: DirAPI.DirStatus;
+    /**
+     * Sort field. Allowed: `created_at`, `updated_at`, `display_name`, `status`,
+     * `submitted_at`, `verified_at`, `expiring_at`. Prefix with `-` for descending.
+     * Default `-created_at`.
+     */
+    sort?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'display_name' | '-display_name' | 'status' | '-status' | 'submitted_at' | '-submitted_at' | 'verified_at' | '-verified_at' | 'expiring_at' | '-expiring_at';
+}
+export declare namespace Dir {
+    export { type DirCreateParams as DirCreateParams, type DirListParams as DirListParams };
+}
+export { type DirsDefaultFlatPagination };
+//# sourceMappingURL=dir.d.mts.map

package/resources/enterprises/dir.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dir.d.mts","sourceRoot":"","sources":["../../src/resources/enterprises/dir.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,uBAAmB;AACrC,OAAO,EAAE,yBAAyB,EAAE,uBAAmB;AACvD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAyB,KAAK,2BAA2B,EAAE,WAAW,EAAE,kCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,MAAM,CAAC,GAAG,CAAC;CAOtD;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,IAAI,CAAC;IAE3B;;;OAGG;IACH,wBAAwB,EAAE,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,aAAc,SAAQ,2BAA2B;IAChE;;OAEG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;IAEpC;;;;OAIG;IACH,IAAI,CAAC,EACD,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,aAAa,GACb,cAAc,GACd,eAAe,GACf,QAAQ,GACR,SAAS,GACT,cAAc,GACd,eAAe,GACf,aAAa,GACb,cAAc,GACd,aAAa,GACb,cAAc,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzF;AAED,OAAO,EAAE,KAAK,yBAAyB,EAAE,CAAC"}

package/resources/enterprises/dir.d.ts

@@ -0,0 +1,167 @@
+import { APIResource } from "../../core/resource.js";
+import * as DirAPI from "../dir/dir.js";
+import { DirsDefaultFlatPagination } from "../dir/dir.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * A Display Identity Record (DIR) is the verified calling identity (display name, logo, call reasons) shown to recipients on outbound calls.
+ */
+export declare class Dir extends APIResource {
+    /**
+     * Create a new DIR under the given enterprise. The DIR starts in `draft` status;
+     * it must be submitted (`POST .../submit`) and approved by Telnyx before any phone
+     * number can be attached.
+     *
+     * **Field rules**
+     *
+     * - `display_name`: 1–35 characters, no emoji or whitespace-only strings; this is
+     *   the name shown to recipients.
+     * - `call_reasons`: 1–10 strings, each ≤64 characters; describe why your business
+     *   calls customers (e.g. 'Appointment reminders', 'Billing inquiries'). Validate
+     *   the wording against `POST /call_reasons/validate`.
+     * - `logo_url`: HTTPS URL (max 128 chars) to a 256×256 BMP (max 1 MB). The image
+     *   is downloaded and hashed at submission time.
+     * - `documents`: up to 20 entries; each `document_id` must be obtained by
+     *   uploading the file via the Telnyx Documents API first. Within one DIR a
+     *   `document_id` may only appear once.
+     * - `certify_brand_is_accurate`, `certify_no_shaft_content`,
+     *   `certify_ip_ownership` MUST all be `true`.
+     *
+     * **Failure modes**
+     *
+     * - `422` - validation error; `errors[].source.pointer` names the offending field.
+     * - `403` - Branded Calling not activated on this enterprise (see
+     *   `POST /enterprises/{id}/branded_calling`).
+     * - `404` - enterprise does not exist or does not belong to your account.
+     *
+     * @example
+     * ```ts
+     * const dirWrapped = await client.enterprises.dir.create(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *   {
+     *     authorizer_email: 'sam@acmeplumbing.example.com',
+     *     authorizer_name: 'Sam Owner',
+     *     certify_brand_is_accurate: true,
+     *     certify_ip_ownership: true,
+     *     certify_no_shaft_content: true,
+     *     display_name: 'Acme Plumbing',
+     *     call_reasons: [
+     *       'Appointment reminders',
+     *       'Billing inquiries',
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    create(enterpriseID: string, body: DirCreateParams, options?: RequestOptions): APIPromise<DirAPI.DirWrapped>;
+    /**
+     * Return the DIRs (Display Identity Records) belonging to a single enterprise.
+     * Pagination is JSON:API style (`page[number]`, `page[size]`, max 250). Supports
+     * `filter[]` query params: `filter[status]`, `filter[display_name][contains]`,
+     * `filter[call_reason][contains]`, plus the renewal-window filters
+     * `filter[expiring_at][gte]` / `filter[expiring_at][lte]` and the convenience
+     * `filter[expiring_within_days]` (mutually exclusive with the explicit gte/lte
+     * form). Sortable by `created_at`, `updated_at`, `display_name`, `status`,
+     * `submitted_at`, `verified_at`, `expiring_at` (prefix `-` for descending; default
+     * `-created_at`).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const dir of client.enterprises.dir.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(enterpriseID: string, query?: DirListParams | null | undefined, options?: RequestOptions): PagePromise<DirsDefaultFlatPagination, DirAPI.Dir>;
+}
+export interface DirCreateParams {
+    /**
+     * Contact email of the authorizer. Telnyx may send verification or
+     * infringement-notice email here; use a monitored mailbox.
+     */
+    authorizer_email: string;
+    /**
+     * Name of the person at your enterprise who is authorizing this DIR registration.
+     * Must be a real individual (used for audit and trademark-claim contests).
+     */
+    authorizer_name: string;
+    /**
+     * Must be `true`.
+     */
+    certify_brand_is_accurate: true;
+    /**
+     * Must be `true`. Confirms ownership of any logos/trademarks shown.
+     */
+    certify_ip_ownership: true;
+    /**
+     * Must be `true`. Confirms this DIR is not used for SHAFT content (Sex, Hate,
+     * Alcohol, Firearms, Tobacco) where prohibited.
+     */
+    certify_no_shaft_content: true;
+    /**
+     * Name shown to call recipients. No emoji; not whitespace-only.
+     */
+    display_name: string;
+    /**
+     * 1–10 reasons your business calls customers. Validate phrasing against
+     * `POST /call_reasons/validate`.
+     */
+    call_reasons?: Array<string>;
+    /**
+     * Supporting documents. Each `document_id` may appear at most once on a DIR.
+     */
+    documents?: Array<DirAPI.Document>;
+    /**
+     * Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).
+     */
+    logo_url?: string;
+    /**
+     * Set to true if your organization places calls on behalf of other enterprises
+     * (BPO/reseller).
+     */
+    reselling?: boolean;
+}
+export interface DirListParams extends DefaultFlatPaginationParams {
+    /**
+     * Case-insensitive partial match on call reason.
+     */
+    'filter[call_reason][contains]'?: string;
+    /**
+     * Case-insensitive partial match on display name.
+     */
+    'filter[display_name][contains]'?: string;
+    /**
+     * Return only DIRs whose `expiring_at` is at or after this ISO-8601 timestamp.
+     */
+    'filter[expiring_at][gte]'?: string;
+    /**
+     * Return only DIRs whose `expiring_at` is at or before this ISO-8601 timestamp.
+     */
+    'filter[expiring_at][lte]'?: string;
+    /**
+     * Convenience: returns DIRs whose `expiring_at` falls within the next N days
+     * (1–365). Equivalent to setting `filter[expiring_at][gte]=<now>` +
+     * `filter[expiring_at][lte]=<now+N>`. Mutually exclusive with the explicit
+     * `[gte]`/`[lte]` filters - combining returns 400.
+     */
+    'filter[expiring_within_days]'?: number;
+    /**
+     * Filter by DIR status.
+     */
+    'filter[status]'?: DirAPI.DirStatus;
+    /**
+     * Sort field. Allowed: `created_at`, `updated_at`, `display_name`, `status`,
+     * `submitted_at`, `verified_at`, `expiring_at`. Prefix with `-` for descending.
+     * Default `-created_at`.
+     */
+    sort?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'display_name' | '-display_name' | 'status' | '-status' | 'submitted_at' | '-submitted_at' | 'verified_at' | '-verified_at' | 'expiring_at' | '-expiring_at';
+}
+export declare namespace Dir {
+    export { type DirCreateParams as DirCreateParams, type DirListParams as DirListParams };
+}
+export { type DirsDefaultFlatPagination };
+//# sourceMappingURL=dir.d.ts.map

package/resources/enterprises/dir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dir.d.ts","sourceRoot":"","sources":["../../src/resources/enterprises/dir.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,sBAAmB;AACrC,OAAO,EAAE,yBAAyB,EAAE,sBAAmB;AACvD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAyB,KAAK,2BAA2B,EAAE,WAAW,EAAE,iCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC;IAIhC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAC5C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,yBAAyB,EAAE,MAAM,CAAC,GAAG,CAAC;CAOtD;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAEhC;;OAEG;IACH,oBAAoB,EAAE,IAAI,CAAC;IAE3B;;;OAGG;IACH,wBAAwB,EAAE,IAAI,CAAC;IAE/B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,aAAc,SAAQ,2BAA2B;IAChE;;OAEG;IACH,+BAA+B,CAAC,EAAE,MAAM,CAAC;IAEzC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;;OAKG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;IAExC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC;IAEpC;;;;OAIG;IACH,IAAI,CAAC,EACD,YAAY,GACZ,aAAa,GACb,YAAY,GACZ,aAAa,GACb,cAAc,GACd,eAAe,GACf,QAAQ,GACR,SAAS,GACT,cAAc,GACd,eAAe,GACf,aAAa,GACb,cAAc,GACd,aAAa,GACb,cAAc,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B,OAAO,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,KAAK,aAAa,IAAI,aAAa,EAAE,CAAC;CACzF;AAED,OAAO,EAAE,KAAK,yBAAyB,EAAE,CAAC"}

package/resources/enterprises/dir.js

@@ -0,0 +1,87 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Dir = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * A Display Identity Record (DIR) is the verified calling identity (display name, logo, call reasons) shown to recipients on outbound calls.
+ */
+class Dir extends resource_1.APIResource {
+    /**
+     * Create a new DIR under the given enterprise. The DIR starts in `draft` status;
+     * it must be submitted (`POST .../submit`) and approved by Telnyx before any phone
+     * number can be attached.
+     *
+     * **Field rules**
+     *
+     * - `display_name`: 1–35 characters, no emoji or whitespace-only strings; this is
+     *   the name shown to recipients.
+     * - `call_reasons`: 1–10 strings, each ≤64 characters; describe why your business
+     *   calls customers (e.g. 'Appointment reminders', 'Billing inquiries'). Validate
+     *   the wording against `POST /call_reasons/validate`.
+     * - `logo_url`: HTTPS URL (max 128 chars) to a 256×256 BMP (max 1 MB). The image
+     *   is downloaded and hashed at submission time.
+     * - `documents`: up to 20 entries; each `document_id` must be obtained by
+     *   uploading the file via the Telnyx Documents API first. Within one DIR a
+     *   `document_id` may only appear once.
+     * - `certify_brand_is_accurate`, `certify_no_shaft_content`,
+     *   `certify_ip_ownership` MUST all be `true`.
+     *
+     * **Failure modes**
+     *
+     * - `422` - validation error; `errors[].source.pointer` names the offending field.
+     * - `403` - Branded Calling not activated on this enterprise (see
+     *   `POST /enterprises/{id}/branded_calling`).
+     * - `404` - enterprise does not exist or does not belong to your account.
+     *
+     * @example
+     * ```ts
+     * const dirWrapped = await client.enterprises.dir.create(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *   {
+     *     authorizer_email: 'sam@acmeplumbing.example.com',
+     *     authorizer_name: 'Sam Owner',
+     *     certify_brand_is_accurate: true,
+     *     certify_ip_ownership: true,
+     *     certify_no_shaft_content: true,
+     *     display_name: 'Acme Plumbing',
+     *     call_reasons: [
+     *       'Appointment reminders',
+     *       'Billing inquiries',
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    create(enterpriseID, body, options) {
+        return this._client.post((0, path_1.path) `/enterprises/${enterpriseID}/dir`, { body, ...options });
+    }
+    /**
+     * Return the DIRs (Display Identity Records) belonging to a single enterprise.
+     * Pagination is JSON:API style (`page[number]`, `page[size]`, max 250). Supports
+     * `filter[]` query params: `filter[status]`, `filter[display_name][contains]`,
+     * `filter[call_reason][contains]`, plus the renewal-window filters
+     * `filter[expiring_at][gte]` / `filter[expiring_at][lte]` and the convenience
+     * `filter[expiring_within_days]` (mutually exclusive with the explicit gte/lte
+     * form). Sortable by `created_at`, `updated_at`, `display_name`, `status`,
+     * `submitted_at`, `verified_at`, `expiring_at` (prefix `-` for descending; default
+     * `-created_at`).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const dir of client.enterprises.dir.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(enterpriseID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/enterprises/${enterpriseID}/dir`, (pagination_1.DefaultFlatPagination), { query, ...options });
+    }
+}
+exports.Dir = Dir;
+//# sourceMappingURL=dir.js.map

package/resources/enterprises/dir.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dir.js","sourceRoot":"","sources":["../../src/resources/enterprises/dir.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAA6G;AAE7G,uDAAiD;AAEjD;;GAEG;AACH,MAAa,GAAI,SAAQ,sBAAW;IAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,YAAoB,EACpB,IAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,YAAY,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,YAAoB,EACpB,QAA0C,EAAE,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,gBAAgB,YAAY,MAAM,EACtC,CAAA,kCAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAvFD,kBAuFC"}

package/resources/enterprises/dir.mjs

@@ -0,0 +1,83 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { DefaultFlatPagination } from "../../core/pagination.mjs";
+import { path } from "../../internal/utils/path.mjs";
+/**
+ * A Display Identity Record (DIR) is the verified calling identity (display name, logo, call reasons) shown to recipients on outbound calls.
+ */
+export class Dir extends APIResource {
+    /**
+     * Create a new DIR under the given enterprise. The DIR starts in `draft` status;
+     * it must be submitted (`POST .../submit`) and approved by Telnyx before any phone
+     * number can be attached.
+     *
+     * **Field rules**
+     *
+     * - `display_name`: 1–35 characters, no emoji or whitespace-only strings; this is
+     *   the name shown to recipients.
+     * - `call_reasons`: 1–10 strings, each ≤64 characters; describe why your business
+     *   calls customers (e.g. 'Appointment reminders', 'Billing inquiries'). Validate
+     *   the wording against `POST /call_reasons/validate`.
+     * - `logo_url`: HTTPS URL (max 128 chars) to a 256×256 BMP (max 1 MB). The image
+     *   is downloaded and hashed at submission time.
+     * - `documents`: up to 20 entries; each `document_id` must be obtained by
+     *   uploading the file via the Telnyx Documents API first. Within one DIR a
+     *   `document_id` may only appear once.
+     * - `certify_brand_is_accurate`, `certify_no_shaft_content`,
+     *   `certify_ip_ownership` MUST all be `true`.
+     *
+     * **Failure modes**
+     *
+     * - `422` - validation error; `errors[].source.pointer` names the offending field.
+     * - `403` - Branded Calling not activated on this enterprise (see
+     *   `POST /enterprises/{id}/branded_calling`).
+     * - `404` - enterprise does not exist or does not belong to your account.
+     *
+     * @example
+     * ```ts
+     * const dirWrapped = await client.enterprises.dir.create(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *   {
+     *     authorizer_email: 'sam@acmeplumbing.example.com',
+     *     authorizer_name: 'Sam Owner',
+     *     certify_brand_is_accurate: true,
+     *     certify_ip_ownership: true,
+     *     certify_no_shaft_content: true,
+     *     display_name: 'Acme Plumbing',
+     *     call_reasons: [
+     *       'Appointment reminders',
+     *       'Billing inquiries',
+     *     ],
+     *   },
+     * );
+     * ```
+     */
+    create(enterpriseID, body, options) {
+        return this._client.post(path `/enterprises/${enterpriseID}/dir`, { body, ...options });
+    }
+    /**
+     * Return the DIRs (Display Identity Records) belonging to a single enterprise.
+     * Pagination is JSON:API style (`page[number]`, `page[size]`, max 250). Supports
+     * `filter[]` query params: `filter[status]`, `filter[display_name][contains]`,
+     * `filter[call_reason][contains]`, plus the renewal-window filters
+     * `filter[expiring_at][gte]` / `filter[expiring_at][lte]` and the convenience
+     * `filter[expiring_within_days]` (mutually exclusive with the explicit gte/lte
+     * form). Sortable by `created_at`, `updated_at`, `display_name`, `status`,
+     * `submitted_at`, `verified_at`, `expiring_at` (prefix `-` for descending; default
+     * `-created_at`).
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const dir of client.enterprises.dir.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(enterpriseID, query = {}, options) {
+        return this._client.getAPIList(path `/enterprises/${enterpriseID}/dir`, (DefaultFlatPagination), { query, ...options });
+    }
+}
+//# sourceMappingURL=dir.mjs.map

package/resources/enterprises/dir.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dir.mjs","sourceRoot":"","sources":["../../src/resources/enterprises/dir.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,qBAAqB,EAAiD,kCAA8B;AAE7G,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,WAAW;IAClC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACH,MAAM,CACJ,YAAoB,EACpB,IAAqB,EACrB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,YAAY,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,YAAoB,EACpB,QAA0C,EAAE,EAC5C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,YAAY,MAAM,EACtC,CAAA,qBAAiC,CAAA,EACjC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}