telnyx 2.0.0-alpha.7 → 2.0.0-beta.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## v2
 
+### v2.0.0-beta.0
+
+- 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
+- FIX: README Typo by @mpareja-godaddy in https://github.com/team-telnyx/telnyx-node/pull/186
+
 ### v2.0.0-alpha.7
 
 - Export API callback `events` type definitions

package/README.md

@@ -43,7 +43,7 @@ callback:
 
 ```typescript
 // Create a new messaging profile and then send a message using that profile:
-telnyx.,essagingProfiles.create({
+telnyx.messagingProfiles.create({
   name: 'Summer Campaign',
 })
   .then((messagingProfile) => {

package/VERSION

@@ -1 +1 @@
-2.0.0-alpha.7
+2.0.0-beta.0

package/dist/TelnyxResource.js

@@ -123,7 +123,11 @@ TelnyxResource.prototype = {
                 let responseBody;
                 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 = {};
                         error.errors =
                             responseBody.errors;

package/dist/resources/Brands.js

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

package/dist/resources/Calls.js

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

package/dist/resources/Conferences.js

@@ -1,7 +1,7 @@
 import TelnyxResource from '../TelnyxResource';
 import * as utils from '../utils';
 const telnyxMethod = TelnyxResource.method;
-const CONFERENCES = [
+const CONFERENCES_COMMANDS = [
     'join',
     'mute',
     'unmute',
@@ -18,17 +18,37 @@ const CONFERENCES = [
     'record_pause',
 ];
 function getSpec(conferenceId) {
+    if (conferenceId) {
+        return function (methodName) {
+            return {
+                method: 'POST',
+                path: `/{conferenceId}/actions/${methodName}`,
+                urlParams: ['conferenceId'],
+                paramsValues: [conferenceId],
+                paramsNames: ['conferenceId'],
+                methodType: 'create',
+            };
+        };
+    }
     return function (methodName) {
         return {
             method: 'POST',
             path: `/{conferenceId}/actions/${methodName}`,
             urlParams: ['conferenceId'],
-            paramsValues: [conferenceId],
-            paramsNames: ['id'],
+            paramsNames: ['conferenceId'],
             methodType: 'create',
         };
     };
 }
+const transformResponseData = (response, telnyx) => {
+    const methods = utils.createNestedMethods(telnyxMethod, CONFERENCES_COMMANDS, getSpec(response.data.id));
+    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'],
@@ -36,20 +56,16 @@ 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)));
-        },
+        transformResponseData: transformResponseData,
     }),
     create: telnyxMethod({
         method: 'POST',
-        transformResponseData: function (response, telnyx) {
-            return utils.addResourceToResponseData(response, telnyx, 'conferences', utils.createNestedMethods(telnyxMethod, CONFERENCES, getSpec(response.data.id)));
-        },
+        transformResponseData: transformResponseData,
     }),
-    participants: telnyxMethod({
+    listParticipants: telnyxMethod({
         method: 'GET',
         path: '/{conferenceId}/participants',
         urlParams: ['conferenceId'],
     }),
-    instanceMethods: utils.createNestedMethods(telnyxMethod, CONFERENCES, getSpec()),
+    instanceMethods: utils.createNestedMethods(telnyxMethod, CONFERENCES_COMMANDS, getSpec()),
 });

package/dist/resources/MessagingProfiles.js

@@ -1,7 +1,7 @@
 import TelnyxResource from '../TelnyxResource';
 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) {
     return function (methodName) {
         return {
@@ -9,19 +9,65 @@ function getSpec(messagingProfileId) {
             path: `/{messagingProfileId}/${methodName}`,
             urlParams: ['messagingProfileId'],
             paramsValues: [messagingProfileId],
-            paramsNames: ['id'],
+            paramsNames: ['messagingProfileId'],
             methodType: 'list',
         };
     };
 }
 const transformResponseData = (response, telnyx) => {
-    const methods = utils.createNestedMethods(telnyxMethod, ACTIONS, getSpec(response.data.id));
+    const methods = utils.createNestedMethods(telnyxMethod, MESSAGING_PROFILES_COMMANDS, getSpec(response.data.id));
     methods.del = telnyxMethod({
         method: 'DELETE',
         path: '/{messagingProfileId}',
         urlParams: ['messagingProfileId'],
         paramsValues: [response.data.id],
-        paramsNames: ['id'],
+        paramsNames: ['messagingProfileId'],
+    });
+    methods.listAutorespConfigs = telnyxMethod({
+        method: 'GET',
+        path: '/{profileId}/autoresp_configs',
+        urlParams: ['profileId'],
+        paramsValues: [response.data.id],
+        paramsNames: ['profileId'],
+        methodType: 'list',
+    });
+    methods.createAutorespConfig = telnyxMethod({
+        method: 'POST',
+        path: '/{profileId}/autoresp_configs',
+        urlParams: ['profileId'],
+        paramsValues: [response.data.id],
+        paramsNames: ['profileId'],
+        methodType: 'create',
+    });
+    methods.delAutorespConfig = telnyxMethod({
+        method: 'DELETE',
+        path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+        paramsValues: [response.data.id],
+        urlParams: ['profileId', 'autorespCfgId'],
+        paramsNames: ['profileId', 'autorespCfgId'],
+    });
+    methods.retrieveAutorespConfig = telnyxMethod({
+        method: 'GET',
+        path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+        paramsValues: [response.data.id],
+        urlParams: ['profileId', 'autorespCfgId'],
+        paramsNames: ['profileId', 'autorespCfgId'],
+        methodType: 'retrieve',
+    });
+    methods.updateAutorespConfig = telnyxMethod({
+        method: 'PUT',
+        path: '/{profileId}/autoresp_configs/{autorespCfgId}',
+        paramsValues: [response.data.id],
+        urlParams: ['profileId', 'autorespCfgId'],
+        paramsNames: ['profileId', 'autorespCfgId'],
+    });
+    methods.retrieveMetrics = telnyxMethod({
+        method: 'GET',
+        path: '/{messagingProfileId}/metrics',
+        urlParams: ['messagingProfileId'],
+        paramsValues: [response.data.id],
+        paramsNames: ['messagingProfileId'],
+        methodType: 'retrieve',
     });
     return utils.addResourceToResponseData(response, telnyx, 'messagingProfiles', methods);
 };
@@ -44,38 +90,49 @@ export const MessagingProfiles = TelnyxResource.extend({
         urlParams: ['messagingProfileId'],
         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',
     }),
 });

package/dist/telnyx.js

@@ -10,7 +10,6 @@ import { Actions } from './resources/Actions';
 import { ActionsSimCards } from './resources/ActionsSimCards';
 import { ActivateDeactivateBulkCredentials } from './resources/ActivateDeactivateBulkCredentials';
 import { Addresses } from './resources/Addresses';
-import { AutorespConfigs } from './resources/AutorespConfigs';
 import { AiAssistants } from './resources/AiAssistants';
 import { AiAudioTranscriptions } from './resources/AiAudioTranscriptions';
 import { AiChatCompletions } from './resources/AiChatCompletions';
@@ -173,7 +172,6 @@ export function createTelnyx() {
         ActionsSimCards,
         ActivateDeactivateBulkCredentials,
         Addresses,
-        AutorespConfigs,
         AiAssistants,
         AiAudioTranscriptions,
         AiChatCompletions,

package/dist/types/BrandsResource.d.ts

@@ -40,29 +40,29 @@ declare module 'telnyx' {
     type BrandsUpdateResponse =
       paths['/brand/{brandId}']['put']['responses']['200']['content']['application/json'];
 
-    type BrandsResend2faEmailPathParams =
-      paths['/brand/{brandId}/2faEmail']['post']['parameters']['path'];
+    type BrandsResend2faEmailId =
+      paths['/brand/{brandId}/2faEmail']['post']['parameters']['path']['brandId'];
 
     type BrandsResend2faEmailResponse =
       paths['/brand/{brandId}/2faEmail']['post']['responses']['200']['content'];
 
-    type BrandsListExternalVettingsPathParams =
-      paths['/brand/{brandId}/externalVetting']['get']['parameters']['path'];
+    type BrandsListExternalVettingsId =
+      paths['/brand/{brandId}/externalVetting']['get']['parameters']['path']['brandId'];
 
     type BrandsListExternalVettingsResponse =
       paths['/brand/{brandId}/externalVetting']['get']['responses']['200']['content']['application/json'];
 
-    type BrandsExportExternalVettingsPathParams =
-      paths['/brand/{brandId}/externalVetting']['put']['parameters']['path'];
+    type BrandsImportExternalVettingsId =
+      paths['/brand/{brandId}/externalVetting']['put']['parameters']['path']['brandId'];
 
-    type BrandsExportExternalVettingsParams =
+    type BrandsImportExternalVettingsParams =
       paths['/brand/{brandId}/externalVetting']['put']['requestBody']['content']['application/json'];
 
-    type BrandsExportExternalVettingsResponse =
+    type BrandsImportExternalVettingsResponse =
       paths['/brand/{brandId}/externalVetting']['put']['responses']['200']['content']['application/json'];
 
-    type BrandsOrderExternalVettingsPathParams =
-      paths['/brand/{brandId}/externalVetting']['post']['parameters']['path'];
+    type BrandsOrderExternalVettingsId =
+      paths['/brand/{brandId}/externalVetting']['post']['parameters']['path']['brandId'];
 
     type BrandsOrderExternalVettingsParams =
       paths['/brand/{brandId}/externalVetting']['post']['requestBody']['content']['application/json'];
@@ -70,8 +70,8 @@ declare module 'telnyx' {
     type BrandsOrderExternalVettingsResponse =
       paths['/brand/{brandId}/externalVetting']['post']['responses']['200']['content']['application/json'];
 
-    type BrandsRevetPathParams =
-      paths['/brand/{brandId}/revet']['put']['parameters']['path'];
+    type BrandsRevetid =
+      paths['/brand/{brandId}/revet']['put']['parameters']['path']['brandId'];
 
     type BrandsRevetParams =
       paths['/brand/{brandId}/externalVetting']['put']['requestBody']['content']['application/json'];
@@ -79,10 +79,10 @@ declare module 'telnyx' {
     type BrandsRevetResponse =
       paths['/brand/{brandId}/revet']['put']['responses']['200']['content']['application/json'];
 
-    type BrandsFeedbackPathParams =
-      paths['/brand/feedback/{brandId}']['get']['parameters']['path'];
+    type BrandsFeedbackRetrieveId =
+      paths['/brand/feedback/{brandId}']['get']['parameters']['path']['brandId'];
 
-    type BrandsFeedbackResponse =
+    type BrandsFeedbackRetrieveResponse =
       paths['/brand/feedback/{brandId}']['get']['responses']['200']['content']['application/json'];
 
     class BrandsResource {
@@ -113,37 +113,37 @@ declare module 'telnyx' {
       ): Promise<Telnyx.Response<Telnyx.BrandsUpdateResponse>>;
 
       resend2faEmail(
-        pathParams: BrandsResend2faEmailPathParams,
+        id: BrandsResend2faEmailId,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.BrandsResend2faEmailResponse>>;
 
       listExternalVettings(
-        pathParams: BrandsListExternalVettingsPathParams,
+        id: BrandsListExternalVettingsId,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.BrandsListExternalVettingsResponse>>;
 
-      exportExternalVettings(
-        pathParams: BrandsExportExternalVettingsPathParams,
-        params: BrandsExportExternalVettingsParams,
+      importExternalVettings(
+        id: BrandsImportExternalVettingsId,
+        params: BrandsImportExternalVettingsParams,
         options?: RequestOptions,
-      ): Promise<Telnyx.Response<Telnyx.BrandsExportExternalVettingsResponse>>;
+      ): Promise<Telnyx.Response<Telnyx.BrandsImportExternalVettingsResponse>>;
 
       orderExternalVettings(
-        pathParams: BrandsOrderExternalVettingsPathParams,
+        id: BrandsOrderExternalVettingsId,
         params: BrandsOrderExternalVettingsParams,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.BrandsOrderExternalVettingsResponse>>;
 
       revet(
-        pathParams: BrandsRevetPathParams,
+        id: BrandsRevetid,
         params: BrandsRevetParams,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.BrandsRevetResponse>>;
 
-      feedback(
-        pathParams: BrandsFeedbackPathParams,
+      retrieveFeedback(
+        id: BrandsFeedbackRetrieveId,
         options?: RequestOptions,
-      ): Promise<Telnyx.Response<Telnyx.BrandsFeedbackResponse>>;
+      ): Promise<Telnyx.Response<Telnyx.BrandsFeedbackRetrieveResponse>>;
     }
   }
 }