telnyx 7.3.0 → 7.5.0

package/src/resources/storage/migration-sources.ts

@@ -10,6 +10,19 @@ import { path } from '../../internal/utils/path';
  * Migrate data from an external provider into Telnyx Cloud Storage
  */
 export class MigrationSources extends APIResource {
+  /**
+   * List all Migration Sources
+   *
+   * @example
+   * ```ts
+   * const migrationSources =
+   *   await client.storage.migrationSources.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<MigrationSourceListResponse> {
+    return this._client.get('/storage/migration_sources', options);
+  }
+
   /**
    * Create a source from which data can be migrated from.
    *
@@ -31,42 +44,29 @@ export class MigrationSources extends APIResource {
   }
 
   /**
-   * Get a Migration Source
+   * Delete a Migration Source
    *
    * @example
    * ```ts
    * const migrationSource =
-   *   await client.storage.migrationSources.retrieve('');
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<MigrationSourceRetrieveResponse> {
-    return this._client.get(path`/storage/migration_sources/${id}`, options);
-  }
-
-  /**
-   * List all Migration Sources
-   *
-   * @example
-   * ```ts
-   * const migrationSources =
-   *   await client.storage.migrationSources.list();
+   *   await client.storage.migrationSources.delete('');
    * ```
    */
-  list(options?: RequestOptions): APIPromise<MigrationSourceListResponse> {
-    return this._client.get('/storage/migration_sources', options);
+  delete(id: string, options?: RequestOptions): APIPromise<MigrationSourceDeleteResponse> {
+    return this._client.delete(path`/storage/migration_sources/${id}`, options);
   }
 
   /**
-   * Delete a Migration Source
+   * Get a Migration Source
    *
    * @example
    * ```ts
    * const migrationSource =
-   *   await client.storage.migrationSources.delete('');
+   *   await client.storage.migrationSources.retrieve('');
    * ```
    */
-  delete(id: string, options?: RequestOptions): APIPromise<MigrationSourceDeleteResponse> {
-    return this._client.delete(path`/storage/migration_sources/${id}`, options);
+  retrieve(id: string, options?: RequestOptions): APIPromise<MigrationSourceRetrieveResponse> {
+    return this._client.get(path`/storage/migration_sources/${id}`, options);
   }
 }
 

package/src/resources/storage/migrations/migrations.ts

@@ -14,6 +14,18 @@ import { path } from '../../../internal/utils/path';
 export class Migrations extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
+  /**
+   * List all Migrations
+   *
+   * @example
+   * ```ts
+   * const migrations = await client.storage.migrations.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<MigrationListResponse> {
+    return this._client.get('/storage/migrations', options);
+  }
+
   /**
    * Initiate a migration of data from an external provider into Telnyx Cloud
    * Storage. Currently, only S3 is supported.
@@ -44,18 +56,6 @@ export class Migrations extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<MigrationRetrieveResponse> {
     return this._client.get(path`/storage/migrations/${id}`, options);
   }
-
-  /**
-   * List all Migrations
-   *
-   * @example
-   * ```ts
-   * const migrations = await client.storage.migrations.list();
-   * ```
-   */
-  list(options?: RequestOptions): APIPromise<MigrationListResponse> {
-    return this._client.get('/storage/migrations', options);
-  }
 }
 
 export interface MigrationParams {

package/src/resources/storage/storage.ts

@@ -14,6 +14,15 @@ import {
 import * as BucketsAPI from './buckets/buckets';
 import { BucketCreatePresignedURLParams, BucketCreatePresignedURLResponse, Buckets } from './buckets/buckets';
 import * as UsageAPI from './buckets/usage';
+import * as KvsAPI from './kvs/kvs';
+import {
+  KvCreateParams,
+  KvListParams,
+  KvNamespace,
+  KvNamespaceResponseWrapper,
+  KvNamespacesDefaultFlatPagination,
+  Kvs,
+} from './kvs/kvs';
 import * as MigrationsAPI from './migrations/migrations';
 import {
   MigrationCreateParams,
@@ -35,6 +44,7 @@ export class Storage extends APIResource {
     this._client,
   );
   migrations: MigrationsAPI.Migrations = new MigrationsAPI.Migrations(this._client);
+  kvs: KvsAPI.Kvs = new KvsAPI.Kvs(this._client);
 
   /**
    * List Migration Source coverage
@@ -75,6 +85,7 @@ export namespace StorageListMigrationSourceCoverageResponse {
 Storage.Buckets = Buckets;
 Storage.MigrationSources = MigrationSources;
 Storage.Migrations = Migrations;
+Storage.Kvs = Kvs;
 
 export declare namespace Storage {
   export { type StorageListMigrationSourceCoverageResponse as StorageListMigrationSourceCoverageResponse };
@@ -103,4 +114,13 @@ export declare namespace Storage {
     type MigrationListResponse as MigrationListResponse,
     type MigrationCreateParams as MigrationCreateParams,
   };
+
+  export {
+    Kvs as Kvs,
+    type KvNamespace as KvNamespace,
+    type KvNamespaceResponseWrapper as KvNamespaceResponseWrapper,
+    type KvNamespacesDefaultFlatPagination as KvNamespacesDefaultFlatPagination,
+    type KvListParams as KvListParams,
+    type KvCreateParams as KvCreateParams,
+  };
 }

package/src/resources/sub-number-orders.ts

@@ -8,6 +8,44 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class SubNumberOrders extends APIResource {
+  /**
+   * Get a paginated list of sub number orders.
+   *
+   * @example
+   * ```ts
+   * const subNumberOrders = await client.subNumberOrders.list();
+   * ```
+   */
+  list(
+    query: SubNumberOrderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<SubNumberOrderListResponse> {
+    return this._client.get('/sub_number_orders', { query, ...options });
+  }
+
+  /**
+   * Update requirement group for a sub number order
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.subNumberOrders.updateRequirementGroup(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       requirement_group_id:
+   *         'a4b201f9-8646-4e54-a7d2-b2e403eeaf8c',
+   *     },
+   *   );
+   * ```
+   */
+  updateRequirementGroup(
+    id: string,
+    body: SubNumberOrderUpdateRequirementGroupParams,
+    options?: RequestOptions,
+  ): APIPromise<SubNumberOrderUpdateRequirementGroupResponse> {
+    return this._client.post(path`/sub_number_orders/${id}/requirement_group`, { body, ...options });
+  }
+
   /**
    * Get an existing sub number order.
    *
@@ -45,21 +83,6 @@ export class SubNumberOrders extends APIResource {
     return this._client.patch(path`/sub_number_orders/${subNumberOrderID}`, { body, ...options });
   }
 
-  /**
-   * Get a paginated list of sub number orders.
-   *
-   * @example
-   * ```ts
-   * const subNumberOrders = await client.subNumberOrders.list();
-   * ```
-   */
-  list(
-    query: SubNumberOrderListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<SubNumberOrderListResponse> {
-    return this._client.get('/sub_number_orders', { query, ...options });
-  }
-
   /**
    * Allows you to cancel a sub number order in 'pending' status.
    *
@@ -73,29 +96,6 @@ export class SubNumberOrders extends APIResource {
   cancel(subNumberOrderID: string, options?: RequestOptions): APIPromise<SubNumberOrderCancelResponse> {
     return this._client.patch(path`/sub_number_orders/${subNumberOrderID}/cancel`, options);
   }
-
-  /**
-   * Update requirement group for a sub number order
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.subNumberOrders.updateRequirementGroup(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *     {
-   *       requirement_group_id:
-   *         'a4b201f9-8646-4e54-a7d2-b2e403eeaf8c',
-   *     },
-   *   );
-   * ```
-   */
-  updateRequirementGroup(
-    id: string,
-    body: SubNumberOrderUpdateRequirementGroupParams,
-    options?: RequestOptions,
-  ): APIPromise<SubNumberOrderUpdateRequirementGroupResponse> {
-    return this._client.post(path`/sub_number_orders/${id}/requirement_group`, { body, ...options });
-  }
 }
 
 export interface SubNumberOrder {
@@ -258,31 +258,6 @@ export namespace SubNumberOrderUpdateRequirementGroupResponse {
   }
 }
 
-export interface SubNumberOrderRetrieveParams {
-  /**
-   * Consolidated filter parameter (deepObject style). Originally:
-   * filter[include_phone_numbers]
-   */
-  filter?: SubNumberOrderRetrieveParams.Filter;
-}
-
-export namespace SubNumberOrderRetrieveParams {
-  /**
-   * Consolidated filter parameter (deepObject style). Originally:
-   * filter[include_phone_numbers]
-   */
-  export interface Filter {
-    /**
-     * Include the first 50 phone number objects in the results
-     */
-    include_phone_numbers?: boolean;
-  }
-}
-
-export interface SubNumberOrderUpdateParams {
-  regulatory_requirements?: Array<NumberOrderPhoneNumbersAPI.UpdateRegulatoryRequirement>;
-}
-
 export interface SubNumberOrderListParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[status],
@@ -333,6 +308,31 @@ export interface SubNumberOrderUpdateRequirementGroupParams {
   requirement_group_id: string;
 }
 
+export interface SubNumberOrderRetrieveParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally:
+   * filter[include_phone_numbers]
+   */
+  filter?: SubNumberOrderRetrieveParams.Filter;
+}
+
+export namespace SubNumberOrderRetrieveParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally:
+   * filter[include_phone_numbers]
+   */
+  export interface Filter {
+    /**
+     * Include the first 50 phone number objects in the results
+     */
+    include_phone_numbers?: boolean;
+  }
+}
+
+export interface SubNumberOrderUpdateParams {
+  regulatory_requirements?: Array<NumberOrderPhoneNumbersAPI.UpdateRegulatoryRequirement>;
+}
+
 export declare namespace SubNumberOrders {
   export {
     type SubNumberOrder as SubNumberOrder,
@@ -342,9 +342,9 @@ export declare namespace SubNumberOrders {
     type SubNumberOrderListResponse as SubNumberOrderListResponse,
     type SubNumberOrderCancelResponse as SubNumberOrderCancelResponse,
     type SubNumberOrderUpdateRequirementGroupResponse as SubNumberOrderUpdateRequirementGroupResponse,
-    type SubNumberOrderRetrieveParams as SubNumberOrderRetrieveParams,
-    type SubNumberOrderUpdateParams as SubNumberOrderUpdateParams,
     type SubNumberOrderListParams as SubNumberOrderListParams,
     type SubNumberOrderUpdateRequirementGroupParams as SubNumberOrderUpdateRequirementGroupParams,
+    type SubNumberOrderRetrieveParams as SubNumberOrderRetrieveParams,
+    type SubNumberOrderUpdateParams as SubNumberOrderUpdateParams,
   };
 }

package/src/resources/telephony-credentials.ts

@@ -8,6 +8,27 @@ import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 export class TelephonyCredentials extends APIResource {
+  /**
+   * List all On-demand Credentials.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const telephonyCredential of client.telephonyCredentials.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: TelephonyCredentialListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<TelephonyCredentialsDefaultFlatPagination, TelephonyCredential> {
+    return this._client.getAPIList('/telephony_credentials', DefaultFlatPagination<TelephonyCredential>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Create a credential.
    *
@@ -26,6 +47,19 @@ export class TelephonyCredentials extends APIResource {
     return this._client.post('/telephony_credentials', { body, ...options });
   }
 
+  /**
+   * Delete an existing credential.
+   *
+   * @example
+   * ```ts
+   * const telephonyCredential =
+   *   await client.telephonyCredentials.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<TelephonyCredentialDeleteResponse> {
+    return this._client.delete(path`/telephony_credentials/${id}`, options);
+  }
+
   /**
    * Get the details of an existing On-demand Credential.
    *
@@ -56,40 +90,6 @@ export class TelephonyCredentials extends APIResource {
     return this._client.patch(path`/telephony_credentials/${id}`, { body, ...options });
   }
 
-  /**
-   * List all On-demand Credentials.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const telephonyCredential of client.telephonyCredentials.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: TelephonyCredentialListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<TelephonyCredentialsDefaultFlatPagination, TelephonyCredential> {
-    return this._client.getAPIList('/telephony_credentials', DefaultFlatPagination<TelephonyCredential>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Delete an existing credential.
-   *
-   * @example
-   * ```ts
-   * const telephonyCredential =
-   *   await client.telephonyCredentials.delete('id');
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<TelephonyCredentialDeleteResponse> {
-    return this._client.delete(path`/telephony_credentials/${id}`, options);
-  }
-
   /**
    * Create an Access Token (JWT) for the credential.
    *
@@ -181,44 +181,6 @@ export interface TelephonyCredentialDeleteResponse {
 
 export type TelephonyCredentialCreateTokenResponse = string;
 
-export interface TelephonyCredentialCreateParams {
-  /**
-   * Identifies the Credential Connection this credential is associated with.
-   */
-  connection_id: string;
-
-  /**
-   * ISO-8601 formatted date indicating when the credential will expire.
-   */
-  expires_at?: string;
-
-  name?: string;
-
-  /**
-   * Tags a credential. A single tag can hold at maximum 1000 credentials.
-   */
-  tag?: string;
-}
-
-export interface TelephonyCredentialUpdateParams {
-  /**
-   * Identifies the Credential Connection this credential is associated with.
-   */
-  connection_id?: string;
-
-  /**
-   * ISO-8601 formatted date indicating when the credential will expire.
-   */
-  expires_at?: string;
-
-  name?: string;
-
-  /**
-   * Tags a credential. A single tag can hold at maximum 1000 credentials.
-   */
-  tag?: string;
-}
-
 export interface TelephonyCredentialListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[tag],
@@ -260,6 +222,44 @@ export namespace TelephonyCredentialListParams {
   }
 }
 
+export interface TelephonyCredentialCreateParams {
+  /**
+   * Identifies the Credential Connection this credential is associated with.
+   */
+  connection_id: string;
+
+  /**
+   * ISO-8601 formatted date indicating when the credential will expire.
+   */
+  expires_at?: string;
+
+  name?: string;
+
+  /**
+   * Tags a credential. A single tag can hold at maximum 1000 credentials.
+   */
+  tag?: string;
+}
+
+export interface TelephonyCredentialUpdateParams {
+  /**
+   * Identifies the Credential Connection this credential is associated with.
+   */
+  connection_id?: string;
+
+  /**
+   * ISO-8601 formatted date indicating when the credential will expire.
+   */
+  expires_at?: string;
+
+  name?: string;
+
+  /**
+   * Tags a credential. A single tag can hold at maximum 1000 credentials.
+   */
+  tag?: string;
+}
+
 export declare namespace TelephonyCredentials {
   export {
     type TelephonyCredential as TelephonyCredential,
@@ -269,8 +269,8 @@ export declare namespace TelephonyCredentials {
     type TelephonyCredentialDeleteResponse as TelephonyCredentialDeleteResponse,
     type TelephonyCredentialCreateTokenResponse as TelephonyCredentialCreateTokenResponse,
     type TelephonyCredentialsDefaultFlatPagination as TelephonyCredentialsDefaultFlatPagination,
+    type TelephonyCredentialListParams as TelephonyCredentialListParams,
     type TelephonyCredentialCreateParams as TelephonyCredentialCreateParams,
     type TelephonyCredentialUpdateParams as TelephonyCredentialUpdateParams,
-    type TelephonyCredentialListParams as TelephonyCredentialListParams,
   };
 }

package/src/resources/terms-of-service/agreements.ts

@@ -10,14 +10,6 @@ import { path } from '../../internal/utils/path';
  * Accept and review the Branded Calling and Phone Number Reputation terms of service.
  */
 export class Agreements extends APIResource {
-  /**
-   * Retrieve a single ToS agreement record. Returns `404` if the agreement does not
-   * exist or does not belong to the authenticated user.
-   */
-  retrieve(agreementID: string, options?: RequestOptions): APIPromise<TosAgreementWrapped> {
-    return this._client.get(path`/terms_of_service/agreements/${agreementID}`, options);
-  }
-
   /**
    * Returns the Terms of Service agreements the authenticated user has on file. Each
    * entry records the version agreed to and when. Most users only have one agreement
@@ -39,6 +31,14 @@ export class Agreements extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a single ToS agreement record. Returns `404` if the agreement does not
+   * exist or does not belong to the authenticated user.
+   */
+  retrieve(agreementID: string, options?: RequestOptions): APIPromise<TosAgreementWrapped> {
+    return this._client.get(path`/terms_of_service/agreements/${agreementID}`, options);
+  }
 }
 
 export type TosAgreementsDefaultFlatPagination = DefaultFlatPagination<TosAgreement>;

package/src/resources/terms-of-service/index.ts

@@ -14,6 +14,6 @@ export {
   TermsOfService,
   type TermsOfServiceRetrieveInfoResponse,
   type TermsOfServiceRetrieveStatusResponse,
-  type TermsOfServiceRetrieveInfoParams,
   type TermsOfServiceRetrieveStatusParams,
+  type TermsOfServiceRetrieveInfoParams,
 } from './terms-of-service';

package/src/resources/terms-of-service/terms-of-service.ts

@@ -27,18 +27,6 @@ export class TermsOfService extends APIResource {
   agreements: AgreementsAPI.Agreements = new AgreementsAPI.Agreements(this._client);
   brandedCalling: BrandedCallingAPI.BrandedCalling = new BrandedCallingAPI.BrandedCalling(this._client);
 
-  /**
-   * Returns the available Terms of Service agreements (product, current version,
-   * terms URL, effective date). Omit `product_type` to return all products; pass it
-   * to scope to one.
-   */
-  retrieveInfo(
-    query: TermsOfServiceRetrieveInfoParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<TermsOfServiceRetrieveInfoResponse> {
-    return this._client.get('/terms_of_service/info', { query, ...options });
-  }
-
   /**
    * Returns whether the authenticated user has agreed to the current Terms of
    * Service for the product given by `product_type`. Used during onboarding to
@@ -53,6 +41,18 @@ export class TermsOfService extends APIResource {
   ): APIPromise<TermsOfServiceRetrieveStatusResponse> {
     return this._client.get('/terms_of_service/status', { query, ...options });
   }
+
+  /**
+   * Returns the available Terms of Service agreements (product, current version,
+   * terms URL, effective date). Omit `product_type` to return all products; pass it
+   * to scope to one.
+   */
+  retrieveInfo(
+    query: TermsOfServiceRetrieveInfoParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TermsOfServiceRetrieveInfoResponse> {
+    return this._client.get('/terms_of_service/info', { query, ...options });
+  }
 }
 
 export interface TermsOfServiceRetrieveInfoResponse {
@@ -121,16 +121,16 @@ export namespace TermsOfServiceRetrieveStatusResponse {
   }
 }
 
-export interface TermsOfServiceRetrieveInfoParams {
+export interface TermsOfServiceRetrieveStatusParams {
   /**
-   * Optional product filter. Omit to return info for all products.
+   * Which product's ToS to check. Defaults to `branded_calling`.
    */
   product_type?: AgreementsAPI.TosProductType;
 }
 
-export interface TermsOfServiceRetrieveStatusParams {
+export interface TermsOfServiceRetrieveInfoParams {
   /**
-   * Which product's ToS to check. Defaults to `branded_calling`.
+   * Optional product filter. Omit to return info for all products.
    */
   product_type?: AgreementsAPI.TosProductType;
 }
@@ -143,8 +143,8 @@ export declare namespace TermsOfService {
   export {
     type TermsOfServiceRetrieveInfoResponse as TermsOfServiceRetrieveInfoResponse,
     type TermsOfServiceRetrieveStatusResponse as TermsOfServiceRetrieveStatusResponse,
-    type TermsOfServiceRetrieveInfoParams as TermsOfServiceRetrieveInfoParams,
     type TermsOfServiceRetrieveStatusParams as TermsOfServiceRetrieveStatusParams,
+    type TermsOfServiceRetrieveInfoParams as TermsOfServiceRetrieveInfoParams,
   };
 
   export { NumberReputation as NumberReputation };

package/src/resources/texml/accounts/accounts.ts

@@ -252,10 +252,10 @@ export declare namespace Accounts {
     type CallRetrieveCallsResponse as CallRetrieveCallsResponse,
     type CallSiprecJsonResponse as CallSiprecJsonResponse,
     type CallStreamsJsonResponse as CallStreamsJsonResponse,
+    type CallRetrieveCallsParams as CallRetrieveCallsParams,
+    type CallCallsParams as CallCallsParams,
     type CallRetrieveParams as CallRetrieveParams,
     type CallUpdateParams as CallUpdateParams,
-    type CallCallsParams as CallCallsParams,
-    type CallRetrieveCallsParams as CallRetrieveCallsParams,
     type CallSiprecJsonParams as CallSiprecJsonParams,
     type CallStreamsJsonParams as CallStreamsJsonParams,
   };
@@ -265,9 +265,9 @@ export declare namespace Accounts {
     type ConferenceResource as ConferenceResource,
     type ConferenceRetrieveConferencesResponse as ConferenceRetrieveConferencesResponse,
     type ConferenceRetrieveRecordingsResponse as ConferenceRetrieveRecordingsResponse,
+    type ConferenceRetrieveConferencesParams as ConferenceRetrieveConferencesParams,
     type ConferenceRetrieveParams as ConferenceRetrieveParams,
     type ConferenceUpdateParams as ConferenceUpdateParams,
-    type ConferenceRetrieveConferencesParams as ConferenceRetrieveConferencesParams,
     type ConferenceRetrieveRecordingsParams as ConferenceRetrieveRecordingsParams,
     type ConferenceRetrieveRecordingsJsonParams as ConferenceRetrieveRecordingsJsonParams,
   };
@@ -281,9 +281,9 @@ export declare namespace Accounts {
     type QueueResource as QueueResource,
     type QueueResourcesDefaultPaginationForQueues as QueueResourcesDefaultPaginationForQueues,
     type QueueCreateParams as QueueCreateParams,
+    type QueueDeleteParams as QueueDeleteParams,
     type QueueRetrieveParams as QueueRetrieveParams,
     type QueueUpdateParams as QueueUpdateParams,
     type QueueListParams as QueueListParams,
-    type QueueDeleteParams as QueueDeleteParams,
   };
 }