telnyx 7.2.0 → 7.5.0

package/src/resources/enterprises/index.ts

@@ -1,6 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Dir, type DirCreateParams, type DirListParams } from './dir';
+export { Dir, type DirListParams, type DirCreateParams } from './dir';
 export {
   Enterprises,
   type BillingAddress,
@@ -10,9 +10,9 @@ export {
   type NumberReputationPaginationMeta,
   type OrganizationContact,
   type PhysicalAddress,
+  type EnterpriseListParams,
   type EnterpriseCreateParams,
   type EnterpriseUpdateParams,
-  type EnterpriseListParams,
   type EnterprisePublicsDefaultFlatPagination,
 } from './enterprises';
 export {

package/src/resources/enterprises/reputation/index.ts

@@ -8,10 +8,10 @@ export {
   type ReputationPhoneNumberListWithReputation,
   type ReputationPhoneNumberWithReputation,
   type NumberRefreshResponse,
-  type NumberRetrieveParams,
   type NumberListParams,
   type NumberAssociateParams,
   type NumberDisassociateParams,
+  type NumberRetrieveParams,
   type NumberRefreshParams,
   type ReputationPhoneNumbersDefaultFlatPagination,
 } from './numbers';
@@ -20,9 +20,9 @@ export {
   type RemediationRequestWrapped,
   type RemediationStatus,
   type RemediationListResponse,
+  type RemediationListParams,
   type RemediationCreateParams,
   type RemediationRetrieveParams,
-  type RemediationListParams,
   type RemediationListResponsesDefaultFlatPagination,
 } from './remediation';
 export {

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

@@ -17,34 +17,6 @@ import { path } from '../../../internal/utils/path';
  * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 export class Numbers extends APIResource {
-  /**
-   * 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 reputationPhoneNumberWithReputation =
-   *   await client.enterprises.reputation.numbers.retrieve(
-   *     '+19493253498',
-   *     {
-   *       enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
-   *     },
-   *   );
-   * ```
-   */
-  retrieve(
-    phoneNumber: string,
-    params: NumberRetrieveParams,
-    options?: RequestOptions,
-  ): APIPromise<ReputationPhoneNumberWithReputation> {
-    const { enterprise_id, ...query } = params;
-    return this._client.get(path`/enterprises/${enterprise_id}/reputation/numbers/${phoneNumber}`, {
-      query,
-      ...options,
-    });
-  }
-
   /**
    * Paginated list of phone numbers registered for reputation monitoring under this
    * enterprise. The response includes the latest reputation snapshot per number
@@ -124,6 +96,34 @@ export class Numbers extends APIResource {
     });
   }
 
+  /**
+   * 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 reputationPhoneNumberWithReputation =
+   *   await client.enterprises.reputation.numbers.retrieve(
+   *     '+19493253498',
+   *     {
+   *       enterprise_id: '4a6192a4-573d-446d-b3ce-aff9117272a6',
+   *     },
+   *   );
+   * ```
+   */
+  retrieve(
+    phoneNumber: string,
+    params: NumberRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<ReputationPhoneNumberWithReputation> {
+    const { enterprise_id, ...query } = params;
+    return this._client.get(path`/enterprises/${enterprise_id}/reputation/numbers/${phoneNumber}`, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * 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
@@ -240,19 +240,6 @@ export namespace NumberRefreshResponse {
   }
 }
 
-export interface NumberRetrieveParams {
-  /**
-   * Path param: The enterprise id. Lowercase UUID.
-   */
-  enterprise_id: string;
-
-  /**
-   * Query param: When true, fetches fresh reputation data (incurs API cost). When
-   * false (default), returns cached data.
-   */
-  fresh?: boolean;
-}
-
 export interface NumberListParams extends DefaultFlatPaginationParams {
   /**
    * Partial match on phone number. Must contain at least 5 digits.
@@ -279,6 +266,19 @@ export interface NumberDisassociateParams {
   enterprise_id: string;
 }
 
+export interface NumberRetrieveParams {
+  /**
+   * Path param: The enterprise id. Lowercase UUID.
+   */
+  enterprise_id: string;
+
+  /**
+   * Query param: When true, fetches fresh reputation data (incurs API cost). When
+   * false (default), returns cached data.
+   */
+  fresh?: boolean;
+}
+
 export interface NumberRefreshParams {
   /**
    * Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
@@ -295,10 +295,10 @@ export declare namespace Numbers {
     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 NumberRetrieveParams as NumberRetrieveParams,
     type NumberRefreshParams as NumberRefreshParams,
   };
 }

package/src/resources/enterprises/reputation/remediation.ts

@@ -15,6 +15,34 @@ import { path } from '../../../internal/utils/path';
  * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 export class Remediation extends APIResource {
+  /**
+   * 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> {
+    return this._client.getAPIList(
+      path`/enterprises/${enterpriseID}/reputation/remediation`,
+      DefaultFlatPagination<RemediationListResponse>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Submit a batch of phone numbers belonging to this enterprise for reputation
    * remediation. The request is accepted asynchronously: this endpoint returns `202`
@@ -75,34 +103,6 @@ export class Remediation extends APIResource {
       options,
     );
   }
-
-  /**
-   * 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> {
-    return this._client.getAPIList(
-      path`/enterprises/${enterpriseID}/reputation/remediation`,
-      DefaultFlatPagination<RemediationListResponse>,
-      { query, ...options },
-    );
-  }
 }
 
 export type RemediationListResponsesDefaultFlatPagination = DefaultFlatPagination<RemediationListResponse>;
@@ -213,6 +213,23 @@ export interface RemediationListResponse {
   tier2_completed_at?: string | null;
 }
 
+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 interface RemediationCreateParams {
   /**
    * How the numbers are used (free text).
@@ -243,31 +260,14 @@ export interface RemediationRetrieveParams {
   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 RemediationListParams as RemediationListParams,
     type RemediationCreateParams as RemediationCreateParams,
     type RemediationRetrieveParams as RemediationRetrieveParams,
-    type RemediationListParams as RemediationListParams,
   };
 }

package/src/resources/enterprises/reputation/reputation.ts

@@ -42,6 +42,25 @@ export class Reputation extends APIResource {
   loa: LoaAPI.Loa = new LoaAPI.Loa(this._client);
   remediation: RemediationAPI.Remediation = new RemediationAPI.Remediation(this._client);
 
+  /**
+   * Disable Phone Number Reputation. All registered numbers are de-registered as a
+   * cascade. The enterprise itself is unaffected. Returns `204` on success, `404` if
+   * reputation is not enabled for this enterprise.
+   *
+   * @example
+   * ```ts
+   * await client.enterprises.reputation.disable(
+   *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
+   * );
+   * ```
+   */
+  disable(enterpriseID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/enterprises/${enterpriseID}/reputation`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Phone Number Reputation tracks how your outbound caller-IDs are perceived (spam
    * risk, engagement, etc.) across the call-screening ecosystem. This endpoint reads
@@ -62,25 +81,6 @@ export class Reputation extends APIResource {
     return this._client.get(path`/enterprises/${enterpriseID}/reputation`, options);
   }
 
-  /**
-   * Disable Phone Number Reputation. All registered numbers are de-registered as a
-   * cascade. The enterprise itself is unaffected. Returns `204` on success, `404` if
-   * reputation is not enabled for this enterprise.
-   *
-   * @example
-   * ```ts
-   * await client.enterprises.reputation.disable(
-   *   '4a6192a4-573d-446d-b3ce-aff9117272a6',
-   * );
-   * ```
-   */
-  disable(enterpriseID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/enterprises/${enterpriseID}/reputation`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   /**
    * Activate Phone Number Reputation for the given enterprise. Requires an uploaded
    * Letter of Authorization document (the `loa_document_id` references the Telnyx
@@ -242,10 +242,10 @@ export declare namespace Reputation {
     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 NumberRetrieveParams as NumberRetrieveParams,
     type NumberRefreshParams as NumberRefreshParams,
   };
 
@@ -262,8 +262,8 @@ export declare namespace Reputation {
     type RemediationStatus as RemediationStatus,
     type RemediationListResponse as RemediationListResponse,
     type RemediationListResponsesDefaultFlatPagination as RemediationListResponsesDefaultFlatPagination,
+    type RemediationListParams as RemediationListParams,
     type RemediationCreateParams as RemediationCreateParams,
     type RemediationRetrieveParams as RemediationRetrieveParams,
-    type RemediationListParams as RemediationListParams,
   };
 }

package/src/resources/external-connections/civic-addresses.ts

@@ -9,6 +9,25 @@ import { path } from '../../internal/utils/path';
  * External Connections operations
  */
 export class CivicAddresses extends APIResource {
+  /**
+   * Returns the civic addresses and locations from Microsoft Teams.
+   *
+   * @example
+   * ```ts
+   * const civicAddresses =
+   *   await client.externalConnections.civicAddresses.list(
+   *     '1293384261075731499',
+   *   );
+   * ```
+   */
+  list(
+    id: string,
+    query: CivicAddressListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CivicAddressListResponse> {
+    return this._client.get(path`/external_connections/${id}/civic_addresses`, { query, ...options });
+  }
+
   /**
    * Return the details of an existing Civic Address with its Locations inside the
    * 'data' attribute of the response.
@@ -30,25 +49,6 @@ export class CivicAddresses extends APIResource {
     const { id } = params;
     return this._client.get(path`/external_connections/${id}/civic_addresses/${addressID}`, options);
   }
-
-  /**
-   * Returns the civic addresses and locations from Microsoft Teams.
-   *
-   * @example
-   * ```ts
-   * const civicAddresses =
-   *   await client.externalConnections.civicAddresses.list(
-   *     '1293384261075731499',
-   *   );
-   * ```
-   */
-  list(
-    id: string,
-    query: CivicAddressListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<CivicAddressListResponse> {
-    return this._client.get(path`/external_connections/${id}/civic_addresses`, { query, ...options });
-  }
 }
 
 export interface CivicAddress {
@@ -118,13 +118,6 @@ export interface CivicAddressListResponse {
   data?: Array<CivicAddress>;
 }
 
-export interface CivicAddressRetrieveParams {
-  /**
-   * Identifies the resource.
-   */
-  id: string;
-}
-
 export interface CivicAddressListParams {
   /**
    * Filter parameter for civic addresses (deepObject style). Supports filtering by
@@ -146,13 +139,20 @@ export namespace CivicAddressListParams {
   }
 }
 
+export interface CivicAddressRetrieveParams {
+  /**
+   * Identifies the resource.
+   */
+  id: string;
+}
+
 export declare namespace CivicAddresses {
   export {
     type CivicAddress as CivicAddress,
     type Location as Location,
     type CivicAddressRetrieveResponse as CivicAddressRetrieveResponse,
     type CivicAddressListResponse as CivicAddressListResponse,
-    type CivicAddressRetrieveParams as CivicAddressRetrieveParams,
     type CivicAddressListParams as CivicAddressListParams,
+    type CivicAddressRetrieveParams as CivicAddressRetrieveParams,
   };
 }