telnyx 2.0.0-beta.6 → 2.0.1-beta.0

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 ## v2
 
+### v2.0.1
+
+- Add Messaging Inbound Webhook example
+- Add Calls `clientStateUpdate` method
+- Remove usage of `ResponsePayload` generic type with specific types from types definitions, since required types are not accepted
+- Remove `MessagingProfiles` resource `metrics` method
+- Unnest `PhoneNumbers` resource `inboundChannels` method
+- Update all type defs
+
+### v2.0.0
+
+- Typescript Support! :tada:
+
 ### v2.0.0-beta.6
 
 - Add `connections` example
@@ -394,7 +407,7 @@
 
 - **error-handling:** prevent undefined message on error handling
 
-## v1.0.0 (2019-8-2)
+### v1.0.0 (2019-8-2)
 
 ##### New Features
 

package/README.md

@@ -157,15 +157,16 @@ Telnyx, to the `constructEvent()` function; this will not work with a parsed
 (i.e., JSON) request body.
 
 You can find an example of how to use this with [Express](https://expressjs.com/)
-in the [`examples/webhook-signing`](examples/webhook-signing) folder, but here's
+in the [`examples/messaging-inbound-webhook`](examples/messaging-inbound-webhook) folder, but here's
 what it looks like:
 
 ```typescript
 const event = telnyx.webhooks.constructEvent(
-  webhookRawBody,
-  webhookTelnyxSignatureHeader,
+  webhookRawBody, // JSON stringified
+  webhookTelnyxSignatureHeader, // Buffer from base 64 encoded signature
   webhookTelnyxTimestampHeader,
-  publicKey,
+  publicKey, // Buffer from base 64 encoded public key
+  timeToleranceInSeconds, // Optional, defaults to 300 seconds
 );
 ```
 
@@ -179,11 +180,11 @@ You can find an example of how to use this with [Express](https://expressjs.com/
 const timeToleranceInSeconds = 300; // Will validate signatures of webhooks up to 5 minutes after Telnyx sent the request
 try {
   telnyx.webhooks.signature.verifySignature(
-    webhookRawBody,
-    webhookTelnyxSignatureHeader,
+    webhookRawBody, // JSON stringified
+    webhookTelnyxSignatureHeader, // Buffer from base 64 encoded signature
     webhookTelnyxTimestampHeader,
-    publicKey,
-    timeToleranceInSeconds,
+    publicKey, // Buffer from base 64 encoded public key
+    timeToleranceInSeconds, // Optional, defaults to 300 seconds
   );
 } catch (e) {
   console.log('Failed to validate the signature');

package/VERSION

@@ -1 +1 @@
-2.0.0-beta.6
+2.0.1-beta.0

package/dist/resources/Calls.js

@@ -56,7 +56,14 @@ function getSpec(callControlId) {
 }
 export const Calls = TelnyxResource.extend({
     path: 'calls',
-    includeBasic: ['retrieve'], // status method
+    retrieve: telnyxMethod({
+        method: 'GET',
+        path: '/{call_control_id}',
+        urlParams: ['call_control_id'],
+        transformResponseData: function (response, telnyx) {
+            return utils.addResourceToResponseData(response, telnyx, 'calls', utils.createNestedMethods(telnyxMethod, CALL_COMMANDS, getSpec(response.data.call_control_id)));
+        },
+    }),
     dial: telnyxMethod({
         // dial method
         method: 'POST',
@@ -71,6 +78,11 @@ export const Calls = TelnyxResource.extend({
             return utils.addResourceToResponseData(response, telnyx, 'calls', utils.createNestedMethods(telnyxMethod, CALL_COMMANDS, getSpec(response.data.call_control_id)));
         },
     }),
+    clientStateUpdate: telnyxMethod({
+        path: '/{call_control_id}/actions/client_state_update',
+        urlParams: ['call_control_id'],
+        method: 'PUT',
+    }),
     updateClientState: telnyxMethod({
         path: '/{call_control_id}/actions/client_state_update',
         urlParams: ['call_control_id'],

package/dist/resources/Channelzones.js

@@ -4,7 +4,7 @@ export const Channelzones = TelnyxResource.extend({
     path: 'channel_zones',
     includeBasic: ['list'],
     update: telnyxMethod({
-        method: 'PATCH',
+        method: 'PUT',
         path: '/{channel_zone_id}',
         urlParams: ['channel_zone_id'],
     }),
@@ -13,18 +13,4 @@ export const Channelzones = TelnyxResource.extend({
         path: '/{channel_zone_id}',
         urlParams: ['channel_zone_id'],
     }),
-    createPhoneNumber: telnyxMethod({
-        method: 'POST',
-        path: '/{channel_zone_id}/channel_zone_phone_numbers',
-        urlParams: ['channel_zone_id'],
-    }),
-    listPhoneNumbers: telnyxMethod({
-        method: 'GET',
-        path: '/{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/{PhoneNumbersInboundChannels.js → InboundChannels.js}

@@ -1,7 +1,7 @@
 import TelnyxResource from '../TelnyxResource.js';
 const telnyxMethod = TelnyxResource.method;
-export const PhoneNumbersInboundChannels = TelnyxResource.extend({
-    path: 'phone_numbers/inbound_channels',
+export const InboundChannels = TelnyxResource.extend({
+    path: 'inbound_channels',
     includeBasic: ['list'],
     update: telnyxMethod({
         method: 'PATCH',

package/dist/resources/MessagingProfiles.js

@@ -129,10 +129,4 @@ export const MessagingProfiles = TelnyxResource.extend({
         urlParams: ['profileId', 'autorespCfgId'],
         paramsNames: ['profileId', 'autorespCfgId'],
     }),
-    retrieveMetrics: telnyxMethod({
-        method: 'GET',
-        path: '/{id}/metrics',
-        urlParams: ['id'],
-        methodType: 'retrieve',
-    }),
 });

package/dist/resources/PhoneNumbers.js

@@ -2,7 +2,6 @@ import TelnyxResource from '../TelnyxResource.js';
 import * as utils from '../utils.js';
 import { PhoneNumbersMessaging } from './PhoneNumbersMessaging.js';
 import { PhoneNumbersVoice } from './PhoneNumbersVoice.js';
-import { PhoneNumbersInboundChannels } from './PhoneNumbersInboundChannels.js';
 const telnyxMethod = TelnyxResource.method;
 function transformResponseData(response, telnyx) {
     return utils.addResourceToResponseData(response, telnyx, 'phoneNumbers', {
@@ -28,7 +27,6 @@ export const PhoneNumbers = TelnyxResource.extend({
     nestedResources: {
         Messaging: PhoneNumbersMessaging,
         Voice: PhoneNumbersVoice,
-        Inbound: PhoneNumbersInboundChannels,
     },
     retrieve: telnyxMethod({
         method: 'GET',

package/dist/telnyx.js

@@ -63,7 +63,6 @@ import { MediaStorageApi } from './resources/MediaStorageApi.js';
 import { Messages } from './resources/Messages.js';
 import { MessagingHostedNumberOrders } from './resources/MessagingHostedNumberOrders.js';
 import { MessagingHostedNumbers } from './resources/MessagingHostedNumbers.js';
-import { MessagingProfileMetrics } from './resources/MessagingProfileMetrics.js';
 import { MessagingProfiles } from './resources/MessagingProfiles.js';
 import { MessagingShortCodes } from './resources/MessagingShortCodes.js';
 import { MessagingTollfreeVerification } from './resources/MessagingTollfreeVerification.js';
@@ -87,7 +86,7 @@ import { PhoneNumberBlockOrders } from './resources/PhoneNumberBlockOrders.js';
 import { PhoneNumberBlocksBackgroundJobs } from './resources/PhoneNumberBlocksBackgroundJobs.js';
 import { PhoneNumberCampaigns } from './resources/PhoneNumberCampaigns.js';
 import { PhoneNumbers } from './resources/PhoneNumbers.js';
-import { PhoneNumbersInboundChannels } from './resources/PhoneNumbersInboundChannels.js';
+import { InboundChannels } from './resources/InboundChannels.js';
 import { PhoneNumbersMessaging } from './resources/PhoneNumbersMessaging.js';
 import { PhoneNumbersRegulatoryRequirements } from './resources/PhoneNumbersRegulatoryRequirements.js';
 import { PhoneNumbersSlim } from './resources/PhoneNumbersSlim.js';
@@ -216,6 +215,7 @@ export function createTelnyx() {
         FqdnConnections,
         Fqdns,
         GlobalIps,
+        InboundChannels,
         InventoryCoverage,
         IpConnections,
         Ips,
@@ -226,7 +226,6 @@ export function createTelnyx() {
         Messages,
         MessagingHostedNumberOrders,
         MessagingHostedNumbers,
-        MessagingProfileMetrics,
         MessagingProfiles,
         MessagingShortCodes,
         MessagingTollfreeVerification,
@@ -252,7 +251,6 @@ export function createTelnyx() {
         PhoneNumbersRegulatoryRequirements,
         PhoneNumbersSlim,
         PhoneNumbers,
-        PhoneNumbersInboundChannels,
         PhoneNumbersMessaging,
         PhoneNumbersVoice,
         PhoneNumbersCsvDownloads,

package/dist/types/CallsResource.d.ts

@@ -129,6 +129,10 @@ declare module 'telnyx' {
       paths['/calls/{call_control_id}/actions/leave_queue']['post']['parameters']['path']['call_control_id'];
     type CallsLeaveQueueParams =
       paths['/calls/{call_control_id}/actions/leave_queue']['post']['requestBody']['content']['application/json'];
+    type CallsClientStateUpdateId =
+      paths['/calls/{call_control_id}/actions/client_state_update']['put']['parameters']['path']['call_control_id'];
+    type CallsClientStateUpdateParams =
+      paths['/calls/{call_control_id}/actions/client_state_update']['put']['requestBody']['content']['application/json'];
 
     type CallsAnswerResponse =
       paths['/calls/{call_control_id}/actions/answer']['post']['responses']['200']['content']['application/json'];
@@ -186,6 +190,8 @@ declare module 'telnyx' {
       paths['/calls/{call_control_id}/actions/enqueue']['post']['responses']['200']['content']['application/json'];
     type CallsLeaveQueueResponse =
       paths['/calls/{call_control_id}/actions/leave_queue']['post']['responses']['200']['content']['application/json'];
+    type CallsClientStateUpdateResponse =
+      paths['/calls/{call_control_id}/actions/client_state_update']['put']['responses']['200']['content']['application/json'];
 
     type CallsNestedMethods = {
       answer(
@@ -300,6 +306,10 @@ declare module 'telnyx' {
         params: CallsLeaveQueueParams,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.CallsLeaveQueueResponse>>;
+      clientStateUpdate(
+        params: CallsClientStateUpdateParams,
+        options?: RequestOptions,
+      ): Promise<Telnyx.Response<Telnyx.CallsClientStateUpdateResponse>>;
     };
 
     class CallsResource {
@@ -468,6 +478,11 @@ declare module 'telnyx' {
         params: CallsLeaveQueueParams,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.CallsLeaveQueueResponse>>;
+      clientStateUpdate(
+        id: CallsClientStateUpdateId,
+        params: CallsClientStateUpdateParams,
+        options?: RequestOptions,
+      ): Promise<Telnyx.Response<Telnyx.CallsClientStateUpdateResponse>>;
     }
   }
 }

package/dist/types/ChannelzonesResource.d.ts

@@ -9,49 +9,13 @@ declare module 'telnyx' {
       paths['/channel_zones']['get']['responses']['200']['content']['application/json'];
 
     type ChannelzonesUpdateId =
-      paths['/channel_zones/{channel_zone_id}']['patch']['parameters']['path']['channel_zone_id'];
+      paths['/channel_zones/{channel_zone_id}']['put']['parameters']['path']['channel_zone_id'];
 
     type ChannelzonesUpdateParams =
-      paths['/channel_zones/{channel_zone_id}']['patch']['requestBody']['content']['application/json'];
+      paths['/channel_zones/{channel_zone_id}']['put']['requestBody']['content']['application/json'];
 
     type ChannelzonesUpdateResponse =
-      paths['/channel_zones/{channel_zone_id}']['patch']['responses']['200']['content']['application/json'];
-
-    type ChannelzonesRetrieveId =
-      paths['/channel_zones/{channel_zone_id}']['get']['parameters']['path']['channel_zone_id'];
-
-    type ChannelzonesRetrieveParams =
-      paths['/channel_zones/{channel_zone_id}']['get']['parameters']['query'];
-
-    type ChannelzonesRetrieveResponse =
-      paths['/channel_zones/{channel_zone_id}']['get']['responses']['200']['content']['application/json'];
-
-    type ChannelzonesPhoneNumbersListChannelzoneId =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers']['get']['parameters']['path']['channel_zone_id'];
-
-    type ChannelzonesPhoneNumbersListParams =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers']['get']['parameters']['query'];
-
-    type ChannelzonesPhoneNumbersListResponse =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers']['get']['responses']['200']['content']['application/json'];
-
-    type ChannelzonesPhoneNumbersCreateChannelZoneId =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers']['post']['parameters']['path']['channel_zone_id'];
-
-    type ChannelzonesPhoneNumbersCreateParams =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers']['post']['requestBody']['content']['application/json'];
-
-    type ChannelzonesPhoneNumbersCreateResponse =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers']['post']['responses']['200']['content']['application/json'];
-
-    type ChannelzonesPhoneNumbersDeleteChannelzoneId =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}']['delete']['parameters']['path']['channel_zone_id'];
-
-    type ChannelzonesPhoneNumbersDeletePhoneNumber =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}']['delete']['parameters']['path']['phone_number'];
-
-    type ChannelzonesPhoneNumbersDeleteResponse =
-      paths['/channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}']['delete']['responses']['200']['content'];
+      paths['/channel_zones/{channel_zone_id}']['put']['responses']['200']['content']['application/json'];
 
     class ChannelzonesResource {
       list(
@@ -64,33 +28,6 @@ declare module 'telnyx' {
         params: ChannelzonesUpdateParams,
         options?: RequestOptions,
       ): Promise<Telnyx.Response<Telnyx.ChannelzonesUpdateResponse>>;
-
-      retrieve(
-        id: ChannelzonesRetrieveId,
-        options?: RequestOptions,
-      ): Promise<Telnyx.Response<Telnyx.ChannelzonesRetrieveResponse>>;
-
-      listPhoneNumbers(
-        id: ChannelzonesPhoneNumbersListChannelzoneId,
-        params?: ChannelzonesPhoneNumbersListParams,
-        options?: RequestOptions,
-      ): Promise<Telnyx.Response<Telnyx.ChannelzonesPhoneNumbersListResponse>>;
-
-      createPhoneNumber(
-        id: ChannelzonesPhoneNumbersCreateChannelZoneId,
-        params: ChannelzonesPhoneNumbersCreateParams,
-        options?: RequestOptions,
-      ): Promise<
-        Telnyx.Response<Telnyx.ChannelzonesPhoneNumbersCreateResponse>
-      >;
-
-      delPhoneNumber(
-        id: ChannelzonesPhoneNumbersDeleteChannelzoneId,
-        phoneNumber: ChannelzonesPhoneNumbersDeletePhoneNumber,
-        options?: RequestOptions,
-      ): Promise<
-        Telnyx.Response<Telnyx.ChannelzonesPhoneNumbersDeleteResponse>
-      >;
     }
   }
 }

package/dist/types/DocumentsResource.d.ts

@@ -24,7 +24,7 @@ declare module 'telnyx' {
       paths['/documents/{id}']['patch']['parameters']['path']['id'];
 
     type DocumentsUpdateParams =
-      paths['/documents/{id}']['patch']['requestBody']['content']['application/json'];
+      NonNullable<paths['/documents/{id}']['patch']['requestBody']>['content']['application/json'];
 
     type DocumentsUpdateResponse =
       paths['/documents/{id}']['patch']['responses']['200']['content']['application/json'];
@@ -42,7 +42,7 @@ declare module 'telnyx' {
       paths['/documents/{id}/download']['get']['parameters']['path']['id'];
 
     type DocumentsDownloadResponse =
-      paths['/documents/{id}/download']['get']['responses']['200']['content']['*'];
+      paths['/documents/{id}/download']['get']['responses']['200']['content']['*/*'];
 
     class DocumentsResource {
       list(

package/dist/types/Events.d.ts

@@ -55,6 +55,16 @@ declare module 'telnyx' {
         components['schemas']['CallSiprecStartedEvent'];
       type CallSiprecStoppedEvent =
         components['schemas']['CallSiprecStoppedEvent'];
+      type CallAIGatherMessageHistoryUpdatedEvent = 
+        components['schemas']['CallAIGatherMessageHistoryUpdatedEvent'];
+      type CallAIGatherPartialResultsEvent =
+        components['schemas']['CallAIGatherPartialResultsEvent'];
+      type CallConversationEndedEvent =
+        components['schemas']['callConversationEndedEvent'];
+      type CallConversationInsightsGeneratedEvent =
+        components['schemas']['callConversationInsightsGeneratedEvent'];
+      type CallRecordingTranscriptionSavedEvent =
+        components['schemas']['callRecordingTranscriptionSavedEvent'];
       type ConferenceCreatedEvent =
         components['schemas']['ConferenceCreatedEvent'];
       type ConferenceEndedEvent = components['schemas']['ConferenceEndedEvent'];
@@ -88,7 +98,6 @@ declare module 'telnyx' {
       type NotificationEvent = components['schemas']['NotificationEvent'];
       type NumberOrderBlockEvent =
         components['schemas']['NumberOrderBlockEvent'];
-      type NumberOrderedEvent = components['schemas']['NumberOrderedEvent'];
       type OutboundMessageEvent = components['schemas']['OutboundMessageEvent'];
       type PortingEvent = components['schemas']['PortingEvent'];
       type PortoutEvent = components['schemas']['PortoutEvent'];

package/dist/types/{PhoneNumbersInboundChannelsResource.d.ts → InboundChannelsResource.d.ts}

@@ -3,18 +3,18 @@ import {paths} from './TelnyxAPI.js';
 declare module 'telnyx' {
   namespace Telnyx {
     type PhoneNumbersInboundChannelsListParams =
-      paths['/phone_numbers/inbound_channels']['get']['parameters']['query'];
+      paths['/inbound_channels']['get']['parameters']['query'];
 
     type PhoneNumbersInboundChannelsListResponse =
-      paths['/phone_numbers/inbound_channels']['get']['responses']['200']['content']['application/json'];
+      paths['/inbound_channels']['get']['responses']['200']['content']['application/json'];
 
     type PhoneNumbersInboundChannelsUpdateParams =
-      paths['/phone_numbers/inbound_channels']['patch']['requestBody']['content']['application/json'];
+      paths['/inbound_channels']['patch']['requestBody']['content']['application/json'];
 
     type PhoneNumbersInboundChannelsUpdateResponse =
-      paths['/phone_numbers/inbound_channels']['patch']['responses']['200']['content']['application/json'];
+      paths['/inbound_channels']['patch']['responses']['200']['content']['application/json'];
 
-    class PhoneNumbersInboundChannelsResource {
+    class InboundChannelsResource {
       list(
         params?: PhoneNumbersInboundChannelsListParams,
         options?: RequestOptions,

package/dist/types/MessagingProfilesResource.d.ts

@@ -59,15 +59,6 @@ declare module 'telnyx' {
     type MessagingProfilesListShortCodesResponse =
       paths['/messaging_profiles/{id}/short_codes']['get']['responses']['200']['content']['application/json'];
 
-    type MessagingProfilesRetrieveMetricsId =
-      paths['/messaging_profiles/{id}/metrics']['get']['parameters']['path']['id'];
-
-    type MessagingProfilesRetrieveMetricsParams =
-      paths['/messaging_profiles/{id}/metrics']['get']['parameters']['query'];
-
-    type MessagingProfilesRetrieveMetricsResponse =
-      paths['/messaging_profiles/{id}/metrics']['get']['responses']['200']['content']['application/json'];
-
     type MessagingProfilesListAutorespConfigsId =
       paths['/messaging_profiles/{profile_id}/autoresp_configs']['get']['parameters']['path']['profile_id'];
 
@@ -141,13 +132,6 @@ declare module 'telnyx' {
       ): Promise<
         Telnyx.Response<Telnyx.MessagingProfilesListAutorespConfigsResponse>
       >;
-
-      retrieveMetrics(
-        params: MessagingProfilesRetrieveMetricsParams,
-        options?: RequestOptions,
-      ): Promise<
-        Telnyx.Response<Telnyx.MessagingProfilesRetrieveMetricsResponse>
-      >;
     };
 
     class MessagingProfilesResource {
@@ -209,14 +193,6 @@ declare module 'telnyx' {
         Telnyx.Response<Telnyx.MessagingProfilesListShortCodesResponse>
       >;
 
-      retrieveMetrics(
-        id: MessagingProfilesRetrieveMetricsId,
-        params: MessagingProfilesRetrieveMetricsParams,
-        options?: RequestOptions,
-      ): Promise<
-        Telnyx.Response<Telnyx.MessagingProfilesRetrieveMetricsResponse>
-      >;
-
       listAutorespConfigs(
         id: MessagingProfilesListAutorespConfigsId,
         params: MessagingProfilesListAutorespConfigsParams,