Class: SwaggerClient::AccountApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AccountApi

Returns a new instance of AccountApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_account_allocation_mapping_using_post(alloc_request, opts = {}) ⇒ AccountAllocationMapping

Create an account allocation Create an account-allocation mapping for an account.

Parameters:

  • alloc_request —

    allocRequest

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

    the optional parameters

Returns:

  • (AccountAllocationMapping) 


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

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

#create_account_allocation_mapping_using_post_with_http_info(alloc_request, opts = {}) ⇒ Array<(AccountAllocationMapping, Fixnum, Hash)>

Create an account allocation Create an account-allocation mapping for an account.

Parameters:

  • alloc_request —

    allocRequest

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

    the optional parameters

Returns:

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

    AccountAllocationMapping 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/account_api.rb', line 37

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

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

#create_account_status_using_post(account_status_request, opts = {}) ⇒ AccountStatus

Create an account status Create an account status record for an account.

Parameters:

  • account_status_request —

    accountStatusRequest

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

    the optional parameters

Returns:

  • (AccountStatus) 


81
82
83
84
 
# File 'lib/nucleus_api/api/account_api.rb', line 81

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

#create_account_status_using_post_with_http_info(account_status_request, opts = {}) ⇒ Array<(AccountStatus, Fixnum, Hash)>

Create an account status Create an account status record for an account.

Parameters:

  • account_status_request —

    accountStatusRequest

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

    the optional parameters

Returns:

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

    AccountStatus data, response status code and response headers



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

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

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

#create_account_type_using_post(account_type_request, opts = {}) ⇒ AccountType

Create an account type Create a new account type for your firm.

Parameters:

  • account_type_request —

    accountTypeRequest

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

    the optional parameters

Returns:

  • (AccountType) 


135
136
137
138
 
# File 'lib/nucleus_api/api/account_api.rb', line 135

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

#create_account_type_using_post_with_http_info(account_type_request, opts = {}) ⇒ Array<(AccountType, Fixnum, Hash)>

Create an account type Create a new account type for your firm.

Parameters:

  • account_type_request —

    accountTypeRequest

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

    the optional parameters

Returns:

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

    AccountType data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/nucleus_api/api/account_api.rb', line 145

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

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

#create_account_using_post(account, opts = {}) ⇒ Account

Create an account Create an account under a client.

Parameters:

  • account —

    account

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/nucleus_api/api/account_api.rb', line 189

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

#create_account_using_post_with_http_info(account, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Create an account Create an account under a client.

Parameters:

  • account —

    account

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



199
200
201
202
203
204
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
 
# File 'lib/nucleus_api/api/account_api.rb', line 199

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

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

#delete_account_allocation_mapping_using_delete(account_allocation_id, opts = {}) ⇒ nil

Delete an account allocation Permanently delete an account-allocation mapping for an account.

Parameters:

  • account_allocation_id —

    UUID account_allocation_id

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

    the optional parameters

Returns:

  • (nil) 


243
244
245
246
 
# File 'lib/nucleus_api/api/account_api.rb', line 243

def (, opts = {})
  (, opts)
  nil
end

#delete_account_allocation_mapping_using_delete_with_http_info(account_allocation_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an account allocation Permanently delete an account-allocation mapping for an account.

Parameters:

  • account_allocation_id —

    UUID account_allocation_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_account_allocation_mapping_using_delete ...'
  end
  # verify the required parameter 'account_allocation_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_allocation_id' when calling AccountApi.delete_account_allocation_mapping_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_allocation/{account_allocation_id}'.sub('{' + 'account_allocation_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: AccountApi#delete_account_allocation_mapping_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_permission_using_delete(account_id, opts = {}) ⇒ AccountPermissionVO

Delete an account permission Delete an account permission

Parameters:

  • account_id —

    account_id

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

    the optional parameters

Returns:

  • (AccountPermissionVO) 


294
295
296
297
 
# File 'lib/nucleus_api/api/account_api.rb', line 294

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

#delete_account_permission_using_delete_with_http_info(account_id, opts = {}) ⇒ Array<(AccountPermissionVO, Fixnum, Hash)>

Delete an account permission Delete an account permission

Parameters:

  • account_id —

    account_id

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

    the optional parameters

Returns:

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

    AccountPermissionVO data, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/nucleus_api/api/account_api.rb', line 304

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_account_permission_using_delete ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.delete_account_permission_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_permission/{account_id}'.sub('{' + 'account_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,
    :return_type => 'AccountPermissionVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#delete_account_permission_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_status_using_delete(account_status_id, opts = {}) ⇒ nil

Delete an account status Permanently delete an account status record from an account’s history.

Parameters:

  • account_status_id —

    UUID account_status_id

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

    the optional parameters

Returns:

  • (nil) 


346
347
348
349
 
# File 'lib/nucleus_api/api/account_api.rb', line 346

def (, opts = {})
  (, opts)
  nil
end

#delete_account_status_using_delete_with_http_info(account_status_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an account status Permanently delete an account status record from an account’s history.

Parameters:

  • account_status_id —

    UUID account_status_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_account_status_using_delete ...'
  end
  # verify the required parameter 'account_status_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_status_id' when calling AccountApi.delete_account_status_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_status/{account_status_id}'.sub('{' + 'account_status_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: AccountApi#delete_account_status_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_type_using_delete(account_type_id, opts = {}) ⇒ nil

Delete an account type Permanently delete a possible account type defined for your firm.

Parameters:

  • account_type_id —

    UUID account_type_id

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

    the optional parameters

Returns:

  • (nil) 


397
398
399
400
 
# File 'lib/nucleus_api/api/account_api.rb', line 397

def (, opts = {})
  (, opts)
  nil
end

#delete_account_type_using_delete_with_http_info(account_type_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an account type Permanently delete a possible account type defined for your firm.

Parameters:

  • account_type_id —

    UUID account_type_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



407
408
409
410
411
412
413
414
415
416
417
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
 
# File 'lib/nucleus_api/api/account_api.rb', line 407

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_account_type_using_delete ...'
  end
  # verify the required parameter 'account_type_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_type_id' when calling AccountApi.delete_account_type_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_type/{account_type_id}'.sub('{' + 'account_type_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: AccountApi#delete_account_type_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_account_using_delete(account_id, opts = {}) ⇒ nil

Delete an account Permanently delete an account under a client.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Returns:

  • (nil) 


448
449
450
451
 
# File 'lib/nucleus_api/api/account_api.rb', line 448

def (, opts = {})
  (, opts)
  nil
end

#delete_account_using_delete_with_http_info(account_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an account Permanently delete an account under a client.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.delete_account_using_delete ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.delete_account_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/account/{account_id}'.sub('{' + 'account_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: AccountApi#delete_account_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_all_using_get(opts = {}) ⇒ PageAccount

List all accounts Get information for all accounts for all clients 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:

  • (PageAccount) 


503
504
505
506
 
# File 'lib/nucleus_api/api/account_api.rb', line 503

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

#get_account_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAccount, Fixnum, Hash)>

List all accounts Get information for all accounts for all clients 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<(PageAccount, Fixnum, Hash)>) —

    PageAccount data, response status code and response headers



517
518
519
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
 
# File 'lib/nucleus_api/api/account_api.rb', line 517

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/account'

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

#get_account_allocation_mapping_all_using_get(opts = {}) ⇒ PageAccountAllocationMapping

List all account allocations Get information for all account-allocation mappings for all accounts 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:

  • (PageAccountAllocationMapping) 


564
565
566
567
 
# File 'lib/nucleus_api/api/account_api.rb', line 564

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

#get_account_allocation_mapping_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAccountAllocationMapping, Fixnum, Hash)>

List all account allocations Get information for all account-allocation mappings for all accounts 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<(PageAccountAllocationMapping, Fixnum, Hash)>) —

    PageAccountAllocationMapping data, response status code and response headers



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

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_allocation_mapping_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/account_allocation'

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

#get_account_allocation_mapping_using_get(account_allocation_id, opts = {}) ⇒ AccountAllocationMapping

Retrieve an account allocation Retrieve the information for a specific account-allocation mapping for an account.

Parameters:

  • account_allocation_id —

    UUID account_allocation_id

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

    the optional parameters

Returns:

  • (AccountAllocationMapping) 


621
622
623
624
 
# File 'lib/nucleus_api/api/account_api.rb', line 621

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

#get_account_allocation_mapping_using_get_with_http_info(account_allocation_id, opts = {}) ⇒ Array<(AccountAllocationMapping, Fixnum, Hash)>

Retrieve an account allocation Retrieve the information for a specific account-allocation mapping for an account.

Parameters:

  • account_allocation_id —

    UUID account_allocation_id

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

    the optional parameters

Returns:

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

    AccountAllocationMapping data, response status code and response headers



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/account_api.rb', line 631

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_allocation_mapping_using_get ...'
  end
  # verify the required parameter 'account_allocation_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_allocation_id' when calling AccountApi.get_account_allocation_mapping_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_allocation/{account_allocation_id}'.sub('{' + 'account_allocation_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 => 'AccountAllocationMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_allocation_mapping_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_asset_size_agg_all_using_get(account_id, opts = {}) ⇒ Array<AvailableDateDoubleVO>

List all account asset sizes Get a list of asset sizes by date for an account.

Parameters:

  • account_id —

    Account Id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :exclude_subledger (BOOLEAN) —

    true or false

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

    Quarter (Q), Monthly (M) , Annually (Y), Daily (D) –caps matter, codes in ()

  • :start_date (Date) —

    start date

Returns:

  • (Array<AvailableDateDoubleVO>) 


679
680
681
682
 
# File 'lib/nucleus_api/api/account_api.rb', line 679

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

#get_account_asset_size_agg_all_using_get_with_http_info(account_id, opts = {}) ⇒ Array<(Array<AvailableDateDoubleVO>, Fixnum, Hash)>

List all account asset sizes Get a list of asset sizes by date for an account.

Parameters:

  • account_id —

    Account Id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :exclude_subledger (BOOLEAN) —

    true or false

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

    Quarter (Q), Monthly (M) , Annually (Y), Daily (D) –caps matter, codes in ()

  • :start_date (Date) —

    start date

Returns:

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

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



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
732
733
734
735
736
737
 
# File 'lib/nucleus_api/api/account_api.rb', line 695

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

  # query parameters
  query_params = {}
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'exclude_subledger'] = opts[:'exclude_subledger'] if !opts[:'exclude_subledger'].nil?
  query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].nil?
  query_params[:'sort_type'] = opts[:'sort_type'] if !opts[:'sort_type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'Array<AvailableDateDoubleVO>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_asset_size_agg_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_overview_using_get(account_id, opts = {}) ⇒ Object

List all Account overview

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :order_by (String) —

    order_by (default to update_date)

Returns:

  • (Object) 


744
745
746
747
 
# File 'lib/nucleus_api/api/account_api.rb', line 744

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

#get_account_overview_using_get_with_http_info(account_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

List all Account overview

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :order_by (String) —

    order_by

Returns:

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

    Object data, response status code and response headers



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
787
788
789
790
791
792
793
 
# File 'lib/nucleus_api/api/account_api.rb', line 755

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

  # query parameters
  query_params = {}
  query_params[:'ascending'] = opts[:'ascending'] if !opts[:'ascending'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].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 => 'Object')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_overview_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_permission_using_get(account_id, opts = {}) ⇒ AccountPermissionVO

Get an account permission Get an account permission

Parameters:

  • account_id —

    account_id

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

    the optional parameters

Returns:

  • (AccountPermissionVO) 


799
800
801
802
 
# File 'lib/nucleus_api/api/account_api.rb', line 799

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

#get_account_permission_using_get_with_http_info(account_id, opts = {}) ⇒ Array<(AccountPermissionVO, Fixnum, Hash)>

Get an account permission Get an account permission

Parameters:

  • account_id —

    account_id

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

    the optional parameters

Returns:

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

    AccountPermissionVO data, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_permission_using_get ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.get_account_permission_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_permission/{account_id}'.sub('{' + 'account_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 => 'AccountPermissionVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_permission_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_status_all_using_get(opts = {}) ⇒ PageAccountStatus

List all account statuses Get the account status history information for all accounts.

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:

  • (PageAccountStatus) 


855
856
857
858
 
# File 'lib/nucleus_api/api/account_api.rb', line 855

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

#get_account_status_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAccountStatus, Fixnum, Hash)>

List all account statuses Get the account status history information for all accounts.

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<(PageAccountStatus, Fixnum, Hash)>) —

    PageAccountStatus data, response status code and response headers



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
900
901
902
903
904
905
906
 
# File 'lib/nucleus_api/api/account_api.rb', line 869

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_status_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/account_status'

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

#get_account_status_using_get(account_status_id, opts = {}) ⇒ AccountStatus

Retrieve an account status Retrieve the information for a specific account status record for an account.

Parameters:

  • account_status_id —

    UUID account_status_id

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

    the optional parameters

Returns:

  • (AccountStatus) 


912
913
914
915
 
# File 'lib/nucleus_api/api/account_api.rb', line 912

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

#get_account_status_using_get_with_http_info(account_status_id, opts = {}) ⇒ Array<(AccountStatus, Fixnum, Hash)>

Retrieve an account status Retrieve the information for a specific account status record for an account.

Parameters:

  • account_status_id —

    UUID account_status_id

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

    the optional parameters

Returns:

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

    AccountStatus data, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_status_using_get ...'
  end
  # verify the required parameter 'account_status_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_status_id' when calling AccountApi.get_account_status_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_status/{account_status_id}'.sub('{' + 'account_status_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 => 'AccountStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_status_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_type_all_using_get(opts = {}) ⇒ PageAccountType

List all account types List all account types 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:

  • (PageAccountType) 


968
969
970
971
 
# File 'lib/nucleus_api/api/account_api.rb', line 968

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

#get_account_type_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAccountType, Fixnum, Hash)>

List all account types List all account types 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<(PageAccountType, Fixnum, Hash)>) —

    PageAccountType data, response status code and response headers



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

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_type_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/account_type'

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

#get_account_type_using_get(account_type_id, opts = {}) ⇒ AccountType

Get an Account Type Get an account types defined for your firm.

Parameters:

  • account_type_id —

    UUID account_type_id

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

    the optional parameters

Returns:

  • (AccountType) 


1025
1026
1027
1028
 
# File 'lib/nucleus_api/api/account_api.rb', line 1025

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

#get_account_type_using_get_with_http_info(account_type_id, opts = {}) ⇒ Array<(AccountType, Fixnum, Hash)>

Get an Account Type Get an account types defined for your firm.

Parameters:

  • account_type_id —

    UUID account_type_id

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

    the optional parameters

Returns:

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

    AccountType data, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_type_using_get ...'
  end
  # verify the required parameter 'account_type_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_type_id' when calling AccountApi.get_account_type_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_type/{account_type_id}'.sub('{' + 'account_type_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 => 'AccountType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_type_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_account_using_get(account_id, opts = {}) ⇒ Account

Retrieve an account Retrieve the information for a specific account associated with a client.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Returns:



1077
1078
1079
1080
 
# File 'lib/nucleus_api/api/account_api.rb', line 1077

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

#get_account_using_get_with_http_info(account_id, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Retrieve an account Retrieve the information for a specific account associated with a client.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



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

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_account_using_get ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.get_account_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/account/{account_id}'.sub('{' + 'account_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 => 'Account')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_account_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_account_permission_using_get(opts = {}) ⇒ PageAccountPermissionVO

List all account permission List all account permission

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:

  • (PageAccountPermissionVO) 


1133
1134
1135
1136
 
# File 'lib/nucleus_api/api/account_api.rb', line 1133

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

#get_all_account_permission_using_get_with_http_info(opts = {}) ⇒ Array<(PageAccountPermissionVO, Fixnum, Hash)>

List all account permission List all account permission

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<(PageAccountPermissionVO, Fixnum, Hash)>) —

    PageAccountPermissionVO data, response status code and response headers



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

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.get_all_account_permission_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/account_permission'

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

#get_portfolio_holding_agg_all_using_get(account_id, opts = {}) ⇒ PagePortfolioHoldingAgg

List all account holdings Get information for all the securities that are currently being held by an account.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by (default to date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date

Returns:

  • (PagePortfolioHoldingAgg) 


1199
1200
1201
1202
 
# File 'lib/nucleus_api/api/account_api.rb', line 1199

def get_portfolio_holding_agg_all_using_get(, opts = {})
  data, _status_code, _headers = get_portfolio_holding_agg_all_using_get_with_http_info(, opts)
  data
end

#get_portfolio_holding_agg_all_using_get_with_http_info(account_id, opts = {}) ⇒ Array<(PagePortfolioHoldingAgg, Fixnum, Hash)>

List all account holdings Get information for all the securities that are currently being held by an account.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PagePortfolioHoldingAgg data, response status code and response headers



1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
 
# File 'lib/nucleus_api/api/account_api.rb', line 1218

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

  # 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[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
  query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].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?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'PagePortfolioHoldingAgg')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_portfolio_holding_agg_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_portfolio_transaction_agg_all_using_get(account_id, opts = {}) ⇒ PagePortfolioTransaction

List all account transactions Get the information for all transactions for an account.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date

Returns:

  • (PagePortfolioTransaction) 


1277
1278
1279
1280
 
# File 'lib/nucleus_api/api/account_api.rb', line 1277

def get_portfolio_transaction_agg_all_using_get(, opts = {})
  data, _status_code, _headers = get_portfolio_transaction_agg_all_using_get_with_http_info(, opts)
  data
end

#get_portfolio_transaction_agg_all_using_get_with_http_info(account_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>

List all account transactions Get the information for all transactions for an account.

Parameters:

  • account_id —

    UUID account_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    USD

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



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
1336
1337
1338
1339
 
# File 'lib/nucleus_api/api/account_api.rb', line 1295

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

  # 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[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].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?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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 => 'PagePortfolioTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#get_portfolio_transaction_agg_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#insert_account_and_related_permission_using_post(acl_client_permission_vo, opts = {}) ⇒ AccountPermissionVO

create an account permission create an account permission

Parameters:

  • acl_client_permission_vo —

    aclClientPermissionVO

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

    the optional parameters

Returns:

  • (AccountPermissionVO) 


1345
1346
1347
1348
 
# File 'lib/nucleus_api/api/account_api.rb', line 1345

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

#insert_account_and_related_permission_using_post_with_http_info(acl_client_permission_vo, opts = {}) ⇒ Array<(AccountPermissionVO, Fixnum, Hash)>

create an account permission create an account permission

Parameters:

  • acl_client_permission_vo —

    aclClientPermissionVO

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

    the optional parameters

Returns:

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

    AccountPermissionVO data, response status code and response headers



1355
1356
1357
1358
1359
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
 
# File 'lib/nucleus_api/api/account_api.rb', line 1355

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

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

#subscribe_account_using_post(account_id, alloc_request, opts = {}) ⇒ Array<Portfolio>

Subscribe an account After creating an account, you may create portfolios for the account to track a client’s investment, savings, or insurance products.

Parameters:

  • account_id —

    UUID account_id

  • alloc_request —

    allocRequest

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

    the optional parameters

Returns:

  • (Array<Portfolio>) 


1400
1401
1402
1403
 
# File 'lib/nucleus_api/api/account_api.rb', line 1400

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

#subscribe_account_using_post_with_http_info(account_id, alloc_request, opts = {}) ⇒ Array<(Array<Portfolio>, Fixnum, Hash)>

Subscribe an account After creating an account, you may create portfolios for the account to track a client’s investment, savings, or insurance products.

Parameters:

  • account_id —

    UUID account_id

  • alloc_request —

    allocRequest

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

    the optional parameters

Returns:

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

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



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
1449
1450
1451
1452
1453
 
# File 'lib/nucleus_api/api/account_api.rb', line 1411

def (, alloc_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.subscribe_account_using_post ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.subscribe_account_using_post"
  end
  # verify the required parameter 'alloc_request' is set
  if @api_client.config.client_side_validation && alloc_request.nil?
    fail ArgumentError, "Missing the required parameter 'alloc_request' when calling AccountApi.subscribe_account_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/account/{account_id}/subscribe'.sub('{' + 'account_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(alloc_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<Portfolio>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#subscribe_account_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_allocation_mapping_using_put(account_allocation_id, account_allocation_mapping, opts = {}) ⇒ AccountAllocationMapping

Update an account allocation Update the information for an account-allocation mapping.

Parameters:

  • account_allocation_id —

    UUID account_allocation_id

  • account_allocation_mapping —

    account_allocation_mapping

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

    the optional parameters

Returns:

  • (AccountAllocationMapping) 


1460
1461
1462
1463
 
# File 'lib/nucleus_api/api/account_api.rb', line 1460

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

#update_account_allocation_mapping_using_put_with_http_info(account_allocation_id, account_allocation_mapping, opts = {}) ⇒ Array<(AccountAllocationMapping, Fixnum, Hash)>

Update an account allocation Update the information for an account-allocation mapping.

Parameters:

  • account_allocation_id —

    UUID account_allocation_id

  • account_allocation_mapping —

    account_allocation_mapping

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

    the optional parameters

Returns:

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

    AccountAllocationMapping data, response status code and response headers



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

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.update_account_allocation_mapping_using_put ...'
  end
  # verify the required parameter 'account_allocation_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_allocation_id' when calling AccountApi.update_account_allocation_mapping_using_put"
  end
  # verify the required parameter 'account_allocation_mapping' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_allocation_mapping' when calling AccountApi.update_account_allocation_mapping_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_allocation/{account_allocation_id}'.sub('{' + 'account_allocation_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()
  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 => 'AccountAllocationMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#update_account_allocation_mapping_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_status_using_put(account_status, account_status_id, opts = {}) ⇒ AccountStatus

Update an account status Update an account status record for an account.

Parameters:

  • account_status —

    account_status

  • account_status_id —

    UUID account_status_id

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

    the optional parameters

Returns:

  • (AccountStatus) 


1520
1521
1522
1523
 
# File 'lib/nucleus_api/api/account_api.rb', line 1520

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

#update_account_status_using_put_with_http_info(account_status, account_status_id, opts = {}) ⇒ Array<(AccountStatus, Fixnum, Hash)>

Update an account status Update an account status record for an account.

Parameters:

  • account_status —

    account_status

  • account_status_id —

    UUID account_status_id

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

    the optional parameters

Returns:

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

    AccountStatus data, response status code and response headers



1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/nucleus_api/api/account_api.rb', line 1531

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.update_account_status_using_put ...'
  end
  # verify the required parameter 'account_status' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_status' when calling AccountApi.update_account_status_using_put"
  end
  # verify the required parameter 'account_status_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_status_id' when calling AccountApi.update_account_status_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_status/{account_status_id}'.sub('{' + 'account_status_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()
  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 => 'AccountStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#update_account_status_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_type_using_put(account_type, account_type_id, opts = {}) ⇒ AccountType

Update an account type Update the information for a possible account type defined for your firm.

Parameters:

  • account_type —

    account_type

  • account_type_id —

    UUID account_type_id

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

    the optional parameters

Returns:

  • (AccountType) 


1580
1581
1582
1583
 
# File 'lib/nucleus_api/api/account_api.rb', line 1580

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

#update_account_type_using_put_with_http_info(account_type, account_type_id, opts = {}) ⇒ Array<(AccountType, Fixnum, Hash)>

Update an account type Update the information for a possible account type defined for your firm.

Parameters:

  • account_type —

    account_type

  • account_type_id —

    UUID account_type_id

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

    the optional parameters

Returns:

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

    AccountType data, response status code and response headers



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
 
# File 'lib/nucleus_api/api/account_api.rb', line 1591

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.update_account_type_using_put ...'
  end
  # verify the required parameter 'account_type' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_type' when calling AccountApi.update_account_type_using_put"
  end
  # verify the required parameter 'account_type_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_type_id' when calling AccountApi.update_account_type_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_type/{account_type_id}'.sub('{' + 'account_type_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()
  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 => 'AccountType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#update_account_type_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_account_using_put(account, account_id, opts = {}) ⇒ Account

Update an account Update the information for an account.

Parameters:

  • account —

    account

  • account_id —

    UUID account_id

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

    the optional parameters

Returns:



1640
1641
1642
1643
 
# File 'lib/nucleus_api/api/account_api.rb', line 1640

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

#update_account_using_put_with_http_info(account, account_id, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Update an account Update the information for an account.

Parameters:

  • account —

    account

  • account_id —

    UUID account_id

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

    the optional parameters

Returns:

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

    Account data, response status code and response headers



1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
 
# File 'lib/nucleus_api/api/account_api.rb', line 1651

def (, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.update_account_using_put ...'
  end
  # verify the required parameter 'account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account' when calling AccountApi.update_account_using_put"
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.update_account_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/account/{account_id}'.sub('{' + 'account_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()
  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 => 'Account')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#update_account_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_client_account_permission_using_put(account_id, acl_client_permission_vo, opts = {}) ⇒ AccountPermissionVO

Update an account permission Update an account permission

Parameters:

  • account_id —

    account_id

  • acl_client_permission_vo —

    aclClientPermissionVO

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

    the optional parameters

Returns:

  • (AccountPermissionVO) 


1700
1701
1702
1703
 
# File 'lib/nucleus_api/api/account_api.rb', line 1700

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

#update_client_account_permission_using_put_with_http_info(account_id, acl_client_permission_vo, opts = {}) ⇒ Array<(AccountPermissionVO, Fixnum, Hash)>

Update an account permission Update an account permission

Parameters:

  • account_id —

    account_id

  • acl_client_permission_vo —

    aclClientPermissionVO

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

    the optional parameters

Returns:

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

    AccountPermissionVO data, response status code and response headers



1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
 
# File 'lib/nucleus_api/api/account_api.rb', line 1711

def (, acl_client_permission_vo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountApi.update_client_account_permission_using_put ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountApi.update_client_account_permission_using_put"
  end
  # verify the required parameter 'acl_client_permission_vo' is set
  if @api_client.config.client_side_validation && acl_client_permission_vo.nil?
    fail ArgumentError, "Missing the required parameter 'acl_client_permission_vo' when calling AccountApi.update_client_account_permission_using_put"
  end
  # resource path
  local_var_path = '/nucleus/v1/account_permission/{account_id}'.sub('{' + 'account_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(acl_client_permission_vo)
  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 => 'AccountPermissionVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountApi#update_client_account_permission_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end