telnyx 6.74.2 → 7.1.0

package/resources/dir/phone-number-batches.d.ts

@@ -0,0 +1,120 @@
+import { APIResource } from "../../core/resource.js";
+import * as DirAPI from "./dir.js";
+import * as PhoneNumbersAPI from "./phone-numbers.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Phone numbers are submitted to Telnyx for vetting in batches. Batches group all numbers added in a single request under the same Letter of Authorization.
+ */
+export declare class PhoneNumberBatches extends APIResource {
+    /**
+     * Get a single phone-number batch by id. The enterprise is resolved server-side
+     * from the DIR id.
+     *
+     * @example
+     * ```ts
+     * const phoneNumberBatch =
+     *   await client.dir.phoneNumberBatches.retrieve(
+     *     '0a4b1f5e-2f12-4c0c-9a98-9b3a7d8b8e62',
+     *     { dir_id: '16635d38-75a6-4481-82e8-69af60e05011' },
+     *   );
+     * ```
+     */
+    retrieve(batchID: string, params: PhoneNumberBatchRetrieveParams, options?: RequestOptions): APIPromise<PhoneNumberBatchRetrieveResponse>;
+    /**
+     * List the phone-number batches submitted under a DIR. The enterprise is resolved
+     * server-side from the DIR id.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const phoneNumberBatch of client.dir.phoneNumberBatches.list(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(dirID: string, query?: PhoneNumberBatchListParams | null | undefined, options?: RequestOptions): PagePromise<PhoneNumberBatchesDefaultFlatPagination, PhoneNumberBatch>;
+}
+export type PhoneNumberBatchesDefaultFlatPagination = DefaultFlatPagination<PhoneNumberBatch>;
+/**
+ * Phone-number lifecycle status.
+ *
+ * - `submitted` / `in_review` - Telnyx is reviewing the batch this number belongs
+ *   to.
+ * - `verified` - approved; the DIR's display identity will be shown on outbound
+ *   calls from this number.
+ * - `unsuccessful` - Telnyx rejected this submission; the customer may re-add to
+ *   retry.
+ * - `suspended` - temporarily disabled (e.g. by an active infringement claim on
+ *   the DIR).
+ * - `expired` - verification expired; re-add to renew.
+ * - `permanently_rejected` - terminal; cannot be re-added on this or any other DIR
+ *   you own.
+ */
+export type DirPhoneNumberStatus = 'submitted' | 'in_review' | 'verified' | 'unsuccessful' | 'suspended' | 'expired' | 'permanently_rejected';
+/**
+ * A phone-number batch groups all numbers added in a single bulk-add request.
+ * Telnyx vets the batch as a unit. The response embeds the full `phone_numbers`
+ * array so you can read per-number status without a separate call, plus a
+ * batch-level `status` summarising the unit's progress.
+ */
+export interface PhoneNumberBatch {
+    batch_id?: string;
+    /**
+     * The DIR's display name at the time the batch was read.
+     */
+    dir_display_name?: string;
+    dir_id?: string;
+    /**
+     * Documents attached to this batch (e.g. a Letter of Authorization). Empty when
+     * none were supplied at add time.
+     */
+    documents?: Array<DirAPI.Document>;
+    enterprise_id?: string;
+    /**
+     * All phone numbers in this batch, with per-number status.
+     */
+    phone_numbers?: Array<PhoneNumbersAPI.DirPhoneNumber>;
+    /**
+     * Aggregate batch status. Mirrors the values used on individual phone numbers
+     * (`submitted`, `in_review`, `verified`, `unsuccessful`, `permanently_rejected`,
+     * etc.).
+     */
+    status?: DirPhoneNumberStatus;
+    /**
+     * When the batch was created (and implicitly submitted for vetting).
+     */
+    submitted_at?: string;
+    /**
+     * Number of phone numbers in this batch (length of `phone_numbers`).
+     */
+    total_count?: number;
+}
+export interface PhoneNumberBatchRetrieveResponse {
+    /**
+     * A phone-number batch groups all numbers added in a single bulk-add request.
+     * Telnyx vets the batch as a unit. The response embeds the full `phone_numbers`
+     * array so you can read per-number status without a separate call, plus a
+     * batch-level `status` summarising the unit's progress.
+     */
+    data: PhoneNumberBatch;
+}
+export interface PhoneNumberBatchRetrieveParams {
+    /**
+     * The DIR id. Lowercase UUID.
+     */
+    dir_id: string;
+}
+export interface PhoneNumberBatchListParams extends DefaultFlatPaginationParams {
+    /**
+     * Restrict to batches whose aggregate status equals this value.
+     */
+    'filter[status]'?: DirPhoneNumberStatus;
+}
+export declare namespace PhoneNumberBatches {
+    export { type DirPhoneNumberStatus as DirPhoneNumberStatus, type PhoneNumberBatch as PhoneNumberBatch, type PhoneNumberBatchRetrieveResponse as PhoneNumberBatchRetrieveResponse, type PhoneNumberBatchesDefaultFlatPagination as PhoneNumberBatchesDefaultFlatPagination, type PhoneNumberBatchRetrieveParams as PhoneNumberBatchRetrieveParams, type PhoneNumberBatchListParams as PhoneNumberBatchListParams, };
+}
+//# sourceMappingURL=phone-number-batches.d.ts.map

package/resources/dir/phone-number-batches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-number-batches.d.ts","sourceRoot":"","sources":["../../src/resources/dir/phone-number-batches.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,iBAAc;AAChC,OAAO,KAAK,eAAe,2BAAwB;AACnD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,iCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,8BAA8B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gCAAgC,CAAC;IAK/C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,gBAAgB,CAAC;CAO1E;AAED,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,oBAAoB,GAC5B,WAAW,GACX,WAAW,GACX,UAAU,GACV,cAAc,GACd,WAAW,GACX,SAAS,GACT,sBAAsB,CAAC;AAE3B;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAEnC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;IAEtD;;;;OAIG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;;;OAKG;IACH,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA2B,SAAQ,2BAA2B;IAC7E;;OAEG;IACH,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;CACzC;AAED,MAAM,CAAC,OAAO,WAAW,kBAAkB,CAAC;IAC1C,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,0BAA0B,IAAI,0BAA0B,GAC9D,CAAC;CACH"}

package/resources/dir/phone-number-batches.js

@@ -0,0 +1,48 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PhoneNumberBatches = void 0;
+const resource_1 = require("../../core/resource.js");
+const pagination_1 = require("../../core/pagination.js");
+const path_1 = require("../../internal/utils/path.js");
+/**
+ * Phone numbers are submitted to Telnyx for vetting in batches. Batches group all numbers added in a single request under the same Letter of Authorization.
+ */
+class PhoneNumberBatches extends resource_1.APIResource {
+    /**
+     * Get a single phone-number batch by id. The enterprise is resolved server-side
+     * from the DIR id.
+     *
+     * @example
+     * ```ts
+     * const phoneNumberBatch =
+     *   await client.dir.phoneNumberBatches.retrieve(
+     *     '0a4b1f5e-2f12-4c0c-9a98-9b3a7d8b8e62',
+     *     { dir_id: '16635d38-75a6-4481-82e8-69af60e05011' },
+     *   );
+     * ```
+     */
+    retrieve(batchID, params, options) {
+        const { dir_id } = params;
+        return this._client.get((0, path_1.path) `/dir/${dir_id}/phone_number_batches/${batchID}`, options);
+    }
+    /**
+     * List the phone-number batches submitted under a DIR. The enterprise is resolved
+     * server-side from the DIR id.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const phoneNumberBatch of client.dir.phoneNumberBatches.list(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(dirID, query = {}, options) {
+        return this._client.getAPIList((0, path_1.path) `/dir/${dirID}/phone_number_batches`, (pagination_1.DefaultFlatPagination), { query, ...options });
+    }
+}
+exports.PhoneNumberBatches = PhoneNumberBatches;
+//# sourceMappingURL=phone-number-batches.js.map

package/resources/dir/phone-number-batches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-number-batches.js","sourceRoot":"","sources":["../../src/resources/dir/phone-number-batches.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,yDAA6G;AAE7G,uDAAiD;AAEjD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,sBAAW;IACjD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,QAAQ,MAAM,yBAAyB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAa,EACb,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,QAAQ,KAAK,uBAAuB,EACxC,CAAA,kCAAuC,CAAA,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF;AAhDD,gDAgDC"}

package/resources/dir/phone-number-batches.mjs

@@ -0,0 +1,44 @@
+// 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";
+/**
+ * Phone numbers are submitted to Telnyx for vetting in batches. Batches group all numbers added in a single request under the same Letter of Authorization.
+ */
+export class PhoneNumberBatches extends APIResource {
+    /**
+     * Get a single phone-number batch by id. The enterprise is resolved server-side
+     * from the DIR id.
+     *
+     * @example
+     * ```ts
+     * const phoneNumberBatch =
+     *   await client.dir.phoneNumberBatches.retrieve(
+     *     '0a4b1f5e-2f12-4c0c-9a98-9b3a7d8b8e62',
+     *     { dir_id: '16635d38-75a6-4481-82e8-69af60e05011' },
+     *   );
+     * ```
+     */
+    retrieve(batchID, params, options) {
+        const { dir_id } = params;
+        return this._client.get(path `/dir/${dir_id}/phone_number_batches/${batchID}`, options);
+    }
+    /**
+     * List the phone-number batches submitted under a DIR. The enterprise is resolved
+     * server-side from the DIR id.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const phoneNumberBatch of client.dir.phoneNumberBatches.list(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(dirID, query = {}, options) {
+        return this._client.getAPIList(path `/dir/${dirID}/phone_number_batches`, (DefaultFlatPagination), { query, ...options });
+    }
+}
+//# sourceMappingURL=phone-number-batches.mjs.map

package/resources/dir/phone-number-batches.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-number-batches.mjs","sourceRoot":"","sources":["../../src/resources/dir/phone-number-batches.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,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;OAYG;IACH,QAAQ,CACN,OAAe,EACf,MAAsC,EACtC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,QAAQ,MAAM,yBAAyB,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACzF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAa,EACb,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,QAAQ,KAAK,uBAAuB,EACxC,CAAA,qBAAuC,CAAA,EACvC,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;CACF"}

package/resources/dir/phone-numbers.d.mts

@@ -0,0 +1,202 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as DirAPI from "./dir.mjs";
+import * as PhoneNumberBatchesAPI from "./phone-number-batches.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+/**
+ * Associate phone numbers with a verified DIR so calls from those numbers carry the DIR's display identity.
+ */
+export declare class PhoneNumbers extends APIResource {
+    /**
+     * List the phone numbers registered under a DIR. The enterprise is resolved
+     * server-side from the DIR id.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const dirPhoneNumber of client.dir.phoneNumbers.list(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(dirID: string, query?: PhoneNumberListParams | null | undefined, options?: RequestOptions): PagePromise<DirPhoneNumbersDefaultFlatPagination, DirPhoneNumber>;
+    /**
+     * Register phone numbers under a DIR. The enterprise is resolved server-side from
+     * the DIR id. Same body, failure modes, and batch semantics whichever path form
+     * you use.
+     *
+     * **Pricing:** This is a billable action. See https://telnyx.com/pricing/numbers
+     * for current pricing.
+     *
+     * @example
+     * ```ts
+     * const response = await client.dir.phoneNumbers.add(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     *   {
+     *     documents: [
+     *       {
+     *         document_id: '2a7e8337-e803-4057-a4ae-26c40eb0bc6c',
+     *         document_type: 'letter_of_authorization',
+     *         description:
+     *           'LOA authorising Telnyx to register these numbers under the DIR.',
+     *       },
+     *     ],
+     *     phone_numbers: ['+19493253498', '+12134445566'],
+     *   },
+     * );
+     * ```
+     */
+    add(dirID: string, body: PhoneNumberAddParams, options?: RequestOptions): APIPromise<PhoneNumberAddResponse>;
+    /**
+     * Deregister phone numbers from a DIR. The enterprise is resolved server-side from
+     * the DIR id. Returns a partial-success envelope.
+     *
+     * @example
+     * ```ts
+     * const phoneNumber = await client.dir.phoneNumbers.remove(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     *   { phone_numbers: ['+19493253498'] },
+     * );
+     * ```
+     */
+    remove(dirID: string, body: PhoneNumberRemoveParams, options?: RequestOptions): APIPromise<PhoneNumberRemoveResponse>;
+}
+export type DirPhoneNumbersDefaultFlatPagination = DefaultFlatPagination<DirPhoneNumber>;
+export interface DirPhoneNumber {
+    id?: string;
+    /**
+     * Id of the batch this number was vetted as part of.
+     */
+    batch_id?: string | null;
+    created_at?: string;
+    dir_id?: string;
+    enterprise_id?: string;
+    /**
+     * Id of the Letter of Authorization document attached to this number's batch.
+     */
+    loa_document_id?: string | null;
+    /**
+     * E.164 with leading `+`.
+     */
+    phone_number?: string;
+    /**
+     * Populated when `status` is `unsuccessful` or `permanently_rejected`.
+     */
+    rejection_reason?: RejectionReason | null;
+    /**
+     * Phone-number lifecycle status.
+     *
+     * - `submitted` / `in_review` - Telnyx is reviewing the batch this number belongs
+     *   to.
+     * - `verified` - approved; the DIR's display identity will be shown on outbound
+     *   calls from this number.
+     * - `unsuccessful` - Telnyx rejected this submission; the customer may re-add to
+     *   retry.
+     * - `suspended` - temporarily disabled (e.g. by an active infringement claim on
+     *   the DIR).
+     * - `expired` - verification expired; re-add to renew.
+     * - `permanently_rejected` - terminal; cannot be re-added on this or any other DIR
+     *   you own.
+     */
+    status?: PhoneNumberBatchesAPI.DirPhoneNumberStatus;
+    updated_at?: string;
+    verified_at?: string | null;
+}
+export interface RejectionReason {
+    code?: string;
+    detail?: string;
+    /**
+     * Customer-visible free-text comment from the Telnyx vetting team. Only the first
+     * entry of `rejection_reasons` carries this; the rest are `null`.
+     */
+    message?: string | null;
+    title?: string;
+}
+/**
+ * Bulk-add success response (HTTP 201). All numbers in the request were accepted
+ * into a single new batch. Every entry in `data` shares the same `batch_id` - read
+ * it from any element to obtain the batch id for subsequent
+ * `GET .../phone_number_batches/{batch_id}` calls. If any number in the request
+ * fails (schema-invalid, not in inventory, already attached to another DIR, etc.)
+ * the entire request is rejected with HTTP 400 and the canonical Telnyx error
+ * envelope; the success body described here is therefore an all-or-nothing
+ * payload.
+ */
+export interface PhoneNumberAddResponse {
+    /**
+     * Phone numbers accepted into the new batch. List order mirrors the request order.
+     * Each element shares the same `batch_id`.
+     */
+    data: Array<DirPhoneNumber>;
+}
+/**
+ * Bulk-delete partial-success response. `data` is the list of phone numbers that
+ * were soft-deleted. `meta.errors` holds per-number failures (e.g. number not
+ * associated with this DIR). When EVERY number in the request fails, the endpoint
+ * instead returns 400 with the canonical Telnyx error envelope and `data`/`meta`
+ * are absent.
+ */
+export interface PhoneNumberRemoveResponse {
+    /**
+     * Phone numbers that were successfully soft-deleted. Bare E.164 strings.
+     */
+    data: Array<string>;
+    meta: PhoneNumberRemoveResponse.Meta;
+}
+export declare namespace PhoneNumberRemoveResponse {
+    interface Meta {
+        /**
+         * Per-number failures that did not block the call. Each entry has `phone_number`,
+         * `code`, `title`, `detail`.
+         */
+        errors: Array<Meta.Error>;
+    }
+    namespace Meta {
+        /**
+         * Per-number error returned by the bulk-delete endpoint. Bulk-add does not use
+         * this shape - it returns a 400 with the canonical envelope grouping numbers by
+         * failure category.
+         */
+        interface Error {
+            /**
+             * Stable per-number error code. Currently only `not_associated` is emitted, when
+             * the number is not attached to this DIR.
+             */
+            code: 'not_associated';
+            detail: string;
+            phone_number: string;
+            title: string;
+        }
+    }
+}
+export interface PhoneNumberListParams extends DefaultFlatPaginationParams {
+    /**
+     * Filter by phone-number status.
+     */
+    status?: PhoneNumberBatchesAPI.DirPhoneNumberStatus;
+}
+export interface PhoneNumberAddParams {
+    /**
+     * Supporting documents covering this batch. At least one entry with
+     * `document_type: letter_of_authorization` is required - the LOA authorises Telnyx
+     * to register these numbers under the DIR. Each `document_id` must come from the
+     * Telnyx Documents API. Additional document types (e.g. business registration) may
+     * be included alongside the LOA.
+     */
+    documents: Array<DirAPI.Document>;
+    /**
+     * 1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with
+     * `1`.
+     */
+    phone_numbers: Array<string>;
+}
+export interface PhoneNumberRemoveParams {
+    phone_numbers: Array<string>;
+}
+export declare namespace PhoneNumbers {
+    export { type DirPhoneNumber as DirPhoneNumber, type RejectionReason as RejectionReason, type PhoneNumberAddResponse as PhoneNumberAddResponse, type PhoneNumberRemoveResponse as PhoneNumberRemoveResponse, type DirPhoneNumbersDefaultFlatPagination as DirPhoneNumbersDefaultFlatPagination, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberAddParams as PhoneNumberAddParams, type PhoneNumberRemoveParams as PhoneNumberRemoveParams, };
+}
+//# sourceMappingURL=phone-numbers.d.mts.map

package/resources/dir/phone-numbers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-numbers.d.mts","sourceRoot":"","sources":["../../src/resources/dir/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,kBAAc;AAChC,OAAO,KAAK,qBAAqB,mCAA+B;AAChE,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,kCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,cAAc,CAAC;IAOpE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,MAAM,oCAAoC,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;AAEzF,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAE1C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;IAEpD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;;WAGG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;;;WAIG;QACH,UAAiB,KAAK;YACpB;;;eAGG;YACH,IAAI,EAAE,gBAAgB,CAAC;YAEvB,MAAM,EAAE,MAAM,CAAC;YAEf,YAAY,EAAE,MAAM,CAAC;YAErB,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;IACxE;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;CACrD;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAElC;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/dir/phone-numbers.d.ts

@@ -0,0 +1,202 @@
+import { APIResource } from "../../core/resource.js";
+import * as DirAPI from "./dir.js";
+import * as PhoneNumberBatchesAPI from "./phone-number-batches.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../core/pagination.js";
+import { RequestOptions } from "../../internal/request-options.js";
+/**
+ * Associate phone numbers with a verified DIR so calls from those numbers carry the DIR's display identity.
+ */
+export declare class PhoneNumbers extends APIResource {
+    /**
+     * List the phone numbers registered under a DIR. The enterprise is resolved
+     * server-side from the DIR id.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const dirPhoneNumber of client.dir.phoneNumbers.list(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(dirID: string, query?: PhoneNumberListParams | null | undefined, options?: RequestOptions): PagePromise<DirPhoneNumbersDefaultFlatPagination, DirPhoneNumber>;
+    /**
+     * Register phone numbers under a DIR. The enterprise is resolved server-side from
+     * the DIR id. Same body, failure modes, and batch semantics whichever path form
+     * you use.
+     *
+     * **Pricing:** This is a billable action. See https://telnyx.com/pricing/numbers
+     * for current pricing.
+     *
+     * @example
+     * ```ts
+     * const response = await client.dir.phoneNumbers.add(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     *   {
+     *     documents: [
+     *       {
+     *         document_id: '2a7e8337-e803-4057-a4ae-26c40eb0bc6c',
+     *         document_type: 'letter_of_authorization',
+     *         description:
+     *           'LOA authorising Telnyx to register these numbers under the DIR.',
+     *       },
+     *     ],
+     *     phone_numbers: ['+19493253498', '+12134445566'],
+     *   },
+     * );
+     * ```
+     */
+    add(dirID: string, body: PhoneNumberAddParams, options?: RequestOptions): APIPromise<PhoneNumberAddResponse>;
+    /**
+     * Deregister phone numbers from a DIR. The enterprise is resolved server-side from
+     * the DIR id. Returns a partial-success envelope.
+     *
+     * @example
+     * ```ts
+     * const phoneNumber = await client.dir.phoneNumbers.remove(
+     *   '16635d38-75a6-4481-82e8-69af60e05011',
+     *   { phone_numbers: ['+19493253498'] },
+     * );
+     * ```
+     */
+    remove(dirID: string, body: PhoneNumberRemoveParams, options?: RequestOptions): APIPromise<PhoneNumberRemoveResponse>;
+}
+export type DirPhoneNumbersDefaultFlatPagination = DefaultFlatPagination<DirPhoneNumber>;
+export interface DirPhoneNumber {
+    id?: string;
+    /**
+     * Id of the batch this number was vetted as part of.
+     */
+    batch_id?: string | null;
+    created_at?: string;
+    dir_id?: string;
+    enterprise_id?: string;
+    /**
+     * Id of the Letter of Authorization document attached to this number's batch.
+     */
+    loa_document_id?: string | null;
+    /**
+     * E.164 with leading `+`.
+     */
+    phone_number?: string;
+    /**
+     * Populated when `status` is `unsuccessful` or `permanently_rejected`.
+     */
+    rejection_reason?: RejectionReason | null;
+    /**
+     * Phone-number lifecycle status.
+     *
+     * - `submitted` / `in_review` - Telnyx is reviewing the batch this number belongs
+     *   to.
+     * - `verified` - approved; the DIR's display identity will be shown on outbound
+     *   calls from this number.
+     * - `unsuccessful` - Telnyx rejected this submission; the customer may re-add to
+     *   retry.
+     * - `suspended` - temporarily disabled (e.g. by an active infringement claim on
+     *   the DIR).
+     * - `expired` - verification expired; re-add to renew.
+     * - `permanently_rejected` - terminal; cannot be re-added on this or any other DIR
+     *   you own.
+     */
+    status?: PhoneNumberBatchesAPI.DirPhoneNumberStatus;
+    updated_at?: string;
+    verified_at?: string | null;
+}
+export interface RejectionReason {
+    code?: string;
+    detail?: string;
+    /**
+     * Customer-visible free-text comment from the Telnyx vetting team. Only the first
+     * entry of `rejection_reasons` carries this; the rest are `null`.
+     */
+    message?: string | null;
+    title?: string;
+}
+/**
+ * Bulk-add success response (HTTP 201). All numbers in the request were accepted
+ * into a single new batch. Every entry in `data` shares the same `batch_id` - read
+ * it from any element to obtain the batch id for subsequent
+ * `GET .../phone_number_batches/{batch_id}` calls. If any number in the request
+ * fails (schema-invalid, not in inventory, already attached to another DIR, etc.)
+ * the entire request is rejected with HTTP 400 and the canonical Telnyx error
+ * envelope; the success body described here is therefore an all-or-nothing
+ * payload.
+ */
+export interface PhoneNumberAddResponse {
+    /**
+     * Phone numbers accepted into the new batch. List order mirrors the request order.
+     * Each element shares the same `batch_id`.
+     */
+    data: Array<DirPhoneNumber>;
+}
+/**
+ * Bulk-delete partial-success response. `data` is the list of phone numbers that
+ * were soft-deleted. `meta.errors` holds per-number failures (e.g. number not
+ * associated with this DIR). When EVERY number in the request fails, the endpoint
+ * instead returns 400 with the canonical Telnyx error envelope and `data`/`meta`
+ * are absent.
+ */
+export interface PhoneNumberRemoveResponse {
+    /**
+     * Phone numbers that were successfully soft-deleted. Bare E.164 strings.
+     */
+    data: Array<string>;
+    meta: PhoneNumberRemoveResponse.Meta;
+}
+export declare namespace PhoneNumberRemoveResponse {
+    interface Meta {
+        /**
+         * Per-number failures that did not block the call. Each entry has `phone_number`,
+         * `code`, `title`, `detail`.
+         */
+        errors: Array<Meta.Error>;
+    }
+    namespace Meta {
+        /**
+         * Per-number error returned by the bulk-delete endpoint. Bulk-add does not use
+         * this shape - it returns a 400 with the canonical envelope grouping numbers by
+         * failure category.
+         */
+        interface Error {
+            /**
+             * Stable per-number error code. Currently only `not_associated` is emitted, when
+             * the number is not attached to this DIR.
+             */
+            code: 'not_associated';
+            detail: string;
+            phone_number: string;
+            title: string;
+        }
+    }
+}
+export interface PhoneNumberListParams extends DefaultFlatPaginationParams {
+    /**
+     * Filter by phone-number status.
+     */
+    status?: PhoneNumberBatchesAPI.DirPhoneNumberStatus;
+}
+export interface PhoneNumberAddParams {
+    /**
+     * Supporting documents covering this batch. At least one entry with
+     * `document_type: letter_of_authorization` is required - the LOA authorises Telnyx
+     * to register these numbers under the DIR. Each `document_id` must come from the
+     * Telnyx Documents API. Additional document types (e.g. business registration) may
+     * be included alongside the LOA.
+     */
+    documents: Array<DirAPI.Document>;
+    /**
+     * 1–15 phone numbers in E.164 format. 10-digit US numbers are auto-prefixed with
+     * `1`.
+     */
+    phone_numbers: Array<string>;
+}
+export interface PhoneNumberRemoveParams {
+    phone_numbers: Array<string>;
+}
+export declare namespace PhoneNumbers {
+    export { type DirPhoneNumber as DirPhoneNumber, type RejectionReason as RejectionReason, type PhoneNumberAddResponse as PhoneNumberAddResponse, type PhoneNumberRemoveResponse as PhoneNumberRemoveResponse, type DirPhoneNumbersDefaultFlatPagination as DirPhoneNumbersDefaultFlatPagination, type PhoneNumberListParams as PhoneNumberListParams, type PhoneNumberAddParams as PhoneNumberAddParams, type PhoneNumberRemoveParams as PhoneNumberRemoveParams, };
+}
+//# sourceMappingURL=phone-numbers.d.ts.map

package/resources/dir/phone-numbers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"phone-numbers.d.ts","sourceRoot":"","sources":["../../src/resources/dir/phone-numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,iBAAc;AAChC,OAAO,KAAK,qBAAqB,kCAA+B;AAChE,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,qBAAqB,EAAE,KAAK,2BAA2B,EAAE,WAAW,EAAE,iCAA8B;AAC7G,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,KAAK,EAAE,MAAM,EACb,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oCAAoC,EAAE,cAAc,CAAC;IAOpE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,GAAG,CACD,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED,MAAM,MAAM,oCAAoC,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;AAEzF,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAE1C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;IAEpD,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,IAAI;QACnB;;;WAGG;QACH,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAC3B;IAED,UAAiB,IAAI,CAAC;QACpB;;;;WAIG;QACH,UAAiB,KAAK;YACpB;;;eAGG;YACH,IAAI,EAAE,gBAAgB,CAAC;YAEvB,MAAM,EAAE,MAAM,CAAC;YAEf,YAAY,EAAE,MAAM,CAAC;YAErB,KAAK,EAAE,MAAM,CAAC;SACf;KACF;CACF;AAED,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;IACxE;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAC,oBAAoB,CAAC;CACrD;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;;OAMG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAElC;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,uBAAuB;IACtC,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}