twilio 4.12.0 → 4.14.0

package/lib/base/BaseTwilio.js

@@ -33,23 +33,30 @@ var Twilio;
         /* jshint ignore:end */
         constructor(username, password, opts) {
             this.opts = opts || {};
-            this.env = this.opts.env || process.env;
+            this.env = this.opts.env || {};
             this.username =
-                username ||
-                    this.env.TWILIO_ACCOUNT_SID ||
+                username ??
+                    this.env.TWILIO_ACCOUNT_SID ??
+                    process.env.TWILIO_ACCOUNT_SID ??
                     (() => {
                         throw new Error("username is required");
                     })();
             this.password =
-                password ||
-                    this.env.TWILIO_AUTH_TOKEN ||
+                password ??
+                    this.env.TWILIO_AUTH_TOKEN ??
+                    process.env.TWILIO_AUTH_TOKEN ??
                     (() => {
                         throw new Error("password is required");
                     })();
             this.accountSid = this.opts.accountSid || this.username;
-            this.edge = this.opts.edge || this.env.TWILIO_EDGE;
-            this.region = this.opts.region || this.env.TWILIO_REGION;
-            this.logLevel = this.opts.logLevel || this.env.TWILIO_LOG_LEVEL;
+            this.edge =
+                this.opts.edge ?? this.env.TWILIO_EDGE ?? process.env.TWILIO_EDGE;
+            this.region =
+                this.opts.region ?? this.env.TWILIO_REGION ?? process.env.TWILIO_REGION;
+            this.logLevel =
+                this.opts.logLevel ??
+                    this.env.TWILIO_LOG_LEVEL ??
+                    process.env.TWILIO_LOG_LEVEL;
             this.autoRetry = this.opts.autoRetry || false;
             this.maxRetries = this.opts.maxRetries;
             this.userAgentExtensions = this.opts.userAgentExtensions || [];

package/lib/rest/flexApi/v1/interaction.d.ts

@@ -10,6 +10,8 @@ export interface InteractionListInstanceCreateOptions {
     channel: any;
     /** The Interaction\\\'s routing logic. */
     routing: any;
+    /** The Interaction context sid is used for adding a context lookup sid */
+    interactionContextSid?: string;
 }
 export interface InteractionContext {
     channels: InteractionChannelListInstance;
@@ -52,6 +54,7 @@ interface InteractionResource {
     routing: any;
     url: string;
     links: Record<string, string>;
+    interaction_context_sid: string;
 }
 export declare class InteractionInstance {
     protected _version: V1;
@@ -72,6 +75,7 @@ export declare class InteractionInstance {
     routing: any;
     url: string;
     links: Record<string, string>;
+    interactionContextSid: string;
     private get _proxy();
     /**
      * Fetch a InteractionInstance
@@ -96,6 +100,7 @@ export declare class InteractionInstance {
         routing: any;
         url: string;
         links: Record<string, string>;
+        interactionContextSid: string;
     };
     [inspect.custom](_depth: any, options: InspectOptions): string;
 }

package/lib/rest/flexApi/v1/interaction.js

@@ -65,6 +65,7 @@ class InteractionInstance {
         this.routing = payload.routing;
         this.url = payload.url;
         this.links = payload.links;
+        this.interactionContextSid = payload.interaction_context_sid;
         this._solution = { sid: sid || this.sid };
     }
     get _proxy() {
@@ -101,6 +102,7 @@ class InteractionInstance {
             routing: this.routing,
             url: this.url,
             links: this.links,
+            interactionContextSid: this.interactionContextSid,
         };
     }
     [util_1.inspect.custom](_depth, options) {
@@ -129,6 +131,8 @@ function InteractionListInstance(version) {
         let data = {};
         data["Channel"] = serialize.object(params["channel"]);
         data["Routing"] = serialize.object(params["routing"]);
+        if (params["interactionContextSid"] !== undefined)
+            data["InteractionContextSid"] = params["interactionContextSid"];
         const headers = {};
         headers["Content-Type"] = "application/x-www-form-urlencoded";
         let operationVersion = version, operationPromise = operationVersion.create({

package/lib/rest/insights/v1/call/annotation.d.ts

@@ -11,15 +11,15 @@ export interface AnnotationContextUpdateOptions {
     answeredBy?: AnnotationAnsweredBy;
     /**  */
     connectivityIssue?: AnnotationConnectivityIssue;
-    /** Specify if the call had any subjective quality issues. Possible values, one or more of:  no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call */
+    /** Specify if the call had any subjective quality issues. Possible values, one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, `static_noise`. Use comma separated values to indicate multiple quality issues for the same call. */
     qualityIssues?: string;
-    /** Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call. */
+    /** A boolean flag to indicate if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Use `true` if the call was a spam call. */
     spam?: boolean;
     /** Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad]. */
     callScore?: number;
-    /** Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here. */
+    /** Specify any comments pertaining to the call. `comment` has a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in the `comment`. */
     comment?: string;
-    /** Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here. */
+    /** Associate this call with an incident or support ticket. The `incident` parameter is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`. */
     incident?: string;
 }
 export interface AnnotationContext {
@@ -100,23 +100,23 @@ export declare class AnnotationInstance {
     answeredBy: AnnotationAnsweredBy;
     connectivityIssue: AnnotationConnectivityIssue;
     /**
-     * Specify if the call had any subjective quality issues. Possible values, one or more of:  no_quality_issue, low_volume, choppy_robotic, echo, dtmf, latency, owa, static_noise. Use comma separated values to indicate multiple quality issues for the same call
+     * Specifies if the call had any subjective quality issues. Possible values are one or more of `no_quality_issue`, `low_volume`, `choppy_robotic`, `echo`, `dtmf`, `latency`, `owa`, or `static_noise`.
      */
     qualityIssues: Array<string>;
     /**
-     * Specify if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
+     * Specifies if the call was a spam call. Use this to provide feedback on whether calls placed from your account were marked as spam, or if inbound calls received by your account were unwanted spam. Is of type Boolean: true, false. Use true if the call was a spam call.
      */
     spam: boolean;
     /**
-     * Specify the call score. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
+     * Specifies the Call Score, if available. This is of type integer. Use a range of 1-5 to indicate the call experience score, with the following mapping as a reference for rating the call [5: Excellent, 4: Good, 3 : Fair, 2 : Poor, 1: Bad].
      */
     callScore: number;
     /**
-     * Specify any comments pertaining to the call. This of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
+     * Specifies any comments pertaining to the call. Twilio does not treat this field as PII, so no PII should be included in comments.
      */
     comment: string;
     /**
-     * Associate this call with an incident or support ticket. This is of type string with a max limit of 100 characters. Twilio does not treat this field as PII, so don’t put any PII in here.
+     * Incident or support ticket associated with this call. The `incident` property is of type string with a maximum character limit of 100. Twilio does not treat this field as PII, so no PII should be included in `incident`.
      */
     incident: string;
     /**

package/lib/rest/insights/v1/call/callSummary.d.ts

@@ -9,7 +9,7 @@ export type CallSummaryProcessingState = "complete" | "partial";
  * Options to pass to fetch a CallSummaryInstance
  */
 export interface CallSummaryContextFetchOptions {
-    /**  */
+    /** The Processing State of this Call Summary. One of `complete`, `partial` or `all`. */
     processingState?: CallSummaryProcessingState;
 }
 export interface CallSummaryContext {
@@ -83,28 +83,85 @@ export declare class CallSummaryInstance {
     protected _solution: CallSummaryContextSolution;
     protected _context?: CallSummaryContext;
     constructor(_version: V1, payload: CallSummaryResource, callSid: string);
+    /**
+     * The unique SID identifier of the Account.
+     */
     accountSid: string;
+    /**
+     * The unique SID identifier of the Call.
+     */
     callSid: string;
     callType: CallSummaryCallType;
     callState: CallSummaryCallState;
     answeredBy: CallSummaryAnsweredBy;
     processingState: CallSummaryProcessingState;
+    /**
+     * The time at which the Call was created, given in ISO 8601 format. Can be different from `start_time` in the event of queueing due to CPS
+     */
     createdTime: Date;
+    /**
+     * The time at which the Call was started, given in ISO 8601 format.
+     */
     startTime: Date;
+    /**
+     * The time at which the Call was ended, given in ISO 8601 format.
+     */
     endTime: Date;
+    /**
+     * Duration between when the call was initiated and the call was ended
+     */
     duration: number;
+    /**
+     * Duration between when the call was answered and when it ended
+     */
     connectDuration: number;
+    /**
+     * The calling party.
+     */
     from: any;
+    /**
+     * The called party.
+     */
     to: any;
+    /**
+     * Contains metrics and properties for the Twilio media gateway of a PSTN call.
+     */
     carrierEdge: any;
+    /**
+     * Contains metrics and properties for the Twilio media gateway of a Client call.
+     */
     clientEdge: any;
+    /**
+     * Contains metrics and properties for the SDK sensor library for Client calls.
+     */
     sdkEdge: any;
+    /**
+     * Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
+     */
     sipEdge: any;
+    /**
+     * Tags applied to calls by Voice Insights analysis indicating a condition that could result in subjective degradation of the call quality.
+     */
     tags: Array<string>;
+    /**
+     * The URL of this resource.
+     */
     url: string;
+    /**
+     * Attributes capturing call-flow-specific details.
+     */
     attributes: any;
+    /**
+     * Contains edge-agnostic call-level details.
+     */
     properties: any;
+    /**
+     * Contains trusted communications details including Branded Call and verified caller ID.
+     */
     trust: any;
+    /**
+     * Programmatically labeled annotations for the Call. Developers can update the Call Summary records with Annotation during or after a Call. Annotations can be updated as long as the Call Summary record is addressable via the API.
+     */
     annotation: any;
     private get _proxy();
     /**

package/lib/rest/insights/v1/call/event.d.ts

@@ -9,7 +9,7 @@ export type EventTwilioEdge = "unknown_edge" | "carrier_edge" | "sip_edge" | "sd
  * Options to pass to each
  */
 export interface EventListInstanceEachOptions {
-    /**  */
+    /** The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. */
     edge?: EventTwilioEdge;
     /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
     pageSize?: number;
@@ -24,7 +24,7 @@ export interface EventListInstanceEachOptions {
  * Options to pass to list
  */
 export interface EventListInstanceOptions {
-    /**  */
+    /** The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. */
     edge?: EventTwilioEdge;
     /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
     pageSize?: number;
@@ -35,7 +35,7 @@ export interface EventListInstanceOptions {
  * Options to pass to page
  */
 export interface EventListInstancePageOptions {
-    /**  */
+    /** The Edge of this Event. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. */
     edge?: EventTwilioEdge;
     /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
     pageSize?: number;
@@ -127,16 +127,43 @@ interface EventResource {
 export declare class EventInstance {
     protected _version: V1;
     constructor(_version: V1, payload: EventResource, callSid: string);
+    /**
+     * Event time.
+     */
     timestamp: string;
+    /**
+     * The unique SID identifier of the Call.
+     */
     callSid: string;
+    /**
+     * The unique SID identifier of the Account.
+     */
     accountSid: string;
     edge: EventTwilioEdge;
+    /**
+     * Event group.
+     */
     group: string;
     level: EventLevel;
+    /**
+     * Event name.
+     */
     name: string;
+    /**
+     * Represents the connection between Twilio and our immediate carrier partners. The events here describe the call lifecycle as reported by Twilio\'s carrier media gateways.
+     */
     carrierEdge: any;
+    /**
+     * Represents the Twilio media gateway for SIP interface and SIP trunking calls. The events here describe the call lifecycle as reported by Twilio\'s public media gateways.
+     */
     sipEdge: any;
+    /**
+     * Represents the Voice SDK running locally in the browser or in the Android/iOS application. The events here are emitted by the Voice SDK in response to certain call progress events, network changes, or call quality conditions.
+     */
     sdkEdge: any;
+    /**
+     * Represents the Twilio media gateway for Client calls. The events here describe the call lifecycle as reported by Twilio\'s Voice SDK media gateways.
+     */
     clientEdge: any;
     /**
      * Provide a user-friendly representation

package/lib/rest/insights/v1/call/metric.d.ts

@@ -9,9 +9,9 @@ export type MetricTwilioEdge = "unknown_edge" | "carrier_edge" | "sip_edge" | "s
  * Options to pass to each
  */
 export interface MetricListInstanceEachOptions {
-    /**  */
+    /** The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. */
     edge?: MetricTwilioEdge;
-    /**  */
+    /** The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`. */
     direction?: MetricStreamDirection;
     /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
     pageSize?: number;
@@ -26,9 +26,9 @@ export interface MetricListInstanceEachOptions {
  * Options to pass to list
  */
 export interface MetricListInstanceOptions {
-    /**  */
+    /** The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. */
     edge?: MetricTwilioEdge;
-    /**  */
+    /** The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`. */
     direction?: MetricStreamDirection;
     /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
     pageSize?: number;
@@ -39,9 +39,9 @@ export interface MetricListInstanceOptions {
  * Options to pass to page
  */
 export interface MetricListInstancePageOptions {
-    /**  */
+    /** The Edge of this Metric. One of `unknown_edge`, `carrier_edge`, `sip_edge`, `sdk_edge` or `client_edge`. */
     edge?: MetricTwilioEdge;
-    /**  */
+    /** The Direction of this Metric. One of `unknown`, `inbound`, `outbound` or `both`. */
     direction?: MetricStreamDirection;
     /** How many resources to return in each list page. The default is 50, and the maximum is 1000. */
     pageSize?: number;
@@ -131,14 +131,35 @@ interface MetricResource {
 export declare class MetricInstance {
     protected _version: V1;
     constructor(_version: V1, payload: MetricResource, callSid: string);
+    /**
+     * Timestamp of metric sample. Samples are taken every 10 seconds and contain the metrics for the previous 10 seconds.
+     */
     timestamp: string;
+    /**
+     * The unique SID identifier of the Call.
+     */
     callSid: string;
+    /**
+     * The unique SID identifier of the Account.
+     */
     accountSid: string;
     edge: MetricTwilioEdge;
     direction: MetricStreamDirection;
+    /**
+     * Contains metrics and properties for the Twilio media gateway of a PSTN call.
+     */
     carrierEdge: any;
+    /**
+     * Contains metrics and properties for the Twilio media gateway of a SIP Interface or Trunking call.
+     */
     sipEdge: any;
+    /**
+     * Contains metrics and properties for the SDK sensor library for Client calls.
+     */
     sdkEdge: any;
+    /**
+     * Contains metrics and properties for the Twilio media gateway of a Client call.
+     */
     clientEdge: any;
     /**
      * Provide a user-friendly representation