twilio 3.74.0 → 3.76.0

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

@@ -0,0 +1,152 @@
+/**
+ * This code was generated by
+ * \ / _    _  _|   _  _
+ *  | (_)\/(_)(_|\/| |(/_  v1.0.0
+ *       /       /
+ */
+
+import Page = require('../../../base/Page');
+import Response = require('../../../http/response');
+import V1 = require('../V1');
+import { InteractionChannelList } from './interaction/interactionChannel';
+import { InteractionChannelListInstance } from './interaction/interactionChannel';
+import { SerializableClass } from '../../../interfaces';
+
+type InteractionStatus = 'close'|'closed'|'wrapup';
+
+/**
+ * Initialize the InteractionList
+ *
+ * @param version - Version of the resource
+ */
+declare function InteractionList(version: V1): InteractionListInstance;
+
+interface InteractionListInstance {
+  /**
+   * @param sid - sid of instance
+   */
+  (sid: string): InteractionContext;
+  /**
+   * create a InteractionInstance
+   *
+   * @param opts - Options for request
+   * @param callback - Callback to handle processed record
+   */
+  create(opts: InteractionListInstanceCreateOptions, callback?: (error: Error | null, item: InteractionInstance) => any): Promise<InteractionInstance>;
+  /**
+   * Constructs a interaction
+   *
+   * @param sid - The SID that identifies the resource to fetch
+   */
+  get(sid: string): InteractionContext;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+/**
+ * Options to pass to create
+ *
+ * @property channel - The Interaction's channel
+ * @property routing - The Interaction's routing logic
+ */
+interface InteractionListInstanceCreateOptions {
+  channel: object;
+  routing: object;
+}
+
+interface InteractionPayload extends InteractionResource, Page.TwilioResponsePayload {
+}
+
+interface InteractionResource {
+  channel: object;
+  links: string;
+  routing: object;
+  sid: string;
+  url: string;
+}
+
+interface InteractionSolution {
+}
+
+
+declare class InteractionContext {
+  /**
+   * Initialize the InteractionContext
+   *
+   * @param version - Version of the resource
+   * @param sid - The SID that identifies the resource to fetch
+   */
+  constructor(version: V1, sid: string);
+
+  channels: InteractionChannelListInstance;
+  /**
+   * fetch a InteractionInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: InteractionInstance) => any): Promise<InteractionInstance>;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+
+declare class InteractionInstance extends SerializableClass {
+  /**
+   * Initialize the InteractionContext
+   *
+   * @param version - Version of the resource
+   * @param payload - The instance payload
+   * @param sid - The SID that identifies the resource to fetch
+   */
+  constructor(version: V1, payload: InteractionPayload, sid: string);
+
+  private _proxy: InteractionContext;
+  channel: any;
+  /**
+   * Access the channels
+   */
+  channels(): InteractionChannelListInstance;
+  /**
+   * fetch a InteractionInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  fetch(callback?: (error: Error | null, items: InteractionInstance) => any): Promise<InteractionInstance>;
+  links: string;
+  routing: any;
+  sid: string;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+  url: string;
+}
+
+
+declare class InteractionPage extends Page<V1, InteractionPayload, InteractionResource, InteractionInstance> {
+  /**
+   * Initialize the InteractionPage
+   *
+   * @param version - Version of the resource
+   * @param response - Response from the API
+   * @param solution - Path solution
+   */
+  constructor(version: V1, response: Response<string>, solution: InteractionSolution);
+
+  /**
+   * Build an instance of InteractionInstance
+   *
+   * @param payload - Payload response from the API
+   */
+  getInstance(payload: InteractionPayload): InteractionInstance;
+  /**
+   * Provide a user-friendly representation
+   */
+  toJSON(): any;
+}
+
+export { InteractionContext, InteractionInstance, InteractionList, InteractionListInstance, InteractionListInstanceCreateOptions, InteractionPage, InteractionPayload, InteractionResource, InteractionSolution, InteractionStatus }

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

@@ -0,0 +1,395 @@
+'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 InteractionChannelList = require(
+    './interaction/interactionChannel').InteractionChannelList;
+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 InteractionList;
+var InteractionPage;
+var InteractionInstance;
+var InteractionContext;
+
+/* jshint ignore:start */
+/**
+ * Initialize the InteractionList
+ *
+ * @constructor Twilio.FlexApi.V1.InteractionList
+ *
+ * @param {Twilio.FlexApi.V1} version - Version of the resource
+ */
+/* jshint ignore:end */
+InteractionList = function InteractionList(version) {
+  /* jshint ignore:start */
+  /**
+   * @function interaction
+   * @memberof Twilio.FlexApi.V1#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.FlexApi.V1.InteractionContext}
+   */
+  /* jshint ignore:end */
+  function InteractionListInstance(sid) {
+    return InteractionListInstance.get(sid);
+  }
+
+  InteractionListInstance._version = version;
+  // Path Solution
+  InteractionListInstance._solution = {};
+  InteractionListInstance._uri = `/Interactions`;
+  /* jshint ignore:start */
+  /**
+   * create a InteractionInstance
+   *
+   * @function create
+   * @memberof Twilio.FlexApi.V1.InteractionList#
+   *
+   * @param {object} opts - Options for request
+   * @param {object} opts.channel - The Interaction's channel
+   * @param {object} opts.routing - The Interaction's routing logic
+   * @param {function} [callback] - Callback to handle processed record
+   *
+   * @returns {Promise} Resolves to processed InteractionInstance
+   */
+  /* jshint ignore:end */
+  InteractionListInstance.create = function create(opts, callback) {
+    if (_.isUndefined(opts)) {
+      throw new Error('Required parameter "opts" missing.');
+    }
+    if (_.isUndefined(opts['channel'])) {
+      throw new Error('Required parameter "opts[\'channel\']" missing.');
+    }
+    if (_.isUndefined(opts['routing'])) {
+      throw new Error('Required parameter "opts[\'routing\']" missing.');
+    }
+
+    var deferred = Q.defer();
+    var data = values.of({
+      'Channel': serialize.object(_.get(opts, 'channel')),
+      'Routing': serialize.object(_.get(opts, 'routing'))
+    });
+
+    var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
+
+    promise = promise.then(function(payload) {
+      deferred.resolve(new InteractionInstance(this._version, payload, 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 */
+  /**
+   * Constructs a interaction
+   *
+   * @function get
+   * @memberof Twilio.FlexApi.V1.InteractionList#
+   *
+   * @param {string} sid - The SID that identifies the resource to fetch
+   *
+   * @returns {Twilio.FlexApi.V1.InteractionContext}
+   */
+  /* jshint ignore:end */
+  InteractionListInstance.get = function get(sid) {
+    return new InteractionContext(this._version, sid);
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Provide a user-friendly representation
+   *
+   * @function toJSON
+   * @memberof Twilio.FlexApi.V1.InteractionList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  InteractionListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  InteractionListInstance[util.inspect.custom] = function inspect(depth, options)
+      {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return InteractionListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the InteractionPage
+ *
+ * @constructor Twilio.FlexApi.V1.InteractionPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {InteractionSolution} solution - Path solution
+ *
+ * @returns InteractionPage
+ */
+/* jshint ignore:end */
+InteractionPage = function InteractionPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(InteractionPage.prototype, Page.prototype);
+InteractionPage.prototype.constructor = InteractionPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of InteractionInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.FlexApi.V1.InteractionPage#
+ *
+ * @param {InteractionPayload} payload - Payload response from the API
+ *
+ * @returns InteractionInstance
+ */
+/* jshint ignore:end */
+InteractionPage.prototype.getInstance = function getInstance(payload) {
+  return new InteractionInstance(this._version, payload);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V1.InteractionPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+InteractionPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+InteractionPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the InteractionContext
+ *
+ * @constructor Twilio.FlexApi.V1.InteractionInstance
+ *
+ * @property {string} sid - The unique string that identifies the resource
+ * @property {object} channel - The Interaction's channel
+ * @property {object} routing - The Interaction's routing logic
+ * @property {string} url - The url
+ * @property {string} links - The links
+ *
+ * @param {V1} version - Version of the resource
+ * @param {InteractionPayload} payload - The instance payload
+ * @param {sid} sid - The SID that identifies the resource to fetch
+ */
+/* jshint ignore:end */
+InteractionInstance = function InteractionInstance(version, payload, sid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.sid = payload.sid; // jshint ignore:line
+  this.channel = payload.channel; // jshint ignore:line
+  this.routing = payload.routing; // jshint ignore:line
+  this.url = payload.url; // jshint ignore:line
+  this.links = payload.links; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {sid: sid || this.sid, };
+};
+
+Object.defineProperty(InteractionInstance.prototype,
+  '_proxy', {
+    get: function() {
+      if (!this._context) {
+        this._context = new InteractionContext(this._version, this._solution.sid);
+      }
+
+      return this._context;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * fetch a InteractionInstance
+ *
+ * @function fetch
+ * @memberof Twilio.FlexApi.V1.InteractionInstance#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed InteractionInstance
+ */
+/* jshint ignore:end */
+InteractionInstance.prototype.fetch = function fetch(callback) {
+  return this._proxy.fetch(callback);
+};
+
+/* jshint ignore:start */
+/**
+ * Access the channels
+ *
+ * @function channels
+ * @memberof Twilio.FlexApi.V1.InteractionInstance#
+ *
+ * @returns {Twilio.FlexApi.V1.InteractionContext.InteractionChannelList}
+ */
+/* jshint ignore:end */
+InteractionInstance.prototype.channels = function channels() {
+  return this._proxy.channels;
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V1.InteractionInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+InteractionInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+InteractionInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the InteractionContext
+ *
+ * @constructor Twilio.FlexApi.V1.InteractionContext
+ *
+ * @property {Twilio.FlexApi.V1.InteractionContext.InteractionChannelList} channels -
+ *          channels resource
+ *
+ * @param {V1} version - Version of the resource
+ * @param {sid} sid - The SID that identifies the resource to fetch
+ */
+/* jshint ignore:end */
+InteractionContext = function InteractionContext(version, sid) {
+  this._version = version;
+
+  // Path Solution
+  this._solution = {sid: sid, };
+  this._uri = `/Interactions/${sid}`;
+
+  // Dependents
+  this._channels = undefined;
+};
+
+/* jshint ignore:start */
+/**
+ * fetch a InteractionInstance
+ *
+ * @function fetch
+ * @memberof Twilio.FlexApi.V1.InteractionContext#
+ *
+ * @param {function} [callback] - Callback to handle processed record
+ *
+ * @returns {Promise} Resolves to processed InteractionInstance
+ */
+/* jshint ignore:end */
+InteractionContext.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 InteractionInstance(this._version, payload, this._solution.sid));
+  }.bind(this));
+
+  promise.catch(function(error) {
+    deferred.reject(error);
+  });
+
+  if (_.isFunction(callback)) {
+    deferred.promise.nodeify(callback);
+  }
+
+  return deferred.promise;
+};
+
+Object.defineProperty(InteractionContext.prototype,
+  'channels', {
+    get: function() {
+      if (!this._channels) {
+        this._channels = new InteractionChannelList(this._version, this._solution.sid);
+      }
+      return this._channels;
+    }
+});
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.FlexApi.V1.InteractionContext#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+InteractionContext.prototype.toJSON = function toJSON() {
+  return this._solution;
+};
+
+InteractionContext.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  InteractionList: InteractionList,
+  InteractionPage: InteractionPage,
+  InteractionInstance: InteractionInstance,
+  InteractionContext: InteractionContext
+};

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

@@ -7,6 +7,8 @@
 
 import Insights = require('../Insights');
 import Version = require('../../base/Version');
+import { AnnotationList } from './v1/annotation';
+import { AnnotationListInstance } from './v1/annotation';
 import { CallList } from './v1/call';
 import { CallListInstance } from './v1/call';
 import { CallSummariesList } from './v1/callSummaries';
@@ -27,6 +29,7 @@ declare class V1 extends Version {
    */
   constructor(domain: Insights);
 
+  readonly annotation: AnnotationListInstance;
   readonly callSummaries: CallSummariesListInstance;
   readonly calls: CallListInstance;
   readonly conferences: ConferenceListInstance;

package/lib/rest/insights/V1.js

@@ -10,6 +10,7 @@
 /* jshint ignore:end */
 
 var _ = require('lodash');  /* jshint ignore:line */
+var AnnotationList = require('./v1/annotation').AnnotationList;
 var CallList = require('./v1/call').CallList;
 var CallSummariesList = require('./v1/callSummaries').CallSummariesList;
 var ConferenceList = require('./v1/conference').ConferenceList;
@@ -25,6 +26,7 @@ var Version = require('../../base/Version');  /* jshint ignore:line */
  * @constructor Twilio.Insights.V1
  *
  * @property {Twilio.Insights.V1.SettingList} settings - settings resource
+ * @property {Twilio.Insights.V1.AnnotationList} annotation - annotation resource
  * @property {Twilio.Insights.V1.CallList} calls - calls resource
  * @property {Twilio.Insights.V1.CallSummariesList} callSummaries -
  *          callSummaries resource
@@ -39,6 +41,7 @@ function V1(domain) {
 
   // Resources
   this._settings = undefined;
+  this._annotation = undefined;
   this._calls = undefined;
   this._callSummaries = undefined;
   this._conferences = undefined;
@@ -56,6 +59,14 @@ Object.defineProperty(V1.prototype,
     }
 });
 
+Object.defineProperty(V1.prototype,
+  'annotation', {
+    get: function() {
+      this._annotation = this._annotation || new AnnotationList(this);
+      return this._annotation;
+    }
+});
+
 Object.defineProperty(V1.prototype,
   'calls', {
     get: function() {