Class: Shotstack::IngestApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IngestApi

Returns a new instance of IngestApi.



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

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/shotstack/api/ingest_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_source(id, opts = {}) ⇒ nil

Delete Source Delete an ingested source file by its id. **Base URL:** <a href="#">api.shotstack.io/ingest/version</a>

Parameters:

Returns:

  • (nil)


27
28
29
30
# File 'lib/shotstack/api/ingest_api.rb', line 27

def delete_source(id, opts = {})
  delete_source_with_http_info(id, opts)
  nil
end

#delete_source_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Source Delete an ingested source file by its id. **Base URL:** &lt;a href&#x3D;&quot;#&quot;&gt;api.shotstack.io/ingest/version&lt;/a&gt;

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/ingest_api.rb', line 37

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(id, opts = {}) ⇒ SourceResponse

Get Source Fetch a source file details and status by its id. **Base URL:** <a href="#">api.shotstack.io/ingest/version</a>

Parameters:

Returns:



93
94
95
96
# File 'lib/shotstack/api/ingest_api.rb', line 93

def get_source(id, opts = {})
  data, _status_code, _headers = get_source_with_http_info(id, opts)
  data
end

#get_source_with_http_info(id, opts = {}) ⇒ Array<(SourceResponse, Integer, Hash)>

Get Source Fetch a source file details and status by its id. **Base URL:** &lt;a href&#x3D;&quot;#&quot;&gt;api.shotstack.io/ingest/version&lt;/a&gt;

Parameters:

Returns:

  • (Array<(SourceResponse, Integer, Hash)>)

    SourceResponse 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/ingest_api.rb', line 103

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

#get_sources(opts = {}) ⇒ SourceListResponse

List Sources Retrieve a list of ingested source files stored against a users account and stage. **Base URL:** <a href="#">api.shotstack.io/ingest/version</a>

Parameters:

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

    the optional parameters

Returns:



160
161
162
163
# File 'lib/shotstack/api/ingest_api.rb', line 160

def get_sources(opts = {})
  data, _status_code, _headers = get_sources_with_http_info(opts)
  data
end

#get_sources_with_http_info(opts = {}) ⇒ Array<(SourceListResponse, Integer, Hash)>

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

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SourceListResponse, Integer, Hash)>)

    SourceListResponse data, response status code and response headers



169
170
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
# File 'lib/shotstack/api/ingest_api.rb', line 169

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

#get_upload_signed_url(opts = {}) ⇒ UploadResponse

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: 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 Shotstack::IngestApi.datadata.attributesdata.attributes.url` Where video.mp4 is the file you want to upload and **Shotstack::IngestApi.datadata.attributesdata.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="#">api.shotstack.io/ingest/version</a>

Parameters:

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

    the optional parameters

Returns:



217
218
219
220
# File 'lib/shotstack/api/ingest_api.rb', line 217

def get_upload_signed_url(opts = {})
  data, _status_code, _headers = get_upload_signed_url_with_http_info(opts)
  data
end

#get_upload_signed_url_with_http_info(opts = {}) ⇒ Array<(UploadResponse, Integer, Hash)>

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: 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 Shotstack::IngestApi.datadata.attributesdata.attributes.url&#x60; Where video.mp4 is the file you want to upload and **Shotstack::IngestApi.datadata.attributesdata.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;api.shotstack.io/ingest/version&lt;/a&gt;

Parameters:

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

    the optional parameters

Returns:

  • (Array<(UploadResponse, Integer, Hash)>)

    UploadResponse data, response status code and response headers



226
227
228
229
230
231
232
233
234
235
236
237
238
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
# File 'lib/shotstack/api/ingest_api.rb', line 226

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

#post_source(source, opts = {}) ⇒ QueuedSourceResponse

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="#">api.shotstack.io/ingest/version</a>

Parameters:

  • source (Source)

    Ingest a video, image, audio or font file from the provided URL. Optionally provide a list of output renditions.

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

    the optional parameters

Returns:



275
276
277
278
# File 'lib/shotstack/api/ingest_api.rb', line 275

def post_source(source, opts = {})
  data, _status_code, _headers = post_source_with_http_info(source, opts)
  data
end

#post_source_with_http_info(source, opts = {}) ⇒ Array<(QueuedSourceResponse, Integer, Hash)>

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

Parameters:

  • source (Source)

    Ingest a video, image, audio or font file from the provided URL. Optionally provide a list of output renditions.

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

    the optional parameters

Returns:

  • (Array<(QueuedSourceResponse, Integer, Hash)>)

    QueuedSourceResponse data, response status code and response headers



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'lib/shotstack/api/ingest_api.rb', line 285

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