telnyx 7.3.0 → 7.6.0

package/src/resources/porting-orders/phone-number-extensions.ts

@@ -10,6 +10,31 @@ import { path } from '../../internal/utils/path';
  * Endpoints related to porting orders management.
  */
 export class PhoneNumberExtensions extends APIResource {
+  /**
+   * Returns a list of all phone number extensions of a porting order.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const portingPhoneNumberExtension of client.portingOrders.phoneNumberExtensions.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    portingOrderID: string,
+    query: PhoneNumberExtensionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PortingPhoneNumberExtensionsDefaultFlatPagination, PortingPhoneNumberExtension> {
+    return this._client.getAPIList(
+      path`/porting_orders/${portingOrderID}/phone_number_extensions`,
+      DefaultFlatPagination<PortingPhoneNumberExtension>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Creates a new phone number extension.
    *
@@ -38,31 +63,6 @@ export class PhoneNumberExtensions extends APIResource {
     });
   }
 
-  /**
-   * Returns a list of all phone number extensions of a porting order.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const portingPhoneNumberExtension of client.portingOrders.phoneNumberExtensions.list(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    portingOrderID: string,
-    query: PhoneNumberExtensionListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PortingPhoneNumberExtensionsDefaultFlatPagination, PortingPhoneNumberExtension> {
-    return this._client.getAPIList(
-      path`/porting_orders/${portingOrderID}/phone_number_extensions`,
-      DefaultFlatPagination<PortingPhoneNumberExtension>,
-      { query, ...options },
-    );
-  }
-
   /**
    * Deletes a phone number extension.
    *
@@ -175,6 +175,43 @@ export interface PhoneNumberExtensionDeleteResponse {
   data?: PortingPhoneNumberExtension;
 }
 
+export interface PhoneNumberExtensionListParams extends DefaultFlatPaginationParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally:
+   * filter[porting_phone_number_id]
+   */
+  filter?: PhoneNumberExtensionListParams.Filter;
+
+  /**
+   * Consolidated sort parameter (deepObject style). Originally: sort[value]
+   */
+  sort?: PhoneNumberExtensionListParams.Sort;
+}
+
+export namespace PhoneNumberExtensionListParams {
+  /**
+   * Consolidated filter parameter (deepObject style). Originally:
+   * filter[porting_phone_number_id]
+   */
+  export interface Filter {
+    /**
+     * Filter results by porting phone number id
+     */
+    porting_phone_number_id?: string;
+  }
+
+  /**
+   * Consolidated sort parameter (deepObject style). Originally: sort[value]
+   */
+  export interface Sort {
+    /**
+     * Specifies the sort order for results. If not given, results are sorted by
+     * created_at in descending order
+     */
+    value?: '-created_at' | 'created_at';
+  }
+}
+
 export interface PhoneNumberExtensionCreateParams {
   /**
    * Specifies the activation ranges for this porting phone number extension. The
@@ -222,43 +259,6 @@ export namespace PhoneNumberExtensionCreateParams {
   }
 }
 
-export interface PhoneNumberExtensionListParams extends DefaultFlatPaginationParams {
-  /**
-   * Consolidated filter parameter (deepObject style). Originally:
-   * filter[porting_phone_number_id]
-   */
-  filter?: PhoneNumberExtensionListParams.Filter;
-
-  /**
-   * Consolidated sort parameter (deepObject style). Originally: sort[value]
-   */
-  sort?: PhoneNumberExtensionListParams.Sort;
-}
-
-export namespace PhoneNumberExtensionListParams {
-  /**
-   * Consolidated filter parameter (deepObject style). Originally:
-   * filter[porting_phone_number_id]
-   */
-  export interface Filter {
-    /**
-     * Filter results by porting phone number id
-     */
-    porting_phone_number_id?: string;
-  }
-
-  /**
-   * Consolidated sort parameter (deepObject style). Originally: sort[value]
-   */
-  export interface Sort {
-    /**
-     * Specifies the sort order for results. If not given, results are sorted by
-     * created_at in descending order
-     */
-    value?: '-created_at' | 'created_at';
-  }
-}
-
 export interface PhoneNumberExtensionDeleteParams {
   /**
    * Identifies the Porting Order associated with the phone number extension
@@ -272,8 +272,8 @@ export declare namespace PhoneNumberExtensions {
     type PhoneNumberExtensionCreateResponse as PhoneNumberExtensionCreateResponse,
     type PhoneNumberExtensionDeleteResponse as PhoneNumberExtensionDeleteResponse,
     type PortingPhoneNumberExtensionsDefaultFlatPagination as PortingPhoneNumberExtensionsDefaultFlatPagination,
-    type PhoneNumberExtensionCreateParams as PhoneNumberExtensionCreateParams,
     type PhoneNumberExtensionListParams as PhoneNumberExtensionListParams,
+    type PhoneNumberExtensionCreateParams as PhoneNumberExtensionCreateParams,
     type PhoneNumberExtensionDeleteParams as PhoneNumberExtensionDeleteParams,
   };
 }

package/src/resources/porting-orders/porting-orders.ts

@@ -134,6 +134,27 @@ export class PortingOrders extends APIResource {
   phoneNumberExtensions: PhoneNumberExtensionsAPI.PhoneNumberExtensions =
     new PhoneNumberExtensionsAPI.PhoneNumberExtensions(this._client);
 
+  /**
+   * Returns a list of your porting order.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const portingOrder of client.portingOrders.list()) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    query: PortingOrderListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PortingOrdersDefaultFlatPagination, PortingOrder> {
+    return this._client.getAPIList('/porting_orders', DefaultFlatPagination<PortingOrder>, {
+      query,
+      ...options,
+    });
+  }
+
   /**
    * Creates a new porting order object.
    *
@@ -152,6 +173,37 @@ export class PortingOrders extends APIResource {
     return this._client.post('/porting_orders', { body, ...options });
   }
 
+  /**
+   * Returns a list of all possible exception types for a porting order.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.portingOrders.retrieveExceptionTypes();
+   * ```
+   */
+  retrieveExceptionTypes(options?: RequestOptions): APIPromise<PortingOrderRetrieveExceptionTypesResponse> {
+    return this._client.get('/porting_orders/exception_types', options);
+  }
+
+  /**
+   * Deletes an existing porting order. This operation is restrict to porting orders
+   * in draft state.
+   *
+   * @example
+   * ```ts
+   * await client.portingOrders.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/porting_orders/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
   /**
    * Retrieves the details of an existing porting order.
    *
@@ -196,45 +248,6 @@ export class PortingOrders extends APIResource {
     return this._client.patch(path`/porting_orders/${id}`, { body, ...options });
   }
 
-  /**
-   * Returns a list of your porting order.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const portingOrder of client.portingOrders.list()) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    query: PortingOrderListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PortingOrdersDefaultFlatPagination, PortingOrder> {
-    return this._client.getAPIList('/porting_orders', DefaultFlatPagination<PortingOrder>, {
-      query,
-      ...options,
-    });
-  }
-
-  /**
-   * Deletes an existing porting order. This operation is restrict to porting orders
-   * in draft state.
-   *
-   * @example
-   * ```ts
-   * await client.portingOrders.delete(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  delete(id: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/porting_orders/${id}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
-
   /**
    * Returns a list of allowed FOC dates for a porting order.
    *
@@ -253,19 +266,6 @@ export class PortingOrders extends APIResource {
     return this._client.get(path`/porting_orders/${id}/allowed_foc_windows`, options);
   }
 
-  /**
-   * Returns a list of all possible exception types for a porting order.
-   *
-   * @example
-   * ```ts
-   * const response =
-   *   await client.portingOrders.retrieveExceptionTypes();
-   * ```
-   */
-  retrieveExceptionTypes(options?: RequestOptions): APIPromise<PortingOrderRetrieveExceptionTypesResponse> {
-    return this._client.get('/porting_orders/exception_types', options);
-  }
-
   /**
    * Download a porting order loa template
    *
@@ -904,103 +904,6 @@ export namespace PortingOrderRetrieveSubRequestResponse {
   }
 }
 
-export interface PortingOrderCreateParams {
-  /**
-   * The list of +E.164 formatted phone numbers
-   */
-  phone_numbers: Array<string>;
-
-  /**
-   * A customer-specified group reference for customer bookkeeping purposes
-   */
-  customer_group_reference?: string;
-
-  /**
-   * A customer-specified reference number for customer bookkeeping purposes
-   */
-  customer_reference?: string | null;
-}
-
-export interface PortingOrderRetrieveParams {
-  /**
-   * Include the first 50 phone number objects in the results
-   */
-  include_phone_numbers?: boolean;
-}
-
-export interface PortingOrderUpdateParams {
-  activation_settings?: PortingOrderUpdateParams.ActivationSettings;
-
-  customer_group_reference?: string;
-
-  customer_reference?: string;
-
-  /**
-   * Can be specified directly or via the `requirement_group_id` parameter.
-   */
-  documents?: PortingOrderDocuments;
-
-  end_user?: PortingOrderEndUser;
-
-  messaging?: PortingOrderUpdateParams.Messaging;
-
-  misc?: PortingOrderMisc | null;
-
-  phone_number_configuration?: PortingOrderPhoneNumberConfiguration;
-
-  /**
-   * If present, we will read the current values from the specified Requirement Group
-   * into the Documents and Requirements for this Porting Order. Note that any future
-   * changes in the Requirement Group would have no impact on this Porting Order. We
-   * will return an error if a specified Requirement Group conflicts with documents
-   * or requirements in the same request.
-   */
-  requirement_group_id?: string;
-
-  /**
-   * List of requirements for porting numbers.
-   */
-  requirements?: Array<PortingOrderUpdateParams.Requirement>;
-
-  user_feedback?: PortingOrderUserFeedback;
-
-  webhook_url?: string;
-}
-
-export namespace PortingOrderUpdateParams {
-  export interface ActivationSettings {
-    /**
-     * ISO 8601 formatted Date/Time requested for the FOC date
-     */
-    foc_datetime_requested?: string;
-  }
-
-  export interface Messaging {
-    /**
-     * Indicates whether Telnyx will port messaging capabilities from the losing
-     * carrier. If false, any messaging capabilities will stay with their current
-     * provider.
-     */
-    enable_messaging?: boolean;
-  }
-
-  /**
-   * Specifies a value for a requirement on the Porting Order.
-   */
-  export interface Requirement {
-    /**
-     * identifies the document or provides the text value that satisfies this
-     * requirement
-     */
-    field_value: string;
-
-    /**
-     * Identifies the requirement type that the `field_value` fulfills
-     */
-    requirement_type_id: string;
-  }
-}
-
 export interface PortingOrderListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -1164,6 +1067,103 @@ export namespace PortingOrderListParams {
   }
 }
 
+export interface PortingOrderCreateParams {
+  /**
+   * The list of +E.164 formatted phone numbers
+   */
+  phone_numbers: Array<string>;
+
+  /**
+   * A customer-specified group reference for customer bookkeeping purposes
+   */
+  customer_group_reference?: string;
+
+  /**
+   * A customer-specified reference number for customer bookkeeping purposes
+   */
+  customer_reference?: string | null;
+}
+
+export interface PortingOrderRetrieveParams {
+  /**
+   * Include the first 50 phone number objects in the results
+   */
+  include_phone_numbers?: boolean;
+}
+
+export interface PortingOrderUpdateParams {
+  activation_settings?: PortingOrderUpdateParams.ActivationSettings;
+
+  customer_group_reference?: string;
+
+  customer_reference?: string;
+
+  /**
+   * Can be specified directly or via the `requirement_group_id` parameter.
+   */
+  documents?: PortingOrderDocuments;
+
+  end_user?: PortingOrderEndUser;
+
+  messaging?: PortingOrderUpdateParams.Messaging;
+
+  misc?: PortingOrderMisc | null;
+
+  phone_number_configuration?: PortingOrderPhoneNumberConfiguration;
+
+  /**
+   * If present, we will read the current values from the specified Requirement Group
+   * into the Documents and Requirements for this Porting Order. Note that any future
+   * changes in the Requirement Group would have no impact on this Porting Order. We
+   * will return an error if a specified Requirement Group conflicts with documents
+   * or requirements in the same request.
+   */
+  requirement_group_id?: string;
+
+  /**
+   * List of requirements for porting numbers.
+   */
+  requirements?: Array<PortingOrderUpdateParams.Requirement>;
+
+  user_feedback?: PortingOrderUserFeedback;
+
+  webhook_url?: string;
+}
+
+export namespace PortingOrderUpdateParams {
+  export interface ActivationSettings {
+    /**
+     * ISO 8601 formatted Date/Time requested for the FOC date
+     */
+    foc_datetime_requested?: string;
+  }
+
+  export interface Messaging {
+    /**
+     * Indicates whether Telnyx will port messaging capabilities from the losing
+     * carrier. If false, any messaging capabilities will stay with their current
+     * provider.
+     */
+    enable_messaging?: boolean;
+  }
+
+  /**
+   * Specifies a value for a requirement on the Porting Order.
+   */
+  export interface Requirement {
+    /**
+     * identifies the document or provides the text value that satisfies this
+     * requirement
+     */
+    field_value: string;
+
+    /**
+     * Identifies the requirement type that the `field_value` fulfills
+     */
+    requirement_type_id: string;
+  }
+}
+
 export interface PortingOrderRetrieveLoaTemplateParams {
   /**
    * The identifier of the LOA configuration to use for the template. If not
@@ -1209,10 +1209,10 @@ export declare namespace PortingOrders {
     type PortingOrderRetrieveSubRequestResponse as PortingOrderRetrieveSubRequestResponse,
     type PortingOrdersDefaultFlatPagination as PortingOrdersDefaultFlatPagination,
     type PortingOrderRetrieveRequirementsResponsesDefaultFlatPagination as PortingOrderRetrieveRequirementsResponsesDefaultFlatPagination,
+    type PortingOrderListParams as PortingOrderListParams,
     type PortingOrderCreateParams as PortingOrderCreateParams,
     type PortingOrderRetrieveParams as PortingOrderRetrieveParams,
     type PortingOrderUpdateParams as PortingOrderUpdateParams,
-    type PortingOrderListParams as PortingOrderListParams,
     type PortingOrderRetrieveLoaTemplateParams as PortingOrderRetrieveLoaTemplateParams,
     type PortingOrderRetrieveRequirementsParams as PortingOrderRetrieveRequirementsParams,
   };
@@ -1222,8 +1222,8 @@ export declare namespace PortingOrders {
     type PortingPhoneNumberConfiguration as PortingPhoneNumberConfiguration,
     type PhoneNumberConfigurationCreateResponse as PhoneNumberConfigurationCreateResponse,
     type PortingPhoneNumberConfigurationsDefaultFlatPagination as PortingPhoneNumberConfigurationsDefaultFlatPagination,
-    type PhoneNumberConfigurationCreateParams as PhoneNumberConfigurationCreateParams,
     type PhoneNumberConfigurationListParams as PhoneNumberConfigurationListParams,
+    type PhoneNumberConfigurationCreateParams as PhoneNumberConfigurationCreateParams,
   };
 
   export {
@@ -1239,9 +1239,9 @@ export declare namespace PortingOrders {
     ActivationJobs as ActivationJobs,
     type ActivationJobRetrieveResponse as ActivationJobRetrieveResponse,
     type ActivationJobUpdateResponse as ActivationJobUpdateResponse,
+    type ActivationJobListParams as ActivationJobListParams,
     type ActivationJobRetrieveParams as ActivationJobRetrieveParams,
     type ActivationJobUpdateParams as ActivationJobUpdateParams,
-    type ActivationJobListParams as ActivationJobListParams,
   };
 
   export {
@@ -1249,8 +1249,8 @@ export declare namespace PortingOrders {
     type PortingAdditionalDocument as PortingAdditionalDocument,
     type AdditionalDocumentCreateResponse as AdditionalDocumentCreateResponse,
     type PortingAdditionalDocumentsDefaultFlatPagination as PortingAdditionalDocumentsDefaultFlatPagination,
-    type AdditionalDocumentCreateParams as AdditionalDocumentCreateParams,
     type AdditionalDocumentListParams as AdditionalDocumentListParams,
+    type AdditionalDocumentCreateParams as AdditionalDocumentCreateParams,
     type AdditionalDocumentDeleteParams as AdditionalDocumentDeleteParams,
   };
 
@@ -1259,8 +1259,8 @@ export declare namespace PortingOrders {
     type PortingOrdersComment as PortingOrdersComment,
     type CommentCreateResponse as CommentCreateResponse,
     type PortingOrdersCommentsDefaultFlatPagination as PortingOrdersCommentsDefaultFlatPagination,
-    type CommentCreateParams as CommentCreateParams,
     type CommentListParams as CommentListParams,
+    type CommentCreateParams as CommentCreateParams,
   };
 
   export {
@@ -1288,8 +1288,8 @@ export declare namespace PortingOrders {
     type AssociatedPhoneNumberCreateResponse as AssociatedPhoneNumberCreateResponse,
     type AssociatedPhoneNumberDeleteResponse as AssociatedPhoneNumberDeleteResponse,
     type PortingAssociatedPhoneNumbersDefaultFlatPagination as PortingAssociatedPhoneNumbersDefaultFlatPagination,
-    type AssociatedPhoneNumberCreateParams as AssociatedPhoneNumberCreateParams,
     type AssociatedPhoneNumberListParams as AssociatedPhoneNumberListParams,
+    type AssociatedPhoneNumberCreateParams as AssociatedPhoneNumberCreateParams,
     type AssociatedPhoneNumberDeleteParams as AssociatedPhoneNumberDeleteParams,
   };
 
@@ -1299,8 +1299,8 @@ export declare namespace PortingOrders {
     type PhoneNumberBlockCreateResponse as PhoneNumberBlockCreateResponse,
     type PhoneNumberBlockDeleteResponse as PhoneNumberBlockDeleteResponse,
     type PortingPhoneNumberBlocksDefaultFlatPagination as PortingPhoneNumberBlocksDefaultFlatPagination,
-    type PhoneNumberBlockCreateParams as PhoneNumberBlockCreateParams,
     type PhoneNumberBlockListParams as PhoneNumberBlockListParams,
+    type PhoneNumberBlockCreateParams as PhoneNumberBlockCreateParams,
     type PhoneNumberBlockDeleteParams as PhoneNumberBlockDeleteParams,
   };
 
@@ -1310,8 +1310,8 @@ export declare namespace PortingOrders {
     type PhoneNumberExtensionCreateResponse as PhoneNumberExtensionCreateResponse,
     type PhoneNumberExtensionDeleteResponse as PhoneNumberExtensionDeleteResponse,
     type PortingPhoneNumberExtensionsDefaultFlatPagination as PortingPhoneNumberExtensionsDefaultFlatPagination,
-    type PhoneNumberExtensionCreateParams as PhoneNumberExtensionCreateParams,
     type PhoneNumberExtensionListParams as PhoneNumberExtensionListParams,
+    type PhoneNumberExtensionCreateParams as PhoneNumberExtensionCreateParams,
     type PhoneNumberExtensionDeleteParams as PhoneNumberExtensionDeleteParams,
   };
 }

package/src/resources/portouts/comments.ts

@@ -11,31 +11,31 @@ import { path } from '../../internal/utils/path';
  */
 export class Comments extends APIResource {
   /**
-   * Creates a comment on a portout request.
+   * Returns a list of comments for a portout request.
    *
    * @example
    * ```ts
-   * const comment = await client.portouts.comments.create(
+   * const comments = await client.portouts.comments.list(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    * );
    * ```
    */
-  create(id: string, body: CommentCreateParams, options?: RequestOptions): APIPromise<CommentCreateResponse> {
-    return this._client.post(path`/portouts/${id}/comments`, { body, ...options });
+  list(id: string, options?: RequestOptions): APIPromise<CommentListResponse> {
+    return this._client.get(path`/portouts/${id}/comments`, options);
   }
 
   /**
-   * Returns a list of comments for a portout request.
+   * Creates a comment on a portout request.
    *
    * @example
    * ```ts
-   * const comments = await client.portouts.comments.list(
+   * const comment = await client.portouts.comments.create(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    * );
    * ```
    */
-  list(id: string, options?: RequestOptions): APIPromise<CommentListResponse> {
-    return this._client.get(path`/portouts/${id}/comments`, options);
+  create(id: string, body: CommentCreateParams, options?: RequestOptions): APIPromise<CommentCreateResponse> {
+    return this._client.post(path`/portouts/${id}/comments`, { body, ...options });
   }
 }
 

package/src/resources/portouts/events.ts

@@ -11,20 +11,6 @@ import { path } from '../../internal/utils/path';
  * Number portout operations
  */
 export class Events extends APIResource {
-  /**
-   * Show a specific port-out event.
-   *
-   * @example
-   * ```ts
-   * const event = await client.portouts.events.retrieve(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<EventRetrieveResponse> {
-    return this._client.get(path`/portouts/events/${id}`, options);
-  }
-
   /**
    * Returns a list of all port-out events.
    *
@@ -46,6 +32,20 @@ export class Events extends APIResource {
     });
   }
 
+  /**
+   * Show a specific port-out event.
+   *
+   * @example
+   * ```ts
+   * const event = await client.portouts.events.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EventRetrieveResponse> {
+    return this._client.get(path`/portouts/events/${id}`, options);
+  }
+
   /**
    * Republish a specific port-out event.
    *

package/src/resources/portouts/index.ts

@@ -34,8 +34,8 @@ export {
   type PortoutReport,
   type ReportCreateResponse,
   type ReportRetrieveResponse,
-  type ReportCreateParams,
   type ReportListParams,
+  type ReportCreateParams,
   type PortoutReportsDefaultFlatPagination,
 } from './reports';
 export {