fix nested resources logic

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## v2
 
+### v2.0.0-alpha.8
+
+- Move `AutorespConfigs` resource to be nested in `MessagingProfiles`
+- Fix nested resources in `Calls`, `MessagingProfiles` and `Conferences` ID usage instead of using constructors data
+- Fix nested resources `Calls`, `MessagingProfiles` and `Conferences` method names
+- Fix `Brand` resources method name
+- Fix bug on `DELETE` operations empty `responseBody` JSON Parsing
+- Update types on resources methods with multiple urlParams
+
 ### v2.0.0-alpha.7
 
 - Export API callback `events` type definitions

VERSION

@@ -1 +1 @@
-2.0.0-alpha.7
+2.0.0-alpha.8

package.json

@@ -1,6 +1,6 @@
 {
   "name": "telnyx",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-alpha.8",
   "description": "Telnyx API Node SDK",
   "keywords": [
     "telnyx",

src/TelnyxResource.ts

@@ -195,7 +195,10 @@ TelnyxResource.prototype = {
         try {
           responseBody = utils.tryParseJSON(response);
 
-          if (responseBody.errors) {
+          // JSON response might be empty on deletion operations
+          if (!responseBody) {
+            responseBody = {};
+          } else if (responseBody.errors) {
             const error = {} as TelnyxError.TelnyxRawError;
 
             error.errors =

src/resources/Brands.ts

@@ -37,7 +37,7 @@ export const Brands = TelnyxResource.extend({
     methodType: 'list',
   }),
 
-  exportExternalVettings: telnyxMethod({
+  importExternalVettings: telnyxMethod({
     method: 'PUT',
     path: '/brand/{brandId}/externalVetting',
     urlParams: ['brandId'],

src/resources/Calls.ts

@@ -34,12 +34,24 @@ const CALL_COMMANDS = [
 ];
 
 function getSpec(callControlId?: string) {
+  if (callControlId) {
+    return function (methodName: string) {
+      return {
+        method: 'POST',
+        path: `/{call_control_id}/actions/${methodName}`,
+        urlParams: ['call_control_id'],
+        paramsValues: [callControlId],
+        paramsNames: ['call_control_id'],
+        methodType: 'create',
+      };
+    };
+  }
+
   return function (methodName: string) {
     return {
       method: 'POST',
       path: `/{call_control_id}/actions/${methodName}`,
       urlParams: ['call_control_id'],
-      paramsValues: [callControlId as string],
       paramsNames: ['call_control_id'],
       methodType: 'create',
     };

src/resources/Conferences.ts

@@ -1,8 +1,9 @@
 import TelnyxResource from '../TelnyxResource';
+import {ResponsePayload, TelnyxObject} from '../Types';
 import * as utils from '../utils';
 const telnyxMethod = TelnyxResource.method;
 
-const CONFERENCES = [
+const CONFERENCES_COMMANDS = [
   'join',
   'mute',
   'unmute',
@@ -20,18 +21,54 @@ const CONFERENCES = [
 ];
 
 function getSpec(conferenceId?: string) {
+  if (conferenceId) {
+    return function (methodName: string) {
+      return {
+        method: 'POST',
+        path: `/{conferenceId}/actions/${methodName}`,
+        urlParams: ['conferenceId'],
+        paramsValues: [conferenceId],
+        paramsNames: ['conferenceId'],
+        methodType: 'create',
+      };
+    };
+  }
+
   return function (methodName: string) {
     return {
       method: 'POST',
       path: `/{conferenceId}/actions/${methodName}`,
       urlParams: ['conferenceId'],
-      paramsValues: [conferenceId as string],
-      paramsNames: ['id'],
+      paramsNames: ['conferenceId'],
       methodType: 'create',
     };
   };
 }
 
+const transformResponseData = (
+  response: ResponsePayload,
+  telnyx: TelnyxObject,
+) => {
+  const methods = utils.createNestedMethods(
+    telnyxMethod,
+    CONFERENCES_COMMANDS,
+    getSpec(response.data.id as string),
+  );
+
+  methods.listParticipants = telnyxMethod({
+    method: 'GET',
+    path: '/{conferenceId}/participants',
+    urlParams: ['conferenceId'],
+  });
+
+  return utils.addResourceToResponseData(
+    response,
+    telnyx,
+    'conferences',
+    methods,
+  );
+};
+
 export const Conferences = TelnyxResource.extend({
   path: 'conferences',
   includeBasic: ['list'],
@@ -40,47 +77,23 @@ export const Conferences = TelnyxResource.extend({
     method: 'GET',
     path: '/{id}',
     urlParams: ['id'],
-
-    transformResponseData: function (response, telnyx) {
-      return utils.addResourceToResponseData(
-        response,
-        telnyx,
-        'conferences',
-        utils.createNestedMethods(
-          telnyxMethod,
-          CONFERENCES,
-          getSpec(response.data.id as string),
-        ),
-      );
-    },
+    transformResponseData: transformResponseData,
   }),
 
   create: telnyxMethod({
     method: 'POST',
-
-    transformResponseData: function (response, telnyx) {
-      return utils.addResourceToResponseData(
-        response,
-        telnyx,
-        'conferences',
-        utils.createNestedMethods(
-          telnyxMethod,
-          CONFERENCES,
-          getSpec(response.data.id as string),
-        ),
-      );
-    },
+    transformResponseData: transformResponseData,
   }),
 
-  participants: telnyxMethod({
+  listParticipants: telnyxMethod({
     method: 'GET',
     path: '/{conferenceId}/participants',
     urlParams: ['conferenceId'],
   }),
 
   instanceMethods: utils.createNestedMethods(
     telnyxMethod,
-    CONFERENCES,
+    CONFERENCES_COMMANDS,
     getSpec(),
   ),
 });

src/resources/MessagingProfiles.ts

@@ -1,11 +1,11 @@
-import telnyx from 'telnyx';
+import Telnyx from 'telnyx';
 import TelnyxResource from '../TelnyxResource';
 import {ResponsePayload, TelnyxObject} from '../Types';
 import * as utils from '../utils';
 
 const telnyxMethod = TelnyxResource.method;
 
-const ACTIONS = ['phone_numbers', 'short_codes', 'metrics', 'autoresp_configs'];
+const MESSAGING_PROFILES_COMMANDS = ['phone_numbers', 'short_codes'];
 
 function getSpec(messagingProfileId?: string) {
   return function (methodName: string) {
@@ -14,19 +14,19 @@ function getSpec(messagingProfileId?: string) {
       path: `/{messagingProfileId}/${methodName}`,
       urlParams: ['messagingProfileId'],
       paramsValues: [messagingProfileId as string],
-      paramsNames: ['id'],
+      paramsNames: ['messagingProfileId'],
       methodType: 'list',
     };
   };
 }
 
 const transformResponseData = (
-  response: ResponsePayload<telnyx.MessagingProfilesCreateResponse>,
+  response: ResponsePayload<Telnyx.MessagingProfilesCreateResponse>,
   telnyx: TelnyxObject,
 ) => {
   const methods = utils.createNestedMethods(
     telnyxMethod,
-    ACTIONS,
+    MESSAGING_PROFILES_COMMANDS,
     getSpec(response.data.id as string),
   );
 
@@ -35,7 +35,59 @@ const transformResponseData = (
     path: '/{messagingProfileId}',
     urlParams: ['messagingProfileId'],
     paramsValues: [response.data.id as string],
-    paramsNames: ['id'],
+    paramsNames: ['messagingProfileId'],
+  });
+
+  methods.listAutorespConfigs = telnyxMethod({
+    method: 'GET',
+    path: '/{profileId}/autoresp_configs',
+    urlParams: ['profileId'],
+    paramsValues: [response.data.id as string],
+    paramsNames: ['profileId'],
+    methodType: 'list',
+  });
+
+  methods.createAutorespConfig = telnyxMethod({
+    method: 'POST',
+    path: '/{profileId}/autoresp_configs',
+    urlParams: ['profileId'],
+    paramsValues: [response.data.id as string],
+    paramsNames: ['profileId'],
+    methodType: 'create',
+  });
+
+  methods.delAutorespConfig = telnyxMethod({
+    method: 'DELETE',
+    path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+    paramsValues: [response.data.id as string],
+    urlParams: ['profileId', 'autorespCfgId'],
+    paramsNames: ['profileId', 'autorespCfgId'],
+  });
+
+  methods.retrieveAutorespConfig = telnyxMethod({
+    method: 'GET',
+    path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+    paramsValues: [response.data.id as string],
+    urlParams: ['profileId', 'autorespCfgId'],
+    paramsNames: ['profileId', 'autorespCfgId'],
+    methodType: 'retrieve',
+  });
+
+  methods.updateAutorespConfig = telnyxMethod({
+    method: 'PUT',
+    path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+    paramsValues: [response.data.id as string],
+    urlParams: ['profileId', 'autorespCfgId'],
+    paramsNames: ['profileId', 'autorespCfgId'],
+  });
+
+  methods.retrieveMetrics = telnyxMethod({
+    method: 'GET',
+    path: '/{messagingProfileId}/metrics',
+    urlParams: ['messagingProfileId'],
+    paramsValues: [response.data.id as string],
+    paramsNames: ['messagingProfileId'],
+    methodType: 'retrieve',
   });
 
   return utils.addResourceToResponseData(
@@ -70,43 +122,55 @@ export const MessagingProfiles = TelnyxResource.extend({
     methodType: 'list',
   }),
 
-  phoneNumbers: telnyxMethod({
-    method: 'GET',
-    path: '/{messagingProfileId}/phone_numbers',
-    urlParams: ['messagingProfileId'],
-  }),
-
   listShortCodes: telnyxMethod({
     method: 'GET',
     path: '/{messagingProfileId}/short_codes',
     urlParams: ['messagingProfileId'],
     methodType: 'list',
   }),
 
-  shortCodes: telnyxMethod({
+  listAutorespConfigs: telnyxMethod({
     method: 'GET',
-    path: '/{messagingProfileId}/short_codes',
-    urlParams: ['messagingProfileId'],
+    path: '/{profileId}/autoresp_configs',
+    urlParams: ['profileId'],
+    paramsNames: ['profileId'],
+    methodType: 'list',
   }),
 
-  retrieveMetrics: telnyxMethod({
+  createAutorespConfig: telnyxMethod({
+    method: 'POST',
+    path: '/{profileId}/autoresp_configs',
+    urlParams: ['profileId'],
+    paramsNames: ['profileId'],
+    methodType: 'create',
+  }),
+
+  delAutorespConfig: telnyxMethod({
+    method: 'DELETE',
+    path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+    urlParams: ['profileId', 'autorespCfgId'],
+    paramsNames: ['profileId', 'autorespCfgId'],
+  }),
+
+  retrieveAutorespConfig: telnyxMethod({
     method: 'GET',
-    path: '/{messagingProfileId}/metrics',
-    urlParams: ['messagingProfileId'],
+    path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+    urlParams: ['profileId', 'autorespCfgId'],
+    paramsNames: ['profileId', 'autorespCfgId'],
     methodType: 'retrieve',
   }),
 
-  autorespConfigs: telnyxMethod({
-    method: 'GET',
-    path: '/{messagingProfileId}/autoresp_configs',
-    urlParams: ['messagingProfileId'],
-    methodType: 'list',
+  updateAutorespConfig: telnyxMethod({
+    method: 'PUT',
+    path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+    urlParams: ['profileId', 'autorespCfgId'],
+    paramsNames: ['profileId', 'autorespCfgId'],
   }),
 
-  listAutorespConfigs: telnyxMethod({
+  retrieveMetrics: telnyxMethod({
     method: 'GET',
-    path: '/{messagingProfileId}/autoresp_configs',
-    urlParams: ['messagingProfileId'],
-    methodType: 'list',
+    path: '/{id}/metrics',
+    urlParams: ['id'],
+    methodType: 'retrieve',
   }),
 });