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

#banks_id_connector_sources_get(id_connector, opts = {}) ⇒ InlineResponse20011

Get list of connector sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



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

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

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

Get list of connector sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20011 data, response status code and response headers



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
295
296
297
298
299
300
 
# File 'lib/budgea_client/api/providers_api.rb', line 261

def banks_id_connector_sources_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.banks_id_connector_sources_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_sources_get"
  end
  # resource path
  local_var_path = '/banks/{id_connector}/sources'.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 => 'InlineResponse20011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#banks_id_connector_sources_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:



306
307
308
309
 
# File 'lib/budgea_client/api/providers_api.rb', line 306

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



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
346
347
348
349
350
351
 
# File 'lib/budgea_client/api/providers_api.rb', line 316

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

#connections_id_connection_logs_get(id_connection, opts = {}) ⇒ InlineResponse20015

Get connection logs Get logs about connections.

Parameters:

  • 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_user (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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:



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

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

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

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

Parameters:

  • 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_user (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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:

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

    InlineResponse20015 data, response status code and response headers



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/budgea_client/api/providers_api.rb', line 391

def connections_id_connection_logs_get_with_http_info(id_connection, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.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.connections_id_connection_logs_get"
  end
  # resource path
  local_var_path = '/connections/{id_connection}/logs'.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_user'] if !opts[:'id_user'].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[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].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 => 'InlineResponse20015')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#connections_id_connection_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#connections_id_connection_sources_get(id_connection, opts = {}) ⇒ InlineResponse20016

Get connection sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



448
449
450
451
 
# File 'lib/budgea_client/api/providers_api.rb', line 448

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

#connections_id_connection_sources_get_with_http_info(id_connection, opts = {}) ⇒ Array<(InlineResponse20016, Fixnum, Hash)>

Get connection sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20016 data, response status code and response headers



459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/budgea_client/api/providers_api.rb', line 459

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

#connections_id_connection_sources_id_source_delete(id_connection, id_source, opts = {}) ⇒ ConnectionSource

Disable a connection source This will make it so the specified source will not be synchronized anymore.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



506
507
508
509
 
# File 'lib/budgea_client/api/providers_api.rb', line 506

def connections_id_connection_sources_id_source_delete(id_connection, id_source, opts = {})
  data, _status_code, _headers = connections_id_connection_sources_id_source_delete_with_http_info(id_connection, id_source, opts)
  data
end

#connections_id_connection_sources_id_source_delete_with_http_info(id_connection, id_source, opts = {}) ⇒ Array<(ConnectionSource, Fixnum, Hash)>

Disable a connection source This will make it so the specified source will not be synchronized anymore.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectionSource data, response status code and response headers



518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/budgea_client/api/providers_api.rb', line 518

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

#connections_id_connection_sources_id_source_post(id_connection, id_source, opts = {}) ⇒ ConnectionSource

Enable connection source This will make it so the specified source will be able to be synchronized.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



569
570
571
572
 
# File 'lib/budgea_client/api/providers_api.rb', line 569

def connections_id_connection_sources_id_source_post(id_connection, id_source, opts = {})
  data, _status_code, _headers = connections_id_connection_sources_id_source_post_with_http_info(id_connection, id_source, opts)
  data
end

#connections_id_connection_sources_id_source_post_with_http_info(id_connection, id_source, opts = {}) ⇒ Array<(ConnectionSource, Fixnum, Hash)>

Enable connection source This will make it so the specified source will be able to be synchronized.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectionSource data, response status code and response headers



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/budgea_client/api/providers_api.rb', line 581

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

#connections_id_connection_sources_id_source_put(id_connection, id_source, opts = {}) ⇒ ConnectionSource

Enable connection source This will make it so the specified source will be able to be synchronized.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



632
633
634
635
 
# File 'lib/budgea_client/api/providers_api.rb', line 632

def connections_id_connection_sources_id_source_put(id_connection, id_source, opts = {})
  data, _status_code, _headers = connections_id_connection_sources_id_source_put_with_http_info(id_connection, id_source, opts)
  data
end

#connections_id_connection_sources_id_source_put_with_http_info(id_connection, id_source, opts = {}) ⇒ Array<(ConnectionSource, Fixnum, Hash)>

Enable connection source This will make it so the specified source will be able to be synchronized.&lt;br&gt;&lt;br&gt;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectionSource data, response status code and response headers



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 644

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

#connectors_get(opts = {}) ⇒ InlineResponse20017

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



693
694
695
696
 
# File 'lib/budgea_client/api/providers_api.rb', line 693

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

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

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20017 data, response status code and response headers



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/budgea_client/api/providers_api.rb', line 703

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 => 'InlineResponse20017')
  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:



745
746
747
748
 
# File 'lib/budgea_client/api/providers_api.rb', line 745

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



756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/budgea_client/api/providers_api.rb', line 756

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:



803
804
805
806
 
# File 'lib/budgea_client/api/providers_api.rb', line 803

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



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
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
 
# File 'lib/budgea_client/api/providers_api.rb', line 815

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:



866
867
868
869
 
# File 'lib/budgea_client/api/providers_api.rb', line 866

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



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/budgea_client/api/providers_api.rb', line 878

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:



928
929
930
931
 
# File 'lib/budgea_client/api/providers_api.rb', line 928

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



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
966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/budgea_client/api/providers_api.rb', line 939

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:



985
986
987
988
 
# File 'lib/budgea_client/api/providers_api.rb', line 985

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



996
997
998
999
1000
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 996

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:



1042
1043
1044
1045
 
# File 'lib/budgea_client/api/providers_api.rb', line 1042

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



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1053

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:



1099
1100
1101
1102
 
# File 'lib/budgea_client/api/providers_api.rb', line 1099

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



1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1110

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_id_connector_sources_get(id_connector, opts = {}) ⇒ InlineResponse20011

Get list of connector sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1156
1157
1158
1159
 
# File 'lib/budgea_client/api/providers_api.rb', line 1156

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

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

Get list of connector sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20011 data, response status code and response headers



1167
1168
1169
1170
1171
1172
1173
1174
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 1167

def connectors_id_connector_sources_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_sources_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_sources_get"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/sources'.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 => 'InlineResponse20011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#connectors_id_connector_sources_id_source_put(id_connector, id_source, opts = {}) ⇒ ConnectorSource

Edit the provided connector source

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :auth_mechanism (String) —

    the authentication mechanism to use for this connector source

  • :disabled (DateTime) —

    to enable or disable connector source

  • :expand (String)

Returns:



1216
1217
1218
1219
 
# File 'lib/budgea_client/api/providers_api.rb', line 1216

def connectors_id_connector_sources_id_source_put(id_connector, id_source, opts = {})
  data, _status_code, _headers = connectors_id_connector_sources_id_source_put_with_http_info(id_connector, id_source, opts)
  data
end

#connectors_id_connector_sources_id_source_put_with_http_info(id_connector, id_source, opts = {}) ⇒ Array<(ConnectorSource, Fixnum, Hash)>

Edit the provided connector source

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :auth_mechanism (String) —

    the authentication mechanism to use for this connector source

  • :disabled (DateTime) —

    to enable or disable connector source

  • :expand (String)

Returns:

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

    ConnectorSource data, response status code and response headers



1230
1231
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
1272
1273
1274
1275
 
# File 'lib/budgea_client/api/providers_api.rb', line 1230

def connectors_id_connector_sources_id_source_put_with_http_info(id_connector, id_source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_sources_id_source_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_sources_id_source_put"
  end
  # verify the required parameter 'id_source' is set
  if @api_client.config.client_side_validation && id_source.nil?
    fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.connectors_id_connector_sources_id_source_put"
  end
  # resource path
  local_var_path = '/connectors/{id_connector}/sources/{id_source}'.sub('{' + 'id_connector' + '}', id_connector.to_s).sub('{' + 'id_source' + '}', id_source.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['auth_mechanism'] = opts[:'auth_mechanism'] if !opts[:'auth_mechanism'].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 => 'ConnectorSource')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_sources_id_source_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

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

Parameters:

  • name —

    Name of the bank or provider

  • login —

    Users login

  • password —

    Users password

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

    the optional parameters

Options Hash (opts):

  • :url (String) —

    Url of the bank

  • :email (String) —

    Email of the user

  • :types (String) —

    Type of connector, eg. banks or providers

  • :comment (String) —

    Optionnal comment

  • :sendmail (BOOLEAN) —

    if set, send an email to user

  • :expand (String)

Returns:



1289
1290
1291
1292
 
# File 'lib/budgea_client/api/providers_api.rb', line 1289

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



1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/budgea_client/api/providers_api.rb', line 1307

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 = {}) ⇒ InlineResponse20018

Get document types

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1368
1369
1370
1371
 
# File 'lib/budgea_client/api/providers_api.rb', line 1368

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

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

Get document types

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



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/budgea_client/api/providers_api.rb', line 1378

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 => 'InlineResponse20018')
  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:



1422
1423
1424
1425
 
# File 'lib/budgea_client/api/providers_api.rb', line 1422

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



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

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 = {}) ⇒ InlineResponse20015

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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:



1501
1502
1503
1504
 
# File 'lib/budgea_client/api/providers_api.rb', line 1501

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

#logs_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20015, 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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:

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

    InlineResponse20015 data, response status code and response headers



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 1522

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[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].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 => 'InlineResponse20015')
  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) 


1576
1577
1578
1579
 
# File 'lib/budgea_client/api/providers_api.rb', line 1576

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



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

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 = {}) ⇒ InlineResponse20020

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1634
1635
1636
1637
 
# File 'lib/budgea_client/api/providers_api.rb', line 1634

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

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

Get list of connectors

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20020 data, response status code and response headers



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

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 => 'InlineResponse20020')
  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 = {}) ⇒ 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:



1686
1687
1688
1689
 
# File 'lib/budgea_client/api/providers_api.rb', line 1686

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<(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



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

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 => 'InlineResponse20010')
  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:



1743
1744
1745
1746
 
# File 'lib/budgea_client/api/providers_api.rb', line 1743

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



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
1790
1791
1792
1793
 
# File 'lib/budgea_client/api/providers_api.rb', line 1754

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:



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

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



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

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

#providers_id_connector_sources_get(id_connector, opts = {}) ⇒ InlineResponse20011

Get list of connector sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



1857
1858
1859
1860
 
# File 'lib/budgea_client/api/providers_api.rb', line 1857

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

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

Get list of connector sources

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20011 data, response status code and response headers



1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
 
# File 'lib/budgea_client/api/providers_api.rb', line 1868

def providers_id_connector_sources_get_with_http_info(id_connector, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.providers_id_connector_sources_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_sources_get"
  end
  # resource path
  local_var_path = '/providers/{id_connector}/sources'.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 => 'InlineResponse20011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#providers_id_connector_sources_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:



1916
1917
1918
1919
 
# File 'lib/budgea_client/api/providers_api.rb', line 1916

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



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

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 = {}) ⇒ InlineResponse20032

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:



1994
1995
1996
1997
 
# File 'lib/budgea_client/api/providers_api.rb', line 1994

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

    InlineResponse20032 data, response status code and response headers



2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
 
# File 'lib/budgea_client/api/providers_api.rb', line 2016

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 => 'InlineResponse20032')
  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:



2082
2083
2084
2085
 
# File 'lib/budgea_client/api/providers_api.rb', line 2082

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



2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/budgea_client/api/providers_api.rb', line 2096

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:



2168
2169
2170
2171
 
# File 'lib/budgea_client/api/providers_api.rb', line 2168

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



2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
 
# File 'lib/budgea_client/api/providers_api.rb', line 2193

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:



2276
2277
2278
2279
 
# File 'lib/budgea_client/api/providers_api.rb', line 2276

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



2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
 
# File 'lib/budgea_client/api/providers_api.rb', line 2301

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:



2378
2379
2380
2381
 
# File 'lib/budgea_client/api/providers_api.rb', line 2378

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



2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 2392

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:



2453
2454
2455
2456
 
# File 'lib/budgea_client/api/providers_api.rb', line 2453

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



2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
 
# File 'lib/budgea_client/api/providers_api.rb', line 2466

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 = {}) ⇒ InlineResponse20032

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:



2531
2532
2533
2534
 
# File 'lib/budgea_client/api/providers_api.rb', line 2531

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

    InlineResponse20032 data, response status code and response headers



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
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
 
# File 'lib/budgea_client/api/providers_api.rb', line 2553

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 => 'InlineResponse20032')
  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:



2619
2620
2621
2622
 
# File 'lib/budgea_client/api/providers_api.rb', line 2619

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



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

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:



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

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



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
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
 
# File 'lib/budgea_client/api/providers_api.rb', line 2730

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:



2813
2814
2815
2816
 
# File 'lib/budgea_client/api/providers_api.rb', line 2813

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



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
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
 
# File 'lib/budgea_client/api/providers_api.rb', line 2838

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:



2915
2916
2917
2918
 
# File 'lib/budgea_client/api/providers_api.rb', line 2915

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



2929
2930
2931
2932
2933
2934
2935
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 2929

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:



2988
2989
2990
2991
 
# File 'lib/budgea_client/api/providers_api.rb', line 2988

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



2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
 
# File 'lib/budgea_client/api/providers_api.rb', line 2999

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:



3045
3046
3047
3048
 
# File 'lib/budgea_client/api/providers_api.rb', line 3045

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



3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
 
# File 'lib/budgea_client/api/providers_api.rb', line 3056

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:



3105
3106
3107
3108
 
# File 'lib/budgea_client/api/providers_api.rb', line 3105

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



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
3165
3166
3167
3168
3169
3170
 
# File 'lib/budgea_client/api/providers_api.rb', line 3119

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 = {}) ⇒ InlineResponse20032

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:



3189
3190
3191
3192
 
# File 'lib/budgea_client/api/providers_api.rb', line 3189

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

    InlineResponse20032 data, response status code and response headers



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
3267
3268
3269
3270
3271
3272
 
# File 'lib/budgea_client/api/providers_api.rb', line 3212

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 => 'InlineResponse20032')
  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:



3283
3284
3285
3286
 
# File 'lib/budgea_client/api/providers_api.rb', line 3283

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



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
3348
3349
3350
3351
3352
3353
 
# File 'lib/budgea_client/api/providers_api.rb', line 3298

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:



3375
3376
3377
3378
 
# File 'lib/budgea_client/api/providers_api.rb', line 3375

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



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
3462
3463
3464
3465
3466
3467
 
# File 'lib/budgea_client/api/providers_api.rb', line 3401

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:



3489
3490
3491
3492
 
# File 'lib/budgea_client/api/providers_api.rb', line 3489

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



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
3581
3582
3583
3584
3585
3586
 
# File 'lib/budgea_client/api/providers_api.rb', line 3515

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:



3597
3598
3599
3600
 
# File 'lib/budgea_client/api/providers_api.rb', line 3597

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



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
3663
3664
3665
3666
3667
3668
 
# File 'lib/budgea_client/api/providers_api.rb', line 3612

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:



3678
3679
3680
3681
 
# File 'lib/budgea_client/api/providers_api.rb', line 3678

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



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
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
 
# File 'lib/budgea_client/api/providers_api.rb', line 3692

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 = {}) ⇒ InlineResponse20032

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:



3762
3763
3764
3765
 
# File 'lib/budgea_client/api/providers_api.rb', line 3762

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

    InlineResponse20032 data, response status code and response headers



3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
 
# File 'lib/budgea_client/api/providers_api.rb', line 3785

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 => 'InlineResponse20032')
  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:



3856
3857
3858
3859
 
# File 'lib/budgea_client/api/providers_api.rb', line 3856

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



3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
 
# File 'lib/budgea_client/api/providers_api.rb', line 3871

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:



3948
3949
3950
3951
 
# File 'lib/budgea_client/api/providers_api.rb', line 3948

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



3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 3974

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:



4062
4063
4064
4065
 
# File 'lib/budgea_client/api/providers_api.rb', line 4062

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



4088
4089
4090
4091
4092
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
4157
4158
4159
 
# File 'lib/budgea_client/api/providers_api.rb', line 4088

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:



4170
4171
4172
4173
 
# File 'lib/budgea_client/api/providers_api.rb', line 4170

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



4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
 
# File 'lib/budgea_client/api/providers_api.rb', line 4185

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:



4249
4250
4251
4252
 
# File 'lib/budgea_client/api/providers_api.rb', line 4249

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



4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
 
# File 'lib/budgea_client/api/providers_api.rb', line 4261

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:



4312
4313
4314
4315
 
# File 'lib/budgea_client/api/providers_api.rb', line 4312

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



4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
 
# File 'lib/budgea_client/api/providers_api.rb', line 4324

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 = {}) ⇒ InlineResponse20032

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:



4384
4385
4386
4387
 
# File 'lib/budgea_client/api/providers_api.rb', line 4384

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

    InlineResponse20032 data, response status code and response headers



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
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
 
# File 'lib/budgea_client/api/providers_api.rb', line 4405

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 => 'InlineResponse20032')
  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:



4466
4467
4468
4469
 
# File 'lib/budgea_client/api/providers_api.rb', line 4466

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



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

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:



4546
4547
4548
4549
 
# File 'lib/budgea_client/api/providers_api.rb', line 4546

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



4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
 
# File 'lib/budgea_client/api/providers_api.rb', line 4570

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:



4648
4649
4650
4651
 
# File 'lib/budgea_client/api/providers_api.rb', line 4648

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



4672
4673
4674
4675
4676
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
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
 
# File 'lib/budgea_client/api/providers_api.rb', line 4672

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:



4744
4745
4746
4747
 
# File 'lib/budgea_client/api/providers_api.rb', line 4744

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



4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
 
# File 'lib/budgea_client/api/providers_api.rb', line 4757

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:



4813
4814
4815
4816
 
# File 'lib/budgea_client/api/providers_api.rb', line 4813

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



4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
 
# File 'lib/budgea_client/api/providers_api.rb', line 4825

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:



4876
4877
4878
4879
 
# File 'lib/budgea_client/api/providers_api.rb', line 4876

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



4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
 
# File 'lib/budgea_client/api/providers_api.rb', line 4888

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 = {}) ⇒ InlineResponse20015

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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:



4950
4951
4952
4953
 
# File 'lib/budgea_client/api/providers_api.rb', line 4950

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<(InlineResponse20015, 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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:

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

    InlineResponse20015 data, response status code and response headers



4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
 
# File 'lib/budgea_client/api/providers_api.rb', line 4973

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[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].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 => 'InlineResponse20015')
  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):

  • :expand (String)
  • :connection (Object)

Returns:



5036
5037
5038
5039
 
# File 'lib/budgea_client/api/providers_api.rb', line 5036

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

  • :expand (String)
  • :connection (Object)

Returns:

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

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

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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'connection'])
  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:



5100
5101
5102
5103
 
# File 'lib/budgea_client/api/providers_api.rb', line 5100

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



5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
 
# File 'lib/budgea_client/api/providers_api.rb', line 5112

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_sources_get(id_user, id_connection, opts = {}) ⇒ InlineResponse20016

Get connection sources

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:



5163
5164
5165
5166
 
# File 'lib/budgea_client/api/providers_api.rb', line 5163

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

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

Get connection sources

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

    InlineResponse20016 data, response status code and response headers



5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
 
# File 'lib/budgea_client/api/providers_api.rb', line 5175

def users_id_user_connections_id_connection_sources_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_sources_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_sources_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_sources_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/sources'.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 => 'InlineResponse20016')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_id_user_connections_id_connection_sources_id_source_delete(id_user, id_connection, id_source, opts = {}) ⇒ ConnectionSource

Disable a connection source This will make it so the specified source will not be synchronized anymore.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5227
5228
5229
5230
 
# File 'lib/budgea_client/api/providers_api.rb', line 5227

def users_id_user_connections_id_connection_sources_id_source_delete(id_user, id_connection, id_source, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_sources_id_source_delete_with_http_info(id_user, id_connection, id_source, opts)
  data
end

#users_id_user_connections_id_connection_sources_id_source_delete_with_http_info(id_user, id_connection, id_source, opts = {}) ⇒ Array<(ConnectionSource, Fixnum, Hash)>

Disable a connection source This will make it so the specified source will not be synchronized anymore.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectionSource data, response status code and response headers



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
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
 
# File 'lib/budgea_client/api/providers_api.rb', line 5240

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

#users_id_user_connections_id_connection_sources_id_source_post(id_user, id_connection, id_source, opts = {}) ⇒ ConnectionSource

Enable connection source This will make it so the specified source will be able to be synchronized.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5296
5297
5298
5299
 
# File 'lib/budgea_client/api/providers_api.rb', line 5296

def users_id_user_connections_id_connection_sources_id_source_post(id_user, id_connection, id_source, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_sources_id_source_post_with_http_info(id_user, id_connection, id_source, opts)
  data
end

#users_id_user_connections_id_connection_sources_id_source_post_with_http_info(id_user, id_connection, id_source, opts = {}) ⇒ Array<(ConnectionSource, Fixnum, Hash)>

Enable connection source This will make it so the specified source will be able to be synchronized.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectionSource data, response status code and response headers



5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
 
# File 'lib/budgea_client/api/providers_api.rb', line 5309

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

#users_id_user_connections_id_connection_sources_id_source_put(id_user, id_connection, id_source, opts = {}) ⇒ ConnectionSource

Enable connection source This will make it so the specified source will be able to be synchronized.

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



5365
5366
5367
5368
 
# File 'lib/budgea_client/api/providers_api.rb', line 5365

def users_id_user_connections_id_connection_sources_id_source_put(id_user, id_connection, id_source, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_sources_id_source_put_with_http_info(id_user, id_connection, id_source, opts)
  data
end

#users_id_user_connections_id_connection_sources_id_source_put_with_http_info(id_user, id_connection, id_source, opts = {}) ⇒ Array<(ConnectionSource, Fixnum, Hash)>

Enable connection source This will make it so the specified source will be able to be synchronized.&lt;br&gt;&lt;br&gt;

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    ConnectionSource data, response status code and response headers



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

def users_id_user_connections_id_connection_sources_id_source_put_with_http_info(id_user, id_connection, id_source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_sources_id_source_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_sources_id_source_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_sources_id_source_put"
  end
  # verify the required parameter 'id_source' is set
  if @api_client.config.client_side_validation && id_source.nil?
    fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.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 => 'ConnectionSource')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_sources_id_source_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:



5434
5435
5436
5437
 
# File 'lib/budgea_client/api/providers_api.rb', line 5434

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



5447
5448
5449
5450
5451
5452
5453
5454
5455
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5447

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:



5503
5504
5505
5506
 
# File 'lib/budgea_client/api/providers_api.rb', line 5503

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



5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
 
# File 'lib/budgea_client/api/providers_api.rb', line 5516

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 = {}) ⇒ InlineResponse20032

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:



5581
5582
5583
5584
 
# File 'lib/budgea_client/api/providers_api.rb', line 5581

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

    InlineResponse20032 data, response status code and response headers



5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
 
# File 'lib/budgea_client/api/providers_api.rb', line 5603

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 => 'InlineResponse20032')
  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:



5669
5670
5671
5672
 
# File 'lib/budgea_client/api/providers_api.rb', line 5669

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



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
5729
5730
5731
5732
5733
5734
 
# File 'lib/budgea_client/api/providers_api.rb', line 5683

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:



5755
5756
5757
5758
 
# File 'lib/budgea_client/api/providers_api.rb', line 5755

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



5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
 
# File 'lib/budgea_client/api/providers_api.rb', line 5780

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:



5863
5864
5865
5866
 
# File 'lib/budgea_client/api/providers_api.rb', line 5863

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



5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
 
# File 'lib/budgea_client/api/providers_api.rb', line 5888

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:



5965
5966
5967
5968
 
# File 'lib/budgea_client/api/providers_api.rb', line 5965

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



5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 5979

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_logs_get(id_user, id_connection, id_subscription, opts = {}) ⇒ InlineResponse20037

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

Parameters:

  • id_user —

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

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

  • :expand (String)

Returns:



6044
6045
6046
6047
 
# File 'lib/budgea_client/api/providers_api.rb', line 6044

def users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get(id_user, id_connection, id_subscription, opts = {})
  data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get_with_http_info(id_user, id_connection, id_subscription, opts)
  data
end

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

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

Parameters:

  • id_user —

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

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

  • :expand (String)

Returns:

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

    InlineResponse20037 data, response status code and response headers



6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
 
# File 'lib/budgea_client/api/providers_api.rb', line 6061

def users_id_user_connections_id_connection_subscriptions_id_subscription_logs_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_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_subscriptions_id_subscription_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_subscriptions_id_subscription_logs_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_logs_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/logs'.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[:'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 => 'InlineResponse20037')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_logs_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_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:



6123
6124
6125
6126
 
# File 'lib/budgea_client/api/providers_api.rb', line 6123

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



6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
 
# File 'lib/budgea_client/api/providers_api.rb', line 6138

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_subscriptions_put(id_user, id_connection, opts = {}) ⇒ Subscription

Update many subscriptions at once

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



6195
6196
6197
6198
 
# File 'lib/budgea_client/api/providers_api.rb', line 6195

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

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

Update many subscriptions at once

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Subscription data, response status code and response headers



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

def users_id_user_connections_id_connection_subscriptions_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_subscriptions_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_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_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions'.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 => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_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:



6259
6260
6261
6262
 
# File 'lib/budgea_client/api/providers_api.rb', line 6259

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



6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
 
# File 'lib/budgea_client/api/providers_api.rb', line 6272

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 = {}) ⇒ InlineResponse20032

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:



6337
6338
6339
6340
 
# File 'lib/budgea_client/api/providers_api.rb', line 6337

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

    InlineResponse20032 data, response status code and response headers



6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
 
# File 'lib/budgea_client/api/providers_api.rb', line 6359

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 => 'InlineResponse20032')
  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:



6425
6426
6427
6428
 
# File 'lib/budgea_client/api/providers_api.rb', line 6425

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



6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
 
# File 'lib/budgea_client/api/providers_api.rb', line 6439

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:



6511
6512
6513
6514
 
# File 'lib/budgea_client/api/providers_api.rb', line 6511

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



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
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
 
# File 'lib/budgea_client/api/providers_api.rb', line 6536

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:



6619
6620
6621
6622
 
# File 'lib/budgea_client/api/providers_api.rb', line 6619

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



6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
 
# File 'lib/budgea_client/api/providers_api.rb', line 6644

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:



6721
6722
6723
6724
 
# File 'lib/budgea_client/api/providers_api.rb', line 6721

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



6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
 
# File 'lib/budgea_client/api/providers_api.rb', line 6735

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:



6796
6797
6798
6799
 
# File 'lib/budgea_client/api/providers_api.rb', line 6796

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



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
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
 
# File 'lib/budgea_client/api/providers_api.rb', line 6809

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 = {}) ⇒ InlineResponse20032

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:



6874
6875
6876
6877
 
# File 'lib/budgea_client/api/providers_api.rb', line 6874

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

    InlineResponse20032 data, response status code and response headers



6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
 
# File 'lib/budgea_client/api/providers_api.rb', line 6896

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 => 'InlineResponse20032')
  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:



6962
6963
6964
6965
 
# File 'lib/budgea_client/api/providers_api.rb', line 6962

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



6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
 
# File 'lib/budgea_client/api/providers_api.rb', line 6976

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:



7048
7049
7050
7051
 
# File 'lib/budgea_client/api/providers_api.rb', line 7048

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



7073
7074
7075
7076
7077
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
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
 
# File 'lib/budgea_client/api/providers_api.rb', line 7073

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:



7156
7157
7158
7159
 
# File 'lib/budgea_client/api/providers_api.rb', line 7156

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



7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 7181

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:



7258
7259
7260
7261
 
# File 'lib/budgea_client/api/providers_api.rb', line 7258

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



7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
 
# File 'lib/budgea_client/api/providers_api.rb', line 7272

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

  • :source (String) —

    optional comma-separated list of sources to use for the connection synchronization

  • :expand (String)
  • :connection (Object)

Returns:



7333
7334
7335
7336
 
# File 'lib/budgea_client/api/providers_api.rb', line 7333

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

  • :source (String) —

    optional comma-separated list of sources to use for the connection synchronization

  • :expand (String)
  • :connection (Object)

Returns:

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

    Connection data, response status code and response headers



7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
 
# File 'lib/budgea_client/api/providers_api.rb', line 7346

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[:'source'] = opts[:'source'] if !opts[:'source'].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/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'connection'])
  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:



7393
7394
7395
7396
 
# File 'lib/budgea_client/api/providers_api.rb', line 7393

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



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

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 = {}) ⇒ InlineResponse20032

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:



7459
7460
7461
7462
 
# File 'lib/budgea_client/api/providers_api.rb', line 7459

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

    InlineResponse20032 data, response status code and response headers



7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
 
# File 'lib/budgea_client/api/providers_api.rb', line 7479

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 => 'InlineResponse20032')
  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:



7535
7536
7537
7538
 
# File 'lib/budgea_client/api/providers_api.rb', line 7535

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



7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
 
# File 'lib/budgea_client/api/providers_api.rb', line 7547

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:



7609
7610
7611
7612
 
# File 'lib/budgea_client/api/providers_api.rb', line 7609

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



7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
 
# File 'lib/budgea_client/api/providers_api.rb', line 7632

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:



7705
7706
7707
7708
 
# File 'lib/budgea_client/api/providers_api.rb', line 7705

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



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
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
 
# File 'lib/budgea_client/api/providers_api.rb', line 7728

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:



7795
7796
7797
7798
 
# File 'lib/budgea_client/api/providers_api.rb', line 7795

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



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
7845
7846
7847
7848
7849
7850
7851
 
# File 'lib/budgea_client/api/providers_api.rb', line 7807

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 = {}) ⇒ InlineResponse20015

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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:



7869
7870
7871
7872
 
# File 'lib/budgea_client/api/providers_api.rb', line 7869

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<(InlineResponse20015, 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

  • :id_source (Integer) —

    ID of a source

  • :expand (String)

Returns:

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

    InlineResponse20015 data, response status code and response headers



7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
 
# File 'lib/budgea_client/api/providers_api.rb', line 7891

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[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].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 => 'InlineResponse20015')
  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) 


7950
7951
7952
7953
 
# File 'lib/budgea_client/api/providers_api.rb', line 7950

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



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

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:



8015
8016
8017
8018
 
# File 'lib/budgea_client/api/providers_api.rb', line 8015

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



8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
 
# File 'lib/budgea_client/api/providers_api.rb', line 8027

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:



8078
8079
8080
8081
 
# File 'lib/budgea_client/api/providers_api.rb', line 8078

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



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
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
 
# File 'lib/budgea_client/api/providers_api.rb', line 8090

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 = {}) ⇒ InlineResponse20032

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:



8150
8151
8152
8153
 
# File 'lib/budgea_client/api/providers_api.rb', line 8150

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

    InlineResponse20032 data, response status code and response headers



8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
 
# File 'lib/budgea_client/api/providers_api.rb', line 8171

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 => 'InlineResponse20032')
  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:



8232
8233
8234
8235
 
# File 'lib/budgea_client/api/providers_api.rb', line 8232

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



8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
 
# File 'lib/budgea_client/api/providers_api.rb', line 8245

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:



8312
8313
8314
8315
 
# File 'lib/budgea_client/api/providers_api.rb', line 8312

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



8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 8336

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:



8414
8415
8416
8417
 
# File 'lib/budgea_client/api/providers_api.rb', line 8414

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



8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
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
 
# File 'lib/budgea_client/api/providers_api.rb', line 8438

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:



8510
8511
8512
8513
 
# File 'lib/budgea_client/api/providers_api.rb', line 8510

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



8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
 
# File 'lib/budgea_client/api/providers_api.rb', line 8523

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_logs_get(id_user, id_subscription, opts = {}) ⇒ InlineResponse20037

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

Parameters:

  • id_user —

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

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

  • :expand (String)

Returns:



8583
8584
8585
8586
 
# File 'lib/budgea_client/api/providers_api.rb', line 8583

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

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

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

Parameters:

  • id_user —

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

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

  • :expand (String)

Returns:

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

    InlineResponse20037 data, response status code and response headers



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
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
 
# File 'lib/budgea_client/api/providers_api.rb', line 8599

def users_id_user_subscriptions_id_subscription_logs_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_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_subscriptions_id_subscription_logs_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_logs_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/logs'.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[:'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 => 'InlineResponse20037')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_logs_get\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:



8656
8657
8658
8659
 
# File 'lib/budgea_client/api/providers_api.rb', line 8656

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



8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
 
# File 'lib/budgea_client/api/providers_api.rb', line 8670

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_subscriptions_put(id_user, opts = {}) ⇒ Subscription

Update many subscriptions at once

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



8722
8723
8724
8725
 
# File 'lib/budgea_client/api/providers_api.rb', line 8722

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

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

Update many subscriptions at once

Parameters:

  • id_user —

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

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    Subscription data, response status code and response headers



8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
 
# File 'lib/budgea_client/api/providers_api.rb', line 8733

def users_id_user_subscriptions_put_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_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_put"
  end
  # resource path
  local_var_path = '/users/{id_user}/subscriptions'.sub('{' + 'id_user' + '}', id_user.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_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:



8780
8781
8782
8783
 
# File 'lib/budgea_client/api/providers_api.rb', line 8780

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



8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
 
# File 'lib/budgea_client/api/providers_api.rb', line 8792

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 = {}) ⇒ InlineResponse20032

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:



8852
8853
8854
8855
 
# File 'lib/budgea_client/api/providers_api.rb', line 8852

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

    InlineResponse20032 data, response status code and response headers



8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
 
# File 'lib/budgea_client/api/providers_api.rb', line 8873

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 => 'InlineResponse20032')
  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:



8934
8935
8936
8937
 
# File 'lib/budgea_client/api/providers_api.rb', line 8934

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



8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
 
# File 'lib/budgea_client/api/providers_api.rb', line 8947

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:



9014
9015
9016
9017
 
# File 'lib/budgea_client/api/providers_api.rb', line 9014

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



9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
 
# File 'lib/budgea_client/api/providers_api.rb', line 9038

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:



9116
9117
9118
9119
 
# File 'lib/budgea_client/api/providers_api.rb', line 9116

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



9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
 
# File 'lib/budgea_client/api/providers_api.rb', line 9140

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:



9212
9213
9214
9215
 
# File 'lib/budgea_client/api/providers_api.rb', line 9212

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



9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
 
# File 'lib/budgea_client/api/providers_api.rb', line 9225

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:



9281
9282
9283
9284
 
# File 'lib/budgea_client/api/providers_api.rb', line 9281

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



9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
 
# File 'lib/budgea_client/api/providers_api.rb', line 9293

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 = {}) ⇒ InlineResponse20032

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:



9353
9354
9355
9356
 
# File 'lib/budgea_client/api/providers_api.rb', line 9353

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

    InlineResponse20032 data, response status code and response headers



9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
 
# File 'lib/budgea_client/api/providers_api.rb', line 9374

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 => 'InlineResponse20032')
  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:



9435
9436
9437
9438
 
# File 'lib/budgea_client/api/providers_api.rb', line 9435

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



9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
 
# File 'lib/budgea_client/api/providers_api.rb', line 9448

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:



9515
9516
9517
9518
 
# File 'lib/budgea_client/api/providers_api.rb', line 9515

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



9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
 
# File 'lib/budgea_client/api/providers_api.rb', line 9539

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:



9617
9618
9619
9620
 
# File 'lib/budgea_client/api/providers_api.rb', line 9617

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



9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
 
# File 'lib/budgea_client/api/providers_api.rb', line 9641

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:



9713
9714
9715
9716
 
# File 'lib/budgea_client/api/providers_api.rb', line 9713

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



9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
 
# File 'lib/budgea_client/api/providers_api.rb', line 9726

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