Class: SwaggerClient::GoalApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GoalApi

Returns a new instance of GoalApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_goal_track_using_post(goal_track, opts = {}) ⇒ GoalTrack

Create a goal track record Create a goal track record for a goal under a client.

Parameters:

  • goal_track —

    goalTrack

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

    the optional parameters

Returns:

  • (GoalTrack) 


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

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

#create_goal_track_using_post_with_http_info(goal_track, opts = {}) ⇒ Array<(GoalTrack, Fixnum, Hash)>

Create a goal track record Create a goal track record for a goal under a client.

Parameters:

  • goal_track —

    goalTrack

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

    the optional parameters

Returns:

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

    GoalTrack 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/goal_api.rb', line 37

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

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

#create_goal_using_post(goal_request, opts = {}) ⇒ Goal

Create a goal Create a new goal for your firm that clients can customize for themselves.

Parameters:

  • goal_request —

    goalRequest

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

    the optional parameters

Returns:

  • (Goal) 


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

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

#create_goal_using_post_with_http_info(goal_request, opts = {}) ⇒ Array<(Goal, Fixnum, Hash)>

Create a goal Create a new goal for your firm that clients can customize for themselves.

Parameters:

  • goal_request —

    goalRequest

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

    the optional parameters

Returns:

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

    Goal 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/goal_api.rb', line 91

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

#delete_goal_track_using_delete(goal_track_id, opts = {}) ⇒ nil

Delete a goal track record Permanently delete an goal track record for a goal under a client.

Parameters:

  • goal_track_id —

    UUID goal_track_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_goal_track_using_delete(goal_track_id, opts = {})
  delete_goal_track_using_delete_with_http_info(goal_track_id, opts)
  nil
end

#delete_goal_track_using_delete_with_http_info(goal_track_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a goal track record Permanently delete an goal track record for a goal under a client.

Parameters:

  • goal_track_id —

    UUID goal_track_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#delete_goal_using_delete(goal_id, opts = {}) ⇒ nil

Delete a goal Permanently delete a goal for your firm.

Parameters:

  • goal_id —

    UUID goal_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_goal_using_delete(goal_id, opts = {})
  delete_goal_using_delete_with_http_info(goal_id, opts)
  nil
end

#delete_goal_using_delete_with_http_info(goal_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a goal Permanently delete a goal for your firm.

Parameters:

  • goal_id —

    UUID goal_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#get_goal_all_using_get(opts = {}) ⇒ PageGoal

List all goals Get the details for all goals defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

Returns:

  • (PageGoal) 


241
242
243
244
 
# File 'lib/nucleus_api/api/goal_api.rb', line 241

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

#get_goal_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageGoal, Fixnum, Hash)>

List all goals Get the details for all goals defined by your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

Returns:

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

    PageGoal data, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/nucleus_api/api/goal_api.rb', line 255

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

#get_goal_asset_size_all_using_get(client_id, goal_id, opts = {}) ⇒ Array<AvailableDateDoubleVO>

List goal asset sizes Get a list of asset sizes per date for a goal for a specified client.

Parameters:

  • client_id —

    client_id

  • goal_id —

    UUID goal_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :get_latest (BOOLEAN) —

    get_latest (default to false)

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal (default to false)

  • :sort_type (String) —

    sort_type

  • :start_date (Date) —

    start date

Returns:

  • (Array<AvailableDateDoubleVO>) 


305
306
307
308
 
# File 'lib/nucleus_api/api/goal_api.rb', line 305

def get_goal_asset_size_all_using_get(client_id, goal_id, opts = {})
  data, _status_code, _headers = get_goal_asset_size_all_using_get_with_http_info(client_id, goal_id, opts)
  data
end

#get_goal_asset_size_all_using_get_with_http_info(client_id, goal_id, opts = {}) ⇒ Array<(Array<AvailableDateDoubleVO>, Fixnum, Hash)>

List goal asset sizes Get a list of asset sizes per date for a goal for a specified client.

Parameters:

  • client_id —

    client_id

  • goal_id —

    UUID goal_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :get_latest (BOOLEAN) —

    get_latest

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal

  • :sort_type (String) —

    sort_type

  • :start_date (Date) —

    start date

Returns:

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

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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/nucleus_api/api/goal_api.rb', line 322

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

  # query parameters
  query_params = {}
  query_params[:'client_id'] = client_id
  query_params[:'currency_conversion'] = opts[:'currency_conversion'] if !opts[:'currency_conversion'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'get_latest'] = opts[:'get_latest'] if !opts[:'get_latest'].nil?
  query_params[:'portfolio_goal'] = opts[:'portfolio_goal'] if !opts[:'portfolio_goal'].nil?
  query_params[:'sort_type'] = opts[:'sort_type'] if !opts[:'sort_type'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?

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

  # form parameters
  form_params = {}

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

#get_goal_holding_all_using_get(client_id, goal_id, opts = {}) ⇒ PagePortfolioHoldingAgg

List goal holdings Get the information for all the securities that are currently being held in portfolios associated with a particular goal.

Parameters:

  • client_id —

    client_id

  • goal_id —

    UUID goal_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to date)

  • :page (Integer) —

    page (default to 0)

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal (default to false)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date

Returns:

  • (PagePortfolioHoldingAgg) 


385
386
387
388
 
# File 'lib/nucleus_api/api/goal_api.rb', line 385

def get_goal_holding_all_using_get(client_id, goal_id, opts = {})
  data, _status_code, _headers = get_goal_holding_all_using_get_with_http_info(client_id, goal_id, opts)
  data
end

#get_goal_holding_all_using_get_with_http_info(client_id, goal_id, opts = {}) ⇒ Array<(PagePortfolioHoldingAgg, Fixnum, Hash)>

List goal holdings Get the information for all the securities that are currently being held in portfolios associated with a particular goal.

Parameters:

  • client_id —

    client_id

  • goal_id —

    UUID goal_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PagePortfolioHoldingAgg data, response status code and response headers



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/nucleus_api/api/goal_api.rb', line 405

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

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

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

  # form parameters
  form_params = {}

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

#get_goal_track_all_using_get(opts = {}) ⇒ PageGoalTrack

List all goal track records Get information for all goal track records stored for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :end_date (String) —

    end date

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (String) —

    start date

Returns:

  • (PageGoalTrack) 


468
469
470
471
 
# File 'lib/nucleus_api/api/goal_api.rb', line 468

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

#get_goal_track_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageGoalTrack, Fixnum, Hash)>

List all goal track records Get information for all goal track records stored for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :end_date (String) —

    end date

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (String) —

    start date

Returns:

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

    PageGoalTrack data, response status code and response headers



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/nucleus_api/api/goal_api.rb', line 485

def get_goal_track_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoalApi.get_goal_track_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/goal_track'

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

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

  # form parameters
  form_params = {}

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

#get_goal_track_using_get(goal_track_id, opts = {}) ⇒ GoalTrack

Retrieve a goal track record Retrieve the information for a specific goal track record for a goal under a client.

Parameters:

  • goal_track_id —

    UUID goal_track_id

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

    the optional parameters

Returns:

  • (GoalTrack) 


531
532
533
534
 
# File 'lib/nucleus_api/api/goal_api.rb', line 531

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

#get_goal_track_using_get_with_http_info(goal_track_id, opts = {}) ⇒ Array<(GoalTrack, Fixnum, Hash)>

Retrieve a goal track record Retrieve the information for a specific goal track record for a goal under a client.

Parameters:

  • goal_track_id —

    UUID goal_track_id

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

    the optional parameters

Returns:

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

    GoalTrack data, response status code and response headers



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/nucleus_api/api/goal_api.rb', line 541

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

#get_goal_transaction_all_using_get(client_id, goal_id, opts = {}) ⇒ PagePortfolioTransaction

List goal transactions Get the information for all transactions under portfolios associated with a particular goal.

Parameters:

  • client_id —

    client_id

  • goal_id —

    UUID goal_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal (default to false)

  • :size (Integer) —

    size (default to 25)

  • :start_date (Date) —

    start date

Returns:

  • (PagePortfolioTransaction) 


593
594
595
596
 
# File 'lib/nucleus_api/api/goal_api.rb', line 593

def get_goal_transaction_all_using_get(client_id, goal_id, opts = {})
  data, _status_code, _headers = get_goal_transaction_all_using_get_with_http_info(client_id, goal_id, opts)
  data
end

#get_goal_transaction_all_using_get_with_http_info(client_id, goal_id, opts = {}) ⇒ Array<(PagePortfolioTransaction, Fixnum, Hash)>

List goal transactions Get the information for all transactions under portfolios associated with a particular goal.

Parameters:

  • client_id —

    client_id

  • goal_id —

    UUID goal_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal

  • :size (Integer) —

    size

  • :start_date (Date) —

    start date

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/nucleus_api/api/goal_api.rb', line 613

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

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

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

  # form parameters
  form_params = {}

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

#get_goal_using_get(goal_id, opts = {}) ⇒ Goal

Retrieve a goal Retrieve the information for a goal defined for your firm.

Parameters:

  • goal_id —

    UUID goal_id

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

    the optional parameters

Returns:

  • (Goal) 


669
670
671
672
 
# File 'lib/nucleus_api/api/goal_api.rb', line 669

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

#get_goal_using_get_with_http_info(goal_id, opts = {}) ⇒ Array<(Goal, Fixnum, Hash)>

Retrieve a goal Retrieve the information for a goal defined for your firm.

Parameters:

  • goal_id —

    UUID goal_id

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

    the optional parameters

Returns:

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

    Goal data, response status code and response headers



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/goal_api.rb', line 679

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

#update_goal_track_using_put(goal_track, goal_track_id, opts = {}) ⇒ GoalTrack

Update a goal track record Update the information for a goal track record.

Parameters:

  • goal_track —

    goal_track

  • goal_track_id —

    UUID goal_track_id

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

    the optional parameters

Returns:

  • (GoalTrack) 


722
723
724
725
 
# File 'lib/nucleus_api/api/goal_api.rb', line 722

def update_goal_track_using_put(goal_track, goal_track_id, opts = {})
  data, _status_code, _headers = update_goal_track_using_put_with_http_info(goal_track, goal_track_id, opts)
  data
end

#update_goal_track_using_put_with_http_info(goal_track, goal_track_id, opts = {}) ⇒ Array<(GoalTrack, Fixnum, Hash)>

Update a goal track record Update the information for a goal track record.

Parameters:

  • goal_track —

    goal_track

  • goal_track_id —

    UUID goal_track_id

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

    the optional parameters

Returns:

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

    GoalTrack data, response status code and response headers



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

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

#update_goal_using_put(goal, goal_id, opts = {}) ⇒ Goal

Update a goal Update a goal defined for your firm.

Parameters:

  • goal —

    goal

  • goal_id —

    UUID goal_id

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

    the optional parameters

Returns:

  • (Goal) 


782
783
784
785
 
# File 'lib/nucleus_api/api/goal_api.rb', line 782

def update_goal_using_put(goal, goal_id, opts = {})
  data, _status_code, _headers = update_goal_using_put_with_http_info(goal, goal_id, opts)
  data
end

#update_goal_using_put_with_http_info(goal, goal_id, opts = {}) ⇒ Array<(Goal, Fixnum, Hash)>

Update a goal Update a goal defined for your firm.

Parameters:

  • goal —

    goal

  • goal_id —

    UUID goal_id

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

    the optional parameters

Returns:

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

    Goal data, response status code and response headers



793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/nucleus_api/api/goal_api.rb', line 793

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