twilio 3.75.0 → 3.76.1

package/lib/rest/chat/v2/service/user/userChannel.js

@@ -512,13 +512,16 @@ UserChannelInstance.prototype.fetch = function fetch(callback) {
  * @function remove
  * @memberof Twilio.Chat.V2.ServiceContext.UserContext.UserChannelInstance#
  *
+ * @param {object} [opts] - Options for request
+ * @param {user_channel.webhook_enabled_type} [opts.xTwilioWebhookEnabled] -
+ *          The X-Twilio-Webhook-Enabled HTTP request header
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed UserChannelInstance
  */
 /* jshint ignore:end */
-UserChannelInstance.prototype.remove = function remove(callback) {
-  return this._proxy.remove(callback);
+UserChannelInstance.prototype.remove = function remove(opts, callback) {
+  return this._proxy.remove(opts, callback);
 };
 
 /* jshint ignore:start */
@@ -638,14 +641,25 @@ UserChannelContext.prototype.fetch = function fetch(callback) {
  * @function remove
  * @memberof Twilio.Chat.V2.ServiceContext.UserContext.UserChannelContext#
  *
+ * @param {object} [opts] - Options for request
+ * @param {user_channel.webhook_enabled_type} [opts.xTwilioWebhookEnabled] -
+ *          The X-Twilio-Webhook-Enabled HTTP request header
  * @param {function} [callback] - Callback to handle processed record
  *
  * @returns {Promise} Resolves to processed UserChannelInstance
  */
 /* jshint ignore:end */
-UserChannelContext.prototype.remove = function remove(callback) {
+UserChannelContext.prototype.remove = function remove(opts, callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
   var deferred = Q.defer();
-  var promise = this._version.remove({uri: this._uri, method: 'DELETE'});
+  var headers = values.of({'X-Twilio-Webhook-Enabled': _.get(opts, 'xTwilioWebhookEnabled')});
+
+  var promise = this._version.remove({uri: this._uri, method: 'DELETE', headers: headers});
 
   promise = promise.then(function(payload) {
     deferred.resolve(payload);

package/lib/rest/chat/v3/channel.d.ts

@@ -0,0 +1,177 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V3 = require('../V3');
+import { SerializableClass } from '../../../interfaces';
+
+type ChannelChannelType = 'public'|'private';
+
+type ChannelWebhookEnabledType = 'true'|'false';
+
+/**
+ * Initialize the ChannelList
+ *
+ * @param version - Version of the resource
+ */
+declare function ChannelList(version: V3): ChannelListInstance;
+
+/**
+ * Options to pass to update
+ *
+ * @property messagingServiceSid - The unique ID of the Messaging Service this channel belongs to.
+ * @property type - The Type for this Channel to migrate to.
+ * @property xTwilioWebhookEnabled - The X-Twilio-Webhook-Enabled HTTP request header
+ */
+interface ChannelInstanceUpdateOptions {
+  messagingServiceSid?: string;
+  type?: ChannelChannelType;
+  xTwilioWebhookEnabled?: ChannelWebhookEnabledType;
+}
+
+interface ChannelListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): ChannelContext;
+  /**
+   * Constructs a channel
+   *
+   * @param serviceSid - Service Sid.
+   * @param sid - A string that uniquely identifies this Channel.
+   */
+  get(serviceSid: string, sid: string): ChannelContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface ChannelPayload extends ChannelResource, Page.TwilioResponsePayload {
+}
+
+interface ChannelResource {
+  account_sid: string;
+  attributes: string;
+  created_by: string;
+  date_created: Date;
+  date_updated: Date;
+  friendly_name: string;
+  members_count: number;
+  messages_count: number;
+  messaging_service_sid: string;
+  service_sid: string;
+  sid: string;
+  type: ChannelChannelType;
+  unique_name: string;
+  url: string;
+}
+
+interface ChannelSolution {
+}
+
+
+declare class ChannelContext {
+  /**
+   * Initialize the ChannelContext
+   *
+   * @param version - Version of the resource
+   * @param serviceSid - Service Sid.
+   * @param sid - A string that uniquely identifies this Channel.
+   */
+  constructor(version: V3, serviceSid: string, sid: string);
+
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a ChannelInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: ChannelInstance) => any): Promise<ChannelInstance>;
+  /**
+   * update a ChannelInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: ChannelInstanceUpdateOptions, callback?: (error: Error | null, items: ChannelInstance) => any): Promise<ChannelInstance>;
+}
+
+
+declare class ChannelInstance extends SerializableClass {
+  /**
+   * Initialize the ChannelContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param serviceSid - Service Sid.
+   * @param sid - A string that uniquely identifies this Channel.
+   */
+  constructor(version: V3, payload: ChannelPayload, serviceSid: string, sid: string);
+
+  private _proxy: ChannelContext;
+  accountSid: string;
+  attributes: string;
+  createdBy: string;
+  dateCreated: Date;
+  dateUpdated: Date;
+  friendlyName: string;
+  membersCount: number;
+  messagesCount: number;
+  messagingServiceSid: string;
+  serviceSid: string;
+  sid: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  type: ChannelChannelType;
+  uniqueName: string;
+  /**
+   * update a ChannelInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: ChannelInstance) => any): Promise<ChannelInstance>;
+  /**
+   * update a ChannelInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: ChannelInstanceUpdateOptions, callback?: (error: Error | null, items: ChannelInstance) => any): Promise<ChannelInstance>;
+  url: string;
+}
+
+
+declare class ChannelPage extends Page<V3, ChannelPayload, ChannelResource, ChannelInstance> {
+  /**
+   * Initialize the ChannelPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V3, response: Response<string>, solution: ChannelSolution);
+
+  /**
+   * Build an instance of ChannelInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: ChannelPayload): ChannelInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { ChannelChannelType, ChannelContext, ChannelInstance, ChannelInstanceUpdateOptions, ChannelList, ChannelListInstance, ChannelPage, ChannelPayload, ChannelResource, ChannelSolution, ChannelWebhookEnabledType }

package/lib/rest/chat/v3/channel.js

@@ -0,0 +1,373 @@
+'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 deserialize = require(
+    '../../../base/deserialize');  /* jshint ignore:line */
+var values = require('../../../base/values');  /* jshint ignore:line */
+
+var ChannelList;
+var ChannelPage;
+var ChannelInstance;
+var ChannelContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the ChannelList
+ *
+ * @constructor Twilio.Chat.V3.ChannelList
+ *
+ * @param {Twilio.Chat.V3} version - Version of the resource
+ */
+/* jshint ignore:end */
+ChannelList = function ChannelList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function channels
+   * @memberof Twilio.Chat.V3#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Chat.V3.ChannelContext}
+   */
+  /* jshint ignore:end */
+  function ChannelListInstance(sid) {
+    return ChannelListInstance.get(sid);
+  }
+
+  ChannelListInstance._version = version;
+  // Path Solution
+  ChannelListInstance._solution = {};
+  /* jshint ignore:start */
+  /**
+   * Constructs a channel
+   *
+   * @function get
+   * @memberof Twilio.Chat.V3.ChannelList#
+   *
+   * @param {string} serviceSid - Service Sid.
+   * @param {string} sid - A string that uniquely identifies this Channel.
+   *
+   * @returns {Twilio.Chat.V3.ChannelContext}
+   */
+  /* jshint ignore:end */
+  ChannelListInstance.get = function get(serviceSid, sid) {
+    return new ChannelContext(this._version, serviceSid, sid);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Chat.V3.ChannelList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  ChannelListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  ChannelListInstance[util.inspect.custom] = function inspect(depth, options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return ChannelListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the ChannelPage
+ *
+ * @constructor Twilio.Chat.V3.ChannelPage
+ *
+ * @param {V3} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {ChannelSolution} solution - Path solution
+ *
+ * @returns ChannelPage
+ */
+/* jshint ignore:end */
+ChannelPage = function ChannelPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(ChannelPage.prototype, Page.prototype);
+ChannelPage.prototype.constructor = ChannelPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of ChannelInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Chat.V3.ChannelPage#
+ *
+ * @param {ChannelPayload} payload - Payload response from the API
+ *
+ * @returns ChannelInstance
+ */
+/* jshint ignore:end */
+ChannelPage.prototype.getInstance = function getInstance(payload) {
+  return new ChannelInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Chat.V3.ChannelPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+ChannelPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+ChannelPage.prototype[util.inspect.custom] = function inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the ChannelContext
+ *
+ * @constructor Twilio.Chat.V3.ChannelInstance
+ *
+ * @property {string} sid - The unique string that identifies the resource
+ * @property {string} accountSid - The SID of the Account that created the resource
+ * @property {string} serviceSid -
+ *          The SID of the Service that the resource is associated with
+ * @property {string} friendlyName -
+ *          The string that you assigned to describe the resource
+ * @property {string} uniqueName -
+ *          An application-defined string that uniquely identifies the resource
+ * @property {string} attributes -
+ *          The JSON string that stores application-specific data
+ * @property {channel.channel_type} type -
+ *          The visibility of the channel. Can be: `public` or `private`
+ * @property {Date} dateCreated -
+ *          The ISO 8601 date and time in GMT when the resource was created
+ * @property {Date} dateUpdated -
+ *          The ISO 8601 date and time in GMT when the resource was last updated
+ * @property {string} createdBy - The identity of the User that created the channel
+ * @property {number} membersCount - The number of Members in the Channel
+ * @property {number} messagesCount -
+ *          The number of Messages that have been passed in the Channel
+ * @property {string} messagingServiceSid -
+ *          The unique ID of the Messaging Service this channel belongs to.
+ * @property {string} url - The absolute URL of the Channel resource
+ *
+ * @param {V3} version - Version of the resource
+ * @param {ChannelPayload} payload - The instance payload
+ * @param {sid} serviceSid - Service Sid.
+ * @param {sid_like} sid - A string that uniquely identifies this Channel.
+ */
+/* jshint ignore:end */
+ChannelInstance = function ChannelInstance(version, payload, serviceSid, sid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.sid = payload.sid; // jshint ignore:line
+  this.accountSid = payload.account_sid; // jshint ignore:line
+  this.serviceSid = payload.service_sid; // jshint ignore:line
+  this.friendlyName = payload.friendly_name; // jshint ignore:line
+  this.uniqueName = payload.unique_name; // jshint ignore:line
+  this.attributes = payload.attributes; // jshint ignore:line
+  this.type = payload.type; // jshint ignore:line
+  this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
+  this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
+  this.createdBy = payload.created_by; // jshint ignore:line
+  this.membersCount = deserialize.integer(payload.members_count); // jshint ignore:line
+  this.messagesCount = deserialize.integer(payload.messages_count); // jshint ignore:line
+  this.messagingServiceSid = payload.messaging_service_sid; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {serviceSid: serviceSid || this.serviceSid, sid: sid || this.sid, };
+};
+
+Object.defineProperty(ChannelInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new ChannelContext(this._version, this._solution.serviceSid, this._solution.sid);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * update a ChannelInstance
+ *
+ * @function update
+ * @memberof Twilio.Chat.V3.ChannelInstance#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {channel.channel_type} [opts.type] -
+ *          The Type for this Channel to migrate to.
+ * @param {string} [opts.messagingServiceSid] -
+ *          The unique ID of the Messaging Service this channel belongs to.
+ * @param {channel.webhook_enabled_type} [opts.xTwilioWebhookEnabled] -
+ *          The X-Twilio-Webhook-Enabled HTTP request header
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed ChannelInstance
+ */
+/* jshint ignore:end */
+ChannelInstance.prototype.update = function update(opts, callback) {
+  return this._proxy.update(opts, callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Chat.V3.ChannelInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+ChannelInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+ChannelInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the ChannelContext
+ *
+ * @constructor Twilio.Chat.V3.ChannelContext
+ *
+ * @param {V3} version - Version of the resource
+ * @param {sid} serviceSid - Service Sid.
+ * @param {sid_like} sid - A string that uniquely identifies this Channel.
+ */
+/* jshint ignore:end */
+ChannelContext = function ChannelContext(version, serviceSid, sid) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {serviceSid: serviceSid, sid: sid, };
+  this._uri = `/Services/${serviceSid}/Channels/${sid}`;
+};
+
+/* jshint ignore:start */
+/**
+ * update a ChannelInstance
+ *
+ * @function update
+ * @memberof Twilio.Chat.V3.ChannelContext#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {channel.channel_type} [opts.type] -
+ *          The Type for this Channel to migrate to.
+ * @param {string} [opts.messagingServiceSid] -
+ *          The unique ID of the Messaging Service this channel belongs to.
+ * @param {channel.webhook_enabled_type} [opts.xTwilioWebhookEnabled] -
+ *          The X-Twilio-Webhook-Enabled HTTP request header
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed ChannelInstance
+ */
+/* jshint ignore:end */
+ChannelContext.prototype.update = function update(opts, callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
+  var deferred = Q.defer();
+  var data = values.of({
+    'Type': _.get(opts, 'type'),
+    'MessagingServiceSid': _.get(opts, 'messagingServiceSid')
+  });
+  var headers = values.of({'X-Twilio-Webhook-Enabled': _.get(opts, 'xTwilioWebhookEnabled')});
+
+  var promise = this._version.update({uri: this._uri, method: 'POST', data: data, headers: headers});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new ChannelInstance(
+      this._version,
+      payload,
+      this._solution.serviceSid,
+      this._solution.sid
+    ));
+  }.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.Chat.V3.ChannelContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+ChannelContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+ChannelContext.prototype[util.inspect.custom] = function inspect(depth, options)
+    {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  ChannelList: ChannelList,
+  ChannelPage: ChannelPage,
+  ChannelInstance: ChannelInstance,
+  ChannelContext: ChannelContext
+};

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

@@ -13,6 +13,8 @@ import { ConfigurationList } from './v1/configuration';
 import { ConfigurationListInstance } from './v1/configuration';
 import { FlexFlowList } from './v1/flexFlow';
 import { FlexFlowListInstance } from './v1/flexFlow';
+import { InteractionList } from './v1/interaction';
+import { InteractionListInstance } from './v1/interaction';
 import { WebChannelList } from './v1/webChannel';
 import { WebChannelListInstance } from './v1/webChannel';
 
@@ -28,6 +30,7 @@ declare class V1 extends Version {
   readonly channel: ChannelListInstance;
   readonly configuration: ConfigurationListInstance;
   readonly flexFlow: FlexFlowListInstance;
+  readonly interaction: InteractionListInstance;
   readonly webChannel: WebChannelListInstance;
 }
 

package/lib/rest/flexApi/V1.js

@@ -13,6 +13,7 @@ var _ = require('lodash');  /* jshint ignore:line */
 var ChannelList = require('./v1/channel').ChannelList;
 var ConfigurationList = require('./v1/configuration').ConfigurationList;
 var FlexFlowList = require('./v1/flexFlow').FlexFlowList;
+var InteractionList = require('./v1/interaction').InteractionList;
 var Version = require('../../base/Version');  /* jshint ignore:line */
 var WebChannelList = require('./v1/webChannel').WebChannelList;
 
@@ -27,6 +28,7 @@ var WebChannelList = require('./v1/webChannel').WebChannelList;
  * @property {Twilio.FlexApi.V1.ConfigurationList} configuration -
  *          configuration resource
  * @property {Twilio.FlexApi.V1.FlexFlowList} flexFlow - flexFlow resource
+ * @property {Twilio.FlexApi.V1.InteractionList} interaction - interaction resource
  * @property {Twilio.FlexApi.V1.WebChannelList} webChannel - webChannel resource
  *
  * @param {Twilio.FlexApi} domain - The twilio domain
@@ -39,6 +41,7 @@ function V1(domain) {
   this._channel = undefined;
   this._configuration = undefined;
   this._flexFlow = undefined;
+  this._interaction = undefined;
   this._webChannel = undefined;
 }
 
@@ -69,6 +72,14 @@ Object.defineProperty(V1.prototype,
     }
 });
 
+Object.defineProperty(V1.prototype,
+  'interaction', {
+    get: function() {
+      this._interaction = this._interaction || new InteractionList(this);
+      return this._interaction;
+    }
+});
+
 Object.defineProperty(V1.prototype,
   'webChannel', {
     get: function() {

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

@@ -51,6 +51,7 @@ interface ConfigurationResource {
   attributes: object;
   call_recording_enabled: boolean;
   call_recording_webhook_url: string;
+  channel_configs: object[];
   chat_service_instance_sid: string;
   crm_attributes: object;
   crm_callback_url: string;
@@ -149,6 +150,7 @@ declare class ConfigurationInstance extends SerializableClass {
   attributes: any;
   callRecordingEnabled: boolean;
   callRecordingWebhookUrl: string;
+  channelConfigs: object[];
   chatServiceInstanceSid: string;
   /**
    * create a ConfigurationInstance

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

@@ -214,6 +214,8 @@ ConfigurationPage.prototype[util.inspect.custom] = function inspect(depth,
  * @property {boolean} flexInsightsDrilldown -
  *          Setting to enable Flex UI redirection
  * @property {string} flexUrl - URL to redirect to in case drilldown is enabled.
+ * @property {object} channelConfigs -
+ *          Flex Conversations channels' attachments configurations
  *
  * @param {V1} version - Version of the resource
  * @param {ConfigurationPayload} payload - The instance payload
@@ -265,6 +267,7 @@ ConfigurationInstance = function ConfigurationInstance(version, payload) {
   this.flexInsightsHr = payload.flex_insights_hr; // jshint ignore:line
   this.flexInsightsDrilldown = payload.flex_insights_drilldown; // jshint ignore:line
   this.flexUrl = payload.flex_url; // jshint ignore:line
+  this.channelConfigs = payload.channel_configs; // jshint ignore:line
 
   // Context
   this._context = undefined;