Merge pull request #6 from shotstack/slide-carousel-blur-docs-updates

Add new slide and carousel transitions, blur effect and docs update

src/Api/EndpointsApi.php

@@ -118,6 +118,8 @@ public function getConfig()
     /**
      * Operation getRender
      *
+     * Get Render Status
+     *
      * @param  string $id The id of the timeline render task in UUID format (required)
      *
      * @throws \Shotstack\Client\ApiException on non-2xx response
@@ -133,6 +135,8 @@ public function getRender($id)
     /**
      * Operation getRenderWithHttpInfo
      *
+     * Get Render Status
+     *
      * @param  string $id The id of the timeline render task in UUID format (required)
      *
      * @throws \Shotstack\Client\ApiException on non-2xx response
@@ -219,7 +223,7 @@ public function getRenderWithHttpInfo($id)
     /**
      * Operation getRenderAsync
      *
-     * 
+     * Get Render Status
      *
      * @param  string $id The id of the timeline render task in UUID format (required)
      *
@@ -239,7 +243,7 @@ function ($response) {
     /**
      * Operation getRenderAsyncWithHttpInfo
      *
-     * 
+     * Get Render Status
      *
      * @param  string $id The id of the timeline render task in UUID format (required)
      *
@@ -395,30 +399,36 @@ protected function getRenderRequest($id)
     /**
      * Operation postRender
      *
-     * @param  \Shotstack\Client\Model\Edit $edit edit (required)
+     * Render Video
+     *
+     * @param  \Shotstack\Client\Model\Edit $edit The video edit specified using JSON. (required)
+     * @param  string $x_api_queue_id The id of a dedicated queue (enterprise customers only). (optional)
      *
      * @throws \Shotstack\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return \Shotstack\Client\Model\QueuedResponse
      */
-    public function postRender($edit)
+    public function postRender($edit, $x_api_queue_id = null)
     {
-        list($response) = $this->postRenderWithHttpInfo($edit);
+        list($response) = $this->postRenderWithHttpInfo($edit, $x_api_queue_id);
         return $response;
     }
 
     /**
      * Operation postRenderWithHttpInfo
      *
-     * @param  \Shotstack\Client\Model\Edit $edit (required)
+     * Render Video
+     *
+     * @param  \Shotstack\Client\Model\Edit $edit The video edit specified using JSON. (required)
+     * @param  string $x_api_queue_id The id of a dedicated queue (enterprise customers only). (optional)
      *
      * @throws \Shotstack\Client\ApiException on non-2xx response
      * @throws \InvalidArgumentException
      * @return array of \Shotstack\Client\Model\QueuedResponse, HTTP status code, HTTP response headers (array of strings)
      */
-    public function postRenderWithHttpInfo($edit)
+    public function postRenderWithHttpInfo($edit, $x_api_queue_id = null)
     {
-        $request = $this->postRenderRequest($edit);
+        $request = $this->postRenderRequest($edit, $x_api_queue_id);
 
         try {
             $options = $this->createHttpClientOption();
@@ -496,16 +506,17 @@ public function postRenderWithHttpInfo($edit)
     /**
      * Operation postRenderAsync
      *
-     * 
+     * Render Video
      *
-     * @param  \Shotstack\Client\Model\Edit $edit (required)
+     * @param  \Shotstack\Client\Model\Edit $edit The video edit specified using JSON. (required)
+     * @param  string $x_api_queue_id The id of a dedicated queue (enterprise customers only). (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function postRenderAsync($edit)
+    public function postRenderAsync($edit, $x_api_queue_id = null)
     {
-        return $this->postRenderAsyncWithHttpInfo($edit)
+        return $this->postRenderAsyncWithHttpInfo($edit, $x_api_queue_id)
             ->then(
                 function ($response) {
                     return $response[0];
@@ -516,17 +527,18 @@ function ($response) {
     /**
      * Operation postRenderAsyncWithHttpInfo
      *
-     * 
+     * Render Video
      *
-     * @param  \Shotstack\Client\Model\Edit $edit (required)
+     * @param  \Shotstack\Client\Model\Edit $edit The video edit specified using JSON. (required)
+     * @param  string $x_api_queue_id The id of a dedicated queue (enterprise customers only). (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function postRenderAsyncWithHttpInfo($edit)
+    public function postRenderAsyncWithHttpInfo($edit, $x_api_queue_id = null)
     {
         $returnType = '\Shotstack\Client\Model\QueuedResponse';
-        $request = $this->postRenderRequest($edit);
+        $request = $this->postRenderRequest($edit, $x_api_queue_id);
 
         return $this->client
             ->sendAsync($request, $this->createHttpClientOption())
@@ -565,12 +577,13 @@ function ($exception) {
     /**
      * Create request for operation 'postRender'
      *
-     * @param  \Shotstack\Client\Model\Edit $edit (required)
+     * @param  \Shotstack\Client\Model\Edit $edit The video edit specified using JSON. (required)
+     * @param  string $x_api_queue_id The id of a dedicated queue (enterprise customers only). (optional)
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Psr7\Request
      */
-    protected function postRenderRequest($edit)
+    protected function postRenderRequest($edit, $x_api_queue_id = null)
     {
         // verify the required parameter 'edit' is set
         if ($edit === null || (is_array($edit) && count($edit) === 0)) {
@@ -586,6 +599,10 @@ protected function postRenderRequest($edit)
         $httpBody = '';
         $multipart = false;
 
+        // header params
+        if ($x_api_queue_id !== null) {
+            $headerParams['x-api-queue-id'] = ObjectSerializer::toHeaderValue($x_api_queue_id);
+        }
 
 
         // body params

src/Model/AudioAsset.php

@@ -196,7 +196,7 @@ public function __construct(array $data = null)
         $this->container['type'] = isset($data['type']) ? $data['type'] : 'audio';
         $this->container['src'] = isset($data['src']) ? $data['src'] : null;
         $this->container['trim'] = isset($data['trim']) ? $data['trim'] : null;
-        $this->container['volume'] = isset($data['volume']) ? $data['volume'] : null;
+        $this->container['volume'] = isset($data['volume']) ? $data['volume'] : 1;
     }
 
     /**
@@ -242,7 +242,7 @@ public function getType()
     /**
      * Sets type
      *
-     * @param string $type The type of asset - set to <b>audio</b> for audio assets.
+     * @param string $type The type of asset - set to `audio` for audio assets.
      *
      * @return $this
      */

src/Model/Clip.php

@@ -228,6 +228,7 @@ 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';
@@ -298,6 +299,7 @@ public function getEffectAllowableValues()
     public function getFilterAllowableValues()
     {
         return [
+            self::FILTER_BLUR,
             self::FILTER_BOOST,
             self::FILTER_CONTRAST,
             self::FILTER_DARKEN,
@@ -334,7 +336,7 @@ public function __construct(array $data = null)
         $this->container['transition'] = isset($data['transition']) ? $data['transition'] : null;
         $this->container['effect'] = isset($data['effect']) ? $data['effect'] : null;
         $this->container['filter'] = isset($data['filter']) ? $data['filter'] : null;
-        $this->container['opacity'] = isset($data['opacity']) ? $data['opacity'] : null;
+        $this->container['opacity'] = isset($data['opacity']) ? $data['opacity'] : 1;
     }
 
     /**
@@ -544,7 +546,7 @@ public function getPosition()
     /**
      * Sets position
      *
-     * @param string|null $position Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position.
+     * @param string|null $position Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position. <ul>   <li>`top` - top (center)</li>   <li>`topRight` - top right</li>   <li>`right` - right (center)</li>   <li>`bottomRight` - bottom right</li>   <li>`bottom` - bottom (center)</li>   <li>`bottomLeft` - bottom left</li>   <li>`left` - left (center)</li>   <li>`topLeft` - top left</li>   <li>`center` - center</li> </ul>
      *
      * @return $this
      */
@@ -625,7 +627,7 @@ public function getEffect()
     /**
      * Sets effect
      *
-     * @param string|null $effect A motion effect to apply to the Clip.
+     * @param string|null $effect A motion effect to apply to the Clip. <ul>   <li>`zoomIn` - slow zoom in</li>   <li>`zoomOut` - slow zoom out</li>   <li>`slideLeft` - slow slide (pan) left</li>   <li>`slideRight` - slow slide (pan) right</li>   <li>`slideUp` - slow slide (pan) up</li>   <li>`slideDown` - slow slide (pan) down</li> </ul>
      *
      * @return $this
      */
@@ -658,7 +660,7 @@ public function getFilter()
     /**
      * Sets filter
      *
-     * @param string|null $filter A filter effect to apply to the Clip.
+     * @param string|null $filter A filter effect to apply to the Clip. <ul>   <li>`blur` - blurs the image or video</li>   <li>`boost` - boost contrast and saturation</li>   <li>`contrast` - increase contrast</li>   <li>`darken` - darken the scene</li>   <li>`greyscale` - remove colour</li>   <li>`lighten` - lighten the scene</li>   <li>`muted` - reduce saturation and contrast</li>   <li>`invert` - invert colors</li> </ul>
      *
      * @return $this
      */

src/Model/HtmlAsset.php

@@ -297,7 +297,7 @@ public function getType()
     /**
      * Sets type
      *
-     * @param string $type The type of asset - set to <b>html</b> for HTML.
+     * @param string $type The type of asset - set to `html` for HTML.
      *
      * @return $this
      */
@@ -441,7 +441,7 @@ public function getPosition()
     /**
      * Sets position
      *
-     * @param string|null $position Place the HTML in one of nine predefined positions within the HTML area.
+     * @param string|null $position Place the HTML in one of nine predefined positions within the HTML area. <ul>   <li>`top` - top (center)</li>   <li>`topRight` - top right</li>   <li>`right` - right (center)</li>   <li>`bottomRight` - bottom right</li>   <li>`bottom` - bottom (center)</li>   <li>`bottomLeft` - bottom left</li>   <li>`left` - left (center)</li>   <li>`topLeft` - top left</li>   <li>`center` - center</li> </ul>
      *
      * @return $this
      */

src/Model/ImageAsset.php

@@ -230,7 +230,7 @@ public function getType()
     /**
      * Sets type
      *
-     * @param string $type The type of asset - set to <b>image</b> for images.
+     * @param string $type The type of asset - set to `image` for images.
      *
      * @return $this
      */

src/Model/LumaAsset.php

@@ -236,7 +236,7 @@ public function getType()
     /**
      * Sets type
      *
-     * @param string $type The type of asset - set to <b>luma</b> for luma mattes.
+     * @param string $type The type of asset - set to `luma` for luma mattes.
      *
      * @return $this
      */

src/Model/Offset.php

@@ -183,8 +183,8 @@ public function getModelName()
      */
     public function __construct(array $data = null)
     {
-        $this->container['x'] = isset($data['x']) ? $data['x'] : null;
-        $this->container['y'] = isset($data['y']) ? $data['y'] : null;
+        $this->container['x'] = isset($data['x']) ? $data['x'] : 0;
+        $this->container['y'] = isset($data['y']) ? $data['y'] : 0;
     }
 
     /**

src/Model/Output.php

@@ -185,7 +185,6 @@ public function getModelName()
     }
 
     const FORMAT_MP4 = 'mp4';
-    const FORMAT_WEBM = 'webm';
     const FORMAT_GIF = 'gif';
     const RESOLUTION_PREVIEW = 'preview';
     const RESOLUTION_MOBILE = 'mobile';
@@ -212,7 +211,6 @@ public function getFormatAllowableValues()
     {
         return [
             self::FORMAT_MP4,
-            self::FORMAT_WEBM,
             self::FORMAT_GIF,
         ];
     }
@@ -362,7 +360,7 @@ public function getFormat()
     /**
      * Sets format
      *
-     * @param string $format `mp4`, `webm` video or animated `gif`
+     * @param string $format `mp4` video or animated `gif`
      *
      * @return $this
      */

src/Model/QueuedResponse.php

@@ -238,7 +238,7 @@ public function getSuccess()
     /**
      * Sets success
      *
-     * @param bool $success success
+     * @param bool $success `true` if successfully queued, else `false`.
      *
      * @return $this
      */
@@ -262,7 +262,7 @@ public function getMessage()
     /**
      * Sets message
      *
-     * @param string $message message
+     * @param string $message `Created`, `Bad Request` or an error message.
      *
      * @return $this
      */

src/Model/QueuedResponseData.php

@@ -229,7 +229,7 @@ public function getMessage()
     /**
      * Sets message
      *
-     * @param string $message Success response message
+     * @param string $message Success response message or error details.
      *
      * @return $this
      */
@@ -253,7 +253,7 @@ public function getId()
     /**
      * Sets id
      *
-     * @param string $id The id of the render task in UUID format
+     * @param string $id The id of the render task in UUID format.
      *
      * @return $this
      */

src/Model/RenderResponse.php

@@ -238,7 +238,7 @@ public function getSuccess()
     /**
      * Sets success
      *
-     * @param bool $success success
+     * @param bool $success `true` if status available, else `false`.
      *
      * @return $this
      */
@@ -262,7 +262,7 @@ public function getMessage()
     /**
      * Sets message
      *
-     * @param string $message message
+     * @param string $message `OK` or an error message.
      *
      * @return $this
      */