twilio 3.83.3 → 3.84.0

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

@@ -0,0 +1,300 @@
+'use strict';
+
+/* jshint ignore:start */
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+/* jshint ignore:end */
+
+var Q = require('q');  /* jshint ignore:line */
+var _ = require('lodash');  /* jshint ignore:line */
+var util = require('util');  /* jshint ignore:line */
+var Page = require('../../../base/Page');  /* jshint ignore:line */
+var values = require('../../../base/values');  /* jshint ignore:line */
+
+var AssessmentsList;
+var AssessmentsPage;
+var AssessmentsInstance;
+var AssessmentsContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the AssessmentsList
+ *
+ * @constructor Twilio.FlexApi.V1.AssessmentsList
+ *
+ * @param {Twilio.FlexApi.V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+AssessmentsList = function AssessmentsList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function assessments
+   * @memberof Twilio.FlexApi.V1#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.FlexApi.V1.AssessmentsContext}
+   */
+  /* jshint ignore:end */
+  function AssessmentsListInstance(sid) {
+    return AssessmentsListInstance.get(sid);
+  }
+
+  AssessmentsListInstance._version = version;
+  // Path Solution
+  AssessmentsListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a assessments
+   *
+   * @function get
+   * @memberof Twilio.FlexApi.V1.AssessmentsList#
+   *
+   * @returns {Twilio.FlexApi.V1.AssessmentsContext}
+   */
+  /* jshint ignore:end */
+  AssessmentsListInstance.get = function get() {
+    return new AssessmentsContext(this._version);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.FlexApi.V1.AssessmentsList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  AssessmentsListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  AssessmentsListInstance[util.inspect.custom] = function inspect(depth, options)
+      {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return AssessmentsListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the AssessmentsPage
+ *
+ * @constructor Twilio.FlexApi.V1.AssessmentsPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {AssessmentsSolution} solution - Path solution
+ *
+ * @returns AssessmentsPage
+ */
+/* jshint ignore:end */
+AssessmentsPage = function AssessmentsPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(AssessmentsPage.prototype, Page.prototype);
+AssessmentsPage.prototype.constructor = AssessmentsPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of AssessmentsInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.FlexApi.V1.AssessmentsPage#
+ *
+ * @param {AssessmentsPayload} payload - Payload response from the API
+ *
+ * @returns AssessmentsInstance
+ */
+/* jshint ignore:end */
+AssessmentsPage.prototype.getInstance = function getInstance(payload) {
+  return new AssessmentsInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V1.AssessmentsPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+AssessmentsPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+AssessmentsPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the AssessmentsContext
+ *
+ * @constructor Twilio.FlexApi.V1.AssessmentsInstance
+ *
+ * @property {string} url - The URL of this resource.
+ *
+ * @param {V1} version - Version of the resource
+ * @param {AssessmentsPayload} payload - The instance payload
+ */
+/* jshint ignore:end */
+AssessmentsInstance = function AssessmentsInstance(version, payload) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {};
+};
+
+Object.defineProperty(AssessmentsInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new AssessmentsContext(this._version);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * create a AssessmentsInstance
+ *
+ * @function create
+ * @memberof Twilio.FlexApi.V1.AssessmentsInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed AssessmentsInstance
+ */
+/* jshint ignore:end */
+AssessmentsInstance.prototype.create = function create(callback) {
+  return this._proxy.create(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V1.AssessmentsInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+AssessmentsInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+AssessmentsInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the AssessmentsContext
+ *
+ * @constructor Twilio.FlexApi.V1.AssessmentsContext
+ *
+ * @param {V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+AssessmentsContext = function AssessmentsContext(version) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {};
+  this._uri = `/Accounts/Assessments`;
+};
+
+/* jshint ignore:start */
+/**
+ * create a AssessmentsInstance
+ *
+ * @function create
+ * @memberof Twilio.FlexApi.V1.AssessmentsContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed AssessmentsInstance
+ */
+/* jshint ignore:end */
+AssessmentsContext.prototype.create = function create(callback) {
+  var deferred = Q.defer();
+  var promise = this._version.create({uri: this._uri, method: 'POST'});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new AssessmentsInstance(this._version, payload));
+  }.bind(this));
+
+  promise.catch(function(error) {
+    deferred.reject(error);
+  });
+
+  if (_.isFunction(callback)) {
+    deferred.promise.nodeify(callback);
+  }
+
+  return deferred.promise;
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V1.AssessmentsContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+AssessmentsContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+AssessmentsContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  AssessmentsList: AssessmentsList,
+  AssessmentsPage: AssessmentsPage,
+  AssessmentsInstance: AssessmentsInstance,
+  AssessmentsContext: AssessmentsContext
+};

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 }

package/lib/rest/flexApi/v2/webChannels.js

@@ -0,0 +1,244 @@
+'use strict';
+
+/* jshint ignore:start */
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+/* jshint ignore:end */
+
+var Q = require('q');  /* jshint ignore:line */
+var _ = require('lodash');  /* jshint ignore:line */
+var util = require('util');  /* jshint ignore:line */
+var Page = require('../../../base/Page');  /* jshint ignore:line */
+var values = require('../../../base/values');  /* jshint ignore:line */
+
+var WebChannelsList;
+var WebChannelsPage;
+var WebChannelsInstance;
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebChannelsList
+ *
+ * @constructor Twilio.FlexApi.V2.WebChannelsList
+ *
+ * @param {Twilio.FlexApi.V2} version - Version of the resource
+ */
+/* jshint ignore:end */
+WebChannelsList = function WebChannelsList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function webChannels
+   * @memberof Twilio.FlexApi.V2#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.FlexApi.V2.WebChannelsContext}
+   */
+  /* jshint ignore:end */
+  function WebChannelsListInstance(sid) {
+    return WebChannelsListInstance.get(sid);
+  }
+
+  WebChannelsListInstance._version = version;
+  // Path Solution
+  WebChannelsListInstance._solution = {};
+  WebChannelsListInstance._uri = `/WebChats`;
+  /* jshint ignore:start */
+  /**
+   * create a WebChannelsInstance
+   *
+   * @function create
+   * @memberof Twilio.FlexApi.V2.WebChannelsList#
+   *
+   * @param {object} opts - Options for request
+   * @param {string} opts.addressSid - The SID of the Conversations Address
+   * @param {string} [opts.chatFriendlyName] - The Conversation's friendly name
+   * @param {string} [opts.customerFriendlyName] -
+   *          The Conversation participant's friendly name
+   * @param {string} [opts.preEngagementData] - The pre-engagement data
+   * @param {function} [callback] - Callback to handle processed record
+   *
+   * @returns {Promise} Resolves to processed WebChannelsInstance
+   */
+  /* jshint ignore:end */
+  WebChannelsListInstance.create = function create(opts, callback) {
+    if (_.isUndefined(opts)) {
+      throw new Error('Required parameter "opts" missing.');
+    }
+    if (_.isUndefined(opts['addressSid'])) {
+      throw new Error('Required parameter "opts[\'addressSid\']" missing.');
+    }
+
+    var deferred = Q.defer();
+    var data = values.of({
+      'AddressSid': _.get(opts, 'addressSid'),
+      'ChatFriendlyName': _.get(opts, 'chatFriendlyName'),
+      'CustomerFriendlyName': _.get(opts, 'customerFriendlyName'),
+      'PreEngagementData': _.get(opts, 'preEngagementData')
+    });
+
+    var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
+
+    promise = promise.then(function(payload) {
+      deferred.resolve(new WebChannelsInstance(this._version, payload));
+    }.bind(this));
+
+    promise.catch(function(error) {
+      deferred.reject(error);
+    });
+
+    if (_.isFunction(callback)) {
+      deferred.promise.nodeify(callback);
+    }
+
+    return deferred.promise;
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.FlexApi.V2.WebChannelsList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  WebChannelsListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  WebChannelsListInstance[util.inspect.custom] = function inspect(depth, options)
+      {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return WebChannelsListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebChannelsPage
+ *
+ * @constructor Twilio.FlexApi.V2.WebChannelsPage
+ *
+ * @param {V2} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {WebChannelsSolution} solution - Path solution
+ *
+ * @returns WebChannelsPage
+ */
+/* jshint ignore:end */
+WebChannelsPage = function WebChannelsPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(WebChannelsPage.prototype, Page.prototype);
+WebChannelsPage.prototype.constructor = WebChannelsPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of WebChannelsInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.FlexApi.V2.WebChannelsPage#
+ *
+ * @param {WebChannelsPayload} payload - Payload response from the API
+ *
+ * @returns WebChannelsInstance
+ */
+/* jshint ignore:end */
+WebChannelsPage.prototype.getInstance = function getInstance(payload) {
+  return new WebChannelsInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V2.WebChannelsPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+WebChannelsPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+WebChannelsPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebChannelsContext
+ *
+ * @constructor Twilio.FlexApi.V2.WebChannelsInstance
+ *
+ * @property {string} conversationSid -
+ *          The unique string representing the Conversation resource created
+ * @property {string} identity - The unique string representing the User created
+ *
+ * @param {V2} version - Version of the resource
+ * @param {WebChannelsPayload} payload - The instance payload
+ */
+/* jshint ignore:end */
+WebChannelsInstance = function WebChannelsInstance(version, payload) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.conversationSid = payload.conversation_sid; // jshint ignore:line
+  this.identity = payload.identity; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {};
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V2.WebChannelsInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+WebChannelsInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+WebChannelsInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  WebChannelsList: WebChannelsList,
+  WebChannelsPage: WebChannelsPage,
+  WebChannelsInstance: WebChannelsInstance
+};