Class: IntegrationApi::WireApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WireApi

Returns a new instance of WireApi.



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

def api_client
  @api_client
end

Instance Method Details

#cancel_wire_transfer_using_delete(nucleus_funding_id, opts = {}) ⇒ WireTransferResponseVO

Cancel the Wire transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

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

    the optional parameters

Returns:



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

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

#cancel_wire_transfer_using_delete_with_http_info(nucleus_funding_id, opts = {}) ⇒ Array<(WireTransferResponseVO, Fixnum, Hash)>

Cancel the Wire transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

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

    the optional parameters

Returns:

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

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

def cancel_wire_transfer_using_delete_with_http_info(nucleus_funding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.cancel_wire_transfer_using_delete ...'
  end
  # verify the required parameter 'nucleus_funding_id' is set
  if @api_client.config.client_side_validation && nucleus_funding_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_funding_id' when calling WireApi.cancel_wire_transfer_using_delete"
  end
  # resource path
  local_var_path = '/wire/{nucleus_funding_id}'.sub('{' + 'nucleus_funding_id' + '}', nucleus_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(['application/json'])

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

Create bank link

Parameters:

  • request

    request

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

    the optional parameters

Returns:



76
77
78
79
# File 'lib/integration_api/api/wire_api.rb', line 76

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

Create bank link

Parameters:

  • request

    request

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

    the optional parameters

Returns:

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

    WireBankLinkResponseVO data, response status code and response headers



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

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

  # query parameters
  query_params = {}

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

Delete bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

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

    the optional parameters

Returns:



128
129
130
131
# File 'lib/integration_api/api/wire_api.rb', line 128

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

Delete bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

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

    the optional parameters

Returns:

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

    WireBankLinkResponseVO data, response status code and response headers



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

def delete_bank_link_using_delete3_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.delete_bank_link_using_delete3 ...'
  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 WireApi.delete_bank_link_using_delete3"
  end
  # resource path
  local_var_path = '/wire/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(['application/json'])

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

Get bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

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

    the optional parameters

Returns:



178
179
180
181
# File 'lib/integration_api/api/wire_api.rb', line 178

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

Get bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

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

    the optional parameters

Returns:

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

    WireBankLinkResponseVO data, response status code and response headers



187
188
189
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
# File 'lib/integration_api/api/wire_api.rb', line 187

def get_bank_link_using_get3_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.get_bank_link_using_get3 ...'
  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 WireApi.get_bank_link_using_get3"
  end
  # resource path
  local_var_path = '/wire/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(['application/json'])

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

Get client bank links

Parameters:

  • nucleus_client_id

    nucleus_client_id

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

    the optional parameters

Returns:



228
229
230
231
# File 'lib/integration_api/api/wire_api.rb', line 228

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

Get client bank links

Parameters:

  • nucleus_client_id

    nucleus_client_id

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

    the optional parameters

Returns:

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

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



237
238
239
240
241
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
# File 'lib/integration_api/api/wire_api.rb', line 237

def get_client_bank_links_using_get2_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.get_client_bank_links_using_get2 ...'
  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 WireApi.get_client_bank_links_using_get2"
  end
  # resource path
  local_var_path = '/wire/bank_link/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(['application/json'])

  # form parameters
  form_params = {}

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

#get_list_of_wire_transfers_using_get(nucleus_client_id, opts = {}) ⇒ Array<WireTransferResponseVO>

Get a list of Wire transfers

Parameters:

  • nucleus_client_id

    nucleus_client_id

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

    the optional parameters

Returns:



278
279
280
281
# File 'lib/integration_api/api/wire_api.rb', line 278

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

#get_list_of_wire_transfers_using_get_with_http_info(nucleus_client_id, opts = {}) ⇒ Array<(Array<WireTransferResponseVO>, Fixnum, Hash)>

Get a list of Wire transfers

Parameters:

  • nucleus_client_id

    nucleus_client_id

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

    the optional parameters

Returns:

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

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



287
288
289
290
291
292
293
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
# File 'lib/integration_api/api/wire_api.rb', line 287

def get_list_of_wire_transfers_using_get_with_http_info(nucleus_client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.get_list_of_wire_transfers_using_get ...'
  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 WireApi.get_list_of_wire_transfers_using_get"
  end
  # resource path
  local_var_path = '/wire/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(['application/json'])

  # form parameters
  form_params = {}

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

#get_wire_transfer_using_get(nucleus_funding_id, opts = {}) ⇒ WireTransferResponseVO

Get the Wire transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

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

    the optional parameters

Returns:



328
329
330
331
# File 'lib/integration_api/api/wire_api.rb', line 328

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

#get_wire_transfer_using_get_with_http_info(nucleus_funding_id, opts = {}) ⇒ Array<(WireTransferResponseVO, Fixnum, Hash)>

Get the Wire transfer

Parameters:

  • nucleus_funding_id

    nucleus_funding_id

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

    the optional parameters

Returns:

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

    WireTransferResponseVO data, response status code and response headers



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/integration_api/api/wire_api.rb', line 337

def get_wire_transfer_using_get_with_http_info(nucleus_funding_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.get_wire_transfer_using_get ...'
  end
  # verify the required parameter 'nucleus_funding_id' is set
  if @api_client.config.client_side_validation && nucleus_funding_id.nil?
    fail ArgumentError, "Missing the required parameter 'nucleus_funding_id' when calling WireApi.get_wire_transfer_using_get"
  end
  # resource path
  local_var_path = '/wire/{nucleus_funding_id}'.sub('{' + 'nucleus_funding_id' + '}', nucleus_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(['application/json'])

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

#submit_wire_transfer_using_post(transfer_request, opts = {}) ⇒ WireTransferResponseVO

Submit a Wire transfer

Parameters:

  • transfer_request

    transferRequest

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

    the optional parameters

Returns:



378
379
380
381
# File 'lib/integration_api/api/wire_api.rb', line 378

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

#submit_wire_transfer_using_post_with_http_info(transfer_request, opts = {}) ⇒ Array<(WireTransferResponseVO, Fixnum, Hash)>

Submit a Wire transfer

Parameters:

  • transfer_request

    transferRequest

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

    the optional parameters

Returns:

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

    WireTransferResponseVO data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
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
# File 'lib/integration_api/api/wire_api.rb', line 387

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

  # query parameters
  query_params = {}

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

Update bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

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

    the optional parameters

Returns:



430
431
432
433
# File 'lib/integration_api/api/wire_api.rb', line 430

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

Update bank link

Parameters:

  • nucleus_bank_link_id

    nucleus_bank_link_id

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

    the optional parameters

Returns:

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

    WireBankLinkResponseVO data, response status code and response headers



439
440
441
442
443
444
445
446
447
448
449
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
# File 'lib/integration_api/api/wire_api.rb', line 439

def update_bank_link_using_put3_with_http_info(nucleus_bank_link_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WireApi.update_bank_link_using_put3 ...'
  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 WireApi.update_bank_link_using_put3"
  end
  # resource path
  local_var_path = '/wire/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(['application/json'])
  # 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 => 'WireBankLinkResponseVO')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WireApi#update_bank_link_using_put3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end