twilio 3.77.2 → 3.79.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +1 -1
  2. package/lib/rest/Insights.d.ts +0 -2
  3. package/lib/rest/Insights.js +0 -8
  4. package/lib/rest/Lookups.d.ts +2 -0
  5. package/lib/rest/Lookups.js +11 -0
  6. package/lib/rest/api/v2010/account/call/payment.d.ts +1 -1
  7. package/lib/rest/api/v2010/account/call/payment.js +1 -1
  8. package/lib/rest/api/v2010/account/usage/record/allTime.d.ts +1 -1
  9. package/lib/rest/api/v2010/account/usage/record/daily.d.ts +1 -1
  10. package/lib/rest/api/v2010/account/usage/record/lastMonth.d.ts +1 -1
  11. package/lib/rest/api/v2010/account/usage/record/monthly.d.ts +1 -1
  12. package/lib/rest/api/v2010/account/usage/record/thisMonth.d.ts +1 -1
  13. package/lib/rest/api/v2010/account/usage/record/today.d.ts +1 -1
  14. package/lib/rest/api/v2010/account/usage/record/yearly.d.ts +1 -1
  15. package/lib/rest/api/v2010/account/usage/record/yesterday.d.ts +1 -1
  16. package/lib/rest/api/v2010/account/usage/record.d.ts +1 -1
  17. package/lib/rest/api/v2010/account/usage/trigger.d.ts +1 -1
  18. package/lib/rest/conversations/v1/conversation/participant.js +4 -2
  19. package/lib/rest/conversations/v1/service/conversation/participant.js +4 -2
  20. package/lib/rest/insights/V1.d.ts +0 -3
  21. package/lib/rest/insights/V1.js +0 -11
  22. package/lib/rest/insights/v1/{annotation.d.ts → call/annotation.d.ts} +29 -17
  23. package/lib/rest/insights/v1/{annotation.js → call/annotation.js} +72 -55
  24. package/lib/rest/insights/v1/call/summary.d.ts +2 -0
  25. package/lib/rest/insights/v1/call/summary.js +2 -0
  26. package/lib/rest/insights/v1/call.d.ts +7 -16
  27. package/lib/rest/insights/v1/call.js +28 -16
  28. package/lib/rest/lookups/V2.d.ts +25 -0
  29. package/lib/rest/lookups/V2.js +47 -0
  30. package/lib/rest/lookups/v2/phoneNumber.d.ts +180 -0
  31. package/lib/rest/lookups/v2/phoneNumber.js +359 -0
  32. package/lib/rest/media/v1/mediaRecording.d.ts +2 -4
  33. package/lib/rest/media/v1/mediaRecording.js +2 -4
  34. package/lib/rest/supersim/v1/sim/simIpAddress.d.ts +246 -0
  35. package/lib/rest/supersim/v1/sim/simIpAddress.js +448 -0
  36. package/lib/rest/supersim/v1/sim.d.ts +7 -0
  37. package/lib/rest/supersim/v1/sim.js +28 -0
  38. package/lib/rest/verify/v2/service/verificationCheck.d.ts +8 -2
  39. package/lib/rest/verify/v2/service/verificationCheck.js +8 -9
  40. package/lib/twiml/VoiceResponse.d.ts +81 -4
  41. package/lib/twiml/VoiceResponse.js +111 -3
  42. package/package.json +1 -1
@@ -14,7 +14,7 @@ type TriggerRecurring = 'daily'|'monthly'|'yearly'|'alltime';
14
14
 
15
15
  type TriggerTriggerField = 'count'|'usage'|'price';
16
16
 
17
- type TriggerUsageCategory = 'a2p-registration-fees'|'agent-conference'|'answering-machine-detection'|'authy-authentications'|'authy-calls-outbound'|'authy-monthly-fees'|'authy-phone-intelligence'|'authy-phone-verifications'|'authy-sms-outbound'|'call-progess-events'|'calleridlookups'|'calls'|'calls-client'|'calls-globalconference'|'calls-inbound'|'calls-inbound-local'|'calls-inbound-mobile'|'calls-inbound-tollfree'|'calls-outbound'|'calls-pay-verb-transactions'|'calls-recordings'|'calls-sip'|'calls-sip-inbound'|'calls-sip-outbound'|'calls-transfers'|'carrier-lookups'|'conversations'|'conversations-api-requests'|'conversations-conversation-events'|'conversations-endpoint-connectivity'|'conversations-events'|'conversations-participant-events'|'conversations-participants'|'cps'|'flex-usage'|'fraud-lookups'|'group-rooms'|'group-rooms-data-track'|'group-rooms-encrypted-media-recorded'|'group-rooms-media-downloaded'|'group-rooms-media-recorded'|'group-rooms-media-routed'|'group-rooms-media-stored'|'group-rooms-participant-minutes'|'group-rooms-recorded-minutes'|'imp-v1-usage'|'lookups'|'marketplace'|'marketplace-algorithmia-named-entity-recognition'|'marketplace-cadence-transcription'|'marketplace-cadence-translation'|'marketplace-capio-speech-to-text'|'marketplace-convriza-ababa'|'marketplace-deepgram-phrase-detector'|'marketplace-digital-segment-business-info'|'marketplace-facebook-offline-conversions'|'marketplace-google-speech-to-text'|'marketplace-ibm-watson-message-insights'|'marketplace-ibm-watson-message-sentiment'|'marketplace-ibm-watson-recording-analysis'|'marketplace-ibm-watson-tone-analyzer'|'marketplace-icehook-systems-scout'|'marketplace-infogroup-dataaxle-bizinfo'|'marketplace-keen-io-contact-center-analytics'|'marketplace-marchex-cleancall'|'marketplace-marchex-sentiment-analysis-for-sms'|'marketplace-marketplace-nextcaller-social-id'|'marketplace-mobile-commons-opt-out-classifier'|'marketplace-nexiwave-voicemail-to-text'|'marketplace-nextcaller-advanced-caller-identification'|'marketplace-nomorobo-spam-score'|'marketplace-payfone-tcpa-compliance'|'marketplace-remeeting-automatic-speech-recognition'|'marketplace-tcpa-defense-solutions-blacklist-feed'|'marketplace-telo-opencnam'|'marketplace-truecnam-true-spam'|'marketplace-twilio-caller-name-lookup-us'|'marketplace-twilio-carrier-information-lookup'|'marketplace-voicebase-pci'|'marketplace-voicebase-transcription'|'marketplace-voicebase-transcription-custom-vocabulary'|'marketplace-whitepages-pro-caller-identification'|'marketplace-whitepages-pro-phone-intelligence'|'marketplace-whitepages-pro-phone-reputation'|'marketplace-wolfarm-spoken-results'|'marketplace-wolfram-short-answer'|'marketplace-ytica-contact-center-reporting-analytics'|'mediastorage'|'mms'|'mms-inbound'|'mms-inbound-longcode'|'mms-inbound-shortcode'|'mms-messages-carrierfees'|'mms-outbound'|'mms-outbound-longcode'|'mms-outbound-shortcode'|'monitor-reads'|'monitor-storage'|'monitor-writes'|'notify'|'notify-actions-attempts'|'notify-channels'|'number-format-lookups'|'pchat'|'pchat-users'|'peer-to-peer-rooms-participant-minutes'|'pfax'|'pfax-minutes'|'pfax-minutes-inbound'|'pfax-minutes-outbound'|'pfax-pages'|'phonenumbers'|'phonenumbers-cps'|'phonenumbers-emergency'|'phonenumbers-local'|'phonenumbers-mobile'|'phonenumbers-setups'|'phonenumbers-tollfree'|'premiumsupport'|'proxy'|'proxy-active-sessions'|'pstnconnectivity'|'pv'|'pv-composition-media-downloaded'|'pv-composition-media-encrypted'|'pv-composition-media-stored'|'pv-composition-minutes'|'pv-recording-compositions'|'pv-room-participants'|'pv-room-participants-au1'|'pv-room-participants-br1'|'pv-room-participants-ie1'|'pv-room-participants-jp1'|'pv-room-participants-sg1'|'pv-room-participants-us1'|'pv-room-participants-us2'|'pv-rooms'|'pv-sip-endpoint-registrations'|'recordings'|'recordingstorage'|'rooms-group-bandwidth'|'rooms-group-minutes'|'rooms-peer-to-peer-minutes'|'shortcodes'|'shortcodes-customerowned'|'shortcodes-mms-enablement'|'shortcodes-mps'|'shortcodes-random'|'shortcodes-uk'|'shortcodes-vanity'|'small-group-rooms'|'small-group-rooms-data-track'|'small-group-rooms-participant-minutes'|'sms'|'sms-inbound'|'sms-inbound-longcode'|'sms-inbound-shortcode'|'sms-messages-carrierfees'|'sms-messages-features'|'sms-messages-features-senderid'|'sms-outbound'|'sms-outbound-content-inspection'|'sms-outbound-longcode'|'sms-outbound-shortcode'|'speech-recognition'|'studio-engagements'|'sync'|'sync-actions'|'sync-endpoint-hours'|'sync-endpoint-hours-above-daily-cap'|'taskrouter-tasks'|'totalprice'|'transcriptions'|'trunking-cps'|'trunking-emergency-calls'|'trunking-origination'|'trunking-origination-local'|'trunking-origination-mobile'|'trunking-origination-tollfree'|'trunking-recordings'|'trunking-secure'|'trunking-termination'|'turnmegabytes'|'turnmegabytes-australia'|'turnmegabytes-brasil'|'turnmegabytes-germany'|'turnmegabytes-india'|'turnmegabytes-ireland'|'turnmegabytes-japan'|'turnmegabytes-singapore'|'turnmegabytes-useast'|'turnmegabytes-uswest'|'twilio-interconnect'|'verify-push'|'verify-totp'|'verify-whatsapp-conversations-business-initiated'|'video-recordings'|'voice-insights'|'voice-insights-client-insights-on-demand-minute'|'voice-insights-ptsn-insights-on-demand-minute'|'voice-insights-sip-interface-insights-on-demand-minute'|'voice-insights-sip-trunking-insights-on-demand-minute'|'wireless'|'wireless-orders'|'wireless-orders-artwork'|'wireless-orders-bulk'|'wireless-orders-esim'|'wireless-orders-starter'|'wireless-usage'|'wireless-usage-commands'|'wireless-usage-commands-africa'|'wireless-usage-commands-asia'|'wireless-usage-commands-centralandsouthamerica'|'wireless-usage-commands-europe'|'wireless-usage-commands-home'|'wireless-usage-commands-northamerica'|'wireless-usage-commands-oceania'|'wireless-usage-commands-roaming'|'wireless-usage-data'|'wireless-usage-data-africa'|'wireless-usage-data-asia'|'wireless-usage-data-centralandsouthamerica'|'wireless-usage-data-custom-additionalmb'|'wireless-usage-data-custom-first5mb'|'wireless-usage-data-domestic-roaming'|'wireless-usage-data-europe'|'wireless-usage-data-individual-additionalgb'|'wireless-usage-data-individual-firstgb'|'wireless-usage-data-international-roaming-canada'|'wireless-usage-data-international-roaming-india'|'wireless-usage-data-international-roaming-mexico'|'wireless-usage-data-northamerica'|'wireless-usage-data-oceania'|'wireless-usage-data-pooled'|'wireless-usage-data-pooled-downlink'|'wireless-usage-data-pooled-uplink'|'wireless-usage-mrc'|'wireless-usage-mrc-custom'|'wireless-usage-mrc-individual'|'wireless-usage-mrc-pooled'|'wireless-usage-mrc-suspended'|'wireless-usage-sms'|'wireless-usage-voice';
17
+ type TriggerUsageCategory = 'a2p-registration-fees'|'agent-conference'|'amazon-polly'|'answering-machine-detection'|'authy-authentications'|'authy-calls-outbound'|'authy-monthly-fees'|'authy-phone-intelligence'|'authy-phone-verifications'|'authy-sms-outbound'|'call-progess-events'|'calleridlookups'|'calls'|'calls-client'|'calls-globalconference'|'calls-inbound'|'calls-inbound-local'|'calls-inbound-mobile'|'calls-inbound-tollfree'|'calls-outbound'|'calls-pay-verb-transactions'|'calls-recordings'|'calls-sip'|'calls-sip-inbound'|'calls-sip-outbound'|'calls-transfers'|'carrier-lookups'|'conversations'|'conversations-api-requests'|'conversations-conversation-events'|'conversations-endpoint-connectivity'|'conversations-events'|'conversations-participant-events'|'conversations-participants'|'cps'|'flex-usage'|'fraud-lookups'|'group-rooms'|'group-rooms-data-track'|'group-rooms-encrypted-media-recorded'|'group-rooms-media-downloaded'|'group-rooms-media-recorded'|'group-rooms-media-routed'|'group-rooms-media-stored'|'group-rooms-participant-minutes'|'group-rooms-recorded-minutes'|'imp-v1-usage'|'lookups'|'marketplace'|'marketplace-algorithmia-named-entity-recognition'|'marketplace-cadence-transcription'|'marketplace-cadence-translation'|'marketplace-capio-speech-to-text'|'marketplace-convriza-ababa'|'marketplace-deepgram-phrase-detector'|'marketplace-digital-segment-business-info'|'marketplace-facebook-offline-conversions'|'marketplace-google-speech-to-text'|'marketplace-ibm-watson-message-insights'|'marketplace-ibm-watson-message-sentiment'|'marketplace-ibm-watson-recording-analysis'|'marketplace-ibm-watson-tone-analyzer'|'marketplace-icehook-systems-scout'|'marketplace-infogroup-dataaxle-bizinfo'|'marketplace-keen-io-contact-center-analytics'|'marketplace-marchex-cleancall'|'marketplace-marchex-sentiment-analysis-for-sms'|'marketplace-marketplace-nextcaller-social-id'|'marketplace-mobile-commons-opt-out-classifier'|'marketplace-nexiwave-voicemail-to-text'|'marketplace-nextcaller-advanced-caller-identification'|'marketplace-nomorobo-spam-score'|'marketplace-payfone-tcpa-compliance'|'marketplace-remeeting-automatic-speech-recognition'|'marketplace-tcpa-defense-solutions-blacklist-feed'|'marketplace-telo-opencnam'|'marketplace-truecnam-true-spam'|'marketplace-twilio-caller-name-lookup-us'|'marketplace-twilio-carrier-information-lookup'|'marketplace-voicebase-pci'|'marketplace-voicebase-transcription'|'marketplace-voicebase-transcription-custom-vocabulary'|'marketplace-whitepages-pro-caller-identification'|'marketplace-whitepages-pro-phone-intelligence'|'marketplace-whitepages-pro-phone-reputation'|'marketplace-wolfarm-spoken-results'|'marketplace-wolfram-short-answer'|'marketplace-ytica-contact-center-reporting-analytics'|'mediastorage'|'mms'|'mms-inbound'|'mms-inbound-longcode'|'mms-inbound-shortcode'|'mms-messages-carrierfees'|'mms-outbound'|'mms-outbound-longcode'|'mms-outbound-shortcode'|'monitor-reads'|'monitor-storage'|'monitor-writes'|'notify'|'notify-actions-attempts'|'notify-channels'|'number-format-lookups'|'pchat'|'pchat-users'|'peer-to-peer-rooms-participant-minutes'|'pfax'|'pfax-minutes'|'pfax-minutes-inbound'|'pfax-minutes-outbound'|'pfax-pages'|'phonenumbers'|'phonenumbers-cps'|'phonenumbers-emergency'|'phonenumbers-local'|'phonenumbers-mobile'|'phonenumbers-setups'|'phonenumbers-tollfree'|'premiumsupport'|'proxy'|'proxy-active-sessions'|'pstnconnectivity'|'pv'|'pv-composition-media-downloaded'|'pv-composition-media-encrypted'|'pv-composition-media-stored'|'pv-composition-minutes'|'pv-recording-compositions'|'pv-room-participants'|'pv-room-participants-au1'|'pv-room-participants-br1'|'pv-room-participants-ie1'|'pv-room-participants-jp1'|'pv-room-participants-sg1'|'pv-room-participants-us1'|'pv-room-participants-us2'|'pv-rooms'|'pv-sip-endpoint-registrations'|'recordings'|'recordingstorage'|'rooms-group-bandwidth'|'rooms-group-minutes'|'rooms-peer-to-peer-minutes'|'shortcodes'|'shortcodes-customerowned'|'shortcodes-mms-enablement'|'shortcodes-mps'|'shortcodes-random'|'shortcodes-uk'|'shortcodes-vanity'|'small-group-rooms'|'small-group-rooms-data-track'|'small-group-rooms-participant-minutes'|'sms'|'sms-inbound'|'sms-inbound-longcode'|'sms-inbound-shortcode'|'sms-messages-carrierfees'|'sms-messages-features'|'sms-messages-features-senderid'|'sms-outbound'|'sms-outbound-content-inspection'|'sms-outbound-longcode'|'sms-outbound-shortcode'|'speech-recognition'|'studio-engagements'|'sync'|'sync-actions'|'sync-endpoint-hours'|'sync-endpoint-hours-above-daily-cap'|'taskrouter-tasks'|'totalprice'|'transcriptions'|'trunking-cps'|'trunking-emergency-calls'|'trunking-origination'|'trunking-origination-local'|'trunking-origination-mobile'|'trunking-origination-tollfree'|'trunking-recordings'|'trunking-secure'|'trunking-termination'|'turnmegabytes'|'turnmegabytes-australia'|'turnmegabytes-brasil'|'turnmegabytes-germany'|'turnmegabytes-india'|'turnmegabytes-ireland'|'turnmegabytes-japan'|'turnmegabytes-singapore'|'turnmegabytes-useast'|'turnmegabytes-uswest'|'twilio-interconnect'|'verify-push'|'verify-totp'|'verify-whatsapp-conversations-business-initiated'|'video-recordings'|'voice-insights'|'voice-insights-client-insights-on-demand-minute'|'voice-insights-ptsn-insights-on-demand-minute'|'voice-insights-sip-interface-insights-on-demand-minute'|'voice-insights-sip-trunking-insights-on-demand-minute'|'wireless'|'wireless-orders'|'wireless-orders-artwork'|'wireless-orders-bulk'|'wireless-orders-esim'|'wireless-orders-starter'|'wireless-usage'|'wireless-usage-commands'|'wireless-usage-commands-africa'|'wireless-usage-commands-asia'|'wireless-usage-commands-centralandsouthamerica'|'wireless-usage-commands-europe'|'wireless-usage-commands-home'|'wireless-usage-commands-northamerica'|'wireless-usage-commands-oceania'|'wireless-usage-commands-roaming'|'wireless-usage-data'|'wireless-usage-data-africa'|'wireless-usage-data-asia'|'wireless-usage-data-centralandsouthamerica'|'wireless-usage-data-custom-additionalmb'|'wireless-usage-data-custom-first5mb'|'wireless-usage-data-domestic-roaming'|'wireless-usage-data-europe'|'wireless-usage-data-individual-additionalgb'|'wireless-usage-data-individual-firstgb'|'wireless-usage-data-international-roaming-canada'|'wireless-usage-data-international-roaming-india'|'wireless-usage-data-international-roaming-mexico'|'wireless-usage-data-northamerica'|'wireless-usage-data-oceania'|'wireless-usage-data-pooled'|'wireless-usage-data-pooled-downlink'|'wireless-usage-data-pooled-uplink'|'wireless-usage-mrc'|'wireless-usage-mrc-custom'|'wireless-usage-mrc-individual'|'wireless-usage-mrc-pooled'|'wireless-usage-mrc-suspended'|'wireless-usage-sms'|'wireless-usage-voice';
18
18
 
19
19
  /**
20
20
  * Initialize the TriggerList
@@ -505,7 +505,8 @@ ParticipantPage.prototype[util.inspect.custom] = function inspect(depth,
505
505
  * @param {ParticipantPayload} payload - The instance payload
506
506
  * @param {sid} conversationSid -
507
507
  * The unique ID of the Conversation for this participant.
508
- * @param {sid} sid - A 34 character string that uniquely identifies this resource.
508
+ * @param {sid_like} sid -
509
+ * A 34 character string that uniquely identifies this resource.
509
510
  */
510
511
  /* jshint ignore:end */
511
512
  ParticipantInstance = function ParticipantInstance(version, payload,
@@ -651,7 +652,8 @@ ParticipantInstance.prototype[util.inspect.custom] = function inspect(depth,
651
652
  * @param {V1} version - Version of the resource
652
653
  * @param {sid_like} conversationSid -
653
654
  * The unique ID of the Conversation for this participant.
654
- * @param {sid} sid - A 34 character string that uniquely identifies this resource.
655
+ * @param {sid_like} sid -
656
+ * A 34 character string that uniquely identifies this resource.
655
657
  */
656
658
  /* jshint ignore:end */
657
659
  ParticipantContext = function ParticipantContext(version, conversationSid, sid)
@@ -527,7 +527,8 @@ ParticipantPage.prototype[util.inspect.custom] = function inspect(depth,
527
527
  * The SID of the Conversation Service that the resource is associated with.
528
528
  * @param {sid} conversationSid -
529
529
  * The unique ID of the Conversation for this participant.
530
- * @param {sid} sid - A 34 character string that uniquely identifies this resource.
530
+ * @param {sid_like} sid -
531
+ * A 34 character string that uniquely identifies this resource.
531
532
  */
532
533
  /* jshint ignore:end */
533
534
  ParticipantInstance = function ParticipantInstance(version, payload,
@@ -682,7 +683,8 @@ ParticipantInstance.prototype[util.inspect.custom] = function inspect(depth,
682
683
  * The SID of the Conversation Service that the resource is associated with.
683
684
  * @param {sid_like} conversationSid -
684
685
  * The unique ID of the Conversation for this participant.
685
- * @param {sid} sid - A 34 character string that uniquely identifies this resource.
686
+ * @param {sid_like} sid -
687
+ * A 34 character string that uniquely identifies this resource.
686
688
  */
687
689
  /* jshint ignore:end */
688
690
  ParticipantContext = function ParticipantContext(version, chatServiceSid,
@@ -7,8 +7,6 @@
7
7
 
8
8
  import Insights = require('../Insights');
9
9
  import Version = require('../../base/Version');
10
- import { AnnotationList } from './v1/annotation';
11
- import { AnnotationListInstance } from './v1/annotation';
12
10
  import { CallList } from './v1/call';
13
11
  import { CallListInstance } from './v1/call';
14
12
  import { CallSummariesList } from './v1/callSummaries';
@@ -29,7 +27,6 @@ declare class V1 extends Version {
29
27
  */
30
28
  constructor(domain: Insights);
31
29
 
32
- readonly annotation: AnnotationListInstance;
33
30
  readonly callSummaries: CallSummariesListInstance;
34
31
  readonly calls: CallListInstance;
35
32
  readonly conferences: ConferenceListInstance;
@@ -10,7 +10,6 @@
10
10
  /* jshint ignore:end */
11
11
 
12
12
  var _ = require('lodash'); /* jshint ignore:line */
13
- var AnnotationList = require('./v1/annotation').AnnotationList;
14
13
  var CallList = require('./v1/call').CallList;
15
14
  var CallSummariesList = require('./v1/callSummaries').CallSummariesList;
16
15
  var ConferenceList = require('./v1/conference').ConferenceList;
@@ -26,7 +25,6 @@ var Version = require('../../base/Version'); /* jshint ignore:line */
26
25
  * @constructor Twilio.Insights.V1
27
26
  *
28
27
  * @property {Twilio.Insights.V1.SettingList} settings - settings resource
29
- * @property {Twilio.Insights.V1.AnnotationList} annotation - annotation resource
30
28
  * @property {Twilio.Insights.V1.CallList} calls - calls resource
31
29
  * @property {Twilio.Insights.V1.CallSummariesList} callSummaries -
32
30
  * callSummaries resource
@@ -41,7 +39,6 @@ function V1(domain) {
41
39
 
42
40
  // Resources
43
41
  this._settings = undefined;
44
- this._annotation = undefined;
45
42
  this._calls = undefined;
46
43
  this._callSummaries = undefined;
47
44
  this._conferences = undefined;
@@ -59,14 +56,6 @@ Object.defineProperty(V1.prototype,
59
56
  }
60
57
  });
61
58
 
62
- Object.defineProperty(V1.prototype,
63
- 'annotation', {
64
- get: function() {
65
- this._annotation = this._annotation || new AnnotationList(this);
66
- return this._annotation;
67
- }
68
- });
69
-
70
59
  Object.defineProperty(V1.prototype,
71
60
  'calls', {
72
61
  get: function() {
@@ -5,10 +5,10 @@
5
5
  * / /
6
6
  */
7
7
 
8
- import Page = require('../../../base/Page');
9
- import Response = require('../../../http/response');
10
- import V1 = require('../V1');
11
- import { SerializableClass } from '../../../interfaces';
8
+ import Page = require('../../../../base/Page');
9
+ import Response = require('../../../../http/response');
10
+ import V1 = require('../../V1');
11
+ import { SerializableClass } from '../../../../interfaces';
12
12
 
13
13
  type AnnotationAnsweredBy = 'unknown_answered_by'|'human'|'machine';
14
14
 
@@ -19,20 +19,24 @@ type AnnotationQualityIssues = 'unknown_quality_issue'|'no_quality_issue'|'low_v
19
19
  /**
20
20
  * Initialize the AnnotationList
21
21
  *
22
+ * PLEASE NOTE that this class contains beta products that are subject to change.
23
+ * Use them with caution.
24
+ *
22
25
  * @param version - Version of the resource
26
+ * @param callSid - Call SID.
23
27
  */
24
- declare function AnnotationList(version: V1): AnnotationListInstance;
28
+ declare function AnnotationList(version: V1, callSid: string): AnnotationListInstance;
25
29
 
26
30
  /**
27
31
  * Options to pass to update
28
32
  *
29
- * @property answeredBy - The answered_by
30
- * @property callScore - The call_score
31
- * @property comment - The comment
32
- * @property connectivityIssue - The connectivity_issue
33
- * @property incident - The incident
34
- * @property qualityIssues - The quality_issues
35
- * @property spam - The spam
33
+ * @property answeredBy - Indicates the answering entity as determined by Answering Machine Detection.
34
+ * @property callScore - Call Score
35
+ * @property comment - User comments
36
+ * @property connectivityIssue - Indicates if the call had any connectivity issue
37
+ * @property incident - Call tag for incidents or support ticket
38
+ * @property qualityIssues - Indicates if the call had audio quality issues.
39
+ * @property spam - Call spam indicator
36
40
  */
37
41
  interface AnnotationInstanceUpdateOptions {
38
42
  answeredBy?: AnnotationAnsweredBy;
@@ -51,10 +55,8 @@ interface AnnotationListInstance {
51
55
  (sid: string): AnnotationContext;
52
56
  /**
53
57
  * Constructs a annotation
54
- *
55
- * @param callSid - The call_sid
56
58
  */
57
- get(callSid: string): AnnotationContext;
59
+ get(): AnnotationContext;
58
60
  /**
59
61
  * Provide a user-friendly representation
60
62
  */
@@ -78,6 +80,7 @@ interface AnnotationResource {
78
80
  }
79
81
 
80
82
  interface AnnotationSolution {
83
+ callSid?: string;
81
84
  }
82
85
 
83
86
 
@@ -85,8 +88,11 @@ declare class AnnotationContext {
85
88
  /**
86
89
  * Initialize the AnnotationContext
87
90
  *
91
+ * PLEASE NOTE that this class contains beta products that are subject to change.
92
+ * Use them with caution.
93
+ *
88
94
  * @param version - Version of the resource
89
- * @param callSid - The call_sid
95
+ * @param callSid - Call SID.
90
96
  */
91
97
  constructor(version: V1, callSid: string);
92
98
 
@@ -120,9 +126,12 @@ declare class AnnotationInstance extends SerializableClass {
120
126
  /**
121
127
  * Initialize the AnnotationContext
122
128
  *
129
+ * PLEASE NOTE that this class contains beta products that are subject to change.
130
+ * Use them with caution.
131
+ *
123
132
  * @param version - Version of the resource
124
133
  * @param payload - The instance payload
125
- * @param callSid - The call_sid
134
+ * @param callSid - Call SID.
126
135
  */
127
136
  constructor(version: V1, payload: AnnotationPayload, callSid: string);
128
137
 
@@ -167,6 +176,9 @@ declare class AnnotationPage extends Page<V1, AnnotationPayload, AnnotationResou
167
176
  /**
168
177
  * Initialize the AnnotationPage
169
178
  *
179
+ * PLEASE NOTE that this class contains beta products that are subject to change.
180
+ * Use them with caution.
181
+ *
170
182
  * @param version - Version of the resource
171
183
  * @param response - Response from the API
172
184
  * @param solution - Path solution
@@ -12,11 +12,11 @@
12
12
  var Q = require('q'); /* jshint ignore:line */
13
13
  var _ = require('lodash'); /* jshint ignore:line */
14
14
  var util = require('util'); /* jshint ignore:line */
15
- var Page = require('../../../base/Page'); /* jshint ignore:line */
15
+ var Page = require('../../../../base/Page'); /* jshint ignore:line */
16
16
  var deserialize = require(
17
- '../../../base/deserialize'); /* jshint ignore:line */
18
- var serialize = require('../../../base/serialize'); /* jshint ignore:line */
19
- var values = require('../../../base/values'); /* jshint ignore:line */
17
+ '../../../../base/deserialize'); /* jshint ignore:line */
18
+ var serialize = require('../../../../base/serialize'); /* jshint ignore:line */
19
+ var values = require('../../../../base/values'); /* jshint ignore:line */
20
20
 
21
21
  var AnnotationList;
22
22
  var AnnotationPage;
@@ -27,20 +27,24 @@ var AnnotationContext;
27
27
  /**
28
28
  * Initialize the AnnotationList
29
29
  *
30
- * @constructor Twilio.Insights.V1.AnnotationList
30
+ * PLEASE NOTE that this class contains beta products that are subject to change.
31
+ * Use them with caution.
32
+ *
33
+ * @constructor Twilio.Insights.V1.CallContext.AnnotationList
31
34
  *
32
35
  * @param {Twilio.Insights.V1} version - Version of the resource
36
+ * @param {string} callSid - Call SID.
33
37
  */
34
38
  /* jshint ignore:end */
35
- AnnotationList = function AnnotationList(version) {
39
+ AnnotationList = function AnnotationList(version, callSid) {
36
40
  /* jshint ignore:start */
37
41
  /**
38
42
  * @function annotation
39
- * @memberof Twilio.Insights.V1#
43
+ * @memberof Twilio.Insights.V1.CallContext#
40
44
  *
41
45
  * @param {string} sid - sid of instance
42
46
  *
43
- * @returns {Twilio.Insights.V1.AnnotationContext}
47
+ * @returns {Twilio.Insights.V1.CallContext.AnnotationContext}
44
48
  */
45
49
  /* jshint ignore:end */
46
50
  function AnnotationListInstance(sid) {
@@ -49,21 +53,19 @@ AnnotationList = function AnnotationList(version) {
49
53
 
50
54
  AnnotationListInstance._version = version;
51
55
  // Path Solution
52
- AnnotationListInstance._solution = {};
56
+ AnnotationListInstance._solution = {callSid: callSid};
53
57
  /* jshint ignore:start */
54
58
  /**
55
59
  * Constructs a annotation
56
60
  *
57
61
  * @function get
58
- * @memberof Twilio.Insights.V1.AnnotationList#
59
- *
60
- * @param {string} callSid - The call_sid
62
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationList#
61
63
  *
62
- * @returns {Twilio.Insights.V1.AnnotationContext}
64
+ * @returns {Twilio.Insights.V1.CallContext.AnnotationContext}
63
65
  */
64
66
  /* jshint ignore:end */
65
- AnnotationListInstance.get = function get(callSid) {
66
- return new AnnotationContext(this._version, callSid);
67
+ AnnotationListInstance.get = function get() {
68
+ return new AnnotationContext(this._version, this._solution.callSid);
67
69
  };
68
70
 
69
71
  /* jshint ignore:start */
@@ -71,7 +73,7 @@ AnnotationList = function AnnotationList(version) {
71
73
  * Provide a user-friendly representation
72
74
  *
73
75
  * @function toJSON
74
- * @memberof Twilio.Insights.V1.AnnotationList#
76
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationList#
75
77
  *
76
78
  * @returns Object
77
79
  */
@@ -92,7 +94,10 @@ AnnotationList = function AnnotationList(version) {
92
94
  /**
93
95
  * Initialize the AnnotationPage
94
96
  *
95
- * @constructor Twilio.Insights.V1.AnnotationPage
97
+ * PLEASE NOTE that this class contains beta products that are subject to change.
98
+ * Use them with caution.
99
+ *
100
+ * @constructor Twilio.Insights.V1.CallContext.AnnotationPage
96
101
  *
97
102
  * @param {V1} version - Version of the resource
98
103
  * @param {Response<string>} response - Response from the API
@@ -116,7 +121,7 @@ AnnotationPage.prototype.constructor = AnnotationPage;
116
121
  * Build an instance of AnnotationInstance
117
122
  *
118
123
  * @function getInstance
119
- * @memberof Twilio.Insights.V1.AnnotationPage#
124
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationPage#
120
125
  *
121
126
  * @param {AnnotationPayload} payload - Payload response from the API
122
127
  *
@@ -124,7 +129,7 @@ AnnotationPage.prototype.constructor = AnnotationPage;
124
129
  */
125
130
  /* jshint ignore:end */
126
131
  AnnotationPage.prototype.getInstance = function getInstance(payload) {
127
- return new AnnotationInstance(this._version, payload);
132
+ return new AnnotationInstance(this._version, payload, this._solution.callSid);
128
133
  };
129
134
 
130
135
  /* jshint ignore:start */
@@ -132,7 +137,7 @@ AnnotationPage.prototype.getInstance = function getInstance(payload) {
132
137
  * Provide a user-friendly representation
133
138
  *
134
139
  * @function toJSON
135
- * @memberof Twilio.Insights.V1.AnnotationPage#
140
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationPage#
136
141
  *
137
142
  * @returns Object
138
143
  */
@@ -157,23 +162,28 @@ AnnotationPage.prototype[util.inspect.custom] = function inspect(depth, options)
157
162
  /**
158
163
  * Initialize the AnnotationContext
159
164
  *
160
- * @constructor Twilio.Insights.V1.AnnotationInstance
165
+ * PLEASE NOTE that this class contains beta products that are subject to change.
166
+ * Use them with caution.
161
167
  *
162
- * @property {string} callSid - The call_sid
163
- * @property {string} accountSid - The account_sid
164
- * @property {annotation.answered_by} answeredBy - The answered_by
168
+ * @constructor Twilio.Insights.V1.CallContext.AnnotationInstance
169
+ *
170
+ * @property {string} callSid - Call SID.
171
+ * @property {string} accountSid - Account SID.
172
+ * @property {annotation.answered_by} answeredBy -
173
+ * Indicates the answering entity as determined by Answering Machine Detection.
165
174
  * @property {annotation.connectivity_issue} connectivityIssue -
166
- * The connectivity_issue
167
- * @property {string} qualityIssues - The quality_issues
168
- * @property {boolean} spam - The spam
169
- * @property {number} callScore - The call_score
170
- * @property {string} comment - The comment
171
- * @property {string} incident - The incident
172
- * @property {string} url - The url
175
+ * Indicates if the call had any connectivity issue
176
+ * @property {string} qualityIssues -
177
+ * Indicates if the call had audio quality issues.
178
+ * @property {boolean} spam - Call spam indicator
179
+ * @property {number} callScore - Call Score
180
+ * @property {string} comment - User comments
181
+ * @property {string} incident - Call tag for incidents or support ticket
182
+ * @property {string} url - The URL of this resource.
173
183
  *
174
184
  * @param {V1} version - Version of the resource
175
185
  * @param {AnnotationPayload} payload - The instance payload
176
- * @param {sid} callSid - The call_sid
186
+ * @param {sid} callSid - Call SID.
177
187
  */
178
188
  /* jshint ignore:end */
179
189
  AnnotationInstance = function AnnotationInstance(version, payload, callSid) {
@@ -193,7 +203,7 @@ AnnotationInstance = function AnnotationInstance(version, payload, callSid) {
193
203
 
194
204
  // Context
195
205
  this._context = undefined;
196
- this._solution = {callSid: callSid || this.callSid, };
206
+ this._solution = {callSid: callSid, };
197
207
  };
198
208
 
199
209
  Object.defineProperty(AnnotationInstance.prototype,
@@ -212,17 +222,19 @@ Object.defineProperty(AnnotationInstance.prototype,
212
222
  * update a AnnotationInstance
213
223
  *
214
224
  * @function update
215
- * @memberof Twilio.Insights.V1.AnnotationInstance#
225
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationInstance#
216
226
  *
217
227
  * @param {object} [opts] - Options for request
218
- * @param {annotation.answered_by} [opts.answeredBy] - The answered_by
228
+ * @param {annotation.answered_by} [opts.answeredBy] -
229
+ * Indicates the answering entity as determined by Answering Machine Detection.
219
230
  * @param {annotation.connectivity_issue} [opts.connectivityIssue] -
220
- * The connectivity_issue
221
- * @param {string} [opts.qualityIssues] - The quality_issues
222
- * @param {boolean} [opts.spam] - The spam
223
- * @param {number} [opts.callScore] - The call_score
224
- * @param {string} [opts.comment] - The comment
225
- * @param {string} [opts.incident] - The incident
231
+ * Indicates if the call had any connectivity issue
232
+ * @param {string} [opts.qualityIssues] -
233
+ * Indicates if the call had audio quality issues.
234
+ * @param {boolean} [opts.spam] - Call spam indicator
235
+ * @param {number} [opts.callScore] - Call Score
236
+ * @param {string} [opts.comment] - User comments
237
+ * @param {string} [opts.incident] - Call tag for incidents or support ticket
226
238
  * @param {function} [callback] - Callback to handle processed record
227
239
  *
228
240
  * @returns {Promise} Resolves to processed AnnotationInstance
@@ -237,7 +249,7 @@ AnnotationInstance.prototype.update = function update(opts, callback) {
237
249
  * fetch a AnnotationInstance
238
250
  *
239
251
  * @function fetch
240
- * @memberof Twilio.Insights.V1.AnnotationInstance#
252
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationInstance#
241
253
  *
242
254
  * @param {function} [callback] - Callback to handle processed record
243
255
  *
@@ -253,7 +265,7 @@ AnnotationInstance.prototype.fetch = function fetch(callback) {
253
265
  * Provide a user-friendly representation
254
266
  *
255
267
  * @function toJSON
256
- * @memberof Twilio.Insights.V1.AnnotationInstance#
268
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationInstance#
257
269
  *
258
270
  * @returns Object
259
271
  */
@@ -278,10 +290,13 @@ AnnotationInstance.prototype[util.inspect.custom] = function inspect(depth,
278
290
  /**
279
291
  * Initialize the AnnotationContext
280
292
  *
281
- * @constructor Twilio.Insights.V1.AnnotationContext
293
+ * PLEASE NOTE that this class contains beta products that are subject to change.
294
+ * Use them with caution.
295
+ *
296
+ * @constructor Twilio.Insights.V1.CallContext.AnnotationContext
282
297
  *
283
298
  * @param {V1} version - Version of the resource
284
- * @param {sid} callSid - The call_sid
299
+ * @param {sid} callSid - Call SID.
285
300
  */
286
301
  /* jshint ignore:end */
287
302
  AnnotationContext = function AnnotationContext(version, callSid) {
@@ -297,17 +312,19 @@ AnnotationContext = function AnnotationContext(version, callSid) {
297
312
  * update a AnnotationInstance
298
313
  *
299
314
  * @function update
300
- * @memberof Twilio.Insights.V1.AnnotationContext#
315
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationContext#
301
316
  *
302
317
  * @param {object} [opts] - Options for request
303
- * @param {annotation.answered_by} [opts.answeredBy] - The answered_by
318
+ * @param {annotation.answered_by} [opts.answeredBy] -
319
+ * Indicates the answering entity as determined by Answering Machine Detection.
304
320
  * @param {annotation.connectivity_issue} [opts.connectivityIssue] -
305
- * The connectivity_issue
306
- * @param {string} [opts.qualityIssues] - The quality_issues
307
- * @param {boolean} [opts.spam] - The spam
308
- * @param {number} [opts.callScore] - The call_score
309
- * @param {string} [opts.comment] - The comment
310
- * @param {string} [opts.incident] - The incident
321
+ * Indicates if the call had any connectivity issue
322
+ * @param {string} [opts.qualityIssues] -
323
+ * Indicates if the call had audio quality issues.
324
+ * @param {boolean} [opts.spam] - Call spam indicator
325
+ * @param {number} [opts.callScore] - Call Score
326
+ * @param {string} [opts.comment] - User comments
327
+ * @param {string} [opts.incident] - Call tag for incidents or support ticket
311
328
  * @param {function} [callback] - Callback to handle processed record
312
329
  *
313
330
  * @returns {Promise} Resolves to processed AnnotationInstance
@@ -353,7 +370,7 @@ AnnotationContext.prototype.update = function update(opts, callback) {
353
370
  * fetch a AnnotationInstance
354
371
  *
355
372
  * @function fetch
356
- * @memberof Twilio.Insights.V1.AnnotationContext#
373
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationContext#
357
374
  *
358
375
  * @param {function} [callback] - Callback to handle processed record
359
376
  *
@@ -384,7 +401,7 @@ AnnotationContext.prototype.fetch = function fetch(callback) {
384
401
  * Provide a user-friendly representation
385
402
  *
386
403
  * @function toJSON
387
- * @memberof Twilio.Insights.V1.AnnotationContext#
404
+ * @memberof Twilio.Insights.V1.CallContext.AnnotationContext#
388
405
  *
389
406
  * @returns Object
390
407
  */
@@ -53,6 +53,7 @@ interface CallSummaryPayload extends CallSummaryResource, Page.TwilioResponsePay
53
53
 
54
54
  interface CallSummaryResource {
55
55
  account_sid: string;
56
+ annotation: object;
56
57
  attributes: object;
57
58
  call_sid: string;
58
59
  call_state: CallSummaryCallState;
@@ -121,6 +122,7 @@ declare class CallSummaryInstance extends SerializableClass {
121
122
 
122
123
  private _proxy: CallSummaryContext;
123
124
  accountSid: string;
125
+ annotation: any;
124
126
  attributes: any;
125
127
  callSid: string;
126
128
  callState: CallSummaryCallState;
@@ -179,6 +179,7 @@ CallSummaryPage.prototype[util.inspect.custom] = function inspect(depth,
179
179
  * @property {object} attributes - The attributes
180
180
  * @property {object} properties - The properties
181
181
  * @property {object} trust - The trust
182
+ * @property {object} annotation - The annotation
182
183
  *
183
184
  * @param {V1} version - Version of the resource
184
185
  * @param {CallSummaryPayload} payload - The instance payload
@@ -210,6 +211,7 @@ CallSummaryInstance = function CallSummaryInstance(version, payload, callSid) {
210
211
  this.attributes = payload.attributes; // jshint ignore:line
211
212
  this.properties = payload.properties; // jshint ignore:line
212
213
  this.trust = payload.trust; // jshint ignore:line
214
+ this.annotation = payload.annotation; // jshint ignore:line
213
215
 
214
216
  // Context
215
217
  this._context = undefined;
@@ -8,6 +8,8 @@
8
8
  import Page = require('../../../base/Page');
9
9
  import Response = require('../../../http/response');
10
10
  import V1 = require('../V1');
11
+ import { AnnotationList } from './call/annotation';
12
+ import { AnnotationListInstance } from './call/annotation';
11
13
  import { CallSummaryList } from './call/summary';
12
14
  import { CallSummaryListInstance } from './call/summary';
13
15
  import { EventList } from './call/event';
@@ -19,10 +21,6 @@ import { SerializableClass } from '../../../interfaces';
19
21
  /**
20
22
  * Initialize the CallList
21
23
  *
22
- * PLEASE NOTE that this class contains preview products that are subject to
23
- * change. Use them with caution. If you currently do not have developer preview
24
- * access, please contact help@twilio.com.
25
- *
26
24
  * @param version - Version of the resource
27
25
  */
28
26
  declare function CallList(version: V1): CallListInstance;
@@ -61,15 +59,12 @@ declare class CallContext {
61
59
  /**
62
60
  * Initialize the CallContext
63
61
  *
64
- * PLEASE NOTE that this class contains preview products that are subject to
65
- * change. Use them with caution. If you currently do not have developer preview
66
- * access, please contact help@twilio.com.
67
- *
68
62
  * @param version - Version of the resource
69
63
  * @param sid - The sid
70
64
  */
71
65
  constructor(version: V1, sid: string);
72
66
 
67
+ annotation: AnnotationListInstance;
73
68
  events: EventListInstance;
74
69
  /**
75
70
  * fetch a CallInstance
@@ -90,10 +85,6 @@ declare class CallInstance extends SerializableClass {
90
85
  /**
91
86
  * Initialize the CallContext
92
87
  *
93
- * PLEASE NOTE that this class contains preview products that are subject to
94
- * change. Use them with caution. If you currently do not have developer preview
95
- * access, please contact help@twilio.com.
96
- *
97
88
  * @param version - Version of the resource
98
89
  * @param payload - The instance payload
99
90
  * @param sid - The sid
@@ -101,6 +92,10 @@ declare class CallInstance extends SerializableClass {
101
92
  constructor(version: V1, payload: CallPayload, sid: string);
102
93
 
103
94
  private _proxy: CallContext;
95
+ /**
96
+ * Access the annotation
97
+ */
98
+ annotation(): AnnotationListInstance;
104
99
  /**
105
100
  * Access the events
106
101
  */
@@ -133,10 +128,6 @@ declare class CallPage extends Page<V1, CallPayload, CallResource, CallInstance>
133
128
  /**
134
129
  * Initialize the CallPage
135
130
  *
136
- * PLEASE NOTE that this class contains preview products that are subject to
137
- * change. Use them with caution. If you currently do not have developer preview
138
- * access, please contact help@twilio.com.
139
- *
140
131
  * @param version - Version of the resource
141
132
  * @param response - Response from the API
142
133
  * @param solution - Path solution