Class: TripletexRubyClient::BankstatementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/bankstatement_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BankstatementApi

Returns a new instance of BankstatementApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/bankstatement_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/tripletex_ruby_client/api/bankstatement_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete(id, opts = {}) ⇒ nil

BETA

Delete bank statement by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 27

def delete(id, opts = {})
  delete_with_http_info(id, opts)
  nil
end

#delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

BETA

Delete bank statement by ID.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 37

def delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementApi.delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BankstatementApi.delete"
  end
  # resource path
  local_var_path = '/bank/statement/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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: BankstatementApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(id, opts = {}) ⇒ ResponseWrapperBankStatement

BETA

Get bank statement.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



77
78
79
80
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 77

def get(id, opts = {})
  data, _status_code, _headers = get_with_http_info(id, opts)
  data
end

#get_with_http_info(id, opts = {}) ⇒ Array<(ResponseWrapperBankStatement, Fixnum, Hash)>

BETA

Get bank statement.

Parameters:

  • id —

    Element ID

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

    the optional parameters

Options Hash (opts):

  • :fields (String) —

    Fields filter pattern

Returns:



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/tripletex_ruby_client/api/bankstatement_api.rb', line 88

def get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementApi.get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling BankstatementApi.get"
  end
  # resource path
  local_var_path = '/bank/statement/{id}'.sub('{' + 'id' + '}', id.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperBankStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankstatementApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#import_bank_statement(bank_id, account_id, from_date, to_date, file_format, file, opts = {}) ⇒ ResponseWrapperBankStatement

BETA

Upload bank statement file.

Parameters:

  • bank_id —

    Bank ID

  • account_id —

    Account ID

  • from_date —

    Format is yyyy-MM-dd (from and incl.).

  • to_date —

    Format is yyyy-MM-dd (to and excl.).

  • file_format —

    File format

  • file —

    The bank statement file

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

    the optional parameters

Options Hash (opts):

  • :external_id (String) —

    External ID

Returns:



135
136
137
138
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 135

def import_bank_statement(bank_id, , from_date, to_date, file_format, file, opts = {})
  data, _status_code, _headers = import_bank_statement_with_http_info(bank_id, , from_date, to_date, file_format, file, opts)
  data
end

#import_bank_statement_with_http_info(bank_id, account_id, from_date, to_date, file_format, file, opts = {}) ⇒ Array<(ResponseWrapperBankStatement, Fixnum, Hash)>

BETA

Upload bank statement file.

Parameters:

  • bank_id —

    Bank ID

  • account_id —

    Account ID

  • from_date —

    Format is yyyy-MM-dd (from and incl.).

  • to_date —

    Format is yyyy-MM-dd (to and excl.).

  • file_format —

    File format

  • file —

    The bank statement file

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

    the optional parameters

Options Hash (opts):

  • :external_id (String) —

    External ID

Returns:



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
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
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 151

def import_bank_statement_with_http_info(bank_id, , from_date, to_date, file_format, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementApi.import_bank_statement ...'
  end
  # verify the required parameter 'bank_id' is set
  if @api_client.config.client_side_validation && bank_id.nil?
    fail ArgumentError, "Missing the required parameter 'bank_id' when calling BankstatementApi.import_bank_statement"
  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 BankstatementApi.import_bank_statement"
  end
  # verify the required parameter 'from_date' is set
  if @api_client.config.client_side_validation && from_date.nil?
    fail ArgumentError, "Missing the required parameter 'from_date' when calling BankstatementApi.import_bank_statement"
  end
  # verify the required parameter 'to_date' is set
  if @api_client.config.client_side_validation && to_date.nil?
    fail ArgumentError, "Missing the required parameter 'to_date' when calling BankstatementApi.import_bank_statement"
  end
  # verify the required parameter 'file_format' is set
  if @api_client.config.client_side_validation && file_format.nil?
    fail ArgumentError, "Missing the required parameter 'file_format' when calling BankstatementApi.import_bank_statement"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['DNB_CSV', 'EIKA_TELEPAY', 'SPAREBANK1_TELEPAY', 'VISMA_ACCOUNT_STATEMENT', 'HANDELSBANKEN_TELEPAY', 'SPAREBANKEN_VEST_TELEPAY', 'NORDEA_CSV', 'TRANSFERWISE', 'SPAREBANKEN_SOR_TELEPAY', 'SPAREBANKEN_OST_TELEPAY', 'DANSKE_BANK_CSV', 'CULTURA_BANK_TELEPAY', 'SBANKEN_PRIVAT_CSV', 'HAUGESUND_SPAREBANK_CSV', 'VISMA_ACCOUNT_STATEMENT_PSD2', 'SBANKEN_BEDRIFT_CSV', 'LANDKREDITT_TELEPAY'].include?(file_format)
    fail ArgumentError, "invalid value for 'file_format', must be one of DNB_CSV, EIKA_TELEPAY, SPAREBANK1_TELEPAY, VISMA_ACCOUNT_STATEMENT, HANDELSBANKEN_TELEPAY, SPAREBANKEN_VEST_TELEPAY, NORDEA_CSV, TRANSFERWISE, SPAREBANKEN_SOR_TELEPAY, SPAREBANKEN_OST_TELEPAY, DANSKE_BANK_CSV, CULTURA_BANK_TELEPAY, SBANKEN_PRIVAT_CSV, HAUGESUND_SPAREBANK_CSV, VISMA_ACCOUNT_STATEMENT_PSD2, SBANKEN_BEDRIFT_CSV, LANDKREDITT_TELEPAY"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling BankstatementApi.import_bank_statement"
  end
  # resource path
  local_var_path = '/bank/statement/import'

  # query parameters
  query_params = {}
  query_params[:'bankId'] = bank_id
  query_params[:'accountId'] = 
  query_params[:'fromDate'] = from_date
  query_params[:'toDate'] = to_date
  query_params[:'fileFormat'] = file_format
  query_params[:'externalId'] = opts[:'external_id'] if !opts[:'external_id'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ResponseWrapperBankStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankstatementApi#import_bank_statement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(opts = {}) ⇒ ListResponseBankStatement

BETA

Find bank statement corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :account_id (String) —

    List of IDs

  • :file_format (String) —

    File format

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



230
231
232
233
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 230

def search(opts = {})
  data, _status_code, _headers = search_with_http_info(opts)
  data
end

#search_with_http_info(opts = {}) ⇒ Array<(ListResponseBankStatement, Fixnum, Hash)>

BETA

Find bank statement corresponding with sent data.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    List of IDs

  • :account_id (String) —

    List of IDs

  • :file_format (String) —

    File format

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

  • (Array<(ListResponseBankStatement, Fixnum, Hash)>) —

    ListResponseBankStatement data, response status code and response headers



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
 
# File 'lib/tripletex_ruby_client/api/bankstatement_api.rb', line 246

def search_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BankstatementApi.search ...'
  end
  if @api_client.config.client_side_validation && opts[:'file_format'] && !['DNB_CSV', 'EIKA_TELEPAY', 'SPAREBANK1_TELEPAY', 'VISMA_ACCOUNT_STATEMENT', 'HANDELSBANKEN_TELEPAY', 'SPAREBANKEN_VEST_TELEPAY', 'NORDEA_CSV', 'TRANSFERWISE', 'SPAREBANKEN_SOR_TELEPAY', 'SPAREBANKEN_OST_TELEPAY', 'DANSKE_BANK_CSV', 'CULTURA_BANK_TELEPAY', 'SBANKEN_PRIVAT_CSV', 'HAUGESUND_SPAREBANK_CSV', 'VISMA_ACCOUNT_STATEMENT_PSD2', 'SBANKEN_BEDRIFT_CSV', 'LANDKREDITT_TELEPAY'].include?(opts[:'file_format'])
    fail ArgumentError, 'invalid value for "file_format", must be one of DNB_CSV, EIKA_TELEPAY, SPAREBANK1_TELEPAY, VISMA_ACCOUNT_STATEMENT, HANDELSBANKEN_TELEPAY, SPAREBANKEN_VEST_TELEPAY, NORDEA_CSV, TRANSFERWISE, SPAREBANKEN_SOR_TELEPAY, SPAREBANKEN_OST_TELEPAY, DANSKE_BANK_CSV, CULTURA_BANK_TELEPAY, SBANKEN_PRIVAT_CSV, HAUGESUND_SPAREBANK_CSV, VISMA_ACCOUNT_STATEMENT_PSD2, SBANKEN_BEDRIFT_CSV, LANDKREDITT_TELEPAY'
  end
  # resource path
  local_var_path = '/bank/statement'

  # query parameters
  query_params = {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'fileFormat'] = opts[:'file_format'] if !opts[:'file_format'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  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 => 'ListResponseBankStatement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BankstatementApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end