telnyx 7.3.0 → 7.5.0

package/src/resources/queues/calls.ts

@@ -11,6 +11,30 @@ import { path } from '../../internal/utils/path';
  * Queue commands operations
  */
 export class Calls extends APIResource {
+  /**
+   * Retrieve the list of calls in an existing queue
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const queueCall of client.queues.calls.list(
+   *   'queue_name',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    queueName: string,
+    query: CallListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<QueueCallsDefaultFlatPagination, QueueCall> {
+    return this._client.getAPIList(path`/queues/${queueName}/calls`, DefaultFlatPagination<QueueCall>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Retrieve an existing call from an existing queue
    *
@@ -32,62 +56,38 @@ export class Calls extends APIResource {
   }
 
   /**
-   * Update queued call's keep_after_hangup flag
+   * Removes an inactive call from a queue. If the call is no longer active, use this
+   * command to remove it from the queue.
    *
    * @example
    * ```ts
-   * await client.queues.calls.update('call_control_id', {
+   * await client.queues.calls.remove('call_control_id', {
    *   queue_name: 'queue_name',
    * });
    * ```
    */
-  update(callControlID: string, params: CallUpdateParams, options?: RequestOptions): APIPromise<void> {
-    const { queue_name, ...body } = params;
-    return this._client.patch(path`/queues/${queue_name}/calls/${callControlID}`, {
-      body,
+  remove(callControlID: string, params: CallRemoveParams, options?: RequestOptions): APIPromise<void> {
+    const { queue_name } = params;
+    return this._client.delete(path`/queues/${queue_name}/calls/${callControlID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * Retrieve the list of calls in an existing queue
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const queueCall of client.queues.calls.list(
-   *   'queue_name',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    queueName: string,
-    query: CallListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<QueueCallsDefaultFlatPagination, QueueCall> {
-    return this._client.getAPIList(path`/queues/${queueName}/calls`, DefaultFlatPagination<QueueCall>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Removes an inactive call from a queue. If the call is no longer active, use this
-   * command to remove it from the queue.
+   * Update queued call's keep_after_hangup flag
    *
    * @example
    * ```ts
-   * await client.queues.calls.remove('call_control_id', {
+   * await client.queues.calls.update('call_control_id', {
    *   queue_name: 'queue_name',
    * });
    * ```
    */
-  remove(callControlID: string, params: CallRemoveParams, options?: RequestOptions): APIPromise<void> {
-    const { queue_name } = params;
-    return this._client.delete(path`/queues/${queue_name}/calls/${callControlID}`, {
+  update(callControlID: string, params: CallUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { queue_name, ...body } = params;
+    return this._client.patch(path`/queues/${queue_name}/calls/${callControlID}`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -161,6 +161,8 @@ export interface CallRetrieveResponse {
   data?: QueueCall;
 }
 
+export interface CallListParams extends DefaultFlatPaginationParams {}
+
 export interface CallRetrieveParams {
   /**
    * Uniquely identifies the queue by name
@@ -168,6 +170,13 @@ export interface CallRetrieveParams {
   queue_name: string;
 }
 
+export interface CallRemoveParams {
+  /**
+   * Uniquely identifies the queue by name
+   */
+  queue_name: string;
+}
+
 export interface CallUpdateParams {
   /**
    * Path param: Uniquely identifies the queue by name
@@ -180,23 +189,14 @@ export interface CallUpdateParams {
   keep_after_hangup?: boolean;
 }
 
-export interface CallListParams extends DefaultFlatPaginationParams {}
-
-export interface CallRemoveParams {
-  /**
-   * Uniquely identifies the queue by name
-   */
-  queue_name: string;
-}
-
 export declare namespace Calls {
   export {
     type QueueCall as QueueCall,
     type CallRetrieveResponse as CallRetrieveResponse,
     type QueueCallsDefaultFlatPagination as QueueCallsDefaultFlatPagination,
-    type CallRetrieveParams as CallRetrieveParams,
-    type CallUpdateParams as CallUpdateParams,
     type CallListParams as CallListParams,
+    type CallRetrieveParams as CallRetrieveParams,
     type CallRemoveParams as CallRemoveParams,
+    type CallUpdateParams as CallUpdateParams,
   };
 }

package/src/resources/queues/index.ts

@@ -4,10 +4,10 @@ export {
   Calls,
   type QueueCall,
   type CallRetrieveResponse,
-  type CallRetrieveParams,
-  type CallUpdateParams,
   type CallListParams,
+  type CallRetrieveParams,
   type CallRemoveParams,
+  type CallUpdateParams,
   type QueueCallsDefaultFlatPagination,
 } from './calls';
 export {
@@ -16,8 +16,8 @@ export {
   type QueueCreateResponse,
   type QueueRetrieveResponse,
   type QueueUpdateResponse,
+  type QueueListParams,
   type QueueCreateParams,
   type QueueUpdateParams,
-  type QueueListParams,
   type QueuesDefaultFlatPagination,
 } from './queues';

package/src/resources/queues/queues.ts

@@ -24,20 +24,6 @@ import { path } from '../../internal/utils/path';
 export class Queues extends APIResource {
   calls: CallsAPI.Calls = new CallsAPI.Calls(this._client);
 
-  /**
-   * Create a new call queue.
-   *
-   * @example
-   * ```ts
-   * const queue = await client.queues.create({
-   *   queue_name: 'tier_1_support',
-   * });
-   * ```
-   */
-  create(body: QueueCreateParams, options?: RequestOptions): APIPromise<QueueCreateResponse> {
-    return this._client.post('/queues', { body, ...options });
-  }
-
   /**
    * Retrieve an existing call queue
    *
@@ -50,24 +36,6 @@ export class Queues extends APIResource {
     return this._client.get(path`/queues/${queueName}`, options);
   }
 
-  /**
-   * Update properties of an existing call queue.
-   *
-   * @example
-   * ```ts
-   * const queue = await client.queues.update('queue_name', {
-   *   max_size: 200,
-   * });
-   * ```
-   */
-  update(
-    queueName: string,
-    body: QueueUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<QueueUpdateResponse> {
-    return this._client.post(path`/queues/${queueName}`, { body, ...options });
-  }
-
   /**
    * List all queues for the authenticated user.
    *
@@ -86,6 +54,20 @@ export class Queues extends APIResource {
     return this._client.getAPIList('/queues', DefaultFlatPagination<Queue>, { query, ...options });
   }
 
+  /**
+   * Create a new call queue.
+   *
+   * @example
+   * ```ts
+   * const queue = await client.queues.create({
+   *   queue_name: 'tier_1_support',
+   * });
+   * ```
+   */
+  create(body: QueueCreateParams, options?: RequestOptions): APIPromise<QueueCreateResponse> {
+    return this._client.post('/queues', { body, ...options });
+  }
+
   /**
    * Delete an existing call queue.
    *
@@ -100,6 +82,24 @@ export class Queues extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Update properties of an existing call queue.
+   *
+   * @example
+   * ```ts
+   * const queue = await client.queues.update('queue_name', {
+   *   max_size: 200,
+   * });
+   * ```
+   */
+  update(
+    queueName: string,
+    body: QueueUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<QueueUpdateResponse> {
+    return this._client.post(path`/queues/${queueName}`, { body, ...options });
+  }
 }
 
 export type QueuesDefaultFlatPagination = DefaultFlatPagination<Queue>;
@@ -156,6 +156,8 @@ export interface QueueUpdateResponse {
   data?: Queue;
 }
 
+export interface QueueListParams extends DefaultFlatPaginationParams {}
+
 export interface QueueCreateParams {
   /**
    * The name of the queue. Must be between 1 and 255 characters.
@@ -175,8 +177,6 @@ export interface QueueUpdateParams {
   max_size: number;
 }
 
-export interface QueueListParams extends DefaultFlatPaginationParams {}
-
 Queues.Calls = Calls;
 
 export declare namespace Queues {
@@ -186,9 +186,9 @@ export declare namespace Queues {
     type QueueRetrieveResponse as QueueRetrieveResponse,
     type QueueUpdateResponse as QueueUpdateResponse,
     type QueuesDefaultFlatPagination as QueuesDefaultFlatPagination,
+    type QueueListParams as QueueListParams,
     type QueueCreateParams as QueueCreateParams,
     type QueueUpdateParams as QueueUpdateParams,
-    type QueueListParams as QueueListParams,
   };
 
   export {
@@ -196,9 +196,9 @@ export declare namespace Queues {
     type QueueCall as QueueCall,
     type CallRetrieveResponse as CallRetrieveResponse,
     type QueueCallsDefaultFlatPagination as QueueCallsDefaultFlatPagination,
-    type CallRetrieveParams as CallRetrieveParams,
-    type CallUpdateParams as CallUpdateParams,
     type CallListParams as CallListParams,
+    type CallRetrieveParams as CallRetrieveParams,
     type CallRemoveParams as CallRemoveParams,
+    type CallUpdateParams as CallUpdateParams,
   };
 }

package/src/resources/recording-transcriptions.ts

@@ -10,16 +10,6 @@ import { path } from '../internal/utils/path';
  * Call Recordings operations.
  */
 export class RecordingTranscriptions extends APIResource {
-  /**
-   * Retrieves the details of an existing recording transcription.
-   */
-  retrieve(
-    recordingTranscriptionID: string,
-    options?: RequestOptions,
-  ): APIPromise<RecordingTranscriptionRetrieveResponse> {
-    return this._client.get(path`/recording_transcriptions/${recordingTranscriptionID}`, options);
-  }
-
   /**
    * Returns a list of your recording transcriptions.
    */
@@ -43,6 +33,16 @@ export class RecordingTranscriptions extends APIResource {
   ): APIPromise<RecordingTranscriptionDeleteResponse> {
     return this._client.delete(path`/recording_transcriptions/${recordingTranscriptionID}`, options);
   }
+
+  /**
+   * Retrieves the details of an existing recording transcription.
+   */
+  retrieve(
+    recordingTranscriptionID: string,
+    options?: RequestOptions,
+  ): APIPromise<RecordingTranscriptionRetrieveResponse> {
+    return this._client.get(path`/recording_transcriptions/${recordingTranscriptionID}`, options);
+  }
 }
 
 export type RecordingTranscriptionsDefaultFlatPagination = DefaultFlatPagination<RecordingTranscription>;

package/src/resources/recordings/recordings.ts

@@ -14,20 +14,6 @@ import { path } from '../../internal/utils/path';
 export class Recordings extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
-  /**
-   * Retrieves the details of an existing call recording.
-   *
-   * @example
-   * ```ts
-   * const recordingResponse = await client.recordings.retrieve(
-   *   'recording_id',
-   * );
-   * ```
-   */
-  retrieve(recordingID: string, options?: RequestOptions): APIPromise<RecordingResponse> {
-    return this._client.get(path`/recordings/${recordingID}`, options);
-  }
-
   /**
    * Returns a list of your call recordings.
    *
@@ -62,6 +48,20 @@ export class Recordings extends APIResource {
   delete(recordingID: string, options?: RequestOptions): APIPromise<RecordingResponse> {
     return this._client.delete(path`/recordings/${recordingID}`, options);
   }
+
+  /**
+   * Retrieves the details of an existing call recording.
+   *
+   * @example
+   * ```ts
+   * const recordingResponse = await client.recordings.retrieve(
+   *   'recording_id',
+   * );
+   * ```
+   */
+  retrieve(recordingID: string, options?: RequestOptions): APIPromise<RecordingResponse> {
+    return this._client.get(path`/recordings/${recordingID}`, options);
+  }
 }
 
 export type RecordingResponseDataDefaultFlatPagination = DefaultFlatPagination<RecordingResponseData>;

package/src/resources/reports/index.ts

@@ -13,8 +13,8 @@ export {
   type MdrUsageReportRetrieveResponse,
   type MdrUsageReportDeleteResponse,
   type MdrUsageReportFetchSyncResponse,
-  type MdrUsageReportCreateParams,
   type MdrUsageReportListParams,
+  type MdrUsageReportCreateParams,
   type MdrUsageReportFetchSyncParams,
   type MdrUsageReportsDefaultFlatPagination,
 } from './mdr-usage-reports';

package/src/resources/reports/mdr-usage-reports.ts

@@ -11,6 +11,28 @@ import { path } from '../../internal/utils/path';
  * Messaging usage reports
  */
 export class MdrUsageReports extends APIResource {
+  /**
+   * Fetch all messaging usage reports. Usage reports are aggregated messaging data
+   * for specified time period and breakdown
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: MdrUsageReportListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<MdrUsageReportsDefaultFlatPagination, MdrUsageReport> {
+    return this._client.getAPIList('/reports/mdr_usage_reports', DefaultFlatPagination<MdrUsageReport>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Submit request for new new messaging usage report. This endpoint will pull and
    * aggregate messaging data in specified time period.
@@ -37,40 +59,23 @@ export class MdrUsageReports extends APIResource {
   }
 
   /**
-   * Fetch a single messaging usage report by id
-   *
-   * @example
-   * ```ts
-   * const mdrUsageReport =
-   *   await client.reports.mdrUsageReports.retrieve(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<MdrUsageReportRetrieveResponse> {
-    return this._client.get(path`/reports/mdr_usage_reports/${id}`, options);
-  }
-
-  /**
-   * Fetch all messaging usage reports. Usage reports are aggregated messaging data
-   * for specified time period and breakdown
+   * Generate and fetch messaging usage report synchronously. This endpoint will both
+   * generate and fetch the messaging report over a specified time period. No polling
+   * is necessary but the response may take up to a couple of minutes.
    *
    * @example
    * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const mdrUsageReport of client.reports.mdrUsageReports.list()) {
-   *   // ...
-   * }
+   * const response =
+   *   await client.reports.mdrUsageReports.fetchSync({
+   *     aggregation_type: 'PROFILE',
+   *   });
    * ```
    */
-  list(
-    query: MdrUsageReportListParams | null | undefined = {},
+  fetchSync(
+    query: MdrUsageReportFetchSyncParams,
     options?: RequestOptions,
-  ): PagePromise<MdrUsageReportsDefaultFlatPagination, MdrUsageReport> {
-    return this._client.getAPIList('/reports/mdr_usage_reports', DefaultFlatPagination<MdrUsageReport>, {
-      query,
-      ...options,
-    });
+  ): APIPromise<MdrUsageReportFetchSyncResponse> {
+    return this._client.get('/reports/mdr_usage_reports/sync', { query, ...options });
   }
 
   /**
@@ -89,23 +94,18 @@ export class MdrUsageReports extends APIResource {
   }
 
   /**
-   * Generate and fetch messaging usage report synchronously. This endpoint will both
-   * generate and fetch the messaging report over a specified time period. No polling
-   * is necessary but the response may take up to a couple of minutes.
+   * Fetch a single messaging usage report by id
    *
    * @example
    * ```ts
-   * const response =
-   *   await client.reports.mdrUsageReports.fetchSync({
-   *     aggregation_type: 'PROFILE',
-   *   });
+   * const mdrUsageReport =
+   *   await client.reports.mdrUsageReports.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
    * ```
    */
-  fetchSync(
-    query: MdrUsageReportFetchSyncParams,
-    options?: RequestOptions,
-  ): APIPromise<MdrUsageReportFetchSyncResponse> {
-    return this._client.get('/reports/mdr_usage_reports/sync', { query, ...options });
+  retrieve(id: string, options?: RequestOptions): APIPromise<MdrUsageReportRetrieveResponse> {
+    return this._client.get(path`/reports/mdr_usage_reports/${id}`, options);
   }
 }
 
@@ -198,6 +198,8 @@ export interface MdrUsageReportFetchSyncResponse {
   data?: MdrUsageReport;
 }
 
+export interface MdrUsageReportListParams extends DefaultFlatPaginationParams {}
+
 export interface MdrUsageReportCreateParams {
   aggregation_type: 'NO_AGGREGATION' | 'PROFILE' | 'TAGS';
 
@@ -208,8 +210,6 @@ export interface MdrUsageReportCreateParams {
   profiles?: string;
 }
 
-export interface MdrUsageReportListParams extends DefaultFlatPaginationParams {}
-
 export interface MdrUsageReportFetchSyncParams {
   /**
    * Type of aggregation to apply to the results.
@@ -241,8 +241,8 @@ export declare namespace MdrUsageReports {
     type MdrUsageReportDeleteResponse as MdrUsageReportDeleteResponse,
     type MdrUsageReportFetchSyncResponse as MdrUsageReportFetchSyncResponse,
     type MdrUsageReportsDefaultFlatPagination as MdrUsageReportsDefaultFlatPagination,
-    type MdrUsageReportCreateParams as MdrUsageReportCreateParams,
     type MdrUsageReportListParams as MdrUsageReportListParams,
+    type MdrUsageReportCreateParams as MdrUsageReportCreateParams,
     type MdrUsageReportFetchSyncParams as MdrUsageReportFetchSyncParams,
   };
 }

package/src/resources/reports/reports.ts

@@ -399,8 +399,8 @@ export declare namespace Reports {
     type MdrUsageReportDeleteResponse as MdrUsageReportDeleteResponse,
     type MdrUsageReportFetchSyncResponse as MdrUsageReportFetchSyncResponse,
     type MdrUsageReportsDefaultFlatPagination as MdrUsageReportsDefaultFlatPagination,
-    type MdrUsageReportCreateParams as MdrUsageReportCreateParams,
     type MdrUsageReportListParams as MdrUsageReportListParams,
+    type MdrUsageReportCreateParams as MdrUsageReportCreateParams,
     type MdrUsageReportFetchSyncParams as MdrUsageReportFetchSyncParams,
   };
 }

package/src/resources/reputation/index.ts

@@ -1,4 +1,4 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export { Numbers, type NumberRetrieveParams, type NumberListParams } from './numbers';
+export { Numbers, type NumberListParams, type NumberRetrieveParams } from './numbers';
 export { Reputation } from './reputation';

package/src/resources/reputation/numbers.ts

@@ -13,18 +13,6 @@ import { path } from '../../internal/utils/path';
  * Phone-number reputation monitoring (spam-score lookup and tracking).
  */
 export class Numbers extends APIResource {
-  /**
-   * Convenience alias for
-   * `GET /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}`.
-   */
-  retrieve(
-    phoneNumber: string,
-    query: NumberRetrieveParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ReputationNumbersAPI.ReputationPhoneNumberWithReputation> {
-    return this._client.get(path`/reputation/numbers/${phoneNumber}`, { query, ...options });
-  }
-
   /**
    * Convenience alias for `GET /v2/enterprises/{enterprise_id}/reputation/numbers`
    * that returns numbers across every enterprise you own. Useful when you don't want
@@ -51,14 +39,18 @@ export class Numbers extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
-}
 
-export interface NumberRetrieveParams {
   /**
-   * When true, fetches fresh reputation data (incurs API cost). When false
-   * (default), returns cached data.
+   * Convenience alias for
+   * `GET /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}`.
    */
-  fresh?: boolean;
+  retrieve(
+    phoneNumber: string,
+    query: NumberRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ReputationNumbersAPI.ReputationPhoneNumberWithReputation> {
+    return this._client.get(path`/reputation/numbers/${phoneNumber}`, { query, ...options });
+  }
 }
 
 export interface NumberListParams extends DefaultFlatPaginationParams {
@@ -78,8 +70,16 @@ export interface NumberListParams extends DefaultFlatPaginationParams {
   'filter[phone_number][eq]'?: string;
 }
 
+export interface NumberRetrieveParams {
+  /**
+   * When true, fetches fresh reputation data (incurs API cost). When false
+   * (default), returns cached data.
+   */
+  fresh?: boolean;
+}
+
 export declare namespace Numbers {
-  export { type NumberRetrieveParams as NumberRetrieveParams, type NumberListParams as NumberListParams };
+  export { type NumberListParams as NumberListParams, type NumberRetrieveParams as NumberRetrieveParams };
 }
 
 export { type ReputationPhoneNumbersDefaultFlatPagination };

package/src/resources/reputation/reputation.ts

@@ -13,7 +13,7 @@ Reputation.Numbers = Numbers;
 export declare namespace Reputation {
   export {
     Numbers as Numbers,
-    type NumberRetrieveParams as NumberRetrieveParams,
     type NumberListParams as NumberListParams,
+    type NumberRetrieveParams as NumberRetrieveParams,
   };
 }