update nested resources typing

team-telnyx · Oct 2, 2024 · 8588eba · 8588eba
1 parent 3f6138c
commit 8588eba
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## v2
 
+### v2.0.0-alpha.3
+
+- Update typing on Nested Resources
+
 ### v2.0.0-alpha.2
 
 - Fix `AI` resource methods and created nested structure

diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 [![Build Status](https://github.com/team-telnyx/telnyx-node/workflows/CI/badge.svg)](https://github.com/team-telnyx/telnyx-node/actions)
 [![Downloads](https://img.shields.io/npm/dm/telnyx.svg)](https://www.npmjs.com/package/telnyx)
 [![Try on RunKit](https://badge.runkitcdn.com/telnyx.svg)](https://runkit.com/npm/telnyx)
+[![Code Style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier")
 [![Join Slack](https://img.shields.io/badge/join-slack-infomational)](https://joinslack.telnyx.com/)
 
 The Telnyx Node library provides convenient access to the Telnyx API from

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.0.0-alpha.2
+2.0.0-alpha.3
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "telnyx",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.3",
   "description": "Telnyx API Node SDK",
   "keywords": [
     "telnyx",

diff --git a/src/resources/Addresses.ts b/src/resources/Addresses.ts
@@ -26,8 +26,6 @@ export const Addresses = TelnyxResource.extend({
   list: telnyxMethod({
     method: 'GET',
     methodType: 'list',
-
-    transformResponseData: transformResponseData,
   }),
 
   create: telnyxMethod({

diff --git a/types/AddressesResource.d.ts b/types/AddressesResource.d.ts
@@ -48,15 +48,25 @@ declare module 'telnyx' {
         options?: RequestOptions,
       ): Promise<
         Telnyx.Response<
-          Telnyx.AddressesRetrieveResponse & AddressesNestedMethods
+          Telnyx.AddressesRetrieveResponse &
+            NestedResponseData<
+              AddressesRetrieveResponse['data'],
+              AddressesNestedMethods
+            >
         >
       >;
 
       create(
         params: AddressesCreateParams,
         options?: RequestOptions,
       ): Promise<
-        Telnyx.Response<Telnyx.AddressesCreateResponse & AddressesNestedMethods>
+        Telnyx.Response<
+          Telnyx.AddressesCreateResponse &
+            NestedResponseData<
+              AddressesCreateResponse['data'],
+              AddressesNestedMethods
+            >
+        >
       >;
 
       validate(

diff --git a/types/CallsResource.d.ts b/types/CallsResource.d.ts
@@ -172,14 +172,20 @@ declare module 'telnyx' {
         params: CallsCreateParams,
         options?: RequestOptions,
       ): Promise<
-        Telnyx.Response<Telnyx.CallsCreateResponse & CallsNestedMethods>
+        Telnyx.Response<
+          Telnyx.CallsCreateResponse &
+            NestedResponseData<CallsCreateResponse['data'], CallsNestedMethods>
+        >
       >;
 
       dial(
         params: CallsCreateParams,
         options?: RequestOptions,
       ): Promise<
-        Telnyx.Response<Telnyx.CallsCreateResponse & CallsNestedMethods>
+        Telnyx.Response<
+          Telnyx.CallsCreateResponse &
+            NestedResponseData<CallsCreateResponse['data'], CallsNestedMethods>
+        >
       >;
 
       answer(

diff --git a/types/MessagingProfilesResource.d.ts b/types/MessagingProfilesResource.d.ts
@@ -76,7 +76,10 @@ declare module 'telnyx' {
       ): Promise<
         Telnyx.Response<
           Telnyx.MessagingProfilesCreateResponse &
-            MessagingProfilesNestedMethods
+            NestedResponseData<
+              MessagingProfilesCreateResponse['data'],
+              MessagingProfilesNestedMethods
+            >
         >
       >;
 
@@ -97,7 +100,10 @@ declare module 'telnyx' {
       ): Promise<
         Telnyx.Response<
           Telnyx.MessagingProfilesRetrieveResponse &
-            MessagingProfilesNestedMethods
+            NestedResponseData<
+              MessagingProfilesRetrieveResponse['data'],
+              MessagingProfilesNestedMethods
+            >
         >
       >;
 

diff --git a/types/lib.d.ts b/types/lib.d.ts
@@ -33,6 +33,8 @@ declare module 'telnyx' {
       headers?: Record<string, string | number | string[]>;
     }
 
+    export type NestedResponseData<T, N> = {data?: T & N};
+
     export type Response<T> = T & {
       lastResponse: {
         headers: Record<string, string | number | string[]>;