telnyx 6.83.0 → 7.1.0

package/resources/enterprises/reputation/numbers.js

@@ -7,36 +7,21 @@ const pagination_1 = require("../../../core/pagination.js");
 const headers_1 = require("../../../internal/headers.js");
 const path_1 = require("../../../internal/utils/path.js");
 /**
- * Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
+ * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 class Numbers extends resource_1.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',
      *     },
      *   );
      * ```
@@ -49,17 +34,15 @@ class Numbers extends resource_1.APIResource {
         });
     }
     /**
-     * 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',
      * )) {
      *   // ...
      * }
@@ -69,28 +52,22 @@ class Numbers extends resource_1.APIResource {
         return this._client.getAPIList((0, path_1.path) `/enterprises/${enterpriseID}/reputation/numbers`, (pagination_1.DefaultFlatPagination), { query, ...options });
     }
     /**
-     * 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'] },
      *   );
      * ```
      */
@@ -98,16 +75,14 @@ class Numbers extends resource_1.APIResource {
         return this._client.post((0, path_1.path) `/enterprises/${enterpriseID}/reputation/numbers`, { body, ...options });
     }
     /**
-     * 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' },
      * );
      * ```
      */
@@ -118,6 +93,30 @@ class Numbers extends resource_1.APIResource {
             headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * 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, body, options) {
+        return this._client.post((0, path_1.path) `/enterprises/${enterpriseID}/reputation/numbers/refresh`, {
+            body,
+            ...options,
+        });
+    }
 }
 exports.Numbers = Numbers;
 //# sourceMappingURL=numbers.js.map

package/resources/enterprises/reputation/numbers.js.map

@@ -1 +1 @@
-{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,4DAIkC;AAClC,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAoB,EACpB,QAA6C,EAAE,EAC/C,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,gBAAgB,YAAY,qBAAqB,EACrD,CAAA,kCAAqE,CAAA,EACrE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAoB,EACpB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,YAAY,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAmB,EACnB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAChG,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AAvID,0BAuIC"}
+{"version":3,"file":"numbers.js","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAIrD,4DAIkC;AAClC,0DAAyD;AAEzD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,YAAoB,EACpB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAA,WAAI,EAAA,gBAAgB,YAAY,qBAAqB,EACrD,CAAA,kCAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACP,YAAoB,EACpB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,YAAY,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,WAAmB,EACnB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAChG,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,YAAoB,EACpB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,gBAAgB,YAAY,6BAA6B,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AAxID,0BAwIC"}

package/resources/enterprises/reputation/numbers.mjs

@@ -4,36 +4,21 @@ import { DefaultFlatPagination, } from "../../../core/pagination.mjs";
 import { buildHeaders } from "../../../internal/headers.mjs";
 import { path } from "../../../internal/utils/path.mjs";
 /**
- * Associate phone numbers with an enterprise for reputation monitoring and retrieve reputation scores
+ * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 export 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',
      *     },
      *   );
      * ```
@@ -46,17 +31,15 @@ export class Numbers extends APIResource {
         });
     }
     /**
-     * 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',
      * )) {
      *   // ...
      * }
@@ -66,28 +49,22 @@ export class Numbers extends APIResource {
         return this._client.getAPIList(path `/enterprises/${enterpriseID}/reputation/numbers`, (DefaultFlatPagination), { query, ...options });
     }
     /**
-     * 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'] },
      *   );
      * ```
      */
@@ -95,16 +72,14 @@ export class Numbers extends APIResource {
         return this._client.post(path `/enterprises/${enterpriseID}/reputation/numbers`, { body, ...options });
     }
     /**
-     * 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' },
      * );
      * ```
      */
@@ -115,5 +90,29 @@ export class Numbers extends APIResource {
             headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
         });
     }
+    /**
+     * 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, body, options) {
+        return this._client.post(path `/enterprises/${enterpriseID}/reputation/numbers/refresh`, {
+            body,
+            ...options,
+        });
+    }
 }
 //# sourceMappingURL=numbers.mjs.map

package/resources/enterprises/reputation/numbers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"numbers.mjs","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD,OAAO,EACL,qBAAqB,GAGtB,qCAAiC;AAClC,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CACF,YAAoB,EACpB,QAA6C,EAAE,EAC/C,OAAwB;QAKxB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,YAAY,qBAAqB,EACrD,CAAA,qBAAqE,CAAA,EACrE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CACP,YAAoB,EACpB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,YAAY,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,WAAmB,EACnB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAChG,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"numbers.mjs","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/numbers.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAIrD,OAAO,EACL,qBAAqB,GAGtB,qCAAiC;AAClC,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CACN,WAAmB,EACnB,MAA4B,EAC5B,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAC7F,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CACF,YAAoB,EACpB,QAA6C,EAAE,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,IAAI,CAAA,gBAAgB,YAAY,qBAAqB,EACrD,CAAA,qBAA4C,CAAA,EAC5C,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CACP,YAAoB,EACpB,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,YAAY,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,WAAmB,EACnB,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,gBAAgB,aAAa,uBAAuB,WAAW,EAAE,EAAE;YAChG,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CACL,YAAoB,EACpB,IAAyB,EACzB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,gBAAgB,YAAY,6BAA6B,EAAE;YACtF,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

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

@@ -0,0 +1,192 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as RemediationAPI from "./remediation.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { DefaultFlatPagination, type DefaultFlatPaginationParams, PagePromise } from "../../../core/pagination.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Phone-number reputation monitoring (spam-score lookup and tracking).
+ */
+export declare class Remediation extends APIResource {
+    /**
+     * Submit a batch of phone numbers belonging to this enterprise for reputation
+     * remediation. The request is accepted asynchronously: this endpoint returns `202`
+     * with the persisted request id, then the request transitions through processing
+     * states until completion. Use the GET endpoints to poll status and per-number
+     * results.
+     *
+     * Each phone number must be in E.164 format and belong to this enterprise. A
+     * number that already has an in-flight remediation request is rejected.
+     *
+     * @example
+     * ```ts
+     * const remediationRequestWrapped =
+     *   await client.enterprises.reputation.remediation.create(
+     *     '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *     {
+     *       call_purpose:
+     *         'Appointment reminders for our dental clinic.',
+     *       phone_numbers: ['+19493253498', '+12134445566'],
+     *       contact_email: 'ops@example.com',
+     *       webhook_url:
+     *         'https://example.com/webhooks/remediation',
+     *     },
+     *   );
+     * ```
+     */
+    create(enterpriseID: string, body: RemediationCreateParams, options?: RequestOptions): APIPromise<RemediationRequestWrapped>;
+    /**
+     * Retrieve the full detail of a remediation request, including current status,
+     * per-number results (once available), and submission metadata.
+     *
+     * @example
+     * ```ts
+     * const remediationRequestWrapped =
+     *   await client.enterprises.reputation.remediation.retrieve(
+     *     'b7c1f1c0-7a9d-4f0a-9d3e-2f6a1c4b8e21',
+     *     {
+     *       enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     *     },
+     *   );
+     * ```
+     */
+    retrieve(remediationID: string, params: RemediationRetrieveParams, options?: RequestOptions): APIPromise<RemediationRequestWrapped>;
+    /**
+     * Paginated list of remediation requests for this enterprise. List items omit
+     * per-number results and webhook URLs to keep the response small; call GET by id
+     * for full detail. Supports JSON:API pagination and optional filters on status and
+     * created-at range.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const remediationListResponse of client.enterprises.reputation.remediation.list(
+     *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+     * )) {
+     *   // ...
+     * }
+     * ```
+     */
+    list(enterpriseID: string, query?: RemediationListParams | null | undefined, options?: RequestOptions): PagePromise<RemediationListResponsesDefaultFlatPagination, RemediationListResponse>;
+}
+export type RemediationListResponsesDefaultFlatPagination = DefaultFlatPagination<RemediationListResponse>;
+export interface RemediationRequestWrapped {
+    /**
+     * Full detail of a remediation request, returned on submit and GET by id.
+     */
+    data: RemediationRequestWrapped.Data;
+}
+export declare namespace RemediationRequestWrapped {
+    /**
+     * Full detail of a remediation request, returned on submit and GET by id.
+     */
+    interface Data {
+        id: string;
+        call_purpose: string;
+        created_at: string;
+        /**
+         * Total phone numbers in this batch, including any later cancelled. May exceed the
+         * sum of the per-category result buckets, which omit cancelled numbers.
+         */
+        phone_numbers_count: number;
+        /**
+         * Numbers rejected before submission (e.g. cooldown).
+         */
+        phone_numbers_ineligible: number;
+        /**
+         * Numbers accepted for remediation, i.e. not rejected as ineligible. Counts
+         * numbers still queued (pending) as well as processed ones.
+         */
+        phone_numbers_submitted: number;
+        /**
+         * Customer-facing status of a remediation request.
+         */
+        status: RemediationAPI.RemediationStatus;
+        updated_at: string;
+        contact_email?: string | null;
+        /**
+         * Per-category buckets. Populated once results are available. Null while the
+         * request is still pending.
+         */
+        results?: Data.Results | null;
+        tier1_completed_at?: string | null;
+        tier2_completed_at?: string | null;
+        webhook_url?: string | null;
+    }
+    namespace Data {
+        /**
+         * Per-category buckets. Populated once results are available. Null while the
+         * request is still pending.
+         */
+        interface Results {
+            ineligible?: Array<string>;
+            not_flagged?: Array<string>;
+            refused?: Array<string>;
+            remediated?: Array<string>;
+            requires_review?: Array<string>;
+        }
+    }
+}
+/**
+ * Customer-facing status of a remediation request.
+ */
+export type RemediationStatus = 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
+/**
+ * Slim list-endpoint shape. Omits per-number results and webhook URLs to keep
+ * responses small.
+ */
+export interface RemediationListResponse {
+    id: string;
+    call_purpose: string;
+    created_at: string;
+    phone_numbers_count: number;
+    /**
+     * Customer-facing status of a remediation request.
+     */
+    status: RemediationStatus;
+    updated_at: string;
+    tier1_completed_at?: string | null;
+    tier2_completed_at?: string | null;
+}
+export interface RemediationCreateParams {
+    /**
+     * How the numbers are used (free text).
+     */
+    call_purpose: string;
+    /**
+     * Phone numbers in E.164 format. Each must belong to this enterprise. Maximum
+     * 2,000 per request.
+     */
+    phone_numbers: Array<string>;
+    /**
+     * Optional contact email for this remediation request.
+     */
+    contact_email?: string;
+    /**
+     * Optional https:// URL for status notifications.
+     */
+    webhook_url?: string;
+}
+export interface RemediationRetrieveParams {
+    /**
+     * The enterprise id. Lowercase UUID.
+     */
+    enterprise_id: string;
+}
+export interface RemediationListParams extends DefaultFlatPaginationParams {
+    /**
+     * Only requests created on or after this timestamp (ISO 8601).
+     */
+    'filter[created_at][gte]'?: string;
+    /**
+     * Only requests created on or before this timestamp (ISO 8601).
+     */
+    'filter[created_at][lte]'?: string;
+    /**
+     * Filter by customer-facing status.
+     */
+    'filter[status]'?: RemediationStatus;
+}
+export declare namespace Remediation {
+    export { type RemediationRequestWrapped as RemediationRequestWrapped, type RemediationStatus as RemediationStatus, type RemediationListResponse as RemediationListResponse, type RemediationListResponsesDefaultFlatPagination as RemediationListResponsesDefaultFlatPagination, type RemediationCreateParams as RemediationCreateParams, type RemediationRetrieveParams as RemediationRetrieveParams, type RemediationListParams as RemediationListParams, };
+}
+//# sourceMappingURL=remediation.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"remediation.d.mts","sourceRoot":"","sources":["../../../src/resources/enterprises/reputation/remediation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,mCAA+B;AACrD,OAAO,KAAK,cAAc,0BAAsB;AAChD,OAAO,EAAE,UAAU,EAAE,sCAAkC;AACvD,OAAO,EACL,qBAAqB,EACrB,KAAK,2BAA2B,EAChC,WAAW,EACZ,qCAAiC;AAClC,OAAO,EAAE,cAAc,EAAE,8CAA0C;AAGnE;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,yBAAyB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAQxC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6CAA6C,EAAE,uBAAuB,CAAC;CAOvF;AAED,MAAM,MAAM,6CAA6C,GAAG,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;AAE3G,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,IAAI,EAAE,yBAAyB,CAAC,IAAI,CAAC;CACtC;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB,EAAE,EAAE,MAAM,CAAC;QAEX,YAAY,EAAE,MAAM,CAAC;QAErB,UAAU,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,wBAAwB,EAAE,MAAM,CAAC;QAEjC;;;WAGG;QACH,uBAAuB,EAAE,MAAM,CAAC;QAEhC;;WAEG;QACH,MAAM,EAAE,cAAc,CAAC,iBAAiB,CAAC;QAEzC,UAAU,EAAE,MAAM,CAAC;QAEnB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAE9B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC7B;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,OAAO;YACtB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE3B,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE5B,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAExB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE3B,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACjC;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAEjG;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,YAAY,EAAE,MAAM,CAAC;IAErB,UAAU,EAAE,MAAM,CAAC;IAEnB,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAsB,SAAQ,2BAA2B;IACxE;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,6CAA6C,IAAI,6CAA6C,EACnG,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}