twilio 3.83.4 → 3.84.0

package/README.md

@@ -32,6 +32,12 @@ TypeScript is supported for TypeScript version 2.9 and above.
 
 `npm install twilio` or `yarn add twilio`
 
+### Installing Release Candidates
+
+Or, if you're wanting to install the latest release candidate use:
+
+`npm install twilio@rc` or `yarn add twilio@rc`
+
 ## Sample Usage
 
 Check out these [code examples](examples) in JavaScript and TypeScript to get up and running quickly.

package/lib/rest/FlexApi.d.ts

@@ -8,6 +8,7 @@
 import Domain = require('../base/Domain');
 import Twilio = require('./Twilio');
 import V1 = require('./flexApi/V1');
+import V2 = require('./flexApi/V2');
 import { AssessmentsListInstance } from './flexApi/v1/assessments';
 import { ChannelListInstance } from './flexApi/v1/channel';
 import { ConfigurationListInstance } from './flexApi/v1/configuration';
@@ -16,6 +17,7 @@ import { GoodDataListInstance } from './flexApi/v1/goodData';
 import { InteractionListInstance } from './flexApi/v1/interaction';
 import { UserRolesListInstance } from './flexApi/v1/userRoles';
 import { WebChannelListInstance } from './flexApi/v1/webChannel';
+import { WebChannelsListInstance } from './flexApi/v2/webChannels';
 
 
 declare class FlexApi extends Domain {
@@ -34,7 +36,9 @@ declare class FlexApi extends Domain {
   readonly interaction: InteractionListInstance;
   readonly userRoles: UserRolesListInstance;
   readonly v1: V1;
+  readonly v2: V2;
   readonly webChannel: WebChannelListInstance;
+  readonly webChannels: WebChannelsListInstance;
 }
 
 export = FlexApi;

package/lib/rest/FlexApi.js

@@ -12,6 +12,7 @@
 var _ = require('lodash');  /* jshint ignore:line */
 var Domain = require('../base/Domain');  /* jshint ignore:line */
 var V1 = require('./flexApi/V1');  /* jshint ignore:line */
+var V2 = require('./flexApi/V2');  /* jshint ignore:line */
 
 
 /* jshint ignore:start */
@@ -21,6 +22,7 @@ var V1 = require('./flexApi/V1');  /* jshint ignore:line */
  * @constructor Twilio.FlexApi
  *
  * @property {Twilio.FlexApi.V1} v1 - v1 version
+ * @property {Twilio.FlexApi.V2} v2 - v2 version
  * @property {Twilio.FlexApi.V1.AssessmentsList} assessments - assessments resource
  * @property {Twilio.FlexApi.V1.ChannelList} channel - channel resource
  * @property {Twilio.FlexApi.V1.ConfigurationList} configuration -
@@ -30,6 +32,7 @@ var V1 = require('./flexApi/V1');  /* jshint ignore:line */
  * @property {Twilio.FlexApi.V1.InteractionList} interaction - interaction resource
  * @property {Twilio.FlexApi.V1.UserRolesList} userRoles - userRoles resource
  * @property {Twilio.FlexApi.V1.WebChannelList} webChannel - webChannel resource
+ * @property {Twilio.FlexApi.V2.WebChannelsList} webChannels - webChannels resource
  *
  * @param {Twilio} twilio - The twilio client
  */
@@ -39,6 +42,7 @@ function FlexApi(twilio) {
 
   // Versions
   this._v1 = undefined;
+  this._v2 = undefined;
 }
 
 _.extend(FlexApi.prototype, Domain.prototype);
@@ -52,6 +56,14 @@ Object.defineProperty(FlexApi.prototype,
     }
 });
 
+Object.defineProperty(FlexApi.prototype,
+  'v2', {
+    get: function() {
+      this._v2 = this._v2 || new V2(this);
+      return this._v2;
+    }
+});
+
 Object.defineProperty(FlexApi.prototype,
   'assessments', {
     get: function() {
@@ -108,4 +120,11 @@ Object.defineProperty(FlexApi.prototype,
     }
 });
 
+Object.defineProperty(FlexApi.prototype,
+  'webChannels', {
+    get: function() {
+      return this.v2.webChannels;
+    }
+});
+
 module.exports = FlexApi;

package/lib/rest/Oauth.d.ts

@@ -8,6 +8,7 @@
 import Domain = require('../base/Domain');
 import Twilio = require('./Twilio');
 import V1 = require('./oauth/V1');
+import { DeviceCodeListInstance } from './oauth/v1/deviceCode';
 import { OauthListInstance } from './oauth/v1/oauth';
 import { OpenidDiscoveryListInstance } from './oauth/v1/openidDiscovery';
 import { TokenListInstance } from './oauth/v1/token';
@@ -22,6 +23,7 @@ declare class Oauth extends Domain {
    */
   constructor(twilio: Twilio);
 
+  readonly deviceCode: DeviceCodeListInstance;
   readonly oauth: OauthListInstance;
   readonly openidDiscovery: OpenidDiscoveryListInstance;
   readonly token: TokenListInstance;

package/lib/rest/Oauth.js

@@ -22,6 +22,7 @@ var V1 = require('./oauth/V1');  /* jshint ignore:line */
  *
  * @property {Twilio.Oauth.V1} v1 - v1 version
  * @property {Twilio.Oauth.V1.OauthList} oauth - oauth resource
+ * @property {Twilio.Oauth.V1.DeviceCodeList} deviceCode - deviceCode resource
  * @property {Twilio.Oauth.V1.OpenidDiscoveryList} openidDiscovery -
  *          openidDiscovery resource
  * @property {Twilio.Oauth.V1.TokenList} token - token resource
@@ -55,6 +56,13 @@ Object.defineProperty(Oauth.prototype,
     }
 });
 
+Object.defineProperty(Oauth.prototype,
+  'deviceCode', {
+    get: function() {
+      return this.v1.deviceCode;
+    }
+});
+
 Object.defineProperty(Oauth.prototype,
   'openidDiscovery', {
     get: function() {

package/lib/rest/api/v2010/account/address.d.ts

@@ -31,6 +31,7 @@ declare function AddressList(version: V2010, accountSid: string): AddressListIns
  * @property postalCode - The postal code of the address
  * @property region - The state or region of the address
  * @property street - The number and street address of the address
+ * @property streetSecondary - The additional number and street address of the address
  */
 interface AddressInstanceUpdateOptions {
   autoCorrectAddress?: boolean;
@@ -41,6 +42,7 @@ interface AddressInstanceUpdateOptions {
   postalCode?: string;
   region?: string;
   street?: string;
+  streetSecondary?: string;
 }
 
 interface AddressListInstance {
@@ -175,6 +177,7 @@ interface AddressListInstance {
  * @property postalCode - The postal code of the new address
  * @property region - The state or region of the new address
  * @property street - The number and street address of the new address
+ * @property streetSecondary - The additional number and street address of the address
  */
 interface AddressListInstanceCreateOptions {
   autoCorrectAddress?: boolean;
@@ -186,6 +189,7 @@ interface AddressListInstanceCreateOptions {
   postalCode: string;
   region: string;
   street: string;
+  streetSecondary?: string;
 }
 
 /**
@@ -279,6 +283,7 @@ interface AddressResource {
   region: string;
   sid: string;
   street: string;
+  street_secondary: string;
   uri: string;
   validated: boolean;
   verified: boolean;
@@ -372,6 +377,7 @@ declare class AddressInstance extends SerializableClass {
   remove(callback?: (error: Error | null, items: AddressInstance) => any): Promise<boolean>;
   sid: string;
   street: string;
+  streetSecondary: string;
   /**
    * Provide a user-friendly representation
    */

package/lib/rest/api/v2010/account/address.js

@@ -74,6 +74,8 @@ AddressList = function AddressList(version, accountSid) {
    *          Whether to enable emergency calling on the new address
    * @param {boolean} [opts.autoCorrectAddress] -
    *          Whether we should automatically correct the address
+   * @param {string} [opts.streetSecondary] -
+   *          The additional number and street address of the address
    * @param {function} [callback] - Callback to handle processed record
    *
    * @returns {Promise} Resolves to processed AddressInstance
@@ -112,7 +114,8 @@ AddressList = function AddressList(version, accountSid) {
       'IsoCountry': _.get(opts, 'isoCountry'),
       'FriendlyName': _.get(opts, 'friendlyName'),
       'EmergencyEnabled': serialize.bool(_.get(opts, 'emergencyEnabled')),
-      'AutoCorrectAddress': serialize.bool(_.get(opts, 'autoCorrectAddress'))
+      'AutoCorrectAddress': serialize.bool(_.get(opts, 'autoCorrectAddress')),
+      'StreetSecondary': _.get(opts, 'streetSecondary')
     });
 
     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
@@ -533,6 +536,8 @@ AddressPage.prototype[util.inspect.custom] = function inspect(depth, options) {
  *          Whether the address has been validated to comply with local regulation
  * @property {boolean} verified -
  *          Whether the address has been verified to comply with regulation
+ * @property {string} streetSecondary -
+ *          The additional number and street address of the address
  *
  * @param {V2010} version - Version of the resource
  * @param {AddressPayload} payload - The instance payload
@@ -560,6 +565,7 @@ AddressInstance = function AddressInstance(version, payload, accountSid, sid) {
   this.emergencyEnabled = payload.emergency_enabled; // jshint ignore:line
   this.validated = payload.validated; // jshint ignore:line
   this.verified = payload.verified; // jshint ignore:line
+  this.streetSecondary = payload.street_secondary; // jshint ignore:line
 
   // Context
   this._context = undefined;
@@ -627,6 +633,8 @@ AddressInstance.prototype.fetch = function fetch(callback) {
  *          Whether to enable emergency calling on the address
  * @param {boolean} [opts.autoCorrectAddress] -
  *          Whether we should automatically correct the address
+ * @param {string} [opts.streetSecondary] -
+ *          The additional number and street address of the address
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed AddressInstance
@@ -788,6 +796,8 @@ AddressContext.prototype.fetch = function fetch(callback) {
  *          Whether to enable emergency calling on the address
  * @param {boolean} [opts.autoCorrectAddress] -
  *          Whether we should automatically correct the address
+ * @param {string} [opts.streetSecondary] -
+ *          The additional number and street address of the address
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed AddressInstance
@@ -809,7 +819,8 @@ AddressContext.prototype.update = function update(opts, callback) {
     'Region': _.get(opts, 'region'),
     'PostalCode': _.get(opts, 'postalCode'),
     'EmergencyEnabled': serialize.bool(_.get(opts, 'emergencyEnabled')),
-    'AutoCorrectAddress': serialize.bool(_.get(opts, 'autoCorrectAddress'))
+    'AutoCorrectAddress': serialize.bool(_.get(opts, 'autoCorrectAddress')),
+    'StreetSecondary': _.get(opts, 'streetSecondary')
   });
 
   var promise = this._version.update({uri: this._uri, method: 'POST', data: data});

package/lib/rest/api/v2010/account/call/userDefinedMessageSubscription.d.ts

@@ -53,7 +53,7 @@ interface UserDefinedMessageSubscriptionListInstance {
 interface UserDefinedMessageSubscriptionListInstanceCreateOptions {
   callback: string;
   idempotencyKey?: string;
-  method: string;
+  method?: string;
 }
 
 interface UserDefinedMessageSubscriptionPayload extends UserDefinedMessageSubscriptionResource, Page.TwilioResponsePayload {

package/lib/rest/api/v2010/account/call/userDefinedMessageSubscription.js

@@ -63,9 +63,9 @@ UserDefinedMessageSubscriptionList = function
    * @param {object} opts - Options for request
    * @param {string} opts.callback -
    *          The URL we should call to send user defined messages.
-   * @param {string} opts.method - HTTP method used with the callback.
    * @param {string} [opts.idempotencyKey] -
    *          A unique string value to identify API call. This should be a unique string value per API call and can be a randomly generated.
+   * @param {string} [opts.method] - HTTP method used with the callback.
    * @param {function} [callback] - Callback to handle processed record
    *
    * @returns {Promise} Resolves to processed UserDefinedMessageSubscriptionInstance
@@ -79,15 +79,12 @@ UserDefinedMessageSubscriptionList = function
     if (_.isUndefined(opts['callback'])) {
       throw new Error('Required parameter "opts[\'callback\']" missing.');
     }
-    if (_.isUndefined(opts['method'])) {
-      throw new Error('Required parameter "opts[\'method\']" missing.');
-    }
 
     var deferred = Q.defer();
     var data = values.of({
       'Callback': _.get(opts, 'callback'),
-      'Method': _.get(opts, 'method'),
-      'IdempotencyKey': _.get(opts, 'idempotencyKey')
+      'IdempotencyKey': _.get(opts, 'idempotencyKey'),
+      'Method': _.get(opts, 'method')
     });
 
     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});

package/lib/rest/flexApi/V2.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import FlexApi = require('../FlexApi');
+import Version = require('../../base/Version');
+import { WebChannelsList } from './v2/webChannels';
+import { WebChannelsListInstance } from './v2/webChannels';
+
+
+declare class V2 extends Version {
+  /**
+   * Initialize the V2 version of FlexApi
+   *
+   * @param domain - The twilio domain
+   */
+  constructor(domain: FlexApi);
+
+  readonly webChannels: WebChannelsListInstance;
+}
+
+export = V2;

package/lib/rest/flexApi/V2.js

@@ -0,0 +1,46 @@
+'use strict';
+
+/* jshint ignore:start */
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+/* jshint ignore:end */
+
+var _ = require('lodash');  /* jshint ignore:line */
+var Version = require('../../base/Version');  /* jshint ignore:line */
+var WebChannelsList = require('./v2/webChannels').WebChannelsList;
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the V2 version of FlexApi
+ *
+ * @constructor Twilio.FlexApi.V2
+ *
+ * @property {Twilio.FlexApi.V2.WebChannelsList} webChannels - webChannels resource
+ *
+ * @param {Twilio.FlexApi} domain - The twilio domain
+ */
+/* jshint ignore:end */
+function V2(domain) {
+  Version.prototype.constructor.call(this, domain, 'v2');
+
+  // Resources
+  this._webChannels = undefined;
+}
+
+_.extend(V2.prototype, Version.prototype);
+V2.prototype.constructor = V2;
+
+Object.defineProperty(V2.prototype,
+  'webChannels', {
+    get: function() {
+      this._webChannels = this._webChannels || new WebChannelsList(this);
+      return this._webChannels;
+    }
+});
+
+module.exports = V2;

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

@@ -45,7 +45,7 @@ interface GoodDataPayload extends GoodDataResource, Page.TwilioResponsePayload {
 }
 
 interface GoodDataResource {
-  gd_base_url: string;
+  base_url: string;
   session_expiry: string;
   session_id: string;
   url: string;
@@ -94,6 +94,7 @@ declare class GoodDataInstance extends SerializableClass {
   constructor(version: V1, payload: GoodDataPayload);
 
   private _proxy: GoodDataContext;
+  baseUrl: string;
   /**
    * create a GoodDataInstance
    *
@@ -107,7 +108,6 @@ declare class GoodDataInstance extends SerializableClass {
    * @param callback - Callback to handle processed record
    */
   create(opts?: GoodDataInstanceCreateOptions, callback?: (error: Error | null, items: GoodDataInstance) => any): Promise<GoodDataInstance>;
-  gdBaseUrl: string;
   sessionExpiry: string;
   sessionId: string;
   /**

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

@@ -153,10 +153,10 @@ GoodDataPage.prototype[util.inspect.custom] = function inspect(depth, options) {
  *
  * @constructor Twilio.FlexApi.V1.GoodDataInstance
  *
- * @property {string} workspaceId - Unique workspace ID in gooddata
+ * @property {string} workspaceId - Unique ID to identify the user's workspace
  * @property {string} sessionExpiry - The session expiry date and time
  * @property {string} sessionId - Unique session ID
- * @property {string} gdBaseUrl - GoodData login base URL
+ * @property {string} baseUrl - Base URL to fetch reports and dashboards
  * @property {string} url - The URL of this resource.
  *
  * @param {V1} version - Version of the resource
@@ -170,7 +170,7 @@ GoodDataInstance = function GoodDataInstance(version, payload) {
   this.workspaceId = payload.workspace_id; // jshint ignore:line
   this.sessionExpiry = payload.session_expiry; // jshint ignore:line
   this.sessionId = payload.session_id; // jshint ignore:line
-  this.gdBaseUrl = payload.gd_base_url; // jshint ignore:line
+  this.baseUrl = payload.base_url; // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
 
   // Context
@@ -247,7 +247,7 @@ GoodDataContext = function GoodDataContext(version) {
 
   // Path Solution
   this._solution = {};
-  this._uri = `/Accounts/GoodData`;
+  this._uri = `/Insights/Session`;
 };
 
 /* jshint ignore:start */

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

@@ -242,7 +242,7 @@ UserRolesContext = function UserRolesContext(version) {
 
   // Path Solution
   this._solution = {};
-  this._uri = `/Accounts/UserRoles`;
+  this._uri = `/Insights/UserRoles`;
 };
 
 /* jshint ignore:start */

package/lib/rest/flexApi/v2/webChannels.d.ts

@@ -0,0 +1,101 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V2 = require('../V2');
+import { SerializableClass } from '../../../interfaces';
+
+/**
+ * Initialize the WebChannelsList
+ *
+ * @param version - Version of the resource
+ */
+declare function WebChannelsList(version: V2): WebChannelsListInstance;
+
+interface WebChannelsListInstance {
+  /**
+   * create a WebChannelsInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  create(opts: WebChannelsListInstanceCreateOptions, callback?: (error: Error | null, item: WebChannelsInstance) => any): Promise<WebChannelsInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to create
+ *
+ * @property addressSid - The SID of the Conversations Address
+ * @property chatFriendlyName - The Conversation's friendly name
+ * @property customerFriendlyName - The Conversation participant's friendly name
+ * @property preEngagementData - The pre-engagement data
+ */
+interface WebChannelsListInstanceCreateOptions {
+  addressSid: string;
+  chatFriendlyName?: string;
+  customerFriendlyName?: string;
+  preEngagementData?: string;
+}
+
+interface WebChannelsPayload extends WebChannelsResource, Page.TwilioResponsePayload {
+}
+
+interface WebChannelsResource {
+  conversation_sid: string;
+  identity: string;
+}
+
+interface WebChannelsSolution {
+}
+
+
+declare class WebChannelsInstance extends SerializableClass {
+  /**
+   * Initialize the WebChannelsContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   */
+  constructor(version: V2, payload: WebChannelsPayload);
+
+  conversationSid: string;
+  identity: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class WebChannelsPage extends Page<V2, WebChannelsPayload, WebChannelsResource, WebChannelsInstance> {
+  /**
+   * Initialize the WebChannelsPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V2, response: Response<string>, solution: WebChannelsSolution);
+
+  /**
+   * Build an instance of WebChannelsInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: WebChannelsPayload): WebChannelsInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { WebChannelsInstance, WebChannelsList, WebChannelsListInstance, WebChannelsListInstanceCreateOptions, WebChannelsPage, WebChannelsPayload, WebChannelsResource, WebChannelsSolution }