Source: rest/flexApi/v1/webChannel.js

  1. 'use strict';
  3. /* jshint ignore:start */
  4. /**
  5.  * This code was generated by
  6.  * \ / _    _  _|   _  _
  7.  *  | (_)\/(_)(_|\/| |(/_  v1.0.0
  8.  *       /       /
  9.  */
  10. /* jshint ignore:end */
  12. var Q = require('q');  /* jshint ignore:line */
  13. var _ = require('lodash');  /* jshint ignore:line */
  14. var util = require('util');  /* jshint ignore:line */
  15. var Page = require('../../../base/Page');  /* jshint ignore:line */
  16. var deserialize = require(
  17.     '../../../base/deserialize');  /* jshint ignore:line */
  18. var values = require('../../../base/values');  /* jshint ignore:line */
  20. var WebChannelList;
  21. var WebChannelPage;
  22. var WebChannelInstance;
  23. var WebChannelContext;
  25. /* jshint ignore:start */
  26. /**
  27.  * Initialize the WebChannelList
  28.  *
  29.  * @constructor Twilio.FlexApi.V1.WebChannelList
  30.  *
  31.  * @param {Twilio.FlexApi.V1} version - Version of the resource
  32.  */
  33. /* jshint ignore:end */
  34. WebChannelList = function WebChannelList(version) {
  35.   /* jshint ignore:start */
  36.   /**
  37.    * @function webChannel
  38.    * @memberof Twilio.FlexApi.V1#
  39.    *
  40.    * @param {string} sid - sid of instance
  41.    *
  42.    * @returns {Twilio.FlexApi.V1.WebChannelContext}
  43.    */
  44.   /* jshint ignore:end */
  45.   function WebChannelListInstance(sid) {
  46.     return WebChannelListInstance.get(sid);
  47.   }
  49.   WebChannelListInstance._version = version;
  50.   // Path Solution
  51.   WebChannelListInstance._solution = {};
  52.   WebChannelListInstance._uri = `/WebChannels`;
  53.   /* jshint ignore:start */
  54.   /**
  55.    * Streams WebChannelInstance records from the API.
  56.    *
  57.    * This operation lazily loads records as efficiently as possible until the limit
  58.    * is reached.
  59.    *
  60.    * The results are passed into the callback function, so this operation is memory
  61.    * efficient.
  62.    *
  63.    * If a function is passed as the first argument, it will be used as the callback
  64.    * function.
  65.    *
  66.    * @function each
  67.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  68.    *
  69.    * @param {object} [opts] - Options for request
  70.    * @param {number} [opts.limit] -
  71.    *         Upper limit for the number of records to return.
  72.    *         each() guarantees never to return more than limit.
  73.    *         Default is no limit
  74.    * @param {number} [opts.pageSize] -
  75.    *         Number of records to fetch per request,
  76.    *         when not set will use the default value of 50 records.
  77.    *         If no pageSize is defined but a limit is defined,
  78.    *         each() will attempt to read the limit with the most efficient
  79.    *         page size, i.e. min(limit, 1000)
  80.    * @param {Function} [opts.callback] -
  81.    *         Function to process each record. If this and a positional
  82.    *         callback are passed, this one will be used
  83.    * @param {Function} [opts.done] -
  84.    *          Function to be called upon completion of streaming
  85.    * @param {Function} [callback] - Function to process each record
  86.    */
  87.   /* jshint ignore:end */
  88.   WebChannelListInstance.each = function each(opts, callback) {
  89.     if (_.isFunction(opts)) {
  90.       callback = opts;
  91.       opts = {};
  92.     }
  93.     opts = opts || {};
  94.     if (opts.callback) {
  95.       callback = opts.callback;
  96.     }
  97.     if (_.isUndefined(callback)) {
  98.       throw new Error('Callback function must be provided');
  99.     }
  101.     var done = false;
  102.     var currentPage = 1;
  103.     var currentResource = 0;
  104.     var limits = this._version.readLimits({
  105.       limit: opts.limit,
  106.       pageSize: opts.pageSize
  107.     });
  109.     function onComplete(error) {
  110.       done = true;
  111.       if (_.isFunction(opts.done)) {
  112.         opts.done(error);
  113.       }
  114.     }
  116.     function fetchNextPage(fn) {
  117.       var promise = fn();
  118.       if (_.isUndefined(promise)) {
  119.         onComplete();
  120.         return;
  121.       }
  123.       promise.then(function(page) {
  124.         _.each(page.instances, function(instance) {
  125.           if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
  126.             done = true;
  127.             return false;
  128.           }
  130.           currentResource++;
  131.           callback(instance, onComplete);
  132.         });
  134.         if (!done) {
  135.           currentPage++;
  136.           fetchNextPage(_.bind(page.nextPage, page));
  137.         }
  138.       });
  140.       promise.catch(onComplete);
  141.     }
  143.     fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
  144.   };
  146.   /* jshint ignore:start */
  147.   /**
  148.    * Lists WebChannelInstance records from the API as a list.
  149.    *
  150.    * If a function is passed as the first argument, it will be used as the callback
  151.    * function.
  152.    *
  153.    * @function list
  154.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  155.    *
  156.    * @param {object} [opts] - Options for request
  157.    * @param {number} [opts.limit] -
  158.    *         Upper limit for the number of records to return.
  159.    *         list() guarantees never to return more than limit.
  160.    *         Default is no limit
  161.    * @param {number} [opts.pageSize] -
  162.    *         Number of records to fetch per request,
  163.    *         when not set will use the default value of 50 records.
  164.    *         If no page_size is defined but a limit is defined,
  165.    *         list() will attempt to read the limit with the most
  166.    *         efficient page size, i.e. min(limit, 1000)
  167.    * @param {function} [callback] - Callback to handle list of records
  168.    *
  169.    * @returns {Promise} Resolves to a list of records
  170.    */
  171.   /* jshint ignore:end */
  172.   WebChannelListInstance.list = function list(opts, callback) {
  173.     if (_.isFunction(opts)) {
  174.       callback = opts;
  175.       opts = {};
  176.     }
  177.     opts = opts || {};
  178.     var deferred = Q.defer();
  179.     var allResources = [];
  180.     opts.callback = function(resource, done) {
  181.       allResources.push(resource);
  183.       if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
  184.         done();
  185.       }
  186.     };
  188.     opts.done = function(error) {
  189.       if (_.isUndefined(error)) {
  190.         deferred.resolve(allResources);
  191.       } else {
  192.         deferred.reject(error);
  193.       }
  194.     };
  196.     if (_.isFunction(callback)) {
  197.       deferred.promise.nodeify(callback);
  198.     }
  200.     this.each(opts);
  201.     return deferred.promise;
  202.   };
  204.   /* jshint ignore:start */
  205.   /**
  206.    * Retrieve a single page of WebChannelInstance records from the API.
  207.    *
  208.    * The request is executed immediately.
  209.    *
  210.    * If a function is passed as the first argument, it will be used as the callback
  211.    * function.
  212.    *
  213.    * @function page
  214.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  215.    *
  216.    * @param {object} [opts] - Options for request
  217.    * @param {string} [opts.pageToken] - PageToken provided by the API
  218.    * @param {number} [opts.pageNumber] -
  219.    *          Page Number, this value is simply for client state
  220.    * @param {number} [opts.pageSize] - Number of records to return, defaults to 50
  221.    * @param {function} [callback] - Callback to handle list of records
  222.    *
  223.    * @returns {Promise} Resolves to a list of records
  224.    */
  225.   /* jshint ignore:end */
  226.   WebChannelListInstance.page = function page(opts, callback) {
  227.     if (_.isFunction(opts)) {
  228.       callback = opts;
  229.       opts = {};
  230.     }
  231.     opts = opts || {};
  233.     var deferred = Q.defer();
  234.     var data = values.of({
  235.       'PageToken': opts.pageToken,
  236.       'Page': opts.pageNumber,
  237.       'PageSize': opts.pageSize
  238.     });
  240.     var promise = this._version.page({uri: this._uri, method: 'GET', params: data});
  242.     promise = promise.then(function(payload) {
  243.       deferred.resolve(new WebChannelPage(this._version, payload, this._solution));
  244.     }.bind(this));
  246.     promise.catch(function(error) {
  247.       deferred.reject(error);
  248.     });
  250.     if (_.isFunction(callback)) {
  251.       deferred.promise.nodeify(callback);
  252.     }
  254.     return deferred.promise;
  255.   };
  257.   /* jshint ignore:start */
  258.   /**
  259.    * Retrieve a single target page of WebChannelInstance records from the API.
  260.    *
  261.    * The request is executed immediately.
  262.    *
  263.    * If a function is passed as the first argument, it will be used as the callback
  264.    * function.
  265.    *
  266.    * @function getPage
  267.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  268.    *
  269.    * @param {string} [targetUrl] - API-generated URL for the requested results page
  270.    * @param {function} [callback] - Callback to handle list of records
  271.    *
  272.    * @returns {Promise} Resolves to a list of records
  273.    */
  274.   /* jshint ignore:end */
  275.   WebChannelListInstance.getPage = function getPage(targetUrl, callback) {
  276.     var deferred = Q.defer();
  278.     var promise = this._version._domain.twilio.request({method: 'GET', uri: targetUrl});
  280.     promise = promise.then(function(payload) {
  281.       deferred.resolve(new WebChannelPage(this._version, payload, this._solution));
  282.     }.bind(this));
  284.     promise.catch(function(error) {
  285.       deferred.reject(error);
  286.     });
  288.     if (_.isFunction(callback)) {
  289.       deferred.promise.nodeify(callback);
  290.     }
  292.     return deferred.promise;
  293.   };
  295.   /* jshint ignore:start */
  296.   /**
  297.    * create a WebChannelInstance
  298.    *
  299.    * @function create
  300.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  301.    *
  302.    * @param {object} opts - Options for request
  303.    * @param {string} opts.flexFlowSid - The SID of the Flex Flow
  304.    * @param {string} opts.identity - The chat identity
  305.    * @param {string} opts.customerFriendlyName - The chat participant's friendly name
  306.    * @param {string} opts.chatFriendlyName - The chat channel's friendly name
  307.    * @param {string} [opts.chatUniqueName] - The chat channel's unique name
  308.    * @param {string} [opts.preEngagementData] - The pre-engagement data
  309.    * @param {function} [callback] - Callback to handle processed record
  310.    *
  311.    * @returns {Promise} Resolves to processed WebChannelInstance
  312.    */
  313.   /* jshint ignore:end */
  314.   WebChannelListInstance.create = function create(opts, callback) {
  315.     if (_.isUndefined(opts)) {
  316.       throw new Error('Required parameter "opts" missing.');
  317.     }
  318.     if (_.isUndefined(opts.flexFlowSid)) {
  319.       throw new Error('Required parameter "opts.flexFlowSid" missing.');
  320.     }
  321.     if (_.isUndefined(opts.identity)) {
  322.       throw new Error('Required parameter "opts.identity" missing.');
  323.     }
  324.     if (_.isUndefined(opts.customerFriendlyName)) {
  325.       throw new Error('Required parameter "opts.customerFriendlyName" missing.');
  326.     }
  327.     if (_.isUndefined(opts.chatFriendlyName)) {
  328.       throw new Error('Required parameter "opts.chatFriendlyName" missing.');
  329.     }
  331.     var deferred = Q.defer();
  332.     var data = values.of({
  333.       'FlexFlowSid': _.get(opts, 'flexFlowSid'),
  334.       'Identity': _.get(opts, 'identity'),
  335.       'CustomerFriendlyName': _.get(opts, 'customerFriendlyName'),
  336.       'ChatFriendlyName': _.get(opts, 'chatFriendlyName'),
  337.       'ChatUniqueName': _.get(opts, 'chatUniqueName'),
  338.       'PreEngagementData': _.get(opts, 'preEngagementData')
  339.     });
  341.     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});
  343.     promise = promise.then(function(payload) {
  344.       deferred.resolve(new WebChannelInstance(this._version, payload, this._solution.sid));
  345.     }.bind(this));
  347.     promise.catch(function(error) {
  348.       deferred.reject(error);
  349.     });
  351.     if (_.isFunction(callback)) {
  352.       deferred.promise.nodeify(callback);
  353.     }
  355.     return deferred.promise;
  356.   };
  358.   /* jshint ignore:start */
  359.   /**
  360.    * Constructs a web_channel
  361.    *
  362.    * @function get
  363.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  364.    *
  365.    * @param {string} sid - The SID of the WebChannel resource to fetch
  366.    *
  367.    * @returns {Twilio.FlexApi.V1.WebChannelContext}
  368.    */
  369.   /* jshint ignore:end */
  370.   WebChannelListInstance.get = function get(sid) {
  371.     return new WebChannelContext(this._version, sid);
  372.   };
  374.   /* jshint ignore:start */
  375.   /**
  376.    * Provide a user-friendly representation
  377.    *
  378.    * @function toJSON
  379.    * @memberof Twilio.FlexApi.V1.WebChannelList#
  380.    *
  381.    * @returns Object
  382.    */
  383.   /* jshint ignore:end */
  384.   WebChannelListInstance.toJSON = function toJSON() {
  385.     return this._solution;
  386.   };
  388.   WebChannelListInstance[util.inspect.custom] = function inspect(depth, options) {
  389.     return util.inspect(this.toJSON(), options);
  390.   };
  392.   return WebChannelListInstance;
  393. };
  396. /* jshint ignore:start */
  397. /**
  398.  * Initialize the WebChannelPage
  399.  *
  400.  * @constructor Twilio.FlexApi.V1.WebChannelPage
  401.  *
  402.  * @param {V1} version - Version of the resource
  403.  * @param {Response<string>} response - Response from the API
  404.  * @param {WebChannelSolution} solution - Path solution
  405.  *
  406.  * @returns WebChannelPage
  407.  */
  408. /* jshint ignore:end */
  409. WebChannelPage = function WebChannelPage(version, response, solution) {
  410.   // Path Solution
  411.   this._solution = solution;
  413.   Page.prototype.constructor.call(this, version, response, this._solution);
  414. };
  416. _.extend(WebChannelPage.prototype, Page.prototype);
  417. WebChannelPage.prototype.constructor = WebChannelPage;
  419. /* jshint ignore:start */
  420. /**
  421.  * Build an instance of WebChannelInstance
  422.  *
  423.  * @function getInstance
  424.  * @memberof Twilio.FlexApi.V1.WebChannelPage#
  425.  *
  426.  * @param {WebChannelPayload} payload - Payload response from the API
  427.  *
  428.  * @returns WebChannelInstance
  429.  */
  430. /* jshint ignore:end */
  431. WebChannelPage.prototype.getInstance = function getInstance(payload) {
  432.   return new WebChannelInstance(this._version, payload);
  433. };
  435. /* jshint ignore:start */
  436. /**
  437.  * Provide a user-friendly representation
  438.  *
  439.  * @function toJSON
  440.  * @memberof Twilio.FlexApi.V1.WebChannelPage#
  441.  *
  442.  * @returns Object
  443.  */
  444. /* jshint ignore:end */
  445. WebChannelPage.prototype.toJSON = function toJSON() {
  446.   let clone = {};
  447.   _.forOwn(this, function(value, key) {
  448.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  449.       clone[key] = value;
  450.     }
  451.   });
  452.   return clone;
  453. };
  455. WebChannelPage.prototype[util.inspect.custom] = function inspect(depth, options)
  456.     {
  457.   return util.inspect(this.toJSON(), options);
  458. };
  461. /* jshint ignore:start */
  462. /**
  463.  * Initialize the WebChannelContext
  464.  *
  465.  * @constructor Twilio.FlexApi.V1.WebChannelInstance
  466.  *
  467.  * @property {string} accountSid -
  468.  *          The SID of the Account that created the resource and owns this Workflow
  469.  * @property {string} flexFlowSid - The SID of the Flex Flow
  470.  * @property {string} sid -
  471.  *          The unique string that identifies the WebChannel resource
  472.  * @property {string} url - The absolute URL of the WebChannel resource
  473.  * @property {Date} dateCreated -
  474.  *          The ISO 8601 date and time in GMT when the resource was created
  475.  * @property {Date} dateUpdated -
  476.  *          The ISO 8601 date and time in GMT when the resource was last updated
  477.  *
  478.  * @param {V1} version - Version of the resource
  479.  * @param {WebChannelPayload} payload - The instance payload
  480.  * @param {sid} sid - The SID of the WebChannel resource to fetch
  481.  */
  482. /* jshint ignore:end */
  483. WebChannelInstance = function WebChannelInstance(version, payload, sid) {
  484.   this._version = version;
  486.   // Marshaled Properties
  487.   this.accountSid = payload.account_sid; // jshint ignore:line
  488.   this.flexFlowSid = payload.flex_flow_sid; // jshint ignore:line
  489.   this.sid = payload.sid; // jshint ignore:line
  490.   this.url = payload.url; // jshint ignore:line
  491.   this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
  492.   this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
  494.   // Context
  495.   this._context = undefined;
  496.   this._solution = {sid: sid || this.sid, };
  497. };
  499. Object.defineProperty(WebChannelInstance.prototype,
  500.   '_proxy', {
  501.     get: function() {
  502.       if (!this._context) {
  503.         this._context = new WebChannelContext(this._version, this._solution.sid);
  504.       }
  506.       return this._context;
  507.     }
  508. });
  510. /* jshint ignore:start */
  511. /**
  512.  * fetch a WebChannelInstance
  513.  *
  514.  * @function fetch
  515.  * @memberof Twilio.FlexApi.V1.WebChannelInstance#
  516.  *
  517.  * @param {function} [callback] - Callback to handle processed record
  518.  *
  519.  * @returns {Promise} Resolves to processed WebChannelInstance
  520.  */
  521. /* jshint ignore:end */
  522. WebChannelInstance.prototype.fetch = function fetch(callback) {
  523.   return this._proxy.fetch(callback);
  524. };
  526. /* jshint ignore:start */
  527. /**
  528.  * update a WebChannelInstance
  529.  *
  530.  * @function update
  531.  * @memberof Twilio.FlexApi.V1.WebChannelInstance#
  532.  *
  533.  * @param {object} [opts] - Options for request
  534.  * @param {web_channel.chat_status} [opts.chatStatus] - The chat status
  535.  * @param {string} [opts.postEngagementData] - The post-engagement data
  536.  * @param {function} [callback] - Callback to handle processed record
  537.  *
  538.  * @returns {Promise} Resolves to processed WebChannelInstance
  539.  */
  540. /* jshint ignore:end */
  541. WebChannelInstance.prototype.update = function update(opts, callback) {
  542.   return this._proxy.update(opts, callback);
  543. };
  545. /* jshint ignore:start */
  546. /**
  547.  * remove a WebChannelInstance
  548.  *
  549.  * @function remove
  550.  * @memberof Twilio.FlexApi.V1.WebChannelInstance#
  551.  *
  552.  * @param {function} [callback] - Callback to handle processed record
  553.  *
  554.  * @returns {Promise} Resolves to processed WebChannelInstance
  555.  */
  556. /* jshint ignore:end */
  557. WebChannelInstance.prototype.remove = function remove(callback) {
  558.   return this._proxy.remove(callback);
  559. };
  561. /* jshint ignore:start */
  562. /**
  563.  * Provide a user-friendly representation
  564.  *
  565.  * @function toJSON
  566.  * @memberof Twilio.FlexApi.V1.WebChannelInstance#
  567.  *
  568.  * @returns Object
  569.  */
  570. /* jshint ignore:end */
  571. WebChannelInstance.prototype.toJSON = function toJSON() {
  572.   let clone = {};
  573.   _.forOwn(this, function(value, key) {
  574.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  575.       clone[key] = value;
  576.     }
  577.   });
  578.   return clone;
  579. };
  581. WebChannelInstance.prototype[util.inspect.custom] = function inspect(depth,
  582.     options) {
  583.   return util.inspect(this.toJSON(), options);
  584. };
  587. /* jshint ignore:start */
  588. /**
  589.  * Initialize the WebChannelContext
  590.  *
  591.  * @constructor Twilio.FlexApi.V1.WebChannelContext
  592.  *
  593.  * @param {V1} version - Version of the resource
  594.  * @param {sid} sid - The SID of the WebChannel resource to fetch
  595.  */
  596. /* jshint ignore:end */
  597. WebChannelContext = function WebChannelContext(version, sid) {
  598.   this._version = version;
  600.   // Path Solution
  601.   this._solution = {sid: sid, };
  602.   this._uri = `/WebChannels/${sid}`;
  603. };
  605. /* jshint ignore:start */
  606. /**
  607.  * fetch a WebChannelInstance
  608.  *
  609.  * @function fetch
  610.  * @memberof Twilio.FlexApi.V1.WebChannelContext#
  611.  *
  612.  * @param {function} [callback] - Callback to handle processed record
  613.  *
  614.  * @returns {Promise} Resolves to processed WebChannelInstance
  615.  */
  616. /* jshint ignore:end */
  617. WebChannelContext.prototype.fetch = function fetch(callback) {
  618.   var deferred = Q.defer();
  619.   var promise = this._version.fetch({uri: this._uri, method: 'GET'});
  621.   promise = promise.then(function(payload) {
  622.     deferred.resolve(new WebChannelInstance(this._version, payload, this._solution.sid));
  623.   }.bind(this));
  625.   promise.catch(function(error) {
  626.     deferred.reject(error);
  627.   });
  629.   if (_.isFunction(callback)) {
  630.     deferred.promise.nodeify(callback);
  631.   }
  633.   return deferred.promise;
  634. };
  636. /* jshint ignore:start */
  637. /**
  638.  * update a WebChannelInstance
  639.  *
  640.  * @function update
  641.  * @memberof Twilio.FlexApi.V1.WebChannelContext#
  642.  *
  643.  * @param {object} [opts] - Options for request
  644.  * @param {web_channel.chat_status} [opts.chatStatus] - The chat status
  645.  * @param {string} [opts.postEngagementData] - The post-engagement data
  646.  * @param {function} [callback] - Callback to handle processed record
  647.  *
  648.  * @returns {Promise} Resolves to processed WebChannelInstance
  649.  */
  650. /* jshint ignore:end */
  651. WebChannelContext.prototype.update = function update(opts, callback) {
  652.   if (_.isFunction(opts)) {
  653.     callback = opts;
  654.     opts = {};
  655.   }
  656.   opts = opts || {};
  658.   var deferred = Q.defer();
  659.   var data = values.of({
  660.     'ChatStatus': _.get(opts, 'chatStatus'),
  661.     'PostEngagementData': _.get(opts, 'postEngagementData')
  662.   });
  664.   var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
  666.   promise = promise.then(function(payload) {
  667.     deferred.resolve(new WebChannelInstance(this._version, payload, this._solution.sid));
  668.   }.bind(this));
  670.   promise.catch(function(error) {
  671.     deferred.reject(error);
  672.   });
  674.   if (_.isFunction(callback)) {
  675.     deferred.promise.nodeify(callback);
  676.   }
  678.   return deferred.promise;
  679. };
  681. /* jshint ignore:start */
  682. /**
  683.  * remove a WebChannelInstance
  684.  *
  685.  * @function remove
  686.  * @memberof Twilio.FlexApi.V1.WebChannelContext#
  687.  *
  688.  * @param {function} [callback] - Callback to handle processed record
  689.  *
  690.  * @returns {Promise} Resolves to processed WebChannelInstance
  691.  */
  692. /* jshint ignore:end */
  693. WebChannelContext.prototype.remove = function remove(callback) {
  694.   var deferred = Q.defer();
  695.   var promise = this._version.remove({uri: this._uri, method: 'DELETE'});
  697.   promise = promise.then(function(payload) {
  698.     deferred.resolve(payload);
  699.   }.bind(this));
  701.   promise.catch(function(error) {
  702.     deferred.reject(error);
  703.   });
  705.   if (_.isFunction(callback)) {
  706.     deferred.promise.nodeify(callback);
  707.   }
  709.   return deferred.promise;
  710. };
  712. /* jshint ignore:start */
  713. /**
  714.  * Provide a user-friendly representation
  715.  *
  716.  * @function toJSON
  717.  * @memberof Twilio.FlexApi.V1.WebChannelContext#
  718.  *
  719.  * @returns Object
  720.  */
  721. /* jshint ignore:end */
  722. WebChannelContext.prototype.toJSON = function toJSON() {
  723.   return this._solution;
  724. };
  726. WebChannelContext.prototype[util.inspect.custom] = function inspect(depth,
  727.     options) {
  728.   return util.inspect(this.toJSON(), options);
  729. };
  731. module.exports = {
  732.   WebChannelList: WebChannelList,
  733.   WebChannelPage: WebChannelPage,
  734.   WebChannelInstance: WebChannelInstance,
  735.   WebChannelContext: WebChannelContext
  736. };