telnyx 2.0.0-alpha.3 → 2.0.0-alpha.5

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 ## v2
 
+### v2.0.0-alpha.5
+
+- Remove `ClientStateUpdate` resource
+- Remove `MessagesAlphanumericSenderId` resource
+- Remove `MessagingHostedNumber` resource
+- Remove `MessagingPhoneNumbers` resource
+- Remove `MessagingSenderIds` resource
+- Remove `PublicKey` resource
+- Remove `UpdateClientState` resource
+- Remove `Debugging` dupe resource
+- Update syntax on `Events` resources
+- Update `ExternalConnections` stale resource
+- Update `Messages` stale resource
+- Update `Ip`s stale resources
+- Update `AutorespConfigs` stale resource
+- Update `DetailRecords` stale resource
+- Update `InventoryCoverage` stale resource
+
+### 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
 
 - Update typing on Nested Resources

package/VERSION

@@ -1 +1 @@
-2.0.0-alpha.3
+2.0.0-alpha.5

package/dist/resources/AuditEvents.js

@@ -0,0 +1,5 @@
+import TelnyxResource from '../TelnyxResource';
+export const AuditEvents = TelnyxResource.extend({
+    path: 'audit_events',
+    includeBasic: ['list'],
+});

package/dist/resources/AutorespConfigs.js

@@ -5,7 +5,7 @@ export const AutorespConfigs = TelnyxResource.extend({
     includeBasic: ['del', 'list', 'create', 'retrieve'],
     update: telnyxMethod({
         method: 'PUT',
-        path: '/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}',
+        path: '/{autoresp_cfg_id}',
         urlParams: ['profile_id', 'autoresp_cfg_id'],
     }),
 });

package/dist/resources/Brands.js

@@ -24,15 +24,11 @@ export const Brands = TelnyxResource.extend({
         path: '/brand/{brandId}/2faEmail',
         urlParams: ['brandId'],
     }),
-    externalVettings: telnyxMethod({
-        method: 'GET',
-        path: '/brand/{brandId}/externalVetting',
-        urlParams: ['brandId'],
-    }),
     listExternalVettings: telnyxMethod({
         method: 'GET',
         path: '/brand/{brandId}/externalVetting',
         urlParams: ['brandId'],
+        methodType: 'list',
     }),
     exportExternalVettings: telnyxMethod({
         method: 'PUT',

package/dist/resources/CallControlApplications.js

@@ -21,11 +21,7 @@ function transformResponseData(response, telnyx) {
 }
 export const CallControlApplications = TelnyxResource.extend({
     path: 'call_control_applications',
-    list: telnyxMethod({
-        method: 'GET',
-        methodType: 'list',
-        transformResponseData: transformResponseData,
-    }),
+    includeBasic: ['list', 'update'],
     create: telnyxMethod({
         method: 'POST',
         transformResponseData: transformResponseData,

package/dist/resources/CallRecordings.js

@@ -2,21 +2,19 @@ import TelnyxResource from '../TelnyxResource';
 const telnyxMethod = TelnyxResource.method;
 export const CallRecordings = TelnyxResource.extend({
     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}',
-    }),
 });

package/dist/resources/Calls.js

@@ -60,5 +60,10 @@ export const Calls = TelnyxResource.extend({
             return utils.addResourceToResponseData(response, telnyx, 'calls', utils.createNestedMethods(telnyxMethod, CALL_COMMANDS, getSpec(response.data.call_control_id)));
         },
     }),
+    updateClientState: telnyxMethod({
+        path: '/{call_control_id}/actions/client_state_update',
+        urlParams: ['call_control_id'],
+        method: 'PUT',
+    }),
     instanceMethods: utils.createNestedMethods(telnyxMethod, CALL_COMMANDS, getSpec()),
 });

package/dist/resources/CdrUsageReports.js

@@ -1,10 +1,10 @@
 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: [],
     }),
 });

package/dist/resources/Channelzones.js

@@ -1,22 +1,30 @@
 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'],
     }),
 });

package/dist/resources/Conferences.js

@@ -14,7 +14,8 @@ const CONFERENCES = [
     'record_stop',
     'update',
     'leave',
-    'resume',
+    'record_resume',
+    'record_pause',
 ];
 function getSpec(conferenceId) {
     return function (methodName) {
@@ -30,7 +31,15 @@ function getSpec(conferenceId) {
 }
 export const Conferences = TelnyxResource.extend({
     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({
         method: 'POST',
         transformResponseData: function (response, telnyx) {

package/dist/resources/Connections.js

@@ -1,5 +1,10 @@
 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',
+    }),
 });

package/dist/resources/CustomerServiceRecords.js

@@ -0,0 +1,15 @@
+import TelnyxResource from '../TelnyxResource';
+const telnyxMethod = TelnyxResource.method;
+export const CustomerServiceRecords = TelnyxResource.extend({
+    path: 'customer_service_records',
+    includeBasic: ['list', 'create'],
+    retrieve: telnyxMethod({
+        method: 'GET',
+        path: '/{customer_service_record_id}',
+        urlParams: ['customer_service_record_id'],
+    }),
+    verifyPhoneNumbersCoverage: telnyxMethod({
+        method: 'POST',
+        path: '/phone_number_coverages',
+    }),
+});

package/dist/resources/DetailRecords.js

@@ -2,7 +2,7 @@ import TelnyxResource from '../TelnyxResource';
 const telnyxMethod = TelnyxResource.method;
 export const DetailRecords = TelnyxResource.extend({
     path: 'detail_records',
-    query: telnyxMethod({
+    search: telnyxMethod({
         method: 'GET',
         methodType: 'list',
     }),

package/dist/resources/DialogflowConnections.js

@@ -0,0 +1,26 @@
+import TelnyxResource from '../TelnyxResource';
+const telnyxMethod = TelnyxResource.method;
+export const DialogflowConnections = TelnyxResource.extend({
+    path: 'dialogflow_connections',
+    retrieve: telnyxMethod({
+        method: 'GET',
+        path: '/{connection_id}',
+        urlParams: ['connection_id'],
+        methodType: 'retrieve',
+    }),
+    create: telnyxMethod({
+        method: 'POST',
+        path: '/{connection_id}',
+        urlParams: ['connection_id'],
+    }),
+    update: telnyxMethod({
+        method: 'PUT',
+        path: '/{connection_id}',
+        urlParams: ['connection_id'],
+    }),
+    del: telnyxMethod({
+        method: 'DELETE',
+        path: '/{connection_id}',
+        urlParams: ['connection_id'],
+    }),
+});

package/dist/resources/Documents.js

@@ -1,44 +1,17 @@
 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({
-        method: 'GET',
-        path: '/{id}',
-        urlParams: ['id'],
-        transformResponseData: transformResponseData,
     }),
-    retrieveDownloadDocument: telnyxMethod({
+    download: telnyxMethod({
         method: 'GET',
         path: '/{id}/download',
         urlParams: ['id'],
         headers: {
             'Content-Type': '*',
         },
-        transformResponseData: transformResponseData,
     }),
 });

package/dist/resources/ExternalConnections.js

@@ -2,70 +2,74 @@ import TelnyxResource from '../TelnyxResource';
 const telnyxMethod = TelnyxResource.method;
 export const ExternalConnections = TelnyxResource.extend({
     path: 'external_connections',
-    includeBasic: ['list', 'retrieve', 'create', 'delete'],
-    GetExternalConnectionUploadsStatus: telnyxMethod({
+    includeBasic: ['list', 'retrieve', 'create', 'update', 'del'],
+    listLogMessages: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/uploads/status',
+        path: '/log/messages',
     }),
-    ListExternalConnectionReleases: telnyxMethod({
+    retrieveLogMessage: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/releases',
+        path: '/log/messages/{id}',
+        urlParams: ['id'],
     }),
-    RetryUpload: telnyxMethod({
-        method: 'POST',
-        path: '/external_connections/{id}/uploads/{ticketIid}/retry',
-    }),
-    DeleteExternalConnection: telnyxMethod({
+    delLogMessage: telnyxMethod({
         method: 'DELETE',
-        path: '/external_connections/{id}',
+        path: '/log/messages/{id}',
+        urlParams: ['id'],
     }),
-    updateLocation: telnyxMethod({
-        method: 'PATCH',
-        path: '/v2/external_connections/{id}/locations/{location_id}',
-        urlParams: ['id', 'location_id'],
-    }),
-    DeleteExternalConnectionLogMessage: telnyxMethod({
-        method: 'DELETE',
-        path: '/external_connections/log/messages/{id}',
+    listCivicAddresses: telnyxMethod({
+        method: 'GET',
+        path: '/{id}/civic_addresses',
+        urlParams: ['id'],
     }),
-    GetExternalConnectionCivicAddress: telnyxMethod({
+    retrieveCivicAddress: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/civic/addresses/{address_id}',
+        path: '/{id}/civic_addresses/{address_id}',
+        urlParams: ['id', 'address_id'],
     }),
-    ListExternalConnectionPhoneNumbers: telnyxMethod({
+    listPhoneNumbers: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/phone/numbers',
+        path: '/{id}/phone_numbers',
+        urlParams: ['id'],
     }),
-    ListExternalConnections: telnyxMethod({
+    retrievePhoneNumber: telnyxMethod({
         method: 'GET',
-        path: '/external_connections',
+        path: '/{id}/phone_numbers/{phone_number_id}',
+        urlParams: ['id', 'phone_number_id'],
     }),
-    GetExternalConnectionPhoneNumber: telnyxMethod({
+    listReleases: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/phone/numbers/{phone_number_id}',
+        path: '/{id}/releases',
+        urlParams: ['id'],
     }),
-    ListCivicAddresses: telnyxMethod({
+    retrieveRelease: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/civic_addresses',
+        path: '/{id}/releases/{release_id}',
+        urlParams: ['id', 'release_id'],
     }),
-    ListExternalConnectionLogMessages: telnyxMethod({
+    listUploads: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/log/messages',
+        path: '/{id}/uploads',
+        urlParams: ['id'],
     }),
-    GetExternalConnectionUpload: telnyxMethod({
+    retrieveUpload: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/uploads/{ticket_id}',
+        path: '/{id}/uploads/{ticket_id}',
+        urlParams: ['id', 'ticket_id'],
     }),
-    RefreshExternalConnectionUploads: telnyxMethod({
+    refreshUploads: telnyxMethod({
         method: 'POST',
-        path: '/external_connections/{id}/uploads/refresh',
+        path: '/{id}/uploads/refresh',
+        urlParams: ['id'],
     }),
-    GetExternalConnectionRelease: telnyxMethod({
+    retrieveUploadsStatus: telnyxMethod({
         method: 'GET',
-        path: '/external_connections/{id}/releases/{release_id}',
+        path: '/{id}/uploads/status',
+        urlParams: ['id'],
     }),
-    ListExternalConnectionUploads: telnyxMethod({
-        method: 'GET',
-        path: '/external_connections/{id}/uploads',
+    retryUpload: telnyxMethod({
+        method: 'POST',
+        path: '/{id}/uploads/{ticket_id}/retry',
+        urlParams: ['id', 'ticket_id'],
     }),
 });

package/dist/resources/FaxApplications.js

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

package/dist/resources/Faxes.js

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

package/dist/resources/FqdnConnections.js

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

package/dist/resources/Fqdns.js

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

package/dist/resources/InventoryCoverage.js

@@ -2,6 +2,10 @@ import TelnyxResource from '../TelnyxResource';
 const telnyxMethod = TelnyxResource.method;
 export const InventoryCoverage = TelnyxResource.extend({
     path: 'inventory_coverage',
+    list: telnyxMethod({
+        method: 'GET',
+        methodType: 'list',
+    }),
     request: telnyxMethod({
         method: 'GET',
         methodType: 'list',

package/dist/resources/Messages.js

@@ -1,9 +1,25 @@
 import TelnyxResource from '../TelnyxResource';
-import { MessagesAlphanumericSenderId } from './MessagesAlphanumericSenderId';
+const telnyxMethod = TelnyxResource.method;
 export const Messages = TelnyxResource.extend({
     path: 'messages',
     includeBasic: ['create', 'retrieve'],
-    nestedResources: {
-        AlphanumericSenderId: MessagesAlphanumericSenderId,
-    },
+    send: telnyxMethod({
+        method: 'POST',
+    }),
+    sendGroupMms: telnyxMethod({
+        method: 'POST',
+        path: '/group_mms',
+    }),
+    sendLongCode: telnyxMethod({
+        method: 'POST',
+        path: '/long_code',
+    }),
+    sendNumberPool: telnyxMethod({
+        method: 'POST',
+        path: '/number_pool',
+    }),
+    sendShortCode: telnyxMethod({
+        method: 'POST',
+        path: '/short_code',
+    }),
 });

package/dist/resources/MessagingHostedNumbers.js

@@ -1,5 +1,5 @@
 import TelnyxResource from '../TelnyxResource';
 export const MessagingHostedNumbers = TelnyxResource.extend({
-    path: '../id/actions/file_upload',
-    includeBasic: ['retrieve'],
+    path: 'messaging_hosted_numbers',
+    includeBasic: ['del'],
 });

package/dist/resources/NotificationEvents.js

@@ -0,0 +1,5 @@
+import TelnyxResource from '../TelnyxResource';
+export const NotificationEvents = TelnyxResource.extend({
+    path: 'notification_events',
+    includeBasic: ['list'],
+});

package/dist/resources/OutboundVoiceProfiles.js

@@ -21,11 +21,7 @@ function transformResponseData(response, telnyx) {
 }
 export const OutboundVoiceProfiles = TelnyxResource.extend({
     path: 'outbound_voice_profiles',
-    list: telnyxMethod({
-        method: 'GET',
-        methodType: 'list',
-        transformResponseData: transformResponseData,
-    }),
+    includeBasic: ['list', 'update', 'del'],
     create: telnyxMethod({
         method: 'POST',
         transformResponseData: transformResponseData,
@@ -36,8 +32,4 @@ export const OutboundVoiceProfiles = TelnyxResource.extend({
         urlParams: ['id'],
         transformResponseData: transformResponseData,
     }),
-    del: telnyxMethod({
-        method: 'DELETE',
-        path: '/{id}',
-    }),
 });

package/dist/resources/PhoneNumbersCsvDownloads.js

@@ -0,0 +1,5 @@
+import TelnyxResource from '../TelnyxResource';
+export const PhoneNumbersCsvDownloads = TelnyxResource.extend({
+    path: '/phone_numbers/csv_downloads',
+    includeBasic: ['list', 'create', 'retrieve'],
+});

package/dist/resources/PortingEvents.js

@@ -0,0 +1,11 @@
+import TelnyxResource from '../TelnyxResource';
+const telnyxMethod = TelnyxResource.method;
+export const PortingEvents = TelnyxResource.extend({
+    path: 'porting/events',
+    includeBasic: ['list', 'retrieve'],
+    republish: telnyxMethod({
+        method: 'POST',
+        path: '/{id}/republish',
+        urlParams: ['id'],
+    }),
+});

package/dist/resources/PortoutEvents.js

@@ -0,0 +1,11 @@
+import TelnyxResource from '../TelnyxResource';
+const telnyxMethod = TelnyxResource.method;
+export const PortoutEvents = TelnyxResource.extend({
+    path: 'portout/events',
+    includeBasic: ['list', 'retrieve'],
+    republish: telnyxMethod({
+        method: 'POST',
+        path: '/{id}/republish',
+        urlParams: ['id'],
+    }),
+});

package/dist/resources/RegulatoryRequirements.js

@@ -1,5 +1,5 @@
 import TelnyxResource from '../TelnyxResource';
 export const RegulatoryRequirements = TelnyxResource.extend({
     path: 'regulatory_requirements',
-    includeBasic: ['list', 'retrieve'],
+    includeBasic: ['list'],
 });

package/dist/resources/TelephonyCredentials.js

@@ -12,7 +12,7 @@ function transformResponseData(response, telnyx) {
         }),
     });
 }
-const telephonyCredentialResource = {
+export const TelephonyCredentials = TelnyxResource.extend({
     path: 'telephony_credentials',
     includeBasic: ['del', 'list', 'update'],
     create: telnyxMethod({
@@ -20,16 +20,18 @@ const telephonyCredentialResource = {
         transformResponseData: transformResponseData,
     }),
     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);
+});