telnyx 7.3.0 → 7.6.0

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

@@ -11,25 +11,6 @@ import { path } from '../../internal/utils/path';
  * Endpoints related to porting orders management.
  */
 export class AdditionalDocuments extends APIResource {
-  /**
-   * Creates a list of additional documents for a porting order.
-   *
-   * @example
-   * ```ts
-   * const additionalDocument =
-   *   await client.portingOrders.additionalDocuments.create(
-   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   *   );
-   * ```
-   */
-  create(
-    id: string,
-    body: AdditionalDocumentCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<AdditionalDocumentCreateResponse> {
-    return this._client.post(path`/porting_orders/${id}/additional_documents`, { body, ...options });
-  }
-
   /**
    * Returns a list of additional documents for a porting order.
    *
@@ -55,6 +36,25 @@ export class AdditionalDocuments extends APIResource {
     );
   }
 
+  /**
+   * Creates a list of additional documents for a porting order.
+   *
+   * @example
+   * ```ts
+   * const additionalDocument =
+   *   await client.portingOrders.additionalDocuments.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
+   */
+  create(
+    id: string,
+    body: AdditionalDocumentCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<AdditionalDocumentCreateResponse> {
+    return this._client.post(path`/porting_orders/${id}/additional_documents`, { body, ...options });
+  }
+
   /**
    * Deletes an additional document for a porting order.
    *
@@ -133,24 +133,6 @@ export interface AdditionalDocumentCreateResponse {
   data?: Array<PortingAdditionalDocument>;
 }
 
-export interface AdditionalDocumentCreateParams {
-  additional_documents?: Array<AdditionalDocumentCreateParams.AdditionalDocument>;
-}
-
-export namespace AdditionalDocumentCreateParams {
-  export interface AdditionalDocument {
-    /**
-     * The document identification
-     */
-    document_id?: string;
-
-    /**
-     * The type of document being created.
-     */
-    document_type?: 'loa' | 'invoice' | 'csr' | 'other';
-  }
-}
-
 export interface AdditionalDocumentListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -188,6 +170,24 @@ export namespace AdditionalDocumentListParams {
   }
 }
 
+export interface AdditionalDocumentCreateParams {
+  additional_documents?: Array<AdditionalDocumentCreateParams.AdditionalDocument>;
+}
+
+export namespace AdditionalDocumentCreateParams {
+  export interface AdditionalDocument {
+    /**
+     * The document identification
+     */
+    document_id?: string;
+
+    /**
+     * The type of document being created.
+     */
+    document_type?: 'loa' | 'invoice' | 'csr' | 'other';
+  }
+}
+
 export interface AdditionalDocumentDeleteParams {
   /**
    * Porting Order id
@@ -200,8 +200,8 @@ export declare namespace AdditionalDocuments {
     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,
   };
 }

package/src/resources/porting-orders/associated-phone-numbers.ts

@@ -10,6 +10,33 @@ import { path } from '../../internal/utils/path';
  * Endpoints related to porting orders management.
  */
 export class AssociatedPhoneNumbers extends APIResource {
+  /**
+   * Returns a list of all associated phone numbers for a porting order. Associated
+   * phone numbers are used for partial porting in GB to specify which phone numbers
+   * should be kept or disconnected.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    portingOrderID: string,
+    query: AssociatedPhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PortingAssociatedPhoneNumbersDefaultFlatPagination, PortingAssociatedPhoneNumber> {
+    return this._client.getAPIList(
+      path`/porting_orders/${portingOrderID}/associated_phone_numbers`,
+      DefaultFlatPagination<PortingAssociatedPhoneNumber>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Creates a new associated phone number for a porting order. This is used for
    * partial porting in GB to specify which phone numbers should be kept or
@@ -38,33 +65,6 @@ export class AssociatedPhoneNumbers extends APIResource {
     });
   }
 
-  /**
-   * Returns a list of all associated phone numbers for a porting order. Associated
-   * phone numbers are used for partial porting in GB to specify which phone numbers
-   * should be kept or disconnected.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const portingAssociatedPhoneNumber of client.portingOrders.associatedPhoneNumbers.list(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    portingOrderID: string,
-    query: AssociatedPhoneNumberListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PortingAssociatedPhoneNumbersDefaultFlatPagination, PortingAssociatedPhoneNumber> {
-    return this._client.getAPIList(
-      path`/porting_orders/${portingOrderID}/associated_phone_numbers`,
-      DefaultFlatPagination<PortingAssociatedPhoneNumber>,
-      { query, ...options },
-    );
-  }
-
   /**
    * Deletes an associated phone number from a porting order.
    *
@@ -169,29 +169,6 @@ export interface AssociatedPhoneNumberDeleteResponse {
   data?: PortingAssociatedPhoneNumber;
 }
 
-export interface AssociatedPhoneNumberCreateParams {
-  /**
-   * Specifies the action to take with this phone number during partial porting.
-   */
-  action: 'keep' | 'disconnect';
-
-  phone_number_range: AssociatedPhoneNumberCreateParams.PhoneNumberRange;
-}
-
-export namespace AssociatedPhoneNumberCreateParams {
-  export interface PhoneNumberRange {
-    /**
-     * Specifies the end of the phone number range for this associated phone number.
-     */
-    end_at?: string;
-
-    /**
-     * Specifies the start of the phone number range for this associated phone number.
-     */
-    start_at?: string;
-  }
-}
-
 export interface AssociatedPhoneNumberListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -234,6 +211,29 @@ export namespace AssociatedPhoneNumberListParams {
   }
 }
 
+export interface AssociatedPhoneNumberCreateParams {
+  /**
+   * Specifies the action to take with this phone number during partial porting.
+   */
+  action: 'keep' | 'disconnect';
+
+  phone_number_range: AssociatedPhoneNumberCreateParams.PhoneNumberRange;
+}
+
+export namespace AssociatedPhoneNumberCreateParams {
+  export interface PhoneNumberRange {
+    /**
+     * Specifies the end of the phone number range for this associated phone number.
+     */
+    end_at?: string;
+
+    /**
+     * Specifies the start of the phone number range for this associated phone number.
+     */
+    start_at?: string;
+  }
+}
+
 export interface AssociatedPhoneNumberDeleteParams {
   /**
    * Identifies the Porting Order associated with the phone number
@@ -247,8 +247,8 @@ export declare namespace AssociatedPhoneNumbers {
     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,
   };
 }

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

@@ -10,20 +10,6 @@ import { path } from '../../internal/utils/path';
  * Endpoints related to porting orders management.
  */
 export class Comments extends APIResource {
-  /**
-   * Creates a new comment for a porting order.
-   *
-   * @example
-   * ```ts
-   * const comment = await client.portingOrders.comments.create(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * );
-   * ```
-   */
-  create(id: string, body: CommentCreateParams, options?: RequestOptions): APIPromise<CommentCreateResponse> {
-    return this._client.post(path`/porting_orders/${id}/comments`, { body, ...options });
-  }
-
   /**
    * Returns a list of all comments of a porting order.
    *
@@ -48,6 +34,20 @@ export class Comments extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * Creates a new comment for a porting order.
+   *
+   * @example
+   * ```ts
+   * const comment = await client.portingOrders.comments.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
+   */
+  create(id: string, body: CommentCreateParams, options?: RequestOptions): APIPromise<CommentCreateResponse> {
+    return this._client.post(path`/porting_orders/${id}/comments`, { body, ...options });
+  }
 }
 
 export type PortingOrdersCommentsDefaultFlatPagination = DefaultFlatPagination<PortingOrdersComment>;
@@ -82,18 +82,18 @@ export interface CommentCreateResponse {
   data?: PortingOrdersComment;
 }
 
+export interface CommentListParams extends DefaultFlatPaginationParams {}
+
 export interface CommentCreateParams {
   body?: string;
 }
 
-export interface CommentListParams extends DefaultFlatPaginationParams {}
-
 export declare namespace Comments {
   export {
     type PortingOrdersComment as PortingOrdersComment,
     type CommentCreateResponse as CommentCreateResponse,
     type PortingOrdersCommentsDefaultFlatPagination as PortingOrdersCommentsDefaultFlatPagination,
-    type CommentCreateParams as CommentCreateParams,
     type CommentListParams as CommentListParams,
+    type CommentCreateParams as CommentCreateParams,
   };
 }

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

@@ -20,16 +20,16 @@ export {
   ActivationJobs,
   type ActivationJobRetrieveResponse,
   type ActivationJobUpdateResponse,
+  type ActivationJobListParams,
   type ActivationJobRetrieveParams,
   type ActivationJobUpdateParams,
-  type ActivationJobListParams,
 } from './activation-jobs';
 export {
   AdditionalDocuments,
   type PortingAdditionalDocument,
   type AdditionalDocumentCreateResponse,
-  type AdditionalDocumentCreateParams,
   type AdditionalDocumentListParams,
+  type AdditionalDocumentCreateParams,
   type AdditionalDocumentDeleteParams,
   type PortingAdditionalDocumentsDefaultFlatPagination,
 } from './additional-documents';
@@ -38,8 +38,8 @@ export {
   type PortingAssociatedPhoneNumber,
   type AssociatedPhoneNumberCreateResponse,
   type AssociatedPhoneNumberDeleteResponse,
-  type AssociatedPhoneNumberCreateParams,
   type AssociatedPhoneNumberListParams,
+  type AssociatedPhoneNumberCreateParams,
   type AssociatedPhoneNumberDeleteParams,
   type PortingAssociatedPhoneNumbersDefaultFlatPagination,
 } from './associated-phone-numbers';
@@ -47,8 +47,8 @@ export {
   Comments,
   type PortingOrdersComment,
   type CommentCreateResponse,
-  type CommentCreateParams,
   type CommentListParams,
+  type CommentCreateParams,
   type PortingOrdersCommentsDefaultFlatPagination,
 } from './comments';
 export {
@@ -56,8 +56,8 @@ export {
   type PortingPhoneNumberBlock,
   type PhoneNumberBlockCreateResponse,
   type PhoneNumberBlockDeleteResponse,
-  type PhoneNumberBlockCreateParams,
   type PhoneNumberBlockListParams,
+  type PhoneNumberBlockCreateParams,
   type PhoneNumberBlockDeleteParams,
   type PortingPhoneNumberBlocksDefaultFlatPagination,
 } from './phone-number-blocks';
@@ -65,8 +65,8 @@ export {
   PhoneNumberConfigurations,
   type PortingPhoneNumberConfiguration,
   type PhoneNumberConfigurationCreateResponse,
-  type PhoneNumberConfigurationCreateParams,
   type PhoneNumberConfigurationListParams,
+  type PhoneNumberConfigurationCreateParams,
   type PortingPhoneNumberConfigurationsDefaultFlatPagination,
 } from './phone-number-configurations';
 export {
@@ -74,8 +74,8 @@ export {
   type PortingPhoneNumberExtension,
   type PhoneNumberExtensionCreateResponse,
   type PhoneNumberExtensionDeleteResponse,
-  type PhoneNumberExtensionCreateParams,
   type PhoneNumberExtensionListParams,
+  type PhoneNumberExtensionCreateParams,
   type PhoneNumberExtensionDeleteParams,
   type PortingPhoneNumberExtensionsDefaultFlatPagination,
 } from './phone-number-extensions';
@@ -101,10 +101,10 @@ export {
   type PortingOrderRetrieveExceptionTypesResponse,
   type PortingOrderRetrieveRequirementsResponse,
   type PortingOrderRetrieveSubRequestResponse,
+  type PortingOrderListParams,
   type PortingOrderCreateParams,
   type PortingOrderRetrieveParams,
   type PortingOrderUpdateParams,
-  type PortingOrderListParams,
   type PortingOrderRetrieveLoaTemplateParams,
   type PortingOrderRetrieveRequirementsParams,
   type PortingOrdersActivationJobsDefaultFlatPagination,

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

@@ -11,6 +11,31 @@ import { path } from '../../internal/utils/path';
  * Endpoints related to porting orders management.
  */
 export class PhoneNumberBlocks extends APIResource {
+  /**
+   * Returns a list of all phone number blocks of a porting order.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const portingPhoneNumberBlock of client.portingOrders.phoneNumberBlocks.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * )) {
+   *   // ...
+   * }
+   * ```
+   */
+  list(
+    portingOrderID: string,
+    query: PhoneNumberBlockListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<PortingPhoneNumberBlocksDefaultFlatPagination, PortingPhoneNumberBlock> {
+    return this._client.getAPIList(
+      path`/porting_orders/${portingOrderID}/phone_number_blocks`,
+      DefaultFlatPagination<PortingPhoneNumberBlock>,
+      { query, ...options },
+    );
+  }
+
   /**
    * Creates a new phone number block.
    *
@@ -45,31 +70,6 @@ export class PhoneNumberBlocks extends APIResource {
     });
   }
 
-  /**
-   * Returns a list of all phone number blocks of a porting order.
-   *
-   * @example
-   * ```ts
-   * // Automatically fetches more pages as needed.
-   * for await (const portingPhoneNumberBlock of client.portingOrders.phoneNumberBlocks.list(
-   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
-   * )) {
-   *   // ...
-   * }
-   * ```
-   */
-  list(
-    portingOrderID: string,
-    query: PhoneNumberBlockListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): PagePromise<PortingPhoneNumberBlocksDefaultFlatPagination, PortingPhoneNumberBlock> {
-    return this._client.getAPIList(
-      path`/porting_orders/${portingOrderID}/phone_number_blocks`,
-      DefaultFlatPagination<PortingPhoneNumberBlock>,
-      { query, ...options },
-    );
-  }
-
   /**
    * Deletes a phone number block.
    *
@@ -182,46 +182,6 @@ export interface PhoneNumberBlockDeleteResponse {
   data?: PortingPhoneNumberBlock;
 }
 
-export interface PhoneNumberBlockCreateParams {
-  /**
-   * Specifies the activation ranges for this porting phone number block. The
-   * activation range must be within the block range and should not overlap with
-   * other activation ranges.
-   */
-  activation_ranges: Array<PhoneNumberBlockCreateParams.ActivationRange>;
-
-  phone_number_range: PhoneNumberBlockCreateParams.PhoneNumberRange;
-}
-
-export namespace PhoneNumberBlockCreateParams {
-  export interface ActivationRange {
-    /**
-     * Specifies the end of the activation range. It must be no more than the end of
-     * the extension range.
-     */
-    end_at: string;
-
-    /**
-     * Specifies the start of the activation range. Must be greater or equal the start
-     * of the extension range.
-     */
-    start_at: string;
-  }
-
-  export interface PhoneNumberRange {
-    /**
-     * Specifies the end of the phone number range for this porting phone number block.
-     */
-    end_at: string;
-
-    /**
-     * Specifies the start of the phone number range for this porting phone number
-     * block.
-     */
-    start_at: string;
-  }
-}
-
 export interface PhoneNumberBlockListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -306,6 +266,46 @@ export namespace PhoneNumberBlockListParams {
   }
 }
 
+export interface PhoneNumberBlockCreateParams {
+  /**
+   * Specifies the activation ranges for this porting phone number block. The
+   * activation range must be within the block range and should not overlap with
+   * other activation ranges.
+   */
+  activation_ranges: Array<PhoneNumberBlockCreateParams.ActivationRange>;
+
+  phone_number_range: PhoneNumberBlockCreateParams.PhoneNumberRange;
+}
+
+export namespace PhoneNumberBlockCreateParams {
+  export interface ActivationRange {
+    /**
+     * Specifies the end of the activation range. It must be no more than the end of
+     * the extension range.
+     */
+    end_at: string;
+
+    /**
+     * Specifies the start of the activation range. Must be greater or equal the start
+     * of the extension range.
+     */
+    start_at: string;
+  }
+
+  export interface PhoneNumberRange {
+    /**
+     * Specifies the end of the phone number range for this porting phone number block.
+     */
+    end_at: string;
+
+    /**
+     * Specifies the start of the phone number range for this porting phone number
+     * block.
+     */
+    start_at: string;
+  }
+}
+
 export interface PhoneNumberBlockDeleteParams {
   /**
    * Identifies the Porting Order associated with the phone number block
@@ -319,8 +319,8 @@ export declare namespace PhoneNumberBlocks {
     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,
   };
 }

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

@@ -9,22 +9,6 @@ import { RequestOptions } from '../../internal/request-options';
  * Endpoints related to porting orders management.
  */
 export class PhoneNumberConfigurations extends APIResource {
-  /**
-   * Creates a list of phone number configurations.
-   *
-   * @example
-   * ```ts
-   * const phoneNumberConfiguration =
-   *   await client.portingOrders.phoneNumberConfigurations.create();
-   * ```
-   */
-  create(
-    body: PhoneNumberConfigurationCreateParams,
-    options?: RequestOptions,
-  ): APIPromise<PhoneNumberConfigurationCreateResponse> {
-    return this._client.post('/porting_orders/phone_number_configurations', { body, ...options });
-  }
-
   /**
    * Returns a list of phone number configurations paginated.
    *
@@ -46,6 +30,22 @@ export class PhoneNumberConfigurations extends APIResource {
       { query, ...options },
     );
   }
+
+  /**
+   * Creates a list of phone number configurations.
+   *
+   * @example
+   * ```ts
+   * const phoneNumberConfiguration =
+   *   await client.portingOrders.phoneNumberConfigurations.create();
+   * ```
+   */
+  create(
+    body: PhoneNumberConfigurationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberConfigurationCreateResponse> {
+    return this._client.post('/porting_orders/phone_number_configurations', { body, ...options });
+  }
 }
 
 export type PortingPhoneNumberConfigurationsDefaultFlatPagination =
@@ -87,24 +87,6 @@ export interface PhoneNumberConfigurationCreateResponse {
   data?: Array<PortingPhoneNumberConfiguration>;
 }
 
-export interface PhoneNumberConfigurationCreateParams {
-  phone_number_configurations?: Array<PhoneNumberConfigurationCreateParams.PhoneNumberConfiguration>;
-}
-
-export namespace PhoneNumberConfigurationCreateParams {
-  export interface PhoneNumberConfiguration {
-    /**
-     * Identifies the porting phone number to be configured.
-     */
-    porting_phone_number_id: string;
-
-    /**
-     * Identifies the user bundle to be associated with the porting phone number.
-     */
-    user_bundle_id: string;
-  }
-}
-
 export interface PhoneNumberConfigurationListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally:
@@ -170,12 +152,30 @@ export namespace PhoneNumberConfigurationListParams {
   }
 }
 
+export interface PhoneNumberConfigurationCreateParams {
+  phone_number_configurations?: Array<PhoneNumberConfigurationCreateParams.PhoneNumberConfiguration>;
+}
+
+export namespace PhoneNumberConfigurationCreateParams {
+  export interface PhoneNumberConfiguration {
+    /**
+     * Identifies the porting phone number to be configured.
+     */
+    porting_phone_number_id: string;
+
+    /**
+     * Identifies the user bundle to be associated with the porting phone number.
+     */
+    user_bundle_id: string;
+  }
+}
+
 export declare namespace PhoneNumberConfigurations {
   export {
     type PortingPhoneNumberConfiguration as PortingPhoneNumberConfiguration,
     type PhoneNumberConfigurationCreateResponse as PhoneNumberConfigurationCreateResponse,
     type PortingPhoneNumberConfigurationsDefaultFlatPagination as PortingPhoneNumberConfigurationsDefaultFlatPagination,
-    type PhoneNumberConfigurationCreateParams as PhoneNumberConfigurationCreateParams,
     type PhoneNumberConfigurationListParams as PhoneNumberConfigurationListParams,
+    type PhoneNumberConfigurationCreateParams as PhoneNumberConfigurationCreateParams,
   };
 }