Merge pull request #21 from shotstack/volume-effects-s3-required

Fix up issues and update contents from latest update

Author: jeffski

package.json

@@ -1,6 +1,6 @@
 {
   "name": "shotstack-sdk",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Official Node SDK for the Shotstack Cloud Video Editing API",
   "license": "MIT",
   "main": "src/index.js",

src/model/Asset.js

@@ -507,6 +507,24 @@ exports.prototype['trim'] = undefined;
   }
 
 
+  /**
+   * Returns The volume effect to apply to the video asset <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
+   * @return {module:model/Asset.VolumeEffectEnum}
+   */
+  exports.prototype.getVolumeEffect = function() {
+    return this['volumeEffect'];
+  }
+
+  /**
+   * Sets The volume effect to apply to the video asset <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
+   * @param {module:model/Asset.VolumeEffectEnum} volumeEffect The volume effect to apply to the video asset <ul>   <li>`fadeIn` - fade volume in only</li>   <li>`fadeOut` - fade volume out only</li>   <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
+   */
+  exports.prototype.setVolumeEffect = function(volumeEffect) {
+    this['volumeEffect'] = volumeEffect;
+    return this;
+  }
+
+
   /**
    * @return {module:model/Crop}
    */

src/model/Edit.js

@@ -101,7 +101,7 @@
    */
   exports.prototype['callback'] = undefined;
   /**
-   * The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
+   * **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**  The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> 
    * @member {module:model/Edit.DiskEnum} disk
    */
   exports.prototype['disk'] = undefined;
@@ -176,16 +176,16 @@
 
 
   /**
-   * Returns The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
+   * Returns **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**  The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> 
    * @return {module:model/Edit.DiskEnum}
    */
   exports.prototype.getDisk = function() {
     return this['disk'];
   }
 
   /**
-   * Sets The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
-   * @param {module:model/Edit.DiskEnum} disk The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
+   * Sets **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**  The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> 
+   * @param {module:model/Edit.DiskEnum} disk **Notice: This option is now deprecated and will be removed. Disk types are handled automatically. Setting a disk type has no effect.**  The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.io/docs/guide/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimized for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimized for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul> 
    */
   exports.prototype.setDisk = function(disk) {
     this['disk'] = disk;

src/model/S3DestinationOptions.js

@@ -43,10 +43,14 @@
    * Pass additional options to control how files are stored in S3.
    * @alias module:model/S3DestinationOptions
    * @class
+   * @param region {String} Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.
+   * @param bucket {String} The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.
    */
-  var exports = function() {
+  var exports = function(region, bucket) {
     var _this = this;
 
+    _this['region'] = region;
+    _this['bucket'] = bucket;
   };
 
   /**
@@ -79,7 +83,7 @@
   }
 
   /**
-   * Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`.
+   * Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.
    * @member {String} region
    */
   exports.prototype['region'] = undefined;
@@ -106,16 +110,16 @@
 
 
   /**
-   * Returns Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`.
+   * Returns Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.
    * @return {String}
    */
   exports.prototype.getRegion = function() {
     return this['region'];
   }
 
   /**
-   * Sets Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`.
-   * @param {String} region Choose the region to send the file to. Must be a valid [AWS region] string like `us-east-1` or `ap-southeast-2`.
+   * Sets Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.
+   * @param {String} region Choose the region to send the file to. Must be a valid  [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.
    */
   exports.prototype.setRegion = function(region) {
     this['region'] = region;

src/model/TemplateRender.js

@@ -40,7 +40,7 @@
 
   /**
    * Constructs a new <code>TemplateRender</code>.
-   * Render a template by it&#39;s id and optional merge fields.
+   * Configure the id and optional merge fields to render a template by id.
    * @alias module:model/TemplateRender
    * @class
    * @param id {String} The id of the template to render in UUID format.

src/model/TemplateResponse.js

@@ -40,7 +40,7 @@
 
   /**
    * Constructs a new <code>TemplateResponse</code>.
-   * The response received after a [template](#create-a-template) is submitted. The template is saved and a unique template id is returned.
+   * The response received after a [template](#create-template) is submitted. The template is saved and a unique template id is returned.
    * @alias module:model/TemplateResponse
    * @class
    * @param success {Boolean} `true` if successfully created, else `false`.