Class: Aimastering::VideoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/aimastering/api/video_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VideoApi

Returns a new instance of VideoApi.



19
20
21
 
# File 'lib/aimastering/api/video_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/aimastering/api/video_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#download_video(id, opts = {}) ⇒ String

Download an video data by id.

Parameters:

  • id —

    Video id

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

    the optional parameters

Returns:

  • (String) 


28
29
30
31
 
# File 'lib/aimastering/api/video_api.rb', line 28

def download_video(id, opts = {})
  data, _status_code, _headers = download_video_with_http_info(id, opts)
  return data
end

#download_video_by_token(download_token, opts = {}) ⇒ String

Download an video data by video_download_token.

Parameters:

  • download_token —

    Video download token

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

    the optional parameters

Returns:

  • (String) 


85
86
87
88
 
# File 'lib/aimastering/api/video_api.rb', line 85

def download_video_by_token(download_token, opts = {})
  data, _status_code, _headers = download_video_by_token_with_http_info(download_token, opts)
  return data
end

#download_video_by_token_with_http_info(download_token, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Download an video data by video_download_token.

Parameters:

  • download_token —

    Video download token

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



95
96
97
98
99
100
101
102
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
 
# File 'lib/aimastering/api/video_api.rb', line 95

def download_video_by_token_with_http_info(download_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideoApi.download_video_by_token ..."
  end
  # verify the required parameter 'download_token' is set
  if @api_client.config.client_side_validation && download_token.nil?
    fail ArgumentError, "Missing the required parameter 'download_token' when calling VideoApi.download_video_by_token"
  end
  # resource path
  local_var_path = "/videos/download_by_token"

  # query parameters
  query_params = {}
  query_params[:'download_token'] = download_token

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#download_video_by_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#download_video_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Download an video data by id.

Parameters:

  • id —

    Video id

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/aimastering/api/video_api.rb', line 38

def download_video_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideoApi.download_video ..."
  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 VideoApi.download_video"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling VideoApi.download_video, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/videos/{id}/download".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#download_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_video(id, opts = {}) ⇒ Video

Get an video by id.

Parameters:

  • id —

    Video id

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

    the optional parameters

Returns:



139
140
141
142
 
# File 'lib/aimastering/api/video_api.rb', line 139

def get_video(id, opts = {})
  data, _status_code, _headers = get_video_with_http_info(id, opts)
  return data
end

#get_video_download_token(id, opts = {}) ⇒ VideoDownloadToken

Get an video download token by id.

Parameters:

  • id —

    Video id

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

    the optional parameters

Returns:



196
197
198
199
 
# File 'lib/aimastering/api/video_api.rb', line 196

def get_video_download_token(id, opts = {})
  data, _status_code, _headers = get_video_download_token_with_http_info(id, opts)
  return data
end

#get_video_download_token_with_http_info(id, opts = {}) ⇒ Array<(VideoDownloadToken, Fixnum, Hash)>

Get an video download token by id.

Parameters:

  • id —

    Video id

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

    the optional parameters

Returns:

  • (Array<(VideoDownloadToken, Fixnum, Hash)>) —

    VideoDownloadToken data, response status code and response headers



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/aimastering/api/video_api.rb', line 206

def get_video_download_token_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideoApi.get_video_download_token ..."
  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 VideoApi.get_video_download_token"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling VideoApi.get_video_download_token, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/videos/{id}/download_token".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VideoDownloadToken')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#get_video_download_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_video_with_http_info(id, opts = {}) ⇒ Array<(Video, Fixnum, Hash)>

Get an video by id.

Parameters:

  • id —

    Video id

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

    the optional parameters

Returns:

  • (Array<(Video, Fixnum, Hash)>) —

    Video data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/aimastering/api/video_api.rb', line 149

def get_video_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideoApi.get_video ..."
  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 VideoApi.get_video"
  end
  if @api_client.config.client_side_validation && id < 1
    fail ArgumentError, 'invalid value for "id" when calling VideoApi.get_video, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/videos/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Video')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#get_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_videos(opts = {}) ⇒ Array<Video>

Get all videos accessable.

Parameters:

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

    the optional parameters

Returns:



252
253
254
255
 
# File 'lib/aimastering/api/video_api.rb', line 252

def list_videos(opts = {})
  data, _status_code, _headers = list_videos_with_http_info(opts)
  return data
end

#list_videos_with_http_info(opts = {}) ⇒ Array<(Array<Video>, Fixnum, Hash)>

Get all videos accessable.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Array<Video>, Fixnum, Hash)>) —

    Array<Video> data, response status code and response headers



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
291
292
293
 
# File 'lib/aimastering/api/video_api.rb', line 261

def list_videos_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VideoApi.list_videos ..."
  end
  # resource path
  local_var_path = "/videos"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Video>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#list_videos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end