twilio 3.79.0 → 3.80.0

package/README.md

@@ -28,6 +28,10 @@ This library supports the following Node.js implementations:
 
 TypeScript is supported for TypeScript version 2.9 and above.
 
+## Installation
+
+`npm install twilio` or `yarn add twilio`
+
 ## Sample Usage
 
 Check out these [code examples](examples) in JavaScript and TypeScript to get up and running quickly.
@@ -138,7 +142,7 @@ npm test
 To run just one specific test file instead of the whole suite, provide a JavaScript regular expression that will match your spec file's name, like:
 
 ```bash
-npm run test -- -m .\*client.\*
+npm run test:javascript -- -m .\*client.\*
 ```
 
 [apidocs]: https://www.twilio.com/docs/api

package/lib/base/RequestClient.d.ts

@@ -1,13 +1,15 @@
-import { HttpMethod } from '../interfaces';
-import Response = require('../http/response');
+import { HttpMethod } from "../interfaces";
+import Response = require("../http/response");
 
 declare class RequestClient {
-  constructor();
+  constructor(opts?: RequestClient.RequestClientOptions);
   /**
    * Make an HTTP request
    * @param opts The request options
    */
-  request<TData>(opts: RequestClient.RequestOptions<TData>): Promise<Response<TData>>;
+  request<TData>(
+    opts: RequestClient.RequestOptions<TData>
+  ): Promise<Response<TData>>;
 }
 
 declare namespace RequestClient {
@@ -54,9 +56,17 @@ declare namespace RequestClient {
     forever?: boolean;
   }
 
+  export interface RequestClientOptions {
+    /**
+     * A timeout in milliseconds. This will be used as the HTTPS agent's socket
+     * timeout, and as the default request timeout.
+     */
+    timeout?: number;
+  }
+
   export interface Headers {
     [header: string]: string;
   }
 }
 
-export = RequestClient;
+export = RequestClient;

package/lib/base/RequestClient.js

@@ -6,12 +6,42 @@ var fs = require('fs');
 var HttpsProxyAgent = require('https-proxy-agent');
 var Q = require('q');
 var qs = require('qs');
+var url = require('url');
+var https = require('https');
 var Response = require('../http/response');
 var Request = require('../http/request');
 
-axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';
+const DEFAULT_CONTENT_TYPE = 'application/x-www-form-urlencoded';
+const DEFAULT_TIMEOUT = 30000;
 
-var RequestClient = function () { };
+/**
+ * Make http request
+ * @param {object} opts - The options argument
+ * @param {string} opts.timeout - A custom timeout to use. This will be used as the socket timeout, and as the default request timeout.
+ */
+var RequestClient = function (opts) {
+  opts = opts || {};
+  this.defaultTimeout = opts.timeout || DEFAULT_TIMEOUT;
+
+  // construct an https agent
+  let agentOpts = {
+    timeout: this.defaultTimeout,
+  };
+
+  let agent;
+  if (process.env.HTTP_PROXY) {
+    // Note: if process.env.HTTP_PROXY is set, we're not able to apply the given
+    // socket timeout. See: https://github.com/TooTallNate/node-https-proxy-agent/pull/96
+    agent = new HttpsProxyAgent(process.env.HTTP_PROXY);
+  } else {
+    agent = new https.Agent(agentOpts);
+  }
+
+  // construct an axios instance
+  this.axios = axios.create();
+  this.axios.defaults.headers.post['Content-Type'] = DEFAULT_CONTENT_TYPE;
+  this.axios.defaults.httpsAgent = agent;
+};
 
 /**
  * Make http request
@@ -53,12 +83,11 @@ RequestClient.prototype.request = function (opts) {
   }
 
   var options = {
-    timeout: opts.timeout || 30000,
+    timeout: opts.timeout || this.defaultTimeout,
     maxRedirects: opts.allowRedirects ? 10 : 0, // Same number of allowed redirects as request module default
     url: opts.uri,
     method: opts.method,
     headers: opts.headers,
-    httpsAgent: process.env.HTTP_PROXY ? new HttpsProxyAgent(process.env.HTTP_PROXY) : undefined,
     proxy: false,
     validateStatus: status => status >= 100 && status < 600,
   };
@@ -99,7 +128,7 @@ RequestClient.prototype.request = function (opts) {
   this.lastResponse = undefined;
   this.lastRequest = new Request(optionsRequest);
 
-  axios(options).then((response) => {
+  this.axios(options).then((response) => {
     if (opts.logLevel === 'debug') {
       console.log(`response.statusCode: ${response.status}`)
       console.log(`response.headers: ${JSON.stringify(response.headers)}`)
@@ -122,7 +151,7 @@ RequestClient.prototype.filterLoggingHeaders = function (headers){
   return Object.keys(headers).filter((header) => {
     return !'authorization'.includes(header.toLowerCase());
   });
-}
+};
 
 RequestClient.prototype.logRequest = function (options){
   console.log('-- BEGIN Twilio API Request --');
@@ -140,6 +169,6 @@ RequestClient.prototype.logRequest = function (options){
   }
 
   console.log('-- END Twilio API Request --');
-}
+};
 
 module.exports = RequestClient;

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

@@ -14,15 +14,17 @@ import { InteractionChannelParticipantList } from './interactionChannel/interact
 import { InteractionChannelParticipantListInstance } from './interactionChannel/interactionChannelParticipant';
 import { SerializableClass } from '../../../../interfaces';
 
+type InteractionChannelChannelStatus = 'setup'|'active'|'failed'|'closed';
+
 type InteractionChannelStatus = 'close'|'closed'|'wrapup';
 
-type InteractionChannelType = 'voice'|'sms'|'email'|'web'|'whatsapp'|'chat';
+type InteractionChannelType = 'voice'|'sms'|'email'|'web'|'whatsapp'|'chat'|'messenger'|'gbm';
 
 /**
  * Initialize the InteractionChannelList
  *
  * @param version - Version of the resource
- * @param interactionSid - The unique string that identifies the resource
+ * @param interactionSid - The unique string that identifies the resource.
  */
 declare function InteractionChannelList(version: V1, interactionSid: string): InteractionChannelListInstance;
 
@@ -213,9 +215,12 @@ interface InteractionChannelPayload extends InteractionChannelResource, Page.Twi
 }
 
 interface InteractionChannelResource {
+  error_code: number;
+  error_message: string;
   interaction_sid: string;
   links: string;
   sid: string;
+  status: InteractionChannelChannelStatus;
   type: InteractionChannelType;
   url: string;
 }
@@ -263,12 +268,14 @@ declare class InteractionChannelInstance extends SerializableClass {
    *
    * @param version - Version of the resource
    * @param payload - The instance payload
-   * @param interactionSid - The unique string that identifies the resource
+   * @param interactionSid - The unique string that identifies the resource.
    * @param sid - The unique string that identifies the resource
    */
   constructor(version: V1, payload: InteractionChannelPayload, interactionSid: string, sid: string);
 
   private _proxy: InteractionChannelContext;
+  errorCode: number;
+  errorMessage: string;
   /**
    * fetch a InteractionChannelInstance
    *
@@ -286,6 +293,7 @@ declare class InteractionChannelInstance extends SerializableClass {
    */
   participants(): InteractionChannelParticipantListInstance;
   sid: string;
+  status: InteractionChannelChannelStatus;
   /**
    * Provide a user-friendly representation
    */
@@ -324,4 +332,4 @@ declare class InteractionChannelPage extends Page<V1, InteractionChannelPayload,
   toJSON(): any;
 }
 
-export { InteractionChannelContext, InteractionChannelInstance, InteractionChannelInstanceUpdateOptions, InteractionChannelList, InteractionChannelListInstance, InteractionChannelListInstanceEachOptions, InteractionChannelListInstanceOptions, InteractionChannelListInstancePageOptions, InteractionChannelPage, InteractionChannelPayload, InteractionChannelResource, InteractionChannelSolution, InteractionChannelStatus, InteractionChannelType }
+export { InteractionChannelChannelStatus, InteractionChannelContext, InteractionChannelInstance, InteractionChannelInstanceUpdateOptions, InteractionChannelList, InteractionChannelListInstance, InteractionChannelListInstanceEachOptions, InteractionChannelListInstanceOptions, InteractionChannelListInstancePageOptions, InteractionChannelPage, InteractionChannelPayload, InteractionChannelResource, InteractionChannelSolution, InteractionChannelStatus, InteractionChannelType }

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

@@ -17,6 +17,8 @@ var InteractionChannelInviteList = require(
 var InteractionChannelParticipantList = require(
     './interactionChannel/interactionChannelParticipant').InteractionChannelParticipantList;
 var Page = require('../../../../base/Page');  /* jshint ignore:line */
+var deserialize = require(
+    '../../../../base/deserialize');  /* jshint ignore:line */
 var serialize = require('../../../../base/serialize');  /* jshint ignore:line */
 var values = require('../../../../base/values');  /* jshint ignore:line */
 
@@ -32,7 +34,7 @@ var InteractionChannelContext;
  * @constructor Twilio.FlexApi.V1.InteractionContext.InteractionChannelList
  *
  * @param {Twilio.FlexApi.V1} version - Version of the resource
- * @param {string} interactionSid - The unique string that identifies the resource
+ * @param {string} interactionSid - The unique string that identifies the resource.
  */
 /* jshint ignore:end */
 InteractionChannelList = function InteractionChannelList(version,
@@ -413,14 +415,18 @@ InteractionChannelPage.prototype[util.inspect.custom] = function inspect(depth,
  *
  * @property {string} sid - The unique string that identifies the resource
  * @property {string} interactionSid -
- *          The unique string that identifies the resource
+ *          The unique string that identifies the resource.
  * @property {interaction_channel.type} type - The Interaction Channel's type.
+ * @property {interaction_channel.channel_status} status -
+ *          The status of this channel.
+ * @property {number} errorCode - The Twilio error code for a failed channel.
+ * @property {string} errorMessage - The error message for a failed channel.
  * @property {string} url - The url
  * @property {string} links - The links
  *
  * @param {V1} version - Version of the resource
  * @param {InteractionChannelPayload} payload - The instance payload
- * @param {sid} interactionSid - The unique string that identifies the resource
+ * @param {sid} interactionSid - The unique string that identifies the resource.
  * @param {sid} sid - The unique string that identifies the resource
  */
 /* jshint ignore:end */
@@ -432,6 +438,9 @@ InteractionChannelInstance = function InteractionChannelInstance(version,
   this.sid = payload.sid; // jshint ignore:line
   this.interactionSid = payload.interaction_sid; // jshint ignore:line
   this.type = payload.type; // jshint ignore:line
+  this.status = payload.status; // jshint ignore:line
+  this.errorCode = deserialize.integer(payload.error_code); // jshint ignore:line
+  this.errorMessage = payload.error_message; // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
   this.links = payload.links; // jshint ignore:line
 

package/lib/rest/verify/v2/service/verificationCheck.d.ts

@@ -69,6 +69,7 @@ interface VerificationCheckResource {
   payee: string;
   service_sid: string;
   sid: string;
+  sna_attempts_error_codes: object[];
   status: string;
   to: string;
   valid: boolean;
@@ -97,6 +98,7 @@ declare class VerificationCheckInstance extends SerializableClass {
   payee: string;
   serviceSid: string;
   sid: string;
+  snaAttemptsErrorCodes: object[];
   status: string;
   to: string;
   /**

package/lib/rest/verify/v2/service/verificationCheck.js

@@ -59,6 +59,7 @@ VerificationCheckList = function VerificationCheckList(version, serviceSid) {
    * @memberof Twilio.Verify.V2.ServiceContext.VerificationCheckList#
    *
    * @param {object} [opts] - Options for request
+   * @param {string} [opts.code] - The verification string
    * @param {string} [opts.to] - The phone number or email to verify
    * @param {string} [opts.verificationSid] -
    *          A SID that uniquely identifies the Verification Check
@@ -66,7 +67,6 @@ VerificationCheckList = function VerificationCheckList(version, serviceSid) {
    *          The amount of the associated PSD2 compliant transaction.
    * @param {string} [opts.payee] -
    *          The payee of the associated PSD2 compliant transaction
-   * @param {string} [opts.code] - The verification string
    * @param {function} [callback] - Callback to handle processed record
    *
    * @returns {Promise} Resolves to processed VerificationCheckInstance
@@ -81,11 +81,11 @@ VerificationCheckList = function VerificationCheckList(version, serviceSid) {
 
     var deferred = Q.defer();
     var data = values.of({
+      'Code': _.get(opts, 'code'),
       'To': _.get(opts, 'to'),
       'VerificationSid': _.get(opts, 'verificationSid'),
       'Amount': _.get(opts, 'amount'),
-      'Payee': _.get(opts, 'payee'),
-      'Code': _.get(opts, 'code')
+      'Payee': _.get(opts, 'payee')
     });
 
     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
@@ -216,6 +216,8 @@ VerificationCheckPage.prototype[util.inspect.custom] = function inspect(depth,
  *          The ISO 8601 date and time in GMT when the Verification Check resource was created
  * @property {Date} dateUpdated -
  *          The ISO 8601 date and time in GMT when the Verification Check resource was last updated
+ * @property {object} snaAttemptsErrorCodes -
+ *          List of error codes as a result of attempting a verification using the `sna` channel.
  *
  * @param {V2} version - Version of the resource
  * @param {VerificationCheckPayload} payload - The instance payload
@@ -239,6 +241,7 @@ VerificationCheckInstance = function VerificationCheckInstance(version, payload,
   this.payee = payload.payee; // jshint ignore:line
   this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
   this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
+  this.snaAttemptsErrorCodes = payload.sna_attempts_error_codes; // jshint ignore:line
 
   // Context
   this._context = undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "twilio",
   "description": "A Twilio helper library",
-  "version": "3.79.0",
+  "version": "3.80.0",
   "author": "API Team <api@twilio.com>",
   "contributors": [
     {