Source: rest/conversations/v1/configuration.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 WebhookList = require('./configuration/webhook').WebhookList;
  17. var values = require('../../../base/values');  /* jshint ignore:line */
  19. var ConfigurationList;
  20. var ConfigurationPage;
  21. var ConfigurationInstance;
  22. var ConfigurationContext;
  24. /* jshint ignore:start */
  25. /**
  26.  * Initialize the ConfigurationList
  27.  *
  28.  * @constructor Twilio.Conversations.V1.ConfigurationList
  29.  *
  30.  * @param {Twilio.Conversations.V1} version - Version of the resource
  31.  */
  32. /* jshint ignore:end */
  33. ConfigurationList = function ConfigurationList(version) {
  34.   /* jshint ignore:start */
  35.   /**
  36.    * @function configuration
  37.    * @memberof Twilio.Conversations.V1#
  38.    *
  39.    * @param {string} sid - sid of instance
  40.    *
  41.    * @returns {Twilio.Conversations.V1.ConfigurationContext}
  42.    */
  43.   /* jshint ignore:end */
  44.   function ConfigurationListInstance(sid) {
  45.     return ConfigurationListInstance.get(sid);
  46.   }
  48.   ConfigurationListInstance._version = version;
  49.   // Path Solution
  50.   ConfigurationListInstance._solution = {};
  52.   // Components
  53.   ConfigurationListInstance._webhooks = undefined;
  55.   /* jshint ignore:start */
  56.   /**
  57.    * Constructs a configuration
  58.    *
  59.    * @function get
  60.    * @memberof Twilio.Conversations.V1.ConfigurationList#
  61.    *
  62.    * @returns {Twilio.Conversations.V1.ConfigurationContext}
  63.    */
  64.   /* jshint ignore:end */
  65.   ConfigurationListInstance.get = function get() {
  66.     return new ConfigurationContext(this._version);
  67.   };
  69.   Object.defineProperty(ConfigurationListInstance,
  70.     'webhooks', {
  71.       get: function webhooks() {
  72.         if (!this._webhooks) {
  73.           this._webhooks = new WebhookList(this._version);
  74.         }
  76.         return this._webhooks;
  77.       }
  78.   });
  80.   /* jshint ignore:start */
  81.   /**
  82.    * Provide a user-friendly representation
  83.    *
  84.    * @function toJSON
  85.    * @memberof Twilio.Conversations.V1.ConfigurationList#
  86.    *
  87.    * @returns Object
  88.    */
  89.   /* jshint ignore:end */
  90.   ConfigurationListInstance.toJSON = function toJSON() {
  91.     return this._solution;
  92.   };
  94.   ConfigurationListInstance[util.inspect.custom] = function inspect(depth,
  95.       options) {
  96.     return util.inspect(this.toJSON(), options);
  97.   };
  99.   return ConfigurationListInstance;
  100. };
  103. /* jshint ignore:start */
  104. /**
  105.  * Initialize the ConfigurationPage
  106.  *
  107.  * @constructor Twilio.Conversations.V1.ConfigurationPage
  108.  *
  109.  * @param {V1} version - Version of the resource
  110.  * @param {Response<string>} response - Response from the API
  111.  * @param {ConfigurationSolution} solution - Path solution
  112.  *
  113.  * @returns ConfigurationPage
  114.  */
  115. /* jshint ignore:end */
  116. ConfigurationPage = function ConfigurationPage(version, response, solution) {
  117.   // Path Solution
  118.   this._solution = solution;
  120.   Page.prototype.constructor.call(this, version, response, this._solution);
  121. };
  123. _.extend(ConfigurationPage.prototype, Page.prototype);
  124. ConfigurationPage.prototype.constructor = ConfigurationPage;
  126. /* jshint ignore:start */
  127. /**
  128.  * Build an instance of ConfigurationInstance
  129.  *
  130.  * @function getInstance
  131.  * @memberof Twilio.Conversations.V1.ConfigurationPage#
  132.  *
  133.  * @param {ConfigurationPayload} payload - Payload response from the API
  134.  *
  135.  * @returns ConfigurationInstance
  136.  */
  137. /* jshint ignore:end */
  138. ConfigurationPage.prototype.getInstance = function getInstance(payload) {
  139.   return new ConfigurationInstance(this._version, payload);
  140. };
  142. /* jshint ignore:start */
  143. /**
  144.  * Provide a user-friendly representation
  145.  *
  146.  * @function toJSON
  147.  * @memberof Twilio.Conversations.V1.ConfigurationPage#
  148.  *
  149.  * @returns Object
  150.  */
  151. /* jshint ignore:end */
  152. ConfigurationPage.prototype.toJSON = function toJSON() {
  153.   let clone = {};
  154.   _.forOwn(this, function(value, key) {
  155.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  156.       clone[key] = value;
  157.     }
  158.   });
  159.   return clone;
  160. };
  162. ConfigurationPage.prototype[util.inspect.custom] = function inspect(depth,
  163.     options) {
  164.   return util.inspect(this.toJSON(), options);
  165. };
  168. /* jshint ignore:start */
  169. /**
  170.  * Initialize the ConfigurationContext
  171.  *
  172.  * @constructor Twilio.Conversations.V1.ConfigurationInstance
  173.  *
  174.  * @property {string} accountSid -
  175.  *          The SID of the Account responsible for this configuration.
  176.  * @property {string} defaultChatServiceSid -
  177.  *          The SID of the default Conversation Service that every new conversation is associated with.
  178.  * @property {string} defaultMessagingServiceSid -
  179.  *          The SID of the default Messaging Service that every new conversation is associated with.
  180.  * @property {string} defaultInactiveTimer -
  181.  *          Default ISO8601 duration when conversation will be switched to `inactive` state.
  182.  * @property {string} defaultClosedTimer -
  183.  *          Default ISO8601 duration when conversation will be switched to `closed` state.
  184.  * @property {string} url - An absolute URL for this global configuration.
  185.  * @property {string} links -
  186.  *          Absolute URLs to access the webhook and default service configurations.
  187.  *
  188.  * @param {V1} version - Version of the resource
  189.  * @param {ConfigurationPayload} payload - The instance payload
  190.  */
  191. /* jshint ignore:end */
  192. ConfigurationInstance = function ConfigurationInstance(version, payload) {
  193.   this._version = version;
  195.   // Marshaled Properties
  196.   this.accountSid = payload.account_sid; // jshint ignore:line
  197.   this.defaultChatServiceSid = payload.default_chat_service_sid; // jshint ignore:line
  198.   this.defaultMessagingServiceSid = payload.default_messaging_service_sid; // jshint ignore:line
  199.   this.defaultInactiveTimer = payload.default_inactive_timer; // jshint ignore:line
  200.   this.defaultClosedTimer = payload.default_closed_timer; // jshint ignore:line
  201.   this.url = payload.url; // jshint ignore:line
  202.   this.links = payload.links; // jshint ignore:line
  204.   // Context
  205.   this._context = undefined;
  206.   this._solution = {};
  207. };
  209. Object.defineProperty(ConfigurationInstance.prototype,
  210.   '_proxy', {
  211.     get: function() {
  212.       if (!this._context) {
  213.         this._context = new ConfigurationContext(this._version);
  214.       }
  216.       return this._context;
  217.     }
  218. });
  220. /* jshint ignore:start */
  221. /**
  222.  * fetch a ConfigurationInstance
  223.  *
  224.  * @function fetch
  225.  * @memberof Twilio.Conversations.V1.ConfigurationInstance#
  226.  *
  227.  * @param {function} [callback] - Callback to handle processed record
  228.  *
  229.  * @returns {Promise} Resolves to processed ConfigurationInstance
  230.  */
  231. /* jshint ignore:end */
  232. ConfigurationInstance.prototype.fetch = function fetch(callback) {
  233.   return this._proxy.fetch(callback);
  234. };
  236. /* jshint ignore:start */
  237. /**
  238.  * update a ConfigurationInstance
  239.  *
  240.  * @function update
  241.  * @memberof Twilio.Conversations.V1.ConfigurationInstance#
  242.  *
  243.  * @param {object} [opts] - Options for request
  244.  * @param {string} [opts.defaultChatServiceSid] -
  245.  *          The SID of the default Conversation Service that every new conversation will be associated with.
  246.  * @param {string} [opts.defaultMessagingServiceSid] -
  247.  *          The SID of the default Messaging Service that every new conversation will be associated with.
  248.  * @param {string} [opts.defaultInactiveTimer] -
  249.  *          Default ISO8601 duration when conversation will be switched to `inactive` state.
  250.  * @param {string} [opts.defaultClosedTimer] -
  251.  *          Default ISO8601 duration when conversation will be switched to `closed` state.
  252.  * @param {function} [callback] - Callback to handle processed record
  253.  *
  254.  * @returns {Promise} Resolves to processed ConfigurationInstance
  255.  */
  256. /* jshint ignore:end */
  257. ConfigurationInstance.prototype.update = function update(opts, callback) {
  258.   return this._proxy.update(opts, callback);
  259. };
  261. /* jshint ignore:start */
  262. /**
  263.  * Provide a user-friendly representation
  264.  *
  265.  * @function toJSON
  266.  * @memberof Twilio.Conversations.V1.ConfigurationInstance#
  267.  *
  268.  * @returns Object
  269.  */
  270. /* jshint ignore:end */
  271. ConfigurationInstance.prototype.toJSON = function toJSON() {
  272.   let clone = {};
  273.   _.forOwn(this, function(value, key) {
  274.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  275.       clone[key] = value;
  276.     }
  277.   });
  278.   return clone;
  279. };
  281. ConfigurationInstance.prototype[util.inspect.custom] = function inspect(depth,
  282.     options) {
  283.   return util.inspect(this.toJSON(), options);
  284. };
  287. /* jshint ignore:start */
  288. /**
  289.  * Initialize the ConfigurationContext
  290.  *
  291.  * @constructor Twilio.Conversations.V1.ConfigurationContext
  292.  *
  293.  * @param {V1} version - Version of the resource
  294.  */
  295. /* jshint ignore:end */
  296. ConfigurationContext = function ConfigurationContext(version) {
  297.   this._version = version;
  299.   // Path Solution
  300.   this._solution = {};
  301.   this._uri = `/Configuration`;
  302. };
  304. /* jshint ignore:start */
  305. /**
  306.  * fetch a ConfigurationInstance
  307.  *
  308.  * @function fetch
  309.  * @memberof Twilio.Conversations.V1.ConfigurationContext#
  310.  *
  311.  * @param {function} [callback] - Callback to handle processed record
  312.  *
  313.  * @returns {Promise} Resolves to processed ConfigurationInstance
  314.  */
  315. /* jshint ignore:end */
  316. ConfigurationContext.prototype.fetch = function fetch(callback) {
  317.   var deferred = Q.defer();
  318.   var promise = this._version.fetch({uri: this._uri, method: 'GET'});
  320.   promise = promise.then(function(payload) {
  321.     deferred.resolve(new ConfigurationInstance(this._version, payload));
  322.   }.bind(this));
  324.   promise.catch(function(error) {
  325.     deferred.reject(error);
  326.   });
  328.   if (_.isFunction(callback)) {
  329.     deferred.promise.nodeify(callback);
  330.   }
  332.   return deferred.promise;
  333. };
  335. /* jshint ignore:start */
  336. /**
  337.  * update a ConfigurationInstance
  338.  *
  339.  * @function update
  340.  * @memberof Twilio.Conversations.V1.ConfigurationContext#
  341.  *
  342.  * @param {object} [opts] - Options for request
  343.  * @param {string} [opts.defaultChatServiceSid] -
  344.  *          The SID of the default Conversation Service that every new conversation will be associated with.
  345.  * @param {string} [opts.defaultMessagingServiceSid] -
  346.  *          The SID of the default Messaging Service that every new conversation will be associated with.
  347.  * @param {string} [opts.defaultInactiveTimer] -
  348.  *          Default ISO8601 duration when conversation will be switched to `inactive` state.
  349.  * @param {string} [opts.defaultClosedTimer] -
  350.  *          Default ISO8601 duration when conversation will be switched to `closed` state.
  351.  * @param {function} [callback] - Callback to handle processed record
  352.  *
  353.  * @returns {Promise} Resolves to processed ConfigurationInstance
  354.  */
  355. /* jshint ignore:end */
  356. ConfigurationContext.prototype.update = function update(opts, callback) {
  357.   if (_.isFunction(opts)) {
  358.     callback = opts;
  359.     opts = {};
  360.   }
  361.   opts = opts || {};
  363.   var deferred = Q.defer();
  364.   var data = values.of({
  365.     'DefaultChatServiceSid': _.get(opts, 'defaultChatServiceSid'),
  366.     'DefaultMessagingServiceSid': _.get(opts, 'defaultMessagingServiceSid'),
  367.     'DefaultInactiveTimer': _.get(opts, 'defaultInactiveTimer'),
  368.     'DefaultClosedTimer': _.get(opts, 'defaultClosedTimer')
  369.   });
  371.   var promise = this._version.update({uri: this._uri, method: 'POST', data: data});
  373.   promise = promise.then(function(payload) {
  374.     deferred.resolve(new ConfigurationInstance(this._version, payload));
  375.   }.bind(this));
  377.   promise.catch(function(error) {
  378.     deferred.reject(error);
  379.   });
  381.   if (_.isFunction(callback)) {
  382.     deferred.promise.nodeify(callback);
  383.   }
  385.   return deferred.promise;
  386. };
  388. /* jshint ignore:start */
  389. /**
  390.  * Provide a user-friendly representation
  391.  *
  392.  * @function toJSON
  393.  * @memberof Twilio.Conversations.V1.ConfigurationContext#
  394.  *
  395.  * @returns Object
  396.  */
  397. /* jshint ignore:end */
  398. ConfigurationContext.prototype.toJSON = function toJSON() {
  399.   return this._solution;
  400. };
  402. ConfigurationContext.prototype[util.inspect.custom] = function inspect(depth,
  403.     options) {
  404.   return util.inspect(this.toJSON(), options);
  405. };
  407. module.exports = {
  408.   ConfigurationList: ConfigurationList,
  409.   ConfigurationPage: ConfigurationPage,
  410.   ConfigurationInstance: ConfigurationInstance,
  411.   ConfigurationContext: ConfigurationContext
  412. };