Class: Aimastering::LibraryAudioApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LibraryAudioApi

Returns a new instance of LibraryAudioApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_library_audio(opts = {}) ⇒ LibraryAudio

Create a new library audio.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    The file to upload.

Returns:



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

def create_library_audio(opts = {})
  data, _status_code, _headers = create_library_audio_with_http_info(opts)
  return data
end

#create_library_audio_like(id, opts = {}) ⇒ LibraryAudioLike

Create a new library audio like.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/aimastering/api/library_audio_api.rb', line 80

def create_library_audio_like(id, opts = {})
  data, _status_code, _headers = create_library_audio_like_with_http_info(id, opts)
  return data
end

#create_library_audio_like_with_http_info(id, opts = {}) ⇒ Array<(LibraryAudioLike, Fixnum, Hash)>

Create a new library audio like.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:

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

    LibraryAudioLike data, response status code and response headers



90
91
92
93
94
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/library_audio_api.rb', line 90

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

  # resource path
  local_var_path = "/library_audios/{id}/like".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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}

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

#create_library_audio_with_http_info(opts = {}) ⇒ Array<(LibraryAudio, Fixnum, Hash)>

Create a new library audio.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    The file to upload.

Returns:

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

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

def create_library_audio_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LibraryAudioApi.create_library_audio ..."
  end
  # resource path
  local_var_path = "/library_audios"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["file"] = opts[:'file'] if !opts[:'file'].nil?

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

#delete_library_audio(id, opts = {}) ⇒ LibraryAudio

Delete library audio.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:



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

def delete_library_audio(id, opts = {})
  data, _status_code, _headers = delete_library_audio_with_http_info(id, opts)
  return data
end

#delete_library_audio_with_http_info(id, opts = {}) ⇒ Array<(LibraryAudio, Fixnum, Hash)>

Delete library audio.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:

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

    LibraryAudio 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
190
191
 
# File 'lib/aimastering/api/library_audio_api.rb', line 149

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

  # resource path
  local_var_path = "/library_audios/{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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}

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

#get_library_audio(id, opts = {}) ⇒ LibraryAudio

Get a library audio by id.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:



198
199
200
201
 
# File 'lib/aimastering/api/library_audio_api.rb', line 198

def get_library_audio(id, opts = {})
  data, _status_code, _headers = get_library_audio_with_http_info(id, opts)
  return data
end

#get_library_audio_analysis(id, opts = {}) ⇒ LibraryAudioAnalysis

Get a library audio analysis by id.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:



255
256
257
258
 
# File 'lib/aimastering/api/library_audio_api.rb', line 255

def get_library_audio_analysis(id, opts = {})
  data, _status_code, _headers = get_library_audio_analysis_with_http_info(id, opts)
  return data
end

#get_library_audio_analysis_with_http_info(id, opts = {}) ⇒ Array<(LibraryAudioAnalysis, Fixnum, Hash)>

Get a library audio analysis by id.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:

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

    LibraryAudioAnalysis data, response status code and response headers



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
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/aimastering/api/library_audio_api.rb', line 265

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

  # resource path
  local_var_path = "/library_audios/{id}/analysis".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 => 'LibraryAudioAnalysis')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryAudioApi#get_library_audio_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_library_audio_with_http_info(id, opts = {}) ⇒ Array<(LibraryAudio, Fixnum, Hash)>

Get a library audio by id.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Returns:

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

    LibraryAudio data, response status code and response headers



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
247
248
 
# File 'lib/aimastering/api/library_audio_api.rb', line 208

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

  # resource path
  local_var_path = "/library_audios/{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 => 'LibraryAudio')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryAudioApi#get_library_audio\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_library_audios(opts = {}) ⇒ Array<LibraryAudio>

Get all library audios accessable.

Parameters:

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

    the optional parameters

Returns:



311
312
313
314
 
# File 'lib/aimastering/api/library_audio_api.rb', line 311

def list_library_audios(opts = {})
  data, _status_code, _headers = list_library_audios_with_http_info(opts)
  return data
end

#list_library_audios_with_http_info(opts = {}) ⇒ Array<(Array<LibraryAudio>, Fixnum, Hash)>

Get all library audios accessable.

Parameters:

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

    the optional parameters

Returns:

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

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/aimastering/api/library_audio_api.rb', line 320

def list_library_audios_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LibraryAudioApi.list_library_audios ..."
  end
  # resource path
  local_var_path = "/library_audios"

  # 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<LibraryAudio>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryAudioApi#list_library_audios\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_library_audio(id, opts = {}) ⇒ LibraryAudio

Update library audio.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Options Hash (opts):

  • :is_public (BOOLEAN) —

    Whether the library audio is public.

Returns:



360
361
362
363
 
# File 'lib/aimastering/api/library_audio_api.rb', line 360

def update_library_audio(id, opts = {})
  data, _status_code, _headers = update_library_audio_with_http_info(id, opts)
  return data
end

#update_library_audio_with_http_info(id, opts = {}) ⇒ Array<(LibraryAudio, Fixnum, Hash)>

Update library audio.

Parameters:

  • id —

    Library audio id

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

    the optional parameters

Options Hash (opts):

  • :is_public (BOOLEAN) —

    Whether the library audio is public.

Returns:

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

    LibraryAudio data, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/aimastering/api/library_audio_api.rb', line 371

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

  # resource path
  local_var_path = "/library_audios/{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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["is_public"] = opts[:'is_public'] if !opts[:'is_public'].nil?

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