Class: BudgeaClient::ProvidersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProvidersApi

Returns a new instance of ProvidersApi.



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

def api_client
  @api_client
end

Instance Method Details

#banks_get(opts = {}) ⇒ InlineResponse2008

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



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

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



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/providers_api.rb', line 37

def banks_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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: ProvidersApi#banks_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:



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

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



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/providers_api.rb', line 90

def banks_id_connector_logos_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



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

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



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/providers_api.rb', line 147

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: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



193
194
195
196
 
# File 'lib/budgea_client/api/providers_api.rb', line 193

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/budgea_client/api/providers_api.rb', line 204

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: ProvidersApi.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 ProvidersApi.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: ProvidersApi#banks_id_connector_logos_thumbnail_get\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:



249
250
251
252
 
# File 'lib/budgea_client/api/providers_api.rb', line 249

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/budgea_client/api/providers_api.rb', line 259

def connections_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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: ProvidersApi#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:



300
301
302
303
 
# File 'lib/budgea_client/api/providers_api.rb', line 300

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/budgea_client/api/providers_api.rb', line 310

def connectors_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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: ProvidersApi#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:



352
353
354
355
 
# File 'lib/budgea_client/api/providers_api.rb', line 352

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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/budgea_client/api/providers_api.rb', line 363

def connectors_id_connector_logos_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



410
411
412
413
 
# File 'lib/budgea_client/api/providers_api.rb', line 410

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



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/budgea_client/api/providers_api.rb', line 422

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



473
474
475
476
 
# File 'lib/budgea_client/api/providers_api.rb', line 473

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



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 485

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



535
536
537
538
 
# File 'lib/budgea_client/api/providers_api.rb', line 535

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



546
547
548
549
550
551
552
553
554
555
556
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 546

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: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



592
593
594
595
 
# File 'lib/budgea_client/api/providers_api.rb', line 592

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



603
604
605
606
607
608
609
610
611
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 603

def connectors_id_connector_logos_post_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



649
650
651
652
 
# File 'lib/budgea_client/api/providers_api.rb', line 649

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



660
661
662
663
664
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 660

def connectors_id_connector_logos_put_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



706
707
708
709
 
# File 'lib/budgea_client/api/providers_api.rb', line 706

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



717
718
719
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
756
 
# File 'lib/budgea_client/api/providers_api.rb', line 717

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: ProvidersApi.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 ProvidersApi.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: ProvidersApi#connectors_id_connector_logos_thumbnail_get\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:



770
771
772
773
 
# File 'lib/budgea_client/api/providers_api.rb', line 770

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



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
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/budgea_client/api/providers_api.rb', line 788

def connectors_post_with_http_info(name, , password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#connectors_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#documenttypes_get(opts = {}) ⇒ InlineResponse20015

Get document types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



849
850
851
852
 
# File 'lib/budgea_client/api/providers_api.rb', line 849

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

#documenttypes_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20015, Fixnum, Hash)>

Get document types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20015 data, response status code and response headers



859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/budgea_client/api/providers_api.rb', line 859

def documenttypes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.documenttypes_get ...'
  end
  # resource path
  local_var_path = '/documenttypes'

  # 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 => 'InlineResponse20015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#documenttypes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#documenttypes_id_documenttype_put(id_documenttype, name, attacheable, opts = {}) ⇒ DocumentType

Edit a document type Change value of a document type.

Parameters:

  • id_documenttype
  • name —

    Displayed name of document type

  • attacheable —

    If true, documents of this type can be attached to a transaction, and have amount related meta-data

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



903
904
905
906
 
# File 'lib/budgea_client/api/providers_api.rb', line 903

def documenttypes_id_documenttype_put(id_documenttype, name, attacheable, opts = {})
  data, _status_code, _headers = documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts)
  data
end

#documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts = {}) ⇒ Array<(DocumentType, Fixnum, Hash)>

Edit a document type Change value of a document type.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_documenttype
  • name —

    Displayed name of document type

  • attacheable —

    If true, documents of this type can be attached to a transaction, and have amount related meta-data

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    DocumentType data, response status code and response headers



916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
 
# File 'lib/budgea_client/api/providers_api.rb', line 916

def documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.documenttypes_id_documenttype_put ...'
  end
  # verify the required parameter 'id_documenttype' is set
  if @api_client.config.client_side_validation && id_documenttype.nil?
    fail ArgumentError, "Missing the required parameter 'id_documenttype' when calling ProvidersApi.documenttypes_id_documenttype_put"
  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 ProvidersApi.documenttypes_id_documenttype_put"
  end
  # verify the required parameter 'attacheable' is set
  if @api_client.config.client_side_validation && attacheable.nil?
    fail ArgumentError, "Missing the required parameter 'attacheable' when calling ProvidersApi.documenttypes_id_documenttype_put"
  end
  # resource path
  local_var_path = '/documenttypes/{id_documenttype}'.sub('{' + 'id_documenttype' + '}', id_documenttype.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['attacheable'] = attacheable

  # 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 => 'DocumentType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#documenttypes_id_documenttype_put\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:



981
982
983
984
 
# File 'lib/budgea_client/api/providers_api.rb', line 981

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



1001
1002
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/providers_api.rb', line 1001

def logs_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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: ProvidersApi#logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ocr_post(file, opts = {}) ⇒ nil

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.

Parameters:

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

  • (nil) 


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

def ocr_post(file, opts = {})
  ocr_post_with_http_info(file, opts)
  nil
end

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

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.&lt;br&gt;&lt;br&gt;

Parameters:

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

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

    nil, 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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1066

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

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file
  form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#ocr_post\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:



1112
1113
1114
1115
 
# File 'lib/budgea_client/api/providers_api.rb', line 1112

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



1122
1123
1124
1125
1126
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1122

def providers_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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: ProvidersApi#providers_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:



1164
1165
1166
1167
 
# File 'lib/budgea_client/api/providers_api.rb', line 1164

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



1175
1176
1177
1178
1179
1180
1181
1182
1183
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1175

def providers_id_connector_logos_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



1221
1222
1223
1224
 
# File 'lib/budgea_client/api/providers_api.rb', line 1221

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



1232
1233
1234
1235
1236
1237
1238
1239
1240
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1232

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: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



1278
1279
1280
1281
 
# File 'lib/budgea_client/api/providers_api.rb', line 1278

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



1289
1290
1291
1292
1293
1294
1295
1296
1297
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1289

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: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_account, id_transaction, opts = {}) ⇒ Document

Delete documents

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:



1337
1338
1339
1340
 
# File 'lib/budgea_client/api/providers_api.rb', line 1337

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_documents_delete_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

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<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1350

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_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_documents_get(id_user, id_account, id_transaction, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



1415
1416
1417
1418
 
# File 'lib/budgea_client/api/providers_api.rb', line 1415

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_documents_get_with_http_info(id_user, id_account, id_transaction, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



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
1491
1492
1493
 
# File 'lib/budgea_client/api/providers_api.rb', line 1437

def (id_user, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.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[:'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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_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_documents_id_document_delete(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1503
1504
1505
1506
 
# File 'lib/budgea_client/api/providers_api.rb', line 1503

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
 
# File 'lib/budgea_client/api/providers_api.rb', line 1517

def (id_user, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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_documents_id_document_put(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



1589
1590
1591
1592
 
# File 'lib/budgea_client/api/providers_api.rb', line 1589

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1614

def (id_user, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_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_documents_post(id_user, id_account, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



1697
1698
1699
1700
 
# File 'lib/budgea_client/api/providers_api.rb', line 1697

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_account, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1722

def (id_user, , id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_post\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_documents_put(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1799
1800
1801
1802
 
# File 'lib/budgea_client/api/providers_api.rb', line 1799

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

#users_id_user_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



1813
1814
1815
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
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/budgea_client/api/providers_api.rb', line 1813

def (id_user, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.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['id_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1874
1875
1876
1877
 
# File 'lib/budgea_client/api/providers_api.rb', line 1874

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
 
# File 'lib/budgea_client/api/providers_api.rb', line 1887

def (id_user, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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_transactions_cluster_documents_get(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

Parameters:

  • id_user —

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

  • id_account
  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



1952
1953
1954
1955
 
# File 'lib/budgea_client/api/providers_api.rb', line 1952

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_account
  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1974

def (id_user, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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_transactions_cluster_documents_id_document_delete(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2040
2041
2042
2043
 
# File 'lib/budgea_client/api/providers_api.rb', line 2040

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
 
# File 'lib/budgea_client/api/providers_api.rb', line 2054

def (id_user, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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_transactions_cluster_documents_id_document_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2126
2127
2128
2129
 
# File 'lib/budgea_client/api/providers_api.rb', line 2126

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
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
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/budgea_client/api/providers_api.rb', line 2151

def (id_user, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2234
2235
2236
2237
 
# File 'lib/budgea_client/api/providers_api.rb', line 2234

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 2259

def (id_user, , id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2336
2337
2338
2339
 
# File 'lib/budgea_client/api/providers_api.rb', line 2336

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

#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 2350

def (id_user, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put\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:



2409
2410
2411
2412
 
# File 'lib/budgea_client/api/providers_api.rb', line 2409

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



2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
 
# File 'lib/budgea_client/api/providers_api.rb', line 2420

def users_id_user_connections_delete_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



2466
2467
2468
2469
 
# File 'lib/budgea_client/api/providers_api.rb', line 2466

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



2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
 
# File 'lib/budgea_client/api/providers_api.rb', line 2477

def users_id_user_connections_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#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_id_account_transactions_id_transaction_documents_delete(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Document

Delete documents

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:



2526
2527
2528
2529
 
# File 'lib/budgea_client/api/providers_api.rb', line 2526

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_documents_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

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<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
 
# File 'lib/budgea_client/api/providers_api.rb', line 2540

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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_documents_get(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



2610
2611
2612
2613
 
# File 'lib/budgea_client/api/providers_api.rb', line 2610

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_documents_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&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_transaction
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



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
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
 
# File 'lib/budgea_client/api/providers_api.rb', line 2633

def (id_user, id_connection, , id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.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[:'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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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_documents_id_document_delete(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



2704
2705
2706
2707
 
# File 'lib/budgea_client/api/providers_api.rb', line 2704

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'lib/budgea_client/api/providers_api.rb', line 2719

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.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_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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_documents_id_document_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2796
2797
2798
2799
 
# File 'lib/budgea_client/api/providers_api.rb', line 2796

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document 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
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
 
# File 'lib/budgea_client/api/providers_api.rb', line 2822

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.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_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_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_documents_post(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



2910
2911
2912
2913
 
# File 'lib/budgea_client/api/providers_api.rb', line 2910

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&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_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 2936

def (id_user, id_connection, , id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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_transactions_id_transaction_documents_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3018
3019
3020
3021
 
# File 'lib/budgea_client/api/providers_api.rb', line 3018

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

#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 3033

def (id_user, id_connection, , id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.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['id_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_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_id_transactions_cluster_documents_delete(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3099
3100
3101
3102
 
# File 'lib/budgea_client/api/providers_api.rb', line 3099

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
 
# File 'lib/budgea_client/api/providers_api.rb', line 3113

def (id_user, id_connection, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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_transactions_cluster_documents_get(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



3183
3184
3185
3186
 
# File 'lib/budgea_client/api/providers_api.rb', line 3183

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&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_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 3206

def (id_user, id_connection, , id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3277
3278
3279
3280
 
# File 'lib/budgea_client/api/providers_api.rb', line 3277

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
3339
3340
3341
3342
3343
3344
3345
3346
3347
 
# File 'lib/budgea_client/api/providers_api.rb', line 3292

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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_transactions_cluster_documents_id_document_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



3369
3370
3371
3372
 
# File 'lib/budgea_client/api/providers_api.rb', line 3369

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 3395

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_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_id_transactions_cluster_documents_post(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



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

def (id_user, id_connection, , id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = (id_user, id_connection, , id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&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_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
 
# File 'lib/budgea_client/api/providers_api.rb', line 3509

def (id_user, id_connection, , id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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_id_transactions_cluster_documents_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3591
3592
3593
3594
 
# File 'lib/budgea_client/api/providers_api.rb', line 3591

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

#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_account
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 3606

def (id_user, id_connection, , id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', .to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_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:



3670
3671
3672
3673
 
# File 'lib/budgea_client/api/providers_api.rb', line 3670

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



3682
3683
3684
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
3725
 
# File 'lib/budgea_client/api/providers_api.rb', line 3682

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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_documents_delete(id_user, id_connection, opts = {}) ⇒ Document

Delete documents

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:



3733
3734
3735
3736
 
# File 'lib/budgea_client/api/providers_api.rb', line 3733

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

#users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

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<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



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
3788
 
# File 'lib/budgea_client/api/providers_api.rb', line 3745

def users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_documents_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



3805
3806
3807
3808
 
# File 'lib/budgea_client/api/providers_api.rb', line 3805

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

#users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



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
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
 
# File 'lib/budgea_client/api/providers_api.rb', line 3826

def users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_documents_id_document_delete(id_user, id_connection, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



3887
3888
3889
3890
 
# File 'lib/budgea_client/api/providers_api.rb', line 3887

def users_id_user_connections_id_connection_documents_id_document_delete(id_user, id_connection, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts)
  data
end

#users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
 
# File 'lib/budgea_client/api/providers_api.rb', line 3900

def users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_documents_id_document_put(id_user, id_connection, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



3967
3968
3969
3970
 
# File 'lib/budgea_client/api/providers_api.rb', line 3967

def users_id_user_connections_id_connection_documents_id_document_put(id_user, id_connection, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts)
  data
end

#users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
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
4045
4046
4047
4048
4049
 
# File 'lib/budgea_client/api/providers_api.rb', line 3991

def users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_documents_post(id_user, id_connection, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_connection
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



4069
4070
4071
4072
 
# File 'lib/budgea_client/api/providers_api.rb', line 4069

def users_id_user_connections_id_connection_documents_post(id_user, id_connection, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_connection
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4093

def users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_documents_put(id_user, id_connection, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4165
4166
4167
4168
 
# File 'lib/budgea_client/api/providers_api.rb', line 4165

def users_id_user_connections_id_connection_documents_put(id_user, id_connection, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts)
  data
end

#users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4178
4179
4180
4181
4182
4183
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4178

def users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_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 ProvidersApi.users_id_user_connections_id_connection_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.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['id_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_put\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:



4234
4235
4236
4237
 
# File 'lib/budgea_client/api/providers_api.rb', line 4234

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



4246
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4246

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



4297
4298
4299
4300
 
# File 'lib/budgea_client/api/providers_api.rb', line 4297

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



4309
4310
4311
4312
4313
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4309

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



4370
4371
4372
4373
 
# File 'lib/budgea_client/api/providers_api.rb', line 4370

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



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
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
 
# File 'lib/budgea_client/api/providers_api.rb', line 4392

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



4458
4459
4460
4461
 
# File 'lib/budgea_client/api/providers_api.rb', line 4458

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



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
4517
4518
4519
4520
4521
4522
4523
 
# File 'lib/budgea_client/api/providers_api.rb', line 4475

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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:



4531
4532
4533
4534
 
# File 'lib/budgea_client/api/providers_api.rb', line 4531

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



4543
4544
4545
4546
4547
4548
4549
4550
4551
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4543

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: ProvidersApi.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 ProvidersApi.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 ProvidersApi.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: ProvidersApi#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_subscriptions_id_subscription_delete(id_user, id_connection, id_subscription, opts = {}) ⇒ Subscription

Delete a subscription. It deletes a specific subscription.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4595
4596
4597
4598
 
# File 'lib/budgea_client/api/providers_api.rb', line 4595

def users_id_user_connections_id_connection_subscriptions_id_subscription_delete(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_delete_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_delete_with_http_info(id_user, id_connection, id_subscription, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Delete a subscription. It deletes a specific subscription.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Subscription data, response status code and response headers



4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4608

def users_id_user_connections_id_connection_subscriptions_id_subscription_delete_with_http_info(id_user, id_connection, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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 => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete(id_user, id_connection, id_subscription, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4664
4665
4666
4667
 
# File 'lib/budgea_client/api/providers_api.rb', line 4664

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
 
# File 'lib/budgea_client/api/providers_api.rb', line 4677

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get(id_user, id_connection, id_subscription, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



4742
4743
4744
4745
 
# File 'lib/budgea_client/api/providers_api.rb', line 4742

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
 
# File 'lib/budgea_client/api/providers_api.rb', line 4764

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



4830
4831
4832
4833
 
# File 'lib/budgea_client/api/providers_api.rb', line 4830

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete(id_user, id_connection, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
 
# File 'lib/budgea_client/api/providers_api.rb', line 4844

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



4916
4917
4918
4919
 
# File 'lib/budgea_client/api/providers_api.rb', line 4916

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put(id_user, id_connection, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 4941

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post(id_user, id_connection, id_subscription, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5024
5025
5026
5027
 
# File 'lib/budgea_client/api/providers_api.rb', line 5024

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post(id_user, id_connection, id_subscription, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
 
# File 'lib/budgea_client/api/providers_api.rb', line 5049

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5126
5127
5128
5129
 
# File 'lib/budgea_client/api/providers_api.rb', line 5126

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put(id_user, id_connection, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
 
# File 'lib/budgea_client/api/providers_api.rb', line 5140

def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_put(id_user, id_connection, id_subscription, opts = {}) ⇒ Subscription

Update a subscription It updates a specific subscription

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Label of the subscription

  • :disabled (BOOLEAN) —

    If the subscription is disabled (not synchronized)

  • :expand (String)

Returns:



5203
5204
5205
5206
 
# File 'lib/budgea_client/api/providers_api.rb', line 5203

def users_id_user_connections_id_connection_subscriptions_id_subscription_put(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_put_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

#users_id_user_connections_id_connection_subscriptions_id_subscription_put_with_http_info(id_user, id_connection, id_subscription, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Update a subscription It updates a specific subscription&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Label of the subscription

  • :disabled (BOOLEAN) —

    If the subscription is disabled (not synchronized)

  • :expand (String)

Returns:

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

    Subscription data, response status code and response headers



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
5261
5262
5263
5264
5265
5266
5267
 
# File 'lib/budgea_client/api/providers_api.rb', line 5218

def users_id_user_connections_id_connection_subscriptions_id_subscription_put_with_http_info(id_user, id_connection, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_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 ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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['disabled'] = opts[:'disabled'] if !opts[:'disabled'].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 => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_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_documents_delete(id_user, id_connection, id_transaction, opts = {}) ⇒ Document

Delete documents

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:



5276
5277
5278
5279
 
# File 'lib/budgea_client/api/providers_api.rb', line 5276

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

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<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5289

def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_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_documents_get(id_user, id_connection, id_transaction, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



5354
5355
5356
5357
 
# File 'lib/budgea_client/api/providers_api.rb', line 5354

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

#users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5376

def users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.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[:'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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_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_documents_id_document_delete(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5442
5443
5444
5445
 
# File 'lib/budgea_client/api/providers_api.rb', line 5442

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5456
5457
5458
5459
5460
5461
5462
5463
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5456

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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_documents_id_document_put(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5528
5529
5530
5531
 
# File 'lib/budgea_client/api/providers_api.rb', line 5528

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
 
# File 'lib/budgea_client/api/providers_api.rb', line 5553

def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_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_documents_post(id_user, id_connection, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_connection
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



5636
5637
5638
5639
 
# File 'lib/budgea_client/api/providers_api.rb', line 5636

def users_id_user_connections_id_connection_transactions_id_transaction_documents_post(id_user, id_connection, id_transaction, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_connection
  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5661

def users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_post\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_documents_put(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5738
5739
5740
5741
 
# File 'lib/budgea_client/api/providers_api.rb', line 5738

def users_id_user_connections_id_connection_transactions_id_transaction_documents_put(id_user, id_connection, id_transaction, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5752

def users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.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['id_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5813
5814
5815
5816
 
# File 'lib/budgea_client/api/providers_api.rb', line 5813

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_transactions_cluster, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5826
5827
5828
5829
5830
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5826

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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_transactions_cluster_documents_get(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



5891
5892
5893
5894
 
# File 'lib/budgea_client/api/providers_api.rb', line 5891

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_transactions_cluster, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



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
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
 
# File 'lib/budgea_client/api/providers_api.rb', line 5913

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5979
5980
5981
5982
 
# File 'lib/budgea_client/api/providers_api.rb', line 5979

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
 
# File 'lib/budgea_client/api/providers_api.rb', line 5993

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_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_transactions_cluster_documents_id_document_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



6065
6066
6067
6068
 
# File 'lib/budgea_client/api/providers_api.rb', line 6065

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • id_document
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 6090

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



6173
6174
6175
6176
 
# File 'lib/budgea_client/api/providers_api.rb', line 6173

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
 
# File 'lib/budgea_client/api/providers_api.rb', line 6198

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6275
6276
6277
6278
 
# File 'lib/budgea_client/api/providers_api.rb', line 6275

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_connection
  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
 
# File 'lib/budgea_client/api/providers_api.rb', line 6289

def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put\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:



6362
6363
6364
6365
 
# File 'lib/budgea_client/api/providers_api.rb', line 6362

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



6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
 
# File 'lib/budgea_client/api/providers_api.rb', line 6387

def users_id_user_connections_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#users_id_user_connections_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_documents_delete(id_user, opts = {}) ⇒ Document

Delete documents

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:



6447
6448
6449
6450
 
# File 'lib/budgea_client/api/providers_api.rb', line 6447

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

#users_id_user_documents_delete_with_http_info(id_user, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

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<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
 
# File 'lib/budgea_client/api/providers_api.rb', line 6458

def users_id_user_documents_delete_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_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 ProvidersApi.users_id_user_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_documents_get(id_user, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



6513
6514
6515
6516
 
# File 'lib/budgea_client/api/providers_api.rb', line 6513

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

#users_id_user_documents_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
 
# File 'lib/budgea_client/api/providers_api.rb', line 6533

def users_id_user_documents_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_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 ProvidersApi.users_id_user_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_documents_id_document_delete(id_user, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6589
6590
6591
6592
 
# File 'lib/budgea_client/api/providers_api.rb', line 6589

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

#users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
 
# File 'lib/budgea_client/api/providers_api.rb', line 6601

def users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_id_document_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 ProvidersApi.users_id_user_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_documents_id_document_put(id_user, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



6663
6664
6665
6666
 
# File 'lib/budgea_client/api/providers_api.rb', line 6663

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

#users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 6686

def users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_id_document_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 ProvidersApi.users_id_user_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_documents_post(id_user, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



6759
6760
6761
6762
 
# File 'lib/budgea_client/api/providers_api.rb', line 6759

def users_id_user_documents_post(id_user, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_documents_post_with_http_info(id_user, date, duedate, opts)
  data
end

#users_id_user_documents_post_with_http_info(id_user, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6782
6783
6784
6785
6786
6787
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
6841
 
# File 'lib/budgea_client/api/providers_api.rb', line 6782

def users_id_user_documents_post_with_http_info(id_user, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_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 ProvidersApi.users_id_user_documents_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 ProvidersApi.users_id_user_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_documents_put(id_user, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6849
6850
6851
6852
 
# File 'lib/budgea_client/api/providers_api.rb', line 6849

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

#users_id_user_documents_put_with_http_info(id_user, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 6861

def users_id_user_documents_put_with_http_info(id_user, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_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 ProvidersApi.users_id_user_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/documents'.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_put\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:



6922
6923
6924
6925
 
# File 'lib/budgea_client/api/providers_api.rb', line 6922

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



6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 6943

def users_id_user_logs_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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 ProvidersApi.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: ProvidersApi#users_id_user_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_ocr_post(id_user, file, opts = {}) ⇒ nil

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.

Parameters:

  • id_user —

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

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

  • (nil) 


7001
7002
7003
7004
 
# File 'lib/budgea_client/api/providers_api.rb', line 7001

def users_id_user_ocr_post(id_user, file, opts = {})
  users_id_user_ocr_post_with_http_info(id_user, file, opts)
  nil
end

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

Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • file —

    File of the document

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

    the optional parameters

Options Hash (opts):

  • :id_transaction (Integer) —

    Transaction used to help OCR to find data

  • :name (String) —

    Name of the document

Returns:

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

    nil, response status code and response headers



7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 7014

def users_id_user_ocr_post_with_http_info(id_user, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_ocr_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 ProvidersApi.users_id_user_ocr_post"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling ProvidersApi.users_id_user_ocr_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/ocr'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['file'] = file
  form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_ocr_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_delete(id_user, id_subscription, opts = {}) ⇒ Subscription

Delete a subscription. It deletes a specific subscription.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7066
7067
7068
7069
 
# File 'lib/budgea_client/api/providers_api.rb', line 7066

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

#users_id_user_subscriptions_id_subscription_delete_with_http_info(id_user, id_subscription, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Delete a subscription. It deletes a specific subscription.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Subscription data, response status code and response headers



7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
 
# File 'lib/budgea_client/api/providers_api.rb', line 7078

def users_id_user_subscriptions_id_subscription_delete_with_http_info(id_user, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_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 ProvidersApi.users_id_user_subscriptions_id_subscription_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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 => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_documents_delete(id_user, id_subscription, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7129
7130
7131
7132
 
# File 'lib/budgea_client/api/providers_api.rb', line 7129

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

#users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
 
# File 'lib/budgea_client/api/providers_api.rb', line 7141

def users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_documents_get(id_user, id_subscription, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

Parameters:

  • id_user —

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

  • id_subscription
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



7201
7202
7203
7204
 
# File 'lib/budgea_client/api/providers_api.rb', line 7201

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

#users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_subscription
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
 
# File 'lib/budgea_client/api/providers_api.rb', line 7222

def users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_get"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_documents_id_document_delete(id_user, id_subscription, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7283
7284
7285
7286
 
# File 'lib/budgea_client/api/providers_api.rb', line 7283

def users_id_user_subscriptions_id_subscription_documents_id_document_delete(id_user, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
 
# File 'lib/budgea_client/api/providers_api.rb', line 7296

def users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_documents_id_document_put(id_user, id_subscription, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



7363
7364
7365
7366
 
# File 'lib/budgea_client/api/providers_api.rb', line 7363

def users_id_user_subscriptions_id_subscription_documents_id_document_put(id_user, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 7387

def users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_documents_post(id_user, id_subscription, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



7465
7466
7467
7468
 
# File 'lib/budgea_client/api/providers_api.rb', line 7465

def users_id_user_subscriptions_id_subscription_documents_post(id_user, id_subscription, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_subscription
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
 
# File 'lib/budgea_client/api/providers_api.rb', line 7489

def users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_documents_put(id_user, id_subscription, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7561
7562
7563
7564
 
# File 'lib/budgea_client/api/providers_api.rb', line 7561

def users_id_user_subscriptions_id_subscription_documents_put(id_user, id_subscription, id_document, opts = {})
  data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts)
  data
end

#users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_subscription
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
 
# File 'lib/budgea_client/api/providers_api.rb', line 7574

def users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_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 ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_subscriptions_id_subscription_put(id_user, id_subscription, opts = {}) ⇒ Subscription

Update a subscription It updates a specific subscription

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Label of the subscription

  • :disabled (BOOLEAN) —

    If the subscription is disabled (not synchronized)

  • :expand (String)

Returns:



7632
7633
7634
7635
 
# File 'lib/budgea_client/api/providers_api.rb', line 7632

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

#users_id_user_subscriptions_id_subscription_put_with_http_info(id_user, id_subscription, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Update a subscription It updates a specific subscription&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Label of the subscription

  • :disabled (BOOLEAN) —

    If the subscription is disabled (not synchronized)

  • :expand (String)

Returns:

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

    Subscription data, response status code and response headers



7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
 
# File 'lib/budgea_client/api/providers_api.rb', line 7646

def users_id_user_subscriptions_id_subscription_put_with_http_info(id_user, id_subscription, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_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 ProvidersApi.users_id_user_subscriptions_id_subscription_put"
  end
  # verify the required parameter 'id_subscription' is set
  if @api_client.config.client_side_validation && id_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.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['disabled'] = opts[:'disabled'] if !opts[:'disabled'].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 => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactions_id_transaction_documents_delete(id_user, id_transaction, opts = {}) ⇒ Document

Delete documents

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:



7699
7700
7701
7702
 
# File 'lib/budgea_client/api/providers_api.rb', line 7699

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

#users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

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<(Document, Fixnum, Hash)>) —

    Document data, response status code and response headers



7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
 
# File 'lib/budgea_client/api/providers_api.rb', line 7711

def users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactions_id_transaction_documents_get(id_user, id_transaction, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



7771
7772
7773
7774
 
# File 'lib/budgea_client/api/providers_api.rb', line 7771

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

#users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

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):

  • :limit (Integer) —

    limit number of results

  • :offset (Integer) —

    offset of first result

  • :min_date (Date) —

    minimal (inclusive) date

  • :max_date (Date) —

    maximum (inclusive) date

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 7792

def users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactions_id_transaction_documents_id_document_delete(id_user, id_transaction, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



7853
7854
7855
7856
 
# File 'lib/budgea_client/api/providers_api.rb', line 7853

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

#users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 7866

def users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactions_id_transaction_documents_id_document_put(id_user, id_transaction, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



7933
7934
7935
7936
 
# File 'lib/budgea_client/api/providers_api.rb', line 7933

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

#users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



7957
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
8007
8008
8009
8010
8011
8012
8013
8014
8015
 
# File 'lib/budgea_client/api/providers_api.rb', line 7957

def users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactions_id_transaction_documents_post(id_user, id_transaction, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



8035
8036
8037
8038
 
# File 'lib/budgea_client/api/providers_api.rb', line 8035

def users_id_user_transactions_id_transaction_documents_post(id_user, id_transaction, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts)
  data
end

#users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_transaction
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



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
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
 
# File 'lib/budgea_client/api/providers_api.rb', line 8059

def users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_post"
  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 ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactions_id_transaction_documents_put(id_user, id_transaction, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8131
8132
8133
8134
 
# File 'lib/budgea_client/api/providers_api.rb', line 8131

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

#users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_transaction
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
 
# File 'lib/budgea_client/api/providers_api.rb', line 8144

def users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_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 ProvidersApi.users_id_user_transactions_id_transaction_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.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['id_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_transactions_cluster, opts = {}) ⇒ Document

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8200
8201
8202
8203
 
# File 'lib/budgea_client/api/providers_api.rb', line 8200

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete documents

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
 
# File 'lib/budgea_client/api/providers_api.rb', line 8212

def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_transactions_cluster, opts = {}) ⇒ InlineResponse20031

Get documents Get list of documents

Parameters:

  • id_user —

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

  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:



8272
8273
8274
8275
 
# File 'lib/budgea_client/api/providers_api.rb', line 8272

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

#users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts = {}) ⇒ Array<(InlineResponse20031, Fixnum, Hash)>

Get documents Get list of documents&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_transactions_cluster
  • 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

  • :min_amount (Float) —

    minimal (inclusive) amount

  • :max_amount (Float) —

    maximum (inclusive) amount

  • :min_timestamp (Float) —

    minimal (inclusive) timestamp

  • :max_timestamp (Float) —

    maximum (inclusive) timestamp

  • :id_type (Integer) —

    filter with a document type

  • :expand (String)

Returns:

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

    InlineResponse20031 data, response status code and response headers



8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
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/providers_api.rb', line 8293

def users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil?
  query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil?
  query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil?
  query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil?
  query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].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 => 'InlineResponse20031')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8354
8355
8356
8357
 
# File 'lib/budgea_client/api/providers_api.rb', line 8354

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Delete a document

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
 
# File 'lib/budgea_client/api/providers_api.rb', line 8367

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



8434
8435
8436
8437
 
# File 'lib/budgea_client/api/providers_api.rb', line 8434

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Edit a document Edit meta-data of a specific document.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :date (Date) —

    Date of document

  • :duedate (Date) —

    Due date of document

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (Integer) —

    Is an income or an outcome

  • :readonly (Integer) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
 
# File 'lib/budgea_client/api/providers_api.rb', line 8458

def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['date'] = opts[:'date'] if !opts[:'date'].nil?
  form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_transactions_cluster, date, duedate, opts = {}) ⇒ Document

Add a new document Add a new document

Parameters:

  • id_user —

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

  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:



8536
8537
8538
8539
 
# File 'lib/budgea_client/api/providers_api.rb', line 8536

def users_id_user_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_transactions_cluster, date, duedate, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Add a new document Add a new document&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

  • id_transactions_cluster
  • date —

    Date of document

  • duedate —

    Due date of document

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

    the optional parameters

Options Hash (opts):

  • :id_type (Integer) —

    Type of this document

  • :id_category (Integer) —

    Related category

  • :total_amount (Float) —

    Taxed amount

  • :untaxed_amount (Float) —

    Untaxed amount

  • :vat (Float) —

    VAT amount

  • :income (BOOLEAN) —

    Is an income or an outcome

  • :readonly (BOOLEAN) —

    Is this file readonly

  • :file (File) —

    File of the document

  • :id_ocr (Integer) —

    Related OCR process

  • :name (String) —

    Name of the document

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
 
# File 'lib/budgea_client/api/providers_api.rb', line 8560

def users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # verify the required parameter 'duedate' is set
  if @api_client.config.client_side_validation && duedate.nil?
    fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['date'] = date
  form_params['duedate'] = duedate
  form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil?
  form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil?
  form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil?
  form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil?
  form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil?
  form_params['income'] = opts[:'income'] if !opts[:'income'].nil?
  form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil?
  form_params['name'] = opts[:'name'] if !opts[:'name'].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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Document

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8632
8633
8634
8635
 
# File 'lib/budgea_client/api/providers_api.rb', line 8632

def users_id_user_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_transactions_cluster, id_document, opts = {})
  data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts)
  data
end

#users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) ⇒ Array<(Document, Fixnum, Hash)>

Attach an existing document to a transaction or a transactions_cluster

Parameters:

  • id_user —

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

  • id_transactions_cluster
  • id_document —

    id of the document you want to attach the file to

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Document data, response status code and response headers



8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
 
# File 'lib/budgea_client/api/providers_api.rb', line 8645

def users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_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 ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_transactions_cluster' is set
  if @api_client.config.client_side_validation && id_transactions_cluster.nil?
    fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # verify the required parameter 'id_document' is set
  if @api_client.config.client_side_validation && id_document.nil?
    fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.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_document'] = id_document

  # 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 => 'Document')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end