Class: SyncteraRubySdk::ACHTransactionSimulationsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ACHTransactionSimulationsApi

Returns a new instance of ACHTransactionSimulationsApi.



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

def api_client
  @api_client
end

Instance Method Details

#ach_return_simulation(ach_return_simulation_request, opts = {}) ⇒ Object

Simulate receiving ACH return Use to simulate receiving ACH return in test environments. Creates an incoming ACH file with a single return entry based on a previously created outgoing transaction. The file gets automatically processed.

Parameters:

  • ach_return_simulation_request (AchReturnSimulationRequest) —

    Incoming ACH return simulation

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

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/synctera_ruby_sdk/api/ach_transaction_simulations_api.rb', line 27

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

#ach_return_simulation_with_http_info(ach_return_simulation_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Simulate receiving ACH return Use to simulate receiving ACH return in test environments. Creates an incoming ACH file with a single return entry based on a previously created outgoing transaction. The file gets automatically processed.

Parameters:

  • ach_return_simulation_request (AchReturnSimulationRequest) —

    Incoming ACH return simulation

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

    the optional parameters

Returns:

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

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

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

  # 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

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

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

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

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

  new_options = opts.merge(
    :operation => :"ACHTransactionSimulationsApi.ach_return_simulation",
    :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: ACHTransactionSimulationsApi#ach_return_simulation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ach_transaction_simulation(ach_transaction_simulation_request, opts = {}) ⇒ Object

Simulate receiving ACH transaction Use to simulate receiving ACH transaction in test environments. Creates an incoming ACH file with a single transaction, which gets automatically processed.

Parameters:

Returns:

  • (Object) 


95
96
97
98
 
# File 'lib/synctera_ruby_sdk/api/ach_transaction_simulations_api.rb', line 95

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

#ach_transaction_simulation_with_http_info(ach_transaction_simulation_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Simulate receiving ACH transaction Use to simulate receiving ACH transaction in test environments. Creates an incoming ACH file with a single transaction, which gets automatically processed.

Parameters:

Returns:

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

    Object data, response status code and response headers



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
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
155
156
 
# File 'lib/synctera_ruby_sdk/api/ach_transaction_simulations_api.rb', line 105

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

  # 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

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

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

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

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

  new_options = opts.merge(
    :operation => :"ACHTransactionSimulationsApi.ach_transaction_simulation",
    :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: ACHTransactionSimulationsApi#ach_transaction_simulation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end