Class: Shotstack::ServeApi

Inherits:
Object
  • Object
show all
Defined in:
lib/shotstack/api/serve_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ServeApi

Returns a new instance of ServeApi.



19
20
21
 
# File 'lib/shotstack/api/serve_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

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:** <a href="#">api.shotstack.io/serve/version</a>

Parameters:

  • id (String) —

    The id of the asset in UUID format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


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:** &lt;a href&#x3D;&quot;#&quot;&gt;api.shotstack.io/serve/version&lt;/a&gt;

Parameters:

  • id (String) —

    The id of the asset in UUID format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



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']

  new_options = 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, new_options)
  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:** <a href="#">api.shotstack.io/serve/version</a>

Parameters:

  • id (String) —

    The id of the asset in UUID format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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:** <a href="#">api.shotstack.io/serve/version</a>

Parameters:

  • id (String) —

    The render id associated with the asset in UUID format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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:** &lt;a href&#x3D;&quot;#&quot;&gt;api.shotstack.io/serve/version&lt;/a&gt;

Parameters:

  • id (String) —

    The render id associated with the asset in UUID format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AssetRenderResponse, Integer, Hash)>) —

    AssetRenderResponse data, response status code and response headers



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']

  new_options = 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, new_options)
  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:** &lt;a href&#x3D;&quot;#&quot;&gt;api.shotstack.io/serve/version&lt;/a&gt;

Parameters:

  • id (String) —

    The id of the asset in UUID format

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AssetResponse, Integer, Hash)>) —

    AssetResponse data, response status code and response headers



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']

  new_options = 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, new_options)
  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

#post_serve_asset(transfer, opts = {}) ⇒ TransferResponse

Transfer Asset Transfer a file from any publicly available URL to one or more Serve API [destinations](#tocs_destinations). **Base URL:** <a href="#">api.shotstack.io/serve/version</a>

Parameters:

  • transfer (Transfer) —

    Fetch an asset from a URL and send it to one or more destinations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



229
230
231
232
 
# File 'lib/shotstack/api/serve_api.rb', line 229

def post_serve_asset(transfer, opts = {})
  data, _status_code, _headers = post_serve_asset_with_http_info(transfer, opts)
  data
end

#post_serve_asset_with_http_info(transfer, opts = {}) ⇒ Array<(TransferResponse, Integer, Hash)>

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;api.shotstack.io/serve/version&lt;/a&gt;

Parameters:

  • transfer (Transfer) —

    Fetch an asset from a URL and send it to one or more destinations.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TransferResponse, Integer, Hash)>) —

    TransferResponse data, response status code and response headers



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/shotstack/api/serve_api.rb', line 239

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