twilio 3.69.0 → 3.71.3

package/lib/rest/conversations/v1/service/configuration/webhook.d.ts

@@ -0,0 +1,172 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../../../base/Page');
+import Response = require('../../../../../http/response');
+import V1 = require('../../../V1');
+import { SerializableClass } from '../../../../../interfaces';
+
+type WebhookMethod = 'GET'|'POST';
+
+/**
+ * Initialize the WebhookList
+ *
+ * @param version - Version of the resource
+ * @param chatServiceSid - The unique string that identifies the resource
+ */
+declare function WebhookList(version: V1, chatServiceSid: string): WebhookListInstance;
+
+/**
+ * Options to pass to update
+ *
+ * @property filters - The list of webhook event triggers that are enabled for this Service.
+ * @property method - The HTTP method to be used when sending a webhook request
+ * @property postWebhookUrl - The absolute url the post-event webhook request should be sent to.
+ * @property preWebhookUrl - The absolute url the pre-event webhook request should be sent to.
+ */
+interface WebhookInstanceUpdateOptions {
+  filters?: string | string[];
+  method?: string;
+  postWebhookUrl?: string;
+  preWebhookUrl?: string;
+}
+
+interface WebhookListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): WebhookContext;
+  /**
+   * Constructs a webhook
+   */
+  get(): WebhookContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+interface WebhookPayload extends WebhookResource, Page.TwilioResponsePayload {
+}
+
+interface WebhookResource {
+  account_sid: string;
+  chat_service_sid: string;
+  filters: string[];
+  method: WebhookMethod;
+  post_webhook_url: string;
+  pre_webhook_url: string;
+  url: string;
+}
+
+interface WebhookSolution {
+  chatServiceSid?: string;
+}
+
+
+declare class WebhookContext {
+  /**
+   * Initialize the WebhookContext
+   *
+   * @param version - Version of the resource
+   * @param chatServiceSid - The unique ID of the Conversation Service this conversation belongs to.
+   */
+  constructor(version: V1, chatServiceSid: string);
+
+  /**
+   * fetch a WebhookInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: WebhookInstance) => any): Promise<WebhookInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a WebhookInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: WebhookInstance) => any): Promise<WebhookInstance>;
+  /**
+   * update a WebhookInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: WebhookInstanceUpdateOptions, callback?: (error: Error | null, items: WebhookInstance) => any): Promise<WebhookInstance>;
+}
+
+
+declare class WebhookInstance extends SerializableClass {
+  /**
+   * Initialize the WebhookContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param chatServiceSid - The unique string that identifies the resource
+   */
+  constructor(version: V1, payload: WebhookPayload, chatServiceSid: string);
+
+  private _proxy: WebhookContext;
+  accountSid: string;
+  chatServiceSid: string;
+  /**
+   * fetch a WebhookInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: WebhookInstance) => any): Promise<WebhookInstance>;
+  filters: string[];
+  method: WebhookMethod;
+  postWebhookUrl: string;
+  preWebhookUrl: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  /**
+   * update a WebhookInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  update(callback?: (error: Error | null, items: WebhookInstance) => any): Promise<WebhookInstance>;
+  /**
+   * update a WebhookInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  update(opts?: WebhookInstanceUpdateOptions, callback?: (error: Error | null, items: WebhookInstance) => any): Promise<WebhookInstance>;
+  url: string;
+}
+
+
+declare class WebhookPage extends Page<V1, WebhookPayload, WebhookResource, WebhookInstance> {
+  /**
+   * Initialize the WebhookPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: WebhookSolution);
+
+  /**
+   * Build an instance of WebhookInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: WebhookPayload): WebhookInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { WebhookContext, WebhookInstance, WebhookInstanceUpdateOptions, WebhookList, WebhookListInstance, WebhookMethod, WebhookPage, WebhookPayload, WebhookResource, WebhookSolution }

package/lib/rest/conversations/v1/service/configuration/webhook.js

@@ -0,0 +1,399 @@
+'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 serialize = require(
+    '../../../../../base/serialize');  /* jshint ignore:line */
+var values = require('../../../../../base/values');  /* jshint ignore:line */
+
+var WebhookList;
+var WebhookPage;
+var WebhookInstance;
+var WebhookContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebhookList
+ *
+ * @constructor Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookList
+ *
+ * @param {Twilio.Conversations.V1} version - Version of the resource
+ * @param {string} chatServiceSid - The unique string that identifies the resource
+ */
+/* jshint ignore:end */
+WebhookList = function WebhookList(version, chatServiceSid) {
+  /* jshint ignore:start */
+  /**
+   * @function webhooks
+   * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookContext}
+   */
+  /* jshint ignore:end */
+  function WebhookListInstance(sid) {
+    return WebhookListInstance.get(sid);
+  }
+
+  WebhookListInstance._version = version;
+  // Path Solution
+  WebhookListInstance._solution = {chatServiceSid: chatServiceSid};
+  /* jshint ignore:start */
+  /**
+   * Constructs a webhook
+   *
+   * @function get
+   * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookList#
+   *
+   * @returns {Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookContext}
+   */
+  /* jshint ignore:end */
+  WebhookListInstance.get = function get() {
+    return new WebhookContext(this._version, this._solution.chatServiceSid);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  WebhookListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  WebhookListInstance[util.inspect.custom] = function inspect(depth, options) {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return WebhookListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebhookPage
+ *
+ * @constructor Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {WebhookSolution} solution - Path solution
+ *
+ * @returns WebhookPage
+ */
+/* jshint ignore:end */
+WebhookPage = function WebhookPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(WebhookPage.prototype, Page.prototype);
+WebhookPage.prototype.constructor = WebhookPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of WebhookInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookPage#
+ *
+ * @param {WebhookPayload} payload - Payload response from the API
+ *
+ * @returns WebhookInstance
+ */
+/* jshint ignore:end */
+WebhookPage.prototype.getInstance = function getInstance(payload) {
+  return new WebhookInstance(this._version, payload, this._solution.chatServiceSid);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+WebhookPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+WebhookPage.prototype[util.inspect.custom] = function inspect(depth, options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebhookContext
+ *
+ * @constructor Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookInstance
+ *
+ * @property {string} accountSid -
+ *          The unique ID of the Account responsible for this service.
+ * @property {string} chatServiceSid - The chat_service_sid
+ * @property {string} preWebhookUrl -
+ *          The absolute url the pre-event webhook request should be sent to.
+ * @property {string} postWebhookUrl -
+ *          The absolute url the post-event webhook request should be sent to.
+ * @property {string} filters -
+ *          The list of webhook event triggers that are enabled for this Service.
+ * @property {webhook.method} method -
+ *          The HTTP method to be used when sending a webhook request
+ * @property {string} url - An absolute URL for this webhook.
+ *
+ * @param {V1} version - Version of the resource
+ * @param {WebhookPayload} payload - The instance payload
+ * @param {sid} chatServiceSid - The unique string that identifies the resource
+ */
+/* jshint ignore:end */
+WebhookInstance = function WebhookInstance(version, payload, chatServiceSid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.accountSid = payload.account_sid; // jshint ignore:line
+  this.chatServiceSid = payload.chat_service_sid; // jshint ignore:line
+  this.preWebhookUrl = payload.pre_webhook_url; // jshint ignore:line
+  this.postWebhookUrl = payload.post_webhook_url; // jshint ignore:line
+  this.filters = payload.filters; // jshint ignore:line
+  this.method = payload.method; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {chatServiceSid: chatServiceSid, };
+};
+
+Object.defineProperty(WebhookInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new WebhookContext(this._version, this._solution.chatServiceSid);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * update a WebhookInstance
+ *
+ * @function update
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookInstance#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.preWebhookUrl] -
+ *          The absolute url the pre-event webhook request should be sent to.
+ * @param {string} [opts.postWebhookUrl] -
+ *          The absolute url the post-event webhook request should be sent to.
+ * @param {string|list} [opts.filters] -
+ *          The list of webhook event triggers that are enabled for this Service.
+ * @param {string} [opts.method] -
+ *          The HTTP method to be used when sending a webhook request
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed WebhookInstance
+ */
+/* jshint ignore:end */
+WebhookInstance.prototype.update = function update(opts, callback) {
+  return this._proxy.update(opts, callback);
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a WebhookInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed WebhookInstance
+ */
+/* jshint ignore:end */
+WebhookInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+WebhookInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+WebhookInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the WebhookContext
+ *
+ * @constructor Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookContext
+ *
+ * @param {V1} version - Version of the resource
+ * @param {sid} chatServiceSid -
+ *          The unique ID of the Conversation Service this conversation belongs to.
+ */
+/* jshint ignore:end */
+WebhookContext = function WebhookContext(version, chatServiceSid) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {chatServiceSid: chatServiceSid, };
+  this._uri = `/Services/${chatServiceSid}/Configuration/Webhooks`;
+};
+
+/* jshint ignore:start */
+/**
+ * update a WebhookInstance
+ *
+ * @function update
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookContext#
+ *
+ * @param {object} [opts] - Options for request
+ * @param {string} [opts.preWebhookUrl] -
+ *          The absolute url the pre-event webhook request should be sent to.
+ * @param {string} [opts.postWebhookUrl] -
+ *          The absolute url the post-event webhook request should be sent to.
+ * @param {string|list} [opts.filters] -
+ *          The list of webhook event triggers that are enabled for this Service.
+ * @param {string} [opts.method] -
+ *          The HTTP method to be used when sending a webhook request
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed WebhookInstance
+ */
+/* jshint ignore:end */
+WebhookContext.prototype.update = function update(opts, callback) {
+  if (_.isFunction(opts)) {
+    callback = opts;
+    opts = {};
+  }
+  opts = opts || {};
+
+  var deferred = Q.defer();
+  var data = values.of({
+    'PreWebhookUrl': _.get(opts, 'preWebhookUrl'),
+    'PostWebhookUrl': _.get(opts, 'postWebhookUrl'),
+    'Filters': serialize.map(_.get(opts, 'filters'), function(e) { return e; }),
+    'Method': _.get(opts, 'method')
+  });
+
+  var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new WebhookInstance(this._version, payload, this._solution.chatServiceSid));
+  }.bind(this));
+
+  promise.catch(function(error) {
+    deferred.reject(error);
+  });
+
+  if (_.isFunction(callback)) {
+    deferred.promise.nodeify(callback);
+  }
+
+  return deferred.promise;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a WebhookInstance
+ *
+ * @function fetch
+ * @memberof Twilio.Conversations.V1.ServiceContext.ConfigurationContext.WebhookContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed WebhookInstance
+ */
+/* jshint ignore:end */
+WebhookContext.prototype.fetch = function fetch(callback) {
+  var deferred = Q.defer();
+  var promise = this._version.fetch({uri: this._uri, method: 'GET'});
+
+  promise = promise.then(function(payload) {
+    deferred.resolve(new WebhookInstance(this._version, payload, this._solution.chatServiceSid));
+  }.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.Conversations.V1.ServiceContext.ConfigurationContext.WebhookContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+WebhookContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+WebhookContext.prototype[util.inspect.custom] = function inspect(depth, options)
+    {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  WebhookList: WebhookList,
+  WebhookPage: WebhookPage,
+  WebhookInstance: WebhookInstance,
+  WebhookContext: WebhookContext
+};

package/lib/rest/conversations/v1/service/configuration.d.ts

@@ -10,6 +10,7 @@ import Response = require('../../../../http/response');
 import V1 = require('../../V1');
 import { NotificationListInstance } from './configuration/notification';
 import { SerializableClass } from '../../../../interfaces';
+import { WebhookListInstance } from './configuration/webhook';
 
 /**
  * Initialize the ConfigurationList
@@ -48,6 +49,7 @@ interface ConfigurationListInstance {
    * Provide a user-friendly representation
    */
   toJSON(): any;
+  webhooks?: WebhookListInstance;
 }
 
 interface ConfigurationPayload extends ConfigurationResource, Page.TwilioResponsePayload {

package/lib/rest/conversations/v1/service/configuration.js

@@ -14,6 +14,7 @@ var _ = require('lodash');  /* jshint ignore:line */
 var util = require('util');  /* jshint ignore:line */
 var NotificationList = require('./configuration/notification').NotificationList;
 var Page = require('../../../../base/Page');  /* jshint ignore:line */
+var WebhookList = require('./configuration/webhook').WebhookList;
 var serialize = require('../../../../base/serialize');  /* jshint ignore:line */
 var values = require('../../../../base/values');  /* jshint ignore:line */
 
@@ -53,6 +54,7 @@ ConfigurationList = function ConfigurationList(version, chatServiceSid) {
 
   // Components
   ConfigurationListInstance._notifications = undefined;
+  ConfigurationListInstance._webhooks = undefined;
 
   /* jshint ignore:start */
   /**
@@ -79,6 +81,17 @@ ConfigurationList = function ConfigurationList(version, chatServiceSid) {
       }
   });
 
+  Object.defineProperty(ConfigurationListInstance,
+    'webhooks', {
+      get: function webhooks() {
+        if (!this._webhooks) {
+          this._webhooks = new WebhookList(this._version, this._solution.chatServiceSid);
+        }
+
+        return this._webhooks;
+      }
+  });
+
   /* jshint ignore:start */
   /**
    * Provide a user-friendly representation

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

@@ -59,8 +59,10 @@ interface ConfigurationResource {
   crm_type: string;
   date_created: Date;
   date_updated: Date;
+  flex_insights_drilldown: boolean;
   flex_insights_hr: object;
   flex_service_instance_sid: string;
+  flex_url: string;
   integrations: object[];
   markdown: object;
   messaging_service_instance_sid: string;
@@ -174,8 +176,10 @@ declare class ConfigurationInstance extends SerializableClass {
    * @param callback - Callback to handle processed record
    */
   fetch(opts?: ConfigurationInstanceFetchOptions, callback?: (error: Error | null, items: ConfigurationInstance) => any): Promise<ConfigurationInstance>;
+  flexInsightsDrilldown: boolean;
   flexInsightsHr: any;
   flexServiceInstanceSid: string;
+  flexUrl: string;
   integrations: object[];
   markdown: any;
   messagingServiceInstanceSid: string;

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

@@ -211,6 +211,9 @@ ConfigurationPage.prototype[util.inspect.custom] = function inspect(depth,
  * @property {object} markdown - Configurable parameters for Markdown
  * @property {string} url - The absolute URL of the Configuration resource
  * @property {object} flexInsightsHr - Object that controls workspace reporting
+ * @property {boolean} flexInsightsDrilldown -
+ *          Setting to enable Flex UI redirection
+ * @property {string} flexUrl - URL to redirect to in case drilldown is enabled.
  *
  * @param {V1} version - Version of the resource
  * @param {ConfigurationPayload} payload - The instance payload
@@ -260,6 +263,8 @@ ConfigurationInstance = function ConfigurationInstance(version, payload) {
   this.markdown = payload.markdown; // jshint ignore:line
   this.url = payload.url; // jshint ignore:line
   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
 
   // Context
   this._context = undefined;

package/lib/rest/frontlineApi/v1/user.d.ts

@@ -27,11 +27,13 @@ declare function UserList(version: V1): UserListInstance;
  *
  * @property avatar - The avatar URL which will be shown in Frontline application
  * @property friendlyName - The string that you assigned to describe the User
+ * @property isAvailable - Whether the User is available for new conversations
  * @property state - Current state of this user
  */
 interface UserInstanceUpdateOptions {
   avatar?: string;
   friendlyName?: string;
+  isAvailable?: boolean;
   state?: UserStateType;
 }
 
@@ -59,6 +61,7 @@ interface UserResource {
   avatar: string;
   friendly_name: string;
   identity: string;
+  is_available: boolean;
   sid: string;
   state: UserStateType;
   url: string;
@@ -129,6 +132,7 @@ declare class UserInstance extends SerializableClass {
   fetch(callback?: (error: Error | null, items: UserInstance) => any): Promise<UserInstance>;
   friendlyName: string;
   identity: string;
+  isAvailable: boolean;
   sid: string;
   state: UserStateType;
   /**