telnyx 7.3.0 → 7.6.0

package/src/resources/sim-card-groups/sim-card-groups.ts

@@ -26,6 +26,27 @@ import { path } from '../../internal/utils/path';
 export class SimCardGroups extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
+  /**
+   * Get all SIM card groups belonging to the user that match the given filters.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const simCardGroupListResponse of client.simCardGroups.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SimCardGroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SimCardGroupListResponsesDefaultFlatPagination, SimCardGroupListResponse> {
+    return this._client.getAPIList('/sim_card_groups', DefaultFlatPagination<SimCardGroupListResponse>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Creates a new SIM card group object
    *
@@ -40,6 +61,20 @@ export class SimCardGroups extends APIResource {
     return this._client.post('/sim_card_groups', { body, ...options });
   }
 
+  /**
+   * Permanently deletes a SIM card group
+   *
+   * @example
+   * ```ts
+   * const simCardGroup = await client.simCardGroups.delete(
+   *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<SimCardGroupDeleteResponse> {
+    return this._client.delete(path`/sim_card_groups/${id}`, options);
+  }
+
   /**
    * Returns the details regarding a specific SIM card group
    *
@@ -75,41 +110,6 @@ export class SimCardGroups extends APIResource {
   ): APIPromise<SimCardGroupUpdateResponse> {
     return this._client.patch(path`/sim_card_groups/${id}`, { body, ...options });
   }
-
-  /**
-   * Get all SIM card groups belonging to the user that match the given filters.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const simCardGroupListResponse of client.simCardGroups.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: SimCardGroupListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<SimCardGroupListResponsesDefaultFlatPagination, SimCardGroupListResponse> {
-    return this._client.getAPIList('/sim_card_groups', DefaultFlatPagination<SimCardGroupListResponse>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Permanently deletes a SIM card group
-   *
-   * @example
-   * ```ts
-   * const simCardGroup = await client.simCardGroups.delete(
-   *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   * );
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<SimCardGroupDeleteResponse> {
-    return this._client.delete(path`/sim_card_groups/${id}`, options);
-  }
 }
 
 export type SimCardGroupListResponsesDefaultFlatPagination = DefaultFlatPagination<SimCardGroupListResponse>;
@@ -272,6 +272,23 @@ export interface SimCardGroupDeleteResponse {
   data?: SimCardGroup;
 }
 
+export interface SimCardGroupListParams extends DefaultFlatPaginationParams {
+  /**
+   * A valid SIM card group name.
+   */
+  'filter[name]'?: string;
+
+  /**
+   * A Private Wireless Gateway ID associated with the group.
+   */
+  'filter[private_wireless_gateway_id]'?: string;
+
+  /**
+   * A Wireless Blocklist ID associated with the group.
+   */
+  'filter[wireless_blocklist_id]'?: string;
+}
+
 export interface SimCardGroupCreateParams {
   /**
    * A user friendly name for the SIM card group.
@@ -325,23 +342,6 @@ export namespace SimCardGroupUpdateParams {
   }
 }
 
-export interface SimCardGroupListParams extends DefaultFlatPaginationParams {
-  /**
-   * A valid SIM card group name.
-   */
-  'filter[name]'?: string;
-
-  /**
-   * A Private Wireless Gateway ID associated with the group.
-   */
-  'filter[private_wireless_gateway_id]'?: string;
-
-  /**
-   * A Wireless Blocklist ID associated with the group.
-   */
-  'filter[wireless_blocklist_id]'?: string;
-}
-
 SimCardGroups.Actions = Actions;
 
 export declare namespace SimCardGroups {
@@ -354,10 +354,10 @@ export declare namespace SimCardGroups {
     type SimCardGroupListResponse as SimCardGroupListResponse,
     type SimCardGroupDeleteResponse as SimCardGroupDeleteResponse,
     type SimCardGroupListResponsesDefaultFlatPagination as SimCardGroupListResponsesDefaultFlatPagination,
+    type SimCardGroupListParams as SimCardGroupListParams,
     type SimCardGroupCreateParams as SimCardGroupCreateParams,
     type SimCardGroupRetrieveParams as SimCardGroupRetrieveParams,
     type SimCardGroupUpdateParams as SimCardGroupUpdateParams,
-    type SimCardGroupListParams as SimCardGroupListParams,
   };
 
   export {

package/src/resources/sim-card-orders.ts

@@ -10,6 +10,27 @@ import { path } from '../internal/utils/path';
  * SIM Card Orders operations
  */
 export class SimCardOrders extends APIResource {
+  /**
+   * Get all SIM card orders according to filters.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const simCardOrder of client.simCardOrders.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: SimCardOrderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<SimCardOrdersDefaultFlatPagination, SimCardOrder> {
+    return this._client.getAPIList('/sim_card_orders', DefaultFlatPagination<SimCardOrder>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Creates a new order for SIM cards.
    *
@@ -38,27 +59,6 @@ export class SimCardOrders extends APIResource {
   retrieve(id: string, options?: RequestOptions): APIPromise<SimCardOrderRetrieveResponse> {
     return this._client.get(path`/sim_card_orders/${id}`, options);
   }
-
-  /**
-   * Get all SIM card orders according to filters.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const simCardOrder of client.simCardOrders.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: SimCardOrderListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<SimCardOrdersDefaultFlatPagination, SimCardOrder> {
-    return this._client.getAPIList('/sim_card_orders', DefaultFlatPagination<SimCardOrder>, {
-      query,
-      ...options,
-    });
-  }
 }
 
 export type SimCardOrdersDefaultFlatPagination = DefaultFlatPagination<SimCardOrder>;
@@ -199,18 +199,6 @@ export interface SimCardOrderRetrieveResponse {
   data?: SimCardOrder;
 }
 
-export interface SimCardOrderCreateParams {
-  /**
-   * Uniquely identifies the address for the order.
-   */
-  address_id: string;
-
-  /**
-   * The amount of SIM cards to order.
-   */
-  quantity: number;
-}
-
 export interface SimCardOrderListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter for SIM card orders (deepObject style).
@@ -299,13 +287,25 @@ export namespace SimCardOrderListParams {
   }
 }
 
+export interface SimCardOrderCreateParams {
+  /**
+   * Uniquely identifies the address for the order.
+   */
+  address_id: string;
+
+  /**
+   * The amount of SIM cards to order.
+   */
+  quantity: number;
+}
+
 export declare namespace SimCardOrders {
   export {
     type SimCardOrder as SimCardOrder,
     type SimCardOrderCreateResponse as SimCardOrderCreateResponse,
     type SimCardOrderRetrieveResponse as SimCardOrderRetrieveResponse,
     type SimCardOrdersDefaultFlatPagination as SimCardOrdersDefaultFlatPagination,
-    type SimCardOrderCreateParams as SimCardOrderCreateParams,
     type SimCardOrderListParams as SimCardOrderListParams,
+    type SimCardOrderCreateParams as SimCardOrderCreateParams,
   };
 }

package/src/resources/sim-cards/actions.ts

@@ -7,21 +7,6 @@ import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
 export class Actions extends APIResource {
-  /**
-   * This API fetches detailed information about a SIM card action to follow-up on an
-   * existing asynchronous operation.
-   *
-   * @example
-   * ```ts
-   * const action = await client.simCards.actions.retrieve(
-   *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<ActionRetrieveResponse> {
-    return this._client.get(path`/sim_card_actions/${id}`, options);
-  }
-
   /**
    * This API lists a paginated collection of SIM card actions. It enables exploring
    * a collection of existing asynchronous operations using specific filters.
@@ -45,81 +30,56 @@ export class Actions extends APIResource {
   }
 
   /**
-   * This API triggers an asynchronous operation to disable voice on SIM cards
-   * belonging to a specified SIM Card Group.<br/> For each SIM Card a SIM Card
-   * Action will be generated. The status of the SIM Card Actions can be followed
-   * through the
-   * [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
-   * API.
-   *
-   * The overall status of the Bulk SIM Card Action can be followed through the
-   * [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-bulk-sim-card-actions)
-   * API.
+   * This API fetches detailed information about a SIM card action to follow-up on an
+   * existing asynchronous operation.
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.simCards.actions.bulkDisableVoice({
-   *     sim_card_group_id:
-   *       '6b14e151-8493-4fa1-8664-1cc4e6d14158',
-   *   });
+   * const action = await client.simCards.actions.retrieve(
+   *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
+   * );
    * ```
    */
-  bulkDisableVoice(
-    body: ActionBulkDisableVoiceParams,
-    options?: RequestOptions,
-  ): APIPromise<ActionBulkDisableVoiceResponse> {
-    return this._client.post('/sim_cards/actions/bulk_disable_voice', { body, ...options });
+  retrieve(id: string, options?: RequestOptions): APIPromise<ActionRetrieveResponse> {
+    return this._client.get(path`/sim_card_actions/${id}`, options);
   }
 
   /**
-   * This API triggers an asynchronous operation to enable voice on SIM cards
-   * belonging to a specified SIM Card Group.<br/> For each SIM Card a SIM Card
-   * Action will be generated. The status of the SIM Card Actions can be followed
-   * through the
+   * This API triggers an asynchronous operation to set a public IP for each of the
+   * specified SIM cards.<br/> For each SIM Card a SIM Card Action will be generated.
+   * The status of the SIM Card Action can be followed through the
    * [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
    * API.
    *
-   * The overall status of the Bulk SIM Card Action can be followed through the
-   * [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-bulk-sim-card-actions)
-   * API.
-   *
    * @example
    * ```ts
    * const response =
-   *   await client.simCards.actions.bulkEnableVoice({
-   *     sim_card_group_id:
-   *       '6b14e151-8493-4fa1-8664-1cc4e6d14158',
+   *   await client.simCards.actions.bulkSetPublicIPs({
+   *     sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158'],
    *   });
    * ```
    */
-  bulkEnableVoice(
-    body: ActionBulkEnableVoiceParams,
+  bulkSetPublicIPs(
+    body: ActionBulkSetPublicIPsParams,
     options?: RequestOptions,
-  ): APIPromise<ActionBulkEnableVoiceResponse> {
-    return this._client.post('/sim_cards/actions/bulk_enable_voice', { body, ...options });
+  ): APIPromise<ActionBulkSetPublicIPsResponse> {
+    return this._client.post('/sim_cards/actions/bulk_set_public_ips', { body, ...options });
   }
 
   /**
-   * This API triggers an asynchronous operation to set a public IP for each of the
-   * specified SIM cards.<br/> For each SIM Card a SIM Card Action will be generated.
-   * The status of the SIM Card Action can be followed through the
-   * [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
-   * API.
+   * It validates whether SIM card registration codes are valid or not.
    *
    * @example
    * ```ts
    * const response =
-   *   await client.simCards.actions.bulkSetPublicIPs({
-   *     sim_card_ids: ['6b14e151-8493-4fa1-8664-1cc4e6d14158'],
-   *   });
+   *   await client.simCards.actions.validateRegistrationCodes();
    * ```
    */
-  bulkSetPublicIPs(
-    body: ActionBulkSetPublicIPsParams,
+  validateRegistrationCodes(
+    body: ActionValidateRegistrationCodesParams,
     options?: RequestOptions,
-  ): APIPromise<ActionBulkSetPublicIPsResponse> {
-    return this._client.post('/sim_cards/actions/bulk_set_public_ips', { body, ...options });
+  ): APIPromise<ActionValidateRegistrationCodesResponse> {
+    return this._client.post('/sim_cards/actions/validate_registration_codes', { body, ...options });
   }
 
   /**
@@ -230,19 +190,59 @@ export class Actions extends APIResource {
   }
 
   /**
-   * It validates whether SIM card registration codes are valid or not.
+   * This API triggers an asynchronous operation to disable voice on SIM cards
+   * belonging to a specified SIM Card Group.<br/> For each SIM Card a SIM Card
+   * Action will be generated. The status of the SIM Card Actions can be followed
+   * through the
+   * [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
+   * API.
+   *
+   * The overall status of the Bulk SIM Card Action can be followed through the
+   * [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-bulk-sim-card-actions)
+   * API.
    *
    * @example
    * ```ts
    * const response =
-   *   await client.simCards.actions.validateRegistrationCodes();
+   *   await client.simCards.actions.bulkDisableVoice({
+   *     sim_card_group_id:
+   *       '6b14e151-8493-4fa1-8664-1cc4e6d14158',
+   *   });
    * ```
    */
-  validateRegistrationCodes(
-    body: ActionValidateRegistrationCodesParams,
+  bulkDisableVoice(
+    body: ActionBulkDisableVoiceParams,
     options?: RequestOptions,
-  ): APIPromise<ActionValidateRegistrationCodesResponse> {
-    return this._client.post('/sim_cards/actions/validate_registration_codes', { body, ...options });
+  ): APIPromise<ActionBulkDisableVoiceResponse> {
+    return this._client.post('/sim_cards/actions/bulk_disable_voice', { body, ...options });
+  }
+
+  /**
+   * This API triggers an asynchronous operation to enable voice on SIM cards
+   * belonging to a specified SIM Card Group.<br/> For each SIM Card a SIM Card
+   * Action will be generated. The status of the SIM Card Actions can be followed
+   * through the
+   * [List SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-sim-card-actions)
+   * API.
+   *
+   * The overall status of the Bulk SIM Card Action can be followed through the
+   * [List Bulk SIM Card Action](https://developers.telnyx.com/api-reference/sim-card-actions/list-bulk-sim-card-actions)
+   * API.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.simCards.actions.bulkEnableVoice({
+   *     sim_card_group_id:
+   *       '6b14e151-8493-4fa1-8664-1cc4e6d14158',
+   *   });
+   * ```
+   */
+  bulkEnableVoice(
+    body: ActionBulkEnableVoiceParams,
+    options?: RequestOptions,
+  ): APIPromise<ActionBulkEnableVoiceResponse> {
+    return this._client.post('/sim_cards/actions/bulk_enable_voice', { body, ...options });
   }
 }
 
@@ -492,18 +492,14 @@ export namespace ActionListParams {
   }
 }
 
-export interface ActionBulkDisableVoiceParams {
-  sim_card_group_id: string;
-}
-
-export interface ActionBulkEnableVoiceParams {
-  sim_card_group_id: string;
-}
-
 export interface ActionBulkSetPublicIPsParams {
   sim_card_ids: Array<string>;
 }
 
+export interface ActionValidateRegistrationCodesParams {
+  registration_codes?: Array<string>;
+}
+
 export interface ActionSetPublicIPParams {
   /**
    * The code of the region where the public IP should be assigned. A list of
@@ -512,8 +508,12 @@ export interface ActionSetPublicIPParams {
   region_code?: string;
 }
 
-export interface ActionValidateRegistrationCodesParams {
-  registration_codes?: Array<string>;
+export interface ActionBulkDisableVoiceParams {
+  sim_card_group_id: string;
+}
+
+export interface ActionBulkEnableVoiceParams {
+  sim_card_group_id: string;
 }
 
 export declare namespace Actions {
@@ -532,10 +532,10 @@ export declare namespace Actions {
     type ActionValidateRegistrationCodesResponse as ActionValidateRegistrationCodesResponse,
     type SimCardActionsDefaultFlatPagination as SimCardActionsDefaultFlatPagination,
     type ActionListParams as ActionListParams,
-    type ActionBulkDisableVoiceParams as ActionBulkDisableVoiceParams,
-    type ActionBulkEnableVoiceParams as ActionBulkEnableVoiceParams,
     type ActionBulkSetPublicIPsParams as ActionBulkSetPublicIPsParams,
-    type ActionSetPublicIPParams as ActionSetPublicIPParams,
     type ActionValidateRegistrationCodesParams as ActionValidateRegistrationCodesParams,
+    type ActionSetPublicIPParams as ActionSetPublicIPParams,
+    type ActionBulkDisableVoiceParams as ActionBulkDisableVoiceParams,
+    type ActionBulkEnableVoiceParams as ActionBulkEnableVoiceParams,
   };
 }

package/src/resources/sim-cards/index.ts

@@ -15,11 +15,11 @@ export {
   type ActionSetStandbyResponse,
   type ActionValidateRegistrationCodesResponse,
   type ActionListParams,
-  type ActionBulkDisableVoiceParams,
-  type ActionBulkEnableVoiceParams,
   type ActionBulkSetPublicIPsParams,
-  type ActionSetPublicIPParams,
   type ActionValidateRegistrationCodesParams,
+  type ActionSetPublicIPParams,
+  type ActionBulkDisableVoiceParams,
+  type ActionBulkEnableVoiceParams,
   type SimCardActionsDefaultFlatPagination,
 } from './actions';
 export {
@@ -32,10 +32,10 @@ export {
   type SimCardGetDeviceDetailsResponse,
   type SimCardGetPublicIPResponse,
   type SimCardListWirelessConnectivityLogsResponse,
-  type SimCardRetrieveParams,
-  type SimCardUpdateParams,
   type SimCardListParams,
   type SimCardDeleteParams,
+  type SimCardRetrieveParams,
+  type SimCardUpdateParams,
   type SimCardListWirelessConnectivityLogsParams,
   type SimCardListWirelessConnectivityLogsResponsesDefaultFlatPagination,
 } from './sim-cards';