telnyx 7.3.0 → 7.5.0

package/src/resources/portouts/portouts.ts

@@ -54,20 +54,6 @@ export class Portouts extends APIResource {
   supportingDocuments: SupportingDocumentsAPI.SupportingDocuments =
     new SupportingDocumentsAPI.SupportingDocuments(this._client);
 
-  /**
-   * Returns the portout request based on the ID provided
-   *
-   * @example
-   * ```ts
-   * const portout = await client.portouts.retrieve(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PortoutRetrieveResponse> {
-    return this._client.get(path`/portouts/${id}`, options);
-  }
-
   /**
    * Returns the portout requests according to filters
    *
@@ -104,6 +90,20 @@ export class Portouts extends APIResource {
     return this._client.get(path`/portouts/rejections/${portoutID}`, { query, ...options });
   }
 
+  /**
+   * Returns the portout request based on the ID provided
+   *
+   * @example
+   * ```ts
+   * const portout = await client.portouts.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PortoutRetrieveResponse> {
+    return this._client.get(path`/portouts/${id}`, options);
+  }
+
   /**
    * Authorize or reject portout request
    *
@@ -477,8 +477,8 @@ export declare namespace Portouts {
     type ReportCreateResponse as ReportCreateResponse,
     type ReportRetrieveResponse as ReportRetrieveResponse,
     type PortoutReportsDefaultFlatPagination as PortoutReportsDefaultFlatPagination,
-    type ReportCreateParams as ReportCreateParams,
     type ReportListParams as ReportListParams,
+    type ReportCreateParams as ReportCreateParams,
   };
 
   export {

package/src/resources/portouts/reports.ts

@@ -10,6 +10,27 @@ import { path } from '../../internal/utils/path';
  * Number portout operations
  */
 export class Reports extends APIResource {
+  /**
+   * List the reports generated about port-out operations.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const portoutReport of client.portouts.reports.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: ReportListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PortoutReportsDefaultFlatPagination, PortoutReport> {
+    return this._client.getAPIList('/portouts/reports', DefaultFlatPagination<PortoutReport>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Generate reports about port-out operations.
    *
@@ -38,27 +59,6 @@ export class Reports extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<ReportRetrieveResponse> {
     return this._client.get(path`/portouts/reports/${id}`, options);
   }
-
-  /**
-   * List the reports generated about port-out operations.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const portoutReport of client.portouts.reports.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: ReportListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PortoutReportsDefaultFlatPagination, PortoutReport> {
-    return this._client.getAPIList('/portouts/reports', DefaultFlatPagination<PortoutReport>, {
-      query,
-      ...options,
-    });
-  }
 }
 
 export type PortoutReportsDefaultFlatPagination = DefaultFlatPagination<PortoutReport>;
@@ -161,18 +161,6 @@ export interface ReportRetrieveResponse {
   data?: PortoutReport;
 }
 
-export interface ReportCreateParams {
-  /**
-   * The parameters for generating a port-outs CSV report.
-   */
-  params: ExportPortoutsCsvReport;
-
-  /**
-   * Identifies the type of report
-   */
-  report_type: 'export_portouts_csv';
-}
-
 export interface ReportListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -199,6 +187,18 @@ export namespace ReportListParams {
   }
 }
 
+export interface ReportCreateParams {
+  /**
+   * The parameters for generating a port-outs CSV report.
+   */
+  params: ExportPortoutsCsvReport;
+
+  /**
+   * Identifies the type of report
+   */
+  report_type: 'export_portouts_csv';
+}
+
 export declare namespace Reports {
   export {
     type ExportPortoutsCsvReport as ExportPortoutsCsvReport,
@@ -206,7 +206,7 @@ export declare namespace Reports {
     type ReportCreateResponse as ReportCreateResponse,
     type ReportRetrieveResponse as ReportRetrieveResponse,
     type PortoutReportsDefaultFlatPagination as PortoutReportsDefaultFlatPagination,
-    type ReportCreateParams as ReportCreateParams,
     type ReportListParams as ReportListParams,
+    type ReportCreateParams as ReportCreateParams,
   };
 }

package/src/resources/portouts/supporting-documents.ts

@@ -10,37 +10,37 @@ import { path } from '../../internal/utils/path';
  */
 export class SupportingDocuments extends APIResource {
   /**
-   * Creates a list of supporting documents on a portout request.
+   * List every supporting documents for a portout request.
    *
    * @example
    * ```ts
-   * const supportingDocument =
-   *   await client.portouts.supportingDocuments.create(
+   * const supportingDocuments =
+   *   await client.portouts.supportingDocuments.list(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *   );
    * ```
    */
-  create(
-    id: string,
-    body: SupportingDocumentCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<SupportingDocumentCreateResponse> {
-    return this._client.post(path`/portouts/${id}/supporting_documents`, { body, ...options });
+  list(id: string, options?: RequestOptions): APIPromise<SupportingDocumentListResponse> {
+    return this._client.get(path`/portouts/${id}/supporting_documents`, options);
   }
 
   /**
-   * List every supporting documents for a portout request.
+   * Creates a list of supporting documents on a portout request.
    *
    * @example
    * ```ts
-   * const supportingDocuments =
-   *   await client.portouts.supportingDocuments.list(
+   * const supportingDocument =
+   *   await client.portouts.supportingDocuments.create(
    *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    *   );
    * ```
    */
-  list(id: string, options?: RequestOptions): APIPromise<SupportingDocumentListResponse> {
-    return this._client.get(path`/portouts/${id}/supporting_documents`, options);
+  create(
+    id: string,
+    body: SupportingDocumentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<SupportingDocumentCreateResponse> {
+    return this._client.post(path`/portouts/${id}/supporting_documents`, { body, ...options });
   }
 }
 

package/src/resources/private-wireless-gateways.ts

@@ -10,6 +10,28 @@ import { path } from '../internal/utils/path';
  * Private Wireless Gateways operations
  */
 export class PrivateWirelessGateways extends APIResource {
+  /**
+   * Get all Private Wireless Gateways belonging to the user.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const privateWirelessGateway of client.privateWirelessGateways.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: PrivateWirelessGatewayListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PrivateWirelessGatewaysDefaultFlatPagination, PrivateWirelessGateway> {
+    return this._client.getAPIList(
+      '/private_wireless_gateways',
+      DefaultFlatPagination<PrivateWirelessGateway>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Asynchronously create a Private Wireless Gateway for SIM cards for a previously
    * created network. This operation may take several minutes so you can check the
@@ -32,55 +54,33 @@ export class PrivateWirelessGateways extends APIResource {
   }
 
   /**
-   * Retrieve information about a Private Wireless Gateway.
+   * Deletes the Private Wireless Gateway.
    *
    * @example
    * ```ts
    * const privateWirelessGateway =
-   *   await client.privateWirelessGateways.retrieve(
+   *   await client.privateWirelessGateways.delete(
    *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
    *   );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PrivateWirelessGatewayRetrieveResponse> {
-    return this._client.get(path`/private_wireless_gateways/${id}`, options);
-  }
-
-  /**
-   * Get all Private Wireless Gateways belonging to the user.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const privateWirelessGateway of client.privateWirelessGateways.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: PrivateWirelessGatewayListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PrivateWirelessGatewaysDefaultFlatPagination, PrivateWirelessGateway> {
-    return this._client.getAPIList(
-      '/private_wireless_gateways',
-      DefaultFlatPagination<PrivateWirelessGateway>,
-      { query, ...options },
-    );
+  delete(id: string, options?: RequestOptions): APIPromise<PrivateWirelessGatewayDeleteResponse> {
+    return this._client.delete(path`/private_wireless_gateways/${id}`, options);
   }
 
   /**
-   * Deletes the Private Wireless Gateway.
+   * Retrieve information about a Private Wireless Gateway.
    *
    * @example
    * ```ts
    * const privateWirelessGateway =
-   *   await client.privateWirelessGateways.delete(
+   *   await client.privateWirelessGateways.retrieve(
    *     '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
    *   );
    * ```
    */
-  delete(id: string, options?: RequestOptions): APIPromise<PrivateWirelessGatewayDeleteResponse> {
-    return this._client.delete(path`/private_wireless_gateways/${id}`, options);
+  retrieve(id: string, options?: RequestOptions): APIPromise<PrivateWirelessGatewayRetrieveResponse> {
+    return this._client.get(path`/private_wireless_gateways/${id}`, options);
   }
 }
 
@@ -192,24 +192,6 @@ export interface PrivateWirelessGatewayDeleteResponse {
   data?: PrivateWirelessGateway;
 }
 
-export interface PrivateWirelessGatewayCreateParams {
-  /**
-   * The private wireless gateway name.
-   */
-  name: string;
-
-  /**
-   * The identification of the related network resource.
-   */
-  network_id: string;
-
-  /**
-   * The code of the region where the private wireless gateway will be assigned. A
-   * list of available regions can be found at the regions endpoint
-   */
-  region_code?: string;
-}
-
 export interface PrivateWirelessGatewayListParams extends DefaultFlatPaginationParams {
   /**
    * Private Wireless Gateway resource creation date.
@@ -237,6 +219,24 @@ export interface PrivateWirelessGatewayListParams extends DefaultFlatPaginationP
   'filter[updated_at]'?: string;
 }
 
+export interface PrivateWirelessGatewayCreateParams {
+  /**
+   * The private wireless gateway name.
+   */
+  name: string;
+
+  /**
+   * The identification of the related network resource.
+   */
+  network_id: string;
+
+  /**
+   * The code of the region where the private wireless gateway will be assigned. A
+   * list of available regions can be found at the regions endpoint
+   */
+  region_code?: string;
+}
+
 export declare namespace PrivateWirelessGateways {
   export {
     type PrivateWirelessGateway as PrivateWirelessGateway,
@@ -246,7 +246,7 @@ export declare namespace PrivateWirelessGateways {
     type PrivateWirelessGatewayRetrieveResponse as PrivateWirelessGatewayRetrieveResponse,
     type PrivateWirelessGatewayDeleteResponse as PrivateWirelessGatewayDeleteResponse,
     type PrivateWirelessGatewaysDefaultFlatPagination as PrivateWirelessGatewaysDefaultFlatPagination,
-    type PrivateWirelessGatewayCreateParams as PrivateWirelessGatewayCreateParams,
     type PrivateWirelessGatewayListParams as PrivateWirelessGatewayListParams,
+    type PrivateWirelessGatewayCreateParams as PrivateWirelessGatewayCreateParams,
   };
 }

package/src/resources/pronunciation-dicts.ts

@@ -12,6 +12,28 @@ import { path } from '../internal/utils/path';
  * Manage pronunciation dictionaries for text-to-speech synthesis. Dictionaries contain alias items (text replacement) and phoneme items (IPA pronunciation notation) that control how specific words are spoken.
  */
 export class PronunciationDicts extends APIResource {
+  /**
+   * List all pronunciation dictionaries for the authenticated organization. Results
+   * are paginated using offset-based pagination.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const pronunciationDictData of client.pronunciationDicts.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: PronunciationDictListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PronunciationDictDataDefaultFlatPagination, PronunciationDictData> {
+    return this._client.getAPIList('/pronunciation_dicts', DefaultFlatPagination<PronunciationDictData>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a new pronunciation dictionary for the authenticated organization. Each
    * dictionary contains a list of items that control how specific words are spoken.
@@ -57,6 +79,23 @@ export class PronunciationDicts extends APIResource {
     );
   }
 
+  /**
+   * Permanently delete a pronunciation dictionary.
+   *
+   * @example
+   * ```ts
+   * await client.pronunciationDicts.delete(
+   *   'c215a3e1-be41-4701-97e8-1d3c22f9a5b7',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/pronunciation_dicts/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieve a single pronunciation dictionary by ID.
    *
@@ -92,45 +131,6 @@ export class PronunciationDicts extends APIResource {
   ): APIPromise<PronunciationDictResponse> {
     return this._client.patch(path`/pronunciation_dicts/${id}`, { body, ...options });
   }
-
-  /**
-   * List all pronunciation dictionaries for the authenticated organization. Results
-   * are paginated using offset-based pagination.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const pronunciationDictData of client.pronunciationDicts.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: PronunciationDictListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PronunciationDictDataDefaultFlatPagination, PronunciationDictData> {
-    return this._client.getAPIList('/pronunciation_dicts', DefaultFlatPagination<PronunciationDictData>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Permanently delete a pronunciation dictionary.
-   *
-   * @example
-   * ```ts
-   * await client.pronunciationDicts.delete(
-   *   'c215a3e1-be41-4701-97e8-1d3c22f9a5b7',
-   * );
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/pronunciation_dicts/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export type PronunciationDictDataDefaultFlatPagination = DefaultFlatPagination<PronunciationDictData>;
@@ -242,6 +242,8 @@ export interface PronunciationDictResponse {
   data?: PronunciationDictData;
 }
 
+export interface PronunciationDictListParams extends DefaultFlatPaginationParams {}
+
 export interface PronunciationDictCreateParams {
   /**
    * List of pronunciation items (alias or phoneme type). At least one item is
@@ -267,8 +269,6 @@ export interface PronunciationDictUpdateParams {
   name?: string;
 }
 
-export interface PronunciationDictListParams extends DefaultFlatPaginationParams {}
-
 export declare namespace PronunciationDicts {
   export {
     type PronunciationDictAliasItem as PronunciationDictAliasItem,
@@ -277,8 +277,8 @@ export declare namespace PronunciationDicts {
     type PronunciationDictPhonemeItem as PronunciationDictPhonemeItem,
     type PronunciationDictResponse as PronunciationDictResponse,
     type PronunciationDictDataDefaultFlatPagination as PronunciationDictDataDefaultFlatPagination,
+    type PronunciationDictListParams as PronunciationDictListParams,
     type PronunciationDictCreateParams as PronunciationDictCreateParams,
     type PronunciationDictUpdateParams as PronunciationDictUpdateParams,
-    type PronunciationDictListParams as PronunciationDictListParams,
   };
 }

package/src/resources/public-internet-gateways.ts

@@ -13,24 +13,6 @@ import { path } from '../internal/utils/path';
  * Public Internet Gateway operations
  */
 export class PublicInternetGateways extends APIResource {
-  /**
-   * Create a new Public Internet Gateway.
-   */
-  create(
-    params: PublicInternetGatewayCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<PublicInternetGatewayCreateResponse> {
-    const { body } = params;
-    return this._client.post('/public_internet_gateways', { body: body, ...options });
-  }
-
-  /**
-   * Retrieve a Public Internet Gateway.
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayRetrieveResponse> {
-    return this._client.get(path`/public_internet_gateways/${id}`, options);
-  }
-
   /**
    * List all Public Internet Gateways.
    */
@@ -45,12 +27,30 @@ export class PublicInternetGateways extends APIResource {
     );
   }
 
+  /**
+   * Create a new Public Internet Gateway.
+   */
+  create(
+    params: PublicInternetGatewayCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PublicInternetGatewayCreateResponse> {
+    const { body } = params;
+    return this._client.post('/public_internet_gateways', { body: body, ...options });
+  }
+
   /**
    * Delete a Public Internet Gateway.
    */
   delete(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayDeleteResponse> {
     return this._client.delete(path`/public_internet_gateways/${id}`, options);
   }
+
+  /**
+   * Retrieve a Public Internet Gateway.
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<PublicInternetGatewayRetrieveResponse> {
+    return this._client.get(path`/public_internet_gateways/${id}`, options);
+  }
 }
 
 export type PublicInternetGatewayReadsDefaultFlatPagination =
@@ -151,14 +151,6 @@ export interface PublicInternetGatewayDeleteResponse {
   data?: PublicInternetGatewayRead;
 }
 
-export interface PublicInternetGatewayCreateParams {
-  body: PublicInternetGatewayCreateParams.Body;
-}
-
-export namespace PublicInternetGatewayCreateParams {
-  export interface Body extends PublicInternetGatewaysAPI.PublicInternetGateway {}
-}
-
 export interface PublicInternetGatewayListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[network_id]
@@ -178,6 +170,14 @@ export namespace PublicInternetGatewayListParams {
   }
 }
 
+export interface PublicInternetGatewayCreateParams {
+  body: PublicInternetGatewayCreateParams.Body;
+}
+
+export namespace PublicInternetGatewayCreateParams {
+  export interface Body extends PublicInternetGatewaysAPI.PublicInternetGateway {}
+}
+
 export declare namespace PublicInternetGateways {
   export {
     type NetworkInterface as NetworkInterface,
@@ -188,7 +188,7 @@ export declare namespace PublicInternetGateways {
     type PublicInternetGatewayRetrieveResponse as PublicInternetGatewayRetrieveResponse,
     type PublicInternetGatewayDeleteResponse as PublicInternetGatewayDeleteResponse,
     type PublicInternetGatewayReadsDefaultFlatPagination as PublicInternetGatewayReadsDefaultFlatPagination,
-    type PublicInternetGatewayCreateParams as PublicInternetGatewayCreateParams,
     type PublicInternetGatewayListParams as PublicInternetGatewayListParams,
+    type PublicInternetGatewayCreateParams as PublicInternetGatewayCreateParams,
   };
 }