shotstack 0.2.1 → 0.2.6

data/lib/shotstack/api/create_api.rb

@@ -0,0 +1,158 @@
+=begin
+#Shotstack
+
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'cgi'
+
+module Shotstack
+  class CreateApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Generated Asset
+    # Get the generated assets status, url and details by ID.  **Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a> 
+    # @param id [String] The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format.
+    # @param [Hash] opts the optional parameters
+    # @return [GeneratedAssetResponse]
+    def get_generated_asset(id, opts = {})
+      data, _status_code, _headers = get_generated_asset_with_http_info(id, opts)
+      data
+    end
+
+    # Get Generated Asset
+    # Get the generated assets status, url and details by ID.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/create/{version}&lt;/a&gt; 
+    # @param id [String] The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GeneratedAssetResponse, Integer, Hash)>] GeneratedAssetResponse data, response status code and response headers
+    def get_generated_asset_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreateApi.get_generated_asset ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CreateApi.get_generated_asset"
+      end
+      pattern = Regexp.new(/^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$/)
+      if @api_client.config.client_side_validation && id !~ pattern
+        fail ArgumentError, "invalid value for 'id' when calling CreateApi.get_generated_asset, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/assets/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'GeneratedAssetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"CreateApi.get_generated_asset",
+        :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: CreateApi#get_generated_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Generate Asset
+    # Generate an asset using a Shotstack or third party provider. Chose the provider, type of asset and provide prompts, inputs and options to generate the asset. Once generated the asset can be used with the [Edit](#tocs_edit) API or downloaded.  **Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a> 
+    # @param generated_asset [GeneratedAsset] Generate an asset using the specified provider, type and options.
+    # @param [Hash] opts the optional parameters
+    # @return [GeneratedAssetResponse]
+    def post_generate_asset(generated_asset, opts = {})
+      data, _status_code, _headers = post_generate_asset_with_http_info(generated_asset, opts)
+      data
+    end
+
+    # Generate Asset
+    # Generate an asset using a Shotstack or third party provider. Chose the provider, type of asset and provide prompts, inputs and options to generate the asset. Once generated the asset can be used with the [Edit](#tocs_edit) API or downloaded.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/create/{version}&lt;/a&gt; 
+    # @param generated_asset [GeneratedAsset] Generate an asset using the specified provider, type and options.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GeneratedAssetResponse, Integer, Hash)>] GeneratedAssetResponse data, response status code and response headers
+    def post_generate_asset_with_http_info(generated_asset, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CreateApi.post_generate_asset ...'
+      end
+      # verify the required parameter 'generated_asset' is set
+      if @api_client.config.client_side_validation && generated_asset.nil?
+        fail ArgumentError, "Missing the required parameter 'generated_asset' when calling CreateApi.post_generate_asset"
+      end
+      # resource path
+      local_var_path = '/assets'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      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] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(generated_asset)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GeneratedAssetResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"CreateApi.post_generate_asset",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CreateApi#post_generate_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/shotstack/api/edit_api.rb

@@ -1,12 +1,12 @@
 =begin
 #Shotstack
 
-#Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.  You arrange and configure an edit and POST it to the API which will render your media and provide a file  location when complete.  For more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.  There are two main API's, one for editing and generating assets (Edit API) and one for managing hosted assets (Serve API).  The Edit API base URL is: <b>https://api.shotstack.io/{version}</b>  The Serve API base URL is: <b>https://api.shotstack.io/serve/{version}</b> 
+# Official Ruby SDK for the Shotstack Cloud Video Editing API
 
 The version of the OpenAPI document: v1
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+Generator version: 7.4.0
 
 =end
 
@@ -20,7 +20,7 @@ module Shotstack
       @api_client = api_client
     end
     # Delete Template
-    # Delete a template by its template id.  **Base URL:** https://api.shotstack.io/{version} 
+    # Delete a template by its template id.  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param id [String] The id of the template in UUID format
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -30,7 +30,7 @@ module Shotstack
     end
 
     # Delete Template
-    # Delete a template by its template id.  **Base URL:** https://api.shotstack.io/{version} 
+    # Delete a template by its template id.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @param id [String] The id of the template 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 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:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @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.&lt;br&gt;&lt;br&gt;&lt;b&gt;Note:&lt;/b&gt; the default is currently &#x60;true&#x60;, this is deprecated and the default will soon be &#x60;false&#x60;. If you rely on the data being returned in the response you should explicitly set the parameter to &#x60;true&#x60;.
@@ -98,7 +98,7 @@ 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:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @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.&lt;br&gt;&lt;br&gt;&lt;b&gt;Note:&lt;/b&gt; the default is currently &#x60;true&#x60;, this is deprecated and the default will soon be &#x60;false&#x60;. If you rely on the data being returned in the response you should explicitly set the parameter to &#x60;true&#x60;.
@@ -160,7 +160,7 @@ module Shotstack
     end
 
     # Retrieve Template
-    # Retrieve a template by template id.  **Base URL:** https://api.shotstack.io/{version} 
+    # Retrieve a template by template id.  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param id [String] The id of the template in UUID format
     # @param [Hash] opts the optional parameters
     # @return [TemplateDataResponse]
@@ -170,7 +170,7 @@ module Shotstack
     end
 
     # Retrieve Template
-    # Retrieve a template by template id.  **Base URL:** https://api.shotstack.io/{version} 
+    # Retrieve a template by template id.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @param id [String] The id of the template in UUID format
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateDataResponse, Integer, Hash)>] TemplateDataResponse data, response status code and response headers
@@ -228,7 +228,7 @@ module Shotstack
     end
 
     # List Templates
-    # Retrieve a list of templates stored against a users account. The API key is used to determine which templates are associated to the user.  **Base URL:** https://api.shotstack.io/{version} 
+    # Retrieve a list of templates stored against a users account and stage.  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param [Hash] opts the optional parameters
     # @return [TemplateListResponse]
     def get_templates(opts = {})
@@ -237,7 +237,7 @@ module Shotstack
     end
 
     # List Templates
-    # Retrieve a list of templates stored against a users account. The API key is used to determine which templates are associated to the user.  **Base URL:** https://api.shotstack.io/{version} 
+    # Retrieve a list of templates stored against a users account and stage.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateListResponse, Integer, Hash)>] TemplateListResponse data, response status code and response headers
     def get_templates_with_http_info(opts = {})
@@ -285,7 +285,7 @@ module Shotstack
     end
 
     # Render Asset
-    # Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.  **Base URL:** https://api.shotstack.io/{version} 
+    # Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param edit [Edit] The video, image or audio edit specified using JSON.
     # @param [Hash] opts the optional parameters
     # @return [QueuedResponse]
@@ -295,7 +295,7 @@ module Shotstack
     end
 
     # Render Asset
-    # Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.  **Base URL:** https://api.shotstack.io/{version} 
+    # Queue and render the contents of an [Edit](#tocs_edit) as a video, image or audio file.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @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
@@ -353,7 +353,7 @@ module Shotstack
     end
 
     # Create Template
-    # Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request.  **Base URL:** https://api.shotstack.io/{version} 
+    # Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request.  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param template [Template] Create a template with a name and [Edit](#tocs_edit).
     # @param [Hash] opts the optional parameters
     # @return [TemplateResponse]
@@ -363,7 +363,7 @@ module Shotstack
     end
 
     # Create Template
-    # Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request.  **Base URL:** https://api.shotstack.io/{version} 
+    # Save an [Edit](#tocs_edit) as a re-usable template. Templates can be retrieved and modified in your application before being rendered. [Merge fields](#tocs_mergefield) can be also used to merge data in to a template and [render](#render-template) it in a single request.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @param template [Template] Create a template with a name and [Edit](#tocs_edit).
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateResponse, Integer, Hash)>] TemplateResponse data, response status code and response headers
@@ -421,7 +421,7 @@ module Shotstack
     end
 
     # Render Template
-    # Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit).  **Base URL:** https://api.shotstack.io/{version} 
+    # Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit).  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param template_render [TemplateRender] Render a template by template id.
     # @param [Hash] opts the optional parameters
     # @return [QueuedResponse]
@@ -431,7 +431,7 @@ module Shotstack
     end
 
     # Render Template
-    # Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit).  **Base URL:** https://api.shotstack.io/{version} 
+    # Render an asset from a template id and optional merge fields. Merge fields can be used to replace placeholder variables within the [Edit](#tocs_edit).  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @param template_render [TemplateRender] Render a template by template id.
     # @param [Hash] opts the optional parameters
     # @return [Array<(QueuedResponse, Integer, Hash)>] QueuedResponse data, response status code and response headers
@@ -489,7 +489,7 @@ module Shotstack
     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} 
+    # 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:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param url [String] The URL of the media to inspect, must be **URL encoded**.
     # @param [Hash] opts the optional parameters
     # @return [ProbeResponse]
@@ -499,7 +499,7 @@ module Shotstack
     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} 
+    # 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:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @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
@@ -552,7 +552,7 @@ module Shotstack
     end
 
     # Update Template
-    # Update an existing template by template id.  **Base URL:** https://api.shotstack.io/{version} 
+    # Update an existing template by template id.  **Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a> 
     # @param id [String] The id of the template in UUID format
     # @param template [Template] Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved.
     # @param [Hash] opts the optional parameters
@@ -563,7 +563,7 @@ module Shotstack
     end
 
     # Update Template
-    # Update an existing template by template id.  **Base URL:** https://api.shotstack.io/{version} 
+    # Update an existing template by template id.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/edit/{version}&lt;/a&gt; 
     # @param id [String] The id of the template in UUID format
     # @param template [Template] Update an individual templates name and [Edit](#tocs_edit). Both template name and template must be provided. If the template parameter is omitted a blank template will be saved.
     # @param [Hash] opts the optional parameters