Regenerate with structured params/properties (twilio#361)

* regenerate with structured params/properties

* add callback tests

* added new test cases

* better test case for opts + callback

* update "second arg as a callback" test cases to show that opts are not stomped

Author: ekarson

lib/rest/Api.js

@@ -21,6 +21,7 @@ var V2010 = require('./api/V2010');  /* jshint ignore:line */
  * @constructor Twilio.Api
  *
  * @property {Twilio.Api.V2010} v2010 - v2010 version
+ * @property {Twilio.Api.V2010.AccountContext} account - Main account resource
  * @property {Twilio.Api.V2010.AccountList} accounts - accounts resource
  * @property {Twilio.Api.V2010.AccountContext.AddressList} addresses -
  *          addresses resource

lib/rest/Preview.js

@@ -50,10 +50,10 @@ var Wireless = require('./preview/Wireless');  /* jshint ignore:line */
  *          authorizationDocuments resource
  * @property {Twilio.Preview.HostedNumbers.HostedNumberOrderList} hostedNumberOrders -
  *          hostedNumberOrders resource
- * @property {Twilio.Preview.Marketplace.AvailableAddOnList} availableAddOns -
- *          availableAddOns resource
  * @property {Twilio.Preview.Marketplace.InstalledAddOnList} installedAddOns -
  *          installedAddOns resource
+ * @property {Twilio.Preview.Marketplace.AvailableAddOnList} availableAddOns -
+ *          availableAddOns resource
  * @property {Twilio.Preview.Sync.ServiceList} services - services resource
  * @property {Twilio.Preview.Studio.FlowList} flows - flows resource
  * @property {Twilio.Preview.Understand.AssistantList} assistants -
@@ -200,16 +200,16 @@ Object.defineProperty(Preview.prototype,
 });
 
 Object.defineProperty(Preview.prototype,
-  'availableAddOns', {
+  'installedAddOns', {
   get: function() {
-    return this.marketplace.availableAddOns;
+    return this.marketplace.installedAddOns;
   }
 });
 
 Object.defineProperty(Preview.prototype,
-  'installedAddOns', {
+  'availableAddOns', {
   get: function() {
-    return this.marketplace.installedAddOns;
+    return this.marketplace.availableAddOns;
   }
 });
 

lib/rest/Twilio.js

@@ -43,7 +43,7 @@ var Wireless = require('./Wireless');  /* jshint ignore:line */
  * @property {Twilio.Api} api - api domain
  * @property {Twilio.Chat} chat - chat domain
  * @property {Twilio.Fax} fax - fax domain
- * @property {Twilio.IpMessaging} ip_messaging - ip_messaging domain
+ * @property {Twilio.IpMessaging} ipMessaging - ip_messaging domain
  * @property {Twilio.Lookups} lookups - lookups domain
  * @property {Twilio.Monitor} monitor - monitor domain
  * @property {Twilio.Notify} notify - notify domain
@@ -102,7 +102,7 @@ var Wireless = require('./Wireless');  /* jshint ignore:line */
  *          The username used for authentication. This is normally account sid, but if using key/secret auth will be the api key sid.
  * @param {string} password -
  *          The password used for authentication. This is normally auth token, but if using key/secret auth will be the secret.
- * @param {object} opts - ...
+ * @param {object} [opts] - ...
  * @param {HttpClient} [opts.httpClient] -
  *          The client used for http requests. Defaults to RequestClient
  * @param {string} [opts.accountSid] -

lib/rest/Video.js

@@ -21,8 +21,8 @@ var V1 = require('./video/V1');  /* jshint ignore:line */
  * @constructor Twilio.Video
  *
  * @property {Twilio.Video.V1} v1 - v1 version
- * @property {Twilio.Video.V1.CompositionList} compositions - compositions resource
  * @property {Twilio.Video.V1.RecordingList} recordings - recordings resource
+ * @property {Twilio.Video.V1.CompositionList} compositions - compositions resource
  * @property {Twilio.Video.V1.RoomList} rooms - rooms resource
  *
  * @param {Twilio} twilio - The twilio client
@@ -47,16 +47,16 @@ Object.defineProperty(Video.prototype,
 });
 
 Object.defineProperty(Video.prototype,
-  'compositions', {
+  'recordings', {
   get: function() {
-    return this.v1.compositions;
+    return this.v1.recordings;
   }
 });
 
 Object.defineProperty(Video.prototype,
-  'recordings', {
+  'compositions', {
   get: function() {
-    return this.v1.recordings;
+    return this.v1.compositions;
   }
 });
 

lib/rest/accounts/v1/credential/aws.js

@@ -66,34 +66,35 @@ AwsList = function AwsList(version) {
    * @memberof Twilio.Accounts.V1.CredentialContext.AwsList
    * @instance
    *
-   * @param {object|function} opts - ...
+   * @param {object} [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] -
+   * @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
+   *         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 */
   AwsListInstance.each = function each(opts, callback) {
-    opts = opts || {};
     if (_.isFunction(opts)) {
-      opts = { callback: opts };
-    } else if (_.isFunction(callback) && !_.isFunction(opts.callback)) {
-      opts.callback = callback;
+      callback = opts;
+      opts = {};
     }
-
-    if (_.isUndefined(opts.callback)) {
+    opts = opts || {};
+    if (opts.callback) {
+      callback = opts.callback;
+    }
+    if (_.isUndefined(callback)) {
       throw new Error('Callback function must be provided');
     }
 
@@ -127,7 +128,7 @@ AwsList = function AwsList(version) {
           }
 
           currentResource++;
-          opts.callback(instance, onComplete);
+          callback(instance, onComplete);
         });
 
         if ((limits.pageLimit && limits.pageLimit <= currentPage)) {
@@ -154,7 +155,7 @@ AwsList = function AwsList(version) {
    * @memberof Twilio.Accounts.V1.CredentialContext.AwsList
    * @instance
    *
-   * @param {object|function} opts - ...
+   * @param {object} [opts] - ...
    * @param {number} [opts.limit] -
    *         Upper limit for the number of records to return.
    *         list() guarantees never to return more than limit.
@@ -213,7 +214,7 @@ AwsList = function AwsList(version) {
    * @memberof Twilio.Accounts.V1.CredentialContext.AwsList
    * @instance
    *
-   * @param {object|function} opts - ...
+   * @param {object} [opts] - ...
    * @param {string} [opts.pageToken] - PageToken provided by the API
    * @param {number} [opts.pageNumber] -
    *          Page Number, this value is simply for client state
@@ -224,6 +225,10 @@ AwsList = function AwsList(version) {
    */
   /* jshint ignore:end */
   AwsListInstance.page = function page(opts, callback) {
+    if (_.isFunction(opts)) {
+      callback = opts;
+      opts = {};
+    }
     opts = opts || {};
 
     var deferred = Q.defer();
@@ -467,7 +472,7 @@ AwsInstance.prototype.fetch = function fetch(callback) {
  * @memberof Twilio.Accounts.V1.CredentialContext.AwsInstance
  * @instance
  *
- * @param {object|function} opts - ...
+ * @param {object} [opts] - ...
  * @param {string} [opts.friendlyName] - The friendly_name
  * @param {function} [callback] - Callback to handle processed record
  *
@@ -577,7 +582,7 @@ AwsContext.prototype.fetch = function fetch(callback) {
  * @memberof Twilio.Accounts.V1.CredentialContext.AwsContext
  * @instance
  *
- * @param {object|function} opts - ...
+ * @param {object} [opts] - ...
  * @param {string} [opts.friendlyName] - The friendly_name
  * @param {function} [callback] - Callback to handle processed record
  *

lib/rest/accounts/v1/credential/publicKey.js

@@ -66,34 +66,35 @@ PublicKeyList = function PublicKeyList(version) {
    * @memberof Twilio.Accounts.V1.CredentialContext.PublicKeyList
    * @instance
    *
-   * @param {object|function} opts - ...
+   * @param {object} [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] -
+   * @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
+   *         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 */
   PublicKeyListInstance.each = function each(opts, callback) {
-    opts = opts || {};
     if (_.isFunction(opts)) {
-      opts = { callback: opts };
-    } else if (_.isFunction(callback) && !_.isFunction(opts.callback)) {
-      opts.callback = callback;
+      callback = opts;
+      opts = {};
     }
-
-    if (_.isUndefined(opts.callback)) {
+    opts = opts || {};
+    if (opts.callback) {
+      callback = opts.callback;
+    }
+    if (_.isUndefined(callback)) {
       throw new Error('Callback function must be provided');
     }
 
@@ -127,7 +128,7 @@ PublicKeyList = function PublicKeyList(version) {
           }
 
           currentResource++;
-          opts.callback(instance, onComplete);
+          callback(instance, onComplete);
         });
 
         if ((limits.pageLimit && limits.pageLimit <= currentPage)) {
@@ -154,7 +155,7 @@ PublicKeyList = function PublicKeyList(version) {
    * @memberof Twilio.Accounts.V1.CredentialContext.PublicKeyList
    * @instance
    *
-   * @param {object|function} opts - ...
+   * @param {object} [opts] - ...
    * @param {number} [opts.limit] -
    *         Upper limit for the number of records to return.
    *         list() guarantees never to return more than limit.
@@ -213,7 +214,7 @@ PublicKeyList = function PublicKeyList(version) {
    * @memberof Twilio.Accounts.V1.CredentialContext.PublicKeyList
    * @instance
    *
-   * @param {object|function} opts - ...
+   * @param {object} [opts] - ...
    * @param {string} [opts.pageToken] - PageToken provided by the API
    * @param {number} [opts.pageNumber] -
    *          Page Number, this value is simply for client state
@@ -224,6 +225,10 @@ PublicKeyList = function PublicKeyList(version) {
    */
   /* jshint ignore:end */
   PublicKeyListInstance.page = function page(opts, callback) {
+    if (_.isFunction(opts)) {
+      callback = opts;
+      opts = {};
+    }
     opts = opts || {};
 
     var deferred = Q.defer();
@@ -471,7 +476,7 @@ PublicKeyInstance.prototype.fetch = function fetch(callback) {
  * @memberof Twilio.Accounts.V1.CredentialContext.PublicKeyInstance
  * @instance
  *
- * @param {object|function} opts - ...
+ * @param {object} [opts] - ...
  * @param {string} [opts.friendlyName] -
  *          A human readable description of this resource
  * @param {function} [callback] - Callback to handle processed record
@@ -582,7 +587,7 @@ PublicKeyContext.prototype.fetch = function fetch(callback) {
  * @memberof Twilio.Accounts.V1.CredentialContext.PublicKeyContext
  * @instance
  *
- * @param {object|function} opts - ...
+ * @param {object} [opts] - ...
  * @param {string} [opts.friendlyName] -
  *          A human readable description of this resource
  * @param {function} [callback] - Callback to handle processed record