Class: Shotstack::CreateApi
- Inherits:
-
Object
- Object
- Shotstack::CreateApi
- Defined in:
- lib/shotstack/api/create_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_generated_asset(id, opts = {}) ⇒ GeneratedAssetResponse
Get Generated Asset Get the generated assets status, url and details by ID.
-
#get_generated_asset_with_http_info(id, opts = {}) ⇒ Array<(GeneratedAssetResponse, Integer, Hash)>
Get Generated Asset Get the generated assets status, url and details by ID.
-
#initialize(api_client = ApiClient.default) ⇒ CreateApi
constructor
A new instance of CreateApi.
-
#post_generate_asset(generated_asset, opts = {}) ⇒ GeneratedAssetResponse
Generate Asset Generate an asset using a Shotstack or third party provider.
-
#post_generate_asset_with_http_info(generated_asset, opts = {}) ⇒ Array<(GeneratedAssetResponse, Integer, Hash)>
Generate Asset Generate an asset using a Shotstack or third party provider.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/shotstack/api/create_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#get_generated_asset(id, opts = {}) ⇒ GeneratedAssetResponse
Get Generated Asset Get the generated assets status, url and details by ID. **Base URL:** <a href="#">api.shotstack.io/create/version</a>
27 28 29 30 |
# File 'lib/shotstack/api/create_api.rb', line 27 def get_generated_asset(id, opts = {}) data, _status_code, _headers = get_generated_asset_with_http_info(id, opts) data end |
#get_generated_asset_with_http_info(id, opts = {}) ⇒ Array<(GeneratedAssetResponse, Integer, Hash)>
Get Generated Asset Get the generated assets status, url and details by ID. **Base URL:** <a href="#">api.shotstack.io/create/version</a>
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/shotstack/api/create_api.rb', line 37 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'] = 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, ) 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 |
#post_generate_asset(generated_asset, opts = {}) ⇒ GeneratedAssetResponse
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="#">api.shotstack.io/create/version</a>
95 96 97 98 |
# File 'lib/shotstack/api/create_api.rb', line 95 def post_generate_asset(generated_asset, opts = {}) data, _status_code, _headers = post_generate_asset_with_http_info(generated_asset, opts) data end |
#post_generate_asset_with_http_info(generated_asset, opts = {}) ⇒ Array<(GeneratedAssetResponse, Integer, Hash)>
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="#">api.shotstack.io/create/version</a>
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/shotstack/api/create_api.rb', line 105 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'] = 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, ) 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 |