Class: SparteraApiSdk::AssetsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spartera_api_sdk/api/assets_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssetsApi

Returns a new instance of AssetsApi.



19
20
21
 
# File 'lib/spartera_api_sdk/api/assets_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/spartera_api_sdk/api/assets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_assets(company_id, assets_input, opts = {}) ⇒ CreateAssetsAnalyze200Response

Create a new asset

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



32
33
34
35
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 32

def create_assets(company_id, assets_input, opts = {})
  data, _status_code, _headers = create_assets_with_http_info(company_id, assets_input, opts)
  data
end

#create_assets_analyze(asset_slug, company_handle, assets_input, opts = {}) ⇒ CreateAssetsAnalyze200Response

Process (analyze) an asset with dynamic rate limiting applied via decorator.

Parameters:

  • asset_slug (String) —

    URL-friendly slug for the Asset

  • company_handle (String) —

    Human-readable handle for the Company

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 152

def create_assets_analyze(asset_slug, company_handle, assets_input, opts = {})
  data, _status_code, _headers = create_assets_analyze_with_http_info(asset_slug, company_handle, assets_input, opts)
  data
end

#create_assets_analyze_with_http_info(asset_slug, company_handle, assets_input, opts = {}) ⇒ Array<(CreateAssetsAnalyze200Response, Integer, Hash)>

Process (analyze) an asset with dynamic rate limiting applied via decorator.

Parameters:

  • asset_slug (String) —

    URL-friendly slug for the Asset

  • company_handle (String) —

    Human-readable handle for the Company

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

    the optional parameters

Returns:



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
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/spartera_api_sdk/api/assets_api.rb', line 163

def create_assets_analyze_with_http_info(asset_slug, company_handle, assets_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.create_assets_analyze ...'
  end
  # verify the required parameter 'asset_slug' is set
  if @api_client.config.client_side_validation && asset_slug.nil?
    fail ArgumentError, "Missing the required parameter 'asset_slug' when calling AssetsApi.create_assets_analyze"
  end
  # verify the required parameter 'company_handle' is set
  if @api_client.config.client_side_validation && company_handle.nil?
    fail ArgumentError, "Missing the required parameter 'company_handle' when calling AssetsApi.create_assets_analyze"
  end
  # verify the required parameter 'assets_input' is set
  if @api_client.config.client_side_validation && assets_input.nil?
    fail ArgumentError, "Missing the required parameter 'assets_input' when calling AssetsApi.create_assets_analyze"
  end
  # resource path
  local_var_path = '/analyze/{company_handle}/assets/{asset_slug}'.sub('{' + 'asset_slug' + '}', CGI.escape(asset_slug.to_s)).sub('{' + 'company_handle' + '}', CGI.escape(company_handle.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']) unless header_params['Accept']
  # 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(assets_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateAssetsAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.create_assets_analyze",
    :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: AssetsApi#create_assets_analyze\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_assets_scan_column(company_id, asset_id, assets_input, opts = {}) ⇒ CreateAssetsAnalyze200Response

Scan a column in the asset’s table to retrieve distinct values Request Body: column (str): Column name to scan limit (int, optional): Maximum distinct values to return (default 1000, max 5000) Returns: Flask Response with scan results

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



230
231
232
233
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 230

def create_assets_scan_column(company_id, asset_id, assets_input, opts = {})
  data, _status_code, _headers = create_assets_scan_column_with_http_info(company_id, asset_id, assets_input, opts)
  data
end

#create_assets_scan_column_with_http_info(company_id, asset_id, assets_input, opts = {}) ⇒ Array<(CreateAssetsAnalyze200Response, Integer, Hash)>

Scan a column in the asset&#39;s table to retrieve distinct values Request Body: column (str): Column name to scan limit (int, optional): Maximum distinct values to return (default 1000, max 5000) Returns: Flask Response with scan results

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



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
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
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 241

def create_assets_scan_column_with_http_info(company_id, asset_id, assets_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.create_assets_scan_column ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.create_assets_scan_column"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.create_assets_scan_column, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.create_assets_scan_column, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.create_assets_scan_column, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.create_assets_scan_column"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.create_assets_scan_column, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.create_assets_scan_column, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.create_assets_scan_column, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'assets_input' is set
  if @api_client.config.client_side_validation && assets_input.nil?
    fail ArgumentError, "Missing the required parameter 'assets_input' when calling AssetsApi.create_assets_scan_column"
  end
  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/scan_column'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']
  # 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(assets_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateAssetsAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.create_assets_scan_column",
    :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: AssetsApi#create_assets_scan_column\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_assets_test(company_id, asset_id, assets_input, opts = {}) ⇒ CreateAssetsAnalyze200Response

POST /companies/company_id/assets/asset_id/test

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



334
335
336
337
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 334

def create_assets_test(company_id, asset_id, assets_input, opts = {})
  data, _status_code, _headers = create_assets_test_with_http_info(company_id, asset_id, assets_input, opts)
  data
end

#create_assets_test_with_http_info(company_id, asset_id, assets_input, opts = {}) ⇒ Array<(CreateAssetsAnalyze200Response, Integer, Hash)>

POST /companies/company_id/assets/asset_id/test

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



345
346
347
348
349
350
351
352
353
354
355
356
357
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 345

def create_assets_test_with_http_info(company_id, asset_id, assets_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.create_assets_test ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.create_assets_test"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.create_assets_test, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.create_assets_test, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.create_assets_test, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.create_assets_test"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.create_assets_test, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.create_assets_test, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.create_assets_test, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'assets_input' is set
  if @api_client.config.client_side_validation && assets_input.nil?
    fail ArgumentError, "Missing the required parameter 'assets_input' when calling AssetsApi.create_assets_test"
  end
  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/test'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']
  # 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(assets_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateAssetsAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.create_assets_test",
    :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: AssetsApi#create_assets_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_assets_with_http_info(company_id, assets_input, opts = {}) ⇒ Array<(CreateAssetsAnalyze200Response, Integer, Hash)>

Create a new asset

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



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
87
88
89
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
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 47

def create_assets_with_http_info(company_id, assets_input, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.create_assets ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.create_assets"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.create_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.create_assets, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.create_assets, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'assets_input' is set
  if @api_client.config.client_side_validation && assets_input.nil?
    fail ArgumentError, "Missing the required parameter 'assets_input' when calling AssetsApi.create_assets"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AssetsApi.create_assets, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AssetsApi.create_assets, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AssetsApi.create_assets, must be greater than or equal to 1.'
  end

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AssetsApi.create_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AssetsApi.create_assets, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(assets_input)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateAssetsAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.create_assets",
    :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: AssetsApi#create_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_assets(company_id, asset_id, opts = {}) ⇒ DeleteAssets200Response

Delete single asset by ID

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



437
438
439
440
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 437

def delete_assets(company_id, asset_id, opts = {})
  data, _status_code, _headers = delete_assets_with_http_info(company_id, asset_id, opts)
  data
end

#delete_assets_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(DeleteAssets200Response, Integer, Hash)>

Delete single asset by ID

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:

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

    DeleteAssets200Response data, response status code and response headers



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
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
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 447

def delete_assets_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.delete_assets ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.delete_assets"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.delete_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.delete_assets, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.delete_assets, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.delete_assets"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.delete_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.delete_assets, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.delete_assets, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteAssets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.delete_assets",
    :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: AssetsApi#delete_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id(company_id, asset_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Get single asset by ID

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



530
531
532
533
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 530

def get_assets_by_id(company_id, asset_id, opts = {})
  data, _status_code, _headers = get_assets_by_id_with_http_info(company_id, asset_id, opts)
  data
end

#get_assets_by_id2(company_id, asset_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Get statistics for a specific asset (public endpoint)

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



623
624
625
626
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 623

def get_assets_by_id2(company_id, asset_id, opts = {})
  data, _status_code, _headers = get_assets_by_id2_with_http_info(company_id, asset_id, opts)
  data
end

#get_assets_by_id2_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Get statistics for a specific asset (public endpoint)

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



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
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
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
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 633

def get_assets_by_id2_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id2 ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id2"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id2, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id2, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id2, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_assets_by_id2"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id2, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id2, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.get_assets_by_id2, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/statistics'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id2",
    :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: AssetsApi#get_assets_by_id2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_analyze(asset_slug, company_handle, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Process (analyze) an asset with dynamic rate limiting applied via decorator.

Parameters:

  • asset_slug (String) —

    URL-friendly slug for the Asset

  • company_handle (String) —

    Human-readable handle for the Company

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

    the optional parameters

Returns:



716
717
718
719
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 716

def get_assets_by_id_analyze(asset_slug, company_handle, opts = {})
  data, _status_code, _headers = get_assets_by_id_analyze_with_http_info(asset_slug, company_handle, opts)
  data
end

#get_assets_by_id_analyze_with_http_info(asset_slug, company_handle, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Process (analyze) an asset with dynamic rate limiting applied via decorator.

Parameters:

  • asset_slug (String) —

    URL-friendly slug for the Asset

  • company_handle (String) —

    Human-readable handle for the Company

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

    the optional parameters

Returns:



726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 726

def get_assets_by_id_analyze_with_http_info(asset_slug, company_handle, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id_analyze ...'
  end
  # verify the required parameter 'asset_slug' is set
  if @api_client.config.client_side_validation && asset_slug.nil?
    fail ArgumentError, "Missing the required parameter 'asset_slug' when calling AssetsApi.get_assets_by_id_analyze"
  end
  # verify the required parameter 'company_handle' is set
  if @api_client.config.client_side_validation && company_handle.nil?
    fail ArgumentError, "Missing the required parameter 'company_handle' when calling AssetsApi.get_assets_by_id_analyze"
  end
  # resource path
  local_var_path = '/analyze/{company_handle}/assets/{asset_slug}'.sub('{' + 'asset_slug' + '}', CGI.escape(asset_slug.to_s)).sub('{' + 'company_handle' + '}', CGI.escape(company_handle.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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id_analyze",
    :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: AssetsApi#get_assets_by_id_analyze\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_infoschema(company_id, asset_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Get the information schema for a specific asset’s table

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



783
784
785
786
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 783

def get_assets_by_id_infoschema(company_id, asset_id, opts = {})
  data, _status_code, _headers = get_assets_by_id_infoschema_with_http_info(company_id, asset_id, opts)
  data
end

#get_assets_by_id_infoschema_save(company_id, asset_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Retrieve and save an asset’s information schema

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



876
877
878
879
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 876

def get_assets_by_id_infoschema_save(company_id, asset_id, opts = {})
  data, _status_code, _headers = get_assets_by_id_infoschema_save_with_http_info(company_id, asset_id, opts)
  data
end

#get_assets_by_id_infoschema_save_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Retrieve and save an asset&#39;s information schema

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 886

def get_assets_by_id_infoschema_save_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id_infoschema_save ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id_infoschema_save"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_infoschema_save, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_infoschema_save, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id_infoschema_save, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_assets_by_id_infoschema_save"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_infoschema_save, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_infoschema_save, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.get_assets_by_id_infoschema_save, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/infoschema/save'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id_infoschema_save",
    :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: AssetsApi#get_assets_by_id_infoschema_save\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_infoschema_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Get the information schema for a specific asset&#39;s table

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 793

def get_assets_by_id_infoschema_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id_infoschema ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id_infoschema"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_infoschema, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_infoschema, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id_infoschema, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_assets_by_id_infoschema"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_infoschema, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_infoschema, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.get_assets_by_id_infoschema, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/infoschema'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id_infoschema",
    :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: AssetsApi#get_assets_by_id_infoschema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_predicted_price(company_id, asset_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Get AI-predicted pricing for a specific asset

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



969
970
971
972
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 969

def get_assets_by_id_predicted_price(company_id, asset_id, opts = {})
  data, _status_code, _headers = get_assets_by_id_predicted_price_with_http_info(company_id, asset_id, opts)
  data
end

#get_assets_by_id_predicted_price_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Get AI-predicted pricing for a specific asset

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 979

def get_assets_by_id_predicted_price_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id_predicted_price ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id_predicted_price"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_predicted_price, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_predicted_price, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id_predicted_price, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_assets_by_id_predicted_price"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_predicted_price, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_predicted_price, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.get_assets_by_id_predicted_price, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/predicted_price'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id_predicted_price",
    :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: AssetsApi#get_assets_by_id_predicted_price\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_statistics(company_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

Get statistics for all assets the user has access to

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Returns:



1061
1062
1063
1064
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1061

def get_assets_by_id_statistics(company_id, opts = {})
  data, _status_code, _headers = get_assets_by_id_statistics_with_http_info(company_id, opts)
  data
end

#get_assets_by_id_statistics_with_http_info(company_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Get statistics for all assets the user has access to

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Returns:



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1070

def get_assets_by_id_statistics_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id_statistics ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id_statistics"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_statistics, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_statistics, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id_statistics, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/statistics'.sub('{' + 'company_id' + '}', CGI.escape(company_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id_statistics",
    :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: AssetsApi#get_assets_by_id_statistics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_test(company_id, asset_id, opts = {}) ⇒ GetAssetsByIdAnalyze200Response

GET /companies/company_id/assets/asset_id/test

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



1136
1137
1138
1139
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1136

def get_assets_by_id_test(company_id, asset_id, opts = {})
  data, _status_code, _headers = get_assets_by_id_test_with_http_info(company_id, asset_id, opts)
  data
end

#get_assets_by_id_test_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

GET /companies/company_id/assets/asset_id/test

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1146

def get_assets_by_id_test_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id_test ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id_test"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_test, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id_test, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id_test, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_assets_by_id_test"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_test, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id_test, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.get_assets_by_id_test, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}/test'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_id_test",
    :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: AssetsApi#get_assets_by_id_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_assets_by_id_with_http_info(company_id, asset_id, opts = {}) ⇒ Array<(GetAssetsByIdAnalyze200Response, Integer, Hash)>

Get single asset by ID

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 540

def get_assets_by_id_with_http_info(company_id, asset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_assets_by_id ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.get_assets_by_id"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.get_assets_by_id, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.get_assets_by_id, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.get_assets_by_id"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.get_assets_by_id, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.get_assets_by_id, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetAssetsByIdAnalyze200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.get_assets_by_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: AssetsApi#get_assets_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_assets(company_id, opts = {}) ⇒ ListAssets200Response

Get all assets for a specific company

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



1233
1234
1235
1236
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1233

def list_assets(company_id, opts = {})
  data, _status_code, _headers = list_assets_with_http_info(company_id, opts)
  data
end

#list_assets_search(company_id, opts = {}) ⇒ ListAssets200Response

Search and filter assets with advanced options Query Parameters: q: Search query string category: Filter by category sport: Filter by sport tag sort_by: Sort field (name|recent|popular|trending) limit: Number of results (default 20, max 100) offset: Offset for pagination include_recommended: Include recommendations (true/false) include_schema: Include asset_schema in response (true/false, default false)

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:



1346
1347
1348
1349
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1346

def list_assets_search(company_id, opts = {})
  data, _status_code, _headers = list_assets_search_with_http_info(company_id, opts)
  data
end

#list_assets_search_with_http_info(company_id, opts = {}) ⇒ Array<(ListAssets200Response, Integer, Hash)>

Search and filter assets with advanced options Query Parameters: q: Search query string category: Filter by category sport: Filter by sport tag sort_by: Sort field (name|recent|popular|trending) limit: Number of results (default 20, max 100) offset: Offset for pagination include_recommended: Include recommendations (true/false) include_schema: Include asset_schema in response (true/false, default false)

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:

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

    ListAssets200Response data, response status code and response headers



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1360

def list_assets_search_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.list_assets_search ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.list_assets_search"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.list_assets_search, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.list_assets_search, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.list_assets_search, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AssetsApi.list_assets_search, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AssetsApi.list_assets_search, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AssetsApi.list_assets_search, must be greater than or equal to 1.'
  end

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AssetsApi.list_assets_search, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AssetsApi.list_assets_search, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets/search'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListAssets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.list_assets_search",
    :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: AssetsApi#list_assets_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_assets_with_http_info(company_id, opts = {}) ⇒ Array<(ListAssets200Response, Integer, Hash)>

Get all assets for a specific company

Parameters:

  • company_id (String) —

    Unique identifier for the Company

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number for pagination (default to 1)

  • :limit (Integer) —

    Number of items per page (default to 20)

  • :sort_by (String) —

    Field to sort by

  • :sort_order (String) —

    Sort order (ascending or descending) (default to ‘desc’)

  • :search (String) —

    Search term to filter results

Returns:

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

    ListAssets200Response data, response status code and response headers



1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1247

def list_assets_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.list_assets ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.list_assets"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.list_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.list_assets, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.list_assets, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AssetsApi.list_assets, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AssetsApi.list_assets, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AssetsApi.list_assets, must be greater than or equal to 1.'
  end

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
    fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AssetsApi.list_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AssetsApi.list_assets, the character length must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/companies/{company_id}/assets'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListAssets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.list_assets",
    :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: AssetsApi#list_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_assets(company_id, asset_id, assets_update, opts = {}) ⇒ UpdateAssets200Response

Update an existing asset by ID

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:



1456
1457
1458
1459
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1456

def update_assets(company_id, asset_id, assets_update, opts = {})
  data, _status_code, _headers = update_assets_with_http_info(company_id, asset_id, assets_update, opts)
  data
end

#update_assets_with_http_info(company_id, asset_id, assets_update, opts = {}) ⇒ Array<(UpdateAssets200Response, Integer, Hash)>

Update an existing asset by ID

Parameters:

  • company_id (String) —

    Unique identifier for the Company

  • asset_id (String) —

    Unique identifier for the Asset

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

    the optional parameters

Returns:

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

    UpdateAssets200Response data, response status code and response headers



1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/spartera_api_sdk/api/assets_api.rb', line 1467

def update_assets_with_http_info(company_id, asset_id, assets_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.update_assets ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling AssetsApi.update_assets"
  end
  if @api_client.config.client_side_validation && company_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.update_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && company_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "company_id" when calling AssetsApi.update_assets, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && company_id !~ pattern
    fail ArgumentError, "invalid value for 'company_id' when calling AssetsApi.update_assets, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'asset_id' is set
  if @api_client.config.client_side_validation && asset_id.nil?
    fail ArgumentError, "Missing the required parameter 'asset_id' when calling AssetsApi.update_assets"
  end
  if @api_client.config.client_side_validation && asset_id.to_s.length > 255
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.update_assets, the character length must be smaller than or equal to 255.'
  end

  if @api_client.config.client_side_validation && asset_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "asset_id" when calling AssetsApi.update_assets, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^[a-zA-Z0-9_-]+$/)
  if @api_client.config.client_side_validation && asset_id !~ pattern
    fail ArgumentError, "invalid value for 'asset_id' when calling AssetsApi.update_assets, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'assets_update' is set
  if @api_client.config.client_side_validation && assets_update.nil?
    fail ArgumentError, "Missing the required parameter 'assets_update' when calling AssetsApi.update_assets"
  end
  # resource path
  local_var_path = '/companies/{company_id}/assets/{asset_id}'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s)).sub('{' + 'asset_id' + '}', CGI.escape(asset_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']) unless header_params['Accept']
  # 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(assets_update)

  # return_type
  return_type = opts[:debug_return_type] || 'UpdateAssets200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"AssetsApi.update_assets",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#update_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end