Class: SyncteraRubySdk::StatementsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatementsApi

Returns a new instance of StatementsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_statement(statement_id, opts = {}) ⇒ Statement

Get a statement Gets a full statement by its ID.

Parameters:

  • statement_id (String) —

    The unique identifier of a statement

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

    the optional parameters

Returns:



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

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

#get_statement_transactions(statement_id, opts = {}) ⇒ TransactionList

Get a statement’s transactions Gets the list of transactions for a statement’s period.

Parameters:

  • statement_id (String) —

    The unique identifier of a statement

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

    the optional parameters

Options Hash (opts):

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

Returns:



92
93
94
95
 
# File 'lib/synctera_ruby_sdk/api/statements_api.rb', line 92

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

#get_statement_transactions_with_http_info(statement_id, opts = {}) ⇒ Array<(TransactionList, Integer, Hash)>

Get a statement&#39;s transactions Gets the list of transactions for a statement&#39;s period.

Parameters:

  • statement_id (String) —

    The unique identifier of a statement

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    TransactionList data, response status code and response headers



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
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/statements_api.rb', line 104

def get_statement_transactions_with_http_info(statement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatementsApi.get_statement_transactions ...'
  end
  # verify the required parameter 'statement_id' is set
  if @api_client.config.client_side_validation && statement_id.nil?
    fail ArgumentError, "Missing the required parameter 'statement_id' when calling StatementsApi.get_statement_transactions"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StatementsApi.get_statement_transactions, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/statements/{statement_id}/transactions'.sub('{' + 'statement_id' + '}', CGI.escape(statement_id.to_s))

  # 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] || 'TransactionList'

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

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

#get_statement_with_http_info(statement_id, opts = {}) ⇒ Array<(Statement, Integer, Hash)>

Get a statement Gets a full statement by its ID.

Parameters:

  • statement_id (String) —

    The unique identifier of a statement

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

    the optional parameters

Returns:

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

    Statement 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
 
# File 'lib/synctera_ruby_sdk/api/statements_api.rb', line 37

def get_statement_with_http_info(statement_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatementsApi.get_statement ...'
  end
  # verify the required parameter 'statement_id' is set
  if @api_client.config.client_side_validation && statement_id.nil?
    fail ArgumentError, "Missing the required parameter 'statement_id' when calling StatementsApi.get_statement"
  end
  # resource path
  local_var_path = '/statements/{statement_id}'.sub('{' + 'statement_id' + '}', CGI.escape(statement_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] || 'Statement'

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

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

#list_statements(account_id, opts = {}) ⇒ StatementList

List statements Gets a list of statement summaries for an account.

Parameters:

  • account_id (String) —

    The account&#39;s unique identifier provided by Synctera

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

    the optional parameters

Options Hash (opts):

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

Returns:



165
166
167
168
 
# File 'lib/synctera_ruby_sdk/api/statements_api.rb', line 165

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

#list_statements_with_http_info(account_id, opts = {}) ⇒ Array<(StatementList, Integer, Hash)>

List statements Gets a list of statement summaries for an account.

Parameters:

  • account_id (String) —

    The account&#39;s unique identifier provided by Synctera

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    StatementList data, response status code and response headers



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
222
223
224
225
226
227
228
229
230
 
# File 'lib/synctera_ruby_sdk/api/statements_api.rb', line 177

def list_statements_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatementsApi.list_statements ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling StatementsApi.list_statements"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling StatementsApi.list_statements, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/statements'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'account_id'] = 
  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] || 'StatementList'

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

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