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

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## v2
 
+### v2.0.0-beta.1
+
+- Fix `Queues` resource nested methods
+- Fix `PortingOrders` and `Ips` resource nested methods param names
+- Update legacy skipped tests
+- Fix `Verifications`, `VerifyProfiles` and `VerifiedNumbers` resources method naming and params
+- Remove dupe `Verify` resource
+- Update nested methods types to match param values usage
+
+### 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.1

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/IpConnections.js

@@ -24,7 +24,6 @@ export const IpConnections = TelnyxResource.extend({
     list: telnyxMethod({
         method: 'GET',
         methodType: 'list',
-        transformResponseData: transformResponseData,
     }),
     create: telnyxMethod({
         method: 'POST',

package/dist/resources/Ips.js

@@ -8,14 +8,14 @@ function transformResponseData(response, telnyx) {
             path: '/{ipId}',
             urlParams: ['ipId'],
             paramsValues: [response.data.id],
-            paramsNames: ['id'],
+            paramsNames: ['ipId'],
         }),
         update: telnyxMethod({
             method: 'PATCH',
             path: '/{ipId}',
             urlParams: ['ipId'],
             paramsValues: [response.data.id],
-            paramsNames: ['id'],
+            paramsNames: ['ipId'],
         }),
     });
 }

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/resources/PortingOrders.js

@@ -8,14 +8,14 @@ function transformResponseData(response, telnyx) {
             path: '/{portingOrderId}',
             urlParams: ['portingOrderId'],
             paramsValues: [response.data.id],
-            paramsNames: ['id'],
+            paramsNames: ['portingOrderId'],
         }),
         update: telnyxMethod({
             method: 'PATCH',
             path: '/{portingOrderId}',
             urlParams: ['portingOrderId'],
             paramsValues: [response.data.id],
-            paramsNames: ['id'],
+            paramsNames: ['portingOrderId'],
         }),
     });
 }
@@ -24,12 +24,10 @@ export const PortingOrders = TelnyxResource.extend({
     list: telnyxMethod({
         method: 'GET',
         methodType: 'list',
-        transformResponseData: transformResponseData,
     }),
     create: telnyxMethod({
         method: 'POST',
         methodType: 'create',
-        transformResponseData: transformResponseData,
     }),
     // include_phone_numbers query param
     retrieve: telnyxMethod({
@@ -51,8 +49,10 @@ export const PortingOrders = TelnyxResource.extend({
     }),
     cancelOrder: telnyxMethod({
         method: 'POST',
-        path: '/{id}/actions/cancel',
-        urlParams: ['id'],
+        path: '/{orderId}/actions/cancel',
+        urlParams: ['orderId'],
+        paramsNames: ['orderId'],
+        methodType: 'create',
     }),
     listAllowedFocWindows: telnyxMethod({
         method: 'GET',

package/dist/resources/Queues.js

@@ -16,12 +16,12 @@ function getSpec(queueName) {
 }
 function transformResponseData(response, telnyx) {
     const methods = utils.createNestedMethods(telnyxMethod, ACTIONS, getSpec(response.data.name));
-    methods.retrieve = telnyxMethod({
+    methods.retrieveCall = telnyxMethod({
         method: 'GET',
-        path: '/{call_control_id}',
-        urlParams: ['call_control_id'],
-        paramsValues: [response.data.call_control_id],
-        paramsNames: ['call_control_id'],
+        path: '/{queue_name}/calls/{call_control_id}',
+        urlParams: ['queue_name', 'call_control_id'],
+        paramsValues: [response.data.queue_name],
+        paramsNames: ['queue_name', 'call_control_id'],
     });
     return utils.addResourceToResponseData(response, telnyx, 'queues', methods);
 }
@@ -37,12 +37,12 @@ export const Queues = TelnyxResource.extend({
         method: 'GET',
         path: '/{queue_name}/calls',
         urlParams: ['queue_name'],
-        transformResponseData: transformResponseData,
     }),
     retrieveCall: telnyxMethod({
         method: 'GET',
         path: '/{queue_name}/calls/{call_control_id}',
         urlParams: ['queue_name', 'call_control_id'],
-        transformResponseData: transformResponseData,
+        paramsNames: ['queue_name', 'call_control_id'],
+        methodType: 'retrieve',
     }),
 });

package/dist/resources/Verifications.js

@@ -1,53 +1,58 @@
 import TelnyxResource from '../TelnyxResource';
 import * as utils from '../utils';
 const telnyxMethod = TelnyxResource.method;
-function transformResponseData(response, telnyx) {
-    return utils.addResourceToResponseData(response, telnyx, 'verification', {
-        sms: telnyxMethod({
+const transformResponseData = (response, telnyx) => {
+    return utils.addResourceToResponseData(response, telnyx, 'verifiedNumbers', {
+        verify: telnyxMethod({
             method: 'POST',
-            path: '/sms',
-            transformResponseData: transformResponseData,
-        }),
-        call: telnyxMethod({
-            method: 'POST',
-            path: '/call',
-            transformResponseData: transformResponseData,
-        }),
-        flashcall: telnyxMethod({
-            method: 'POST',
-            path: '/flashcall',
-            transformResponseData: transformResponseData,
-        }),
-        byPhoneNumber: telnyxMethod({
-            method: 'GET',
-            path: '/verifications/by_phone_number/{phone_number}',
-            urlParams: ['phone_number'],
-            paramsValues: [response.data.id],
-            paramsNames: ['id'],
-        }),
-        verifyVerificationCodeByPhoneNumber: telnyxMethod({
-            method: 'POST',
-            path: '/by_phone_number/{phone_number}/actions/verify',
-            urlParams: ['phone_number'],
-            paramsValues: [response.data.id],
-            paramsNames: ['id'],
-        }),
-        verifyVerificationCodeById: telnyxMethod({
-            method: 'POST',
-            path: '/by_phone_number/{verification_id}/actions/verify',
+            path: '/{verification_id}/actions/verify',
             urlParams: ['verification_id'],
+            paramsNames: ['verification_id'],
             paramsValues: [response.data.id],
-            paramsNames: ['id'],
         }),
     });
-}
+};
 export const Verifications = TelnyxResource.extend({
     path: 'verifications',
-    includeBasic: ['update'],
+    callVerify: telnyxMethod({
+        method: 'POST',
+        path: '/call',
+        methodType: 'create',
+    }),
+    flashcallVerify: telnyxMethod({
+        method: 'POST',
+        path: '/flashcall',
+        methodType: 'create',
+    }),
+    smsVerify: telnyxMethod({
+        method: 'POST',
+        path: '/sms',
+        methodType: 'create',
+    }),
     retrieve: telnyxMethod({
         method: 'GET',
         path: '/{verification_id}',
         urlParams: ['verification_id'],
         transformResponseData: transformResponseData,
     }),
+    verify: telnyxMethod({
+        method: 'POST',
+        path: '/{verification_id}/actions/verify',
+        urlParams: ['verification_id'],
+        paramsNames: ['verification_id'],
+    }),
+    listByPhoneNumber: telnyxMethod({
+        method: 'GET',
+        path: '/by_phone_number/{phone_number}',
+        urlParams: ['phone_number'],
+        paramsNames: ['phone_number'],
+        methodType: 'list',
+    }),
+    verifyByPhoneNumber: telnyxMethod({
+        method: 'POST',
+        path: '/by_phone_number/{phone_number}/actions/verify',
+        urlParams: ['phone_number'],
+        paramsNames: ['phone_number'],
+        methodType: 'create',
+    }),
 });

package/dist/resources/VerifiedNumbers.js

@@ -1,5 +1,39 @@
 import TelnyxResource from '../TelnyxResource';
+import * as utils from '../utils';
+const telnyxMethod = TelnyxResource.method;
+const transformResponseData = (response, telnyx) => {
+    return utils.addResourceToResponseData(response, telnyx, 'verifiedNumbers', {
+        verify: telnyxMethod({
+            method: 'POST',
+            path: '/{phone_number}/actions/verify',
+            urlParams: ['phone_number'],
+            paramsNames: ['phone_number'],
+            paramsValues: [response.data.id],
+        }),
+    });
+};
 export const VerifiedNumbers = TelnyxResource.extend({
     path: 'verified_numbers',
-    includeBasic: ['list', 'retrieve', 'del'],
+    includeBasic: ['list', 'del'],
+    retrieve: telnyxMethod({
+        method: 'GET',
+        path: '/{phone_number}',
+        urlParams: ['phone_number'],
+        transformResponseData: transformResponseData,
+    }),
+    create: telnyxMethod({
+        method: 'POST',
+        transformResponseData: transformResponseData,
+    }),
+    request: telnyxMethod({
+        method: 'POST',
+        transformResponseData: transformResponseData,
+    }),
+    verify: telnyxMethod({
+        method: 'POST',
+        path: '/{phone_number}/actions/verify',
+        urlParams: ['phone_number'],
+        paramsNames: ['phone_number'],
+        methodType: 'create',
+    }),
 });

package/dist/resources/VerifyProfiles.js

@@ -1,33 +1,11 @@
 import TelnyxResource from '../TelnyxResource';
-import * as utils from '../utils';
 const telnyxMethod = TelnyxResource.method;
-function transformResponseData(response, telnyx) {
-    return utils.addResourceToResponseData(response, telnyx, 'verifyProfiles', {
-        retrieveVerifyProfileMessageTemplates: telnyxMethod({
-            method: 'GET',
-            path: '/verify_profiles/templates',
-        }),
-    });
-}
 export const VerifyProfiles = TelnyxResource.extend({
     path: 'verify_profiles',
-    includeBasic: ['list', 'update', 'del'],
-    save: telnyxMethod({
-        method: 'PATCH',
-        path: '/{verify_profile_id}',
-        urlParams: ['verify_profile_id'],
-        paramsNames: ['id'],
-        transformResponseData: transformResponseData,
-    }),
-    retrieve: telnyxMethod({
+    includeBasic: ['list', 'create', 'retrieve', 'update', 'del'],
+    listTemplates: telnyxMethod({
         method: 'GET',
-        path: '/{verify_profile_id}',
-        urlParams: ['verify_profile_id'],
-        paramsNames: ['id'],
-        transformResponseData: transformResponseData,
-    }),
-    create: telnyxMethod({
-        method: 'POST',
-        transformResponseData: transformResponseData,
+        path: '/templates',
+        methodType: 'list',
     }),
 });

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';
@@ -133,7 +132,6 @@ import { TelephonyCredentials } from './resources/TelephonyCredentials';
 import { TexmlApplications } from './resources/TexmlApplications';
 import { Verifications } from './resources/Verifications';
 import { VerifiedNumbers } from './resources/VerifiedNumbers';
-import { Verify } from './resources/Verify';
 import { VerifyProfiles } from './resources/VerifyProfiles';
 import { VirtualCrossConnects } from './resources/VirtualCrossConnects';
 import { WdrDetailReports } from './resources/WdrDetailReports';
@@ -173,7 +171,6 @@ export function createTelnyx() {
         ActionsSimCards,
         ActivateDeactivateBulkCredentials,
         Addresses,
-        AutorespConfigs,
         AiAssistants,
         AiAudioTranscriptions,
         AiChatCompletions,
@@ -296,7 +293,6 @@ export function createTelnyx() {
         TexmlApplications,
         Verifications,
         VerifiedNumbers,
-        Verify,
         VerifyProfiles,
         VirtualCrossConnects,
         WdrDetailReports,

package/dist/types/AddressesResource.d.ts

@@ -39,7 +39,9 @@ declare module 'telnyx' {
       paths['/addresses/{id}']['delete']['responses']['200']['content']['application/json'];
 
     type AddressesNestedMethods = {
-      del: AddressesResource['del'];
+      del(
+        options?: RequestOptions,
+      ): Promise<Telnyx.Response<Telnyx.AddressesDelResponse>>;
     };
 
     class AddressesResource {