Class: NucleusApi::AllocationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AllocationApi

Returns a new instance of AllocationApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_allocation_composition_using_post(alloc_request, opts = {}) ⇒ AllocationComposition

Create an allocation composition Create a new allocation composition record for an allocation.

Parameters:

  • alloc_request —

    allocRequest

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

    the optional parameters

Returns:



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

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

#create_allocation_composition_using_post_with_http_info(alloc_request, opts = {}) ⇒ Array<(AllocationComposition, Fixnum, Hash)>

Create an allocation composition Create a new allocation composition record for an allocation.

Parameters:

  • alloc_request —

    allocRequest

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

    the optional parameters

Returns:

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

    AllocationComposition 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/allocation_api.rb', line 37

def create_allocation_composition_using_post_with_http_info(alloc_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllocationApi.create_allocation_composition_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 AllocationApi.create_allocation_composition_using_post"
  end
  # resource path
  local_var_path = '/nucleus/v1/allocation_composition'

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

#create_allocation_using_post(allocation_request, opts = {}) ⇒ Allocation

Create an allocation Create a new allocation for your firm.

Parameters:

  • allocation_request —

    allocationRequest

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

    the optional parameters

Returns:



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

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

#create_allocation_using_post_with_http_info(allocation_request, opts = {}) ⇒ Array<(Allocation, Fixnum, Hash)>

Create an allocation Create a new allocation for your firm.

Parameters:

  • allocation_request —

    allocationRequest

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

    the optional parameters

Returns:

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

    Allocation 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/allocation_api.rb', line 91

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

#delete_allocation_composition_using_delete(allocation_composition_id, opts = {}) ⇒ nil

Delete an allocation composition Permanently delete an allocation composition record for an allocation.

Parameters:

  • allocation_composition_id —

    UUID allocation_composition_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_allocation_composition_using_delete(allocation_composition_id, opts = {})
  delete_allocation_composition_using_delete_with_http_info(allocation_composition_id, opts)
  nil
end

#delete_allocation_composition_using_delete_with_http_info(allocation_composition_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an allocation composition Permanently delete an allocation composition record for an allocation.

Parameters:

  • allocation_composition_id —

    UUID allocation_composition_id

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 145

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

#delete_allocation_using_delete(allocation_id, opts = {}) ⇒ nil

Delete an allocation Permanently delete an allocation defined by your firm.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 186

def delete_allocation_using_delete(allocation_id, opts = {})
  delete_allocation_using_delete_with_http_info(allocation_id, opts)
  nil
end

#delete_allocation_using_delete_with_http_info(allocation_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an allocation Permanently delete an allocation defined by your firm.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 196

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

#get_allocation_all_aggregate_data_using_get(allocation_id, opts = {}) ⇒ AllocationAggregatedVO

List all Allocation aggregated data overview

Parameters:

  • allocation_id —

    Allocation Id

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

    the optional parameters

Returns:



236
237
238
239
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 236

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

#get_allocation_all_aggregate_data_using_get_with_http_info(allocation_id, opts = {}) ⇒ Array<(AllocationAggregatedVO, Fixnum, Hash)>

List all Allocation aggregated data overview

Parameters:

  • allocation_id —

    Allocation Id

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

    the optional parameters

Returns:

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

    AllocationAggregatedVO data, response status code and response headers



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 245

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

#get_allocation_all_asset_size_all_using_get(allocation_id, opts = {}) ⇒ Array<DateDoubleVO>

List all allocation asset sizes Get a list of asset sizes by date for a specific allocation.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Options Hash (opts):

  • :end_date (Date) —

    end date

  • :get_latest (BOOLEAN) —

    get_latest

  • :is_current_weight (BOOLEAN) —

    is_current_weight (default to true)

  • :sort_type (String) —

    D (Daily), Q (quarterly), M (Monthly), Y (Annually)

  • :start_date (Date) —

    start date

Returns:



292
293
294
295
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 292

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

#get_allocation_all_asset_size_all_using_get_with_http_info(allocation_id, opts = {}) ⇒ Array<(Array<DateDoubleVO>, Fixnum, Hash)>

List all allocation asset sizes Get a list of asset sizes by date for a specific allocation.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Options Hash (opts):

  • :end_date (Date) —

    end date

  • :get_latest (BOOLEAN) —

    get_latest

  • :is_current_weight (BOOLEAN) —

    is_current_weight

  • :sort_type (String) —

    D (Daily), Q (quarterly), M (Monthly), Y (Annually)

  • :start_date (Date) —

    start date

Returns:

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

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



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
341
342
343
344
345
346
347
348
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 307

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

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

#get_allocation_all_holding_all_using_get(allocation_id, opts = {}) ⇒ Array<ModelHoldingVO>

List all allocation holdings Get the information for all securities assigned to a specific allocation.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Options Hash (opts):

  • :end_date (Date) —

    end date

  • :start_date (Date) —

    start date

Returns:



356
357
358
359
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 356

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

#get_allocation_all_holding_all_using_get_with_http_info(allocation_id, opts = {}) ⇒ Array<(Array<ModelHoldingVO>, Fixnum, Hash)>

List all allocation holdings Get the information for all securities assigned to a specific allocation.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Options Hash (opts):

  • :end_date (Date) —

    end date

  • :start_date (Date) —

    start date

Returns:

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

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 368

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

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

#get_allocation_all_transaction_all_using_get(allocation_id, opts = {}) ⇒ PageModelTransaction

List all allocation transactions Get the information for all transactions made under an allocation to achieve the composition of the allocation.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :end_date (Date) —

    end date

  • :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:



418
419
420
421
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 418

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

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

List all allocation transactions Get the information for all transactions made under an allocation to achieve the composition of the allocation.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :end_date (Date) —

    end date

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PageModelTransaction data, response status code and response headers



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 434

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

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

#get_allocation_all_using_get(opts = {}) ⇒ PageAllocation

List all allocations Get details for all allocations 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:



486
487
488
489
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 486

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

#get_allocation_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAllocation, Fixnum, Hash)>

List all allocations Get details for all allocations 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<(PageAllocation, Fixnum, Hash)>) —

    PageAllocation data, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 500

def get_allocation_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllocationApi.get_allocation_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/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 => 'PageAllocation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AllocationApi#get_allocation_all_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_allocation_composition_all_using_get(opts = {}) ⇒ PageAllocationComposition

List all allocations compositions Get the allocation composition for all allocations.

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:



547
548
549
550
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 547

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

#get_allocation_composition_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageAllocationComposition, Fixnum, Hash)>

List all allocations compositions Get the allocation composition for all allocations.

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

    PageAllocationComposition data, response status code and response headers



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

def get_allocation_composition_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AllocationApi.get_allocation_composition_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/allocation_composition'

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

#get_allocation_composition_using_get(allocation_composition_id, opts = {}) ⇒ AllocationComposition

Retrieve an allocation composition Retrieve the information of an allocation composition record for an allocation.

Parameters:

  • allocation_composition_id —

    UUID allocation_composition_id

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

    the optional parameters

Returns:



604
605
606
607
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 604

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

#get_allocation_composition_using_get_with_http_info(allocation_composition_id, opts = {}) ⇒ Array<(AllocationComposition, Fixnum, Hash)>

Retrieve an allocation composition Retrieve the information of an allocation composition record for an allocation.

Parameters:

  • allocation_composition_id —

    UUID allocation_composition_id

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

    the optional parameters

Returns:

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

    AllocationComposition data, response status code and response headers



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 614

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

#get_allocation_using_get(allocation_id, opts = {}) ⇒ Allocation

Retrieve an allocation Retrieve the information for an allocation defined by your firm.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Returns:



656
657
658
659
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 656

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

#get_allocation_using_get_with_http_info(allocation_id, opts = {}) ⇒ Array<(Allocation, Fixnum, Hash)>

Retrieve an allocation Retrieve the information for an allocation defined by your firm.

Parameters:

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Returns:

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

    Allocation data, response status code and response headers



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 666

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

#update_allocation_composition_using_put(allocation_composition, allocation_composition_id, opts = {}) ⇒ AllocationComposition

Update an allocation composition Update the information of an allocation composition record for an allocation.

Parameters:

  • allocation_composition —

    allocation_composition

  • allocation_composition_id —

    UUID allocation_composition_id

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

    the optional parameters

Returns:



709
710
711
712
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 709

def update_allocation_composition_using_put(allocation_composition, allocation_composition_id, opts = {})
  data, _status_code, _headers = update_allocation_composition_using_put_with_http_info(allocation_composition, allocation_composition_id, opts)
  data
end

#update_allocation_composition_using_put_with_http_info(allocation_composition, allocation_composition_id, opts = {}) ⇒ Array<(AllocationComposition, Fixnum, Hash)>

Update an allocation composition Update the information of an allocation composition record for an allocation.

Parameters:

  • allocation_composition —

    allocation_composition

  • allocation_composition_id —

    UUID allocation_composition_id

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

    the optional parameters

Returns:

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

    AllocationComposition data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 720

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

#update_allocation_using_put(allocation, allocation_id, opts = {}) ⇒ Allocation

Update an allocation Update an allocation defined by your firm.

Parameters:

  • allocation —

    allocation

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Returns:



769
770
771
772
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 769

def update_allocation_using_put(allocation, allocation_id, opts = {})
  data, _status_code, _headers = update_allocation_using_put_with_http_info(allocation, allocation_id, opts)
  data
end

#update_allocation_using_put_with_http_info(allocation, allocation_id, opts = {}) ⇒ Array<(Allocation, Fixnum, Hash)>

Update an allocation Update an allocation defined by your firm.

Parameters:

  • allocation —

    allocation

  • allocation_id —

    UUID allocation_id

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

    the optional parameters

Returns:

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

    Allocation data, response status code and response headers



780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/nucleus_api/api/allocation_api.rb', line 780

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