twilio 3.77.2 → 3.79.0

package/lib/rest/supersim/v1/sim/simIpAddress.js

@@ -0,0 +1,448 @@
+'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 values = require('../../../../base/values');  /* jshint ignore:line */
+
+var SimIpAddressList;
+var SimIpAddressPage;
+var SimIpAddressInstance;
+
+/* jshint ignore:start */
+/**
+ * Initialize the SimIpAddressList
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Supersim.V1.SimContext.SimIpAddressList
+ *
+ * @param {Twilio.Supersim.V1} version - Version of the resource
+ * @param {string} simSid - The unique string that identifies the resource
+ */
+/* jshint ignore:end */
+SimIpAddressList = function SimIpAddressList(version, simSid) {
+  /* jshint ignore:start */
+  /**
+   * @function simIpAddresses
+   * @memberof Twilio.Supersim.V1.SimContext#
+   *
+   * @param {string} sid - sid of instance
+   *
+   * @returns {Twilio.Supersim.V1.SimContext.SimIpAddressContext}
+   */
+  /* jshint ignore:end */
+  function SimIpAddressListInstance(sid) {
+    return SimIpAddressListInstance.get(sid);
+  }
+
+  SimIpAddressListInstance._version = version;
+  // Path Solution
+  SimIpAddressListInstance._solution = {simSid: simSid};
+  SimIpAddressListInstance._uri = `/Sims/${simSid}/IpAddresses`;
+  /* jshint ignore:start */
+  /**
+   * Streams SimIpAddressInstance 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.Supersim.V1.SimContext.SimIpAddressList#
+   *
+   * @param {object} [opts] - Options for request
+   * @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] -
+   *         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 */
+  SimIpAddressListInstance.each = function each(opts, callback) {
+    if (_.isFunction(opts)) {
+      callback = opts;
+      opts = {};
+    }
+    opts = opts || {};
+    if (opts.callback) {
+      callback = opts.callback;
+    }
+    if (_.isUndefined(callback)) {
+      throw new Error('Callback function must be provided');
+    }
+
+    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);
+      }
+    }
+
+    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++;
+          callback(instance, onComplete);
+        });
+
+        if (!done) {
+          currentPage++;
+          fetchNextPage(_.bind(page.nextPage, page));
+        } else {
+          onComplete();
+        }
+      });
+
+      promise.catch(onComplete);
+    }
+
+    fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Lists SimIpAddressInstance 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.Supersim.V1.SimContext.SimIpAddressList#
+   *
+   * @param {object} [opts] - Options for request
+   * @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 */
+  SimIpAddressListInstance.list = function list(opts, callback) {
+    if (_.isFunction(opts)) {
+      callback = opts;
+      opts = {};
+    }
+    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);
+    }
+
+    this.each(opts);
+    return deferred.promise;
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Retrieve a single page of SimIpAddressInstance records from the API.
+   *
+   * The 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.Supersim.V1.SimContext.SimIpAddressList#
+   *
+   * @param {object} [opts] - Options for request
+   * @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 */
+  SimIpAddressListInstance.page = function page(opts, callback) {
+    if (_.isFunction(opts)) {
+      callback = opts;
+      opts = {};
+    }
+    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 SimIpAddressPage(this._version, payload, this._solution));
+    }.bind(this));
+
+    promise.catch(function(error) {
+      deferred.reject(error);
+    });
+
+    if (_.isFunction(callback)) {
+      deferred.promise.nodeify(callback);
+    }
+
+    return deferred.promise;
+  };
+
+  /* jshint ignore:start */
+  /**
+   * Retrieve a single target page of SimIpAddressInstance records from the API.
+   *
+   * The 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.Supersim.V1.SimContext.SimIpAddressList#
+   *
+   * @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 */
+  SimIpAddressListInstance.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 SimIpAddressPage(this._version, payload, this._solution));
+    }.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.Supersim.V1.SimContext.SimIpAddressList#
+   *
+   * @returns Object
+   */
+  /* jshint ignore:end */
+  SimIpAddressListInstance.toJSON = function toJSON() {
+    return this._solution;
+  };
+
+  SimIpAddressListInstance[util.inspect.custom] = function inspect(depth, options)
+      {
+    return util.inspect(this.toJSON(), options);
+  };
+
+  return SimIpAddressListInstance;
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the SimIpAddressPage
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Supersim.V1.SimContext.SimIpAddressPage
+ *
+ * @param {V1} version - Version of the resource
+ * @param {Response<string>} response - Response from the API
+ * @param {SimIpAddressSolution} solution - Path solution
+ *
+ * @returns SimIpAddressPage
+ */
+/* jshint ignore:end */
+SimIpAddressPage = function SimIpAddressPage(version, response, solution) {
+  // Path Solution
+  this._solution = solution;
+
+  Page.prototype.constructor.call(this, version, response, this._solution);
+};
+
+_.extend(SimIpAddressPage.prototype, Page.prototype);
+SimIpAddressPage.prototype.constructor = SimIpAddressPage;
+
+/* jshint ignore:start */
+/**
+ * Build an instance of SimIpAddressInstance
+ *
+ * @function getInstance
+ * @memberof Twilio.Supersim.V1.SimContext.SimIpAddressPage#
+ *
+ * @param {SimIpAddressPayload} payload - Payload response from the API
+ *
+ * @returns SimIpAddressInstance
+ */
+/* jshint ignore:end */
+SimIpAddressPage.prototype.getInstance = function getInstance(payload) {
+  return new SimIpAddressInstance(this._version, payload, this._solution.simSid);
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Supersim.V1.SimContext.SimIpAddressPage#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+SimIpAddressPage.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+SimIpAddressPage.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+
+/* jshint ignore:start */
+/**
+ * Initialize the SimIpAddressContext
+ *
+ * PLEASE NOTE that this class contains beta products that are subject to change.
+ * Use them with caution.
+ *
+ * @constructor Twilio.Supersim.V1.SimContext.SimIpAddressInstance
+ *
+ * @property {string} ipAddress - IP address assigned to the given Super SIM
+ * @property {sim_ip_address.ip_address_version} ipAddressVersion -
+ *          IP address version
+ *
+ * @param {V1} version - Version of the resource
+ * @param {SimIpAddressPayload} payload - The instance payload
+ * @param {sid} simSid - The unique string that identifies the resource
+ */
+/* jshint ignore:end */
+SimIpAddressInstance = function SimIpAddressInstance(version, payload, simSid) {
+  this._version = version;
+
+  // Marshaled Properties
+  this.ipAddress = payload.ip_address; // jshint ignore:line
+  this.ipAddressVersion = payload.ip_address_version; // jshint ignore:line
+
+  // Context
+  this._context = undefined;
+  this._solution = {simSid: simSid, };
+};
+
+/* jshint ignore:start */
+/**
+ * Provide a user-friendly representation
+ *
+ * @function toJSON
+ * @memberof Twilio.Supersim.V1.SimContext.SimIpAddressInstance#
+ *
+ * @returns Object
+ */
+/* jshint ignore:end */
+SimIpAddressInstance.prototype.toJSON = function toJSON() {
+  let clone = {};
+  _.forOwn(this, function(value, key) {
+    if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
+      clone[key] = value;
+    }
+  });
+  return clone;
+};
+
+SimIpAddressInstance.prototype[util.inspect.custom] = function inspect(depth,
+    options) {
+  return util.inspect(this.toJSON(), options);
+};
+
+module.exports = {
+  SimIpAddressList: SimIpAddressList,
+  SimIpAddressPage: SimIpAddressPage,
+  SimIpAddressInstance: SimIpAddressInstance
+};

package/lib/rest/supersim/v1/sim.d.ts

@@ -11,6 +11,8 @@ import V1 = require('../V1');
 import { BillingPeriodList } from './sim/billingPeriod';
 import { BillingPeriodListInstance } from './sim/billingPeriod';
 import { SerializableClass } from '../../../interfaces';
+import { SimIpAddressList } from './sim/simIpAddress';
+import { SimIpAddressListInstance } from './sim/simIpAddress';
 
 type SimStatus = 'new'|'ready'|'active'|'inactive'|'scheduled';
 
@@ -290,6 +292,7 @@ declare class SimContext {
    * @param callback - Callback to handle processed record
    */
   fetch(callback?: (error: Error | null, items: SimInstance) => any): Promise<SimInstance>;
+  simIpAddresses: SimIpAddressListInstance;
   /**
    * Provide a user-friendly representation
    */
@@ -341,6 +344,10 @@ declare class SimInstance extends SerializableClass {
   iccid: string;
   links: string;
   sid: string;
+  /**
+   * Access the simIpAddresses
+   */
+  simIpAddresses(): SimIpAddressListInstance;
   status: SimStatus;
   /**
    * Provide a user-friendly representation

package/lib/rest/supersim/v1/sim.js

@@ -14,6 +14,7 @@ var _ = require('lodash');  /* jshint ignore:line */
 var util = require('util');  /* jshint ignore:line */
 var BillingPeriodList = require('./sim/billingPeriod').BillingPeriodList;
 var Page = require('../../../base/Page');  /* jshint ignore:line */
+var SimIpAddressList = require('./sim/simIpAddress').SimIpAddressList;
 var deserialize = require(
     '../../../base/deserialize');  /* jshint ignore:line */
 var values = require('../../../base/values');  /* jshint ignore:line */
@@ -590,6 +591,20 @@ SimInstance.prototype.billingPeriods = function billingPeriods() {
   return this._proxy.billingPeriods;
 };
 
+/* jshint ignore:start */
+/**
+ * Access the simIpAddresses
+ *
+ * @function simIpAddresses
+ * @memberof Twilio.Supersim.V1.SimInstance#
+ *
+ * @returns {Twilio.Supersim.V1.SimContext.SimIpAddressList}
+ */
+/* jshint ignore:end */
+SimInstance.prototype.simIpAddresses = function simIpAddresses() {
+  return this._proxy.simIpAddresses;
+};
+
 /* jshint ignore:start */
 /**
  * Provide a user-friendly representation
@@ -626,6 +641,8 @@ SimInstance.prototype[util.inspect.custom] = function inspect(depth, options) {
  *
  * @property {Twilio.Supersim.V1.SimContext.BillingPeriodList} billingPeriods -
  *          billingPeriods resource
+ * @property {Twilio.Supersim.V1.SimContext.SimIpAddressList} simIpAddresses -
+ *          simIpAddresses resource
  *
  * @param {V1} version - Version of the resource
  * @param {sid_like} sid - The SID that identifies the resource to fetch
@@ -640,6 +657,7 @@ SimContext = function SimContext(version, sid) {
 
   // Dependents
   this._billingPeriods = undefined;
+  this._simIpAddresses = undefined;
 };
 
 /* jshint ignore:start */
@@ -741,6 +759,16 @@ Object.defineProperty(SimContext.prototype,
     }
 });
 
+Object.defineProperty(SimContext.prototype,
+  'simIpAddresses', {
+    get: function() {
+      if (!this._simIpAddresses) {
+        this._simIpAddresses = new SimIpAddressList(this._version, this._solution.sid);
+      }
+      return this._simIpAddresses;
+    }
+});
+
 /* jshint ignore:start */
 /**
  * Provide a user-friendly representation

package/lib/rest/verify/v2/service/verificationCheck.d.ts

@@ -21,13 +21,19 @@ type VerificationCheckChannel = 'sms'|'call'|'email'|'whatsapp'|'sna';
 declare function VerificationCheckList(version: V2, serviceSid: string): VerificationCheckListInstance;
 
 interface VerificationCheckListInstance {
+  /**
+   * create a VerificationCheckInstance
+   *
+   * @param callback - Callback to handle processed record
+   */
+  create(callback?: (error: Error | null, item: VerificationCheckInstance) => any): Promise<VerificationCheckInstance>;
   /**
    * create a VerificationCheckInstance
    *
    * @param opts - Options for request
    * @param callback - Callback to handle processed record
    */
-  create(opts: VerificationCheckListInstanceCreateOptions, callback?: (error: Error | null, item: VerificationCheckInstance) => any): Promise<VerificationCheckInstance>;
+  create(opts?: VerificationCheckListInstanceCreateOptions, callback?: (error: Error | null, item: VerificationCheckInstance) => any): Promise<VerificationCheckInstance>;
   /**
    * Provide a user-friendly representation
    */
@@ -45,7 +51,7 @@ interface VerificationCheckListInstance {
  */
 interface VerificationCheckListInstanceCreateOptions {
   amount?: string;
-  code: string;
+  code?: string;
   payee?: string;
   to?: string;
   verificationSid?: string;

package/lib/rest/verify/v2/service/verificationCheck.js

@@ -58,8 +58,7 @@ VerificationCheckList = function VerificationCheckList(version, serviceSid) {
    * @function create
    * @memberof Twilio.Verify.V2.ServiceContext.VerificationCheckList#
    *
-   * @param {object} opts - Options for request
-   * @param {string} opts.code - The verification string
+   * @param {object} [opts] - Options for request
    * @param {string} [opts.to] - The phone number or email to verify
    * @param {string} [opts.verificationSid] -
    *          A SID that uniquely identifies the Verification Check
@@ -67,26 +66,26 @@ VerificationCheckList = function VerificationCheckList(version, serviceSid) {
    *          The amount of the associated PSD2 compliant transaction.
    * @param {string} [opts.payee] -
    *          The payee of the associated PSD2 compliant transaction
+   * @param {string} [opts.code] - The verification string
    * @param {function} [callback] - Callback to handle processed record
    *
    * @returns {Promise} Resolves to processed VerificationCheckInstance
    */
   /* jshint ignore:end */
   VerificationCheckListInstance.create = function create(opts, callback) {
-    if (_.isUndefined(opts)) {
-      throw new Error('Required parameter "opts" missing.');
-    }
-    if (_.isUndefined(opts['code'])) {
-      throw new Error('Required parameter "opts[\'code\']" missing.');
+    if (_.isFunction(opts)) {
+      callback = opts;
+      opts = {};
     }
+    opts = opts || {};
 
     var deferred = Q.defer();
     var data = values.of({
-      'Code': _.get(opts, 'code'),
       'To': _.get(opts, 'to'),
       'VerificationSid': _.get(opts, 'verificationSid'),
       'Amount': _.get(opts, 'amount'),
-      'Payee': _.get(opts, 'payee')
+      'Payee': _.get(opts, 'payee'),
+      'Code': _.get(opts, 'code')
     });
 
     var promise = this._version.create({uri: this._uri, method: 'POST', data: data});