telnyx - npm Package Compare versions

Comparing version 2.0.0-alpha.3 to 2.0.0-alpha.4

CHANGELOG.md

@@ -5,2 +5,11 @@ # CHANGELOG
 
+### v2.0.0-alpha.4
+
+- Add `Addresses` example
+- Remove `BusinessIdentity` resource
+- Remove `CallInformation` resource
+- Remove duplicated `Credentials` resource
+- Fixed `Conferences`, `Documents` and `TelephonyCredentials` method names
+- Add missing resource types defs
+
 ### v2.0.0-alpha.3
@@ -7,0 +16,0 @@

dist/resources/Brands.js

@@ -27,7 +27,2 @@ import TelnyxResource from '../TelnyxResource';
     }),
-    externalVettings: telnyxMethod({
-        method: 'GET',
-        path: '/brand/{brandId}/externalVetting',
-        urlParams: ['brandId'],
-    }),
     listExternalVettings: telnyxMethod({
@@ -37,2 +32,3 @@ method: 'GET',
         urlParams: ['brandId'],
+        methodType: 'list',
     }),
@@ -39,0 +35,0 @@ exportExternalVettings: telnyxMethod({

dist/resources/CallControlApplications.js

@@ -24,7 +24,3 @@ import TelnyxResource from '../TelnyxResource';
     path: 'call_control_applications',
-    list: telnyxMethod({
-        method: 'GET',
-        methodType: 'list',
-        transformResponseData: transformResponseData,
-    }),
+    includeBasic: ['list', 'update'],
     create: telnyxMethod({
@@ -31,0 +27,0 @@ method: 'POST',

dist/resources/CallRecordings.js

@@ -5,19 +5,17 @@ import TelnyxResource from '../TelnyxResource';
     path: 'recordings',
-    includeBasic: ['list', 'retrieve', 'del'],
-    GetRecordings: telnyxMethod({
+    includeBasic: ['list'],
+    retrieve: telnyxMethod({
         method: 'GET',
-        path: '/recordings',
+        path: '/{recording_id}',
+        urlParams: ['recording_id'],
     }),
-    DeleteRecording: telnyxMethod({
+    del: telnyxMethod({
         method: 'DELETE',
-        path: '/recordings/{recording/id}',
+        path: '/{recording_id}',
+        urlParams: ['recording_id'],
     }),
-    DeleteRecordings: telnyxMethod({
+    bulkDel: telnyxMethod({
         method: 'DELETE',
         path: '/recordings/actions/delete',
     }),
-    DeleteCustomStorageCredentials: telnyxMethod({
-        method: 'DELETE',
-        path: '/custom/storage/credentials/{connection/id}',
-    }),
 });

dist/resources/CdrUsageReports.js

 import TelnyxResource from '../TelnyxResource';
 const telnyxMethod = TelnyxResource.method;
 export const CdrUsageReports = TelnyxResource.extend({
-    path: 'cdr_usage_reports',
-    includeBasic: ['list', 'retrieve'],
-    GetUsageReportSync: telnyxMethod({
+    path: 'reports/cdr_usage_reports',
+    retrieveUsageReportSync: telnyxMethod({
+        path: '/sync',
         method: 'GET',
-        path: '/reports/cdr_usage_reports/sync',
+        urlParams: [],
     }),
 });

dist/resources/Channelzones.js

 import TelnyxResource from '../TelnyxResource';
 const telnyxMethod = TelnyxResource.method;
 export const Channelzones = TelnyxResource.extend({
-    path: 'channelzones',
-    includeBasic: ['list', 'retrieve', 'delete'],
-    GetChannelZone: telnyxMethod({
+    path: 'channel_zones',
+    includeBasic: ['list'],
+    update: telnyxMethod({
+        method: 'PATCH',
+        path: '/{channel_zone_id}',
+        urlParams: ['channel_zone_id'],
+    }),
+    retrieve: telnyxMethod({
         method: 'GET',
-        path: '/channel_zones/{channel/zone/id}',
+        path: '/{channel_zone_id}',
+        urlParams: ['channel_zone_id'],
     }),
-    UnassignPhoneNumber: telnyxMethod({
-        method: 'DELETE',
-        path: '/channel_zones/{channel/zone/id}/channel_zone_phone_numbers/{phone_number}',
+    createPhoneNumber: telnyxMethod({
+        method: 'POST',
+        path: '/{channel_zone_id}/channel_zone_phone_numbers',
+        urlParams: ['channel_zone_id'],
     }),
-    GetChannelZones: telnyxMethod({
+    listPhoneNumbers: telnyxMethod({
         method: 'GET',
-        path: '/channel/zones',
+        path: '/{channel_zone_id}/channel_zone_phone_numbers',
     }),
-    GetPhoneNumbers: telnyxMethod({
-        method: 'GET',
-        path: '/channel_zones/{channel_zone_id}/channel_zone_phone_numbers',
+    delPhoneNumber: telnyxMethod({
+        method: 'DELETE',
+        path: '/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}',
+        urlParams: ['channel_zone_id', 'phone_number'],
     }),
 });

dist/resources/Conferences.js

@@ -17,3 +17,4 @@ import TelnyxResource from '../TelnyxResource';
     'leave',
-    'resume',
+    'record_resume',
+    'record_pause',
 ];
@@ -34,3 +35,11 @@ function getSpec(conferenceId) {
     path: 'conferences',
-    includeBasic: ['list', 'retrieve'],
+    includeBasic: ['list'],
+    retrieve: telnyxMethod({
+        method: 'GET',
+        path: '/{id}',
+        urlParams: ['id'],
+        transformResponseData: function (response, telnyx) {
+            return utils.addResourceToResponseData(response, telnyx, 'conferences', utils.createNestedMethods(telnyxMethod, CONFERENCES, getSpec(response.data.id)));
+        },
+    }),
     create: telnyxMethod({
@@ -37,0 +46,0 @@ method: 'POST',

dist/resources/Connections.js

 import TelnyxResource from '../TelnyxResource';
+const telnyxMethod = TelnyxResource.method;
 export const Connections = TelnyxResource.extend({
     path: 'connections',
     includeBasic: ['list', 'retrieve'],
+    listActiveCalls: telnyxMethod({
+        method: 'GET',
+        path: '/{connection_id}/active_calls',
+    }),
 });

dist/resources/Documents.js

 import TelnyxResource from '../TelnyxResource';
-import * as utils from '../utils';
 const telnyxMethod = TelnyxResource.method;
-function transformResponseData(response, telnyx) {
-    return utils.addResourceToResponseData(response, telnyx, 'documents', {});
-}
 export const Documents = TelnyxResource.extend({
     path: 'documents',
-    list: telnyxMethod({
-        method: 'GET',
-        transformResponseData: transformResponseData,
-    }),
-    update: telnyxMethod({
-        method: 'PATCH',
-        path: '/{id}',
-        urlParams: ['id'],
-        transformResponseData: transformResponseData,
-    }),
-    del: telnyxMethod({
-        method: 'DELETE',
-        path: '{id}',
-        urlParams: ['id'],
-        transformResponseData: transformResponseData,
-    }),
+    includeBasic: ['list', 'update', 'del', 'create', 'retrieve'],
     upload: telnyxMethod({
         method: 'POST',
-        transformResponseData: transformResponseData,
     }),
-    retrieveDocumentId: telnyxMethod({
+    download: telnyxMethod({
         method: 'GET',
-        path: '/{id}',
-        urlParams: ['id'],
-        transformResponseData: transformResponseData,
-    }),
-    retrieveDownloadDocument: telnyxMethod({
-        method: 'GET',
         path: '/{id}/download',
@@ -42,4 +16,3 @@ urlParams: ['id'],
         },
-        transformResponseData: transformResponseData,
     }),
 });

dist/resources/TelephonyCredentials.js

@@ -15,3 +15,3 @@ import TelnyxResource from '../TelnyxResource';
 }
-const telephonyCredentialResource = {
+export const TelephonyCredentials = TelnyxResource.extend({
     path: 'telephony_credentials',
@@ -24,14 +24,16 @@ includeBasic: ['del', 'list', 'update'],
     retrieve: telnyxMethod({
+        method: 'GET',
+        path: '/{id}',
+        urlParams: ['id'],
+        transformResponseData: transformResponseData,
+    }),
+    createToken: telnyxMethod({
         method: 'POST',
         path: '/{id}/token',
         urlParams: ['id'],
-        transformResponseData: transformResponseData,
     }),
-    retrieveCredential: telnyxMethod({
+    listTags: telnyxMethod({
         method: 'GET',
-        path: '/{id}',
-        urlParams: ['id'],
-        transformResponseData: transformResponseData,
+        path: '/tags',
     }),
-};
-export const TelephonyCredentials = TelnyxResource.extend(telephonyCredentialResource);
+});

dist/telnyx.js

@@ -30,6 +30,4 @@ import * as http from 'http';
 import { BulkTelephonyCredentials } from './resources/BulkTelephonyCredentials';
-import { BusinessIdentity } from './resources/BusinessIdentity';
 import { CallControlApplications } from './resources/CallControlApplications';
 import { CallEvents } from './resources/CallEvents';
-import { CallInformation } from './resources/CallInformation';
 import { CallRecordings } from './resources/CallRecordings';
@@ -45,3 +43,2 @@ import { Calls } from './resources/Calls';
 import { CredentialConnections } from './resources/CredentialConnections';
-import { Credentials } from './resources/Credentials';
 import { CsvDownloads } from './resources/CsvDownloads';
@@ -207,6 +204,4 @@ import { CustomerServiceRecord } from './resources/CustomerServiceRecord';
         BulkTelephonyCredentials,
-        BusinessIdentity,
         CallControlApplications,
         CallEvents,
-        CallInformation,
         CallRecordings,
@@ -222,3 +217,2 @@ Calls,
         CredentialConnections,
-        Credentials,
         CsvDownloads,
@@ -225,0 +219,0 @@ CustomerServiceRecord,

dist/types/BrandsResource.d.ts

@@ -58,2 +58,5 @@ import {paths} from './TelnyxAPI.js';
 
+    type BrandsExportExternalVettingsParams =
+      paths['/brand/{brandId}/externalVetting']['put']['requestBody']['content']['application/json'];
+
     type BrandsExportExternalVettingsResponse =
@@ -65,2 +68,5 @@ paths['/brand/{brandId}/externalVetting']['put']['responses']['200']['content']['application/json'];
 
+    type BrandsOrderExternalVettingsParams =
+      paths['/brand/{brandId}/externalVetting']['post']['requestBody']['content']['application/json'];
+
     type BrandsOrderExternalVettingsResponse =
@@ -72,2 +78,5 @@ paths['/brand/{brandId}/externalVetting']['post']['responses']['200']['content']['application/json'];
 
+    type BrandsRevetParams =
+      paths['/brand/{brandId}/externalVetting']['put']['requestBody']['content']['application/json'];
+
     type BrandsRevetResponse =
@@ -114,7 +123,2 @@ paths['/brand/{brandId}/revet']['put']['responses']['200']['content']['application/json'];
 
-      externalVettings(
-        params?: BrandsListExternalVettingsPathParams,
-        options?: RequestOptions,
-      ): Promise<Telnyx.Response<Telnyx.BrandsListExternalVettingsResponse>>;
-
       listExternalVettings(
@@ -127,2 +131,3 @@ pathParams: BrandsListExternalVettingsPathParams,
         pathParams: BrandsExportExternalVettingsPathParams,
+        params: BrandsExportExternalVettingsParams,
         options?: RequestOptions,
@@ -133,2 +138,3 @@ ): Promise<Telnyx.Response<Telnyx.BrandsExportExternalVettingsResponse>>;
         pathParams: BrandsOrderExternalVettingsPathParams,
+        params: BrandsOrderExternalVettingsParams,
         options?: RequestOptions,
@@ -139,2 +145,3 @@ ): Promise<Telnyx.Response<Telnyx.BrandsOrderExternalVettingsResponse>>;
         pathParams: BrandsRevetPathParams,
+        params: BrandsRevetParams,
         options?: RequestOptions,
@@ -141,0 +148,0 @@ ): Promise<Telnyx.Response<Telnyx.BrandsRevetResponse>>;

dist/types/index.d.ts

@@ -8,3 +8,3 @@ /* eslint-disable @typescript-eslint/triple-slash-reference */
 
-// Resources Imports
+// Resources imports
 ///<reference path='./AiAssistantsResource.d.ts' />
@@ -21,2 +21,3 @@ ///<reference path='./AiAudioTranscriptionsResource.d.ts' />
 ///<reference path='./AccessIpRangesResource.d.ts' />
+///<reference path='./AuthenticationProvidersResource.d.ts' />
 ///<reference path='./AutorespConfigsResource.d.ts' />
@@ -29,5 +30,16 @@ ///<reference path='./AddressesResource.d.ts' />
 ///<reference path='./CallsResource.d.ts' />
+///<reference path='./CallControlApplicationsResource.d.ts' />
+///<reference path='./CallEventsResource.d.ts' />
+///<reference path='./CallRecordingsResource.d.ts' />
+///<reference path='./CdrUsageReportsResource.d.ts' />
+///<reference path='./ChannelzonesResource.d.ts' />
+///<reference path='./ConferencesResource.d.ts' />
+///<reference path='./ConnectionsResource.d.ts' />
+///<reference path='./CredentialConnectionsResource.d.ts' />
+///<reference path='./DocumentLinksResource.d.ts' />
+///<reference path='./DocumentsResource.d.ts' />
 ///<reference path='./MessagingProfilesResource.d.ts' />
 ///<reference path='./MessagingProfileMetricsResource.d.ts' />
 ///<reference path='./PhoneNumberAssignmentByProfileResource.d.ts' />
+///<reference path='./TelephonyCredentialsResource.d.ts' />
 ///<reference path='./StorageBucketsResource.d.ts' />
@@ -60,2 +72,3 @@ //
     accessIpRanges: Telnyx.AccessIpRangesResource;
+    authenticationProviders: Telnyx.AuthenticationProvidersResource;
     autorespConfigs: Telnyx.AutorespConfigsResource;
@@ -68,2 +81,13 @@ addresses: Telnyx.AddressesResource;
     calls: Telnyx.CallsResource;
+    callControlApplications: Telnyx.CallControlApplicationsResource;
+    callEvents: Telnyx.CallEventsResource;
+    callRecordings: Telnyx.CallRecordingsResource;
+    cdrUsageReports: Telnyx.CdrUsageReportsResource;
+    channelzones: Telnyx.ChannelzonesResource;
+    conferences: Telnyx.ConferencesResource;
+    connections: Telnyx.ConnectionsResource;
+    credentialConnections: Telnyx.CredentialConnectionsResource;
+    documentLinks: Telnyx.DocumentLinksResource;
+    documents: Telnyx.DocumentsResource;
+    telephonyCredentials: Telnyx.TelephonyCredentialsResource;
     messagingProfiles: Telnyx.MessagingProfilesResource;
@@ -70,0 +94,0 @@ phoneNumberAssignmentByProfileResource: Telnyx.PhoneNumberAssignmentByProfileResource;

package.json

 {
   "name": "telnyx",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.4",
   "description": "Telnyx API Node SDK",
@@ -5,0 +5,0 @@ "keywords": [

No alert changes

Improved metrics

Total package byte prevSize

2385636

increased by1.42%

Number of package files

199

increased by4.74%

Lines of code

72417

increased by0.91%

No dependency changes