Class: MetatronClient::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/metatron_ruby_client/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



17
18
19
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 17

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#assets_asset_type_asset_id_delete(asset_id, asset_type, authorization, opts = {}) ⇒ nil

Parameters:

  • asset_id
  • asset_type
  • authorization
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 28

def assets_asset_type_asset_id_delete(asset_id, asset_type, authorization, opts = {})
  assets_asset_type_asset_id_delete_with_http_info(asset_id, asset_type, authorization, opts)
  return nil
end

#assets_asset_type_asset_id_delete_with_http_info(asset_id, asset_type, authorization, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • asset_id
  • asset_type
  • authorization
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 40

def assets_asset_type_asset_id_delete_with_http_info(asset_id, asset_type, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.assets_asset_type_asset_id_delete ..."
  end
  # verify the required parameter 'asset_id' is set
  fail ArgumentError, "Missing the required parameter 'asset_id' when calling DefaultApi.assets_asset_type_asset_id_delete" if asset_id.nil?
  # verify the required parameter 'asset_type' is set
  fail ArgumentError, "Missing the required parameter 'asset_type' when calling DefaultApi.assets_asset_type_asset_id_delete" if asset_type.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.assets_asset_type_asset_id_delete" if authorization.nil?
  # resource path
  local_var_path = "/2/assets/{assetType}/{assetId}".sub('{format}','json').sub('{' + 'assetId' + '}', asset_id.to_s).sub('{' + 'assetType' + '}', asset_type.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json', 'application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#assets_asset_type_asset_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#manifestations_get(authorization, opts = {}) ⇒ ManifestationResultSet

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :work_id (String)
  • :isbn (String)

Returns:



93
94
95
96
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 93

def manifestations_get(authorization, opts = {})
  data, _status_code, _headers = manifestations_get_with_http_info(authorization, opts)
  return data
end

#manifestations_get_with_http_info(authorization, opts = {}) ⇒ Array<(ManifestationResultSet, Fixnum, Hash)>

Returns ManifestationResultSet data, response status code and response headers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :work_id (String)
  • :isbn (String)

Returns:

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

    ManifestationResultSet data, response status code and response headers



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
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 105

def manifestations_get_with_http_info(authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.manifestations_get ..."
  end
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.manifestations_get" if authorization.nil?
  # resource path
  local_var_path = "/2/manifestations".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'work_id'] = opts[:'work_id'] if opts[:'work_id']
  query_params[:'isbn'] = opts[:'isbn'] if opts[:'isbn']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json', 'application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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 => 'ManifestationResultSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#manifestations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#manifestations_manifestation_id_assets_get(manifestation_id, authorization, opts = {}) ⇒ AssetResultSet

Parameters:

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

    the optional parameters

Returns:



156
157
158
159
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 156

def manifestations_manifestation_id_assets_get(manifestation_id, authorization, opts = {})
  data, _status_code, _headers = manifestations_manifestation_id_assets_get_with_http_info(manifestation_id, authorization, opts)
  return data
end

#manifestations_manifestation_id_assets_get_with_http_info(manifestation_id, authorization, opts = {}) ⇒ Array<(AssetResultSet, Fixnum, Hash)>

Returns AssetResultSet data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    AssetResultSet data, response status code and response headers



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 167

def manifestations_manifestation_id_assets_get_with_http_info(manifestation_id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.manifestations_manifestation_id_assets_get ..."
  end
  # verify the required parameter 'manifestation_id' is set
  fail ArgumentError, "Missing the required parameter 'manifestation_id' when calling DefaultApi.manifestations_manifestation_id_assets_get" if manifestation_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.manifestations_manifestation_id_assets_get" if authorization.nil?
  # resource path
  local_var_path = "/2/manifestations/{manifestationId}/assets".sub('{format}','json').sub('{' + 'manifestationId' + '}', manifestation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json', 'application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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 => 'AssetResultSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#manifestations_manifestation_id_assets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#manifestations_manifestation_id_assets_post(manifestation_id, authorization, asset, opts = {}) ⇒ Asset

Parameters:

  • manifestation_id
  • authorization
  • asset
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 219

def manifestations_manifestation_id_assets_post(manifestation_id, authorization, asset, opts = {})
  data, _status_code, _headers = manifestations_manifestation_id_assets_post_with_http_info(manifestation_id, authorization, asset, opts)
  return data
end

#manifestations_manifestation_id_assets_post_with_http_info(manifestation_id, authorization, asset, opts = {}) ⇒ Array<(Asset, Fixnum, Hash)>

Returns Asset data, response status code and response headers.

Parameters:

  • manifestation_id
  • authorization
  • asset
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Asset data, response status code and response headers



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
269
270
271
272
273
274
275
276
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 231

def manifestations_manifestation_id_assets_post_with_http_info(manifestation_id, authorization, asset, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.manifestations_manifestation_id_assets_post ..."
  end
  # verify the required parameter 'manifestation_id' is set
  fail ArgumentError, "Missing the required parameter 'manifestation_id' when calling DefaultApi.manifestations_manifestation_id_assets_post" if manifestation_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.manifestations_manifestation_id_assets_post" if authorization.nil?
  # verify the required parameter 'asset' is set
  fail ArgumentError, "Missing the required parameter 'asset' when calling DefaultApi.manifestations_manifestation_id_assets_post" if asset.nil?
  # resource path
  local_var_path = "/2/manifestations/{manifestationId}/assets".sub('{format}','json').sub('{' + 'manifestationId' + '}', manifestation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json', 'application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/vnd.api+json', 'application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(asset)
  auth_names = ['Authorizer']
  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 => 'Asset')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#manifestations_manifestation_id_assets_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#manifestations_manifestation_id_get(manifestation_id, authorization, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


284
285
286
287
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 284

def manifestations_manifestation_id_get(manifestation_id, authorization, opts = {})
  manifestations_manifestation_id_get_with_http_info(manifestation_id, authorization, opts)
  return nil
end

#manifestations_manifestation_id_get_with_http_info(manifestation_id, authorization, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
337
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 295

def manifestations_manifestation_id_get_with_http_info(manifestation_id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.manifestations_manifestation_id_get ..."
  end
  # verify the required parameter 'manifestation_id' is set
  fail ArgumentError, "Missing the required parameter 'manifestation_id' when calling DefaultApi.manifestations_manifestation_id_get" if manifestation_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.manifestations_manifestation_id_get" if authorization.nil?
  # resource path
  local_var_path = "/2/manifestations/{manifestationId}".sub('{format}','json').sub('{' + 'manifestationId' + '}', manifestation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#manifestations_manifestation_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#manifestations_manifestation_id_items_tenant_code_get(manifestation_id, authorization, tenant_code, opts = {}) ⇒ ItemResultSet

Parameters:

  • manifestation_id
  • authorization
  • tenant_code
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



346
347
348
349
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 346

def manifestations_manifestation_id_items_tenant_code_get(manifestation_id, authorization, tenant_code, opts = {})
  data, _status_code, _headers = manifestations_manifestation_id_items_tenant_code_get_with_http_info(manifestation_id, authorization, tenant_code, opts)
  return data
end

#manifestations_manifestation_id_items_tenant_code_get_with_http_info(manifestation_id, authorization, tenant_code, opts = {}) ⇒ Array<(ItemResultSet, Fixnum, Hash)>

Returns ItemResultSet data, response status code and response headers.

Parameters:

  • manifestation_id
  • authorization
  • tenant_code
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    ItemResultSet data, response status code and response headers



358
359
360
361
362
363
364
365
366
367
368
369
370
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
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 358

def manifestations_manifestation_id_items_tenant_code_get_with_http_info(manifestation_id, authorization, tenant_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.manifestations_manifestation_id_items_tenant_code_get ..."
  end
  # verify the required parameter 'manifestation_id' is set
  fail ArgumentError, "Missing the required parameter 'manifestation_id' when calling DefaultApi.manifestations_manifestation_id_items_tenant_code_get" if manifestation_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.manifestations_manifestation_id_items_tenant_code_get" if authorization.nil?
  # verify the required parameter 'tenant_code' is set
  fail ArgumentError, "Missing the required parameter 'tenant_code' when calling DefaultApi.manifestations_manifestation_id_items_tenant_code_get" if tenant_code.nil?
  # resource path
  local_var_path = "/2/manifestations/{manifestationId}/items/{tenantCode}".sub('{format}','json').sub('{' + 'manifestationId' + '}', manifestation_id.to_s).sub('{' + 'tenantCode' + '}', tenant_code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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 => 'ItemResultSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#manifestations_manifestation_id_items_tenant_code_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#manifestations_manifestation_id_works_get(manifestation_id, authorization, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


411
412
413
414
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 411

def manifestations_manifestation_id_works_get(manifestation_id, authorization, opts = {})
  manifestations_manifestation_id_works_get_with_http_info(manifestation_id, authorization, opts)
  return nil
end

#manifestations_manifestation_id_works_get_with_http_info(manifestation_id, authorization, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 422

def manifestations_manifestation_id_works_get_with_http_info(manifestation_id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.manifestations_manifestation_id_works_get ..."
  end
  # verify the required parameter 'manifestation_id' is set
  fail ArgumentError, "Missing the required parameter 'manifestation_id' when calling DefaultApi.manifestations_manifestation_id_works_get" if manifestation_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.manifestations_manifestation_id_works_get" if authorization.nil?
  # resource path
  local_var_path = "/2/manifestations/{manifestationId}/works".sub('{format}','json').sub('{' + 'manifestationId' + '}', manifestation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#manifestations_manifestation_id_works_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#works_get(limit, offset, q, authorization, opts = {}) ⇒ WorkResultSet

Parameters:

  • limit
  • offset
  • q
  • authorization
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include (String)

Returns:



475
476
477
478
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 475

def works_get(limit, offset, q, authorization, opts = {})
  data, _status_code, _headers = works_get_with_http_info(limit, offset, q, authorization, opts)
  return data
end

#works_get_with_http_info(limit, offset, q, authorization, opts = {}) ⇒ Array<(WorkResultSet, Fixnum, Hash)>

Returns WorkResultSet data, response status code and response headers.

Parameters:

  • limit
  • offset
  • q
  • authorization
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include (String)

Returns:

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

    WorkResultSet data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 489

def works_get_with_http_info(limit, offset, q, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.works_get ..."
  end
  # verify the required parameter 'limit' is set
  fail ArgumentError, "Missing the required parameter 'limit' when calling DefaultApi.works_get" if limit.nil?
  # verify the required parameter 'offset' is set
  fail ArgumentError, "Missing the required parameter 'offset' when calling DefaultApi.works_get" if offset.nil?
  # verify the required parameter 'q' is set
  fail ArgumentError, "Missing the required parameter 'q' when calling DefaultApi.works_get" if q.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.works_get" if authorization.nil?
  # resource path
  local_var_path = "/2/works".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'limit'] = limit
  query_params[:'offset'] = offset
  query_params[:'q'] = q
  query_params[:'include'] = opts[:'include'] if opts[:'include']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json', 'application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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 => 'WorkResultSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#works_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#works_work_id_assets_get(work_id, authorization, opts = {}) ⇒ AssetResultSet

Parameters:

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

    the optional parameters

Returns:



548
549
550
551
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 548

def works_work_id_assets_get(work_id, authorization, opts = {})
  data, _status_code, _headers = works_work_id_assets_get_with_http_info(work_id, authorization, opts)
  return data
end

#works_work_id_assets_get_with_http_info(work_id, authorization, opts = {}) ⇒ Array<(AssetResultSet, Fixnum, Hash)>

Returns AssetResultSet data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    AssetResultSet data, response status code and response headers



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 559

def works_work_id_assets_get_with_http_info(work_id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.works_work_id_assets_get ..."
  end
  # verify the required parameter 'work_id' is set
  fail ArgumentError, "Missing the required parameter 'work_id' when calling DefaultApi.works_work_id_assets_get" if work_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.works_work_id_assets_get" if authorization.nil?
  # resource path
  local_var_path = "/2/works/{workId}/assets".sub('{format}','json').sub('{' + 'workId' + '}', work_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json', 'application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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 => 'AssetResultSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#works_work_id_assets_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#works_work_id_manifestations_get(work_id, authorization, opts = {}) ⇒ nil

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


610
611
612
613
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 610

def works_work_id_manifestations_get(work_id, authorization, opts = {})
  works_work_id_manifestations_get_with_http_info(work_id, authorization, opts)
  return nil
end

#works_work_id_manifestations_get_with_http_info(work_id, authorization, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Returns nil, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 621

def works_work_id_manifestations_get_with_http_info(work_id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.works_work_id_manifestations_get ..."
  end
  # verify the required parameter 'work_id' is set
  fail ArgumentError, "Missing the required parameter 'work_id' when calling DefaultApi.works_work_id_manifestations_get" if work_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.works_work_id_manifestations_get" if authorization.nil?
  # resource path
  local_var_path = "/2/works/{workId}/manifestations".sub('{format}','json').sub('{' + 'workId' + '}', work_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#works_work_id_manifestations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#works_work_id_similar_get(work_id, authorization, opts = {}) ⇒ WorkResultSet

Parameters:

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

    the optional parameters

Returns:



671
672
673
674
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 671

def works_work_id_similar_get(work_id, authorization, opts = {})
  data, _status_code, _headers = works_work_id_similar_get_with_http_info(work_id, authorization, opts)
  return data
end

#works_work_id_similar_get_with_http_info(work_id, authorization, opts = {}) ⇒ Array<(WorkResultSet, Fixnum, Hash)>

Returns WorkResultSet data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    WorkResultSet data, response status code and response headers



682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/metatron_ruby_client/api/default_api.rb', line 682

def works_work_id_similar_get_with_http_info(work_id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DefaultApi.works_work_id_similar_get ..."
  end
  # verify the required parameter 'work_id' is set
  fail ArgumentError, "Missing the required parameter 'work_id' when calling DefaultApi.works_work_id_similar_get" if work_id.nil?
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling DefaultApi.works_work_id_similar_get" if authorization.nil?
  # resource path
  local_var_path = "/2/works/{workId}/similar".sub('{format}','json').sub('{' + 'workId' + '}', work_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/vnd.api+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['Authorizer']
  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 => 'WorkResultSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#works_work_id_similar_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end