Class: SyncteraRubySdk::ACHApi

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/api/ach_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ACHApi

Returns a new instance of ACHApi.



19
20
21
 
# File 'lib/synctera_ruby_sdk/api/ach_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/synctera_ruby_sdk/api/ach_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_transaction_out(outgoing_ach_request, opts = {}) ⇒ OutgoingAch

Send an ACH Send an ACH

Parameters:

  • outgoing_ach_request (OutgoingAchRequest) —

    Send ACH request

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:



28
29
30
31
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 28

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

#add_transaction_out_with_http_info(outgoing_ach_request, opts = {}) ⇒ Array<(OutgoingAch, Integer, Hash)>

Send an ACH Send an ACH

Parameters:

  • outgoing_ach_request (OutgoingAchRequest) —

    Send ACH request

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

  • (Array<(OutgoingAch, Integer, Hash)>) —

    OutgoingAch data, response status code and response headers



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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 39

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(outgoing_ach_request)

  # return_type
  return_type = opts[:debug_return_type] || 'OutgoingAch'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ACHApi.add_transaction_out",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#add_transaction_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transaction_out(transaction_id, opts = {}) ⇒ OutgoingAch

Get a sent ACH transaction Get a single sent ACH transaction

Parameters:

  • transaction_id (String) —

    Transaction ID in the ledger

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

    the optional parameters

Returns:



98
99
100
101
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 98

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

#get_transaction_out_with_http_info(transaction_id, opts = {}) ⇒ Array<(OutgoingAch, Integer, Hash)>

Get a sent ACH transaction Get a single sent ACH transaction

Parameters:

  • transaction_id (String) —

    Transaction ID in the ledger

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

    the optional parameters

Returns:

  • (Array<(OutgoingAch, Integer, Hash)>) —

    OutgoingAch data, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 108

def get_transaction_out_with_http_info(transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.get_transaction_out ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling ACHApi.get_transaction_out"
  end
  # resource path
  local_var_path = '/ach/{transaction_id}'.sub('{' + 'transaction_id' + '}', CGI.escape(transaction_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OutgoingAch'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ACHApi.get_transaction_out",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#get_transaction_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transactions_out(opts = {}) ⇒ OutgoingAchList

List sent ACH transactions List sent ACH transactions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:



162
163
164
165
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 162

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

#list_transactions_out_with_http_info(opts = {}) ⇒ Array<(OutgoingAchList, Integer, Hash)>

List sent ACH transactions List sent ACH transactions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) — default: default to 100
  • :page_token (String)

Returns:

  • (Array<(OutgoingAchList, Integer, Hash)>) —

    OutgoingAchList data, response status code and response headers



173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 173

def list_transactions_out_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.list_transactions_out ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ACHApi.list_transactions_out, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/ach'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OutgoingAchList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ACHApi.list_transactions_out",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#list_transactions_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_transaction_out(transaction_id, outgoing_ach_patch, opts = {}) ⇒ OutgoingAch

Update a sent ACH transaction Update a sent ACH transaction (either status or funds availability)

Parameters:

  • transaction_id (String) —

    Transaction ID in the ledger

  • outgoing_ach_patch (OutgoingAchPatch) —

    Update sent ach transaction

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:



230
231
232
233
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 230

def patch_transaction_out(transaction_id, outgoing_ach_patch, opts = {})
  data, _status_code, _headers = patch_transaction_out_with_http_info(transaction_id, outgoing_ach_patch, opts)
  data
end

#patch_transaction_out_with_http_info(transaction_id, outgoing_ach_patch, opts = {}) ⇒ Array<(OutgoingAch, Integer, Hash)>

Update a sent ACH transaction Update a sent ACH transaction (either status or funds availability)

Parameters:

  • transaction_id (String) —

    Transaction ID in the ledger

  • outgoing_ach_patch (OutgoingAchPatch) —

    Update sent ach transaction

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Returns:

  • (Array<(OutgoingAch, Integer, Hash)>) —

    OutgoingAch 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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/synctera_ruby_sdk/api/ach_api.rb', line 242

def patch_transaction_out_with_http_info(transaction_id, outgoing_ach_patch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ACHApi.patch_transaction_out ...'
  end
  # verify the required parameter 'transaction_id' is set
  if @api_client.config.client_side_validation && transaction_id.nil?
    fail ArgumentError, "Missing the required parameter 'transaction_id' when calling ACHApi.patch_transaction_out"
  end
  # verify the required parameter 'outgoing_ach_patch' is set
  if @api_client.config.client_side_validation && outgoing_ach_patch.nil?
    fail ArgumentError, "Missing the required parameter 'outgoing_ach_patch' when calling ACHApi.patch_transaction_out"
  end
  # resource path
  local_var_path = '/ach/{transaction_id}'.sub('{' + 'transaction_id' + '}', CGI.escape(transaction_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(outgoing_ach_patch)

  # return_type
  return_type = opts[:debug_return_type] || 'OutgoingAch'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['bearerAuth']

  new_options = opts.merge(
    :operation => :"ACHApi.patch_transaction_out",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ACHApi#patch_transaction_out\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end