shotstack 0.1.8 → 0.1.11

data/lib/shotstack/api/edit_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -20,9 +20,11 @@ module Shotstack
       @api_client = api_client
     end
     # Get Render Status
-    # Get the rendering status, temporary asset url and details of a render by ID.  **base URL:** https://api.shotstack.io/{version}
+    # Get the rendering status, temporary asset url and details of a render by ID.  **Base URL:** https://api.shotstack.io/{version}
     # @param id [String] The id of the timeline render task in UUID format
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :data Include the data parameter in the response. The data parameter includes the original timeline, output and other settings sent to the API.<br><br><b>Note:</b> the default is currently `true`, this is deprecated and the default will soon be `false`. If you rely on the data being returned in the response you should explicitly set the parameter to `true`.
+    # @option opts [Boolean] :merged Used when data is set to true, it will show the [merge fields](#tocs_mergefield) merged in to the data response.
     # @return [RenderResponse]
     def get_render(id, opts = {})
       data, _status_code, _headers = get_render_with_http_info(id, opts)
@@ -30,9 +32,11 @@ module Shotstack
     end
 
     # Get Render Status
-    # Get the rendering status, temporary asset url and details of a render by ID.  **base URL:** https://api.shotstack.io/{version}
+    # Get the rendering status, temporary asset url and details of a render by ID.  **Base URL:** https://api.shotstack.io/{version}
     # @param id [String] The id of the timeline render task in UUID format
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :data Include the data parameter in the response. The data parameter includes the original timeline, output and other settings sent to the API.<br><br><b>Note:</b> the default is currently `true`, this is deprecated and the default will soon be `false`. If you rely on the data being returned in the response you should explicitly set the parameter to `true`.
+    # @option opts [Boolean] :merged Used when data is set to true, it will show the [merge fields](#tocs_mergefield) merged in to the data response.
     # @return [Array<(RenderResponse, Integer, Hash)>] RenderResponse data, response status code and response headers
     def get_render_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -52,6 +56,8 @@ module Shotstack
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'data'] = opts[:'data'] if !opts[:'data'].nil?
+      query_params[:'merged'] = opts[:'merged'] if !opts[:'merged'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -88,8 +94,8 @@ module Shotstack
     end
 
     # Render Asset
-    # Queue and render the contents of a timeline as a video, image or audio file.
-    # @param edit [Edit] The video, image or audio edit specified using JSON.  **base URL:** https://api.shotstack.io/{version}
+    # Queue and render the contents of a timeline as a video, image or audio file.  **Base URL:** https://api.shotstack.io/{version}
+    # @param edit [Edit] The video, image or audio edit specified using JSON.
     # @param [Hash] opts the optional parameters
     # @return [QueuedResponse]
     def post_render(edit, opts = {})
@@ -98,8 +104,8 @@ module Shotstack
     end
 
     # Render Asset
-    # Queue and render the contents of a timeline as a video, image or audio file.
-    # @param edit [Edit] The video, image or audio edit specified using JSON.  **base URL:** https://api.shotstack.io/{version}
+    # Queue and render the contents of a timeline as a video, image or audio file.  **Base URL:** https://api.shotstack.io/{version}
+    # @param edit [Edit] The video, image or audio edit specified using JSON.
     # @param [Hash] opts the optional parameters
     # @return [Array<(QueuedResponse, Integer, Hash)>] QueuedResponse data, response status code and response headers
     def post_render_with_http_info(edit, opts = {})
@@ -121,7 +127,10 @@ module Shotstack
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -151,5 +160,68 @@ module Shotstack
       end
       return data, status_code, headers
     end
+
+    # Inspect Media
+    # Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc...  **Base URL:** https://api.shotstack.io/{version}
+    # @param url [String] The URL of the media to inspect, must be **URL encoded**.
+    # @param [Hash] opts the optional parameters
+    # @return [ProbeResponse]
+    def probe(url, opts = {})
+      data, _status_code, _headers = probe_with_http_info(url, opts)
+      data
+    end
+
+    # Inspect Media
+    # Inspects any media asset (image, video, audio) on the internet using a hosted version of [FFprobe](https://ffmpeg.org/ffprobe.html). The probe endpoint returns useful information about an asset such as width, height, duration, rotation, framerate, etc...  **Base URL:** https://api.shotstack.io/{version}
+    # @param url [String] The URL of the media to inspect, must be **URL encoded**.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProbeResponse, Integer, Hash)>] ProbeResponse data, response status code and response headers
+    def probe_with_http_info(url, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EditApi.probe ...'
+      end
+      # verify the required parameter 'url' is set
+      if @api_client.config.client_side_validation && url.nil?
+        fail ArgumentError, "Missing the required parameter 'url' when calling EditApi.probe"
+      end
+      # resource path
+      local_var_path = '/probe/{url}'.sub('{' + 'url' + '}', CGI.escape(url.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ProbeResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"EditApi.probe",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EditApi#probe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/shotstack/api/serve_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -20,7 +20,7 @@ module Shotstack
       @api_client = api_client
     end
     # Delete Asset
-    # Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id.  **base URL:** https://api.shotstack.io/serve/{version}
+    # Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id.  **Base URL:** https://api.shotstack.io/serve/{version}
     # @param id [String] The id of the asset in UUID format
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -30,7 +30,7 @@ module Shotstack
     end
 
     # Delete Asset
-    # Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id.  **base URL:** https://api.shotstack.io/serve/{version}
+    # Delete an asset by its asset id. If a render creates multiple assets, such as thumbnail and poster images, each asset must be deleted individually by the asset id.  **Base URL:** https://api.shotstack.io/serve/{version}
     # @param id [String] The id of the asset in UUID format
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -86,7 +86,7 @@ module Shotstack
     end
 
     # Get Asset
-    # The Serve API is used to interact with, and delete hosted assets including videos, images, audio files,  thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id.  **base URL:** https://api.shotstack.io/serve/{version}
+    # The Serve API is used to interact with, and delete hosted assets including videos, images, audio files,  thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id.  **Base URL:** https://api.shotstack.io/serve/{version}
     # @param id [String] The id of the asset in UUID format
     # @param [Hash] opts the optional parameters
     # @return [AssetResponse]
@@ -96,7 +96,7 @@ module Shotstack
     end
 
     # Get Asset
-    # The Serve API is used to interact with, and delete hosted assets including videos, images, audio files,  thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id.  **base URL:** https://api.shotstack.io/serve/{version}
+    # The Serve API is used to interact with, and delete hosted assets including videos, images, audio files,  thumbnails and poster images. Use this endpoint to fetch an asset by asset id. Note that an asset id is unique for each asset and different from the render id.  **Base URL:** https://api.shotstack.io/serve/{version}
     # @param id [String] The id of the asset in UUID format
     # @param [Hash] opts the optional parameters
     # @return [Array<(AssetResponse, Integer, Hash)>] AssetResponse data, response status code and response headers
@@ -154,7 +154,7 @@ module Shotstack
     end
 
     # Get Asset by Render ID
-    # A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status  request or webhook. This endpoint lets you look up one or more assets by the render id.  **base URL:** https://api.shotstack.io/serve/{version}
+    # A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status  request or webhook. This endpoint lets you look up one or more assets by the render id.  **Base URL:** https://api.shotstack.io/serve/{version}
     # @param id [String] The render id associated with the asset in UUID format
     # @param [Hash] opts the optional parameters
     # @return [AssetRenderResponse]
@@ -164,7 +164,7 @@ module Shotstack
     end
 
     # Get Asset by Render ID
-    # A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status  request or webhook. This endpoint lets you look up one or more assets by the render id.  **base URL:** https://api.shotstack.io/serve/{version}
+    # A render may generate more than one file, such as a video, thumbnail and poster image. When the assets are created the only known id is the render id returned by the original [render request](#render-video), status  request or webhook. This endpoint lets you look up one or more assets by the render id.  **Base URL:** https://api.shotstack.io/serve/{version}
     # @param id [String] The render id associated with the asset in UUID format
     # @param [Hash] opts the optional parameters
     # @return [Array<(AssetRenderResponse, Integer, Hash)>] AssetRenderResponse data, response status code and response headers

data/lib/shotstack/api_client.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -296,7 +296,7 @@ module Shotstack
       @config.base_url(opts[:operation]) + path
     end
 
-    # Update hearder and query params based on authentication settings.
+    # Update header and query params based on authentication settings.
     #
     # @param [Hash] header_params Header parameters
     # @param [Hash] query_params Query parameters
@@ -308,7 +308,7 @@ module Shotstack
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
         when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end

data/lib/shotstack/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -147,13 +147,13 @@ module Shotstack
       @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
-      @timeout = 0
       @client_side_validation = true
       @verify_ssl = true
       @verify_ssl_host = true
       @params_encoding = nil
       @cert_file = nil
       @key_file = nil
+      @timeout = 0
       @debugging = false
       @inject_format = false
       @force_ending_format = false
@@ -197,11 +197,13 @@ module Shotstack
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
@@ -295,5 +297,6 @@ module Shotstack
 
       url
     end
+
   end
 end

data/lib/shotstack/models/asset_render_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/models/asset_response.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/models/asset_response_attributes.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/models/asset_response_data.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/models/audio_asset.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/models/clip.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -16,7 +16,7 @@ require 'time'
 module Shotstack
   # A clip is a container for a specific type of asset, i.e. a title, image, video, audio or html. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it.
   class Clip
-    # The type of asset to display for the duration of this Clip. Value must be one of <b>TitleAsset</b>, <b>ImageAsset</b>, <b>VideoAsset</b>, <b>HtmlAsset</b>, <b>AudioAsset</b> or <b>LumaAsset</b>
+    # The type of asset to display for the duration of this Clip. Value must be one of:   <ul>     <li><a href=\"#tocs_videoasset\">VideoAsset</a></li>     <li><a href=\"#tocs_imageasset\">ImageAsset</a></li>     <li><a href=\"#tocs_titleasset\">TitleAsset</a></li>     <li><a href=\"#tocs_htmlasset\">HtmlAsset</a></li>     <li><a href=\"#tocs_audioasset\">AudioAsset</a></li>     <li><a href=\"#tocs_lumaasset\">LumaAsset</a></li>   </ul>
     attr_accessor :asset
 
     # The start position of the Clip on the timeline, in seconds.
@@ -47,6 +47,8 @@ module Shotstack
     # Sets the opacity of the Clip where 1 is opaque and 0 is transparent.
     attr_accessor :opacity
 
+    attr_accessor :transform
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -82,7 +84,8 @@ module Shotstack
         :'transition' => :'transition',
         :'effect' => :'effect',
         :'filter' => :'filter',
-        :'opacity' => :'opacity'
+        :'opacity' => :'opacity',
+        :'transform' => :'transform'
       }
     end
 
@@ -104,7 +107,8 @@ module Shotstack
         :'transition' => :'Transition',
         :'effect' => :'String',
         :'filter' => :'String',
-        :'opacity' => :'Float'
+        :'opacity' => :'Float',
+        :'transform' => :'Transformation'
       }
     end
 
@@ -178,6 +182,10 @@ module Shotstack
       else
         self.opacity = 1
       end
+
+      if attributes.key?(:'transform')
+        self.transform = attributes[:'transform']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -271,7 +279,8 @@ module Shotstack
           transition == o.transition &&
           effect == o.effect &&
           filter == o.filter &&
-          opacity == o.opacity
+          opacity == o.opacity &&
+          transform == o.transform
     end
 
     # @see the `==` method
@@ -283,7 +292,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [asset, start, length, fit, scale, position, offset, transition, effect, filter, opacity].hash
+      [asset, start, length, fit, scale, position, offset, transition, effect, filter, opacity, transform].hash
     end
 
     # Builds the object from hash

data/lib/shotstack/models/crop.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 

data/lib/shotstack/models/edit.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0
+OpenAPI Generator version: 5.4.0
 
 =end
 
@@ -20,6 +20,9 @@ module Shotstack
 
     attr_accessor :output
 
+    # An array of key/value pairs that provides an easy way to create templates with placeholders. The placeholders can be used to find and replace keys with values. For example you can search for the placeholder `{{NAME}}` and replace it with the value `Jane`. 
+    attr_accessor :merge
+
     # 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.
     attr_accessor :callback
 
@@ -53,6 +56,7 @@ module Shotstack
       {
         :'timeline' => :'timeline',
         :'output' => :'output',
+        :'merge' => :'merge',
         :'callback' => :'callback',
         :'disk' => :'disk'
       }
@@ -68,6 +72,7 @@ module Shotstack
       {
         :'timeline' => :'Timeline',
         :'output' => :'Output',
+        :'merge' => :'Array<MergeField>',
         :'callback' => :'String',
         :'disk' => :'String'
       }
@@ -102,6 +107,12 @@ module Shotstack
         self.output = attributes[:'output']
       end
 
+      if attributes.key?(:'merge')
+        if (value = attributes[:'merge']).is_a?(Array)
+          self.merge = value
+        end
+      end
+
       if attributes.key?(:'callback')
         self.callback = attributes[:'callback']
       end
@@ -155,6 +166,7 @@ module Shotstack
       self.class == o.class &&
           timeline == o.timeline &&
           output == o.output &&
+          merge == o.merge &&
           callback == o.callback &&
           disk == o.disk
     end
@@ -168,7 +180,7 @@ module Shotstack
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [timeline, output, callback, disk].hash
+      [timeline, output, merge, callback, disk].hash
     end
 
     # Builds the object from hash