shotstack 0.2.2 → 0.2.6

data/lib/shotstack/api/ingest_api.rb

@@ -0,0 +1,338 @@
+=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 IngestApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete Source
+    # Delete an ingested source file by its id.  **Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{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 [nil]
+    def delete_source(id, opts = {})
+      delete_source_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete Source
+    # Delete an ingested source file by its id.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/ingest/{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<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_source_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IngestApi.delete_source ...'
+      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 IngestApi.delete_source"
+      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 IngestApi.delete_source, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"IngestApi.delete_source",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IngestApi#delete_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Source
+    # Fetch a source file details and status by its id.  **Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{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 [SourceResponse]
+    def get_source(id, opts = {})
+      data, _status_code, _headers = get_source_with_http_info(id, opts)
+      data
+    end
+
+    # Get Source
+    # Fetch a source file details and status by its id.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/ingest/{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<(SourceResponse, Integer, Hash)>] SourceResponse data, response status code and response headers
+    def get_source_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IngestApi.get_source ...'
+      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 IngestApi.get_source"
+      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 IngestApi.get_source, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/sources/{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] || 'SourceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"IngestApi.get_source",
+        :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: IngestApi#get_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Sources
+    # Retrieve a list of ingested source files stored against a users account and stage.  **Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a> 
+    # @param [Hash] opts the optional parameters
+    # @return [SourceListResponse]
+    def get_sources(opts = {})
+      data, _status_code, _headers = get_sources_with_http_info(opts)
+      data
+    end
+
+    # List Sources
+    # Retrieve a list of ingested source files stored against a users account and stage.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/ingest/{version}&lt;/a&gt; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SourceListResponse, Integer, Hash)>] SourceListResponse data, response status code and response headers
+    def get_sources_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IngestApi.get_sources ...'
+      end
+      # resource path
+      local_var_path = '/sources'
+
+      # 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] || 'SourceListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"IngestApi.get_sources",
+        :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: IngestApi#get_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Direct Upload
+    # Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to. The signed URL looks similar to:  https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId=ASIAWJV7UWDMGTZLHTXP&Expires=1677209777&Signature=PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&x-amz-acl=public-read&x-amz-security-token=IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR  In a separate API call, use this signed URL to send a PUT request with the binary file. Using  cURL you can use a command like:      `curl -X PUT -T video.mp4 {data.attributes.url}`      Where **video.mp4** is the file you want to upload and **{data.attributes.url}** is the signed URL returned in the response. The request must be a PUT type.  The SDK does not currently support the PUT request. You can use the SDK to make the request for the signed URL and then use cURL to make the PUT request.  **Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a> 
+    # @param [Hash] opts the optional parameters
+    # @return [UploadResponse]
+    def get_upload_signed_url(opts = {})
+      data, _status_code, _headers = get_upload_signed_url_with_http_info(opts)
+      data
+    end
+
+    # Direct Upload
+    # Request a signed URL to upload a file to. The response returns a signed URL that you use to upload the file to. The signed URL looks similar to:  https://shotstack-ingest-api-stage-sources.s3.ap-southeast-2.amazonaws.com/5ca6hu7s9k/zzytey4v-32km-kq1z-aftr-3kcuqi0brad2/source?AWSAccessKeyId&#x3D;ASIAWJV7UWDMGTZLHTXP&amp;Expires&#x3D;1677209777&amp;Signature&#x3D;PKR4dGDDdOuMTAQmDASzLGmLOeo%3D&amp;x-amz-acl&#x3D;public-read&amp;x-amz-security-token&#x3D;IQoJb3JpZ2luX2VjEGMaDmFwLX......56osBGByztm7WZdbmXzO09KR  In a separate API call, use this signed URL to send a PUT request with the binary file. Using  cURL you can use a command like:      &#x60;curl -X PUT -T video.mp4 {data.attributes.url}&#x60;      Where **video.mp4** is the file you want to upload and **{data.attributes.url}** is the signed URL returned in the response. The request must be a PUT type.  The SDK does not currently support the PUT request. You can use the SDK to make the request for the signed URL and then use cURL to make the PUT request.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/ingest/{version}&lt;/a&gt; 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UploadResponse, Integer, Hash)>] UploadResponse data, response status code and response headers
+    def get_upload_signed_url_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IngestApi.get_upload_signed_url ...'
+      end
+      # resource path
+      local_var_path = '/upload'
+
+      # 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] || 'UploadResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"IngestApi.get_upload_signed_url",
+        :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: IngestApi#get_upload_signed_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Fetch Source
+    # Queue a source file to be fetched from a URL and stored by Shotstack. Source files can be videos, images, audio files and fonts. Once ingested, new [output renditions](#tocs_outputs) can be created from the source file.  **Base URL:** <a href=\"#\">https://api.shotstack.io/ingest/{version}</a> 
+    # @param source [Source] Ingest a video, image, audio or font file from the provided URL. Optionally provide a list of output renditions.
+    # @param [Hash] opts the optional parameters
+    # @return [QueuedSourceResponse]
+    def post_source(source, opts = {})
+      data, _status_code, _headers = post_source_with_http_info(source, opts)
+      data
+    end
+
+    # Fetch Source
+    # Queue a source file to be fetched from a URL and stored by Shotstack. Source files can be videos, images, audio files and fonts. Once ingested, new [output renditions](#tocs_outputs) can be created from the source file.  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/ingest/{version}&lt;/a&gt; 
+    # @param source [Source] Ingest a video, image, audio or font file from the provided URL. Optionally provide a list of output renditions.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(QueuedSourceResponse, Integer, Hash)>] QueuedSourceResponse data, response status code and response headers
+    def post_source_with_http_info(source, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IngestApi.post_source ...'
+      end
+      # verify the required parameter 'source' is set
+      if @api_client.config.client_side_validation && source.nil?
+        fail ArgumentError, "Missing the required parameter 'source' when calling IngestApi.post_source"
+      end
+      # resource path
+      local_var_path = '/sources'
+
+      # 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(source)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'QueuedSourceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"IngestApi.post_source",
+        :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: IngestApi#post_source\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

@@ -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 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:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a> 
     # @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:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/serve/{version}&lt;/a&gt; 
     # @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:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a> 
     # @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:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/serve/{version}&lt;/a&gt; 
     # @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:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a> 
     # @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:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/serve/{version}&lt;/a&gt; 
     # @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
@@ -220,5 +220,73 @@ module Shotstack
       end
       return data, status_code, headers
     end
+
+    # Transfer Asset
+    # Transfer a file from any publicly available URL to one or more Serve API [destinations](#tocs_destinations).  **Base URL:** <a href=\"#\">https://api.shotstack.io/serve/{version}</a> 
+    # @param transfer [Transfer] Fetch an asset from a URL and send it to one or more destinations.
+    # @param [Hash] opts the optional parameters
+    # @return [TransferResponse]
+    def post_serve_asset(transfer, opts = {})
+      data, _status_code, _headers = post_serve_asset_with_http_info(transfer, opts)
+      data
+    end
+
+    # Transfer Asset
+    # Transfer a file from any publicly available URL to one or more Serve API [destinations](#tocs_destinations).  **Base URL:** &lt;a href&#x3D;\&quot;#\&quot;&gt;https://api.shotstack.io/serve/{version}&lt;/a&gt; 
+    # @param transfer [Transfer] Fetch an asset from a URL and send it to one or more destinations.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TransferResponse, Integer, Hash)>] TransferResponse data, response status code and response headers
+    def post_serve_asset_with_http_info(transfer, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ServeApi.post_serve_asset ...'
+      end
+      # verify the required parameter 'transfer' is set
+      if @api_client.config.client_side_validation && transfer.nil?
+        fail ArgumentError, "Missing the required parameter 'transfer' when calling ServeApi.post_serve_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(transfer)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TransferResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['DeveloperKey']
+
+      new_options = opts.merge(
+        :operation => :"ServeApi.post_serve_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: ServeApi#post_serve_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/shotstack/api_client.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
 
@@ -17,6 +17,7 @@ require 'tempfile'
 require 'time'
 require 'typhoeus'
 
+
 module Shotstack
   class ApiClient
     # The Configuration object holding settings to be used in the API client.
@@ -45,9 +46,10 @@ module Shotstack
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
-    #   the data deserialized from response body (could be nil), response status code and response headers.
+    #   the data deserialized from response body (may be a Tempfile or nil), response status code and response headers.
     def call_api(http_method, path, opts = {})
       request = build_request(http_method, path, opts)
+      tempfile = download_file(request) if opts[:return_type] == 'File'
       response = request.run
 
       if @config.debugging
@@ -69,7 +71,9 @@ module Shotstack
         end
       end
 
-      if opts[:return_type]
+      if opts[:return_type] == 'File'
+        data = tempfile
+      elsif opts[:return_type]
         data = deserialize(response, opts[:return_type])
       else
         data = nil
@@ -93,6 +97,7 @@ module Shotstack
       header_params = @default_headers.merge(opts[:header_params] || {})
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
+      follow_location = opts[:follow_location] || true
 
       update_params_for_auth! header_params, query_params, opts[:auth_names]
 
@@ -109,7 +114,8 @@ module Shotstack
         :ssl_verifyhost => _verify_ssl_host,
         :sslcert => @config.cert_file,
         :sslkey => @config.key_file,
-        :verbose => @config.debugging
+        :verbose => @config.debugging,
+        :followlocation => follow_location
       }
 
       # set custom cert, if provided
@@ -123,9 +129,7 @@ module Shotstack
         end
       end
 
-      request = Typhoeus::Request.new(url, req_opts)
-      download_file(request) if opts[:return_type] == 'File'
-      request
+      Typhoeus::Request.new(url, req_opts)
     end
 
     # Builds the HTTP request body
@@ -163,6 +167,8 @@ module Shotstack
     # process can use.
     #
     # @see Configuration#temp_folder_path
+    #
+    # @return [Tempfile] the tempfile generated
     def download_file(request)
       tempfile = nil
       encoding = nil
@@ -177,21 +183,24 @@ module Shotstack
         prefix = prefix + '-' unless prefix.end_with?('-')
         encoding = response.body.encoding
         tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
       end
       request.on_body do |chunk|
         chunk.force_encoding(encoding)
         tempfile.write(chunk)
       end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+      # run the request to ensure the tempfile is created successfully before returning it
+      request.run
+      if tempfile
+        tempfile.close
+        @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+      else
+        fail ApiError.new("Failed to create the tempfile based on the HTTP response from the server: #{request.inspect}") 
       end
+
+      tempfile
     end
 
     # Check if the given MIME is a JSON MIME.
@@ -212,15 +221,10 @@ module Shotstack
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
     def deserialize(response, return_type)
       body = response.body
-
-      # handle file downloading - return the File instance processed in request callbacks
-      # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
-
       return nil if body.nil? || body.empty?
 
       # return response body directly for String return type
-      return body if return_type == 'String'
+      return body.to_s if return_type == 'String'
 
       # ensuring a default content type
       content_type = response.headers['Content-Type'] || 'application/json'
@@ -335,7 +339,7 @@ module Shotstack
     # @param [Array] content_types array for Content-Type
     # @return [String] the Content-Type header  (e.g. application/json)
     def select_header_content_type(content_types)
-      # use application/json by default
+      # return nil by default
       return 'application/json' if content_types.nil? || content_types.empty?
       # use JSON when present, otherwise use the first one
       json_content_type = content_types.find { |s| json_mime?(s) }

data/lib/shotstack/api_error.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
 
@@ -32,6 +32,7 @@ module Shotstack
         end
       else
         super arg
+        @message = arg
       end
     end