telnyx 7.3.0 → 7.5.0

package/src/resources/requirement-groups.ts

@@ -9,6 +9,22 @@ import { path } from '../internal/utils/path';
  * Requirement Groups
  */
 export class RequirementGroups extends APIResource {
+  /**
+   * List requirement groups
+   *
+   * @example
+   * ```ts
+   * const requirementGroups =
+   *   await client.requirementGroups.list();
+   * ```
+   */
+  list(
+    query: RequirementGroupListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RequirementGroupListResponse> {
+    return this._client.get('/requirement_groups', { query, ...options });
+  }
+
   /**
    * Create a new requirement group
    *
@@ -26,6 +42,19 @@ export class RequirementGroups extends APIResource {
     return this._client.post('/requirement_groups', { body, ...options });
   }
 
+  /**
+   * Delete a requirement group by ID
+   *
+   * @example
+   * ```ts
+   * const requirementGroup =
+   *   await client.requirementGroups.delete('id');
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<RequirementGroup> {
+    return this._client.delete(path`/requirement_groups/${id}`, options);
+  }
+
   /**
    * Get a single requirement group by ID
    *
@@ -56,35 +85,6 @@ export class RequirementGroups extends APIResource {
     return this._client.patch(path`/requirement_groups/${id}`, { body, ...options });
   }
 
-  /**
-   * List requirement groups
-   *
-   * @example
-   * ```ts
-   * const requirementGroups =
-   *   await client.requirementGroups.list();
-   * ```
-   */
-  list(
-    query: RequirementGroupListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<RequirementGroupListResponse> {
-    return this._client.get('/requirement_groups', { query, ...options });
-  }
-
-  /**
-   * Delete a requirement group by ID
-   *
-   * @example
-   * ```ts
-   * const requirementGroup =
-   *   await client.requirementGroups.delete('id');
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<RequirementGroup> {
-    return this._client.delete(path`/requirement_groups/${id}`, options);
-  }
-
   /**
    * Submit a Requirement Group for Approval
    *
@@ -139,6 +139,49 @@ export interface UserRequirement {
 
 export type RequirementGroupListResponse = Array<RequirementGroup>;
 
+export interface RequirementGroupListParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally:
+   * filter[country_code], filter[phone_number_type], filter[action], filter[status],
+   * filter[customer_reference]
+   */
+  filter?: RequirementGroupListParams.Filter;
+}
+
+export namespace RequirementGroupListParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally:
+   * filter[country_code], filter[phone_number_type], filter[action], filter[status],
+   * filter[customer_reference]
+   */
+  export interface Filter {
+    /**
+     * Filter requirement groups by action type
+     */
+    action?: 'ordering' | 'porting' | 'action';
+
+    /**
+     * Filter requirement groups by country code (iso alpha 2)
+     */
+    country_code?: string;
+
+    /**
+     * Filter requirement groups by customer reference
+     */
+    customer_reference?: string;
+
+    /**
+     * Filter requirement groups by phone number type.
+     */
+    phone_number_type?: 'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost';
+
+    /**
+     * Filter requirement groups by status
+     */
+    status?: 'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired';
+  }
+}
+
 export interface RequirementGroupCreateParams {
   action: 'ordering' | 'porting';
 
@@ -185,56 +228,13 @@ export namespace RequirementGroupUpdateParams {
   }
 }
 
-export interface RequirementGroupListParams {
-  /**
-   * Consolidated filter parameter (deepObject style). Originally:
-   * filter[country_code], filter[phone_number_type], filter[action], filter[status],
-   * filter[customer_reference]
-   */
-  filter?: RequirementGroupListParams.Filter;
-}
-
-export namespace RequirementGroupListParams {
-  /**
-   * Consolidated filter parameter (deepObject style). Originally:
-   * filter[country_code], filter[phone_number_type], filter[action], filter[status],
-   * filter[customer_reference]
-   */
-  export interface Filter {
-    /**
-     * Filter requirement groups by action type
-     */
-    action?: 'ordering' | 'porting' | 'action';
-
-    /**
-     * Filter requirement groups by country code (iso alpha 2)
-     */
-    country_code?: string;
-
-    /**
-     * Filter requirement groups by customer reference
-     */
-    customer_reference?: string;
-
-    /**
-     * Filter requirement groups by phone number type.
-     */
-    phone_number_type?: 'local' | 'toll_free' | 'mobile' | 'national' | 'shared_cost';
-
-    /**
-     * Filter requirement groups by status
-     */
-    status?: 'approved' | 'unapproved' | 'pending-approval' | 'declined' | 'expired';
-  }
-}
-
 export declare namespace RequirementGroups {
   export {
     type RequirementGroup as RequirementGroup,
     type UserRequirement as UserRequirement,
     type RequirementGroupListResponse as RequirementGroupListResponse,
+    type RequirementGroupListParams as RequirementGroupListParams,
     type RequirementGroupCreateParams as RequirementGroupCreateParams,
     type RequirementGroupUpdateParams as RequirementGroupUpdateParams,
-    type RequirementGroupListParams as RequirementGroupListParams,
   };
 }

package/src/resources/requirement-types.ts

@@ -11,21 +11,6 @@ import { path } from '../internal/utils/path';
  * Types of requirements for international numbers and porting orders
  */
 export class RequirementTypes extends APIResource {
-  /**
-   * Retrieve a requirement type by id
-   *
-   * @example
-   * ```ts
-   * const requirementType =
-   *   await client.requirementTypes.retrieve(
-   *     'a38c217a-8019-48f8-bff6-0fdd9939075b',
-   *   );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<RequirementTypeRetrieveResponse> {
-    return this._client.get(path`/requirement_types/${id}`, options);
-  }
-
   /**
    * List all requirement types ordered by created_at descending
    *
@@ -41,6 +26,21 @@ export class RequirementTypes extends APIResource {
   ): APIPromise<RequirementTypeListResponse> {
     return this._client.get('/requirement_types', { query, ...options });
   }
+
+  /**
+   * Retrieve a requirement type by id
+   *
+   * @example
+   * ```ts
+   * const requirementType =
+   *   await client.requirementTypes.retrieve(
+   *     'a38c217a-8019-48f8-bff6-0fdd9939075b',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<RequirementTypeRetrieveResponse> {
+    return this._client.get(path`/requirement_types/${id}`, options);
+  }
 }
 
 export interface RequirementTypeRetrieveResponse {

package/src/resources/requirements.ts

@@ -11,20 +11,6 @@ import { path } from '../internal/utils/path';
  * Requirements for international numbers and porting orders
  */
 export class Requirements extends APIResource {
-  /**
-   * Retrieve a document requirement record
-   *
-   * @example
-   * ```ts
-   * const requirement = await client.requirements.retrieve(
-   *   'a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<RequirementRetrieveResponse> {
-    return this._client.get(path`/requirements/${id}`, options);
-  }
-
   /**
    * List all requirements with filtering, sorting, and pagination
    *
@@ -45,6 +31,20 @@ export class Requirements extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * Retrieve a document requirement record
+   *
+   * @example
+   * ```ts
+   * const requirement = await client.requirements.retrieve(
+   *   'a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<RequirementRetrieveResponse> {
+    return this._client.get(path`/requirements/${id}`, options);
+  }
 }
 
 export type DocReqsRequirementsDefaultFlatPagination = DefaultFlatPagination<DocReqsRequirement>;

package/src/resources/room-compositions.ts

@@ -11,37 +11,6 @@ import { path } from '../internal/utils/path';
  * Rooms Compositions operations.
  */
 export class RoomCompositions extends APIResource {
-  /**
-   * Asynchronously create a room composition.
-   *
-   * @example
-   * ```ts
-   * const roomComposition =
-   *   await client.roomCompositions.create();
-   * ```
-   */
-  create(
-    body: RoomCompositionCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<RoomCompositionCreateResponse> {
-    return this._client.post('/room_compositions', { body, ...options });
-  }
-
-  /**
-   * View a room composition.
-   *
-   * @example
-   * ```ts
-   * const roomComposition =
-   *   await client.roomCompositions.retrieve(
-   *     '5219b3af-87c6-4c08-9b58-5a533d893e21',
-   *   );
-   * ```
-   */
-  retrieve(roomCompositionID: string, options?: RequestOptions): APIPromise<RoomCompositionRetrieveResponse> {
-    return this._client.get(path`/room_compositions/${roomCompositionID}`, options);
-  }
-
   /**
    * View a list of room compositions.
    *
@@ -63,6 +32,22 @@ export class RoomCompositions extends APIResource {
     });
   }
 
+  /**
+   * Asynchronously create a room composition.
+   *
+   * @example
+   * ```ts
+   * const roomComposition =
+   *   await client.roomCompositions.create();
+   * ```
+   */
+  create(
+    body: RoomCompositionCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<RoomCompositionCreateResponse> {
+    return this._client.post('/room_compositions', { body, ...options });
+  }
+
   /**
    * Synchronously delete a room composition.
    *
@@ -79,6 +64,21 @@ export class RoomCompositions extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * View a room composition.
+   *
+   * @example
+   * ```ts
+   * const roomComposition =
+   *   await client.roomCompositions.retrieve(
+   *     '5219b3af-87c6-4c08-9b58-5a533d893e21',
+   *   );
+   * ```
+   */
+  retrieve(roomCompositionID: string, options?: RequestOptions): APIPromise<RoomCompositionRetrieveResponse> {
+    return this._client.get(path`/room_compositions/${roomCompositionID}`, options);
+  }
 }
 
 export type RoomCompositionsDefaultFlatPagination = DefaultFlatPagination<RoomComposition>;
@@ -241,47 +241,6 @@ export interface RoomCompositionRetrieveResponse {
   data?: RoomComposition;
 }
 
-export interface RoomCompositionCreateParams {
-  /**
-   * The desired format of the room composition.
-   */
-  format?: string;
-
-  /**
-   * The desired resolution (width/height in pixels) of the resulting video of the
-   * room composition. Both width and height are required to be between 16 and 1280;
-   * and width _ height should not exceed 1280 _ 720
-   */
-  resolution?: string;
-
-  /**
-   * id of the room session associated with the room composition.
-   */
-  session_id?: string;
-
-  /**
-   * Describes the video layout of the room composition in terms of regions.
-   */
-  video_layout?: { [key: string]: VideoRegion };
-
-  /**
-   * The failover URL where webhooks related to this room composition will be sent if
-   * sending to the primary URL fails. Must include a scheme, such as 'https'.
-   */
-  webhook_event_failover_url?: string;
-
-  /**
-   * The URL where webhooks related to this room composition will be sent. Must
-   * include a scheme, such as 'https'.
-   */
-  webhook_event_url?: string;
-
-  /**
-   * Specifies how many seconds to wait before timing out a webhook.
-   */
-  webhook_timeout_secs?: number;
-}
-
 export interface RoomCompositionListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -331,6 +290,47 @@ export namespace RoomCompositionListParams {
   }
 }
 
+export interface RoomCompositionCreateParams {
+  /**
+   * The desired format of the room composition.
+   */
+  format?: string;
+
+  /**
+   * The desired resolution (width/height in pixels) of the resulting video of the
+   * room composition. Both width and height are required to be between 16 and 1280;
+   * and width _ height should not exceed 1280 _ 720
+   */
+  resolution?: string;
+
+  /**
+   * id of the room session associated with the room composition.
+   */
+  session_id?: string;
+
+  /**
+   * Describes the video layout of the room composition in terms of regions.
+   */
+  video_layout?: { [key: string]: VideoRegion };
+
+  /**
+   * The failover URL where webhooks related to this room composition will be sent if
+   * sending to the primary URL fails. Must include a scheme, such as 'https'.
+   */
+  webhook_event_failover_url?: string;
+
+  /**
+   * The URL where webhooks related to this room composition will be sent. Must
+   * include a scheme, such as 'https'.
+   */
+  webhook_event_url?: string;
+
+  /**
+   * Specifies how many seconds to wait before timing out a webhook.
+   */
+  webhook_timeout_secs?: number;
+}
+
 export declare namespace RoomCompositions {
   export {
     type RoomComposition as RoomComposition,
@@ -338,7 +338,7 @@ export declare namespace RoomCompositions {
     type RoomCompositionCreateResponse as RoomCompositionCreateResponse,
     type RoomCompositionRetrieveResponse as RoomCompositionRetrieveResponse,
     type RoomCompositionsDefaultFlatPagination as RoomCompositionsDefaultFlatPagination,
-    type RoomCompositionCreateParams as RoomCompositionCreateParams,
     type RoomCompositionListParams as RoomCompositionListParams,
+    type RoomCompositionCreateParams as RoomCompositionCreateParams,
   };
 }

package/src/resources/room-participants.ts

@@ -12,13 +12,6 @@ import { path } from '../internal/utils/path';
  * Rooms Participants operations.
  */
 export class RoomParticipants extends APIResource {
-  /**
-   * View a room participant.
-   */
-  retrieve(roomParticipantID: string, options?: RequestOptions): APIPromise<RoomParticipantRetrieveResponse> {
-    return this._client.get(path`/room_participants/${roomParticipantID}`, options);
-  }
-
   /**
    * View a list of room participants.
    */
@@ -31,6 +24,13 @@ export class RoomParticipants extends APIResource {
       ...options,
     });
   }
+
+  /**
+   * View a room participant.
+   */
+  retrieve(roomParticipantID: string, options?: RequestOptions): APIPromise<RoomParticipantRetrieveResponse> {
+    return this._client.get(path`/room_participants/${roomParticipantID}`, options);
+  }
 }
 
 export interface RoomParticipantRetrieveResponse {

package/src/resources/room-recordings.ts

@@ -12,10 +12,17 @@ import { path } from '../internal/utils/path';
  */
 export class RoomRecordings extends APIResource {
   /**
-   * View a room recording.
+   * Delete several room recordings in a bulk.
    */
-  retrieve(roomRecordingID: string, options?: RequestOptions): APIPromise<RoomRecordingRetrieveResponse> {
-    return this._client.get(path`/room_recordings/${roomRecordingID}`, options);
+  deleteBulk(
+    params: RoomRecordingDeleteBulkParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RoomRecordingDeleteBulkResponse> {
+    const { filter, 'page[number]': pageNumber, 'page[size]': pageSize } = params ?? {};
+    return this._client.delete('/room_recordings', {
+      query: { filter, 'page[number]': pageNumber, 'page[size]': pageSize },
+      ...options,
+    });
   }
 
   /**
@@ -42,17 +49,10 @@ export class RoomRecordings extends APIResource {
   }
 
   /**
-   * Delete several room recordings in a bulk.
+   * View a room recording.
    */
-  deleteBulk(
-    params: RoomRecordingDeleteBulkParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<RoomRecordingDeleteBulkResponse> {
-    const { filter, 'page[number]': pageNumber, 'page[size]': pageSize } = params ?? {};
-    return this._client.delete('/room_recordings', {
-      query: { filter, 'page[number]': pageNumber, 'page[size]': pageSize },
-      ...options,
-    });
+  retrieve(roomRecordingID: string, options?: RequestOptions): APIPromise<RoomRecordingRetrieveResponse> {
+    return this._client.get(path`/room_recordings/${roomRecordingID}`, options);
   }
 }
 
@@ -154,7 +154,7 @@ export namespace RoomRecordingDeleteBulkResponse {
   }
 }
 
-export interface RoomRecordingListParams extends DefaultFlatPaginationParams {
+export interface RoomRecordingDeleteBulkParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
    * filter[date_ended_at][eq], filter[date_ended_at][gte],
@@ -163,10 +163,14 @@ export interface RoomRecordingListParams extends DefaultFlatPaginationParams {
    * filter[participant_id], filter[session_id], filter[status], filter[type],
    * filter[duration_secs]
    */
-  filter?: RoomRecordingListParams.Filter;
+  filter?: RoomRecordingDeleteBulkParams.Filter;
+
+  'page[number]'?: number;
+
+  'page[size]'?: number;
 }
 
-export namespace RoomRecordingListParams {
+export namespace RoomRecordingDeleteBulkParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
    * filter[date_ended_at][eq], filter[date_ended_at][gte],
@@ -248,7 +252,7 @@ export namespace RoomRecordingListParams {
   }
 }
 
-export interface RoomRecordingDeleteBulkParams {
+export interface RoomRecordingListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
    * filter[date_ended_at][eq], filter[date_ended_at][gte],
@@ -257,14 +261,10 @@ export interface RoomRecordingDeleteBulkParams {
    * filter[participant_id], filter[session_id], filter[status], filter[type],
    * filter[duration_secs]
    */
-  filter?: RoomRecordingDeleteBulkParams.Filter;
-
-  'page[number]'?: number;
-
-  'page[size]'?: number;
+  filter?: RoomRecordingListParams.Filter;
 }
 
-export namespace RoomRecordingDeleteBulkParams {
+export namespace RoomRecordingListParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
    * filter[date_ended_at][eq], filter[date_ended_at][gte],
@@ -352,7 +352,7 @@ export declare namespace RoomRecordings {
     type RoomRecordingRetrieveResponse as RoomRecordingRetrieveResponse,
     type RoomRecordingDeleteBulkResponse as RoomRecordingDeleteBulkResponse,
     type RoomRecordingsDefaultFlatPagination as RoomRecordingsDefaultFlatPagination,
-    type RoomRecordingListParams as RoomRecordingListParams,
     type RoomRecordingDeleteBulkParams as RoomRecordingDeleteBulkParams,
+    type RoomRecordingListParams as RoomRecordingListParams,
   };
 }

package/src/resources/rooms/index.ts

@@ -14,18 +14,18 @@ export {
   type RoomCreateResponse,
   type RoomRetrieveResponse,
   type RoomUpdateResponse,
+  type RoomListParams,
   type RoomCreateParams,
   type RoomRetrieveParams,
   type RoomUpdateParams,
-  type RoomListParams,
   type RoomSessionsDefaultFlatPagination,
   type RoomsDefaultFlatPagination,
 } from './rooms';
 export {
   Sessions,
   type SessionRetrieveResponse,
-  type SessionRetrieveParams,
   type SessionList0Params,
   type SessionList1Params,
+  type SessionRetrieveParams,
   type SessionRetrieveParticipantsParams,
 } from './sessions/index';