Class: SwaggerClient::ClientApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ClientApi

Returns a new instance of ClientApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_client_response_using_post(client_response, opts = {}) ⇒ ClientResponse

Create a client response Create a new client response for a question as part of a questionnaires.

Parameters:

  • client_response —

    clientResponse

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

    the optional parameters

Returns:

  • (ClientResponse) 


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

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

#create_client_response_using_post_with_http_info(client_response, opts = {}) ⇒ Array<(ClientResponse, Fixnum, Hash)>

Create a client response Create a new client response for a question as part of a questionnaires.

Parameters:

  • client_response —

    clientResponse

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

    the optional parameters

Returns:

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

    ClientResponse 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/client_api.rb', line 37

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

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

#create_client_status_using_post(client_status_request, opts = {}) ⇒ ClientStatus

Create an client status Create an client status record for an client.

Parameters:

  • client_status_request —

    clientStatusRequest

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

    the optional parameters

Returns:

  • (ClientStatus) 


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

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

#create_client_status_using_post_with_http_info(client_status_request, opts = {}) ⇒ Array<(ClientStatus, Fixnum, Hash)>

Create an client status Create an client status record for an client.

Parameters:

  • client_status_request —

    clientStatusRequest

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

    the optional parameters

Returns:

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

    ClientStatus 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/client_api.rb', line 91

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_client_using_post(client_request, opts = {}) ⇒ Client

Create a client Create a new client, or register a new user, with your firm.

Parameters:

  • client_request —

    clientRequest

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

    the optional parameters

Returns:

  • (Client) 


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

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

#create_client_using_post_with_http_info(client_request, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Create a client Create a new client, or register a new user, with your firm.

Parameters:

  • client_request —

    clientRequest

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

    the optional parameters

Returns:

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

    Client 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/client_api.rb', line 145

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

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

#delete_client_response_using_delete(client_response_id, opts = {}) ⇒ nil

Delete a client response Permanently delete a client response for a client.

Parameters:

  • client_response_id —

    UUID client_response_id

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_client_response_using_delete(client_response_id, opts = {})
  delete_client_response_using_delete_with_http_info(client_response_id, opts)
  nil
end

#delete_client_response_using_delete_with_http_info(client_response_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a client response Permanently delete a client response for a client.

Parameters:

  • client_response_id —

    UUID client_response_id

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

    the optional parameters

Returns:

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

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

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

#delete_client_status_using_delete(client_status_id, opts = {}) ⇒ nil

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

Parameters:

  • client_status_id —

    UUID client_status_id

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/nucleus_api/api/client_api.rb', line 240

def delete_client_status_using_delete(client_status_id, opts = {})
  delete_client_status_using_delete_with_http_info(client_status_id, opts)
  nil
end

#delete_client_status_using_delete_with_http_info(client_status_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

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

Parameters:

  • client_status_id —

    UUID client_status_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/nucleus_api/api/client_api.rb', line 250

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_client_using_delete(client_id, opts = {}) ⇒ nil

Delete a client Permanently delete a client registered with your firm. Turns the client’s is_active = 0

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Returns:

  • (nil) 


291
292
293
294
 
# File 'lib/nucleus_api/api/client_api.rb', line 291

def delete_client_using_delete(client_id, opts = {})
  delete_client_using_delete_with_http_info(client_id, opts)
  nil
end

#delete_client_using_delete_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a client Permanently delete a client registered with your firm. Turns the client&#39;s is_active &#x3D; 0

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_client_using_delete_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.delete_client_using_delete ...'
  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 ClientApi.delete_client_using_delete"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}'.sub('{' + 'client_id' + '}', client_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: ClientApi#delete_client_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_account_overview_using_get(client_id, opts = {}) ⇒ Object

List all client Account overview

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :order_by (String) —

    order_by (default to update_date)

Returns:

  • (Object) 


343
344
345
346
 
# File 'lib/nucleus_api/api/client_api.rb', line 343

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

#get_client_account_overview_using_get_with_http_info(client_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

List all client Account overview

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :order_by (String) —

    order_by

Returns:

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

    Object data, response status code and response headers



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/nucleus_api/api/client_api.rb', line 354

def (client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_account_overview_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 ClientApi.get_client_account_overview_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}/account_overview'.sub('{' + 'client_id' + '}', client_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_client_advisor_overview_using_get(client_id, opts = {}) ⇒ Object

Advisor overview

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :show_clients (BOOLEAN) —

    show_clients (default to false)

Returns:

  • (Object) 


398
399
400
401
 
# File 'lib/nucleus_api/api/client_api.rb', line 398

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

#get_client_advisor_overview_using_get_with_http_info(client_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Advisor overview

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :show_clients (BOOLEAN) —

    show_clients

Returns:

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

    Object data, response status code and response headers



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

def get_client_advisor_overview_using_get_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_advisor_overview_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 ClientApi.get_client_advisor_overview_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}/advisor_overview'.sub('{' + 'client_id' + '}', client_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'show_clients'] = opts[:'show_clients'] if !opts[:'show_clients'].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: ClientApi#get_client_advisor_overview_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_all_using_get(opts = {}) ⇒ PageClient

List all clients Get details for all clients registered with 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:

  • (PageClient) 


455
456
457
458
 
# File 'lib/nucleus_api/api/client_api.rb', line 455

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

#get_client_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageClient, Fixnum, Hash)>

List all clients Get details for all clients registered with 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<(PageClient, Fixnum, Hash)>) —

    PageClient data, response status code and response headers



469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/nucleus_api/api/client_api.rb', line 469

def get_client_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/client'

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

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

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

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date (default to null)

  • :exclude_subledger (BOOLEAN) —

    exclude_subledger (default to false)

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

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

  • :start_date (Date) —

    start date (default to null)

Returns:

  • (Array<AvailableDateDoubleVO>) 


518
519
520
521
 
# File 'lib/nucleus_api/api/client_api.rb', line 518

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

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

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

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String) —

    Currency Code

  • :end_date (Date) —

    end date

  • :exclude_subledger (BOOLEAN) —

    exclude_subledger

  • :get_latest (BOOLEAN) —

    true or false

  • :sort_type (String) —

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

  • :start_date (Date) —

    start date

Returns:

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

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



534
535
536
537
538
539
540
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
 
# File 'lib/nucleus_api/api/client_api.rb', line 534

def get_client_asset_size_using_get_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_asset_size_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 ClientApi.get_client_asset_size_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}/asset_size'.sub('{' + 'client_id' + '}', client_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_client_goal_overview_using_get(client_id, opts = {}) ⇒ VClientGoalViewData

Retrieve client’s goal details Retrieve client’s goal details

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal (default to false)

Returns:

  • (VClientGoalViewData) 


583
584
585
586
 
# File 'lib/nucleus_api/api/client_api.rb', line 583

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

#get_client_goal_overview_using_get_with_http_info(client_id, opts = {}) ⇒ Array<(VClientGoalViewData, Fixnum, Hash)>

Retrieve client&#39;s goal details Retrieve client&#39;s goal details

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :portfolio_goal (BOOLEAN) —

    portfolio_goal

Returns:

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

    VClientGoalViewData data, response status code and response headers



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/nucleus_api/api/client_api.rb', line 594

def get_client_goal_overview_using_get_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_goal_overview_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 ClientApi.get_client_goal_overview_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}/goal_overview'.sub('{' + 'client_id' + '}', client_id.to_s)

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

#get_client_holding_using_get(client_id, opts = {}) ⇒ PagePortfolioHoldingAgg

List all client holdings Get the information for all the securities that are currently being held by a client registered with your firm.

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    Currency Code

  • :end_date (String) —

    end date - yyyy-mm-dd

  • :filter (String) —

    filter

  • :get_latest (BOOLEAN) —

    true or false

  • :order_by (String) —

    order_by (default to date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (String) —

    start date - yyyy-mm-dd

Returns:

  • (PagePortfolioHoldingAgg) 


646
647
648
649
 
# File 'lib/nucleus_api/api/client_api.rb', line 646

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

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

List all client holdings Get the information for all the securities that are currently being held by a client registered with your firm.

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    Currency Code

  • :end_date (String) —

    end date - yyyy-mm-dd

  • :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 - yyyy-mm-dd

Returns:

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

    PagePortfolioHoldingAgg data, response status code and response headers



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

def get_client_holding_using_get_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_holding_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 ClientApi.get_client_holding_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}/holding'.sub('{' + 'client_id' + '}', client_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_client_response_all_using_get(opts = {}) ⇒ PageClientResponse

List all client responses Get all the client responses for questions as part of a questionnaire 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:

  • (PageClientResponse) 


720
721
722
723
 
# File 'lib/nucleus_api/api/client_api.rb', line 720

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

#get_client_response_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageClientResponse, Fixnum, Hash)>

List all client responses Get all the client responses for questions as part of a questionnaire 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<(PageClientResponse, Fixnum, Hash)>) —

    PageClientResponse data, response status code and response headers



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

def get_client_response_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_response_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/client_response'

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

#get_client_response_using_get(client_response_id, opts = {}) ⇒ ClientResponse

Retrieve a client response Retrieve the information for a client response for a client.

Parameters:

  • client_response_id —

    UUID client_response_id

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

    the optional parameters

Returns:

  • (ClientResponse) 


777
778
779
780
 
# File 'lib/nucleus_api/api/client_api.rb', line 777

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

#get_client_response_using_get_with_http_info(client_response_id, opts = {}) ⇒ Array<(ClientResponse, Fixnum, Hash)>

Retrieve a client response Retrieve the information for a client response for a client.

Parameters:

  • client_response_id —

    UUID client_response_id

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

    the optional parameters

Returns:

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

    ClientResponse data, response status code and response headers



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

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

#get_client_status_all_using_get(opts = {}) ⇒ PageClientStatus

List all client statuses Get the client status history information for all clients.

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:

  • (PageClientStatus) 


833
834
835
836
 
# File 'lib/nucleus_api/api/client_api.rb', line 833

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

#get_client_status_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageClientStatus, Fixnum, Hash)>

List all client statuses Get the client status history information for all clients.

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

    PageClientStatus data, response status code and response headers



847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
 
# File 'lib/nucleus_api/api/client_api.rb', line 847

def get_client_status_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_status_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/client_status'

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

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

  # form parameters
  form_params = {}

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

#get_client_status_using_get(client_status_id, opts = {}) ⇒ ClientStatus

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

Parameters:

  • client_status_id —

    UUID client_status_id

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

    the optional parameters

Returns:

  • (ClientStatus) 


890
891
892
893
 
# File 'lib/nucleus_api/api/client_api.rb', line 890

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

#get_client_status_using_get_with_http_info(client_status_id, opts = {}) ⇒ Array<(ClientStatus, Fixnum, Hash)>

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

Parameters:

  • client_status_id —

    UUID client_status_id

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

    the optional parameters

Returns:

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

    ClientStatus data, response status code and response headers



900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
 
# File 'lib/nucleus_api/api/client_api.rb', line 900

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_client_transaction_all_using_get(client_id, opts = {}) ⇒ PagePortfolioTransaction

List all client transactions Get the information for all transactions under a client registered with your firm.

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending (default to false)

  • :currency_conversion (String) —

    currency_conversion

  • :end_date (String) —

    end date - yyyy-mm-dd

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by (default to update_date)

  • :page (Integer) —

    page (default to 0)

  • :size (Integer) —

    size (default to 25)

  • :start_date (String) —

    start date - yyyy-mm-dd

Returns:

  • (PagePortfolioTransaction) 


950
951
952
953
 
# File 'lib/nucleus_api/api/client_api.rb', line 950

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

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

List all client transactions Get the information for all transactions under a client registered with your firm.

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN) —

    ascending

  • :currency_conversion (String) —

    currency_conversion

  • :end_date (String) —

    end date - yyyy-mm-dd

  • :filter (String) —

    filter

  • :order_by (String) —

    order_by

  • :page (Integer) —

    page

  • :size (Integer) —

    size

  • :start_date (String) —

    start date - yyyy-mm-dd

Returns:

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

    PagePortfolioTransaction data, response status code and response headers



968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/nucleus_api/api/client_api.rb', line 968

def get_client_transaction_all_using_get_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_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 ClientApi.get_client_transaction_all_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}/transaction'.sub('{' + 'client_id' + '}', client_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_client_using_get(client_id, opts = {}) ⇒ Client

Retrieve a client Retrieve the information for a client registered with your firm.

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Returns:

  • (Client) 


1018
1019
1020
1021
 
# File 'lib/nucleus_api/api/client_api.rb', line 1018

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

#get_client_using_get_with_http_info(client_id, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Retrieve a client Retrieve the information for a client registered with your firm.

Parameters:

  • client_id —

    UUID client_id

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

    the optional parameters

Returns:

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

    Client data, response status code and response headers



1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/nucleus_api/api/client_api.rb', line 1028

def get_client_using_get_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientApi.get_client_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 ClientApi.get_client_using_get"
  end
  # resource path
  local_var_path = '/nucleus/v1/client/{client_id}'.sub('{' + 'client_id' + '}', client_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 => 'Client')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClientApi#get_client_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_client_response_using_put(client_response, client_response_id, opts = {}) ⇒ ClientResponse

Update a client response Update a client response for a client.

Parameters:

  • client_response —

    client_response

  • client_response_id —

    UUID client_response_id

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

    the optional parameters

Returns:

  • (ClientResponse) 


1071
1072
1073
1074
 
# File 'lib/nucleus_api/api/client_api.rb', line 1071

def update_client_response_using_put(client_response, client_response_id, opts = {})
  data, _status_code, _headers = update_client_response_using_put_with_http_info(client_response, client_response_id, opts)
  data
end

#update_client_response_using_put_with_http_info(client_response, client_response_id, opts = {}) ⇒ Array<(ClientResponse, Fixnum, Hash)>

Update a client response Update a client response for a client.

Parameters:

  • client_response —

    client_response

  • client_response_id —

    UUID client_response_id

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

    the optional parameters

Returns:

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

    ClientResponse data, response status code and response headers



1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
 
# File 'lib/nucleus_api/api/client_api.rb', line 1082

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

#update_client_status_using_put(client_status, client_status_id, opts = {}) ⇒ ClientStatus

Update an client status Update an client status record for an client.

Parameters:

  • client_status —

    client_status

  • client_status_id —

    UUID client_status_id

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

    the optional parameters

Returns:

  • (ClientStatus) 


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

def update_client_status_using_put(client_status, client_status_id, opts = {})
  data, _status_code, _headers = update_client_status_using_put_with_http_info(client_status, client_status_id, opts)
  data
end

#update_client_status_using_put_with_http_info(client_status, client_status_id, opts = {}) ⇒ Array<(ClientStatus, Fixnum, Hash)>

Update an client status Update an client status record for an client.

Parameters:

  • client_status —

    client_status

  • client_status_id —

    UUID client_status_id

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

    the optional parameters

Returns:

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

    ClientStatus data, response status code and response headers



1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'lib/nucleus_api/api/client_api.rb', line 1142

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_client_using_put(client, client_id, opts = {}) ⇒ Client

Update a client Update the information for a client registered with your firm.

Parameters:

  • client —

    client

  • client_id —

    UUID client_id

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

    the optional parameters

Returns:

  • (Client) 


1191
1192
1193
1194
 
# File 'lib/nucleus_api/api/client_api.rb', line 1191

def update_client_using_put(client, client_id, opts = {})
  data, _status_code, _headers = update_client_using_put_with_http_info(client, client_id, opts)
  data
end

#update_client_using_put_with_http_info(client, client_id, opts = {}) ⇒ Array<(Client, Fixnum, Hash)>

Update a client Update the information for a client registered with your firm.

Parameters:

  • client —

    client

  • client_id —

    UUID client_id

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

    the optional parameters

Returns:

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

    Client data, response status code and response headers



1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/nucleus_api/api/client_api.rb', line 1202

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