telnyx 6.74.2 → 7.1.0

package/resources/enterprises/reputation/numbers.d.mts

@@ -1,168 +1,207 @@
 import { APIResource } from "../../../core/resource.mjs";
 import * as Shared from "../../shared.mjs";
-import { ReputationPhoneNumberWithReputationDataDefaultFlatPagination } from "../../shared.mjs";
+import * as EnterprisesAPI from "../enterprises.mjs";
 import { APIPromise } from "../../../core/api-promise.mjs";
-import { type DefaultFlatPaginationParams, PagePromise } from "../../../core/pagination.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../../core/pagination.mjs";
 import { RequestOptions } from "../../../internal/request-options.mjs";
 /**
- * Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
+ * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 export declare class Numbers extends APIResource {
     /**
-     * Get detailed reputation data for a specific phone number associated with an
-     * enterprise.
-     *
-     * **Query Parameters:**
-     *
-     * - `fresh` (default: `false`): When `true`, fetches fresh reputation data (incurs
-     *   API cost). When `false`, returns cached data. If no cached data exists, fresh
-     *   data is automatically fetched.
-     *
-     * **Returns:**
-     *
-     * - `spam_risk`: Overall spam risk level (`low`, `medium`, `high`)
-     * - `spam_category`: Spam category classification
-     * - `maturity_score`: Maturity metric (0–100)
-     * - `connection_score`: Connection quality metric (0–100)
-     * - `engagement_score`: Engagement metric (0–100)
-     * - `sentiment_score`: Sentiment metric (0–100)
-     * - `last_refreshed_at`: Timestamp of last data refresh
+     * Retrieve one registered number with its latest reputation snapshot. The
+     * `phone_number` path parameter is in E.164 format and must be URL-encoded (e.g.
+     * `%2B19493253498`).
      *
      * @example
      * ```ts
-     * const number =
+     * const reputationPhoneNumberWithReputation =
      *   await client.enterprises.reputation.numbers.retrieve(
-     *     '+16035551234',
+     *     '+19493253498',
      *     {
-     *       enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+     *       enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
      *     },
      *   );
      * ```
      */
-    retrieve(phoneNumber: string, params: NumberRetrieveParams, options?: RequestOptions): APIPromise<NumberRetrieveResponse>;
+    retrieve(phoneNumber: string, params: NumberRetrieveParams, options?: RequestOptions): APIPromise<ReputationPhoneNumberWithReputation>;
     /**
-     * List all phone numbers associated with an enterprise for Number Reputation
-     * monitoring.
-     *
-     * Returns phone numbers with their cached reputation data (if available). Supports
-     * pagination and filtering by phone number.
+     * Paginated list of phone numbers registered for reputation monitoring under this
+     * enterprise. The response includes the latest reputation snapshot per number
+     * where one has been collected.
      *
      * @example
      * ```ts
      * // Automatically fetches more pages as needed.
-     * for await (const reputationPhoneNumberWithReputationData of client.enterprises.reputation.numbers.list(
-     *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+     * for await (const reputationPhoneNumber of client.enterprises.reputation.numbers.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
      * )) {
      *   // ...
      * }
      * ```
      */
-    list(enterpriseID: string, query?: NumberListParams | null | undefined, options?: RequestOptions): PagePromise<ReputationPhoneNumberWithReputationDataDefaultFlatPagination, Shared.ReputationPhoneNumberWithReputationData>;
+    list(enterpriseID: string, query?: NumberListParams | null | undefined, options?: RequestOptions): PagePromise<ReputationPhoneNumbersDefaultFlatPagination, ReputationPhoneNumber>;
     /**
-     * Associate one or more phone numbers with an enterprise for Number Reputation
-     * monitoring.
-     *
-     * **Validations:**
+     * Add up to 100 phone numbers to reputation monitoring on this enterprise. Each
+     * must be in E.164 format (`+1NPANXXXXXX` for US/CA) and belong to your Telnyx
+     * phone-number inventory.
      *
-     * - Phone numbers must be in E.164 format (e.g., `+16035551234`)
-     * - Phone numbers must be in-service and belong to your account (verified via
-     *   Warehouse)
-     * - Phone numbers must be US local numbers
-     * - Phone numbers cannot already be associated with any enterprise
+     * **Prerequisite**: reputation must already be enabled on this enterprise (see
+     * `POST .../reputation`).
      *
-     * **Note:** This operation is atomic — if any number fails validation, the entire
-     * request fails.
-     *
-     * **Maximum:** 100 phone numbers per request.
+     * **Pricing:** This is a billable action. See https://telnyx.com/pricing/numbers
+     * for current pricing.
      *
      * @example
      * ```ts
-     * const response =
+     * const reputationPhoneNumberList =
      *   await client.enterprises.reputation.numbers.associate(
-     *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-     *     { phone_numbers: ['+16035551234'] },
+     *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *     { phone_numbers: ['+19493253498', '+12134445566'] },
      *   );
      * ```
      */
-    associate(enterpriseID: string, body: NumberAssociateParams, options?: RequestOptions): APIPromise<NumberAssociateResponse>;
+    associate(enterpriseID: string, body: NumberAssociateParams, options?: RequestOptions): APIPromise<ReputationPhoneNumberList>;
     /**
-     * Remove a phone number from Number Reputation monitoring for an enterprise.
-     *
-     * The number will no longer be tracked and reputation data will no longer be
-     * refreshed.
+     * Stop tracking the reputation of this phone number. The number itself remains in
+     * your inventory; only the reputation registration is removed.
      *
      * @example
      * ```ts
      * await client.enterprises.reputation.numbers.disassociate(
-     *   '+16035551234',
-     *   { enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
+     *   '+19493253498',
+     *   { enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6' },
      * );
      * ```
      */
     disassociate(phoneNumber: string, params: NumberDisassociateParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Immediately refresh the stored reputation data for the listed numbers. This is
+     * in addition to the periodic refresh determined by `check_frequency`. Up to 100
+     * numbers per call. The response carries the kicked-off jobs; the actual refresh
+     * runs asynchronously.
+     *
+     * **Pricing:** Forcing a refresh performs live reputation lookups, which are
+     * billable. See https://telnyx.com/pricing/numbers for current pricing.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.enterprises.reputation.numbers.refresh(
+     *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *     { phone_numbers: ['+19493253498'] },
+     *   );
+     * ```
+     */
+    refresh(enterpriseID: string, body: NumberRefreshParams, options?: RequestOptions): APIPromise<NumberRefreshResponse>;
+}
+export type ReputationPhoneNumbersDefaultFlatPagination = DefaultFlatPagination<ReputationPhoneNumber>;
+export interface ReputationPhoneNumber {
+    id?: string;
+    created_at?: string;
+    enterprise_id?: string;
+    /**
+     * E.164 with leading `+`.
+     */
+    phone_number?: string;
+    /**
+     * `null` until the first refresh has been collected for this number.
+     */
+    reputation_data?: Shared.ReputationData | null;
+    updated_at?: string;
 }
-export interface NumberRetrieveResponse {
-    data?: Shared.ReputationPhoneNumberWithReputationData;
+export interface ReputationPhoneNumberList {
+    data: Array<ReputationPhoneNumber>;
+    /**
+     * JSON:API pagination metadata returned with every paginated list response. Page
+     * numbering is 1-based. `page_size` reports the number of items actually returned
+     * in `data` for this page; the requested size is taken from the `page[size]` query
+     * parameter.
+     */
+    meta: EnterprisesAPI.NumberReputationPaginationMeta;
+}
+/**
+ * List of reputation-monitored phone numbers, each carrying its current reputation
+ * data.
+ */
+export interface ReputationPhoneNumberListWithReputation {
+    data: Array<ReputationPhoneNumber>;
+    /**
+     * JSON:API pagination metadata returned with every paginated list response. Page
+     * numbering is 1-based. `page_size` reports the number of items actually returned
+     * in `data` for this page; the requested size is taken from the `page[size]` query
+     * parameter.
+     */
+    meta: EnterprisesAPI.NumberReputationPaginationMeta;
+}
+export interface ReputationPhoneNumberWithReputation {
+    data: ReputationPhoneNumber;
 }
-export interface NumberAssociateResponse {
-    data?: Array<NumberAssociateResponse.Data>;
-    meta?: Shared.MetaInfo;
+export interface NumberRefreshResponse {
+    data: NumberRefreshResponse.Data;
 }
-export declare namespace NumberAssociateResponse {
+export declare namespace NumberRefreshResponse {
     interface Data {
         /**
-         * Unique identifier
-         */
-        id?: string;
-        /**
-         * When the number was associated
-         */
-        created_at?: string;
-        /**
-         * ID of the associated enterprise
+         * Per-number outcome of the refresh.
          */
-        enterprise_id?: string;
-        /**
-         * Phone number in E.164 format
-         */
-        phone_number?: string;
-        /**
-         * When the record was last updated
-         */
-        updated_at?: string;
+        results: Array<Data.Result>;
+        total_failed: number;
+        total_requested: number;
+        total_successful: number;
+    }
+    namespace Data {
+        interface Result {
+            phone_number: string;
+            success: boolean;
+            /**
+             * `null` when `success` is `true`; carries an error message otherwise.
+             */
+            error?: string | null;
+        }
     }
 }
 export interface NumberRetrieveParams {
     /**
-     * Path param: Unique identifier of the enterprise (UUID)
+     * Path param: The enterprise id. Lowercase UUID.
      */
     enterprise_id: string;
     /**
      * Query param: When true, fetches fresh reputation data (incurs API cost). When
-     * false, returns cached data.
+     * false (default), returns cached data.
      */
     fresh?: boolean;
 }
 export interface NumberListParams extends DefaultFlatPaginationParams {
     /**
-     * Filter by specific phone number (E.164 format)
+     * Partial match on phone number. Must contain at least 5 digits.
      */
-    phone_number?: string;
+    'filter[phone_number][contains]'?: string;
+    /**
+     * Exact phone-number match (E.164).
+     */
+    'filter[phone_number][eq]'?: string;
 }
 export interface NumberAssociateParams {
     /**
-     * List of phone numbers to associate for reputation monitoring (max 100)
+     * 1–100 phone numbers in E.164 format with a leading `+`.
      */
     phone_numbers: Array<string>;
 }
 export interface NumberDisassociateParams {
     /**
-     * Unique identifier of the enterprise (UUID)
+     * The enterprise id. Lowercase UUID.
      */
     enterprise_id: string;
 }
+export interface NumberRefreshParams {
+    /**
+     * Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
+     * E.164 format. Reputation refreshes are subject to per-enterprise rate limits.
+     */
+    phone_numbers: Array<string>;
+}
 export declare namespace Numbers {
-    export { type NumberRetrieveResponse as NumberRetrieveResponse, type NumberAssociateResponse as NumberAssociateResponse, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, };
+    export { type ReputationPhoneNumber as ReputationPhoneNumber, type ReputationPhoneNumberList as ReputationPhoneNumberList, type ReputationPhoneNumberListWithReputation as ReputationPhoneNumberListWithReputation, type ReputationPhoneNumberWithReputation as ReputationPhoneNumberWithReputation, type NumberRefreshResponse as NumberRefreshResponse, type ReputationPhoneNumbersDefaultFlatPagination as ReputationPhoneNumbersDefaultFlatPagination, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, type NumberRefreshParams as NumberRefreshParams, };
 }
-export { type ReputationPhoneNumberWithReputationDataDefaultFlatPagination };
 //# sourceMappingURL=numbers.d.mts.map

package/resources/enterprises/reputation/numbers.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"numbers.d.mts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,EAAE,4DAA4D,EAAE,yBAAqB;AAC5F,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EAEL,KAAK,2BAA2B,EAChC,WAAW,EACZ,qCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAQrC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,4DAA4D,EAC5D,MAAM,CAAC,uCAAuC,CAC/C;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,uCAAuC,CAAC;CACvD;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B;IACnE;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,4DAA4D,EAAE,CAAC"}
+{"version":3,"file":"numbers.d.mts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,MAAM,yBAAqB;AACvC,OAAO,KAAK,cAAc,2BAAuB;AACjD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,EAChC,WAAW,EACZ,qCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAQlD;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2CAA2C,EAAE,qBAAqB,CAAC;IAQlF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACP,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,YAAY,CACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAMrC;AAED,MAAM,MAAM,2CAA2C,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;AAEvG,MAAM,WAAW,qBAAqB;IACpC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,IAAI,EAAE,cAAc,CAAC,8BAA8B,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IACtD,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,IAAI,EAAE,cAAc,CAAC,8BAA8B,CAAC;CACrD;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,YAAY,EAAE,MAAM,CAAC;QAErB,eAAe,EAAE,MAAM,CAAC;QAExB,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,YAAY,EAAE,MAAM,CAAC;YAErB,OAAO,EAAE,OAAO,CAAC;YAEjB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B;IACnE;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/enterprises/reputation/numbers.d.ts

@@ -1,168 +1,207 @@
 import { APIResource } from "../../../core/resource.js";
 import * as Shared from "../../shared.js";
-import { ReputationPhoneNumberWithReputationDataDefaultFlatPagination } from "../../shared.js";
+import * as EnterprisesAPI from "../enterprises.js";
 import { APIPromise } from "../../../core/api-promise.js";
-import { type DefaultFlatPaginationParams, PagePromise } from "../../../core/pagination.js";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../../core/pagination.js";
 import { RequestOptions } from "../../../internal/request-options.js";
 /**
- * Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
+ * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 export declare class Numbers extends APIResource {
     /**
-     * Get detailed reputation data for a specific phone number associated with an
-     * enterprise.
-     *
-     * **Query Parameters:**
-     *
-     * - `fresh` (default: `false`): When `true`, fetches fresh reputation data (incurs
-     *   API cost). When `false`, returns cached data. If no cached data exists, fresh
-     *   data is automatically fetched.
-     *
-     * **Returns:**
-     *
-     * - `spam_risk`: Overall spam risk level (`low`, `medium`, `high`)
-     * - `spam_category`: Spam category classification
-     * - `maturity_score`: Maturity metric (0–100)
-     * - `connection_score`: Connection quality metric (0–100)
-     * - `engagement_score`: Engagement metric (0–100)
-     * - `sentiment_score`: Sentiment metric (0–100)
-     * - `last_refreshed_at`: Timestamp of last data refresh
+     * Retrieve one registered number with its latest reputation snapshot. The
+     * `phone_number` path parameter is in E.164 format and must be URL-encoded (e.g.
+     * `%2B19493253498`).
      *
      * @example
      * ```ts
-     * const number =
+     * const reputationPhoneNumberWithReputation =
      *   await client.enterprises.reputation.numbers.retrieve(
-     *     '+16035551234',
+     *     '+19493253498',
      *     {
-     *       enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+     *       enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
      *     },
      *   );
      * ```
      */
-    retrieve(phoneNumber: string, params: NumberRetrieveParams, options?: RequestOptions): APIPromise<NumberRetrieveResponse>;
+    retrieve(phoneNumber: string, params: NumberRetrieveParams, options?: RequestOptions): APIPromise<ReputationPhoneNumberWithReputation>;
     /**
-     * List all phone numbers associated with an enterprise for Number Reputation
-     * monitoring.
-     *
-     * Returns phone numbers with their cached reputation data (if available). Supports
-     * pagination and filtering by phone number.
+     * Paginated list of phone numbers registered for reputation monitoring under this
+     * enterprise. The response includes the latest reputation snapshot per number
+     * where one has been collected.
      *
      * @example
      * ```ts
      * // Automatically fetches more pages as needed.
-     * for await (const reputationPhoneNumberWithReputationData of client.enterprises.reputation.numbers.list(
-     *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+     * for await (const reputationPhoneNumber of client.enterprises.reputation.numbers.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
      * )) {
      *   // ...
      * }
      * ```
      */
-    list(enterpriseID: string, query?: NumberListParams | null | undefined, options?: RequestOptions): PagePromise<ReputationPhoneNumberWithReputationDataDefaultFlatPagination, Shared.ReputationPhoneNumberWithReputationData>;
+    list(enterpriseID: string, query?: NumberListParams | null | undefined, options?: RequestOptions): PagePromise<ReputationPhoneNumbersDefaultFlatPagination, ReputationPhoneNumber>;
     /**
-     * Associate one or more phone numbers with an enterprise for Number Reputation
-     * monitoring.
-     *
-     * **Validations:**
+     * Add up to 100 phone numbers to reputation monitoring on this enterprise. Each
+     * must be in E.164 format (`+1NPANXXXXXX` for US/CA) and belong to your Telnyx
+     * phone-number inventory.
      *
-     * - Phone numbers must be in E.164 format (e.g., `+16035551234`)
-     * - Phone numbers must be in-service and belong to your account (verified via
-     *   Warehouse)
-     * - Phone numbers must be US local numbers
-     * - Phone numbers cannot already be associated with any enterprise
+     * **Prerequisite**: reputation must already be enabled on this enterprise (see
+     * `POST .../reputation`).
      *
-     * **Note:** This operation is atomic — if any number fails validation, the entire
-     * request fails.
-     *
-     * **Maximum:** 100 phone numbers per request.
+     * **Pricing:** This is a billable action. See https://telnyx.com/pricing/numbers
+     * for current pricing.
      *
      * @example
      * ```ts
-     * const response =
+     * const reputationPhoneNumberList =
      *   await client.enterprises.reputation.numbers.associate(
-     *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-     *     { phone_numbers: ['+16035551234'] },
+     *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *     { phone_numbers: ['+19493253498', '+12134445566'] },
      *   );
      * ```
      */
-    associate(enterpriseID: string, body: NumberAssociateParams, options?: RequestOptions): APIPromise<NumberAssociateResponse>;
+    associate(enterpriseID: string, body: NumberAssociateParams, options?: RequestOptions): APIPromise<ReputationPhoneNumberList>;
     /**
-     * Remove a phone number from Number Reputation monitoring for an enterprise.
-     *
-     * The number will no longer be tracked and reputation data will no longer be
-     * refreshed.
+     * Stop tracking the reputation of this phone number. The number itself remains in
+     * your inventory; only the reputation registration is removed.
      *
      * @example
      * ```ts
      * await client.enterprises.reputation.numbers.disassociate(
-     *   '+16035551234',
-     *   { enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58' },
+     *   '+19493253498',
+     *   { enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6' },
      * );
      * ```
      */
     disassociate(phoneNumber: string, params: NumberDisassociateParams, options?: RequestOptions): APIPromise<void>;
+    /**
+     * Immediately refresh the stored reputation data for the listed numbers. This is
+     * in addition to the periodic refresh determined by `check_frequency`. Up to 100
+     * numbers per call. The response carries the kicked-off jobs; the actual refresh
+     * runs asynchronously.
+     *
+     * **Pricing:** Forcing a refresh performs live reputation lookups, which are
+     * billable. See https://telnyx.com/pricing/numbers for current pricing.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.enterprises.reputation.numbers.refresh(
+     *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *     { phone_numbers: ['+19493253498'] },
+     *   );
+     * ```
+     */
+    refresh(enterpriseID: string, body: NumberRefreshParams, options?: RequestOptions): APIPromise<NumberRefreshResponse>;
+}
+export type ReputationPhoneNumbersDefaultFlatPagination = DefaultFlatPagination<ReputationPhoneNumber>;
+export interface ReputationPhoneNumber {
+    id?: string;
+    created_at?: string;
+    enterprise_id?: string;
+    /**
+     * E.164 with leading `+`.
+     */
+    phone_number?: string;
+    /**
+     * `null` until the first refresh has been collected for this number.
+     */
+    reputation_data?: Shared.ReputationData | null;
+    updated_at?: string;
 }
-export interface NumberRetrieveResponse {
-    data?: Shared.ReputationPhoneNumberWithReputationData;
+export interface ReputationPhoneNumberList {
+    data: Array<ReputationPhoneNumber>;
+    /**
+     * JSON:API pagination metadata returned with every paginated list response. Page
+     * numbering is 1-based. `page_size` reports the number of items actually returned
+     * in `data` for this page; the requested size is taken from the `page[size]` query
+     * parameter.
+     */
+    meta: EnterprisesAPI.NumberReputationPaginationMeta;
+}
+/**
+ * List of reputation-monitored phone numbers, each carrying its current reputation
+ * data.
+ */
+export interface ReputationPhoneNumberListWithReputation {
+    data: Array<ReputationPhoneNumber>;
+    /**
+     * JSON:API pagination metadata returned with every paginated list response. Page
+     * numbering is 1-based. `page_size` reports the number of items actually returned
+     * in `data` for this page; the requested size is taken from the `page[size]` query
+     * parameter.
+     */
+    meta: EnterprisesAPI.NumberReputationPaginationMeta;
+}
+export interface ReputationPhoneNumberWithReputation {
+    data: ReputationPhoneNumber;
 }
-export interface NumberAssociateResponse {
-    data?: Array<NumberAssociateResponse.Data>;
-    meta?: Shared.MetaInfo;
+export interface NumberRefreshResponse {
+    data: NumberRefreshResponse.Data;
 }
-export declare namespace NumberAssociateResponse {
+export declare namespace NumberRefreshResponse {
     interface Data {
         /**
-         * Unique identifier
-         */
-        id?: string;
-        /**
-         * When the number was associated
-         */
-        created_at?: string;
-        /**
-         * ID of the associated enterprise
+         * Per-number outcome of the refresh.
          */
-        enterprise_id?: string;
-        /**
-         * Phone number in E.164 format
-         */
-        phone_number?: string;
-        /**
-         * When the record was last updated
-         */
-        updated_at?: string;
+        results: Array<Data.Result>;
+        total_failed: number;
+        total_requested: number;
+        total_successful: number;
+    }
+    namespace Data {
+        interface Result {
+            phone_number: string;
+            success: boolean;
+            /**
+             * `null` when `success` is `true`; carries an error message otherwise.
+             */
+            error?: string | null;
+        }
     }
 }
 export interface NumberRetrieveParams {
     /**
-     * Path param: Unique identifier of the enterprise (UUID)
+     * Path param: The enterprise id. Lowercase UUID.
      */
     enterprise_id: string;
     /**
      * Query param: When true, fetches fresh reputation data (incurs API cost). When
-     * false, returns cached data.
+     * false (default), returns cached data.
      */
     fresh?: boolean;
 }
 export interface NumberListParams extends DefaultFlatPaginationParams {
     /**
-     * Filter by specific phone number (E.164 format)
+     * Partial match on phone number. Must contain at least 5 digits.
      */
-    phone_number?: string;
+    'filter[phone_number][contains]'?: string;
+    /**
+     * Exact phone-number match (E.164).
+     */
+    'filter[phone_number][eq]'?: string;
 }
 export interface NumberAssociateParams {
     /**
-     * List of phone numbers to associate for reputation monitoring (max 100)
+     * 1–100 phone numbers in E.164 format with a leading `+`.
      */
     phone_numbers: Array<string>;
 }
 export interface NumberDisassociateParams {
     /**
-     * Unique identifier of the enterprise (UUID)
+     * The enterprise id. Lowercase UUID.
      */
     enterprise_id: string;
 }
+export interface NumberRefreshParams {
+    /**
+     * Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
+     * E.164 format. Reputation refreshes are subject to per-enterprise rate limits.
+     */
+    phone_numbers: Array<string>;
+}
 export declare namespace Numbers {
-    export { type NumberRetrieveResponse as NumberRetrieveResponse, type NumberAssociateResponse as NumberAssociateResponse, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, };
+    export { type ReputationPhoneNumber as ReputationPhoneNumber, type ReputationPhoneNumberList as ReputationPhoneNumberList, type ReputationPhoneNumberListWithReputation as ReputationPhoneNumberListWithReputation, type ReputationPhoneNumberWithReputation as ReputationPhoneNumberWithReputation, type NumberRefreshResponse as NumberRefreshResponse, type ReputationPhoneNumbersDefaultFlatPagination as ReputationPhoneNumbersDefaultFlatPagination, type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams, type NumberAssociateParams as NumberAssociateParams, type NumberDisassociateParams as NumberDisassociateParams, type NumberRefreshParams as NumberRefreshParams, };
 }
-export { type ReputationPhoneNumberWithReputationDataDefaultFlatPagination };
 //# sourceMappingURL=numbers.d.ts.map

package/resources/enterprises/reputation/numbers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"numbers.d.ts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,EAAE,4DAA4D,EAAE,wBAAqB;AAC5F,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EAEL,KAAK,2BAA2B,EAChC,WAAW,EACZ,oCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAQrC;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CACZ,4DAA4D,EAC5D,MAAM,CAAC,uCAAuC,CAC/C;IAQD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;IAItC;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,uCAAuC,CAAC;CACvD;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,KAAK,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;IAE3C,IAAI,CAAC,EAAE,MAAM,CAAC,QAAQ,CAAC;CACxB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B;IACnE;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH;AAED,OAAO,EAAE,KAAK,4DAA4D,EAAE,CAAC"}
+{"version":3,"file":"numbers.d.ts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,kCAA+B;AACrD,OAAO,KAAK,MAAM,wBAAqB;AACvC,OAAO,KAAK,cAAc,0BAAuB;AACjD,OAAO,EAAE,UAAU,EAAE,qCAAkC;AACvD,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,EAChC,WAAW,EACZ,oCAAiC;AAElC,OAAO,EAAE,cAAc,EAAE,6CAA0C;AAGnE;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mCAAmC,CAAC;IAQlD;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,2CAA2C,EAAE,qBAAqB,CAAC;IAQlF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACP,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,YAAY,CACV,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,wBAAwB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,mBAAmB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qBAAqB,CAAC;CAMrC;AAED,MAAM,MAAM,2CAA2C,GAAG,qBAAqB,CAAC,qBAAqB,CAAC,CAAC;AAEvG,MAAM,WAAW,qBAAqB;IACpC,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,cAAc,GAAG,IAAI,CAAC;IAE/C,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,IAAI,EAAE,cAAc,CAAC,8BAA8B,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAuC;IACtD,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEnC;;;;;OAKG;IACH,IAAI,EAAE,cAAc,CAAC,8BAA8B,CAAC;CACrD;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,IAAI;QACnB;;WAEG;QACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE5B,YAAY,EAAE,MAAM,CAAC;QAErB,eAAe,EAAE,MAAM,CAAC;QAExB,gBAAgB,EAAE,MAAM,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB,UAAiB,MAAM;YACrB,YAAY,EAAE,MAAM,CAAC;YAErB,OAAO,EAAE,OAAO,CAAC;YAEjB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SACvB;KACF;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,gBAAiB,SAAQ,2BAA2B;IACnE;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,mCAAmC,IAAI,mCAAmC,EAC/E,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2CAA2C,IAAI,2CAA2C,EAC/F,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}