Merge pull request #10 from shotstack/disk-settings

Add disk and cache. Update descriptions.

Author: jeffski

src/Api/EndpointsApi.php

@@ -12,7 +12,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 

src/ApiException.php

@@ -12,7 +12,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 

src/Configuration.php

@@ -12,7 +12,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 

src/HeaderSelector.php

@@ -12,7 +12,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 

src/Model/AudioAsset.php

@@ -13,7 +13,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 

src/Model/Clip.php

@@ -13,7 +13,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -233,7 +233,6 @@ public function getModelName()
     const EFFECT_SLIDE_RIGHT = 'slideRight';
     const EFFECT_SLIDE_UP = 'slideUp';
     const EFFECT_SLIDE_DOWN = 'slideDown';
-    const FILTER_BLUR = 'blur';
     const FILTER_BOOST = 'boost';
     const FILTER_CONTRAST = 'contrast';
     const FILTER_DARKEN = 'darken';
@@ -304,7 +303,6 @@ public function getEffectAllowableValues()
     public function getFilterAllowableValues()
     {
         return [
-            self::FILTER_BLUR,
             self::FILTER_BOOST,
             self::FILTER_CONTRAST,
             self::FILTER_DARKEN,

src/Model/Crop.php

@@ -13,7 +13,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 

src/Model/Edit.php

@@ -13,7 +13,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -63,7 +63,8 @@ class Edit implements ModelInterface, ArrayAccess, \JsonSerializable
     protected static $openAPITypes = [
         'timeline' => '\Shotstack\Client\Model\Timeline',
         'output' => '\Shotstack\Client\Model\Output',
-        'callback' => 'string'
+        'callback' => 'string',
+        'disk' => 'string'
     ];
 
     /**
@@ -76,7 +77,8 @@ class Edit implements ModelInterface, ArrayAccess, \JsonSerializable
     protected static $openAPIFormats = [
         'timeline' => null,
         'output' => null,
-        'callback' => null
+        'callback' => null,
+        'disk' => null
     ];
 
     /**
@@ -108,7 +110,8 @@ public static function openAPIFormats()
     protected static $attributeMap = [
         'timeline' => 'timeline',
         'output' => 'output',
-        'callback' => 'callback'
+        'callback' => 'callback',
+        'disk' => 'disk'
     ];
 
     /**
@@ -119,7 +122,8 @@ public static function openAPIFormats()
     protected static $setters = [
         'timeline' => 'setTimeline',
         'output' => 'setOutput',
-        'callback' => 'setCallback'
+        'callback' => 'setCallback',
+        'disk' => 'setDisk'
     ];
 
     /**
@@ -130,7 +134,8 @@ public static function openAPIFormats()
     protected static $getters = [
         'timeline' => 'getTimeline',
         'output' => 'getOutput',
-        'callback' => 'getCallback'
+        'callback' => 'getCallback',
+        'disk' => 'getDisk'
     ];
 
     /**
@@ -174,9 +179,24 @@ public function getModelName()
         return self::$openAPIModelName;
     }
 
+    const DISK_LOCAL = 'local';
+    const DISK_MOUNT = 'mount';
 
 
 
+    /**
+     * Gets allowable values of the enum
+     *
+     * @return string[]
+     */
+    public function getDiskAllowableValues()
+    {
+        return [
+            self::DISK_LOCAL,
+            self::DISK_MOUNT,
+        ];
+    }
+    
 
     /**
      * Associative array for storing property values
@@ -196,6 +216,7 @@ public function __construct(array $data = null)
         $this->container['timeline'] = $data['timeline'] ?? null;
         $this->container['output'] = $data['output'] ?? null;
         $this->container['callback'] = $data['callback'] ?? null;
+        $this->container['disk'] = $data['disk'] ?? 'local';
     }
 
     /**
@@ -213,6 +234,15 @@ public function listInvalidProperties()
         if ($this->container['output'] === null) {
             $invalidProperties[] = "'output' can't be null";
         }
+        $allowedValues = $this->getDiskAllowableValues();
+        if (!is_null($this->container['disk']) && !in_array($this->container['disk'], $allowedValues, true)) {
+            $invalidProperties[] = sprintf(
+                "invalid value '%s' for 'disk', must be one of '%s'",
+                $this->container['disk'],
+                implode("', '", $allowedValues)
+            );
+        }
+
         return $invalidProperties;
     }
 
@@ -289,7 +319,7 @@ public function getCallback()
     /**
      * Sets callback
      *
-     * @param string|null $callback An optional webhook callback URL used to receive status notifications when a render completes or fails.
+     * @param string|null $callback An optional webhook callback URL used to receive status notifications when a render completes or fails. See [webhooks](https://shotstack.gitbook.io/docs/guides/architecting-an-application/webhooks) for  more details.
      *
      * @return self
      */
@@ -299,6 +329,40 @@ public function setCallback($callback)
 
         return $this;
     }
+
+    /**
+     * Gets disk
+     *
+     * @return string|null
+     */
+    public function getDisk()
+    {
+        return $this->container['disk'];
+    }
+
+    /**
+     * Sets disk
+     *
+     * @param string|null $disk The disk type to use for storing footage and assets for each render. See [disk types](https://shotstack.gitbook.io/docs/guides/architecting-an-application/disk-types) for more details. <ul>   <li>`local` - optimised for high speed rendering with up to 512MB storage</li>   <li>`mount` - optimised for larger file sizes and longer videos with 5GB for source footage and 512MB for output render</li> </ul>
+     *
+     * @return self
+     */
+    public function setDisk($disk)
+    {
+        $allowedValues = $this->getDiskAllowableValues();
+        if (!is_null($disk) && !in_array($disk, $allowedValues, true)) {
+            throw new \InvalidArgumentException(
+                sprintf(
+                    "Invalid value '%s' for 'disk', must be one of '%s'",
+                    $disk,
+                    implode("', '", $allowedValues)
+                )
+            );
+        }
+        $this->container['disk'] = $disk;
+
+        return $this;
+    }
     /**
      * Returns true if offset exists. False otherwise.
      *

src/Model/Font.php

@@ -13,7 +13,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -36,7 +36,7 @@
  * Font Class Doc Comment
  *
  * @category Class
- * @description Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag.
+ * @description Download a custom font to use with the HTML asset type, using the font name in the CSS or font tag. See our [custom fonts](https://shotstack.io/learn/html-custom-fonts/) getting started guide for more details.
  * @package  Shotstack\Client
  * @author   OpenAPI Generator team
  * @link     https://openapi-generator.tech

src/Model/HtmlAsset.php

@@ -13,7 +13,7 @@
 /**
  * Shotstack
  *
- * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details check https://shotstack.io
+ * The Shotstack API is a video editing service that allows for the automated creation of videos using JSON. You can configure an edit and POST it to the Shotstack API which will render your video and provide a file location when complete. For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.gitbook.io/docs/guides/getting-started) documentation.
  *
  * The version of the OpenAPI document: v1
  * 
@@ -327,7 +327,7 @@ public function getHtml()
     /**
      * Sets html
      *
-     * @param string $html The HTML text string.
+     * @param string $html The HTML text string. See list of [supported HTML tags](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
      *
      * @return self
      */
@@ -351,7 +351,7 @@ public function getCss()
     /**
      * Sets css
      *
-     * @param string|null $css The CSS text string to apply styling to the HTML.
+     * @param string|null $css The CSS text string to apply styling to the HTML. See list of  [support CSS properties](https://shotstack.gitbook.io/docs/guides/architecting-an-application/html-support#supported-html-tags).
      *
      * @return self
      */
@@ -375,7 +375,7 @@ public function getWidth()
     /**
      * Sets width
      *
-     * @param int|null $width Set the width of the HTML asset bounding box. Text will wrap to fill the bounding box.
+     * @param int|null $width Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.
      *
      * @return self
      */
@@ -399,7 +399,7 @@ public function getHeight()
     /**
      * Sets height
      *
-     * @param int|null $height Set the width of the HTML asset bounding box. Text and elements will be masked if they exceed the  height of the bounding box.
+     * @param int|null $height Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the  height of the bounding box.
      *
      * @return self
      */