Class: NucleusApi::FundingApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FundingApi

Returns a new instance of FundingApi.



19
20
21
# File 'lib/nucleus_api/api/funding_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/nucleus_api/api/funding_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_bank_link_using_post(bank_link_info_request, opts = {}) ⇒ BankLink

Create a bank link Create a new bank link for an account.

Parameters:

  • bank_link_info_request

    bankLinkInfoRequest

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

    the optional parameters

Returns:



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

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

#create_bank_link_using_post_with_http_info(bank_link_info_request, opts = {}) ⇒ Array<(BankLink, Fixnum, Hash)>

Create a bank link Create a new bank link for an account.

Parameters:

  • bank_link_info_request

    bankLinkInfoRequest

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

    the optional parameters

Returns:

  • (Array<(BankLink, Fixnum, Hash)>)

    BankLink 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/funding_api.rb', line 37

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

#create_funding_transaction_using_post(funding_transaction_request, opts = {}) ⇒ FundingTransaction

Create a funding transaction request Create a new funding transaction request for an account.

Parameters:

  • funding_transaction_request

    fundingTransactionRequest

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

    the optional parameters

Returns:



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

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

#create_funding_transaction_using_post_with_http_info(funding_transaction_request, opts = {}) ⇒ Array<(FundingTransaction, Fixnum, Hash)>

Create a funding transaction request Create a new funding transaction request for an account.

Parameters:

  • funding_transaction_request

    fundingTransactionRequest

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

    the optional parameters

Returns:

  • (Array<(FundingTransaction, Fixnum, Hash)>)

    FundingTransaction 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/funding_api.rb', line 91

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#create_funding_using_post(funding_request, opts = {}) ⇒ Funding

Create a funding request Create a new funding request for an account.

Parameters:

  • funding_request

    fundingRequest

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

    the optional parameters

Returns:

  • (Funding)


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

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

#create_funding_using_post_with_http_info(funding_request, opts = {}) ⇒ Array<(Funding, Fixnum, Hash)>

Create a funding request Create a new funding request for an account.

Parameters:

  • funding_request

    fundingRequest

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

    the optional parameters

Returns:

  • (Array<(Funding, Fixnum, Hash)>)

    Funding 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/funding_api.rb', line 145

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

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

#create_transfer_using_post(external_account_transfer_request, opts = {}) ⇒ ExternalAccountTransfer

Create a transfer requests Create a new external account transfer for a client account.

Parameters:

  • external_account_transfer_request

    externalAccountTransferRequest

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

    the optional parameters

Returns:



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

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

#create_transfer_using_post_with_http_info(external_account_transfer_request, opts = {}) ⇒ Array<(ExternalAccountTransfer, Fixnum, Hash)>

Create a transfer requests Create a new external account transfer for a client account.

Parameters:

  • external_account_transfer_request

    externalAccountTransferRequest

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

    the optional parameters

Returns:

  • (Array<(ExternalAccountTransfer, Fixnum, Hash)>)

    ExternalAccountTransfer data, response status code and response headers



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

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

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

Delete a bank link Permanently delete a bank link defined for an account.

Parameters:

  • bank_link_id

    UUID bank_link_id

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

    the optional parameters

Returns:

  • (nil)


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

def delete_bank_link_using_delete(bank_link_id, opts = {})
  delete_bank_link_using_delete_with_http_info(bank_link_id, opts)
  nil
end

Delete a bank link Permanently delete a bank link defined for an account.

Parameters:

  • bank_link_id

    UUID bank_link_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#delete_funding_transaction_using_delete(funding_transaction_id, opts = {}) ⇒ nil

Delete a funding transaction request Permanently delete a funding transaction request for an account.

Parameters:

  • funding_transaction_id

    UUID funding_transaction_id

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

    the optional parameters

Returns:

  • (nil)


294
295
296
297
# File 'lib/nucleus_api/api/funding_api.rb', line 294

def delete_funding_transaction_using_delete(funding_transaction_id, opts = {})
  delete_funding_transaction_using_delete_with_http_info(funding_transaction_id, opts)
  nil
end

#delete_funding_transaction_using_delete_with_http_info(funding_transaction_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a funding transaction request Permanently delete a funding transaction request for an account.

Parameters:

  • funding_transaction_id

    UUID funding_transaction_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
337
338
339
# File 'lib/nucleus_api/api/funding_api.rb', line 304

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#delete_funding_using_delete(funding_id, opts = {}) ⇒ nil

Delete a funding request Permanently delete a funding request defined for an account.

Parameters:

  • funding_id

    UUID funding_id

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

    the optional parameters

Returns:

  • (nil)


345
346
347
348
# File 'lib/nucleus_api/api/funding_api.rb', line 345

def delete_funding_using_delete(funding_id, opts = {})
  delete_funding_using_delete_with_http_info(funding_id, opts)
  nil
end

#delete_funding_using_delete_with_http_info(funding_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a funding request Permanently delete a funding request defined for an account.

Parameters:

  • funding_id

    UUID funding_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

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

#delete_transfer_using_delete(transfer_id, opts = {}) ⇒ nil

Delete a transfer request Permanently delete a external account transfer from a client account.

Parameters:

  • transfer_id

    UUID external_account_transfer_id

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

    the optional parameters

Returns:

  • (nil)


396
397
398
399
# File 'lib/nucleus_api/api/funding_api.rb', line 396

def delete_transfer_using_delete(transfer_id, opts = {})
  delete_transfer_using_delete_with_http_info(transfer_id, opts)
  nil
end

#delete_transfer_using_delete_with_http_info(transfer_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a transfer request Permanently delete a external account transfer from a client account.

Parameters:

  • transfer_id

    UUID external_account_transfer_id

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
# File 'lib/nucleus_api/api/funding_api.rb', line 406

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

List all bank links Get all bank links defined for all clients defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending (default to false)

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by (default to update_date)

  • :page (Integer)

    page (default to 0)

  • :size (Integer)

    size (default to 25)

Returns:



452
453
454
455
# File 'lib/nucleus_api/api/funding_api.rb', line 452

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

List all bank links Get all bank links defined for all clients defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by

  • :page (Integer)

    page

  • :size (Integer)

    size

Returns:

  • (Array<(PageBankLink, Fixnum, Hash)>)

    PageBankLink data, response status code and response headers



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

def get_bank_link_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FundingApi.get_bank_link_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/bank_link'

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

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

  # form parameters
  form_params = {}

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

Retrieve a bank link Retrieve the information for a bank link for an account.

Parameters:

  • bank_link_id

    UUID bank_link_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:



512
513
514
515
# File 'lib/nucleus_api/api/funding_api.rb', line 512

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

Retrieve a bank link Retrieve the information for a bank link for an account.

Parameters:

  • bank_link_id

    UUID bank_link_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:

  • (Array<(BankLink, Fixnum, Hash)>)

    BankLink data, response status code and response headers



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
557
558
559
560
# File 'lib/nucleus_api/api/funding_api.rb', line 523

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

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

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

  # form parameters
  form_params = {}

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

#get_funding_all_using_get(opts = {}) ⇒ PageFunding

List all funding requests Get the information for all funding requests defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending (default to false)

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by (default to update_date)

  • :page (Integer)

    page (default to 0)

  • :size (Integer)

    size (default to 25)

Returns:



571
572
573
574
# File 'lib/nucleus_api/api/funding_api.rb', line 571

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

#get_funding_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageFunding, Fixnum, Hash)>

List all funding requests Get the information for all funding requests defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by

  • :page (Integer)

    page

  • :size (Integer)

    size

Returns:

  • (Array<(PageFunding, Fixnum, Hash)>)

    PageFunding data, response status code and response headers



586
587
588
589
590
591
592
593
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
# File 'lib/nucleus_api/api/funding_api.rb', line 586

def get_funding_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FundingApi.get_funding_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/funding'

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

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

  # form parameters
  form_params = {}

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

#get_funding_transaction_all_using_get(opts = {}) ⇒ PageFundingTransaction

List all funding transaction requests Get the information for all funding transaction requests for all clients.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending (default to false)

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by (default to update_date)

  • :page (Integer)

    page (default to 0)

  • :size (Integer)

    size (default to 25)

Returns:



635
636
637
638
# File 'lib/nucleus_api/api/funding_api.rb', line 635

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

#get_funding_transaction_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageFundingTransaction, Fixnum, Hash)>

List all funding transaction requests Get the information for all funding transaction requests for all clients.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by

  • :page (Integer)

    page

  • :size (Integer)

    size

Returns:

  • (Array<(PageFundingTransaction, Fixnum, Hash)>)

    PageFundingTransaction data, response status code and response headers



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
# File 'lib/nucleus_api/api/funding_api.rb', line 650

def get_funding_transaction_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FundingApi.get_funding_transaction_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/funding_transaction'

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

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

  # form parameters
  form_params = {}

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

#get_funding_transaction_using_get(funding_transaction_id, opts = {}) ⇒ FundingTransaction

Retrieve a funding transaction request Retrieve the information for a funding transaction request for an account.

Parameters:

  • funding_transaction_id

    UUID funding_transaction_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:



695
696
697
698
# File 'lib/nucleus_api/api/funding_api.rb', line 695

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

#get_funding_transaction_using_get_with_http_info(funding_transaction_id, opts = {}) ⇒ Array<(FundingTransaction, Fixnum, Hash)>

Retrieve a funding transaction request Retrieve the information for a funding transaction request for an account.

Parameters:

  • funding_transaction_id

    UUID funding_transaction_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:

  • (Array<(FundingTransaction, Fixnum, Hash)>)

    FundingTransaction data, response status code and response headers



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
# File 'lib/nucleus_api/api/funding_api.rb', line 706

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

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

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

  # form parameters
  form_params = {}

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

#get_funding_using_get(funding_id, opts = {}) ⇒ Funding

Retrieve a funding request Retrieve the information for a funding request for an account.

Parameters:

  • funding_id

    UUID funding_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:

  • (Funding)


750
751
752
753
# File 'lib/nucleus_api/api/funding_api.rb', line 750

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

#get_funding_using_get_with_http_info(funding_id, opts = {}) ⇒ Array<(Funding, Fixnum, Hash)>

Retrieve a funding request Retrieve the information for a funding request for an account.

Parameters:

  • funding_id

    UUID funding_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:

  • (Array<(Funding, Fixnum, Hash)>)

    Funding data, response status code and response headers



761
762
763
764
765
766
767
768
769
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
# File 'lib/nucleus_api/api/funding_api.rb', line 761

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

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

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

  # form parameters
  form_params = {}

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

#get_transfer_all_using_get(opts = {}) ⇒ PageExternalAccountTransfer

List all transfer requests Get the information for all external account transfers defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending (default to false)

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by (default to update_date)

  • :page (Integer)

    page (default to 0)

  • :size (Integer)

    size (default to 25)

Returns:



809
810
811
812
# File 'lib/nucleus_api/api/funding_api.rb', line 809

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

#get_transfer_all_using_get_with_http_info(opts = {}) ⇒ Array<(PageExternalAccountTransfer, Fixnum, Hash)>

List all transfer requests Get the information for all external account transfers defined for your firm.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ascending (BOOLEAN)

    ascending

  • :currency_conversion (String)

    currency_conversion

  • :filter (String)

    filter

  • :order_by (String)

    order_by

  • :page (Integer)

    page

  • :size (Integer)

    size

Returns:



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
857
858
859
860
861
862
# File 'lib/nucleus_api/api/funding_api.rb', line 824

def get_transfer_all_using_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FundingApi.get_transfer_all_using_get ...'
  end
  # resource path
  local_var_path = '/nucleus/v1/transfer'

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

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

  # form parameters
  form_params = {}

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

#get_transfer_using_get(transfer_id, opts = {}) ⇒ ExternalAccountTransfer

Retrieve a transfer request Retrieve the information for a external account transfer for an account.

Parameters:

  • transfer_id

    UUID external_account_transfer_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:



869
870
871
872
# File 'lib/nucleus_api/api/funding_api.rb', line 869

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

#get_transfer_using_get_with_http_info(transfer_id, opts = {}) ⇒ Array<(ExternalAccountTransfer, Fixnum, Hash)>

Retrieve a transfer request Retrieve the information for a external account transfer for an account.

Parameters:

  • transfer_id

    UUID external_account_transfer_id

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

    the optional parameters

Options Hash (opts):

  • :currency_conversion (String)

    USD

Returns:

  • (Array<(ExternalAccountTransfer, Fixnum, Hash)>)

    ExternalAccountTransfer data, response status code and response headers



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
914
915
916
917
# File 'lib/nucleus_api/api/funding_api.rb', line 880

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

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

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

  # form parameters
  form_params = {}

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

Update list of bank link Update bank link list for an account.

Parameters:

  • bank_link_list

    bankLinkList

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

    the optional parameters

Returns:



923
924
925
926
# File 'lib/nucleus_api/api/funding_api.rb', line 923

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

Update list of bank link Update bank link list for an account.

Parameters:

  • bank_link_list

    bankLinkList

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

    the optional parameters

Returns:

  • (Array<(Array<BankLink>, Fixnum, Hash)>)

    Array<BankLink> 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
# File 'lib/nucleus_api/api/funding_api.rb', line 933

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

Update a bank link Update the information for a bank link for an account.

Parameters:

  • bank_link

    bank_link

  • bank_link_id

    UUID bank_link_id

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

    the optional parameters

Returns:



978
979
980
981
# File 'lib/nucleus_api/api/funding_api.rb', line 978

def update_bank_link_using_put(bank_link, bank_link_id, opts = {})
  data, _status_code, _headers = update_bank_link_using_put_with_http_info(bank_link, bank_link_id, opts)
  data
end

Update a bank link Update the information for a bank link for an account.

Parameters:

  • bank_link

    bank_link

  • bank_link_id

    UUID bank_link_id

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

    the optional parameters

Returns:

  • (Array<(BankLink, Fixnum, Hash)>)

    BankLink data, response status code and response headers



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
# File 'lib/nucleus_api/api/funding_api.rb', line 989

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

#update_funding_transaction_using_put(funding_transaction, funding_transaction_id, opts = {}) ⇒ FundingTransaction

Update a funding transaction request Update the information for a funding transaction request for an account.

Parameters:

  • funding_transaction

    fundingTransaction

  • funding_transaction_id

    UUID funding_transaction_id

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

    the optional parameters

Returns:



1038
1039
1040
1041
# File 'lib/nucleus_api/api/funding_api.rb', line 1038

def update_funding_transaction_using_put(funding_transaction, funding_transaction_id, opts = {})
  data, _status_code, _headers = update_funding_transaction_using_put_with_http_info(funding_transaction, funding_transaction_id, opts)
  data
end

#update_funding_transaction_using_put_with_http_info(funding_transaction, funding_transaction_id, opts = {}) ⇒ Array<(FundingTransaction, Fixnum, Hash)>

Update a funding transaction request Update the information for a funding transaction request for an account.

Parameters:

  • funding_transaction

    fundingTransaction

  • funding_transaction_id

    UUID funding_transaction_id

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

    the optional parameters

Returns:

  • (Array<(FundingTransaction, Fixnum, Hash)>)

    FundingTransaction data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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

#update_funding_using_put(funding, funding_id, opts = {}) ⇒ Funding

Update a funding request Update the information for a funding request for an account.

Parameters:

  • funding

    funding

  • funding_id

    UUID funding_id

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

    the optional parameters

Returns:

  • (Funding)


1098
1099
1100
1101
# File 'lib/nucleus_api/api/funding_api.rb', line 1098

def update_funding_using_put(funding, funding_id, opts = {})
  data, _status_code, _headers = update_funding_using_put_with_http_info(funding, funding_id, opts)
  data
end

#update_funding_using_put_with_http_info(funding, funding_id, opts = {}) ⇒ Array<(Funding, Fixnum, Hash)>

Update a funding request Update the information for a funding request for an account.

Parameters:

  • funding

    funding

  • funding_id

    UUID funding_id

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

    the optional parameters

Returns:

  • (Array<(Funding, Fixnum, Hash)>)

    Funding data, response status code and response headers



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
# File 'lib/nucleus_api/api/funding_api.rb', line 1109

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

#update_transfer_using_put(transfer, transfer_id, opts = {}) ⇒ ExternalAccountTransfer

Update a transfer request Update the information for a external account transfer for a client account.

Parameters:

  • transfer

    transfer

  • transfer_id

    UUID external_account_transfer_id

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

    the optional parameters

Returns:



1158
1159
1160
1161
# File 'lib/nucleus_api/api/funding_api.rb', line 1158

def update_transfer_using_put(transfer, transfer_id, opts = {})
  data, _status_code, _headers = update_transfer_using_put_with_http_info(transfer, transfer_id, opts)
  data
end

#update_transfer_using_put_with_http_info(transfer, transfer_id, opts = {}) ⇒ Array<(ExternalAccountTransfer, Fixnum, Hash)>

Update a transfer request Update the information for a external account transfer for a client account.

Parameters:

  • transfer

    transfer

  • transfer_id

    UUID external_account_transfer_id

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

    the optional parameters

Returns:

  • (Array<(ExternalAccountTransfer, Fixnum, Hash)>)

    ExternalAccountTransfer data, response status code and response headers



1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
# File 'lib/nucleus_api/api/funding_api.rb', line 1169

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