Class: BudgeaClient::BanksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/banks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BanksApi

Returns a new instance of BanksApi.



19
20
21
 
# File 'lib/budgea_client/api/banks_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/budgea_client/api/banks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#account_types_get(opts = {}) ⇒ InlineResponse200

Get account types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



27
28
29
30
 
# File 'lib/budgea_client/api/banks_api.rb', line 27

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

#account_types_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Get account types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse200 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
 
# File 'lib/budgea_client/api/banks_api.rb', line 37

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.account_types_get ...'
  end
  # resource path
  local_var_path = '/account_types'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#account_types_id_account_type_get(id_account_type, opts = {}) ⇒ AccountType

Get an account type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



79
80
81
82
 
# File 'lib/budgea_client/api/banks_api.rb', line 79

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

#account_types_id_account_type_get_with_http_info(id_account_type, opts = {}) ⇒ Array<(AccountType, Fixnum, Hash)>

Get an account type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    AccountType data, response status code and response headers



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
124
125
126
127
128
129
 
# File 'lib/budgea_client/api/banks_api.rb', line 90

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

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#banks_categories_id_category_delete(id_category, opts = {}) ⇒ ConnectorCategory

Delete the supplied category

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



136
137
138
139
 
# File 'lib/budgea_client/api/banks_api.rb', line 136

def banks_categories_id_category_delete(id_category, opts = {})
  data, _status_code, _headers = banks_categories_id_category_delete_with_http_info(id_category, opts)
  data
end

#banks_categories_id_category_delete_with_http_info(id_category, opts = {}) ⇒ Array<(ConnectorCategory, Fixnum, Hash)>

Delete the supplied category

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorCategory data, response status code and response headers



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

def banks_categories_id_category_delete_with_http_info(id_category, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_categories_id_category_delete ...'
  end
  # verify the required parameter 'id_category' is set
  if @api_client.config.client_side_validation && id_category.nil?
    fail ArgumentError, "Missing the required parameter 'id_category' when calling BanksApi.banks_categories_id_category_delete"
  end
  # resource path
  local_var_path = '/banks/categories/{id_category}'.sub('{' + 'id_category' + '}', id_category.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#banks_categories_id_category_post(id_category, name, opts = {}) ⇒ ConnectorCategory

Edit a bank categories Edit the name for the supplied category.

Parameters:

  • id_category
  • name —

    new name for the supplied category

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



194
195
196
197
 
# File 'lib/budgea_client/api/banks_api.rb', line 194

def banks_categories_id_category_post(id_category, name, opts = {})
  data, _status_code, _headers = banks_categories_id_category_post_with_http_info(id_category, name, opts)
  data
end

#banks_categories_id_category_post_with_http_info(id_category, name, opts = {}) ⇒ Array<(ConnectorCategory, Fixnum, Hash)>

Edit a bank categories Edit the name for the supplied category.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_category
  • name —

    new name for the supplied category

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorCategory data, response status code and response headers



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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/budgea_client/api/banks_api.rb', line 206

def banks_categories_id_category_post_with_http_info(id_category, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_categories_id_category_post ...'
  end
  # verify the required parameter 'id_category' is set
  if @api_client.config.client_side_validation && id_category.nil?
    fail ArgumentError, "Missing the required parameter 'id_category' when calling BanksApi.banks_categories_id_category_post"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling BanksApi.banks_categories_id_category_post"
  end
  # resource path
  local_var_path = '/banks/categories/{id_category}'.sub('{' + 'id_category' + '}', id_category.to_s)

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

  # 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/x-www-form-urlencoded'])

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

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

#banks_categories_post(name, opts = {}) ⇒ ConnectorCategory

Create bank categories It requires the name of the category to be created

Parameters:

  • name —

    name of the category to be created

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



257
258
259
260
 
# File 'lib/budgea_client/api/banks_api.rb', line 257

def banks_categories_post(name, opts = {})
  data, _status_code, _headers = banks_categories_post_with_http_info(name, opts)
  data
end

#banks_categories_post_with_http_info(name, opts = {}) ⇒ Array<(ConnectorCategory, Fixnum, Hash)>

Create bank categories It requires the name of the category to be created&lt;br&gt;&lt;br&gt;

Parameters:

  • name —

    name of the category to be created

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorCategory data, response status code and response headers



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
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/budgea_client/api/banks_api.rb', line 268

def banks_categories_post_with_http_info(name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_categories_post ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling BanksApi.banks_categories_post"
  end
  # resource path
  local_var_path = '/banks/categories'

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

  # 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/x-www-form-urlencoded'])

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

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

#banks_get(opts = {}) ⇒ InlineResponse2008

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



314
315
316
317
 
# File 'lib/budgea_client/api/banks_api.rb', line 314

def banks_get(opts = {})
  data, _status_code, _headers = banks_get_with_http_info(opts)
  data
end

#banks_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse2008, Fixnum, Hash)>

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse2008 data, response status code and response headers



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/budgea_client/api/banks_api.rb', line 324

def banks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_get ...'
  end
  # resource path
  local_var_path = '/banks'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#banks_id_connector_connections_get(id_connector, opts = {}) ⇒ InlineResponse2009

Get a subset of id_connection with the largest diversity of account By default, it selects a set of 3 connections.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :range (Integer) —

    the length of the connection subset

  • :type (Integer) —

    to target a specific account type which will be

  • :occurrences (Integer) —

    require at least N accounts of the targeted

  • :expand (String)

Returns:



369
370
371
372
 
# File 'lib/budgea_client/api/banks_api.rb', line 369

def banks_id_connector_connections_get(id_connector, opts = {})
  data, _status_code, _headers = banks_id_connector_connections_get_with_http_info(id_connector, opts)
  data
end

#banks_id_connector_connections_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

Get a subset of id_connection with the largest diversity of account By default, it selects a set of 3 connections.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :range (Integer) —

    the length of the connection subset

  • :type (Integer) —

    to target a specific account type which will be

  • :occurrences (Integer) —

    require at least N accounts of the targeted

  • :expand (String)

Returns:

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

    InlineResponse2009 data, response status code and response headers



383
384
385
386
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/budgea_client/api/banks_api.rb', line 383

def banks_id_connector_connections_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_id_connector_connections_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.banks_id_connector_connections_get"
  end
  # resource path
  local_var_path = '/banks/{id_connector}/connections'.sub('{' + 'id_connector' + '}', id_connector.to_s)

  # query parameters
  query_params = {}
  query_params[:'range'] = opts[:'range'] if !opts[:'range'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'occurrences'] = opts[:'occurrences'] if !opts[:'occurrences'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#banks_id_connector_logos_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



432
433
434
435
 
# File 'lib/budgea_client/api/banks_api.rb', line 432

def banks_id_connector_logos_get(id_connector, opts = {})
  data, _status_code, _headers = banks_id_connector_logos_get_with_http_info(id_connector, opts)
  data
end

#banks_id_connector_logos_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



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
478
479
480
481
482
 
# File 'lib/budgea_client/api/banks_api.rb', line 443

def banks_id_connector_logos_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_id_connector_logos_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.banks_id_connector_logos_get"
  end
  # resource path
  local_var_path = '/banks/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#banks_id_connector_logos_main_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



489
490
491
492
 
# File 'lib/budgea_client/api/banks_api.rb', line 489

def banks_id_connector_logos_main_get(id_connector, opts = {})
  data, _status_code, _headers = banks_id_connector_logos_main_get_with_http_info(id_connector, opts)
  data
end

#banks_id_connector_logos_main_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/budgea_client/api/banks_api.rb', line 500

def banks_id_connector_logos_main_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_id_connector_logos_main_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.banks_id_connector_logos_main_get"
  end
  # resource path
  local_var_path = '/banks/{id_connector}/logos/main'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#banks_id_connector_logos_thumbnail_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



546
547
548
549
 
# File 'lib/budgea_client/api/banks_api.rb', line 546

def banks_id_connector_logos_thumbnail_get(id_connector, opts = {})
  data, _status_code, _headers = banks_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts)
  data
end

#banks_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/budgea_client/api/banks_api.rb', line 557

def banks_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.banks_id_connector_logos_thumbnail_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.banks_id_connector_logos_thumbnail_get"
  end
  # resource path
  local_var_path = '/banks/{id_connector}/logos/thumbnail'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#categories_get(opts = {}) ⇒ InlineResponse20011

Get all categories Ressource to get all existing categories

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



602
603
604
605
 
# File 'lib/budgea_client/api/banks_api.rb', line 602

def categories_get(opts = {})
  data, _status_code, _headers = categories_get_with_http_info(opts)
  data
end

#categories_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20011, Fixnum, Hash)>

Get all categories Ressource to get all existing categories&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20011 data, response status code and response headers



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/budgea_client/api/banks_api.rb', line 612

def categories_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.categories_get ...'
  end
  # resource path
  local_var_path = '/categories'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#categories_keywords_id_keyword_delete(id_keyword, opts = {}) ⇒ Keyword

Delete a particular key-value pair on a transaction.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



654
655
656
657
 
# File 'lib/budgea_client/api/banks_api.rb', line 654

def categories_keywords_id_keyword_delete(id_keyword, opts = {})
  data, _status_code, _headers = categories_keywords_id_keyword_delete_with_http_info(id_keyword, opts)
  data
end

#categories_keywords_id_keyword_delete_with_http_info(id_keyword, opts = {}) ⇒ Array<(Keyword, Fixnum, Hash)>

Delete a particular key-value pair on a transaction.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Keyword data, response status code and response headers



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/budgea_client/api/banks_api.rb', line 665

def categories_keywords_id_keyword_delete_with_http_info(id_keyword, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.categories_keywords_id_keyword_delete ...'
  end
  # verify the required parameter 'id_keyword' is set
  if @api_client.config.client_side_validation && id_keyword.nil?
    fail ArgumentError, "Missing the required parameter 'id_keyword' when calling BanksApi.categories_keywords_id_keyword_delete"
  end
  # resource path
  local_var_path = '/categories/keywords/{id_keyword}'.sub('{' + 'id_keyword' + '}', id_keyword.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#categories_keywords_post(opts = {}) ⇒ Keyword

Add a new keyword associated with a category in the database. If the keyword already exists the keyword is not added. Used for the categorization of transactions.
Form params: - id_category (integer): a reference towards the category associated with the keyword - keyword (string): the searched keyword - income (bool): 1 if the associated category represents an income else 0 - priority (integer): sets the priority for the keyword, used when categorizing

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



710
711
712
713
 
# File 'lib/budgea_client/api/banks_api.rb', line 710

def categories_keywords_post(opts = {})
  data, _status_code, _headers = categories_keywords_post_with_http_info(opts)
  data
end

#categories_keywords_post_with_http_info(opts = {}) ⇒ Array<(Keyword, Fixnum, Hash)>

Add a new keyword associated with a category in the database. If the keyword already exists the keyword is not added. Used for the categorization of transactions.&lt;br&gt;&lt;br&gt;Form params: - id_category (integer): a reference towards the category associated with the keyword - keyword (string): the searched keyword - income (bool): 1 if the associated category represents an income else 0 - priority (integer): sets the priority for the keyword, used when categorizing&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Keyword data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/budgea_client/api/banks_api.rb', line 720

def categories_keywords_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.categories_keywords_post ...'
  end
  # resource path
  local_var_path = '/categories/keywords'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#categorize_post(wording, value, type, opts = {}) ⇒ Object

categorize transactions without storing them It requires an array of transaction dictionaries. Any fields of transactions that are not required will be kept in the response. The response contains the list of transactions with two more fields: id_category and state (it indicates how the transaction has been categorized)

Parameters:

  • wording —

    label of the transaction

  • value —

    value of the transaction

  • type —

    type of the transaction (default: unknown)

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

    the optional parameters

Returns:

  • (Object) 


763
764
765
766
 
# File 'lib/budgea_client/api/banks_api.rb', line 763

def categorize_post(wording, value, type, opts = {})
  data, _status_code, _headers = categorize_post_with_http_info(wording, value, type, opts)
  data
end

#categorize_post_with_http_info(wording, value, type, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

categorize transactions without storing them It requires an array of transaction dictionaries. Any fields of transactions that are not required will be kept in the response. The response contains the list of transactions with two more fields: id_category and state (it indicates how the transaction has been categorized)&lt;br&gt;&lt;br&gt;

Parameters:

  • wording —

    label of the transaction

  • value —

    value of the transaction

  • type —

    type of the transaction (default: unknown)

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
 
# File 'lib/budgea_client/api/banks_api.rb', line 775

def categorize_post_with_http_info(wording, value, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.categorize_post ...'
  end
  # verify the required parameter 'wording' is set
  if @api_client.config.client_side_validation && wording.nil?
    fail ArgumentError, "Missing the required parameter 'wording' when calling BanksApi.categorize_post"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling BanksApi.categorize_post"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling BanksApi.categorize_post"
  end
  # resource path
  local_var_path = '/categorize'

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['wording'] = wording
  form_params['value'] = value
  form_params['type'] = type

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

#connections_get(opts = {}) ⇒ InlineResponse2009

Get connections without a user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



830
831
832
833
 
# File 'lib/budgea_client/api/banks_api.rb', line 830

def connections_get(opts = {})
  data, _status_code, _headers = connections_get_with_http_info(opts)
  data
end

#connections_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

Get connections without a user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse2009 data, response status code and response headers



840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
 
# File 'lib/budgea_client/api/banks_api.rb', line 840

def connections_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connections_get ...'
  end
  # resource path
  local_var_path = '/connections'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_get(opts = {}) ⇒ InlineResponse20014

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



881
882
883
884
 
# File 'lib/budgea_client/api/banks_api.rb', line 881

def connectors_get(opts = {})
  data, _status_code, _headers = connectors_get_with_http_info(opts)
  data
end

#connectors_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20014, Fixnum, Hash)>

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20014 data, response status code and response headers



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/budgea_client/api/banks_api.rb', line 891

def connectors_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_get ...'
  end
  # resource path
  local_var_path = '/connectors'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



933
934
935
936
 
# File 'lib/budgea_client/api/banks_api.rb', line 933

def connectors_id_connector_logos_get(id_connector, opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_get_with_http_info(id_connector, opts)
  data
end

#connectors_id_connector_logos_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/budgea_client/api/banks_api.rb', line 944

def connectors_id_connector_logos_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_get"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_id_logo_delete(id_connector, id_logo, opts = {}) ⇒ ConnectorLogo

Delete a single Logo object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



991
992
993
994
 
# File 'lib/budgea_client/api/banks_api.rb', line 991

def connectors_id_connector_logos_id_logo_delete(id_connector, , opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_id_logo_delete_with_http_info(id_connector, , opts)
  data
end

#connectors_id_connector_logos_id_logo_delete_with_http_info(id_connector, id_logo, opts = {}) ⇒ Array<(ConnectorLogo, Fixnum, Hash)>

Delete a single Logo object.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorLogo data, response status code and response headers



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/budgea_client/api/banks_api.rb', line 1003

def connectors_id_connector_logos_id_logo_delete_with_http_info(id_connector, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_id_logo_delete ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_id_logo_delete"
  end
  # verify the required parameter 'id_logo' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_logo' when calling BanksApi.connectors_id_connector_logos_id_logo_delete"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos/{id_logo}'.sub('{' + 'id_connector' + '}', id_connector.to_s).sub('{' + 'id_logo' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_id_logo_put(id_connector, id_logo, opts = {}) ⇒ ConnectorLogo

Create or Update a connector Logo. This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).
Form params: - id_file (integer): The id of the file to link with that connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1054
1055
1056
1057
 
# File 'lib/budgea_client/api/banks_api.rb', line 1054

def connectors_id_connector_logos_id_logo_put(id_connector, , opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_id_logo_put_with_http_info(id_connector, , opts)
  data
end

#connectors_id_connector_logos_id_logo_put_with_http_info(id_connector, id_logo, opts = {}) ⇒ Array<(ConnectorLogo, Fixnum, Hash)>

Create or Update a connector Logo. This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).&lt;br&gt;&lt;br&gt;Form params: - id_file (integer): The id of the file to link with that connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorLogo data, response status code and response headers



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/budgea_client/api/banks_api.rb', line 1066

def connectors_id_connector_logos_id_logo_put_with_http_info(id_connector, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_id_logo_put ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_id_logo_put"
  end
  # verify the required parameter 'id_logo' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_logo' when calling BanksApi.connectors_id_connector_logos_id_logo_put"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos/{id_logo}'.sub('{' + 'id_connector' + '}', id_connector.to_s).sub('{' + 'id_logo' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_main_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1116
1117
1118
1119
 
# File 'lib/budgea_client/api/banks_api.rb', line 1116

def connectors_id_connector_logos_main_get(id_connector, opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_main_get_with_http_info(id_connector, opts)
  data
end

#connectors_id_connector_logos_main_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
 
# File 'lib/budgea_client/api/banks_api.rb', line 1127

def connectors_id_connector_logos_main_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_main_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_main_get"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos/main'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_post(id_connector, opts = {}) ⇒ ConnectorLogo

Create a connector Logo This endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a connector with an existing file. Will fail if the file is already linked with that connector.
Form params: - id_file (integer): The id of the file to link with that connector. - img (string): Path to the image to link with that connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1173
1174
1175
1176
 
# File 'lib/budgea_client/api/banks_api.rb', line 1173

def connectors_id_connector_logos_post(id_connector, opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_post_with_http_info(id_connector, opts)
  data
end

#connectors_id_connector_logos_post_with_http_info(id_connector, opts = {}) ⇒ Array<(ConnectorLogo, Fixnum, Hash)>

Create a connector Logo This endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a connector with an existing file. Will fail if the file is already linked with that connector.&lt;br&gt;&lt;br&gt;Form params: - id_file (integer): The id of the file to link with that connector. - img (string): Path to the image to link with that connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorLogo data, response status code and response headers



1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'lib/budgea_client/api/banks_api.rb', line 1184

def connectors_id_connector_logos_post_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_post ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_post"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_put(id_connector, opts = {}) ⇒ ConnectorLogo

Create or Update a connector Logo This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).
Form params: - id_file (integer): The id of the file to link with that connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1230
1231
1232
1233
 
# File 'lib/budgea_client/api/banks_api.rb', line 1230

def connectors_id_connector_logos_put(id_connector, opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_put_with_http_info(id_connector, opts)
  data
end

#connectors_id_connector_logos_put_with_http_info(id_connector, opts = {}) ⇒ Array<(ConnectorLogo, Fixnum, Hash)>

Create or Update a connector Logo This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).&lt;br&gt;&lt;br&gt;Form params: - id_file (integer): The id of the file to link with that connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectorLogo data, response status code and response headers



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/budgea_client/api/banks_api.rb', line 1241

def connectors_id_connector_logos_put_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_put ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_put"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_logos_thumbnail_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1287
1288
1289
1290
 
# File 'lib/budgea_client/api/banks_api.rb', line 1287

def connectors_id_connector_logos_thumbnail_get(id_connector, opts = {})
  data, _status_code, _headers = connectors_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts)
  data
end

#connectors_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/budgea_client/api/banks_api.rb', line 1298

def connectors_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_id_connector_logos_thumbnail_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.connectors_id_connector_logos_thumbnail_get"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/logos/thumbnail'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#connectors_id_connector_put(id_connector, opts = {}) ⇒ Connector

Edit the provided connector

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id_categories (String) —

    one or several comma separated categories to map to the given connector (or null to map no category)

  • :hidden (BOOLEAN) —

    to enable or disable connector (bank or provider)

  • :sync_frequency (Integer) —

    Allows you to overload global sync_frequency param

  • :expand (String)

Returns:



1347
1348
1349
1350
 
# File 'lib/budgea_client/api/banks_api.rb', line 1347

def connectors_id_connector_put(id_connector, opts = {})
  data, _status_code, _headers = connectors_id_connector_put_with_http_info(id_connector, opts)
  data
end

#connectors_id_connector_put_with_http_info(id_connector, opts = {}) ⇒ Array<(Connector, Fixnum, Hash)>

Edit the provided connector &lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :id_categories (String) —

    one or several comma separated categories to map to the given connector (or null to map no category)

  • :hidden (BOOLEAN) —

    to enable or disable connector (bank or provider)

  • :sync_frequency (Integer) —

    Allows you to overload global sync_frequency param

  • :expand (String)

Returns:

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

    Connector data, response status code and response headers



1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
 
# File 'lib/budgea_client/api/banks_api.rb', line 1361

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

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_categories'] = opts[:'id_categories'] if !opts[:'id_categories'].nil?
  form_params['hidden'] = opts[:'hidden'] if !opts[:'hidden'].nil?
  form_params['sync_frequency'] = opts[:'sync_frequency'] if !opts[:'sync_frequency'].nil?

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

#connectors_post(name, login, password, opts = {}) ⇒ Connector

Request a new connector Send a request to add a new connector

Parameters:

  • name —

    Name of the bank or provider

  • login —

    Users login

  • password —

    Users password

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

    the optional parameters

Options Hash (opts):

  • :url (String) —

    Url of the bank

  • :email (String) —

    Email of the user

  • :types (String) —

    Type of connector, eg. banks or providers

  • :comment (String) —

    Optionnal comment

  • :sendmail (BOOLEAN) —

    if set, send an email to user

  • :expand (String)

Returns:



1417
1418
1419
1420
 
# File 'lib/budgea_client/api/banks_api.rb', line 1417

def connectors_post(name, , password, opts = {})
  data, _status_code, _headers = connectors_post_with_http_info(name, , password, opts)
  data
end

#connectors_post_with_http_info(name, login, password, opts = {}) ⇒ Array<(Connector, Fixnum, Hash)>

Request a new connector Send a request to add a new connector&lt;br&gt;&lt;br&gt;

Parameters:

  • name —

    Name of the bank or provider

  • login —

    Users login

  • password —

    Users password

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

    the optional parameters

Options Hash (opts):

  • :url (String) —

    Url of the bank

  • :email (String) —

    Email of the user

  • :types (String) —

    Type of connector, eg. banks or providers

  • :comment (String) —

    Optionnal comment

  • :sendmail (BOOLEAN) —

    if set, send an email to user

  • :expand (String)

Returns:

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

    Connector data, response status code and response headers



1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
 
# File 'lib/budgea_client/api/banks_api.rb', line 1435

def connectors_post_with_http_info(name, , password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.connectors_post ...'
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling BanksApi.connectors_post"
  end
  # verify the required parameter 'login' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'login' when calling BanksApi.connectors_post"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling BanksApi.connectors_post"
  end
  # resource path
  local_var_path = '/connectors'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['name'] = name
  form_params['login'] = 
  form_params['password'] = password
  form_params['url'] = opts[:'url'] if !opts[:'url'].nil?
  form_params['email'] = opts[:'email'] if !opts[:'email'].nil?
  form_params['types'] = opts[:'types'] if !opts[:'types'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['sendmail'] = opts[:'sendmail'] if !opts[:'sendmail'].nil?

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

#invoicing_get(opts = {}) ⇒ nil

Get number of accounts, connections and users synced. Get number of accounts, connections and users synced between two dates for the given period.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :period (String) —

    period to group logs

  • :all (String) —

    get full ids list instead of numbers

Returns:

  • (nil) 


1499
1500
1501
1502
 
# File 'lib/budgea_client/api/banks_api.rb', line 1499

def invoicing_get(opts = {})
  invoicing_get_with_http_info(opts)
  nil
end

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

Get number of accounts, connections and users synced. Get number of accounts, connections and users synced between two dates for the given period.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :period (String) —

    period to group logs

  • :all (String) —

    get full ids list instead of numbers

Returns:

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

    nil, response status code and response headers



1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
 
# File 'lib/budgea_client/api/banks_api.rb', line 1512

def invoicing_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.invoicing_get ...'
  end
  # resource path
  local_var_path = '/invoicing'

  # query parameters
  query_params = {}
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#logs_get(opts = {}) ⇒ InlineResponse20017

Get connection logs Get logs about connections.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :state (Integer) —

    state of user

  • :period (String) —

    period to group logs

  • :id_user (Integer) —

    ID of a user

  • :id_connection (Integer) —

    ID of a connection

  • :id_connector (Integer) —

    ID of a connector

  • :charged (BOOLEAN) —

    consider only logs for charged connectors

  • :expand (String)

Returns:



1565
1566
1567
1568
 
# File 'lib/budgea_client/api/banks_api.rb', line 1565

def logs_get(opts = {})
  data, _status_code, _headers = logs_get_with_http_info(opts)
  data
end

#logs_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20017, Fixnum, Hash)>

Get connection logs Get logs about connections.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :state (Integer) —

    state of user

  • :period (String) —

    period to group logs

  • :id_user (Integer) —

    ID of a user

  • :id_connection (Integer) —

    ID of a connection

  • :id_connector (Integer) —

    ID of a connector

  • :charged (BOOLEAN) —

    consider only logs for charged connectors

  • :expand (String)

Returns:

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

    InlineResponse20017 data, response status code and response headers



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
 
# File 'lib/budgea_client/api/banks_api.rb', line 1585

def logs_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.logs_get ...'
  end
  # resource path
  local_var_path = '/logs'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil?
  query_params[:'id_connection'] = opts[:'id_connection'] if !opts[:'id_connection'].nil?
  query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil?
  query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#providers_get(opts = {}) ⇒ InlineResponse20018

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1636
1637
1638
1639
 
# File 'lib/budgea_client/api/banks_api.rb', line 1636

def providers_get(opts = {})
  data, _status_code, _headers = providers_get_with_http_info(opts)
  data
end

#providers_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20018, Fixnum, Hash)>

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20018 data, response status code and response headers



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
 
# File 'lib/budgea_client/api/banks_api.rb', line 1646

def providers_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.providers_get ...'
  end
  # resource path
  local_var_path = '/providers'

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#providers_id_connector_connections_get(id_connector, opts = {}) ⇒ InlineResponse2009

Get a random subset of provider’s id_connection By default, it selects a set of 3 connections.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :range (Integer) —

    the length of the connection subset

  • :expand (String)

Returns:



1689
1690
1691
1692
 
# File 'lib/budgea_client/api/banks_api.rb', line 1689

def providers_id_connector_connections_get(id_connector, opts = {})
  data, _status_code, _headers = providers_id_connector_connections_get_with_http_info(id_connector, opts)
  data
end

#providers_id_connector_connections_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

Get a random subset of provider&#39;s id_connection By default, it selects a set of 3 connections.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :range (Integer) —

    the length of the connection subset

  • :expand (String)

Returns:

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

    InlineResponse2009 data, response status code and response headers



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/budgea_client/api/banks_api.rb', line 1701

def providers_id_connector_connections_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.providers_id_connector_connections_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.providers_id_connector_connections_get"
  end
  # resource path
  local_var_path = '/providers/{id_connector}/connections'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#providers_id_connector_logos_get(id_connector, opts = {}) ⇒ InlineResponse20019

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1748
1749
1750
1751
 
# File 'lib/budgea_client/api/banks_api.rb', line 1748

def providers_id_connector_logos_get(id_connector, opts = {})
  data, _status_code, _headers = providers_id_connector_logos_get_with_http_info(id_connector, opts)
  data
end

#providers_id_connector_logos_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20019, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20019 data, response status code and response headers



1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'lib/budgea_client/api/banks_api.rb', line 1759

def providers_id_connector_logos_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.providers_id_connector_logos_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.providers_id_connector_logos_get"
  end
  # resource path
  local_var_path = '/providers/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#providers_id_connector_logos_main_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1805
1806
1807
1808
 
# File 'lib/budgea_client/api/banks_api.rb', line 1805

def providers_id_connector_logos_main_get(id_connector, opts = {})
  data, _status_code, _headers = providers_id_connector_logos_main_get_with_http_info(id_connector, opts)
  data
end

#providers_id_connector_logos_main_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
 
# File 'lib/budgea_client/api/banks_api.rb', line 1816

def providers_id_connector_logos_main_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.providers_id_connector_logos_main_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.providers_id_connector_logos_main_get"
  end
  # resource path
  local_var_path = '/providers/{id_connector}/logos/main'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#providers_id_connector_logos_thumbnail_get(id_connector, opts = {}) ⇒ InlineResponse20010

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1862
1863
1864
1865
 
# File 'lib/budgea_client/api/banks_api.rb', line 1862

def providers_id_connector_logos_thumbnail_get(id_connector, opts = {})
  data, _status_code, _headers = providers_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts)
  data
end

#providers_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>

Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20010 data, response status code and response headers



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
 
# File 'lib/budgea_client/api/banks_api.rb', line 1873

def providers_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.providers_id_connector_logos_thumbnail_get ...'
  end
  # verify the required parameter 'id_connector' is set
  if @api_client.config.client_side_validation && id_connector.nil?
    fail ArgumentError, "Missing the required parameter 'id_connector' when calling BanksApi.providers_id_connector_logos_thumbnail_get"
  end
  # resource path
  local_var_path = '/providers/{id_connector}/logos/thumbnail'.sub('{' + 'id_connector' + '}', id_connector.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_account_types_get(id_user, opts = {}) ⇒ InlineResponse200

Get account types

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1919
1920
1921
1922
 
# File 'lib/budgea_client/api/banks_api.rb', line 1919

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

#users_id_user_account_types_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse200, Fixnum, Hash)>

Get account types

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse200 data, response status code and response headers



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
 
# File 'lib/budgea_client/api/banks_api.rb', line 1930

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

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_account_types_id_account_type_get(id_user, id_account_type, opts = {}) ⇒ AccountType

Get an account type

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1977
1978
1979
1980
 
# File 'lib/budgea_client/api/banks_api.rb', line 1977

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

#users_id_user_account_types_id_account_type_get_with_http_info(id_user, id_account_type, opts = {}) ⇒ Array<(AccountType, Fixnum, Hash)>

Get an account type

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    AccountType data, response status code and response headers



1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
 
# File 'lib/budgea_client/api/banks_api.rb', line 1989

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_account_types_id_account_type_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_account_types_id_account_type_get"
  end
  # verify the required parameter 'id_account_type' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account_type' when calling BanksApi.users_id_user_account_types_id_account_type_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/account_types/{id_account_type}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account_type' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_delete(id_user, opts = {}) ⇒ Account

Delete all accounts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2039
2040
2041
2042
 
# File 'lib/budgea_client/api/banks_api.rb', line 2039

def users_id_user_accounts_delete(id_user, opts = {})
  data, _status_code, _headers = users_id_user_accounts_delete_with_http_info(id_user, opts)
  data
end

#users_id_user_accounts_delete_with_http_info(id_user, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Delete all accounts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
 
# File 'lib/budgea_client/api/banks_api.rb', line 2050

def users_id_user_accounts_delete_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_get(id_user, opts = {}) ⇒ InlineResponse20022

Get accounts list.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2096
2097
2098
2099
 
# File 'lib/budgea_client/api/banks_api.rb', line 2096

def users_id_user_accounts_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_accounts_get_with_http_info(id_user, opts)
  data
end

#users_id_user_accounts_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20022, Fixnum, Hash)>

Get accounts list.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20022 data, response status code and response headers



2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
 
# File 'lib/budgea_client/api/banks_api.rb', line 2107

def users_id_user_accounts_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_categories_get(id_user, id_account, opts = {}) ⇒ nil

Get the category Ressource to get categories for the user’s transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (nil) 


2153
2154
2155
2156
 
# File 'lib/budgea_client/api/banks_api.rb', line 2153

def (id_user, , opts = {})
  (id_user, , opts)
  nil
end

#users_id_user_accounts_id_account_categories_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get the category Ressource to get categories for the user&#39;s transactions&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
 
# File 'lib/budgea_client/api/banks_api.rb', line 2164

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_categories_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_categories_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_categories_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/categories'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_delete(id_user, id_account, opts = {}) ⇒ Account

Delete an account. It deletes a specific account.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2213
2214
2215
2216
 
# File 'lib/budgea_client/api/banks_api.rb', line 2213

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

#users_id_user_accounts_id_account_delete_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Delete an account. It deletes a specific account.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
 
# File 'lib/budgea_client/api/banks_api.rb', line 2225

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_delta_get(id_user, id_account, opts = {}) ⇒ nil

Get deltas of accounts Get account delta between sums of transactions and difference of account balance for the given period.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :period (String) —

    period to group logs

Returns:

  • (nil) 


2278
2279
2280
2281
 
# File 'lib/budgea_client/api/banks_api.rb', line 2278

def (id_user, , opts = {})
  (id_user, , opts)
  nil
end

#users_id_user_accounts_id_account_delta_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get deltas of accounts Get account delta between sums of transactions and difference of account balance for the given period.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :period (String) —

    period to group logs

Returns:

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

    nil, response status code and response headers



2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
 
# File 'lib/budgea_client/api/banks_api.rb', line 2292

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_delta_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_delta_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_delta_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/delta'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_logs_get(id_user, id_account, opts = {}) ⇒ InlineResponse20026

Get accounts logs. Get logs of account.
By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :expand (String)

Returns:



2348
2349
2350
2351
 
# File 'lib/budgea_client/api/banks_api.rb', line 2348

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

#users_id_user_accounts_id_account_logs_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(InlineResponse20026, Fixnum, Hash)>

Get accounts logs. Get logs of account.&lt;br&gt;&lt;br&gt;By default, it selects logs for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :expand (String)

Returns:

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

    InlineResponse20026 data, response status code and response headers



2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
 
# File 'lib/budgea_client/api/banks_api.rb', line 2364

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_logs_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_logs_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_logs_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/logs'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_put(id_user, id_account, opts = {}) ⇒ Account

Update an account It updates a specific account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :display (BOOLEAN) —

    If the account is displayed

  • :name (String) —

    Label of the account

  • :balance (Float) —

    Balance of the account

  • :disabled (BOOLEAN) —

    If the account is disabled (not synchronized)

  • :iban (String) —

    IBAN of the account

  • :bookmarked (BOOLEAN) —

    If the account is bookmarked

  • :usage (String) —

    Usage of the account : PRIV, ORGA or ASSO

  • :expand (String)

Returns:



2426
2427
2428
2429
 
# File 'lib/budgea_client/api/banks_api.rb', line 2426

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

#users_id_user_accounts_id_account_put_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Update an account It updates a specific account&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :display (BOOLEAN) —

    If the account is displayed

  • :name (String) —

    Label of the account

  • :balance (Float) —

    Balance of the account

  • :disabled (BOOLEAN) —

    If the account is disabled (not synchronized)

  • :iban (String) —

    IBAN of the account

  • :bookmarked (BOOLEAN) —

    If the account is bookmarked

  • :usage (String) —

    Usage of the account : PRIV, ORGA or ASSO

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
 
# File 'lib/budgea_client/api/banks_api.rb', line 2445

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['display'] = opts[:'display'] if !opts[:'display'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['balance'] = opts[:'balance'] if !opts[:'balance'].nil?
  form_params['disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil?
  form_params['iban'] = opts[:'iban'] if !opts[:'iban'].nil?
  form_params['bookmarked'] = opts[:'bookmarked'] if !opts[:'bookmarked'].nil?
  form_params['usage'] = opts[:'usage'] if !opts[:'usage'].nil?

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

#users_id_user_accounts_id_account_transactions_delete(id_user, id_account, opts = {}) ⇒ Transaction

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2503
2504
2505
2506
 
# File 'lib/budgea_client/api/banks_api.rb', line 2503

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

#users_id_user_accounts_id_account_transactions_delete_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
 
# File 'lib/budgea_client/api/banks_api.rb', line 2515

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts = {}) ⇒ InlineResponse20030

Get transactions Get list of transactions.
By default, it selects transactions for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:



2579
2580
2581
2582
 
# File 'lib/budgea_client/api/banks_api.rb', line 2579

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

#users_id_user_accounts_id_account_transactions_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(InlineResponse20030, Fixnum, Hash)>

Get transactions Get list of transactions.&lt;br&gt;&lt;br&gt;By default, it selects transactions for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:

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

    InlineResponse20030 data, response status code and response headers



2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
 
# File 'lib/budgea_client/api/banks_api.rb', line 2604

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'income'] = opts[:'income'] if !opts[:'income'].nil?
  query_params[:'deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
  query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?
  query_params[:'last_update'] = opts[:'last_update'] if !opts[:'last_update'].nil?
  query_params[:'wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  query_params[:'min_value'] = opts[:'min_value'] if !opts[:'min_value'].nil?
  query_params[:'max_value'] = opts[:'max_value'] if !opts[:'max_value'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_informations_delete(id_user, id_account, id_transaction, opts = {}) ⇒ TransactionInformation

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2669
2670
2671
2672
 
# File 'lib/budgea_client/api/banks_api.rb', line 2669

def (id_user, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_informations_delete_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
 
# File 'lib/budgea_client/api/banks_api.rb', line 2682

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts = {}) ⇒ InlineResponse20032

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2738
2739
2740
2741
 
# File 'lib/budgea_client/api/banks_api.rb', line 2738

def (id_user, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_informations_get_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
 
# File 'lib/budgea_client/api/banks_api.rb', line 2751

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete(id_user, id_account, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2808
2809
2810
2811
 
# File 'lib/budgea_client/api/banks_api.rb', line 2808

def (id_user, , id_transaction, id_information, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, id_information, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_account, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
 
# File 'lib/budgea_client/api/banks_api.rb', line 2822

def (id_user, , id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get(id_user, id_account, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2883
2884
2885
2886
 
# File 'lib/budgea_client/api/banks_api.rb', line 2883

def (id_user, , id_transaction, id_information, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, id_information, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_account, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'lib/budgea_client/api/banks_api.rb', line 2897

def (id_user, , id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_informations_put(id_user, id_account, id_transaction, opts = {}) ⇒ TransactionInformation

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2957
2958
2959
2960
 
# File 'lib/budgea_client/api/banks_api.rb', line 2957

def (id_user, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_informations_put_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
 
# File 'lib/budgea_client/api/banks_api.rb', line 2970

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactions_id_transaction_put(id_user, id_account, id_transaction, opts = {}) ⇒ Transaction

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:



3031
3032
3033
3034
 
# File 'lib/budgea_client/api/banks_api.rb', line 3031

def (id_user, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, , id_transaction, opts)
  data
end

#users_id_user_accounts_id_account_transactions_id_transaction_put_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
 
# File 'lib/budgea_client/api/banks_api.rb', line 3049

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_accounts_id_account_transactions_id_transaction_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  form_params['application_date'] = opts[:'application_date'] if !opts[:'application_date'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?

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

#users_id_user_accounts_id_account_transactions_post(id_user, id_account, original_wording, value, date, opts = {}) ⇒ Transaction

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account2 (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:



3119
3120
3121
3122
 
# File 'lib/budgea_client/api/banks_api.rb', line 3119

def (id_user, , original_wording, value, date, opts = {})
  data, _status_code, _headers = (id_user, , original_wording, value, date, opts)
  data
end

#users_id_user_accounts_id_account_transactions_post_with_http_info(id_user, id_account, original_wording, value, date, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_account
  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account2 (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
 
# File 'lib/budgea_client/api/banks_api.rb', line 3141

def (id_user, , original_wording, value, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactions_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'original_wording' is set
  if @api_client.config.client_side_validation && original_wording.nil?
    fail ArgumentError, "Missing the required parameter 'original_wording' when calling BanksApi.users_id_user_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling BanksApi.users_id_user_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling BanksApi.users_id_user_accounts_id_account_transactions_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['original_wording'] = original_wording
  form_params['value'] = value
  form_params['date'] = date
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['state'] = opts[:'state'] if !opts[:'state'].nil?
  form_params['rdate'] = opts[:'rdate'] if !opts[:'rdate'].nil?
  form_params['coming'] = opts[:'coming'] if !opts[:'coming'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?
  form_params['date_scraped'] = opts[:'date_scraped'] if !opts[:'date_scraped'].nil?
  form_params['id_account'] = opts[:'id_account2'] if !opts[:'id_account2'].nil?

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

#users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts = {}) ⇒ InlineResponse20033

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3214
3215
3216
3217
 
# File 'lib/budgea_client/api/banks_api.rb', line 3214

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

#users_id_user_accounts_id_account_transactionsclusters_get_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(InlineResponse20033, Fixnum, Hash)>

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20033 data, response status code and response headers



3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
 
# File 'lib/budgea_client/api/banks_api.rb', line 3226

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactionsclusters_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete(id_user, id_account, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3278
3279
3280
3281
 
# File 'lib/budgea_client/api/banks_api.rb', line 3278

def (id_user, , id_transactionscluster, opts = {})
  data, _status_code, _headers = (id_user, , id_transactionscluster, opts)
  data
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_account, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
 
# File 'lib/budgea_client/api/banks_api.rb', line 3291

def (id_user, , id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put(id_user, id_account, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3347
3348
3349
3350
 
# File 'lib/budgea_client/api/banks_api.rb', line 3347

def (id_user, , id_transactionscluster, opts = {})
  data, _status_code, _headers = (id_user, , id_transactionscluster, opts)
  data
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_account, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
 
# File 'lib/budgea_client/api/banks_api.rb', line 3360

def (id_user, , id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_id_account_transactionsclusters_post(id_user, id_account, opts = {}) ⇒ TransactionsCluster

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3415
3416
3417
3418
 
# File 'lib/budgea_client/api/banks_api.rb', line 3415

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

#users_id_user_accounts_id_account_transactionsclusters_post_with_http_info(id_user, id_account, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
 
# File 'lib/budgea_client/api/banks_api.rb', line 3427

def (id_user, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_id_account_transactionsclusters_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_accounts_id_account_transactionsclusters_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_accounts_post(id_user, name, balance, opts = {}) ⇒ Account

Create an account This endpoint creates an account related to a connection or not.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • name —

    name of account

  • balance —

    balance of account

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    number of account

  • :iban (String) —

    IBAN of account

  • :id_currency (String) —

    the currency of the account (default: &#39;EUR&#39;)

  • :id_connection (Integer) —

    the connection to attach to the account

  • :expand (String)

Returns:



3483
3484
3485
3486
 
# File 'lib/budgea_client/api/banks_api.rb', line 3483

def users_id_user_accounts_post(id_user, name, balance, opts = {})
  data, _status_code, _headers = users_id_user_accounts_post_with_http_info(id_user, name, balance, opts)
  data
end

#users_id_user_accounts_post_with_http_info(id_user, name, balance, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Create an account This endpoint creates an account related to a connection or not.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • name —

    name of account

  • balance —

    balance of account

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    number of account

  • :iban (String) —

    IBAN of account

  • :id_currency (String) —

    the currency of the account (default: &#39;EUR&#39;)

  • :id_connection (Integer) —

    the connection to attach to the account

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
 
# File 'lib/budgea_client/api/banks_api.rb', line 3500

def users_id_user_accounts_post_with_http_info(id_user, name, balance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_post"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling BanksApi.users_id_user_accounts_post"
  end
  # verify the required parameter 'balance' is set
  if @api_client.config.client_side_validation && balance.nil?
    fail ArgumentError, "Missing the required parameter 'balance' when calling BanksApi.users_id_user_accounts_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['name'] = name
  form_params['balance'] = balance
  form_params['number'] = opts[:'number'] if !opts[:'number'].nil?
  form_params['iban'] = opts[:'iban'] if !opts[:'iban'].nil?
  form_params['id_currency'] = opts[:'id_currency'] if !opts[:'id_currency'].nil?
  form_params['id_connection'] = opts[:'id_connection'] if !opts[:'id_connection'].nil?

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

#users_id_user_accounts_put(id_user, opts = {}) ⇒ Account

Update many accounts at once

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3560
3561
3562
3563
 
# File 'lib/budgea_client/api/banks_api.rb', line 3560

def users_id_user_accounts_put(id_user, opts = {})
  data, _status_code, _headers = users_id_user_accounts_put_with_http_info(id_user, opts)
  data
end

#users_id_user_accounts_put_with_http_info(id_user, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Update many accounts at once

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
 
# File 'lib/budgea_client/api/banks_api.rb', line 3571

def users_id_user_accounts_put_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_accounts_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_accounts_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_alerts_get(id_user, opts = {}) ⇒ InlineResponse20034

Get alerts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3617
3618
3619
3620
 
# File 'lib/budgea_client/api/banks_api.rb', line 3617

def users_id_user_alerts_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_alerts_get_with_http_info(id_user, opts)
  data
end

#users_id_user_alerts_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20034, Fixnum, Hash)>

Get alerts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20034 data, response status code and response headers



3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
 
# File 'lib/budgea_client/api/banks_api.rb', line 3628

def users_id_user_alerts_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_alerts_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_alerts_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/alerts'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_categories_full_get(id_user, opts = {}) ⇒ InlineResponse20035

Get the category Ressource to get categories

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3674
3675
3676
3677
 
# File 'lib/budgea_client/api/banks_api.rb', line 3674

def users_id_user_categories_full_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_categories_full_get_with_http_info(id_user, opts)
  data
end

#users_id_user_categories_full_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20035, Fixnum, Hash)>

Get the category Ressource to get categories&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20035 data, response status code and response headers



3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
 
# File 'lib/budgea_client/api/banks_api.rb', line 3685

def users_id_user_categories_full_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_categories_full_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_categories_full_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/categories/full'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_categories_full_id_full_delete(id_user, id_full, opts = {}) ⇒ Category

Delete a user-created transaction category

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3732
3733
3734
3735
 
# File 'lib/budgea_client/api/banks_api.rb', line 3732

def users_id_user_categories_full_id_full_delete(id_user, id_full, opts = {})
  data, _status_code, _headers = users_id_user_categories_full_id_full_delete_with_http_info(id_user, id_full, opts)
  data
end

#users_id_user_categories_full_id_full_delete_with_http_info(id_user, id_full, opts = {}) ⇒ Array<(Category, Fixnum, Hash)>

Delete a user-created transaction category

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Category data, response status code and response headers



3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
 
# File 'lib/budgea_client/api/banks_api.rb', line 3744

def users_id_user_categories_full_id_full_delete_with_http_info(id_user, id_full, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_categories_full_id_full_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_categories_full_id_full_delete"
  end
  # verify the required parameter 'id_full' is set
  if @api_client.config.client_side_validation && id_full.nil?
    fail ArgumentError, "Missing the required parameter 'id_full' when calling BanksApi.users_id_user_categories_full_id_full_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/categories/full/{id_full}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_full' + '}', id_full.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_categories_full_id_full_put(id_user, id_full, opts = {}) ⇒ Category

Modify a user-created category

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :hide (String) —

    Hide (but not delete) a category. Must be 0, 1 or toggle.

  • :accountant_account (String) —

    Accountant account number.

  • :expand (String)

Returns:



3797
3798
3799
3800
 
# File 'lib/budgea_client/api/banks_api.rb', line 3797

def users_id_user_categories_full_id_full_put(id_user, id_full, opts = {})
  data, _status_code, _headers = users_id_user_categories_full_id_full_put_with_http_info(id_user, id_full, opts)
  data
end

#users_id_user_categories_full_id_full_put_with_http_info(id_user, id_full, opts = {}) ⇒ Array<(Category, Fixnum, Hash)>

Modify a user-created category

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :hide (String) —

    Hide (but not delete) a category. Must be 0, 1 or toggle.

  • :accountant_account (String) —

    Accountant account number.

  • :expand (String)

Returns:

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

    Category data, response status code and response headers



3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
 
# File 'lib/budgea_client/api/banks_api.rb', line 3811

def users_id_user_categories_full_id_full_put_with_http_info(id_user, id_full, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_categories_full_id_full_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_categories_full_id_full_put"
  end
  # verify the required parameter 'id_full' is set
  if @api_client.config.client_side_validation && id_full.nil?
    fail ArgumentError, "Missing the required parameter 'id_full' when calling BanksApi.users_id_user_categories_full_id_full_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/categories/full/{id_full}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_full' + '}', id_full.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['hide'] = opts[:'hide'] if !opts[:'hide'].nil?
  form_params['accountant_account'] = opts[:'accountant_account'] if !opts[:'accountant_account'].nil?

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

#users_id_user_categories_full_post(id_user, opts = {}) ⇒ Category

Create a new transaction category

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name of the category.

  • :id_parent_category (Integer) —

    ID of the parent category.

  • :id_parent_category_in_menu (Integer) —

    ID of the parent category to be displayed.

  • :color (String) —

    Color of the category.

  • :income (BOOLEAN) —

    Is an income category. If null, this is both an income and an expense category.

  • :refundable (BOOLEAN) —

    This category accepts opposite sign of transactions.

  • :accountant_account (String) —

    Accountant account number.

  • :expand (String)

Returns:



3870
3871
3872
3873
 
# File 'lib/budgea_client/api/banks_api.rb', line 3870

def users_id_user_categories_full_post(id_user, opts = {})
  data, _status_code, _headers = users_id_user_categories_full_post_with_http_info(id_user, opts)
  data
end

#users_id_user_categories_full_post_with_http_info(id_user, opts = {}) ⇒ Array<(Category, Fixnum, Hash)>

Create a new transaction category

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Name of the category.

  • :id_parent_category (Integer) —

    ID of the parent category.

  • :id_parent_category_in_menu (Integer) —

    ID of the parent category to be displayed.

  • :color (String) —

    Color of the category.

  • :income (BOOLEAN) —

    Is an income category. If null, this is both an income and an expense category.

  • :refundable (BOOLEAN) —

    This category accepts opposite sign of transactions.

  • :accountant_account (String) —

    Accountant account number.

  • :expand (String)

Returns:

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

    Category data, response status code and response headers



3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
 
# File 'lib/budgea_client/api/banks_api.rb', line 3888

def users_id_user_categories_full_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_categories_full_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_categories_full_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/categories/full'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['id_parent_category'] = opts[:'id_parent_category'] if !opts[:'id_parent_category'].nil?
  form_params['id_parent_category_in_menu'] = opts[:'id_parent_category_in_menu'] if !opts[:'id_parent_category_in_menu'].nil?
  form_params['color'] = opts[:'color'] if !opts[:'color'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['refundable'] = opts[:'refundable'] if !opts[:'refundable'].nil?
  form_params['accountant_account'] = opts[:'accountant_account'] if !opts[:'accountant_account'].nil?

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

#users_id_user_categories_get(id_user, opts = {}) ⇒ nil

Get the category Ressource to get categories for the user’s transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (nil) 


3940
3941
3942
3943
 
# File 'lib/budgea_client/api/banks_api.rb', line 3940

def users_id_user_categories_get(id_user, opts = {})
  users_id_user_categories_get_with_http_info(id_user, opts)
  nil
end

#users_id_user_categories_get_with_http_info(id_user, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get the category Ressource to get categories for the user&#39;s transactions&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
 
# File 'lib/budgea_client/api/banks_api.rb', line 3950

def users_id_user_categories_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_categories_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_categories_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/categories'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_delete(id_user, opts = {}) ⇒ Connection

Delete all connections

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3994
3995
3996
3997
 
# File 'lib/budgea_client/api/banks_api.rb', line 3994

def users_id_user_connections_delete(id_user, opts = {})
  data, _status_code, _headers = users_id_user_connections_delete_with_http_info(id_user, opts)
  data
end

#users_id_user_connections_delete_with_http_info(id_user, opts = {}) ⇒ Array<(Connection, Fixnum, Hash)>

Delete all connections

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Connection data, response status code and response headers



4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
 
# File 'lib/budgea_client/api/banks_api.rb', line 4005

def users_id_user_connections_delete_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_get(id_user, opts = {}) ⇒ InlineResponse2009

Get connections

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4051
4052
4053
4054
 
# File 'lib/budgea_client/api/banks_api.rb', line 4051

def users_id_user_connections_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_connections_get_with_http_info(id_user, opts)
  data
end

#users_id_user_connections_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

Get connections

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse2009 data, response status code and response headers



4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
 
# File 'lib/budgea_client/api/banks_api.rb', line 4062

def users_id_user_connections_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_delete(id_user, id_connection, opts = {}) ⇒ Account

Delete all accounts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4109
4110
4111
4112
 
# File 'lib/budgea_client/api/banks_api.rb', line 4109

def users_id_user_connections_id_connection_accounts_delete(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_accounts_delete_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_accounts_delete_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Delete all accounts

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
 
# File 'lib/budgea_client/api/banks_api.rb', line 4121

def users_id_user_connections_id_connection_accounts_delete_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20022

Get accounts list.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4172
4173
4174
4175
 
# File 'lib/budgea_client/api/banks_api.rb', line 4172

def users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_accounts_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_accounts_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse20022, Fixnum, Hash)>

Get accounts list.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20022 data, response status code and response headers



4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
 
# File 'lib/budgea_client/api/banks_api.rb', line 4184

def users_id_user_connections_id_connection_accounts_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_categories_get(id_user, id_connection, id_account, opts = {}) ⇒ nil

Get the category Ressource to get categories for the user’s transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (nil) 


4235
4236
4237
4238
 
# File 'lib/budgea_client/api/banks_api.rb', line 4235

def (id_user, id_connection, , opts = {})
  (id_user, id_connection, , opts)
  nil
end

#users_id_user_connections_id_connection_accounts_id_account_categories_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get the category Ressource to get categories for the user&#39;s transactions&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
 
# File 'lib/budgea_client/api/banks_api.rb', line 4247

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_categories_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_categories_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_categories_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_categories_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/categories'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_delete(id_user, id_connection, id_account, opts = {}) ⇒ Account

Delete an account. It deletes a specific account.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4301
4302
4303
4304
 
# File 'lib/budgea_client/api/banks_api.rb', line 4301

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_delete_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Delete an account. It deletes a specific account.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
 
# File 'lib/budgea_client/api/banks_api.rb', line 4314

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_delta_get(id_user, id_connection, id_account, opts = {}) ⇒ nil

Get deltas of accounts Get account delta between sums of transactions and difference of account balance for the given period.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :period (String) —

    period to group logs

Returns:

  • (nil) 


4372
4373
4374
4375
 
# File 'lib/budgea_client/api/banks_api.rb', line 4372

def (id_user, id_connection, , opts = {})
  (id_user, id_connection, , opts)
  nil
end

#users_id_user_connections_id_connection_accounts_id_account_delta_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get deltas of accounts Get account delta between sums of transactions and difference of account balance for the given period.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :period (String) —

    period to group logs

Returns:

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

    nil, response status code and response headers



4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
 
# File 'lib/budgea_client/api/banks_api.rb', line 4387

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_delta_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_delta_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_delta_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_delta_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/delta'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_logs_get(id_user, id_connection, id_account, opts = {}) ⇒ InlineResponse20026

Get accounts logs. Get logs of account.
By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :expand (String)

Returns:



4448
4449
4450
4451
 
# File 'lib/budgea_client/api/banks_api.rb', line 4448

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_logs_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(InlineResponse20026, Fixnum, Hash)>

Get accounts logs. Get logs of account.&lt;br&gt;&lt;br&gt;By default, it selects logs for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :expand (String)

Returns:

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

    InlineResponse20026 data, response status code and response headers



4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
 
# File 'lib/budgea_client/api/banks_api.rb', line 4465

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_logs_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_logs_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_logs_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_logs_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/logs'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_put(id_user, id_connection, id_account, opts = {}) ⇒ Account

Update an account It updates a specific account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :display (BOOLEAN) —

    If the account is displayed

  • :name (String) —

    Label of the account

  • :balance (Float) —

    Balance of the account

  • :disabled (BOOLEAN) —

    If the account is disabled (not synchronized)

  • :iban (String) —

    IBAN of the account

  • :bookmarked (BOOLEAN) —

    If the account is bookmarked

  • :usage (String) —

    Usage of the account : PRIV, ORGA or ASSO

  • :expand (String)

Returns:



4532
4533
4534
4535
 
# File 'lib/budgea_client/api/banks_api.rb', line 4532

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_put_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Update an account It updates a specific account&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :display (BOOLEAN) —

    If the account is displayed

  • :name (String) —

    Label of the account

  • :balance (Float) —

    Balance of the account

  • :disabled (BOOLEAN) —

    If the account is disabled (not synchronized)

  • :iban (String) —

    IBAN of the account

  • :bookmarked (BOOLEAN) —

    If the account is bookmarked

  • :usage (String) —

    Usage of the account : PRIV, ORGA or ASSO

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
 
# File 'lib/budgea_client/api/banks_api.rb', line 4552

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['display'] = opts[:'display'] if !opts[:'display'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['balance'] = opts[:'balance'] if !opts[:'balance'].nil?
  form_params['disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil?
  form_params['iban'] = opts[:'iban'] if !opts[:'iban'].nil?
  form_params['bookmarked'] = opts[:'bookmarked'] if !opts[:'bookmarked'].nil?
  form_params['usage'] = opts[:'usage'] if !opts[:'usage'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_delete(id_user, id_connection, id_account, opts = {}) ⇒ Transaction

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4615
4616
4617
4618
 
# File 'lib/budgea_client/api/banks_api.rb', line 4615

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_delete_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
 
# File 'lib/budgea_client/api/banks_api.rb', line 4628

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts = {}) ⇒ InlineResponse20030

Get transactions Get list of transactions.
By default, it selects transactions for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:



4697
4698
4699
4700
 
# File 'lib/budgea_client/api/banks_api.rb', line 4697

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(InlineResponse20030, Fixnum, Hash)>

Get transactions Get list of transactions.&lt;br&gt;&lt;br&gt;By default, it selects transactions for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:

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

    InlineResponse20030 data, response status code and response headers



4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
 
# File 'lib/budgea_client/api/banks_api.rb', line 4723

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'income'] = opts[:'income'] if !opts[:'income'].nil?
  query_params[:'deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
  query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?
  query_params[:'last_update'] = opts[:'last_update'] if !opts[:'last_update'].nil?
  query_params[:'wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  query_params[:'min_value'] = opts[:'min_value'] if !opts[:'min_value'].nil?
  query_params[:'max_value'] = opts[:'max_value'] if !opts[:'max_value'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ TransactionInformation

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4793
4794
4795
4796
 
# File 'lib/budgea_client/api/banks_api.rb', line 4793

def (id_user, id_connection, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
 
# File 'lib/budgea_client/api/banks_api.rb', line 4807

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ InlineResponse20032

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4868
4869
4870
4871
 
# File 'lib/budgea_client/api/banks_api.rb', line 4868

def (id_user, id_connection, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
 
# File 'lib/budgea_client/api/banks_api.rb', line 4882

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete(id_user, id_connection, id_account, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4944
4945
4946
4947
 
# File 'lib/budgea_client/api/banks_api.rb', line 4944

def (id_user, id_connection, , id_transaction, id_information, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, id_information, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
 
# File 'lib/budgea_client/api/banks_api.rb', line 4959

def (id_user, id_connection, , id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get(id_user, id_connection, id_account, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5025
5026
5027
5028
 
# File 'lib/budgea_client/api/banks_api.rb', line 5025

def (id_user, id_connection, , id_transaction, id_information, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, id_information, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_connection, id_account, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
 
# File 'lib/budgea_client/api/banks_api.rb', line 5040

def (id_user, id_connection, , id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ TransactionInformation

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5105
5106
5107
5108
 
# File 'lib/budgea_client/api/banks_api.rb', line 5105

def (id_user, id_connection, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
 
# File 'lib/budgea_client/api/banks_api.rb', line 5119

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Transaction

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:



5185
5186
5187
5188
 
# File 'lib/budgea_client/api/banks_api.rb', line 5185

def (id_user, id_connection, , id_transaction, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transaction
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
 
# File 'lib/budgea_client/api/banks_api.rb', line 5204

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  form_params['application_date'] = opts[:'application_date'] if !opts[:'application_date'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_post(id_user, id_connection, id_account, original_wording, value, date, opts = {}) ⇒ Transaction

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account2 (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:



5279
5280
5281
5282
 
# File 'lib/budgea_client/api/banks_api.rb', line 5279

def (id_user, id_connection, , original_wording, value, date, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , original_wording, value, date, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactions_post_with_http_info(id_user, id_connection, id_account, original_wording, value, date, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account2 (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
 
# File 'lib/budgea_client/api/banks_api.rb', line 5302

def (id_user, id_connection, , original_wording, value, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'original_wording' is set
  if @api_client.config.client_side_validation && original_wording.nil?
    fail ArgumentError, "Missing the required parameter 'original_wording' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactions_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['original_wording'] = original_wording
  form_params['value'] = value
  form_params['date'] = date
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['state'] = opts[:'state'] if !opts[:'state'].nil?
  form_params['rdate'] = opts[:'rdate'] if !opts[:'rdate'].nil?
  form_params['coming'] = opts[:'coming'] if !opts[:'coming'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?
  form_params['date_scraped'] = opts[:'date_scraped'] if !opts[:'date_scraped'].nil?
  form_params['id_account'] = opts[:'id_account2'] if !opts[:'id_account2'].nil?

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts = {}) ⇒ InlineResponse20033

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5380
5381
5382
5383
 
# File 'lib/budgea_client/api/banks_api.rb', line 5380

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(InlineResponse20033, Fixnum, Hash)>

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20033 data, response status code and response headers



5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
 
# File 'lib/budgea_client/api/banks_api.rb', line 5393

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete(id_user, id_connection, id_account, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactionscluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5450
5451
5452
5453
 
# File 'lib/budgea_client/api/banks_api.rb', line 5450

def (id_user, id_connection, , id_transactionscluster, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactionscluster, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_connection, id_account, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactionscluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
 
# File 'lib/budgea_client/api/banks_api.rb', line 5464

def (id_user, id_connection, , id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put(id_user, id_connection, id_account, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactionscluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5525
5526
5527
5528
 
# File 'lib/budgea_client/api/banks_api.rb', line 5525

def (id_user, id_connection, , id_transactionscluster, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactionscluster, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_connection, id_account, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_account
  • id_transactionscluster
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
 
# File 'lib/budgea_client/api/banks_api.rb', line 5539

def (id_user, id_connection, , id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post(id_user, id_connection, id_account, opts = {}) ⇒ TransactionsCluster

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5599
5600
5601
5602
 
# File 'lib/budgea_client/api/banks_api.rb', line 5599

def (id_user, id_connection, , opts = {})
  data, _status_code, _headers = (id_user, id_connection, , opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post_with_http_info(id_user, id_connection, id_account, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
 
# File 'lib/budgea_client/api/banks_api.rb', line 5612

def (id_user, id_connection, , opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post"
  end
  # verify the required parameter 'id_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'id_account' when calling BanksApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, balance, opts = {}) ⇒ Account

Create an account This endpoint creates an account related to a connection or not.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • name —

    name of account

  • balance —

    balance of account

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    number of account

  • :iban (String) —

    IBAN of account

  • :id_currency (String) —

    the currency of the account (default: &#39;EUR&#39;)

  • :id_connection2 (Integer) —

    the connection to attach to the account

  • :expand (String)

Returns:



5673
5674
5675
5676
 
# File 'lib/budgea_client/api/banks_api.rb', line 5673

def users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, balance, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_accounts_post_with_http_info(id_user, id_connection, name, balance, opts)
  data
end

#users_id_user_connections_id_connection_accounts_post_with_http_info(id_user, id_connection, name, balance, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Create an account This endpoint creates an account related to a connection or not.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • name —

    name of account

  • balance —

    balance of account

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

    the optional parameters

Options Hash (opts):

  • :number (String) —

    number of account

  • :iban (String) —

    IBAN of account

  • :id_currency (String) —

    the currency of the account (default: &#39;EUR&#39;)

  • :id_connection2 (Integer) —

    the connection to attach to the account

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
 
# File 'lib/budgea_client/api/banks_api.rb', line 5691

def users_id_user_connections_id_connection_accounts_post_with_http_info(id_user, id_connection, name, balance, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_post"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling BanksApi.users_id_user_connections_id_connection_accounts_post"
  end
  # verify the required parameter 'balance' is set
  if @api_client.config.client_side_validation && balance.nil?
    fail ArgumentError, "Missing the required parameter 'balance' when calling BanksApi.users_id_user_connections_id_connection_accounts_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['name'] = name
  form_params['balance'] = balance
  form_params['number'] = opts[:'number'] if !opts[:'number'].nil?
  form_params['iban'] = opts[:'iban'] if !opts[:'iban'].nil?
  form_params['id_currency'] = opts[:'id_currency'] if !opts[:'id_currency'].nil?
  form_params['id_connection'] = opts[:'id_connection2'] if !opts[:'id_connection2'].nil?

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

#users_id_user_connections_id_connection_accounts_put(id_user, id_connection, opts = {}) ⇒ Account

Update many accounts at once

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5756
5757
5758
5759
 
# File 'lib/budgea_client/api/banks_api.rb', line 5756

def users_id_user_connections_id_connection_accounts_put(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_accounts_put_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_accounts_put_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Account, Fixnum, Hash)>

Update many accounts at once

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Account data, response status code and response headers



5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
 
# File 'lib/budgea_client/api/banks_api.rb', line 5768

def users_id_user_connections_id_connection_accounts_put_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_accounts_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_accounts_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_accounts_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_delete(id_user, id_connection, opts = {}) ⇒ Connection

Delete a connection. This endpoint deletes a connection and all related accounts and transactions.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5819
5820
5821
5822
 
# File 'lib/budgea_client/api/banks_api.rb', line 5819

def users_id_user_connections_id_connection_delete(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_delete_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_delete_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Connection, Fixnum, Hash)>

Delete a connection. This endpoint deletes a connection and all related accounts and transactions.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Connection data, response status code and response headers



5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
 
# File 'lib/budgea_client/api/banks_api.rb', line 5831

def users_id_user_connections_id_connection_delete_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_get(id_user, id_connection, opts = {}) ⇒ Connection

Get connection Get connection by ID

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5882
5883
5884
5885
 
# File 'lib/budgea_client/api/banks_api.rb', line 5882

def users_id_user_connections_id_connection_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Connection, Fixnum, Hash)>

Get connection Get connection by ID

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Connection data, response status code and response headers



5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
 
# File 'lib/budgea_client/api/banks_api.rb', line 5894

def users_id_user_connections_id_connection_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts = {}) ⇒ InlineResponse2009

Get connection additionnal informations

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5945
5946
5947
5948
 
# File 'lib/budgea_client/api/banks_api.rb', line 5945

def users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_informations_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_informations_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>

Get connection additionnal informations &lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse2009 data, response status code and response headers



5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
 
# File 'lib/budgea_client/api/banks_api.rb', line 5957

def users_id_user_connections_id_connection_informations_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_informations_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_informations_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_informations_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20017

Get connection logs Get logs about connections.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :state (Integer) —

    state of user

  • :period (String) —

    period to group logs

  • :id_user2 (Integer) —

    ID of a user

  • :id_connection2 (Integer) —

    ID of a connection

  • :id_connector (Integer) —

    ID of a connector

  • :charged (BOOLEAN) —

    consider only logs for charged connectors

  • :expand (String)

Returns:



6018
6019
6020
6021
 
# File 'lib/budgea_client/api/banks_api.rb', line 6018

def users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_logs_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_logs_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse20017, Fixnum, Hash)>

Get connection logs Get logs about connections.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :state (Integer) —

    state of user

  • :period (String) —

    period to group logs

  • :id_user2 (Integer) —

    ID of a user

  • :id_connection2 (Integer) —

    ID of a connection

  • :id_connector (Integer) —

    ID of a connector

  • :charged (BOOLEAN) —

    consider only logs for charged connectors

  • :expand (String)

Returns:

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

    InlineResponse20017 data, response status code and response headers



6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
 
# File 'lib/budgea_client/api/banks_api.rb', line 6040

def users_id_user_connections_id_connection_logs_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_logs_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_logs_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_logs_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/logs'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'id_user'] = opts[:'id_user2'] if !opts[:'id_user2'].nil?
  query_params[:'id_connection'] = opts[:'id_connection2'] if !opts[:'id_connection2'].nil?
  query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil?
  query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_post(id_user, id_connection, opts = {}) ⇒ Connection

Update a connection. Give new parameters to change on the configuration of this connection (for example "password").
It tests connection to website, and if it fails, a 400 response is given with the error code "wrongpass" or "websiteUnavailable".
You can also supply meta-parameters on connection, like ‘active’ or ‘expire’.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :active (BOOLEAN) —

    Set if the connection synchronisation is active

  • :expire (DateTime) —

    Set expiration of the connection to this date

  • :login (String) —

    Set login to this new login

  • :password (String) —

    Set password to this new password

  • :decoupled (BOOLEAN) —

    Try to update a connection with the decoupled error

  • :expand (String)

Returns:



6106
6107
6108
6109
 
# File 'lib/budgea_client/api/banks_api.rb', line 6106

def users_id_user_connections_id_connection_post(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_post_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_post_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Connection, Fixnum, Hash)>

Update a connection. Give new parameters to change on the configuration of this connection (for example &quot;password&quot;).&lt;br&gt;&lt;br&gt;It tests connection to website, and if it fails, a 400 response is given with the error code &quot;wrongpass&quot; or &quot;websiteUnavailable&quot;.&lt;br&gt;&lt;br&gt;You can also supply meta-parameters on connection, like &#39;active&#39; or &#39;expire&#39;.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :active (BOOLEAN) —

    Set if the connection synchronisation is active

  • :expire (DateTime) —

    Set expiration of the connection to this date

  • :login (String) —

    Set login to this new login

  • :password (String) —

    Set password to this new password

  • :decoupled (BOOLEAN) —

    Try to update a connection with the decoupled error

  • :expand (String)

Returns:

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

    Connection data, response status code and response headers



6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
 
# File 'lib/budgea_client/api/banks_api.rb', line 6123

def users_id_user_connections_id_connection_post_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?
  form_params['expire'] = opts[:'expire'] if !opts[:'expire'].nil?
  form_params['login'] = opts[:'login'] if !opts[:'login'].nil?
  form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
  form_params['decoupled'] = opts[:'decoupled'] if !opts[:'decoupled'].nil?

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

#users_id_user_connections_id_connection_put(id_user, id_connection, opts = {}) ⇒ Connection

Force synchronisation of a connection. We suggest to pass parameter expand=accounts to get all new and updated transactions.
Query params: - expand (string): fields to expand - last_update (dateTime): if supplied, get transactions inserted since this date

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6179
6180
6181
6182
 
# File 'lib/budgea_client/api/banks_api.rb', line 6179

def users_id_user_connections_id_connection_put(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_put_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_put_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Connection, Fixnum, Hash)>

Force synchronisation of a connection. We suggest to pass parameter expand&#x3D;accounts to get all new and updated transactions.&lt;br&gt;&lt;br&gt;Query params: - expand (string): fields to expand - last_update (dateTime): if supplied, get transactions inserted since this date&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Connection data, response status code and response headers



6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
 
# File 'lib/budgea_client/api/banks_api.rb', line 6191

def users_id_user_connections_id_connection_put_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_delete(id_user, id_connection, opts = {}) ⇒ Transaction

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6242
6243
6244
6245
 
# File 'lib/budgea_client/api/banks_api.rb', line 6242

def users_id_user_connections_id_connection_transactions_delete(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_delete_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_transactions_delete_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
 
# File 'lib/budgea_client/api/banks_api.rb', line 6254

def users_id_user_connections_id_connection_transactions_delete_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20030

Get transactions Get list of transactions.
By default, it selects transactions for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:



6318
6319
6320
6321
 
# File 'lib/budgea_client/api/banks_api.rb', line 6318

def users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_transactions_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse20030, Fixnum, Hash)>

Get transactions Get list of transactions.&lt;br&gt;&lt;br&gt;By default, it selects transactions for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:

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

    InlineResponse20030 data, response status code and response headers



6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
 
# File 'lib/budgea_client/api/banks_api.rb', line 6343

def users_id_user_connections_id_connection_transactions_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'income'] = opts[:'income'] if !opts[:'income'].nil?
  query_params[:'deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
  query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?
  query_params[:'last_update'] = opts[:'last_update'] if !opts[:'last_update'].nil?
  query_params[:'wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  query_params[:'min_value'] = opts[:'min_value'] if !opts[:'min_value'].nil?
  query_params[:'max_value'] = opts[:'max_value'] if !opts[:'max_value'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_informations_delete(id_user, id_connection, id_transaction, opts = {}) ⇒ TransactionInformation

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6408
6409
6410
6411
 
# File 'lib/budgea_client/api/banks_api.rb', line 6408

def users_id_user_connections_id_connection_transactions_id_transaction_informations_delete(id_user, id_connection, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_informations_delete_with_http_info(id_user, id_connection, id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_informations_delete_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
 
# File 'lib/budgea_client/api/banks_api.rb', line 6421

def users_id_user_connections_id_connection_transactions_id_transaction_informations_delete_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts = {}) ⇒ InlineResponse20032

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6477
6478
6479
6480
 
# File 'lib/budgea_client/api/banks_api.rb', line 6477

def users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_informations_get_with_http_info(id_user, id_connection, id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_informations_get_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
 
# File 'lib/budgea_client/api/banks_api.rb', line 6490

def users_id_user_connections_id_connection_transactions_id_transaction_informations_get_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete(id_user, id_connection, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6547
6548
6549
6550
 
# File 'lib/budgea_client/api/banks_api.rb', line 6547

def users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete(id_user, id_connection, id_transaction, id_information, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_connection, id_transaction, id_information, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_connection, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
 
# File 'lib/budgea_client/api/banks_api.rb', line 6561

def users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_connection, id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get(id_user, id_connection, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6622
6623
6624
6625
 
# File 'lib/budgea_client/api/banks_api.rb', line 6622

def users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get(id_user, id_connection, id_transaction, id_information, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_connection, id_transaction, id_information, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_connection, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • id_transaction
  • id_information
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
 
# File 'lib/budgea_client/api/banks_api.rb', line 6636

def users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_connection, id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_informations_put(id_user, id_connection, id_transaction, opts = {}) ⇒ TransactionInformation

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6696
6697
6698
6699
 
# File 'lib/budgea_client/api/banks_api.rb', line 6696

def users_id_user_connections_id_connection_transactions_id_transaction_informations_put(id_user, id_connection, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_informations_put_with_http_info(id_user, id_connection, id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_informations_put_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
 
# File 'lib/budgea_client/api/banks_api.rb', line 6709

def users_id_user_connections_id_connection_transactions_id_transaction_informations_put_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_informations_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactions_id_transaction_put(id_user, id_connection, id_transaction, opts = {}) ⇒ Transaction

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:



6770
6771
6772
6773
 
# File 'lib/budgea_client/api/banks_api.rb', line 6770

def users_id_user_connections_id_connection_transactions_id_transaction_put(id_user, id_connection, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_put_with_http_info(id_user, id_connection, id_transaction, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_put_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
 
# File 'lib/budgea_client/api/banks_api.rb', line 6788

def users_id_user_connections_id_connection_transactions_id_transaction_put_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_connections_id_connection_transactions_id_transaction_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  form_params['application_date'] = opts[:'application_date'] if !opts[:'application_date'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?

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

#users_id_user_connections_id_connection_transactions_post(id_user, id_connection, original_wording, value, date, opts = {}) ⇒ Transaction

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:



6858
6859
6860
6861
 
# File 'lib/budgea_client/api/banks_api.rb', line 6858

def users_id_user_connections_id_connection_transactions_post(id_user, id_connection, original_wording, value, date, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_post_with_http_info(id_user, id_connection, original_wording, value, date, opts)
  data
end

#users_id_user_connections_id_connection_transactions_post_with_http_info(id_user, id_connection, original_wording, value, date, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • id_connection
  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
 
# File 'lib/budgea_client/api/banks_api.rb', line 6880

def users_id_user_connections_id_connection_transactions_post_with_http_info(id_user, id_connection, original_wording, value, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactions_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactions_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactions_post"
  end
  # verify the required parameter 'original_wording' is set
  if @api_client.config.client_side_validation && original_wording.nil?
    fail ArgumentError, "Missing the required parameter 'original_wording' when calling BanksApi.users_id_user_connections_id_connection_transactions_post"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling BanksApi.users_id_user_connections_id_connection_transactions_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling BanksApi.users_id_user_connections_id_connection_transactions_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['original_wording'] = original_wording
  form_params['value'] = value
  form_params['date'] = date
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['state'] = opts[:'state'] if !opts[:'state'].nil?
  form_params['rdate'] = opts[:'rdate'] if !opts[:'rdate'].nil?
  form_params['coming'] = opts[:'coming'] if !opts[:'coming'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?
  form_params['date_scraped'] = opts[:'date_scraped'] if !opts[:'date_scraped'].nil?
  form_params['id_account'] = opts[:'id_account'] if !opts[:'id_account'].nil?

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

#users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20033

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6953
6954
6955
6956
 
# File 'lib/budgea_client/api/banks_api.rb', line 6953

def users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_get_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse20033, Fixnum, Hash)>

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20033 data, response status code and response headers



6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
 
# File 'lib/budgea_client/api/banks_api.rb', line 6965

def users_id_user_connections_id_connection_transactionsclusters_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactionsclusters_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_get"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete(id_user, id_connection, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7017
7018
7019
7020
 
# File 'lib/budgea_client/api/banks_api.rb', line 7017

def users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete(id_user, id_connection, id_transactionscluster, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_connection, id_transactionscluster, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_connection, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
 
# File 'lib/budgea_client/api/banks_api.rb', line 7030

def users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_connection, id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put(id_user, id_connection, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7086
7087
7088
7089
 
# File 'lib/budgea_client/api/banks_api.rb', line 7086

def users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put(id_user, id_connection, id_transactionscluster, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_connection, id_transactionscluster, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_connection, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
 
# File 'lib/budgea_client/api/banks_api.rb', line 7099

def users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_connection, id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_id_connection_transactionsclusters_post(id_user, id_connection, opts = {}) ⇒ TransactionsCluster

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7154
7155
7156
7157
 
# File 'lib/budgea_client/api/banks_api.rb', line 7154

def users_id_user_connections_id_connection_transactionsclusters_post(id_user, id_connection, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_post_with_http_info(id_user, id_connection, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_post_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
 
# File 'lib/budgea_client/api/banks_api.rb', line 7166

def users_id_user_connections_id_connection_transactionsclusters_post_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_id_connection_transactionsclusters_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_post"
  end
  # verify the required parameter 'id_connection' is set
  if @api_client.config.client_side_validation && id_connection.nil?
    fail ArgumentError, "Missing the required parameter 'id_connection' when calling BanksApi.users_id_user_connections_id_connection_transactionsclusters_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_connections_post(id_user, opts = {}) ⇒ Connection

Add a new connection. Create a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_connector (Integer) —

    ID of the connector

  • :connector_uuid (String) —

    optional uuid of the connector (replaces id_connector)

  • :birthday (String) —

    bank additional login parameter

  • :password (String) —

    bank additional login parameter

  • :oauth_token (String) —

    bank additional login parameter

  • :oauth_token_secret (String) —

    bank additional login parameter

  • :auth_type (String) —

    bank additional login parameter

  • :secret (String) —

    bank additional login parameter

  • :type (String) —

    bank additional login parameter

  • :birthdate (String) —

    bank additional login parameter

  • :nuser (String) —

    bank additional login parameter

  • :website (String) —

    bank additional login parameter

  • :login (String) —

    bank additional login parameter

  • :id_provider (Integer) —

    ID of the provider

  • :expand (String)

Returns:



7230
7231
7232
7233
 
# File 'lib/budgea_client/api/banks_api.rb', line 7230

def users_id_user_connections_post(id_user, opts = {})
  data, _status_code, _headers = users_id_user_connections_post_with_http_info(id_user, opts)
  data
end

#users_id_user_connections_post_with_http_info(id_user, opts = {}) ⇒ Array<(Connection, Fixnum, Hash)>

Add a new connection. Create a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_connector (Integer) —

    ID of the connector

  • :connector_uuid (String) —

    optional uuid of the connector (replaces id_connector)

  • :birthday (String) —

    bank additional login parameter

  • :password (String) —

    bank additional login parameter

  • :oauth_token (String) —

    bank additional login parameter

  • :oauth_token_secret (String) —

    bank additional login parameter

  • :auth_type (String) —

    bank additional login parameter

  • :secret (String) —

    bank additional login parameter

  • :type (String) —

    bank additional login parameter

  • :birthdate (String) —

    bank additional login parameter

  • :nuser (String) —

    bank additional login parameter

  • :website (String) —

    bank additional login parameter

  • :login (String) —

    bank additional login parameter

  • :id_provider (Integer) —

    ID of the provider

  • :expand (String)

Returns:

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

    Connection data, response status code and response headers



7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
 
# File 'lib/budgea_client/api/banks_api.rb', line 7255

def users_id_user_connections_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_connections_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_connections_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil?
  form_params['connector_uuid'] = opts[:'connector_uuid'] if !opts[:'connector_uuid'].nil?
  form_params['birthday'] = opts[:'birthday'] if !opts[:'birthday'].nil?
  form_params['password'] = opts[:'password'] if !opts[:'password'].nil?
  form_params['oauth_token'] = opts[:'oauth_token'] if !opts[:'oauth_token'].nil?
  form_params['oauth_token_secret'] = opts[:'oauth_token_secret'] if !opts[:'oauth_token_secret'].nil?
  form_params['auth_type'] = opts[:'auth_type'] if !opts[:'auth_type'].nil?
  form_params['secret'] = opts[:'secret'] if !opts[:'secret'].nil?
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['birthdate'] = opts[:'birthdate'] if !opts[:'birthdate'].nil?
  form_params['nuser'] = opts[:'nuser'] if !opts[:'nuser'].nil?
  form_params['website'] = opts[:'website'] if !opts[:'website'].nil?
  form_params['login'] = opts[:'login'] if !opts[:'login'].nil?
  form_params['id_provider'] = opts[:'id_provider'] if !opts[:'id_provider'].nil?

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

#users_id_user_forecast_get(id_user, opts = {}) ⇒ nil

Get forecast

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

  • (nil) 


7314
7315
7316
7317
 
# File 'lib/budgea_client/api/banks_api.rb', line 7314

def users_id_user_forecast_get(id_user, opts = {})
  users_id_user_forecast_get_with_http_info(id_user, opts)
  nil
end

#users_id_user_forecast_get_with_http_info(id_user, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get forecast

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
 
# File 'lib/budgea_client/api/banks_api.rb', line 7324

def users_id_user_forecast_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_forecast_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_forecast_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/forecast'.sub('{' + 'id_user' + '}', id_user.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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_logs_get(id_user, opts = {}) ⇒ InlineResponse20017

Get connection logs Get logs about connections.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :state (Integer) —

    state of user

  • :period (String) —

    period to group logs

  • :id_user2 (Integer) —

    ID of a user

  • :id_connection (Integer) —

    ID of a connection

  • :id_connector (Integer) —

    ID of a connector

  • :charged (BOOLEAN) —

    consider only logs for charged connectors

  • :expand (String)

Returns:



7378
7379
7380
7381
 
# File 'lib/budgea_client/api/banks_api.rb', line 7378

def users_id_user_logs_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_logs_get_with_http_info(id_user, opts)
  data
end

#users_id_user_logs_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20017, Fixnum, Hash)>

Get connection logs Get logs about connections.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal date

  • :max_date (Date) —

    maximum date

  • :state (Integer) —

    state of user

  • :period (String) —

    period to group logs

  • :id_user2 (Integer) —

    ID of a user

  • :id_connection (Integer) —

    ID of a connection

  • :id_connector (Integer) —

    ID of a connector

  • :charged (BOOLEAN) —

    consider only logs for charged connectors

  • :expand (String)

Returns:

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

    InlineResponse20017 data, response status code and response headers



7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
 
# File 'lib/budgea_client/api/banks_api.rb', line 7399

def users_id_user_logs_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_logs_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_logs_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/logs'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'id_user'] = opts[:'id_user2'] if !opts[:'id_user2'].nil?
  query_params[:'id_connection'] = opts[:'id_connection'] if !opts[:'id_connection'].nil?
  query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil?
  query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_delete(id_user, opts = {}) ⇒ Transaction

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7455
7456
7457
7458
 
# File 'lib/budgea_client/api/banks_api.rb', line 7455

def users_id_user_transactions_delete(id_user, opts = {})
  data, _status_code, _headers = users_id_user_transactions_delete_with_http_info(id_user, opts)
  data
end

#users_id_user_transactions_delete_with_http_info(id_user, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Delete transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
 
# File 'lib/budgea_client/api/banks_api.rb', line 7466

def users_id_user_transactions_delete_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_get(id_user, opts = {}) ⇒ InlineResponse20030

Get transactions Get list of transactions.
By default, it selects transactions for the last month. You can use "min_date" and "max_date" to change boundary dates.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:



7525
7526
7527
7528
 
# File 'lib/budgea_client/api/banks_api.rb', line 7525

def users_id_user_transactions_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_transactions_get_with_http_info(id_user, opts)
  data
end

#users_id_user_transactions_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20030, Fixnum, Hash)>

Get transactions Get list of transactions.&lt;br&gt;&lt;br&gt;By default, it selects transactions for the last month. You can use &quot;min_date&quot; and &quot;max_date&quot; to change boundary dates.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :income (BOOLEAN) —

    filter on income or expenditures

  • :deleted (BOOLEAN) —

    display only deleted transactions

  • :all (BOOLEAN) —

    display all transactions, including deleted ones

  • :last_update (DateTime) —

    get only transactions updated after the specified datetime

  • :wording (String) —

    filter transactions containing the given string

  • :min_value (Float) —

    minimal (inclusive) value

  • :max_value (Float) —

    maximum (inclusive) value

  • :search (String) —

    search in labels, dates, values and categories

  • :value (String) —

    &quot;XX|-XX&quot; or &quot;±XX&quot;

  • :expand (String)

Returns:

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

    InlineResponse20030 data, response status code and response headers



7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
 
# File 'lib/budgea_client/api/banks_api.rb', line 7549

def users_id_user_transactions_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil?
  query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil?
  query_params[:'income'] = opts[:'income'] if !opts[:'income'].nil?
  query_params[:'deleted'] = opts[:'deleted'] if !opts[:'deleted'].nil?
  query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?
  query_params[:'last_update'] = opts[:'last_update'] if !opts[:'last_update'].nil?
  query_params[:'wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  query_params[:'min_value'] = opts[:'min_value'] if !opts[:'min_value'].nil?
  query_params[:'max_value'] = opts[:'max_value'] if !opts[:'max_value'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_informations_delete(id_user, id_transaction, opts = {}) ⇒ TransactionInformation

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7609
7610
7611
7612
 
# File 'lib/budgea_client/api/banks_api.rb', line 7609

def users_id_user_transactions_id_transaction_informations_delete(id_user, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_informations_delete_with_http_info(id_user, id_transaction, opts)
  data
end

#users_id_user_transactions_id_transaction_informations_delete_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete all arbitrary key-value pairs of a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
 
# File 'lib/budgea_client/api/banks_api.rb', line 7621

def users_id_user_transactions_id_transaction_informations_delete_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_id_transaction_informations_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_id_transaction_informations_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_transactions_id_transaction_informations_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts = {}) ⇒ InlineResponse20032

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7672
7673
7674
7675
 
# File 'lib/budgea_client/api/banks_api.rb', line 7672

def users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_informations_get_with_http_info(id_user, id_transaction, opts)
  data
end

#users_id_user_transactions_id_transaction_informations_get_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(InlineResponse20032, Fixnum, Hash)>

List all arbitrary key-value pairs on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20032 data, response status code and response headers



7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
 
# File 'lib/budgea_client/api/banks_api.rb', line 7684

def users_id_user_transactions_id_transaction_informations_get_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_id_transaction_informations_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_id_transaction_informations_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_transactions_id_transaction_informations_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_informations_id_information_delete(id_user, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7736
7737
7738
7739
 
# File 'lib/budgea_client/api/banks_api.rb', line 7736

def users_id_user_transactions_id_transaction_informations_id_information_delete(id_user, id_transaction, id_information, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_transaction, id_information, opts)
  data
end

#users_id_user_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Delete a particular key-value pair on a transaction.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
 
# File 'lib/budgea_client/api/banks_api.rb', line 7749

def users_id_user_transactions_id_transaction_informations_id_information_delete_with_http_info(id_user, id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_id_transaction_informations_id_information_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_transactions_id_transaction_informations_id_information_delete"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_transactions_id_transaction_informations_id_information_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_informations_id_information_get(id_user, id_transaction, id_information, opts = {}) ⇒ TransactionInformation

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7805
7806
7807
7808
 
# File 'lib/budgea_client/api/banks_api.rb', line 7805

def users_id_user_transactions_id_transaction_informations_id_information_get(id_user, id_transaction, id_information, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_transaction, id_information, opts)
  data
end

#users_id_user_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_transaction, id_information, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Get a particular arbitrary key-value pair on a transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
 
# File 'lib/budgea_client/api/banks_api.rb', line 7818

def users_id_user_transactions_id_transaction_informations_id_information_get_with_http_info(id_user, id_transaction, id_information, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_id_transaction_informations_id_information_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_transactions_id_transaction_informations_id_information_get"
  end
  # verify the required parameter 'id_information' is set
  if @api_client.config.client_side_validation && id_information.nil?
    fail ArgumentError, "Missing the required parameter 'id_information' when calling BanksApi.users_id_user_transactions_id_transaction_informations_id_information_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/informations/{id_information}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_information' + '}', id_information.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_informations_put(id_user, id_transaction, opts = {}) ⇒ TransactionInformation

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7873
7874
7875
7876
 
# File 'lib/budgea_client/api/banks_api.rb', line 7873

def users_id_user_transactions_id_transaction_informations_put(id_user, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_informations_put_with_http_info(id_user, id_transaction, opts)
  data
end

#users_id_user_transactions_id_transaction_informations_put_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(TransactionInformation, Fixnum, Hash)>

Add or edit transaction arbitrary key-value pairs

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionInformation data, response status code and response headers



7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
 
# File 'lib/budgea_client/api/banks_api.rb', line 7885

def users_id_user_transactions_id_transaction_informations_put_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_id_transaction_informations_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_id_transaction_informations_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_transactions_id_transaction_informations_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactions_id_transaction_put(id_user, id_transaction, opts = {}) ⇒ Transaction

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:



7941
7942
7943
7944
 
# File 'lib/budgea_client/api/banks_api.rb', line 7941

def users_id_user_transactions_id_transaction_put(id_user, id_transaction, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_put_with_http_info(id_user, id_transaction, opts)
  data
end

#users_id_user_transactions_id_transaction_put_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Edit a transaction meta-data

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :wording (String) —

    user rewording of the transaction

  • :application_date (Date) —

    change application date of the transaction

  • :id_category (Integer) —

    ID of the associated category

  • :comment (String) —

    change comment

  • :active (BOOLEAN) —

    if false, transaction isn&#39;t considered in analyzisis endpoints (like /balances)

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
 
# File 'lib/budgea_client/api/banks_api.rb', line 7958

def users_id_user_transactions_id_transaction_put_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_id_transaction_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_id_transaction_put"
  end
  # verify the required parameter 'id_transaction' is set
  if @api_client.config.client_side_validation && id_transaction.nil?
    fail ArgumentError, "Missing the required parameter 'id_transaction' when calling BanksApi.users_id_user_transactions_id_transaction_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['wording'] = opts[:'wording'] if !opts[:'wording'].nil?
  form_params['application_date'] = opts[:'application_date'] if !opts[:'application_date'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?

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

#users_id_user_transactions_post(id_user, original_wording, value, date, opts = {}) ⇒ Transaction

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:



8023
8024
8025
8026
 
# File 'lib/budgea_client/api/banks_api.rb', line 8023

def users_id_user_transactions_post(id_user, original_wording, value, date, opts = {})
  data, _status_code, _headers = users_id_user_transactions_post_with_http_info(id_user, original_wording, value, date, opts)
  data
end

#users_id_user_transactions_post_with_http_info(id_user, original_wording, value, date, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>

Create transactions Create transactions for the supplied account or the account whose id is given with form parameters. It requires an array of transaction dictionaries.&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

  • original_wording —

    label of the transaction

  • value —

    vallue of the transaction

  • date —

    date of the transaction

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    type of the transaction (default: unknown)

  • :state (String) —

    nature of the transaction (default: new)

  • :rdate (Date) —

    realisation date of the transaction (default: value of date)

  • :coming (BOOLEAN) —

    1 if the transaction has already been debited (default: 0)

  • :active (BOOLEAN) —

    1 if the transaction should be taken into account by pfm services (default: 1)

  • :date_scraped (DateTime) —

    date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)

  • :id_account (Integer) —

    account of the transaction. If not supplied, it has to be given in the route

  • :expand (String)

Returns:

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

    Transaction data, response status code and response headers



8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
 
# File 'lib/budgea_client/api/banks_api.rb', line 8044

def users_id_user_transactions_post_with_http_info(id_user, original_wording, value, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactions_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactions_post"
  end
  # verify the required parameter 'original_wording' is set
  if @api_client.config.client_side_validation && original_wording.nil?
    fail ArgumentError, "Missing the required parameter 'original_wording' when calling BanksApi.users_id_user_transactions_post"
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling BanksApi.users_id_user_transactions_post"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling BanksApi.users_id_user_transactions_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['original_wording'] = original_wording
  form_params['value'] = value
  form_params['date'] = date
  form_params['type'] = opts[:'type'] if !opts[:'type'].nil?
  form_params['state'] = opts[:'state'] if !opts[:'state'].nil?
  form_params['rdate'] = opts[:'rdate'] if !opts[:'rdate'].nil?
  form_params['coming'] = opts[:'coming'] if !opts[:'coming'].nil?
  form_params['active'] = opts[:'active'] if !opts[:'active'].nil?
  form_params['date_scraped'] = opts[:'date_scraped'] if !opts[:'date_scraped'].nil?
  form_params['id_account'] = opts[:'id_account'] if !opts[:'id_account'].nil?

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

#users_id_user_transactionsclusters_get(id_user, opts = {}) ⇒ InlineResponse20033

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8112
8113
8114
8115
 
# File 'lib/budgea_client/api/banks_api.rb', line 8112

def users_id_user_transactionsclusters_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_get_with_http_info(id_user, opts)
  data
end

#users_id_user_transactionsclusters_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20033, Fixnum, Hash)>

Get clustered transactions

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20033 data, response status code and response headers



8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
 
# File 'lib/budgea_client/api/banks_api.rb', line 8123

def users_id_user_transactionsclusters_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactionsclusters_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactionsclusters_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactionsclusters_id_transactionscluster_delete(id_user, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8170
8171
8172
8173
 
# File 'lib/budgea_client/api/banks_api.rb', line 8170

def users_id_user_transactionsclusters_id_transactionscluster_delete(id_user, id_transactionscluster, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_transactionscluster, opts)
  data
end

#users_id_user_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Delete a clustered transaction

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
 
# File 'lib/budgea_client/api/banks_api.rb', line 8182

def users_id_user_transactionsclusters_id_transactionscluster_delete_with_http_info(id_user, id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactionsclusters_id_transactionscluster_delete ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactionsclusters_id_transactionscluster_delete"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_transactionsclusters_id_transactionscluster_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactionsclusters_id_transactionscluster_put(id_user, id_transactionscluster, opts = {}) ⇒ TransactionsCluster

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8233
8234
8235
8236
 
# File 'lib/budgea_client/api/banks_api.rb', line 8233

def users_id_user_transactionsclusters_id_transactionscluster_put(id_user, id_transactionscluster, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_transactionscluster, opts)
  data
end

#users_id_user_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_transactionscluster, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Edit a clustered transaction Form params : - next_date (date): Date of transaction - mean_amount (decimal): Mean Amount - wording (string): name of transaction - id_account (id): related account - id_category (id): related category - enabled (bool): is enabled&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
 
# File 'lib/budgea_client/api/banks_api.rb', line 8245

def users_id_user_transactionsclusters_id_transactionscluster_put_with_http_info(id_user, id_transactionscluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactionsclusters_id_transactionscluster_put ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactionsclusters_id_transactionscluster_put"
  end
  # verify the required parameter 'id_transactionscluster' is set
  if @api_client.config.client_side_validation && id_transactionscluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactionscluster' when calling BanksApi.users_id_user_transactionsclusters_id_transactionscluster_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactionscluster}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactionscluster' + '}', id_transactionscluster.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_transactionsclusters_post(id_user, opts = {}) ⇒ TransactionsCluster

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8295
8296
8297
8298
 
# File 'lib/budgea_client/api/banks_api.rb', line 8295

def users_id_user_transactionsclusters_post(id_user, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_post_with_http_info(id_user, opts)
  data
end

#users_id_user_transactionsclusters_post_with_http_info(id_user, opts = {}) ⇒ Array<(TransactionsCluster, Fixnum, Hash)>

Create clustered transaction Form params : - next_date (date) required: Date of transaction - mean_amount (decimal) required: Mean Amount - wording (string) required: name of transaction - id_account (id) required: related account&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    TransactionsCluster data, response status code and response headers



8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
 
# File 'lib/budgea_client/api/banks_api.rb', line 8306

def users_id_user_transactionsclusters_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BanksApi.users_id_user_transactionsclusters_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling BanksApi.users_id_user_transactionsclusters_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # 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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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