Class: Shotstack::ServeApi
- Inherits:
-
Object
- Object
- Shotstack::ServeApi
- Defined in:
- lib/shotstack/api/serve_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_asset(id, opts = {}) ⇒ nil
Delete Asset Delete an asset by its asset id.
-
#delete_asset_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete Asset Delete an asset by its asset id.
-
#get_asset(id, opts = {}) ⇒ AssetResponse
Get Asset The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images.
-
#get_asset_by_render_id(id, opts = {}) ⇒ AssetRenderResponse
Get Asset by Render ID A render may generate more than one file, such as a video, thumbnail and poster image.
-
#get_asset_by_render_id_with_http_info(id, opts = {}) ⇒ Array<(AssetRenderResponse, Integer, Hash)>
Get Asset by Render ID A render may generate more than one file, such as a video, thumbnail and poster image.
-
#get_asset_with_http_info(id, opts = {}) ⇒ Array<(AssetResponse, Integer, Hash)>
Get Asset The Serve API is used to interact with, and delete hosted assets including videos, images, audio files, thumbnails and poster images.
-
#initialize(api_client = ApiClient.default) ⇒ ServeApi
constructor
A new instance of ServeApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/shotstack/api/serve_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_asset(id, opts = {}) ⇒ nil
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:** api.shotstack.io/serve/version
27 28 29 30 |
# File 'lib/shotstack/api/serve_api.rb', line 27 def delete_asset(id, opts = {}) delete_asset_with_http_info(id, opts) nil end |
#delete_asset_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
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:** api.shotstack.io/serve/version
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 |
# File 'lib/shotstack/api/serve_api.rb', line 37 def delete_asset_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ServeApi.delete_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 ServeApi.delete_asset" end pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/) if @api_client.config.client_side_validation && id !~ pattern fail ArgumentError, "invalid value for 'id' when calling ServeApi.delete_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] || {} # 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'] = opts.merge( :operation => :"ServeApi.delete_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(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: ServeApi#delete_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_asset(id, opts = {}) ⇒ AssetResponse
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:** api.shotstack.io/serve/version
93 94 95 96 |
# File 'lib/shotstack/api/serve_api.rb', line 93 def get_asset(id, opts = {}) data, _status_code, _headers = get_asset_with_http_info(id, opts) data end |
#get_asset_by_render_id(id, opts = {}) ⇒ AssetRenderResponse
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:** api.shotstack.io/serve/version
161 162 163 164 |
# File 'lib/shotstack/api/serve_api.rb', line 161 def get_asset_by_render_id(id, opts = {}) data, _status_code, _headers = get_asset_by_render_id_with_http_info(id, opts) data end |
#get_asset_by_render_id_with_http_info(id, opts = {}) ⇒ Array<(AssetRenderResponse, Integer, Hash)>
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:** api.shotstack.io/serve/version
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/shotstack/api/serve_api.rb', line 171 def get_asset_by_render_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ServeApi.get_asset_by_render_id ...' 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 ServeApi.get_asset_by_render_id" end pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/) if @api_client.config.client_side_validation && id !~ pattern fail ArgumentError, "invalid value for 'id' when calling ServeApi.get_asset_by_render_id, must conform to the pattern #{pattern}." end # resource path local_var_path = '/assets/render/{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] || 'AssetRenderResponse' # auth_names auth_names = opts[:debug_auth_names] || ['DeveloperKey'] = opts.merge( :operation => :"ServeApi.get_asset_by_render_id", :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: ServeApi#get_asset_by_render_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_asset_with_http_info(id, opts = {}) ⇒ Array<(AssetResponse, Integer, Hash)>
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:** api.shotstack.io/serve/version
103 104 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 |
# File 'lib/shotstack/api/serve_api.rb', line 103 def get_asset_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ServeApi.get_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 ServeApi.get_asset" end pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/) if @api_client.config.client_side_validation && id !~ pattern fail ArgumentError, "invalid value for 'id' when calling ServeApi.get_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] || 'AssetResponse' # auth_names auth_names = opts[:debug_auth_names] || ['DeveloperKey'] = opts.merge( :operation => :"ServeApi.get_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: ServeApi#get_asset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |