Class: IntegrationApi::BrokerageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/api/brokerage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BrokerageApi

Returns a new instance of BrokerageApi.



19
20
21
 
# File 'lib/integration_api/api/brokerage_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/integration_api/api/brokerage_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#cancel_brokerage_order_using_put(nucleus_order_id, opts = {}) ⇒ nil

Cancel an Order

Parameters:

  • nucleus_order_id —

    nucleus_order_id

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/integration_api/api/brokerage_api.rb', line 26

def cancel_brokerage_order_using_put(nucleus_order_id, opts = {})
  cancel_brokerage_order_using_put_with_http_info(nucleus_order_id, opts)
  nil
end

#cancel_brokerage_order_using_put_with_http_info(nucleus_order_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Cancel an Order

Parameters:

  • nucleus_order_id —

    nucleus_order_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



35
36
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 35

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

#create_brokerage_account_using_post(brokerage_account_co, opts = {}) ⇒ BrokerageAccountVO

create a Brokerage account

Parameters:

  • brokerage_account_co —

    brokerageAccountCO

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

    the optional parameters

Returns:



77
78
79
80
 
# File 'lib/integration_api/api/brokerage_api.rb', line 77

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

#create_brokerage_account_using_post_with_http_info(brokerage_account_co, opts = {}) ⇒ Array<(BrokerageAccountVO, Fixnum, Hash)>

create a Brokerage account

Parameters:

  • brokerage_account_co —

    brokerageAccountCO

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

    the optional parameters

Returns:

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

    BrokerageAccountVO data, response status code and response headers



86
87
88
89
90
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 86

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_brokerage_bank_link_using_post(brokerage_bank_link_co, opts = {}) ⇒ BrokerageBankLinkVO

create a Bank Link

Parameters:

  • brokerage_bank_link_co —

    brokerageBankLinkCO

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

    the optional parameters

Returns:



129
130
131
132
 
# File 'lib/integration_api/api/brokerage_api.rb', line 129

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

#create_brokerage_bank_link_using_post_with_http_info(brokerage_bank_link_co, opts = {}) ⇒ Array<(BrokerageBankLinkVO, Fixnum, Hash)>

create a Bank Link

Parameters:

  • brokerage_bank_link_co —

    brokerageBankLinkCO

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

    the optional parameters

Returns:

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

    BrokerageBankLinkVO data, response status code and response headers



138
139
140
141
142
143
144
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 138

def create_brokerage_bank_link_using_post_with_http_info(brokerage_bank_link_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.create_brokerage_bank_link_using_post ...'
  end
  # verify the required parameter 'brokerage_bank_link_co' is set
  if @api_client.config.client_side_validation && brokerage_bank_link_co.nil?
    fail ArgumentError, "Missing the required parameter 'brokerage_bank_link_co' when calling BrokerageApi.create_brokerage_bank_link_using_post"
  end
  # resource path
  local_var_path = '/brokerage/bank_link'

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

#create_brokerage_client_using_post(client_co, opts = {}) ⇒ BrokerageCreateClientVO

Create a Brokerage Client

Parameters:

  • client_co —

    clientCO

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

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/integration_api/api/brokerage_api.rb', line 181

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

#create_brokerage_client_using_post_with_http_info(client_co, opts = {}) ⇒ Array<(BrokerageCreateClientVO, Fixnum, Hash)>

Create a Brokerage Client

Parameters:

  • client_co —

    clientCO

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

    the optional parameters

Returns:

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

    BrokerageCreateClientVO data, response status code and response headers



190
191
192
193
194
195
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 190

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

#create_brokerage_deposit_using_post(brokerage_deposit_co, opts = {}) ⇒ BrokerageDepositVO

Create a deposit

Parameters:

  • brokerage_deposit_co —

    brokerageDepositCO

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/integration_api/api/brokerage_api.rb', line 233

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

#create_brokerage_deposit_using_post_with_http_info(brokerage_deposit_co, opts = {}) ⇒ Array<(BrokerageDepositVO, Fixnum, Hash)>

Create a deposit

Parameters:

  • brokerage_deposit_co —

    brokerageDepositCO

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

    the optional parameters

Returns:

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

    BrokerageDepositVO data, response status code and response headers



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

def create_brokerage_deposit_using_post_with_http_info(brokerage_deposit_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.create_brokerage_deposit_using_post ...'
  end
  # verify the required parameter 'brokerage_deposit_co' is set
  if @api_client.config.client_side_validation && brokerage_deposit_co.nil?
    fail ArgumentError, "Missing the required parameter 'brokerage_deposit_co' when calling BrokerageApi.create_brokerage_deposit_using_post"
  end
  # resource path
  local_var_path = '/brokerage/deposit'

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

#create_brokerage_document_using_post(document_co, opts = {}) ⇒ BrokerageDocumentVO

Create a Brokerage document

Parameters:

  • document_co —

    documentCO

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/integration_api/api/brokerage_api.rb', line 285

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

#create_brokerage_document_using_post_with_http_info(document_co, opts = {}) ⇒ Array<(BrokerageDocumentVO, Fixnum, Hash)>

Create a Brokerage document

Parameters:

  • document_co —

    documentCO

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

    the optional parameters

Returns:

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

    BrokerageDocumentVO data, response status code and response headers



294
295
296
297
298
299
300
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 294

def create_brokerage_document_using_post_with_http_info(document_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.create_brokerage_document_using_post ...'
  end
  # verify the required parameter 'document_co' is set
  if @api_client.config.client_side_validation && document_co.nil?
    fail ArgumentError, "Missing the required parameter 'document_co' when calling BrokerageApi.create_brokerage_document_using_post"
  end
  # resource path
  local_var_path = '/brokerage/document'

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

#create_brokerage_order_using_post(brokerage_order_co, opts = {}) ⇒ BrokerageOrderVO

Create an Order

Parameters:

  • brokerage_order_co —

    brokerageOrderCO

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

    the optional parameters

Returns:



337
338
339
340
 
# File 'lib/integration_api/api/brokerage_api.rb', line 337

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

#create_brokerage_order_using_post_with_http_info(brokerage_order_co, opts = {}) ⇒ Array<(BrokerageOrderVO, Fixnum, Hash)>

Create an Order

Parameters:

  • brokerage_order_co —

    brokerageOrderCO

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

    the optional parameters

Returns:

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

    BrokerageOrderVO data, response status code and response headers



346
347
348
349
350
351
352
353
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 346

def create_brokerage_order_using_post_with_http_info(brokerage_order_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.create_brokerage_order_using_post ...'
  end
  # verify the required parameter 'brokerage_order_co' is set
  if @api_client.config.client_side_validation && brokerage_order_co.nil?
    fail ArgumentError, "Missing the required parameter 'brokerage_order_co' when calling BrokerageApi.create_brokerage_order_using_post"
  end
  # resource path
  local_var_path = '/brokerage/order'

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

#create_brokerage_withdrawal_using_post(brokerage_withdrawal_co, opts = {}) ⇒ BrokerageWithdrawalVO

Create a withdrawal

Parameters:

  • brokerage_withdrawal_co —

    brokerageWithdrawalCO

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

    the optional parameters

Returns:



389
390
391
392
 
# File 'lib/integration_api/api/brokerage_api.rb', line 389

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

#create_brokerage_withdrawal_using_post_with_http_info(brokerage_withdrawal_co, opts = {}) ⇒ Array<(BrokerageWithdrawalVO, Fixnum, Hash)>

Create a withdrawal

Parameters:

  • brokerage_withdrawal_co —

    brokerageWithdrawalCO

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

    the optional parameters

Returns:

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

    BrokerageWithdrawalVO data, response status code and response headers



398
399
400
401
402
403
404
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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 398

def create_brokerage_withdrawal_using_post_with_http_info(brokerage_withdrawal_co, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.create_brokerage_withdrawal_using_post ...'
  end
  # verify the required parameter 'brokerage_withdrawal_co' is set
  if @api_client.config.client_side_validation && brokerage_withdrawal_co.nil?
    fail ArgumentError, "Missing the required parameter 'brokerage_withdrawal_co' when calling BrokerageApi.create_brokerage_withdrawal_using_post"
  end
  # resource path
  local_var_path = '/brokerage/withdrawal'

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

#delete_brokerage_bank_link_using_delete(nucleus_bank_link_id, opts = {}) ⇒ nil

Delete a Bank Link

Parameters:

  • nucleus_bank_link_id —

    nucleus_bank_link_id

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

    the optional parameters

Returns:

  • (nil) 


441
442
443
444
 
# File 'lib/integration_api/api/brokerage_api.rb', line 441

def delete_brokerage_bank_link_using_delete(nucleus_bank_link_id, opts = {})
  delete_brokerage_bank_link_using_delete_with_http_info(nucleus_bank_link_id, opts)
  nil
end

#delete_brokerage_bank_link_using_delete_with_http_info(nucleus_bank_link_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Bank Link

Parameters:

  • nucleus_bank_link_id —

    nucleus_bank_link_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/integration_api/api/brokerage_api.rb', line 450

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

#get_brokerage_account_statement_using_get(end_date, nucleus_account_id, start_date, statement_type, opts = {}) ⇒ BrokerageStatementVO

Get a Brokerage account statement

Parameters:

  • end_date —

    end_date

  • nucleus_account_id —

    nucleus_account_id

  • start_date —

    start_date

  • statement_type —

    statement_type

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

    the optional parameters

Returns:



493
494
495
496
 
# File 'lib/integration_api/api/brokerage_api.rb', line 493

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

#get_brokerage_account_statement_using_get_with_http_info(end_date, nucleus_account_id, start_date, statement_type, opts = {}) ⇒ Array<(BrokerageStatementVO, Fixnum, Hash)>

Get a Brokerage account statement

Parameters:

  • end_date —

    end_date

  • nucleus_account_id —

    nucleus_account_id

  • start_date —

    start_date

  • statement_type —

    statement_type

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

    the optional parameters

Returns:

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

    BrokerageStatementVO data, response status code and response headers



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
 
# File 'lib/integration_api/api/brokerage_api.rb', line 505

def (end_date, , start_date, statement_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_account_statement_using_get ...'
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling BrokerageApi.get_brokerage_account_statement_using_get"
  end
  # verify the required parameter 'nucleus_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_account_id' when calling BrokerageApi.get_brokerage_account_statement_using_get"
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling BrokerageApi.get_brokerage_account_statement_using_get"
  end
  # verify the required parameter 'statement_type' is set
  if @api_client.config.client_side_validation && statement_type.nil?
    fail ArgumentError, "Missing the required parameter 'statement_type' when calling BrokerageApi.get_brokerage_account_statement_using_get"
  end
  # resource path
  local_var_path = '/brokerage/statement/{nucleus_account_id}'.sub('{' + 'nucleus_account_id' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'end_date'] = end_date
  query_params[:'start_date'] = start_date
  query_params[:'statement_type'] = statement_type

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

#get_brokerage_balance_using_get(nucleus_portfolio_id, opts = {}) ⇒ BrokerageBalanceVO

Get account balance

Parameters:

  • nucleus_portfolio_id —

    nucleus_portfolio_id

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

    the optional parameters

Returns:



561
562
563
564
 
# File 'lib/integration_api/api/brokerage_api.rb', line 561

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

#get_brokerage_balance_using_get_with_http_info(nucleus_portfolio_id, opts = {}) ⇒ Array<(BrokerageBalanceVO, Fixnum, Hash)>

Get account balance

Parameters:

  • nucleus_portfolio_id —

    nucleus_portfolio_id

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

    the optional parameters

Returns:

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

    BrokerageBalanceVO data, response status code and response headers



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/integration_api/api/brokerage_api.rb', line 570

def get_brokerage_balance_using_get_with_http_info(nucleus_portfolio_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_balance_using_get ...'
  end
  # verify the required parameter 'nucleus_portfolio_id' is set
  if @api_client.config.client_side_validation && nucleus_portfolio_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_portfolio_id' when calling BrokerageApi.get_brokerage_balance_using_get"
  end
  # resource path
  local_var_path = '/brokerage/balance/{nucleus_portfolio_id}'.sub('{' + 'nucleus_portfolio_id' + '}', nucleus_portfolio_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_brokerage_bank_link_using_get(nucleus_bank_link_id, opts = {}) ⇒ BrokerageBankLinkVO

Get a Bank Link

Parameters:

  • nucleus_bank_link_id —

    nucleus_bank_link_id

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

    the optional parameters

Returns:



611
612
613
614
 
# File 'lib/integration_api/api/brokerage_api.rb', line 611

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

#get_brokerage_bank_link_using_get_with_http_info(nucleus_bank_link_id, opts = {}) ⇒ Array<(BrokerageBankLinkVO, Fixnum, Hash)>

Get a Bank Link

Parameters:

  • nucleus_bank_link_id —

    nucleus_bank_link_id

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

    the optional parameters

Returns:

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

    BrokerageBankLinkVO data, response status code and response headers



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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 620

def get_brokerage_bank_link_using_get_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_bank_link_using_get ...'
  end
  # verify the required parameter 'nucleus_bank_link_id' is set
  if @api_client.config.client_side_validation && nucleus_bank_link_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_bank_link_id' when calling BrokerageApi.get_brokerage_bank_link_using_get"
  end
  # resource path
  local_var_path = '/brokerage/bank_link/{nucleus_bank_link_id}'.sub('{' + 'nucleus_bank_link_id' + '}', nucleus_bank_link_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 => 'BrokerageBankLinkVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BrokerageApi#get_brokerage_bank_link_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brokerage_document_using_get(nucleus_document_id, opts = {}) ⇒ BrokerageDocumentVO

Get a Brokerage document

Parameters:

  • nucleus_document_id —

    nucleus_document_id

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

    the optional parameters

Returns:



661
662
663
664
 
# File 'lib/integration_api/api/brokerage_api.rb', line 661

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

#get_brokerage_document_using_get_with_http_info(nucleus_document_id, opts = {}) ⇒ Array<(BrokerageDocumentVO, Fixnum, Hash)>

Get a Brokerage document

Parameters:

  • nucleus_document_id —

    nucleus_document_id

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

    the optional parameters

Returns:

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

    BrokerageDocumentVO data, response status code and response headers



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
 
# File 'lib/integration_api/api/brokerage_api.rb', line 670

def get_brokerage_document_using_get_with_http_info(nucleus_document_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_document_using_get ...'
  end
  # verify the required parameter 'nucleus_document_id' is set
  if @api_client.config.client_side_validation && nucleus_document_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_document_id' when calling BrokerageApi.get_brokerage_document_using_get"
  end
  # resource path
  local_var_path = '/brokerage/document/{nucleus_document_id}'.sub('{' + 'nucleus_document_id' + '}', nucleus_document_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 => 'BrokerageDocumentVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BrokerageApi#get_brokerage_document_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brokerage_holding_performance_using_get(nucleus_portfolio_id, opts = {}) ⇒ BrokeragePerformanceVO

Get portfolio holding performance

Parameters:

  • nucleus_portfolio_id —

    nucleus_portfolio_id

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

    the optional parameters

Returns:



711
712
713
714
 
# File 'lib/integration_api/api/brokerage_api.rb', line 711

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

#get_brokerage_holding_performance_using_get_with_http_info(nucleus_portfolio_id, opts = {}) ⇒ Array<(BrokeragePerformanceVO, Fixnum, Hash)>

Get portfolio holding performance

Parameters:

  • nucleus_portfolio_id —

    nucleus_portfolio_id

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

    the optional parameters

Returns:

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

    BrokeragePerformanceVO data, response status code and response headers



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

def get_brokerage_holding_performance_using_get_with_http_info(nucleus_portfolio_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_holding_performance_using_get ...'
  end
  # verify the required parameter 'nucleus_portfolio_id' is set
  if @api_client.config.client_side_validation && nucleus_portfolio_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_portfolio_id' when calling BrokerageApi.get_brokerage_holding_performance_using_get"
  end
  # resource path
  local_var_path = '/brokerage/holding/performance/{nucleus_portfolio_id}'.sub('{' + 'nucleus_portfolio_id' + '}', nucleus_portfolio_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_brokerage_holding_using_get(nucleus_portfolio_id, opts = {}) ⇒ BrokerageHoldingVO

Get portfolio holdings

Parameters:

  • nucleus_portfolio_id —

    nucleus_portfolio_id

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

    the optional parameters

Returns:



761
762
763
764
 
# File 'lib/integration_api/api/brokerage_api.rb', line 761

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

#get_brokerage_holding_using_get_with_http_info(nucleus_portfolio_id, opts = {}) ⇒ Array<(BrokerageHoldingVO, Fixnum, Hash)>

Get portfolio holdings

Parameters:

  • nucleus_portfolio_id —

    nucleus_portfolio_id

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

    the optional parameters

Returns:

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

    BrokerageHoldingVO data, response status code and response headers



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/integration_api/api/brokerage_api.rb', line 770

def get_brokerage_holding_using_get_with_http_info(nucleus_portfolio_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_holding_using_get ...'
  end
  # verify the required parameter 'nucleus_portfolio_id' is set
  if @api_client.config.client_side_validation && nucleus_portfolio_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_portfolio_id' when calling BrokerageApi.get_brokerage_holding_using_get"
  end
  # resource path
  local_var_path = '/brokerage/holding/{nucleus_portfolio_id}'.sub('{' + 'nucleus_portfolio_id' + '}', nucleus_portfolio_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#get_brokerage_order_using_get(nucleus_order_id, opts = {}) ⇒ BrokerageOrderVO

Get an Order

Parameters:

  • nucleus_order_id —

    nucleus_order_id

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

    the optional parameters

Returns:



811
812
813
814
 
# File 'lib/integration_api/api/brokerage_api.rb', line 811

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

#get_brokerage_order_using_get_with_http_info(nucleus_order_id, opts = {}) ⇒ Array<(BrokerageOrderVO, Fixnum, Hash)>

Get an Order

Parameters:

  • nucleus_order_id —

    nucleus_order_id

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

    the optional parameters

Returns:

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

    BrokerageOrderVO data, response status code and response headers



820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/integration_api/api/brokerage_api.rb', line 820

def get_brokerage_order_using_get_with_http_info(nucleus_order_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_order_using_get ...'
  end
  # verify the required parameter 'nucleus_order_id' is set
  if @api_client.config.client_side_validation && nucleus_order_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_order_id' when calling BrokerageApi.get_brokerage_order_using_get"
  end
  # resource path
  local_var_path = '/brokerage/order/{nucleus_order_id}'.sub('{' + 'nucleus_order_id' + '}', nucleus_order_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 => 'BrokerageOrderVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BrokerageApi#get_brokerage_order_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_brokerage_securities_using_get(vendor_name, opts = {}) ⇒ BrokerageSecuritiesVO

Get securities information

Parameters:

  • vendor_name —

    vendor_name

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

    the optional parameters

Options Hash (opts):

  • :get_fundamentals (BOOLEAN) —

    get_fundamentals (default to false)

  • :nucleus_security_id (String) —

    nucleus_security_id

Returns:



863
864
865
866
 
# File 'lib/integration_api/api/brokerage_api.rb', line 863

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

#get_brokerage_securities_using_get_with_http_info(vendor_name, opts = {}) ⇒ Array<(BrokerageSecuritiesVO, Fixnum, Hash)>

Get securities information

Parameters:

  • vendor_name —

    vendor_name

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

    the optional parameters

Options Hash (opts):

  • :get_fundamentals (BOOLEAN) —

    get_fundamentals

  • :nucleus_security_id (String) —

    nucleus_security_id

Returns:

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

    BrokerageSecuritiesVO data, response status code and response headers



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/integration_api/api/brokerage_api.rb', line 874

def get_brokerage_securities_using_get_with_http_info(vendor_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_securities_using_get ...'
  end
  # verify the required parameter 'vendor_name' is set
  if @api_client.config.client_side_validation && vendor_name.nil?
    fail ArgumentError, "Missing the required parameter 'vendor_name' when calling BrokerageApi.get_brokerage_securities_using_get"
  end
  # resource path
  local_var_path = '/brokerage/securities'

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

#get_brokerage_transactions_using_get(drivewealth_response, end_date, nucleus_portfolio_id, start_date, opts = {}) ⇒ BrokerageTransactionVO

Get account transactions

Parameters:

  • drivewealth_response —

    drivewealthResponse

  • end_date —

    end_date

  • nucleus_portfolio_id —

    nucleus_portfolio_id

  • start_date —

    start_date

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

    the optional parameters

Returns:



921
922
923
924
 
# File 'lib/integration_api/api/brokerage_api.rb', line 921

def get_brokerage_transactions_using_get(drivewealth_response, end_date, nucleus_portfolio_id, start_date, opts = {})
  data, _status_code, _headers = get_brokerage_transactions_using_get_with_http_info(drivewealth_response, end_date, nucleus_portfolio_id, start_date, opts)
  data
end

#get_brokerage_transactions_using_get_with_http_info(drivewealth_response, end_date, nucleus_portfolio_id, start_date, opts = {}) ⇒ Array<(BrokerageTransactionVO, Fixnum, Hash)>

Get account transactions

Parameters:

  • drivewealth_response —

    drivewealthResponse

  • end_date —

    end_date

  • nucleus_portfolio_id —

    nucleus_portfolio_id

  • start_date —

    start_date

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

    the optional parameters

Returns:

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

    BrokerageTransactionVO data, response status code and response headers



933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/integration_api/api/brokerage_api.rb', line 933

def get_brokerage_transactions_using_get_with_http_info(drivewealth_response, end_date, nucleus_portfolio_id, start_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.get_brokerage_transactions_using_get ...'
  end
  # verify the required parameter 'drivewealth_response' is set
  if @api_client.config.client_side_validation && drivewealth_response.nil?
    fail ArgumentError, "Missing the required parameter 'drivewealth_response' when calling BrokerageApi.get_brokerage_transactions_using_get"
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling BrokerageApi.get_brokerage_transactions_using_get"
  end
  # verify the required parameter 'nucleus_portfolio_id' is set
  if @api_client.config.client_side_validation && nucleus_portfolio_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_portfolio_id' when calling BrokerageApi.get_brokerage_transactions_using_get"
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling BrokerageApi.get_brokerage_transactions_using_get"
  end
  # resource path
  local_var_path = '/brokerage/transaction/{nucleus_portfolio_id}'.sub('{' + 'nucleus_portfolio_id' + '}', nucleus_portfolio_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'end_date'] = end_date
  query_params[:'start_date'] = start_date

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

#update_brokerage_bank_link_using_put(nucleus_bank_link_id, opts = {}) ⇒ BrokerageBankLinkVO

Update a Bank Link

Parameters:

  • nucleus_bank_link_id —

    nucleus_bank_link_id

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

    the optional parameters

Returns:



988
989
990
991
 
# File 'lib/integration_api/api/brokerage_api.rb', line 988

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

#update_brokerage_bank_link_using_put_with_http_info(nucleus_bank_link_id, opts = {}) ⇒ Array<(BrokerageBankLinkVO, Fixnum, Hash)>

Update a Bank Link

Parameters:

  • nucleus_bank_link_id —

    nucleus_bank_link_id

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

    the optional parameters

Returns:

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

    BrokerageBankLinkVO data, response status code and response headers



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/integration_api/api/brokerage_api.rb', line 997

def update_brokerage_bank_link_using_put_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.update_brokerage_bank_link_using_put ...'
  end
  # verify the required parameter 'nucleus_bank_link_id' is set
  if @api_client.config.client_side_validation && nucleus_bank_link_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_bank_link_id' when calling BrokerageApi.update_brokerage_bank_link_using_put"
  end
  # resource path
  local_var_path = '/brokerage/bank_link/{nucleus_bank_link_id}'.sub('{' + 'nucleus_bank_link_id' + '}', nucleus_bank_link_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 = nil
  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 => 'BrokerageBankLinkVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BrokerageApi#update_brokerage_bank_link_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_brokerage_client_using_put(nucleus_client_id, opts = {}) ⇒ BrokerageUpdateClientVO

Update a Brokerage client

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Options Hash (opts):

Returns:



1041
1042
1043
1044
 
# File 'lib/integration_api/api/brokerage_api.rb', line 1041

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

#update_brokerage_client_using_put_with_http_info(nucleus_client_id, opts = {}) ⇒ Array<(BrokerageUpdateClientVO, Fixnum, Hash)>

Update a Brokerage client

Parameters:

  • nucleus_client_id —

    nucleus_client_id

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

    the optional parameters

Options Hash (opts):

Returns:

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

    BrokerageUpdateClientVO data, response status code and response headers



1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/integration_api/api/brokerage_api.rb', line 1051

def update_brokerage_client_using_put_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BrokerageApi.update_brokerage_client_using_put ...'
  end
  # verify the required parameter 'nucleus_client_id' is set
  if @api_client.config.client_side_validation && nucleus_client_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_client_id' when calling BrokerageApi.update_brokerage_client_using_put"
  end
  # resource path
  local_var_path = '/brokerage/client/{nucleus_client_id}'.sub('{' + 'nucleus_client_id' + '}', nucleus_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(opts[:'client_co'])
  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 => 'BrokerageUpdateClientVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BrokerageApi#update_brokerage_client_using_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end