Class: NucleusApi::PortfolioApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PortfolioApi

Returns a new instance of PortfolioApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_portfolio_asset_size_using_post(portfolio_asset_size_log_request, opts = {}) ⇒ PortfolioAssetSizeLog

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

Parameters:

  • portfolio_asset_size_log_request —

    portfolioAssetSizeLogRequest

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

    the optional parameters

Returns:



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

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

#create_portfolio_asset_size_using_post_with_http_info(portfolio_asset_size_log_request, opts = {}) ⇒ Array<(PortfolioAssetSizeLog, Fixnum, Hash)>

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

Parameters:

  • portfolio_asset_size_log_request —

    portfolioAssetSizeLogRequest

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

    the optional parameters

Returns:

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

    PortfolioAssetSizeLog 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/portfolio_api.rb', line 37

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(portfolio_asset_size_log_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 => 'PortfolioAssetSizeLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortfolioApi#create_portfolio_asset_size_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_portfolio_comment_using_post(portfolio_comment, opts = {}) ⇒ PortfolioComment

Create a portfolio commentary Create a new comment for a portfolio defined for your firm.

Parameters:

  • portfolio_comment —

    portfolioComment

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

    the optional parameters

Returns:



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

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

#create_portfolio_comment_using_post_with_http_info(portfolio_comment, opts = {}) ⇒ Array<(PortfolioComment, Fixnum, Hash)>

Create a portfolio commentary Create a new comment for a portfolio defined for your firm.

Parameters:

  • portfolio_comment —

    portfolioComment

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

    the optional parameters

Returns:

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

    PortfolioComment 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/portfolio_api.rb', line 91

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(portfolio_comment)
  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 => 'PortfolioComment')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortfolioApi#create_portfolio_comment_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_portfolio_goal_using_post(portfolio_goal, opts = {}) ⇒ PortfolioGoal

Create an portfolio goal Create an portfolio goal.

Parameters:

  • portfolio_goal —

    portfolioGoal

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

    the optional parameters

Returns:



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

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

#create_portfolio_goal_using_post_with_http_info(portfolio_goal, opts = {}) ⇒ Array<(PortfolioGoal, Fixnum, Hash)>

Create an portfolio goal Create an portfolio goal.

Parameters:

  • portfolio_goal —

    portfolioGoal

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

    the optional parameters

Returns:

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

    PortfolioGoal 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/portfolio_api.rb', line 145

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

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

#create_portfolio_holding_using_post(portfolio_holdin_log_request, opts = {}) ⇒ PortfolioHoldingLog

Create a portfolio holding Create a new holding record for a portfolio.

Parameters:

  • portfolio_holdin_log_request —

    portfolioHoldinLogRequest

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

    the optional parameters

Returns:



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

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

#create_portfolio_holding_using_post_with_http_info(portfolio_holdin_log_request, opts = {}) ⇒ Array<(PortfolioHoldingLog, Fixnum, Hash)>

Create a portfolio holding Create a new holding record for a portfolio.

Parameters:

  • portfolio_holdin_log_request —

    portfolioHoldinLogRequest

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

    the optional parameters

Returns:

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

    PortfolioHoldingLog 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/portfolio_api.rb', line 199

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(portfolio_holdin_log_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 => 'PortfolioHoldingLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortfolioApi#create_portfolio_holding_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_portfolio_transaction_using_post(portfolio_transaction_request, opts = {}) ⇒ PortfolioTransaction

Create a portfolio transaction Create a new transaction record for a portfolio.

Parameters:

  • portfolio_transaction_request —

    portfolioTransactionRequest

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

    the optional parameters

Returns:



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

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

#create_portfolio_transaction_using_post_with_http_info(portfolio_transaction_request, opts = {}) ⇒ Array<(PortfolioTransaction, Fixnum, Hash)>

Create a portfolio transaction Create a new transaction record for a portfolio.

Parameters:

  • portfolio_transaction_request —

    portfolioTransactionRequest

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

    the optional parameters

Returns:

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

    PortfolioTransaction data, 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
289
290
291
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 253

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_portfolio_using_post(portfolio_request, opts = {}) ⇒ Portfolio

Create a portfolio Create a new portfolio for an account.

Parameters:

  • portfolio_request —

    portfolioRequest

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 297

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

#create_portfolio_using_post_with_http_info(portfolio_request, opts = {}) ⇒ Array<(Portfolio, Fixnum, Hash)>

Create a portfolio Create a new portfolio for an account.

Parameters:

  • portfolio_request —

    portfolioRequest

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

    the optional parameters

Returns:

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

    Portfolio 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
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 307

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

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

#delete_portfolio_asset_size_using_delete(portfolio_asset_size_id, opts = {}) ⇒ nil

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

Parameters:

  • portfolio_asset_size_id —

    UUID portfolio_asset_size_id

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

    the optional parameters

Returns:

  • (nil) 


351
352
353
354
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 351

def delete_portfolio_asset_size_using_delete(portfolio_asset_size_id, opts = {})
  delete_portfolio_asset_size_using_delete_with_http_info(portfolio_asset_size_id, opts)
  nil
end

#delete_portfolio_asset_size_using_delete_with_http_info(portfolio_asset_size_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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

Parameters:

  • portfolio_asset_size_id —

    UUID portfolio_asset_size_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 361

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_portfolio_comment_using_delete(portfolio_comment_id, opts = {}) ⇒ nil

Delete a portfolio commentary Permanently delete a portfolio comment for a portfolio.

Parameters:

  • portfolio_comment_id —

    UUID portfolio_comment_id

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

    the optional parameters

Returns:

  • (nil) 


402
403
404
405
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 402

def delete_portfolio_comment_using_delete(portfolio_comment_id, opts = {})
  delete_portfolio_comment_using_delete_with_http_info(portfolio_comment_id, opts)
  nil
end

#delete_portfolio_comment_using_delete_with_http_info(portfolio_comment_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a portfolio commentary Permanently delete a portfolio comment for a portfolio.

Parameters:

  • portfolio_comment_id —

    UUID portfolio_comment_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
443
444
445
446
447
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 412

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_portfolio_goal_using_delete(portfolio_goal_id, opts = {}) ⇒ nil

Delete an portfolio goal Permanently delete an portfolio-goal mapping.

Parameters:

  • portfolio_goal_id —

    UUID portfolio_goal_id

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

    the optional parameters

Returns:

  • (nil) 


453
454
455
456
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 453

def delete_portfolio_goal_using_delete(portfolio_goal_id, opts = {})
  delete_portfolio_goal_using_delete_with_http_info(portfolio_goal_id, opts)
  nil
end

#delete_portfolio_goal_using_delete_with_http_info(portfolio_goal_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an portfolio goal Permanently delete an portfolio-goal mapping.

Parameters:

  • portfolio_goal_id —

    UUID portfolio_goal_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 463

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

#delete_portfolio_holding_using_delete(portfolio_holding_id, opts = {}) ⇒ nil

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

Parameters:

  • portfolio_holding_id —

    UUID portfolio_holding_id

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

    the optional parameters

Returns:

  • (nil) 


504
505
506
507
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 504

def delete_portfolio_holding_using_delete(portfolio_holding_id, opts = {})
  delete_portfolio_holding_using_delete_with_http_info(portfolio_holding_id, opts)
  nil
end

#delete_portfolio_holding_using_delete_with_http_info(portfolio_holding_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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

Parameters:

  • portfolio_holding_id —

    UUID portfolio_holding_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 514

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_portfolio_transaction_using_delete(portfolio_transaction_id, opts = {}) ⇒ nil

Delete a portfolio transaction Permanently delete a portfolio transaction record for a portfolio.

Parameters:

  • portfolio_transaction_id —

    UUID portfolio_transaction_id

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

    the optional parameters

Returns:

  • (nil) 


555
556
557
558
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 555

def delete_portfolio_transaction_using_delete(portfolio_transaction_id, opts = {})
  delete_portfolio_transaction_using_delete_with_http_info(portfolio_transaction_id, opts)
  nil
end

#delete_portfolio_transaction_using_delete_with_http_info(portfolio_transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a portfolio transaction Permanently delete a portfolio transaction record for a portfolio.

Parameters:

  • portfolio_transaction_id —

    UUID portfolio_transaction_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_portfolio_using_delete(portfolio_id, opts = {}) ⇒ nil

Delete a portfolio Permanently delete a portfolio for an account.

Parameters:

  • portfolio_id —

    UUID portfolio_id

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

    the optional parameters

Returns:

  • (nil) 


606
607
608
609
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 606

def delete_portfolio_using_delete(portfolio_id, opts = {})
  delete_portfolio_using_delete_with_http_info(portfolio_id, opts)
  nil
end

#delete_portfolio_using_delete_with_http_info(portfolio_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a portfolio Permanently delete a portfolio for an account.

Parameters:

  • portfolio_id —

    UUID portfolio_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
651
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 616

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

#get_all_portfolio_transaction_by_post_using_post(opts = {}) ⇒ PagePortfolioTransaction

getAllPortfolioTransactionByPost

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



661
662
663
664
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 661

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

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

getAllPortfolioTransactionByPost

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 675

def get_all_portfolio_transaction_by_post_using_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_all_portfolio_transaction_by_post_using_post ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio_transaction_by_post'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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 = nil
  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 => 'PagePortfolioTransaction')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortfolioApi#get_all_portfolio_transaction_by_post_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_portfolio_aggregated_data_using_get(portfolio_id, opts = {}) ⇒ Object

Retrieve an portfolio aggregate data Retrieve the information for a securities associated with a portfolio.

Parameters:

  • portfolio_id —

    Portfolio Id

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

    the optional parameters

Options Hash (opts):

  • :show_asset_class (BOOLEAN) —

    true or false (default to true)

  • :show_category (BOOLEAN) —

    true or false (default to true)

  • :show_industry (BOOLEAN) —

    true or false (default to true)

  • :show_sector (BOOLEAN) —

    true or false (default to true)

  • :show_security_class (BOOLEAN) —

    true or false (default to true)

Returns:

  • (Object) 


726
727
728
729
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 726

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

#get_portfolio_aggregated_data_using_get_with_http_info(portfolio_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Retrieve an portfolio aggregate data Retrieve the information for a securities associated with a portfolio.

Parameters:

  • portfolio_id —

    Portfolio Id

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

    the optional parameters

Options Hash (opts):

  • :show_asset_class (BOOLEAN) —

    true or false

  • :show_category (BOOLEAN) —

    true or false

  • :show_industry (BOOLEAN) —

    true or false

  • :show_sector (BOOLEAN) —

    true or false

  • :show_security_class (BOOLEAN) —

    true or false

Returns:

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

    Object data, response status code and response headers



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 741

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

  # query parameters
  query_params = {}
  query_params[:'show_asset_class'] = opts[:'show_asset_class'] if !opts[:'show_asset_class'].nil?
  query_params[:'show_category'] = opts[:'show_category'] if !opts[:'show_category'].nil?
  query_params[:'show_industry'] = opts[:'show_industry'] if !opts[:'show_industry'].nil?
  query_params[:'show_sector'] = opts[:'show_sector'] if !opts[:'show_sector'].nil?
  query_params[:'show_security_class'] = opts[:'show_security_class'] if !opts[:'show_security_class'].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: PortfolioApi#get_portfolio_aggregated_data_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_portfolio_all_using_get(opts = {}) ⇒ PagePortfolio

List all portfolios Get the information for all portfolios assigned to all of your firm’s 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:



792
793
794
795
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 792

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

#get_portfolio_all_using_get_with_http_info(opts = {}) ⇒ Array<(PagePortfolio, Fixnum, Hash)>

List all portfolios Get the information for all portfolios assigned to all of your firm’s 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<(PagePortfolio, Fixnum, Hash)>) —

    PagePortfolio data, response status code and response headers



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 806

def get_portfolio_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_portfolio_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio'

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

#get_portfolio_asset_size_all_using_get(opts = {}) ⇒ PagePortfolioAssetSizeLog

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



854
855
856
857
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 854

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

#get_portfolio_asset_size_all_using_get_with_http_info(opts = {}) ⇒ Array<(PagePortfolioAssetSizeLog, Fixnum, Hash)>

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

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PagePortfolioAssetSizeLog 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
907
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 869

def get_portfolio_asset_size_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_portfolio_asset_size_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio_asset_size'

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_asset_size_using_get(portfolio_asset_size_id, opts = {}) ⇒ PortfolioAssetSizeLog

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

Parameters:

  • portfolio_asset_size_id —

    portfolio_asset_size_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    currency_conversion

Returns:



914
915
916
917
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 914

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

#get_portfolio_asset_size_using_get_with_http_info(portfolio_asset_size_id, opts = {}) ⇒ Array<(PortfolioAssetSizeLog, Fixnum, Hash)>

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

Parameters:

  • portfolio_asset_size_id —

    portfolio_asset_size_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    currency_conversion

Returns:

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

    PortfolioAssetSizeLog data, response status code and response headers



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 925

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

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_comment_all_using_get(opts = {}) ⇒ PagePortfolioComment

List all portfolio commentary List all comments for all portfolios 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:



972
973
974
975
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 972

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

#get_portfolio_comment_all_using_get_with_http_info(opts = {}) ⇒ Array<(PagePortfolioComment, Fixnum, Hash)>

List all portfolio commentary List all comments for all portfolios 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<(PagePortfolioComment, Fixnum, Hash)>) —

    PagePortfolioComment data, response status code and response headers



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 986

def get_portfolio_comment_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_portfolio_comment_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio_comment'

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_comment_using_get(portfolio_comment_id, opts = {}) ⇒ PortfolioComment

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

Parameters:

  • portfolio_comment_id —

    UUID portfolio_comment_id

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

    the optional parameters

Returns:



1029
1030
1031
1032
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1029

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

#get_portfolio_comment_using_get_with_http_info(portfolio_comment_id, opts = {}) ⇒ Array<(PortfolioComment, Fixnum, Hash)>

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

Parameters:

  • portfolio_comment_id —

    UUID portfolio_comment_id

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

    the optional parameters

Returns:

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

    PortfolioComment data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_portfolio_goal_all_using_get(opts = {}) ⇒ PagePortfolioGoal

List all portfolio goals Get information for all portfolio-goal mappings 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:



1085
1086
1087
1088
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1085

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

#get_portfolio_goal_all_using_get_with_http_info(opts = {}) ⇒ Array<(PagePortfolioGoal, Fixnum, Hash)>

List all portfolio goals Get information for all portfolio-goal mappings 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<(PagePortfolioGoal, Fixnum, Hash)>) —

    PagePortfolioGoal data, response status code and response headers



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1099

def get_portfolio_goal_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_portfolio_goal_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio_goal'

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

#get_portfolio_goal_using_get(portfolio_goal_id, opts = {}) ⇒ PortfolioGoal

Retrieve an portfolio goal Retrieve the information for a specific portfolio-goal mapping.

Parameters:

  • portfolio_goal_id —

    UUID portfolio_goal_id

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

    the optional parameters

Returns:



1142
1143
1144
1145
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1142

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

#get_portfolio_goal_using_get_with_http_info(portfolio_goal_id, opts = {}) ⇒ Array<(PortfolioGoal, Fixnum, Hash)>

Retrieve an portfolio goal Retrieve the information for a specific portfolio-goal mapping.

Parameters:

  • portfolio_goal_id —

    UUID portfolio_goal_id

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

    the optional parameters

Returns:

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

    PortfolioGoal data, response status code and response headers



1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1152

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

#get_portfolio_holding_all_using_get(opts = {}) ⇒ PagePortfolioHoldingLog

List all portfolio holdings Get the information for all holding records for all portfolios defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



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

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

#get_portfolio_holding_all_using_get_with_http_info(opts = {}) ⇒ Array<(PagePortfolioHoldingLog, Fixnum, Hash)>

List all portfolio holdings Get the information for all holding records for all portfolios defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PagePortfolioHoldingLog data, response status code and response headers



1214
1215
1216
1217
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
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1214

def get_portfolio_holding_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_portfolio_holding_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio_holding'

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_holding_using_get(portfolio_holding_id, opts = {}) ⇒ PortfolioHoldingLog

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

Parameters:

  • portfolio_holding_id —

    UUID portfolio_holding_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



1259
1260
1261
1262
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1259

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

#get_portfolio_holding_using_get_with_http_info(portfolio_holding_id, opts = {}) ⇒ Array<(PortfolioHoldingLog, Fixnum, Hash)>

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

Parameters:

  • portfolio_holding_id —

    UUID portfolio_holding_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    PortfolioHoldingLog data, response status code and response headers



1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1270

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

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_transaction_all_using_get(opts = {}) ⇒ PagePortfolioTransaction

List all portfolio transactions Get the information for all transaction records for all portfolios defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:



1318
1319
1320
1321
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1318

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

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

List all portfolio transactions Get the information for all transaction records for all portfolios defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1333

def get_portfolio_transaction_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PortfolioApi.get_portfolio_transaction_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/portfolio_transaction'

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_transaction_using_get(portfolio_transaction_id, opts = {}) ⇒ PortfolioTransaction

Retrieve a portfolio transaction Retrieve the information for a portfolio transaction record for a portfolio.

Parameters:

  • portfolio_transaction_id —

    UUID portfolio_transaction_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:



1378
1379
1380
1381
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1378

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

#get_portfolio_transaction_using_get_with_http_info(portfolio_transaction_id, opts = {}) ⇒ Array<(PortfolioTransaction, Fixnum, Hash)>

Retrieve a portfolio transaction Retrieve the information for a portfolio transaction record for a portfolio.

Parameters:

  • portfolio_transaction_id —

    UUID portfolio_transaction_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    USD

Returns:

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

    PortfolioTransaction data, response status code and response headers



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1389

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

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

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

  # form parameters
  form_params = {}

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

#get_portfolio_using_get(portfolio_id, opts = {}) ⇒ Portfolio

Retrieve a portfolio Retrieve a portfolio for an account.

Parameters:

  • portfolio_id —

    UUID portfolio_id

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

    the optional parameters

Returns:



1432
1433
1434
1435
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1432

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

#get_portfolio_using_get_with_http_info(portfolio_id, opts = {}) ⇒ Array<(Portfolio, Fixnum, Hash)>

Retrieve a portfolio Retrieve a portfolio for an account.

Parameters:

  • portfolio_id —

    UUID portfolio_id

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

    the optional parameters

Returns:

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

    Portfolio data, response status code and response headers



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

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

#update_portfolio_asset_size_using_put(portfolio_asset_size, portfolio_asset_size_id, opts = {}) ⇒ PortfolioAssetSizeLog

Update a portfolio asset size Update the information for a portfolio asset size record for a portfolio.

Parameters:

  • portfolio_asset_size —

    portfolio_asset_size

  • portfolio_asset_size_id —

    UUID portfolio_asset_size_id

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

    the optional parameters

Returns:



1485
1486
1487
1488
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1485

def update_portfolio_asset_size_using_put(portfolio_asset_size, portfolio_asset_size_id, opts = {})
  data, _status_code, _headers = update_portfolio_asset_size_using_put_with_http_info(portfolio_asset_size, portfolio_asset_size_id, opts)
  data
end

#update_portfolio_asset_size_using_put_with_http_info(portfolio_asset_size, portfolio_asset_size_id, opts = {}) ⇒ Array<(PortfolioAssetSizeLog, Fixnum, Hash)>

Update a portfolio asset size Update the information for a portfolio asset size record for a portfolio.

Parameters:

  • portfolio_asset_size —

    portfolio_asset_size

  • portfolio_asset_size_id —

    UUID portfolio_asset_size_id

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

    the optional parameters

Returns:

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

    PortfolioAssetSizeLog data, response status code and response headers



1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1496

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_portfolio_comment_using_put(portfolio_comment, portfolio_comment_id, opts = {}) ⇒ PortfolioComment

Update a portfolio comment Update the information for a portfolio comment for a portfolio.

Parameters:

  • portfolio_comment —

    portfolio_comment

  • portfolio_comment_id —

    UUID portfolio_comment_id

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

    the optional parameters

Returns:



1545
1546
1547
1548
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1545

def update_portfolio_comment_using_put(portfolio_comment, portfolio_comment_id, opts = {})
  data, _status_code, _headers = update_portfolio_comment_using_put_with_http_info(portfolio_comment, portfolio_comment_id, opts)
  data
end

#update_portfolio_comment_using_put_with_http_info(portfolio_comment, portfolio_comment_id, opts = {}) ⇒ Array<(PortfolioComment, Fixnum, Hash)>

Update a portfolio comment Update the information for a portfolio comment for a portfolio.

Parameters:

  • portfolio_comment —

    portfolio_comment

  • portfolio_comment_id —

    UUID portfolio_comment_id

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

    the optional parameters

Returns:

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

    PortfolioComment data, response status code and response headers



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1556

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_portfolio_goal_using_put(portfolio_goal, portfolio_goal_id, opts = {}) ⇒ PortfolioGoal

Update an portfolio goal Update the information for an portfolio-goal mapping.

Parameters:

  • portfolio_goal —

    portfolio_goal

  • portfolio_goal_id —

    UUID portfolio_goal_id

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

    the optional parameters

Returns:



1605
1606
1607
1608
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1605

def update_portfolio_goal_using_put(portfolio_goal, portfolio_goal_id, opts = {})
  data, _status_code, _headers = update_portfolio_goal_using_put_with_http_info(portfolio_goal, portfolio_goal_id, opts)
  data
end

#update_portfolio_goal_using_put_with_http_info(portfolio_goal, portfolio_goal_id, opts = {}) ⇒ Array<(PortfolioGoal, Fixnum, Hash)>

Update an portfolio goal Update the information for an portfolio-goal mapping.

Parameters:

  • portfolio_goal —

    portfolio_goal

  • portfolio_goal_id —

    UUID portfolio_goal_id

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

    the optional parameters

Returns:

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

    PortfolioGoal data, response status code and response headers



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1616

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

#update_portfolio_holding_using_put(portfolio_holding, portfolio_holding_id, opts = {}) ⇒ PortfolioHoldingLog

Update a portfolio holding Update the information for a portfolio holding record for a portfolio.

Parameters:

  • portfolio_holding —

    portfolio_holding

  • portfolio_holding_id —

    UUID portfolio_holding_id

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

    the optional parameters

Returns:



1665
1666
1667
1668
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1665

def update_portfolio_holding_using_put(portfolio_holding, portfolio_holding_id, opts = {})
  data, _status_code, _headers = update_portfolio_holding_using_put_with_http_info(portfolio_holding, portfolio_holding_id, opts)
  data
end

#update_portfolio_holding_using_put_with_http_info(portfolio_holding, portfolio_holding_id, opts = {}) ⇒ Array<(PortfolioHoldingLog, Fixnum, Hash)>

Update a portfolio holding Update the information for a portfolio holding record for a portfolio.

Parameters:

  • portfolio_holding —

    portfolio_holding

  • portfolio_holding_id —

    UUID portfolio_holding_id

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

    the optional parameters

Returns:

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

    PortfolioHoldingLog data, response status code and response headers



1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1676

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_portfolio_transaction_using_put(portfolio_transaction, portfolio_transaction_id, opts = {}) ⇒ PortfolioTransaction

Update a portfolio transaction Update the information for a portfolio transaction record for a portfolio.

Parameters:

  • portfolio_transaction —

    portfolio_transaction

  • portfolio_transaction_id —

    UUID portfolio_transaction_id

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

    the optional parameters

Returns:



1725
1726
1727
1728
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1725

def update_portfolio_transaction_using_put(portfolio_transaction, portfolio_transaction_id, opts = {})
  data, _status_code, _headers = update_portfolio_transaction_using_put_with_http_info(portfolio_transaction, portfolio_transaction_id, opts)
  data
end

#update_portfolio_transaction_using_put_with_http_info(portfolio_transaction, portfolio_transaction_id, opts = {}) ⇒ Array<(PortfolioTransaction, Fixnum, Hash)>

Update a portfolio transaction Update the information for a portfolio transaction record for a portfolio.

Parameters:

  • portfolio_transaction —

    portfolio_transaction

  • portfolio_transaction_id —

    UUID portfolio_transaction_id

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

    the optional parameters

Returns:

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

    PortfolioTransaction data, response status code and response headers



1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1736

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_portfolio_using_put(portfolio, portfolio_id, opts = {}) ⇒ Portfolio

Update a portfolio Update a portfolio for an account.

Parameters:

  • portfolio —

    portfolio

  • portfolio_id —

    UUID portfolio_id

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

    the optional parameters

Returns:



1785
1786
1787
1788
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1785

def update_portfolio_using_put(portfolio, portfolio_id, opts = {})
  data, _status_code, _headers = update_portfolio_using_put_with_http_info(portfolio, portfolio_id, opts)
  data
end

#update_portfolio_using_put_with_http_info(portfolio, portfolio_id, opts = {}) ⇒ Array<(Portfolio, Fixnum, Hash)>

Update a portfolio Update a portfolio for an account.

Parameters:

  • portfolio —

    portfolio

  • portfolio_id —

    UUID portfolio_id

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

    the optional parameters

Returns:

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

    Portfolio data, response status code and response headers



1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
 
# File 'lib/nucleus_api/api/portfolio_api.rb', line 1796

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