telnyx 6.83.0 → 7.2.0

package/src/resources/networks/networks.ts

@@ -8,6 +8,7 @@ import {
   DefaultGatewayCreateParams,
   DefaultGatewayCreateResponse,
   DefaultGatewayDeleteResponse,
+  DefaultGatewayResource,
   DefaultGatewayRetrieveResponse,
 } from './default-gateway';
 import { APIPromise } from '../../core/api-promise';
@@ -19,7 +20,9 @@ import { path } from '../../internal/utils/path';
  * Network operations
  */
 export class Networks extends APIResource {
-  defaultGateway: DefaultGatewayAPI.DefaultGateway = new DefaultGatewayAPI.DefaultGateway(this._client);
+  defaultGateway: DefaultGatewayAPI.DefaultGatewayResource = new DefaultGatewayAPI.DefaultGatewayResource(
+    this._client,
+  );
 
   /**
    * Create a new Network.
@@ -27,12 +30,13 @@ export class Networks extends APIResource {
    * @example
    * ```ts
    * const network = await client.networks.create({
-   *   name: 'test network',
+   *   network_create: {},
    * });
    * ```
    */
-  create(body: NetworkCreateParams, options?: RequestOptions): APIPromise<NetworkCreateResponse> {
-    return this._client.post('/networks', { body, ...options });
+  create(params: NetworkCreateParams, options?: RequestOptions): APIPromise<NetworkCreateResponse> {
+    const { network_create } = params;
+    return this._client.post('/networks', { body: network_create, ...options });
   }
 
   /**
@@ -56,16 +60,17 @@ export class Networks extends APIResource {
    * ```ts
    * const network = await client.networks.update(
    *   '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
-   *   { name: 'test network' },
+   *   { network_create: {} },
    * );
    * ```
    */
   update(
     networkID: string,
-    body: NetworkUpdateParams,
+    params: NetworkUpdateParams,
     options?: RequestOptions,
   ): APIPromise<NetworkUpdateResponse> {
-    return this._client.patch(path`/networks/${networkID}`, { body, ...options });
+    const { network_create } = params;
+    return this._client.patch(path`/networks/${networkID}`, { body: network_create, ...options });
   }
 
   /**
@@ -74,7 +79,7 @@ export class Networks extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const networkListResponse of client.networks.list()) {
+   * for await (const network of client.networks.list()) {
    *   // ...
    * }
    * ```
@@ -82,11 +87,8 @@ export class Networks extends APIResource {
   list(
     query: NetworkListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<NetworkListResponsesDefaultFlatPagination, NetworkListResponse> {
-    return this._client.getAPIList('/networks', DefaultFlatPagination<NetworkListResponse>, {
-      query,
-      ...options,
-    });
+  ): PagePromise<NetworksDefaultFlatPagination, Network> {
+    return this._client.getAPIList('/networks', DefaultFlatPagination<Network>, { query, ...options });
   }
 
   /**
@@ -129,7 +131,7 @@ export class Networks extends APIResource {
   }
 }
 
-export type NetworkListResponsesDefaultFlatPagination = DefaultFlatPagination<NetworkListResponse>;
+export type NetworksDefaultFlatPagination = DefaultFlatPagination<Network>;
 
 export type NetworkListInterfacesResponsesDefaultFlatPagination =
   DefaultFlatPagination<NetworkListInterfacesResponse>;
@@ -139,70 +141,29 @@ export type NetworkListInterfacesResponsesDefaultFlatPagination =
  */
 export type InterfaceStatus = 'created' | 'provisioning' | 'provisioned' | 'deleting';
 
-export interface NetworkCreate extends GlobalIPAssignmentsAPI.Record {
+export interface Network extends GlobalIPAssignmentsAPI.Record {
   /**
    * A user specified name for the network.
    */
-  name: string;
+  name?: string;
 }
 
-export interface NetworkCreateResponse {
-  data?: NetworkCreateResponse.Data;
-}
+export interface NetworkCreate extends Network {}
 
-export namespace NetworkCreateResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * A user specified name for the network.
-     */
-    name?: string;
-  }
+export interface NetworkCreateResponse {
+  data?: Network;
 }
 
 export interface NetworkRetrieveResponse {
-  data?: NetworkRetrieveResponse.Data;
-}
-
-export namespace NetworkRetrieveResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * A user specified name for the network.
-     */
-    name?: string;
-  }
+  data?: Network;
 }
 
 export interface NetworkUpdateResponse {
-  data?: NetworkUpdateResponse.Data;
-}
-
-export namespace NetworkUpdateResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * A user specified name for the network.
-     */
-    name?: string;
-  }
-}
-
-export interface NetworkListResponse extends GlobalIPAssignmentsAPI.Record {
-  /**
-   * A user specified name for the network.
-   */
-  name?: string;
+  data?: Network;
 }
 
 export interface NetworkDeleteResponse {
-  data?: NetworkDeleteResponse.Data;
-}
-
-export namespace NetworkDeleteResponse {
-  export interface Data extends GlobalIPAssignmentsAPI.Record {
-    /**
-     * A user specified name for the network.
-     */
-    name?: string;
-  }
+  data?: Network;
 }
 
 export interface NetworkListInterfacesResponse {
@@ -274,17 +235,11 @@ export namespace NetworkListInterfacesResponse {
 }
 
 export interface NetworkCreateParams {
-  /**
-   * A user specified name for the network.
-   */
-  name: string;
+  network_create: NetworkCreate;
 }
 
 export interface NetworkUpdateParams {
-  /**
-   * A user specified name for the network.
-   */
-  name: string;
+  network_create: NetworkCreate;
 }
 
 export interface NetworkListParams extends DefaultFlatPaginationParams {
@@ -332,19 +287,19 @@ export namespace NetworkListInterfacesParams {
   }
 }
 
-Networks.DefaultGateway = DefaultGateway;
+Networks.DefaultGatewayResource = DefaultGatewayResource;
 
 export declare namespace Networks {
   export {
     type InterfaceStatus as InterfaceStatus,
+    type Network as Network,
     type NetworkCreate as NetworkCreate,
     type NetworkCreateResponse as NetworkCreateResponse,
     type NetworkRetrieveResponse as NetworkRetrieveResponse,
     type NetworkUpdateResponse as NetworkUpdateResponse,
-    type NetworkListResponse as NetworkListResponse,
     type NetworkDeleteResponse as NetworkDeleteResponse,
     type NetworkListInterfacesResponse as NetworkListInterfacesResponse,
-    type NetworkListResponsesDefaultFlatPagination as NetworkListResponsesDefaultFlatPagination,
+    type NetworksDefaultFlatPagination as NetworksDefaultFlatPagination,
     type NetworkListInterfacesResponsesDefaultFlatPagination as NetworkListInterfacesResponsesDefaultFlatPagination,
     type NetworkCreateParams as NetworkCreateParams,
     type NetworkUpdateParams as NetworkUpdateParams,
@@ -353,7 +308,8 @@ export declare namespace Networks {
   };
 
   export {
-    DefaultGateway as DefaultGateway,
+    DefaultGatewayResource as DefaultGatewayResource,
+    type DefaultGateway as DefaultGateway,
     type DefaultGatewayCreateResponse as DefaultGatewayCreateResponse,
     type DefaultGatewayRetrieveResponse as DefaultGatewayRetrieveResponse,
     type DefaultGatewayDeleteResponse as DefaultGatewayDeleteResponse,

package/src/resources/porting/events.ts

@@ -32,7 +32,7 @@ export class Events extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const eventListResponse of client.porting.events.list()) {
+   * for await (const portingEvent of client.porting.events.list()) {
    *   // ...
    * }
    * ```
@@ -40,8 +40,8 @@ export class Events extends APIResource {
   list(
     query: EventListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<EventListResponsesDefaultFlatPagination, EventListResponse> {
-    return this._client.getAPIList('/porting/events', DefaultFlatPagination<EventListResponse>, {
+  ): PagePromise<PortingEventsDefaultFlatPagination, PortingEvent> {
+    return this._client.getAPIList('/porting/events', DefaultFlatPagination<PortingEvent>, {
       query,
       ...options,
     });
@@ -65,7 +65,15 @@ export class Events extends APIResource {
   }
 }
 
-export type EventListResponsesDefaultFlatPagination = DefaultFlatPagination<EventListResponse>;
+export type PortingEventsDefaultFlatPagination = DefaultFlatPagination<PortingEvent>;
+
+export type PortingEvent =
+  | PortingEventDeletedPayload
+  | PortingEventMessagingChangedPayload
+  | PortingEventStatusChangedEvent
+  | PortingEventNewCommentEvent
+  | PortingEventSplitEvent
+  | PortingEventWithoutWebhook;
 
 export interface PortingEventDeletedPayload {
   /**
@@ -568,23 +576,9 @@ export interface PortingEventWithoutWebhook {
 }
 
 export interface EventRetrieveResponse {
-  data?:
-    | PortingEventDeletedPayload
-    | PortingEventMessagingChangedPayload
-    | PortingEventStatusChangedEvent
-    | PortingEventNewCommentEvent
-    | PortingEventSplitEvent
-    | PortingEventWithoutWebhook;
+  data?: PortingEvent;
 }
 
-export type EventListResponse =
-  | PortingEventDeletedPayload
-  | PortingEventMessagingChangedPayload
-  | PortingEventStatusChangedEvent
-  | PortingEventNewCommentEvent
-  | PortingEventSplitEvent
-  | PortingEventWithoutWebhook;
-
 export interface EventListParams extends DefaultFlatPaginationParams {
   /**
    * Consolidated filter parameter (deepObject style). Originally: filter[type],
@@ -642,6 +636,7 @@ export namespace EventListParams {
 
 export declare namespace Events {
   export {
+    type PortingEvent as PortingEvent,
     type PortingEventDeletedPayload as PortingEventDeletedPayload,
     type PortingEventMessagingChangedPayload as PortingEventMessagingChangedPayload,
     type PortingEventNewCommentEvent as PortingEventNewCommentEvent,
@@ -649,8 +644,7 @@ export declare namespace Events {
     type PortingEventStatusChangedEvent as PortingEventStatusChangedEvent,
     type PortingEventWithoutWebhook as PortingEventWithoutWebhook,
     type EventRetrieveResponse as EventRetrieveResponse,
-    type EventListResponse as EventListResponse,
-    type EventListResponsesDefaultFlatPagination as EventListResponsesDefaultFlatPagination,
+    type PortingEventsDefaultFlatPagination as PortingEventsDefaultFlatPagination,
     type EventListParams as EventListParams,
   };
 }

package/src/resources/porting/index.ts

@@ -2,6 +2,7 @@
 
 export {
   Events,
+  type PortingEvent,
   type PortingEventDeletedPayload,
   type PortingEventMessagingChangedPayload,
   type PortingEventNewCommentEvent,
@@ -9,9 +10,8 @@ export {
   type PortingEventStatusChangedEvent,
   type PortingEventWithoutWebhook,
   type EventRetrieveResponse,
-  type EventListResponse,
   type EventListParams,
-  type EventListResponsesDefaultFlatPagination,
+  type PortingEventsDefaultFlatPagination,
 } from './events';
 export {
   LoaConfigurations,

package/src/resources/porting/porting.ts

@@ -4,16 +4,16 @@ import { APIResource } from '../../core/resource';
 import * as EventsAPI from './events';
 import {
   EventListParams,
-  EventListResponse,
-  EventListResponsesDefaultFlatPagination,
   EventRetrieveResponse,
   Events,
+  PortingEvent,
   PortingEventDeletedPayload,
   PortingEventMessagingChangedPayload,
   PortingEventNewCommentEvent,
   PortingEventSplitEvent,
   PortingEventStatusChangedEvent,
   PortingEventWithoutWebhook,
+  PortingEventsDefaultFlatPagination,
 } from './events';
 import * as LoaConfigurationsAPI from './loa-configurations';
 import {
@@ -119,6 +119,7 @@ export declare namespace Porting {
 
   export {
     Events as Events,
+    type PortingEvent as PortingEvent,
     type PortingEventDeletedPayload as PortingEventDeletedPayload,
     type PortingEventMessagingChangedPayload as PortingEventMessagingChangedPayload,
     type PortingEventNewCommentEvent as PortingEventNewCommentEvent,
@@ -126,8 +127,7 @@ export declare namespace Porting {
     type PortingEventStatusChangedEvent as PortingEventStatusChangedEvent,
     type PortingEventWithoutWebhook as PortingEventWithoutWebhook,
     type EventRetrieveResponse as EventRetrieveResponse,
-    type EventListResponse as EventListResponse,
-    type EventListResponsesDefaultFlatPagination as EventListResponsesDefaultFlatPagination,
+    type PortingEventsDefaultFlatPagination as PortingEventsDefaultFlatPagination,
     type EventListParams as EventListParams,
   };
 

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

@@ -16,7 +16,7 @@ export class ActionRequirements extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const actionRequirementListResponse of client.portingOrders.actionRequirements.list(
+   * for await (const portingActionRequirement of client.portingOrders.actionRequirements.list(
    *   'porting_order_id',
    * )) {
    *   // ...
@@ -27,10 +27,10 @@ export class ActionRequirements extends APIResource {
     portingOrderID: string,
     query: ActionRequirementListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<ActionRequirementListResponsesDefaultFlatPagination, ActionRequirementListResponse> {
+  ): PagePromise<PortingActionRequirementsDefaultFlatPagination, PortingActionRequirement> {
     return this._client.getAPIList(
       path`/porting_orders/${portingOrderID}/action_requirements`,
-      DefaultFlatPagination<ActionRequirementListResponse>,
+      DefaultFlatPagination<PortingActionRequirement>,
       { query, ...options },
     );
   }
@@ -63,10 +63,9 @@ export class ActionRequirements extends APIResource {
   }
 }
 
-export type ActionRequirementListResponsesDefaultFlatPagination =
-  DefaultFlatPagination<ActionRequirementListResponse>;
+export type PortingActionRequirementsDefaultFlatPagination = DefaultFlatPagination<PortingActionRequirement>;
 
-export interface ActionRequirementListResponse {
+export interface PortingActionRequirement {
   /**
    * Identifies the action requirement
    */
@@ -119,61 +118,7 @@ export interface ActionRequirementListResponse {
 }
 
 export interface ActionRequirementInitiateResponse {
-  data?: ActionRequirementInitiateResponse.Data;
-}
-
-export namespace ActionRequirementInitiateResponse {
-  export interface Data {
-    /**
-     * Identifies the action requirement
-     */
-    id?: string;
-
-    /**
-     * The type of action required
-     */
-    action_type?: string;
-
-    /**
-     * Optional URL for the action
-     */
-    action_url?: string | null;
-
-    /**
-     * Reason for cancellation if status is 'cancelled'
-     */
-    cancel_reason?: string | null;
-
-    /**
-     * ISO 8601 formatted date-time indicating when the resource was created
-     */
-    created_at?: string;
-
-    /**
-     * The ID of the porting order this action requirement belongs to
-     */
-    porting_order_id?: string;
-
-    /**
-     * Identifies the type of the resource
-     */
-    record_type?: 'porting_action_requirement';
-
-    /**
-     * The ID of the requirement type
-     */
-    requirement_type_id?: string;
-
-    /**
-     * Current status of the action requirement
-     */
-    status?: 'created' | 'pending' | 'completed' | 'cancelled' | 'failed';
-
-    /**
-     * ISO 8601 formatted date-time indicating when the resource was updated
-     */
-    updated_at?: string;
-  }
+  data?: PortingActionRequirement;
 }
 
 export interface ActionRequirementListParams extends DefaultFlatPaginationParams {
@@ -261,9 +206,9 @@ export namespace ActionRequirementInitiateParams {
 
 export declare namespace ActionRequirements {
   export {
-    type ActionRequirementListResponse as ActionRequirementListResponse,
+    type PortingActionRequirement as PortingActionRequirement,
     type ActionRequirementInitiateResponse as ActionRequirementInitiateResponse,
-    type ActionRequirementListResponsesDefaultFlatPagination as ActionRequirementListResponsesDefaultFlatPagination,
+    type PortingActionRequirementsDefaultFlatPagination as PortingActionRequirementsDefaultFlatPagination,
     type ActionRequirementListParams as ActionRequirementListParams,
     type ActionRequirementInitiateParams as ActionRequirementInitiateParams,
   };

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

@@ -36,7 +36,7 @@ export class AdditionalDocuments extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const additionalDocumentListResponse of client.portingOrders.additionalDocuments.list(
+   * for await (const portingAdditionalDocument of client.portingOrders.additionalDocuments.list(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    * )) {
    *   // ...
@@ -47,10 +47,10 @@ export class AdditionalDocuments extends APIResource {
     id: string,
     query: AdditionalDocumentListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<AdditionalDocumentListResponsesDefaultFlatPagination, AdditionalDocumentListResponse> {
+  ): PagePromise<PortingAdditionalDocumentsDefaultFlatPagination, PortingAdditionalDocument> {
     return this._client.getAPIList(
       path`/porting_orders/${id}/additional_documents`,
-      DefaultFlatPagination<AdditionalDocumentListResponse>,
+      DefaultFlatPagination<PortingAdditionalDocument>,
       { query, ...options },
     );
   }
@@ -79,63 +79,10 @@ export class AdditionalDocuments extends APIResource {
   }
 }
 
-export type AdditionalDocumentListResponsesDefaultFlatPagination =
-  DefaultFlatPagination<AdditionalDocumentListResponse>;
+export type PortingAdditionalDocumentsDefaultFlatPagination =
+  DefaultFlatPagination<PortingAdditionalDocument>;
 
-export interface AdditionalDocumentCreateResponse {
-  data?: Array<AdditionalDocumentCreateResponse.Data>;
-}
-
-export namespace AdditionalDocumentCreateResponse {
-  export interface Data {
-    /**
-     * Uniquely identifies this additional document
-     */
-    id?: string;
-
-    /**
-     * The content type of the related document.
-     */
-    content_type?: string;
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was created.
-     */
-    created_at?: string;
-
-    /**
-     * Identifies the associated document
-     */
-    document_id?: string;
-
-    /**
-     * Identifies the type of additional document
-     */
-    document_type?: 'loa' | 'invoice' | 'csr' | 'other';
-
-    /**
-     * The filename of the related document.
-     */
-    filename?: string;
-
-    /**
-     * Identifies the associated porting order
-     */
-    porting_order_id?: string;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: string;
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was updated.
-     */
-    updated_at?: string;
-  }
-}
-
-export interface AdditionalDocumentListResponse {
+export interface PortingAdditionalDocument {
   /**
    * Uniquely identifies this additional document
    */
@@ -182,6 +129,10 @@ export interface AdditionalDocumentListResponse {
   updated_at?: string;
 }
 
+export interface AdditionalDocumentCreateResponse {
+  data?: Array<PortingAdditionalDocument>;
+}
+
 export interface AdditionalDocumentCreateParams {
   additional_documents?: Array<AdditionalDocumentCreateParams.AdditionalDocument>;
 }
@@ -246,9 +197,9 @@ export interface AdditionalDocumentDeleteParams {
 
 export declare namespace AdditionalDocuments {
   export {
+    type PortingAdditionalDocument as PortingAdditionalDocument,
     type AdditionalDocumentCreateResponse as AdditionalDocumentCreateResponse,
-    type AdditionalDocumentListResponse as AdditionalDocumentListResponse,
-    type AdditionalDocumentListResponsesDefaultFlatPagination as AdditionalDocumentListResponsesDefaultFlatPagination,
+    type PortingAdditionalDocumentsDefaultFlatPagination as PortingAdditionalDocumentsDefaultFlatPagination,
     type AdditionalDocumentCreateParams as AdditionalDocumentCreateParams,
     type AdditionalDocumentListParams as AdditionalDocumentListParams,
     type AdditionalDocumentDeleteParams as AdditionalDocumentDeleteParams,

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

@@ -30,7 +30,7 @@ export class Comments extends APIResource {
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.
-   * for await (const commentListResponse of client.portingOrders.comments.list(
+   * for await (const portingOrdersComment of client.portingOrders.comments.list(
    *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    * )) {
    *   // ...
@@ -41,50 +41,18 @@ export class Comments extends APIResource {
     id: string,
     query: CommentListParams | null | undefined = {},
     options?: RequestOptions,
-  ): PagePromise<CommentListResponsesDefaultFlatPagination, CommentListResponse> {
+  ): PagePromise<PortingOrdersCommentsDefaultFlatPagination, PortingOrdersComment> {
     return this._client.getAPIList(
       path`/porting_orders/${id}/comments`,
-      DefaultFlatPagination<CommentListResponse>,
+      DefaultFlatPagination<PortingOrdersComment>,
       { query, ...options },
     );
   }
 }
 
-export type CommentListResponsesDefaultFlatPagination = DefaultFlatPagination<CommentListResponse>;
+export type PortingOrdersCommentsDefaultFlatPagination = DefaultFlatPagination<PortingOrdersComment>;
 
-export interface CommentCreateResponse {
-  data?: CommentCreateResponse.Data;
-}
-
-export namespace CommentCreateResponse {
-  export interface Data {
-    id?: string;
-
-    /**
-     * Body of comment
-     */
-    body?: string;
-
-    /**
-     * ISO 8601 formatted date indicating when the resource was created.
-     */
-    created_at?: string;
-
-    porting_order_id?: string;
-
-    /**
-     * Identifies the type of the resource.
-     */
-    record_type?: string;
-
-    /**
-     * Indicates whether this comment was created by a Telnyx Admin, user, or system
-     */
-    user_type?: 'admin' | 'user' | 'system';
-  }
-}
-
-export interface CommentListResponse {
+export interface PortingOrdersComment {
   id?: string;
 
   /**
@@ -110,6 +78,10 @@ export interface CommentListResponse {
   user_type?: 'admin' | 'user' | 'system';
 }
 
+export interface CommentCreateResponse {
+  data?: PortingOrdersComment;
+}
+
 export interface CommentCreateParams {
   body?: string;
 }
@@ -118,9 +90,9 @@ export interface CommentListParams extends DefaultFlatPaginationParams {}
 
 export declare namespace Comments {
   export {
+    type PortingOrdersComment as PortingOrdersComment,
     type CommentCreateResponse as CommentCreateResponse,
-    type CommentListResponse as CommentListResponse,
-    type CommentListResponsesDefaultFlatPagination as CommentListResponsesDefaultFlatPagination,
+    type PortingOrdersCommentsDefaultFlatPagination as PortingOrdersCommentsDefaultFlatPagination,
     type CommentCreateParams as CommentCreateParams,
     type CommentListParams as CommentListParams,
   };