Class: NucleusApi::ModelApi

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/api/model_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ModelApi

Returns a new instance of ModelApi.



19
20
21
 
# File 'lib/nucleus_api/api/model_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/nucleus_api/api/model_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_model_asset_size_using_post(req, opts = {}) ⇒ ModelAssetSize

Create a model asset size Create a new asset size record for a model.

Parameters:

  • req —

    req

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/nucleus_api/api/model_api.rb', line 27

def create_model_asset_size_using_post(req, opts = {})
  data, _status_code, _headers = create_model_asset_size_using_post_with_http_info(req, opts)
  data
end

#create_model_asset_size_using_post_with_http_info(req, opts = {}) ⇒ Array<(ModelAssetSize, Fixnum, Hash)>

Create a model asset size Create a new asset size record for a model.

Parameters:

  • req —

    req

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

    the optional parameters

Returns:

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

    ModelAssetSize data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/nucleus_api/api/model_api.rb', line 37

def create_model_asset_size_using_post_with_http_info(req, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.create_model_asset_size_using_post ...'
  end
  # verify the required parameter 'req' is set
  if @api_client.config.client_side_validation && req.nil?
    fail ArgumentError, "Missing the required parameter 'req' when calling ModelApi.create_model_asset_size_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_asset_size'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_model_change_using_post(change_request, model_id, opts = {}) ⇒ Array<ModelTransaction>

Change a model composition Model composition changes represent a change in a model’s holdings.

Parameters:

  • change_request —

    changeRequest

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:



82
83
84
85
 
# File 'lib/nucleus_api/api/model_api.rb', line 82

def create_model_change_using_post(change_request, model_id, opts = {})
  data, _status_code, _headers = create_model_change_using_post_with_http_info(change_request, model_id, opts)
  data
end

#create_model_change_using_post_with_http_info(change_request, model_id, opts = {}) ⇒ Array<(Array<ModelTransaction>, Fixnum, Hash)>

Change a model composition Model composition changes represent a change in a model’s holdings.

Parameters:

  • change_request —

    changeRequest

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:

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

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



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 93

def create_model_change_using_post_with_http_info(change_request, model_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.create_model_change_using_post ...'
  end
  # verify the required parameter 'change_request' is set
  if @api_client.config.client_side_validation && change_request.nil?
    fail ArgumentError, "Missing the required parameter 'change_request' when calling ModelApi.create_model_change_using_post"
  end
  # verify the required parameter 'model_id' is set
  if @api_client.config.client_side_validation && model_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_id' when calling ModelApi.create_model_change_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/model/{model_id}/model_change'.sub('{' + 'model_id' + '}', model_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_model_comment_using_post(model_comment_request, opts = {}) ⇒ ModelComment

Create a model commentary Create a new comment for a model available for your firm.

Parameters:

  • model_comment_request —

    modelCommentRequest

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

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/nucleus_api/api/model_api.rb', line 141

def create_model_comment_using_post(model_comment_request, opts = {})
  data, _status_code, _headers = create_model_comment_using_post_with_http_info(model_comment_request, opts)
  data
end

#create_model_comment_using_post_with_http_info(model_comment_request, opts = {}) ⇒ Array<(ModelComment, Fixnum, Hash)>

Create a model commentary Create a new comment for a model available for your firm.

Parameters:

  • model_comment_request —

    modelCommentRequest

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

    the optional parameters

Returns:

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

    ModelComment data, response status code and response headers



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

def create_model_comment_using_post_with_http_info(model_comment_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.create_model_comment_using_post ...'
  end
  # verify the required parameter 'model_comment_request' is set
  if @api_client.config.client_side_validation && model_comment_request.nil?
    fail ArgumentError, "Missing the required parameter 'model_comment_request' when calling ModelApi.create_model_comment_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_comment'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_model_holding_using_post(model_holding_request, opts = {}) ⇒ ModelHolding

Create a model holding Create a new model holding record for a specific model and date.

Parameters:

  • model_holding_request —

    modelHoldingRequest

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

    the optional parameters

Returns:



195
196
197
198
 
# File 'lib/nucleus_api/api/model_api.rb', line 195

def create_model_holding_using_post(model_holding_request, opts = {})
  data, _status_code, _headers = create_model_holding_using_post_with_http_info(model_holding_request, opts)
  data
end

#create_model_holding_using_post_with_http_info(model_holding_request, opts = {}) ⇒ Array<(ModelHolding, Fixnum, Hash)>

Create a model holding Create a new model holding record for a specific model and date.

Parameters:

  • model_holding_request —

    modelHoldingRequest

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

    the optional parameters

Returns:

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

    ModelHolding data, response status code and response headers



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

def create_model_holding_using_post_with_http_info(model_holding_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.create_model_holding_using_post ...'
  end
  # verify the required parameter 'model_holding_request' is set
  if @api_client.config.client_side_validation && model_holding_request.nil?
    fail ArgumentError, "Missing the required parameter 'model_holding_request' when calling ModelApi.create_model_holding_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_holding'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_model_transaction_using_post(model_transaction_request, opts = {}) ⇒ ModelTransaction

Create a model transaction Create a new transaction record for a security under a model for a specific date.

Parameters:

  • model_transaction_request —

    modelTransactionRequest

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

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/nucleus_api/api/model_api.rb', line 249

def create_model_transaction_using_post(model_transaction_request, opts = {})
  data, _status_code, _headers = create_model_transaction_using_post_with_http_info(model_transaction_request, opts)
  data
end

#create_model_transaction_using_post_with_http_info(model_transaction_request, opts = {}) ⇒ Array<(ModelTransaction, Fixnum, Hash)>

Create a model transaction Create a new transaction record for a security under a model for a specific date.

Parameters:

  • model_transaction_request —

    modelTransactionRequest

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

    the optional parameters

Returns:

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

    ModelTransaction data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 259

def create_model_transaction_using_post_with_http_info(model_transaction_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.create_model_transaction_using_post ...'
  end
  # verify the required parameter 'model_transaction_request' is set
  if @api_client.config.client_side_validation && model_transaction_request.nil?
    fail ArgumentError, "Missing the required parameter 'model_transaction_request' when calling ModelApi.create_model_transaction_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_transaction'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_model_using_post(model_info_request, opts = {}) ⇒ Model

Create a model Create a new model for your firm to which a portfolios can later subscribe.

Parameters:

  • model_info_request —

    modelInfoRequest

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

    the optional parameters

Returns:



303
304
305
306
 
# File 'lib/nucleus_api/api/model_api.rb', line 303

def create_model_using_post(model_info_request, opts = {})
  data, _status_code, _headers = create_model_using_post_with_http_info(model_info_request, opts)
  data
end

#create_model_using_post_with_http_info(model_info_request, opts = {}) ⇒ Array<(Model, Fixnum, Hash)>

Create a model Create a new model for your firm to which a portfolios can later subscribe.

Parameters:

  • model_info_request —

    modelInfoRequest

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

    the optional parameters

Returns:

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

    Model data, response status code and response headers



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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/nucleus_api/api/model_api.rb', line 313

def create_model_using_post_with_http_info(model_info_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.create_model_using_post ...'
  end
  # verify the required parameter 'model_info_request' is set
  if @api_client.config.client_side_validation && model_info_request.nil?
    fail ArgumentError, "Missing the required parameter 'model_info_request' when calling ModelApi.create_model_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/model'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_model_asset_size_using_delete(model_asset_size_id, opts = {}) ⇒ nil

Delete a model asset size Permanently delete a model asset size record for a model.

Parameters:

  • model_asset_size_id —

    UUID model_asset_size_id

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

    the optional parameters

Returns:

  • (nil) 


357
358
359
360
 
# File 'lib/nucleus_api/api/model_api.rb', line 357

def delete_model_asset_size_using_delete(model_asset_size_id, opts = {})
  delete_model_asset_size_using_delete_with_http_info(model_asset_size_id, opts)
  nil
end

#delete_model_asset_size_using_delete_with_http_info(model_asset_size_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a model asset size Permanently delete a model asset size record for a model.

Parameters:

  • model_asset_size_id —

    UUID model_asset_size_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 367

def delete_model_asset_size_using_delete_with_http_info(model_asset_size_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.delete_model_asset_size_using_delete ...'
  end
  # verify the required parameter 'model_asset_size_id' is set
  if @api_client.config.client_side_validation && model_asset_size_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_asset_size_id' when calling ModelApi.delete_model_asset_size_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_asset_size/{model_asset_size_id}'.sub('{' + 'model_asset_size_id' + '}', model_asset_size_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ModelApi#delete_model_asset_size_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_model_comment_using_delete(model_comment_id, opts = {}) ⇒ nil

Delete a model commentary Permanently delete a model comment for a model

Parameters:

  • model_comment_id —

    UUID model_comment_id

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

    the optional parameters

Returns:

  • (nil) 


408
409
410
411
 
# File 'lib/nucleus_api/api/model_api.rb', line 408

def delete_model_comment_using_delete(model_comment_id, opts = {})
  delete_model_comment_using_delete_with_http_info(model_comment_id, opts)
  nil
end

#delete_model_comment_using_delete_with_http_info(model_comment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a model commentary Permanently delete a model comment for a model

Parameters:

  • model_comment_id —

    UUID model_comment_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



418
419
420
421
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
 
# File 'lib/nucleus_api/api/model_api.rb', line 418

def delete_model_comment_using_delete_with_http_info(model_comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.delete_model_comment_using_delete ...'
  end
  # verify the required parameter 'model_comment_id' is set
  if @api_client.config.client_side_validation && model_comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_comment_id' when calling ModelApi.delete_model_comment_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_comment/{model_comment_id}'.sub('{' + 'model_comment_id' + '}', model_comment_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ModelApi#delete_model_comment_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_model_holding_using_delete(model_holding_id, opts = {}) ⇒ nil

Delete a model holding Permanently delete a model holding record for a model.

Parameters:

  • model_holding_id —

    UUID model_holding_id

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

    the optional parameters

Returns:

  • (nil) 


459
460
461
462
 
# File 'lib/nucleus_api/api/model_api.rb', line 459

def delete_model_holding_using_delete(model_holding_id, opts = {})
  delete_model_holding_using_delete_with_http_info(model_holding_id, opts)
  nil
end

#delete_model_holding_using_delete_with_http_info(model_holding_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a model holding Permanently delete a model holding record for a model.

Parameters:

  • model_holding_id —

    UUID model_holding_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 469

def delete_model_holding_using_delete_with_http_info(model_holding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.delete_model_holding_using_delete ...'
  end
  # verify the required parameter 'model_holding_id' is set
  if @api_client.config.client_side_validation && model_holding_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_holding_id' when calling ModelApi.delete_model_holding_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_holding/{model_holding_id}'.sub('{' + 'model_holding_id' + '}', model_holding_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ModelApi#delete_model_holding_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_model_transaction_using_delete(model_transaction_id, opts = {}) ⇒ nil

Delete a model transaction Permanently delete a model transaction for a model.

Parameters:

  • model_transaction_id —

    UUID model_transaction_id

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

    the optional parameters

Returns:

  • (nil) 


510
511
512
513
 
# File 'lib/nucleus_api/api/model_api.rb', line 510

def delete_model_transaction_using_delete(model_transaction_id, opts = {})
  delete_model_transaction_using_delete_with_http_info(model_transaction_id, opts)
  nil
end

#delete_model_transaction_using_delete_with_http_info(model_transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a model transaction Permanently delete a model transaction for a model.

Parameters:

  • model_transaction_id —

    UUID model_transaction_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/nucleus_api/api/model_api.rb', line 520

def delete_model_transaction_using_delete_with_http_info(model_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.delete_model_transaction_using_delete ...'
  end
  # verify the required parameter 'model_transaction_id' is set
  if @api_client.config.client_side_validation && model_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_transaction_id' when calling ModelApi.delete_model_transaction_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_transaction/{model_transaction_id}'.sub('{' + 'model_transaction_id' + '}', model_transaction_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ModelApi#delete_model_transaction_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_model_using_delete(model_id, opts = {}) ⇒ nil

Delete a model Permanently delete a model for your firm.

Parameters:

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:

  • (nil) 


561
562
563
564
 
# File 'lib/nucleus_api/api/model_api.rb', line 561

def delete_model_using_delete(model_id, opts = {})
  delete_model_using_delete_with_http_info(model_id, opts)
  nil
end

#delete_model_using_delete_with_http_info(model_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a model Permanently delete a model for your firm.

Parameters:

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 571

def delete_model_using_delete_with_http_info(model_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.delete_model_using_delete ...'
  end
  # verify the required parameter 'model_id' is set
  if @api_client.config.client_side_validation && model_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_id' when calling ModelApi.delete_model_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/model/{model_id}'.sub('{' + 'model_id' + '}', model_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  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: ModelApi#delete_model_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_model_all_using_get(opts = {}) ⇒ PageModel

List all models Get details for all models defined for your firm to which portfolios can subscribe.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



616
617
618
619
 
# File 'lib/nucleus_api/api/model_api.rb', line 616

def get_model_all_using_get(opts = {})
  data, _status_code, _headers = get_model_all_using_get_with_http_info(opts)
  data
end

#get_model_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageModel, Fixnum, Hash)>

List all models Get details for all models defined for your firm to which portfolios can subscribe.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageModel data, response status code and response headers



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
664
665
666
667
 
# File 'lib/nucleus_api/api/model_api.rb', line 630

def get_model_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/model'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

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

  # form parameters
  form_params = {}

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

#get_model_asset_size_all_using_get(opts = {}) ⇒ PageModelAssetSize

List all model asset sizes Get a list of asset sizes per date for all models defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



678
679
680
681
 
# File 'lib/nucleus_api/api/model_api.rb', line 678

def get_model_asset_size_all_using_get(opts = {})
  data, _status_code, _headers = get_model_asset_size_all_using_get_with_http_info(opts)
  data
end

#get_model_asset_size_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageModelAssetSize, Fixnum, Hash)>

List all model asset sizes Get a list of asset sizes per date for all models defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageModelAssetSize data, response status code and response headers



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
726
727
728
729
730
731
 
# File 'lib/nucleus_api/api/model_api.rb', line 693

def get_model_asset_size_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_asset_size_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/model_asset_size'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

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

  # form parameters
  form_params = {}

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

#get_model_asset_size_using_get(model_asset_size_id, opts = {}) ⇒ ModelAssetSize

Retrieve a model asset size Retrieve the information for a model asset size record for a model.

Parameters:

  • model_asset_size_id —

    UUID model_asset_size_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



738
739
740
741
 
# File 'lib/nucleus_api/api/model_api.rb', line 738

def get_model_asset_size_using_get(model_asset_size_id, opts = {})
  data, _status_code, _headers = get_model_asset_size_using_get_with_http_info(model_asset_size_id, opts)
  data
end

#get_model_asset_size_using_get_with_http_info(model_asset_size_id, opts = {}) ⇒ Array<(ModelAssetSize, Fixnum, Hash)>

Retrieve a model asset size Retrieve the information for a model asset size record for a model.

Parameters:

  • model_asset_size_id —

    UUID model_asset_size_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    ModelAssetSize data, response status code and response headers



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
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/nucleus_api/api/model_api.rb', line 749

def get_model_asset_size_using_get_with_http_info(model_asset_size_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_asset_size_using_get ...'
  end
  # verify the required parameter 'model_asset_size_id' is set
  if @api_client.config.client_side_validation && model_asset_size_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_asset_size_id' when calling ModelApi.get_model_asset_size_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_asset_size/{model_asset_size_id}'.sub('{' + 'model_asset_size_id' + '}', model_asset_size_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?

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

  # form parameters
  form_params = {}

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

#get_model_comment_all_using_get(opts = {}) ⇒ PageModelComment

List all model commentaries List all comments for all models defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



796
797
798
799
 
# File 'lib/nucleus_api/api/model_api.rb', line 796

def get_model_comment_all_using_get(opts = {})
  data, _status_code, _headers = get_model_comment_all_using_get_with_http_info(opts)
  data
end

#get_model_comment_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageModelComment, Fixnum, Hash)>

List all model commentaries List all comments for all models defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageModelComment data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 810

def get_model_comment_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_comment_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/model_comment'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

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

  # form parameters
  form_params = {}

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

#get_model_comment_using_get(model_comment_id, opts = {}) ⇒ ModelComment

Retrieve a model commentary Retrieve the information for a model comment for a model.

Parameters:

  • model_comment_id —

    UUID model_comment_id

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

    the optional parameters

Returns:



853
854
855
856
 
# File 'lib/nucleus_api/api/model_api.rb', line 853

def get_model_comment_using_get(model_comment_id, opts = {})
  data, _status_code, _headers = get_model_comment_using_get_with_http_info(model_comment_id, opts)
  data
end

#get_model_comment_using_get_with_http_info(model_comment_id, opts = {}) ⇒ Array<(ModelComment, Fixnum, Hash)>

Retrieve a model commentary Retrieve the information for a model comment for a model.

Parameters:

  • model_comment_id —

    UUID model_comment_id

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

    the optional parameters

Returns:

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

    ModelComment data, response status code and response headers



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
 
# File 'lib/nucleus_api/api/model_api.rb', line 863

def get_model_comment_using_get_with_http_info(model_comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_comment_using_get ...'
  end
  # verify the required parameter 'model_comment_id' is set
  if @api_client.config.client_side_validation && model_comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_comment_id' when calling ModelApi.get_model_comment_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_comment/{model_comment_id}'.sub('{' + 'model_comment_id' + '}', model_comment_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_model_holding_all_using_get(opts = {}) ⇒ PageModelHolding

List all model holdings Get all model holding records for all models defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



909
910
911
912
 
# File 'lib/nucleus_api/api/model_api.rb', line 909

def get_model_holding_all_using_get(opts = {})
  data, _status_code, _headers = get_model_holding_all_using_get_with_http_info(opts)
  data
end

#get_model_holding_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageModelHolding, Fixnum, Hash)>

List all model holdings Get all model holding records for all models defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageModelHolding data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 923

def get_model_holding_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_holding_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/model_holding'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

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

  # form parameters
  form_params = {}

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

#get_model_holding_using_get(model_holding_id, opts = {}) ⇒ ModelHolding

Retrieve a model holding Retrieve the information for a model holding record for a model.

Parameters:

  • model_holding_id —

    UUID model_holding_id

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

    the optional parameters

Returns:



966
967
968
969
 
# File 'lib/nucleus_api/api/model_api.rb', line 966

def get_model_holding_using_get(model_holding_id, opts = {})
  data, _status_code, _headers = get_model_holding_using_get_with_http_info(model_holding_id, opts)
  data
end

#get_model_holding_using_get_with_http_info(model_holding_id, opts = {}) ⇒ Array<(ModelHolding, Fixnum, Hash)>

Retrieve a model holding Retrieve the information for a model holding record for a model.

Parameters:

  • model_holding_id —

    UUID model_holding_id

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

    the optional parameters

Returns:

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

    ModelHolding data, response status code and response headers



976
977
978
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
 
# File 'lib/nucleus_api/api/model_api.rb', line 976

def get_model_holding_using_get_with_http_info(model_holding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_holding_using_get ...'
  end
  # verify the required parameter 'model_holding_id' is set
  if @api_client.config.client_side_validation && model_holding_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_holding_id' when calling ModelApi.get_model_holding_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_holding/{model_holding_id}'.sub('{' + 'model_holding_id' + '}', model_holding_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_model_transaction_all_using_get(opts = {}) ⇒ PageModelTransaction

List all model transactions Get details for all transaction records for all models defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1022
1023
1024
1025
 
# File 'lib/nucleus_api/api/model_api.rb', line 1022

def get_model_transaction_all_using_get(opts = {})
  data, _status_code, _headers = get_model_transaction_all_using_get_with_http_info(opts)
  data
end

#get_model_transaction_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageModelTransaction, Fixnum, Hash)>

List all model transactions Get details for all transaction records for all models defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageModelTransaction data, response status code and response headers



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/nucleus_api/api/model_api.rb', line 1036

def get_model_transaction_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_transaction_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/model_transaction'

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?

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

  # form parameters
  form_params = {}

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

#get_model_transaction_using_get(model_transaction_id, opts = {}) ⇒ ModelTransaction

Retrieve a model transaction Retrieve the information for a model transaction for a model.

Parameters:

  • model_transaction_id —

    UUID model_transaction_id

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

    the optional parameters

Returns:



1079
1080
1081
1082
 
# File 'lib/nucleus_api/api/model_api.rb', line 1079

def get_model_transaction_using_get(model_transaction_id, opts = {})
  data, _status_code, _headers = get_model_transaction_using_get_with_http_info(model_transaction_id, opts)
  data
end

#get_model_transaction_using_get_with_http_info(model_transaction_id, opts = {}) ⇒ Array<(ModelTransaction, Fixnum, Hash)>

Retrieve a model transaction Retrieve the information for a model transaction for a model.

Parameters:

  • model_transaction_id —

    UUID model_transaction_id

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

    the optional parameters

Returns:

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

    ModelTransaction data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 1089

def get_model_transaction_using_get_with_http_info(model_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_transaction_using_get ...'
  end
  # verify the required parameter 'model_transaction_id' is set
  if @api_client.config.client_side_validation && model_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_transaction_id' when calling ModelApi.get_model_transaction_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_transaction/{model_transaction_id}'.sub('{' + 'model_transaction_id' + '}', model_transaction_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_model_using_get(model_id, opts = {}) ⇒ Model

Retrieve a model Get the information for a model for your firm.

Parameters:

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:



1131
1132
1133
1134
 
# File 'lib/nucleus_api/api/model_api.rb', line 1131

def get_model_using_get(model_id, opts = {})
  data, _status_code, _headers = get_model_using_get_with_http_info(model_id, opts)
  data
end

#get_model_using_get_with_http_info(model_id, opts = {}) ⇒ Array<(Model, Fixnum, Hash)>

Retrieve a model Get the information for a model for your firm.

Parameters:

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:

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

    Model data, response status code and response headers



1141
1142
1143
1144
1145
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
 
# File 'lib/nucleus_api/api/model_api.rb', line 1141

def get_model_using_get_with_http_info(model_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.get_model_using_get ...'
  end
  # verify the required parameter 'model_id' is set
  if @api_client.config.client_side_validation && model_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_id' when calling ModelApi.get_model_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/model/{model_id}'.sub('{' + 'model_id' + '}', model_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_model_asset_size_using_put(model_asset_size, model_asset_size_id, opts = {}) ⇒ ModelAssetSize

Update a model asset size Update a model asset size record for a model.

Parameters:

  • model_asset_size —

    model_asset_size

  • model_asset_size_id —

    UUID model_asset_size_id

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

    the optional parameters

Returns:



1184
1185
1186
1187
 
# File 'lib/nucleus_api/api/model_api.rb', line 1184

def update_model_asset_size_using_put(model_asset_size, model_asset_size_id, opts = {})
  data, _status_code, _headers = update_model_asset_size_using_put_with_http_info(model_asset_size, model_asset_size_id, opts)
  data
end

#update_model_asset_size_using_put_with_http_info(model_asset_size, model_asset_size_id, opts = {}) ⇒ Array<(ModelAssetSize, Fixnum, Hash)>

Update a model asset size Update a model asset size record for a model.

Parameters:

  • model_asset_size —

    model_asset_size

  • model_asset_size_id —

    UUID model_asset_size_id

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

    the optional parameters

Returns:

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

    ModelAssetSize data, response status code and response headers



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
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'lib/nucleus_api/api/model_api.rb', line 1195

def update_model_asset_size_using_put_with_http_info(model_asset_size, model_asset_size_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.update_model_asset_size_using_put ...'
  end
  # verify the required parameter 'model_asset_size' is set
  if @api_client.config.client_side_validation && model_asset_size.nil?
    fail ArgumentError, "Missing the required parameter 'model_asset_size' when calling ModelApi.update_model_asset_size_using_put"
  end
  # verify the required parameter 'model_asset_size_id' is set
  if @api_client.config.client_side_validation && model_asset_size_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_asset_size_id' when calling ModelApi.update_model_asset_size_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_asset_size/{model_asset_size_id}'.sub('{' + 'model_asset_size_id' + '}', model_asset_size_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_model_comment_using_put(model_comment, model_comment_id, opts = {}) ⇒ ModelComment

Update a model commentary Update a model comment for a model.

Parameters:

  • model_comment —

    model_comment

  • model_comment_id —

    UUID model_comment_id

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

    the optional parameters

Returns:



1244
1245
1246
1247
 
# File 'lib/nucleus_api/api/model_api.rb', line 1244

def update_model_comment_using_put(model_comment, model_comment_id, opts = {})
  data, _status_code, _headers = update_model_comment_using_put_with_http_info(model_comment, model_comment_id, opts)
  data
end

#update_model_comment_using_put_with_http_info(model_comment, model_comment_id, opts = {}) ⇒ Array<(ModelComment, Fixnum, Hash)>

Update a model commentary Update a model comment for a model.

Parameters:

  • model_comment —

    model_comment

  • model_comment_id —

    UUID model_comment_id

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

    the optional parameters

Returns:

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

    ModelComment data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 1255

def update_model_comment_using_put_with_http_info(model_comment, model_comment_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.update_model_comment_using_put ...'
  end
  # verify the required parameter 'model_comment' is set
  if @api_client.config.client_side_validation && model_comment.nil?
    fail ArgumentError, "Missing the required parameter 'model_comment' when calling ModelApi.update_model_comment_using_put"
  end
  # verify the required parameter 'model_comment_id' is set
  if @api_client.config.client_side_validation && model_comment_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_comment_id' when calling ModelApi.update_model_comment_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_comment/{model_comment_id}'.sub('{' + 'model_comment_id' + '}', model_comment_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_model_holding_using_put(model_holding, model_holding_id, opts = {}) ⇒ ModelHolding

Update a model holding Update a model holding record for a model.

Parameters:

  • model_holding —

    model_holding

  • model_holding_id —

    UUID model_holding_id

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

    the optional parameters

Returns:



1304
1305
1306
1307
 
# File 'lib/nucleus_api/api/model_api.rb', line 1304

def update_model_holding_using_put(model_holding, model_holding_id, opts = {})
  data, _status_code, _headers = update_model_holding_using_put_with_http_info(model_holding, model_holding_id, opts)
  data
end

#update_model_holding_using_put_with_http_info(model_holding, model_holding_id, opts = {}) ⇒ Array<(ModelHolding, Fixnum, Hash)>

Update a model holding Update a model holding record for a model.

Parameters:

  • model_holding —

    model_holding

  • model_holding_id —

    UUID model_holding_id

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

    the optional parameters

Returns:

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

    ModelHolding data, response status code and response headers



1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/nucleus_api/api/model_api.rb', line 1315

def update_model_holding_using_put_with_http_info(model_holding, model_holding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.update_model_holding_using_put ...'
  end
  # verify the required parameter 'model_holding' is set
  if @api_client.config.client_side_validation && model_holding.nil?
    fail ArgumentError, "Missing the required parameter 'model_holding' when calling ModelApi.update_model_holding_using_put"
  end
  # verify the required parameter 'model_holding_id' is set
  if @api_client.config.client_side_validation && model_holding_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_holding_id' when calling ModelApi.update_model_holding_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_holding/{model_holding_id}'.sub('{' + 'model_holding_id' + '}', model_holding_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_model_transaction_using_put(model_transaction, model_transaction_id, opts = {}) ⇒ ModelTransaction

Update a model transaction Update a model transaction for a model.

Parameters:

  • model_transaction —

    model_transaction

  • model_transaction_id —

    UUID model_transaction_id

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

    the optional parameters

Returns:



1364
1365
1366
1367
 
# File 'lib/nucleus_api/api/model_api.rb', line 1364

def update_model_transaction_using_put(model_transaction, model_transaction_id, opts = {})
  data, _status_code, _headers = update_model_transaction_using_put_with_http_info(model_transaction, model_transaction_id, opts)
  data
end

#update_model_transaction_using_put_with_http_info(model_transaction, model_transaction_id, opts = {}) ⇒ Array<(ModelTransaction, Fixnum, Hash)>

Update a model transaction Update a model transaction for a model.

Parameters:

  • model_transaction —

    model_transaction

  • model_transaction_id —

    UUID model_transaction_id

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

    the optional parameters

Returns:

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

    ModelTransaction data, response status code and response headers



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
 
# File 'lib/nucleus_api/api/model_api.rb', line 1375

def update_model_transaction_using_put_with_http_info(model_transaction, model_transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.update_model_transaction_using_put ...'
  end
  # verify the required parameter 'model_transaction' is set
  if @api_client.config.client_side_validation && model_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'model_transaction' when calling ModelApi.update_model_transaction_using_put"
  end
  # verify the required parameter 'model_transaction_id' is set
  if @api_client.config.client_side_validation && model_transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_transaction_id' when calling ModelApi.update_model_transaction_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/model_transaction/{model_transaction_id}'.sub('{' + 'model_transaction_id' + '}', model_transaction_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_model_using_put(model, model_id, opts = {}) ⇒ Model

Update a model Update a model for your firm.

Parameters:

  • model —

    model

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:



1424
1425
1426
1427
 
# File 'lib/nucleus_api/api/model_api.rb', line 1424

def update_model_using_put(model, model_id, opts = {})
  data, _status_code, _headers = update_model_using_put_with_http_info(model, model_id, opts)
  data
end

#update_model_using_put_with_http_info(model, model_id, opts = {}) ⇒ Array<(Model, Fixnum, Hash)>

Update a model Update a model for your firm.

Parameters:

  • model —

    model

  • model_id —

    UUID model_id

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

    the optional parameters

Returns:

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

    Model data, response status code and response headers



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
 
# File 'lib/nucleus_api/api/model_api.rb', line 1435

def update_model_using_put_with_http_info(model, model_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ModelApi.update_model_using_put ...'
  end
  # verify the required parameter 'model' is set
  if @api_client.config.client_side_validation && model.nil?
    fail ArgumentError, "Missing the required parameter 'model' when calling ModelApi.update_model_using_put"
  end
  # verify the required parameter 'model_id' is set
  if @api_client.config.client_side_validation && model_id.nil?
    fail ArgumentError, "Missing the required parameter 'model_id' when calling ModelApi.update_model_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/model/{model_id}'.sub('{' + 'model_id' + '}', model_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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