twilio 4.6.0 → 4.7.0

package/lib/rest/preview/marketplace/availableAddOn.js

@@ -1,548 +1,196 @@
-'use strict';
-
-/* jshint ignore:start */
-/**
+"use strict";
+/*
  * 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 AvailableAddOnExtensionList = require(
-    './availableAddOn/availableAddOnExtension').AvailableAddOnExtensionList;
-var Page = require('../../../base/Page');  /* jshint ignore:line */
-var values = require('../../../base/values');  /* jshint ignore:line */
-
-var AvailableAddOnList;
-var AvailableAddOnPage;
-var AvailableAddOnInstance;
-var AvailableAddOnContext;
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Preview.Marketplace.AvailableAddOnList
- * @description Initialize the AvailableAddOnList
- * PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
+ * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ *
+ * Twilio - Preview
+ * This is the public Twilio REST API.
  *
- * @param {Twilio.Preview.Marketplace} version - Version of the resource
+ * NOTE: This class is auto generated by OpenAPI Generator.
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
  */
-/* jshint ignore:end */
-AvailableAddOnList = function AvailableAddOnList(version) {
-  /* jshint ignore:start */
-  /**
-   * @function availableAddOns
-   * @memberof Twilio.Preview.Marketplace
-   * @instance
-   *
-   * @param {string} sid - sid of instance
-   *
-   * @returns {Twilio.Preview.Marketplace.AvailableAddOnContext}
-   */
-  /* jshint ignore:end */
-  function AvailableAddOnListInstance(sid) {
-    return AvailableAddOnListInstance.get(sid);
-  }
-
-  AvailableAddOnListInstance._version = version;
-  // Path Solution
-  AvailableAddOnListInstance._solution = {};
-  AvailableAddOnListInstance._uri = _.template(
-    '/AvailableAddOns' // jshint ignore:line
-  )(AvailableAddOnListInstance._solution);
-  /* jshint ignore:start */
-  /**
-   * Streams AvailableAddOnInstance records from the API.
-   *
-   * This operation lazily loads records as efficiently as possible until the limit
-   * is reached.
-   *
-   * The results are passed into the callback function, so this operation is memory efficient.
-   *
-   * If a function is passed as the first argument, it will be used as the callback function.
-   *
-   * @function each
-   * @memberof Twilio.Preview.Marketplace.AvailableAddOnList
-   * @instance
-   *
-   * @param {object|function} opts - ...
-   * @param {number} [opts.limit] -
-   *         Upper limit for the number of records to return.
-   *         each() guarantees never to return more than limit.
-   *         Default is no limit
-   * @param {number} [opts.pageSize=50] -
-   *         Number of records to fetch per request,
-   *         when not set will use the default value of 50 records.
-   *         If no pageSize is defined but a limit is defined,
-   *         each() will attempt to read the limit with the most efficient
-   *         page size, i.e. min(limit, 1000)
-   * @param {Function} [opts.callback] -
-   *         Function to process each record. If this and a positional
-   * callback are passed, this one will be used
-   * @param {Function} [opts.done] -
-   *          Function to be called upon completion of streaming
-   * @param {Function} [callback] - Function to process each record
-   */
-  /* jshint ignore:end */
-  AvailableAddOnListInstance.each = function each(opts, callback) {
-    opts = opts || {};
-    if (_.isFunction(opts)) {
-      opts = { callback: opts };
-    } else if (_.isFunction(callback) && !_.isFunction(opts.callback)) {
-      opts.callback = callback;
-    }
-
-    if (_.isUndefined(opts.callback)) {
-      throw new Error('Callback function must be provided');
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AvailableAddOnPage = exports.AvailableAddOnListInstance = exports.AvailableAddOnInstance = exports.AvailableAddOnContextImpl = void 0;
+const util_1 = require("util");
+const Page_1 = __importDefault(require("../../../base/Page"));
+const deserialize = require("../../../base/deserialize");
+const serialize = require("../../../base/serialize");
+const utility_1 = require("../../../base/utility");
+const availableAddOnExtension_1 = require("./availableAddOn/availableAddOnExtension");
+class AvailableAddOnContextImpl {
+    constructor(_version, sid) {
+        this._version = _version;
+        if (!(0, utility_1.isValidPathParam)(sid)) {
+            throw new Error("Parameter 'sid' is not valid.");
+        }
+        this._solution = { sid };
+        this._uri = `/AvailableAddOns/${sid}`;
     }
-
-    var done = false;
-    var currentPage = 1;
-    var currentResource = 0;
-    var limits = this._version.readLimits({
-      limit: opts.limit,
-      pageSize: opts.pageSize
-    });
-
-    function onComplete(error) {
-      done = true;
-      if (_.isFunction(opts.done)) {
-        opts.done(error);
-      }
+    get extensions() {
+        this._extensions =
+            this._extensions ||
+                (0, availableAddOnExtension_1.AvailableAddOnExtensionListInstance)(this._version, this._solution.sid);
+        return this._extensions;
     }
-
-    function fetchNextPage(fn) {
-      var promise = fn();
-      if (_.isUndefined(promise)) {
-        onComplete();
-        return;
-      }
-
-      promise.then(function(page) {
-        _.each(page.instances, function(instance) {
-          if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
-            done = true;
-            return false;
-          }
-
-          currentResource++;
-          opts.callback(instance, onComplete);
+    fetch(callback) {
+        const instance = this;
+        let operationVersion = instance._version, operationPromise = operationVersion.fetch({
+            uri: instance._uri,
+            method: "get",
         });
-
-        if ((limits.pageLimit && limits.pageLimit <= currentPage)) {
-          onComplete();
-        } else if (!done) {
-          currentPage++;
-          fetchNextPage(_.bind(page.nextPage, page));
-        }
-      });
-
-      promise.catch(onComplete);
+        operationPromise = operationPromise.then((payload) => new AvailableAddOnInstance(operationVersion, payload, instance._solution.sid));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
     }
-
-    fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
-  };
-
-  /* jshint ignore:start */
-  /**
-   * @description Lists AvailableAddOnInstance records from the API as a list.
-   *
-   * If a function is passed as the first argument, it will be used as the callback function.
-   *
-   * @function list
-   * @memberof Twilio.Preview.Marketplace.AvailableAddOnList
-   * @instance
-   *
-   * @param {object|function} opts - ...
-   * @param {number} [opts.limit] -
-   *         Upper limit for the number of records to return.
-   *         list() guarantees never to return more than limit.
-   *         Default is no limit
-   * @param {number} [opts.pageSize] -
-   *         Number of records to fetch per request,
-   *         when not set will use the default value of 50 records.
-   *         If no page_size is defined but a limit is defined,
-   *         list() will attempt to read the limit with the most
-   *         efficient page size, i.e. min(limit, 1000)
-   * @param {function} [callback] - Callback to handle list of records
-   *
-   * @returns {Promise} Resolves to a list of records
-   */
-  /* jshint ignore:end */
-  AvailableAddOnListInstance.list = function list(opts, callback) {
-    if (_.isFunction(opts)) {
-      callback = opts;
-      opts = {};
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return this._solution;
     }
-    opts = opts || {};
-    var deferred = Q.defer();
-    var allResources = [];
-    opts.callback = function(resource, done) {
-      allResources.push(resource);
-
-      if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
-        done();
-      }
-    };
-
-    opts.done = function(error) {
-      if (_.isUndefined(error)) {
-        deferred.resolve(allResources);
-      } else {
-        deferred.reject(error);
-      }
-    };
-
-    if (_.isFunction(callback)) {
-      deferred.promise.nodeify(callback);
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
     }
-
-    this.each(opts);
-    return deferred.promise;
-  };
-
-  /* jshint ignore:start */
-  /**
-   * Retrieve a single page of AvailableAddOnInstance records from the API.
-   * Request is executed immediately
-   *
-   * If a function is passed as the first argument, it will be used as the callback function.
-   *
-   * @function page
-   * @memberof Twilio.Preview.Marketplace.AvailableAddOnList
-   * @instance
-   *
-   * @param {object|function} opts - ...
-   * @param {string} [opts.pageToken] - PageToken provided by the API
-   * @param {number} [opts.pageNumber] -
-   *          Page Number, this value is simply for client state
-   * @param {number} [opts.pageSize] - Number of records to return, defaults to 50
-   * @param {function} [callback] - Callback to handle list of records
-   *
-   * @returns {Promise} Resolves to a list of records
-   */
-  /* jshint ignore:end */
-  AvailableAddOnListInstance.page = function page(opts, callback) {
-    opts = opts || {};
-
-    var deferred = Q.defer();
-    var data = values.of({
-      'PageToken': opts.pageToken,
-      'Page': opts.pageNumber,
-      'PageSize': opts.pageSize
-    });
-
-    var promise = this._version.page({
-      uri: this._uri,
-      method: 'GET',
-      params: data
-    });
-
-    promise = promise.then(function(payload) {
-      deferred.resolve(new AvailableAddOnPage(
-        this._version,
-        payload,
-        this._solution
-      ));
-    }.bind(this));
-
-    promise.catch(function(error) {
-      deferred.reject(error);
-    });
-
-    if (_.isFunction(callback)) {
-      deferred.promise.nodeify(callback);
+}
+exports.AvailableAddOnContextImpl = AvailableAddOnContextImpl;
+class AvailableAddOnInstance {
+    constructor(_version, payload, sid) {
+        this._version = _version;
+        this.sid = payload.sid;
+        this.friendlyName = payload.friendly_name;
+        this.description = payload.description;
+        this.pricingType = payload.pricing_type;
+        this.configurationSchema = payload.configuration_schema;
+        this.url = payload.url;
+        this.links = payload.links;
+        this._solution = { sid: sid || this.sid };
     }
-
-    return deferred.promise;
-  };
-
-  /* jshint ignore:start */
-  /**
-   * Retrieve a single target page of AvailableAddOnInstance records from the API.
-   * Request is executed immediately
-   *
-   * If a function is passed as the first argument, it will be used as the callback function.
-   *
-   * @function getPage
-   * @memberof Twilio.Preview.Marketplace.AvailableAddOnList
-   * @instance
-   *
-   * @param {string} [targetUrl] - API-generated URL for the requested results page
-   * @param {function} [callback] - Callback to handle list of records
-   *
-   * @returns {Promise} Resolves to a list of records
-   */
-  /* jshint ignore:end */
-  AvailableAddOnListInstance.getPage = function getPage(targetUrl, callback) {
-    var deferred = Q.defer();
-
-    var promise = this._version._domain.twilio.request({
-      method: 'GET',
-      uri: targetUrl
-    });
-
-    promise = promise.then(function(payload) {
-      deferred.resolve(new AvailableAddOnPage(
-        this._version,
-        payload,
-        this._solution
-      ));
-    }.bind(this));
-
-    promise.catch(function(error) {
-      deferred.reject(error);
-    });
-
-    if (_.isFunction(callback)) {
-      deferred.promise.nodeify(callback);
+    get _proxy() {
+        this._context =
+            this._context ||
+                new AvailableAddOnContextImpl(this._version, this._solution.sid);
+        return this._context;
     }
-
-    return deferred.promise;
-  };
-
-  /* jshint ignore:start */
-  /**
-   * Constructs a available_add_on
-   *
-   * @function get
-   * @memberof Twilio.Preview.Marketplace.AvailableAddOnList
-   * @instance
-   *
-   * @param {string} sid - The unique Available Add-on Sid
-   *
-   * @returns {Twilio.Preview.Marketplace.AvailableAddOnContext}
-   */
-  /* jshint ignore:end */
-  AvailableAddOnListInstance.get = function get(sid) {
-    return new AvailableAddOnContext(
-      this._version,
-      sid
-    );
-  };
-
-  return AvailableAddOnListInstance;
-};
-
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Preview.Marketplace.AvailableAddOnPage
- * @augments Page
- * @description Initialize the AvailableAddOnPage
- * PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
- *
- * @param {Twilio.Preview.Marketplace} version - Version of the resource
- * @param {object} response - Response from the API
- * @param {object} solution - Path solution
- *
- * @returns AvailableAddOnPage
- */
-/* jshint ignore:end */
-AvailableAddOnPage = function AvailableAddOnPage(version, response, solution) {
-  // Path Solution
-  this._solution = solution;
-
-  Page.prototype.constructor.call(this, version, response, this._solution);
-};
-
-_.extend(AvailableAddOnPage.prototype, Page.prototype);
-AvailableAddOnPage.prototype.constructor = AvailableAddOnPage;
-
-/* jshint ignore:start */
-/**
- * Build an instance of AvailableAddOnInstance
- *
- * @function getInstance
- * @memberof Twilio.Preview.Marketplace.AvailableAddOnPage
- * @instance
- *
- * @param {object} payload - Payload response from the API
- *
- * @returns AvailableAddOnInstance
- */
-/* jshint ignore:end */
-AvailableAddOnPage.prototype.getInstance = function getInstance(payload) {
-  return new AvailableAddOnInstance(
-    this._version,
-    payload
-  );
-};
-
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Preview.Marketplace.AvailableAddOnInstance
- * @description Initialize the AvailableAddOnContext
- * PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
- *
- * @property {string} sid - A string that uniquely identifies this Add-on
- * @property {string} friendlyName - A description of this Add-on
- * @property {string} description - A short description of the Add-on functionality
- * @property {string} pricingType -
- *          The way customers are charged for using this Add-on
- * @property {string} configurationSchema -
- *          The JSON Schema describing the Add-on's configuration
- * @property {string} url - The url
- * @property {string} links - The links
- *
- * @param {Twilio.Preview.Marketplace} version - Version of the resource
- * @param {object} payload - The instance payload
- * @param {sid} sid - The unique Available Add-on Sid
- */
-/* jshint ignore:end */
-AvailableAddOnInstance = function AvailableAddOnInstance(version, payload, sid)
-                                                          {
-  this._version = version;
-
-  // Marshaled Properties
-  this.sid = payload.sid; // jshint ignore:line
-  this.friendlyName = payload.friendly_name; // jshint ignore:line
-  this.description = payload.description; // jshint ignore:line
-  this.pricingType = payload.pricing_type; // jshint ignore:line
-  this.configurationSchema = payload.configuration_schema; // 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(AvailableAddOnInstance.prototype,
-  '_proxy', {
-  get: function() {
-    if (!this._context) {
-      this._context = new AvailableAddOnContext(
-        this._version,
-        this._solution.sid
-      );
+    /**
+     * Fetch a AvailableAddOnInstance
+     *
+     * @param callback - Callback to handle processed record
+     *
+     * @returns Resolves to processed AvailableAddOnInstance
+     */
+    fetch(callback) {
+        return this._proxy.fetch(callback);
     }
-
-    return this._context;
-  }
-});
-
-/* jshint ignore:start */
-/**
- * fetch a AvailableAddOnInstance
- *
- * @function fetch
- * @memberof Twilio.Preview.Marketplace.AvailableAddOnInstance
- * @instance
- *
- * @param {function} [callback] - Callback to handle processed record
- *
- * @returns {Promise} Resolves to processed AvailableAddOnInstance
- */
-/* jshint ignore:end */
-AvailableAddOnInstance.prototype.fetch = function fetch(callback) {
-  return this._proxy.fetch(callback);
-};
-
-/* jshint ignore:start */
-/**
- * Access the extensions
- *
- * @function extensions
- * @memberof Twilio.Preview.Marketplace.AvailableAddOnInstance
- * @instance
- *
- * @returns {Twilio.Preview.Marketplace.AvailableAddOnContext.AvailableAddOnExtensionList}
- */
-/* jshint ignore:end */
-AvailableAddOnInstance.prototype.extensions = function extensions() {
-  return this._proxy.extensions;
-};
-
-
-/* jshint ignore:start */
-/**
- * @constructor Twilio.Preview.Marketplace.AvailableAddOnContext
- * @description Initialize the AvailableAddOnContext
- * PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
- *
- * @property {Twilio.Preview.Marketplace.AvailableAddOnContext.AvailableAddOnExtensionList} extensions -
- *          extensions resource
- *
- * @param {Twilio.Preview.Marketplace} version - Version of the resource
- * @param {sid} sid - The unique Available Add-on Sid
- */
-/* jshint ignore:end */
-AvailableAddOnContext = function AvailableAddOnContext(version, sid) {
-  this._version = version;
-
-  // Path Solution
-  this._solution = {
-    sid: sid,
-  };
-  this._uri = _.template(
-    '/AvailableAddOns/<%= sid %>' // jshint ignore:line
-  )(this._solution);
-
-  // Dependents
-  this._extensions = undefined;
-};
-
-/* jshint ignore:start */
-/**
- * fetch a AvailableAddOnInstance
- *
- * @function fetch
- * @memberof Twilio.Preview.Marketplace.AvailableAddOnContext
- * @instance
- *
- * @param {function} [callback] - Callback to handle processed record
- *
- * @returns {Promise} Resolves to processed AvailableAddOnInstance
- */
-/* jshint ignore:end */
-AvailableAddOnContext.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 AvailableAddOnInstance(
-      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(AvailableAddOnContext.prototype,
-  'extensions', {
-  get: function() {
-    if (!this._extensions) {
-      this._extensions = new AvailableAddOnExtensionList(
-        this._version,
-        this._solution.sid
-      );
+    /**
+     * Access the extensions.
+     */
+    extensions() {
+        return this._proxy.extensions;
     }
-    return this._extensions;
-  }
-});
-
-module.exports = {
-  AvailableAddOnList: AvailableAddOnList,
-  AvailableAddOnPage: AvailableAddOnPage,
-  AvailableAddOnInstance: AvailableAddOnInstance,
-  AvailableAddOnContext: AvailableAddOnContext
-};
+    /**
+     * Provide a user-friendly representation
+     *
+     * @returns Object
+     */
+    toJSON() {
+        return {
+            sid: this.sid,
+            friendlyName: this.friendlyName,
+            description: this.description,
+            pricingType: this.pricingType,
+            configurationSchema: this.configurationSchema,
+            url: this.url,
+            links: this.links,
+        };
+    }
+    [util_1.inspect.custom](_depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AvailableAddOnInstance = AvailableAddOnInstance;
+function AvailableAddOnListInstance(version) {
+    const instance = ((sid) => instance.get(sid));
+    instance.get = function get(sid) {
+        return new AvailableAddOnContextImpl(version, sid);
+    };
+    instance._version = version;
+    instance._solution = {};
+    instance._uri = `/AvailableAddOns`;
+    instance.page = function page(params, callback) {
+        if (params instanceof Function) {
+            callback = params;
+            params = {};
+        }
+        else {
+            params = params || {};
+        }
+        let data = {};
+        if (params["pageSize"] !== undefined)
+            data["PageSize"] = params["pageSize"];
+        if (params.pageNumber !== undefined)
+            data["Page"] = params.pageNumber;
+        if (params.pageToken !== undefined)
+            data["PageToken"] = params.pageToken;
+        const headers = {};
+        let operationVersion = version, operationPromise = operationVersion.page({
+            uri: instance._uri,
+            method: "get",
+            params: data,
+            headers,
+        });
+        operationPromise = operationPromise.then((payload) => new AvailableAddOnPage(operationVersion, payload, instance._solution));
+        operationPromise = instance._version.setPromiseCallback(operationPromise, callback);
+        return operationPromise;
+    };
+    instance.each = instance._version.each;
+    instance.list = instance._version.list;
+    instance.getPage = function getPage(targetUrl, callback) {
+        const operationPromise = instance._version._domain.twilio.request({
+            method: "get",
+            uri: targetUrl,
+        });
+        let pagePromise = operationPromise.then((payload) => new AvailableAddOnPage(instance._version, payload, instance._solution));
+        pagePromise = instance._version.setPromiseCallback(pagePromise, callback);
+        return pagePromise;
+    };
+    instance.toJSON = function toJSON() {
+        return instance._solution;
+    };
+    instance[util_1.inspect.custom] = function inspectImpl(_depth, options) {
+        return (0, util_1.inspect)(instance.toJSON(), options);
+    };
+    return instance;
+}
+exports.AvailableAddOnListInstance = AvailableAddOnListInstance;
+class AvailableAddOnPage extends Page_1.default {
+    /**
+     * Initialize the AvailableAddOnPage
+     *
+     * @param version - Version of the resource
+     * @param response - Response from the API
+     * @param solution - Path solution
+     */
+    constructor(version, response, solution) {
+        super(version, response, solution);
+    }
+    /**
+     * Build an instance of AvailableAddOnInstance
+     *
+     * @param payload - Payload response from the API
+     */
+    getInstance(payload) {
+        return new AvailableAddOnInstance(this._version, payload);
+    }
+    [util_1.inspect.custom](depth, options) {
+        return (0, util_1.inspect)(this.toJSON(), options);
+    }
+}
+exports.AvailableAddOnPage = AvailableAddOnPage;