docs/BanksApi.md in budgea_client-4.0.3 vs docs/BanksApi.md in budgea_client-5.0.0

- old
+ new

@@ -12,41 +12,48 @@ [**banks_get**](BanksApi.md#banks_get) | **GET** /banks | Get list of connectors [**banks_id_connector_connections_get**](BanksApi.md#banks_id_connector_connections_get) | **GET** /banks/{id_connector}/connections | Get a subset of id_connection with the largest diversity of account [**banks_id_connector_logos_get**](BanksApi.md#banks_id_connector_logos_get) | **GET** /banks/{id_connector}/logos | Get all links to the files associated with this connector. [**banks_id_connector_logos_main_get**](BanksApi.md#banks_id_connector_logos_main_get) | **GET** /banks/{id_connector}/logos/main | Get all links to the files associated with this connector. [**banks_id_connector_logos_thumbnail_get**](BanksApi.md#banks_id_connector_logos_thumbnail_get) | **GET** /banks/{id_connector}/logos/thumbnail | Get all links to the files associated with this connector. +[**banks_id_connector_sources_get**](BanksApi.md#banks_id_connector_sources_get) | **GET** /banks/{id_connector}/sources | Get list of connector sources [**categories_get**](BanksApi.md#categories_get) | **GET** /categories | Get all categories [**categories_keywords_id_keyword_delete**](BanksApi.md#categories_keywords_id_keyword_delete) | **DELETE** /categories/keywords/{id_keyword} | Delete a particular key-value pair on a transaction. [**categories_keywords_post**](BanksApi.md#categories_keywords_post) | **POST** /categories/keywords | Add a new keyword associated with a category in the database. [**categorize_post**](BanksApi.md#categorize_post) | **POST** /categorize | categorize transactions without storing them [**connections_get**](BanksApi.md#connections_get) | **GET** /connections | Get connections without a user +[**connections_id_connection_logs_get**](BanksApi.md#connections_id_connection_logs_get) | **GET** /connections/{id_connection}/logs | Get connection logs [**connectors_get**](BanksApi.md#connectors_get) | **GET** /connectors | Get list of connectors [**connectors_id_connector_logos_get**](BanksApi.md#connectors_id_connector_logos_get) | **GET** /connectors/{id_connector}/logos | Get all links to the files associated with this connector. [**connectors_id_connector_logos_id_logo_delete**](BanksApi.md#connectors_id_connector_logos_id_logo_delete) | **DELETE** /connectors/{id_connector}/logos/{id_logo} | Delete a single Logo object. [**connectors_id_connector_logos_id_logo_put**](BanksApi.md#connectors_id_connector_logos_id_logo_put) | **PUT** /connectors/{id_connector}/logos/{id_logo} | Create or Update a connector Logo. [**connectors_id_connector_logos_main_get**](BanksApi.md#connectors_id_connector_logos_main_get) | **GET** /connectors/{id_connector}/logos/main | Get all links to the files associated with this connector. [**connectors_id_connector_logos_post**](BanksApi.md#connectors_id_connector_logos_post) | **POST** /connectors/{id_connector}/logos | Create a connector Logo [**connectors_id_connector_logos_put**](BanksApi.md#connectors_id_connector_logos_put) | **PUT** /connectors/{id_connector}/logos | Create or Update a connector Logo [**connectors_id_connector_logos_thumbnail_get**](BanksApi.md#connectors_id_connector_logos_thumbnail_get) | **GET** /connectors/{id_connector}/logos/thumbnail | Get all links to the files associated with this connector. [**connectors_id_connector_put**](BanksApi.md#connectors_id_connector_put) | **PUT** /connectors/{id_connector} | Edit the provided connector +[**connectors_id_connector_sources_get**](BanksApi.md#connectors_id_connector_sources_get) | **GET** /connectors/{id_connector}/sources | Get list of connector sources +[**connectors_id_connector_sources_id_source_put**](BanksApi.md#connectors_id_connector_sources_id_source_put) | **PUT** /connectors/{id_connector}/sources/{id_source} | Edit the provided connector source [**connectors_post**](BanksApi.md#connectors_post) | **POST** /connectors | Request a new connector -[**invoicing_get**](BanksApi.md#invoicing_get) | **GET** /invoicing | Get number of accounts, connections and users synced. +[**connectors_put**](BanksApi.md#connectors_put) | **PUT** /connectors | Enable/disable several connectors +[**invoicing_get**](BanksApi.md#invoicing_get) | **GET** /invoicing | Get invoicing data for a given period (default is the current month). [**logs_get**](BanksApi.md#logs_get) | **GET** /logs | Get connection logs [**providers_get**](BanksApi.md#providers_get) | **GET** /providers | Get list of connectors [**providers_id_connector_connections_get**](BanksApi.md#providers_id_connector_connections_get) | **GET** /providers/{id_connector}/connections | Get a random subset of provider&#39;s id_connection [**providers_id_connector_logos_get**](BanksApi.md#providers_id_connector_logos_get) | **GET** /providers/{id_connector}/logos | Get all links to the files associated with this connector. [**providers_id_connector_logos_main_get**](BanksApi.md#providers_id_connector_logos_main_get) | **GET** /providers/{id_connector}/logos/main | Get all links to the files associated with this connector. [**providers_id_connector_logos_thumbnail_get**](BanksApi.md#providers_id_connector_logos_thumbnail_get) | **GET** /providers/{id_connector}/logos/thumbnail | Get all links to the files associated with this connector. +[**providers_id_connector_sources_get**](BanksApi.md#providers_id_connector_sources_get) | **GET** /providers/{id_connector}/sources | Get list of connector sources [**users_id_user_account_types_get**](BanksApi.md#users_id_user_account_types_get) | **GET** /users/{id_user}/account_types | Get account types [**users_id_user_account_types_id_account_type_get**](BanksApi.md#users_id_user_account_types_id_account_type_get) | **GET** /users/{id_user}/account_types/{id_account_type} | Get an account type [**users_id_user_accounts_delete**](BanksApi.md#users_id_user_accounts_delete) | **DELETE** /users/{id_user}/accounts | Delete all accounts [**users_id_user_accounts_get**](BanksApi.md#users_id_user_accounts_get) | **GET** /users/{id_user}/accounts | Get accounts list. [**users_id_user_accounts_id_account_categories_get**](BanksApi.md#users_id_user_accounts_id_account_categories_get) | **GET** /users/{id_user}/accounts/{id_account}/categories | Get the category [**users_id_user_accounts_id_account_delete**](BanksApi.md#users_id_user_accounts_id_account_delete) | **DELETE** /users/{id_user}/accounts/{id_account} | Delete an account. [**users_id_user_accounts_id_account_delta_get**](BanksApi.md#users_id_user_accounts_id_account_delta_get) | **GET** /users/{id_user}/accounts/{id_account}/delta | Get deltas of accounts [**users_id_user_accounts_id_account_logs_get**](BanksApi.md#users_id_user_accounts_id_account_logs_get) | **GET** /users/{id_user}/accounts/{id_account}/logs | Get accounts logs. [**users_id_user_accounts_id_account_put**](BanksApi.md#users_id_user_accounts_id_account_put) | **PUT** /users/{id_user}/accounts/{id_account} | Update an account +[**users_id_user_accounts_id_account_sources_get**](BanksApi.md#users_id_user_accounts_id_account_sources_get) | **GET** /users/{id_user}/accounts/{id_account}/sources | Get account sources [**users_id_user_accounts_id_account_transactions_delete**](BanksApi.md#users_id_user_accounts_id_account_transactions_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/transactions | Delete transactions [**users_id_user_accounts_id_account_transactions_get**](BanksApi.md#users_id_user_accounts_id_account_transactions_get) | **GET** /users/{id_user}/accounts/{id_account}/transactions | Get transactions [**users_id_user_accounts_id_account_transactions_id_transaction_informations_delete**](BanksApi.md#users_id_user_accounts_id_account_transactions_id_transaction_informations_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations | Delete all arbitrary key-value pairs of a transaction [**users_id_user_accounts_id_account_transactions_id_transaction_informations_get**](BanksApi.md#users_id_user_accounts_id_account_transactions_id_transaction_informations_get) | **GET** /users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations | List all arbitrary key-value pairs on a transaction [**users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete**](BanksApi.md#users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information} | Delete a particular key-value pair on a transaction. @@ -73,10 +80,11 @@ [**users_id_user_connections_id_connection_accounts_id_account_categories_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_categories_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/categories | Get the category [**users_id_user_connections_id_connection_accounts_id_account_delete**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account} | Delete an account. [**users_id_user_connections_id_connection_accounts_id_account_delta_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_delta_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/delta | Get deltas of accounts [**users_id_user_connections_id_connection_accounts_id_account_logs_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_logs_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/logs | Get accounts logs. [**users_id_user_connections_id_connection_accounts_id_account_put**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_put) | **PUT** /users/{id_user}/connections/{id_connection}/accounts/{id_account} | Update an account +[**users_id_user_connections_id_connection_accounts_id_account_sources_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_sources_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/sources | Get account sources [**users_id_user_connections_id_connection_accounts_id_account_transactions_delete**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactions_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions | Delete transactions [**users_id_user_connections_id_connection_accounts_id_account_transactions_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactions_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions | Get transactions [**users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations | Delete all arbitrary key-value pairs of a transaction [**users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations | List all arbitrary key-value pairs on a transaction [**users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/informations/{id_information} | Delete a particular key-value pair on a transaction. @@ -94,10 +102,14 @@ [**users_id_user_connections_id_connection_get**](BanksApi.md#users_id_user_connections_id_connection_get) | **GET** /users/{id_user}/connections/{id_connection} | Get connection [**users_id_user_connections_id_connection_informations_get**](BanksApi.md#users_id_user_connections_id_connection_informations_get) | **GET** /users/{id_user}/connections/{id_connection}/informations | Get connection additionnal informations [**users_id_user_connections_id_connection_logs_get**](BanksApi.md#users_id_user_connections_id_connection_logs_get) | **GET** /users/{id_user}/connections/{id_connection}/logs | Get connection logs [**users_id_user_connections_id_connection_post**](BanksApi.md#users_id_user_connections_id_connection_post) | **POST** /users/{id_user}/connections/{id_connection} | Update a connection. [**users_id_user_connections_id_connection_put**](BanksApi.md#users_id_user_connections_id_connection_put) | **PUT** /users/{id_user}/connections/{id_connection} | Force synchronisation of a connection. +[**users_id_user_connections_id_connection_sources_get**](BanksApi.md#users_id_user_connections_id_connection_sources_get) | **GET** /users/{id_user}/connections/{id_connection}/sources | Get connection sources +[**users_id_user_connections_id_connection_sources_id_source_delete**](BanksApi.md#users_id_user_connections_id_connection_sources_id_source_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/sources/{id_source} | Disable a connection source +[**users_id_user_connections_id_connection_sources_id_source_post**](BanksApi.md#users_id_user_connections_id_connection_sources_id_source_post) | **POST** /users/{id_user}/connections/{id_connection}/sources/{id_source} | Enable connection source +[**users_id_user_connections_id_connection_sources_id_source_put**](BanksApi.md#users_id_user_connections_id_connection_sources_id_source_put) | **PUT** /users/{id_user}/connections/{id_connection}/sources/{id_source} | Enable connection source [**users_id_user_connections_id_connection_transactions_delete**](BanksApi.md#users_id_user_connections_id_connection_transactions_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/transactions | Delete transactions [**users_id_user_connections_id_connection_transactions_get**](BanksApi.md#users_id_user_connections_id_connection_transactions_get) | **GET** /users/{id_user}/connections/{id_connection}/transactions | Get transactions [**users_id_user_connections_id_connection_transactions_id_transaction_informations_delete**](BanksApi.md#users_id_user_connections_id_connection_transactions_id_transaction_informations_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations | Delete all arbitrary key-value pairs of a transaction [**users_id_user_connections_id_connection_transactions_id_transaction_informations_get**](BanksApi.md#users_id_user_connections_id_connection_transactions_id_transaction_informations_get) | **GET** /users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations | List all arbitrary key-value pairs on a transaction [**users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete**](BanksApi.md#users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/informations/{id_information} | Delete a particular key-value pair on a transaction. @@ -175,11 +187,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **account_types_id_account_type_get** @@ -233,11 +245,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_categories_id_category_delete** @@ -291,11 +303,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_categories_id_category_post** @@ -352,11 +364,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_categories_post** @@ -410,11 +422,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_get** @@ -465,11 +477,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_id_connector_connections_get** @@ -529,11 +541,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_id_connector_logos_get** @@ -587,11 +599,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_id_connector_logos_main_get** @@ -645,11 +657,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **banks_id_connector_logos_thumbnail_get** @@ -703,17 +715,75 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **banks_id_connector_sources_get** +> InlineResponse20011 banks_id_connector_sources_get(id_connector, opts) + +Get list of connector sources + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_connector = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Get list of connector sources + result = api_instance.banks_id_connector_sources_get(id_connector, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->banks_id_connector_sources_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_connector** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20011**](InlineResponse20011.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **categories_get** -> InlineResponse20011 categories_get(opts) +> InlineResponse20012 categories_get(opts) Get all categories Ressource to get all existing categories<br><br> @@ -750,19 +820,19 @@ ------------- | ------------- | ------------- | ------------- **expand** | **String**| | [optional] ### Return type -[**InlineResponse20011**](InlineResponse20011.md) +[**InlineResponse20012**](InlineResponse20012.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **categories_keywords_id_keyword_delete** @@ -816,11 +886,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **categories_keywords_post** @@ -871,11 +941,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **categorize_post** @@ -931,11 +1001,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connections_get** @@ -986,17 +1056,97 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **connections_id_connection_logs_get** +> InlineResponse20015 connections_id_connection_logs_get(id_connection, opts) + +Get connection logs + +Get logs about connections.<br><br> + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_connection = 56 # Integer | + +opts = { + limit: 56, # Integer | limit number of results + offset: 56, # Integer | offset of first result + min_date: Date.parse('2013-10-20'), # Date | minimal date + max_date: Date.parse('2013-10-20'), # Date | maximum date + state: 56, # Integer | state of user + period: 'period_example', # String | period to group logs + id_user: 56, # Integer | ID of a user + id_connection2: 56, # Integer | ID of a connection + id_connector: 56, # Integer | ID of a connector + charged: true, # BOOLEAN | consider only logs for charged connectors + id_source: 56, # Integer | ID of a source + expand: 'expand_example' # String | +} + +begin + #Get connection logs + result = api_instance.connections_id_connection_logs_get(id_connection, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->connections_id_connection_logs_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_connection** | **Integer**| | + **limit** | **Integer**| limit number of results | [optional] + **offset** | **Integer**| offset of first result | [optional] + **min_date** | **Date**| minimal date | [optional] + **max_date** | **Date**| maximum date | [optional] + **state** | **Integer**| state of user | [optional] + **period** | **String**| period to group logs | [optional] + **id_user** | **Integer**| ID of a user | [optional] + **id_connection2** | **Integer**| ID of a connection | [optional] + **id_connector** | **Integer**| ID of a connector | [optional] + **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] + **id_source** | **Integer**| ID of a source | [optional] + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20015**](InlineResponse20015.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **connectors_get** -> InlineResponse20014 connectors_get(opts) +> InlineResponse20016 connectors_get(opts) Get list of connectors @@ -1033,19 +1183,19 @@ ------------- | ------------- | ------------- | ------------- **expand** | **String**| | [optional] ### Return type -[**InlineResponse20014**](InlineResponse20014.md) +[**InlineResponse20016**](InlineResponse20016.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_get** @@ -1099,11 +1249,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_id_logo_delete** @@ -1160,11 +1310,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_id_logo_put** @@ -1221,11 +1371,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_main_get** @@ -1279,11 +1429,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_post** @@ -1337,11 +1487,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_put** @@ -1395,11 +1545,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_logos_thumbnail_get** @@ -1453,11 +1603,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **connectors_id_connector_put** @@ -1485,10 +1635,11 @@ opts = { id_categories: 'id_categories_example', # String | one or several comma separated categories to map to the given connector (or null to map no category) hidden: true, # BOOLEAN | to enable or disable connector (bank or provider) sync_frequency: 56, # Integer | Allows you to overload global sync_frequency param + auth_mechanism: 'auth_mechanism_example', # String | the authentication mechanism to use for this connector expand: 'expand_example' # String | } begin #Edit the provided connector @@ -1505,10 +1656,11 @@ ------------- | ------------- | ------------- | ------------- **id_connector** | **Integer**| | **id_categories** | **String**| one or several comma separated categories to map to the given connector (or null to map no category) | [optional] **hidden** | **BOOLEAN**| to enable or disable connector (bank or provider) | [optional] **sync_frequency** | **Integer**| Allows you to overload global sync_frequency param | [optional] + **auth_mechanism** | **String**| the authentication mechanism to use for this connector | [optional] **expand** | **String**| | [optional] ### Return type [**Connector**](Connector.md) @@ -1517,15 +1669,138 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **connectors_id_connector_sources_get** +> InlineResponse20011 connectors_id_connector_sources_get(id_connector, opts) + +Get list of connector sources + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_connector = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Get list of connector sources + result = api_instance.connectors_id_connector_sources_get(id_connector, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->connectors_id_connector_sources_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_connector** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20011**](InlineResponse20011.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + +# **connectors_id_connector_sources_id_source_put** +> ConnectorSource connectors_id_connector_sources_id_source_put(id_connector, id_source, opts) + +Edit the provided connector source + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_connector = 56 # Integer | + +id_source = 56 # Integer | + +opts = { + auth_mechanism: 'auth_mechanism_example', # String | the authentication mechanism to use for this connector source + disabled: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | to enable or disable connector source + expand: 'expand_example' # String | +} + +begin + #Edit the provided connector source + result = api_instance.connectors_id_connector_sources_id_source_put(id_connector, id_source, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->connectors_id_connector_sources_id_source_put: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_connector** | **Integer**| | + **id_source** | **Integer**| | + **auth_mechanism** | **String**| the authentication mechanism to use for this connector source | [optional] + **disabled** | **DateTime**| to enable or disable connector source | [optional] + **expand** | **String**| | [optional] + +### Return type + +[**ConnectorSource**](ConnectorSource.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **connectors_post** > Connector connectors_post(name, login, password, opts) Request a new connector @@ -1596,16 +1871,73 @@ - **Content-Type**: application/x-www-form-urlencoded - **Accept**: application/json +# **connectors_put** +> Connector connectors_put(opts) + +Enable/disable several connectors + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +opts = { + hidden: true, # BOOLEAN | to enable or disable connector (bank or provider) + expand: 'expand_example' # String | +} + +begin + #Enable/disable several connectors + result = api_instance.connectors_put(opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->connectors_put: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **hidden** | **BOOLEAN**| to enable or disable connector (bank or provider) | [optional] + **expand** | **String**| | [optional] + +### Return type + +[**Connector**](Connector.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **invoicing_get** > invoicing_get(opts) -Get number of accounts, connections and users synced. +Get invoicing data for a given period (default is the current month). -Get number of accounts, connections and users synced between two dates for the given period.<br><br> +You can get all the invoicing data or just specific ones by using the available parameters.<br><br>If no parameters are specified, no invoicing data is returned.<br><br> ### Example ```ruby # load the gem require 'budgea_client' @@ -1620,16 +1952,24 @@ api_instance = BudgeaClient::BanksApi.new opts = { min_date: Date.parse('2013-10-20'), # Date | minimal date max_date: Date.parse('2013-10-20'), # Date | maximum date - period: 'period_example', # String | period to group logs - all: 'all_example' # String | get full ids list instead of numbers + users_synced: 'users_synced_example', # String | the number of user synchronized during the period + users_bank: 'users_bank_example', # String | the number of user of the Bank API synchronized during the period + users_bill: 'users_bill_example', # String | the number of user of the Bill API synchronized during the period + accounts_synced: 'accounts_synced_example', # String | the number of accounts synchronized during the period + subscriptions_synced: 'subscriptions_synced_example', # String | the number of subscriptions synchronized during the period + connections_synced: 'connections_synced_example', # String | the number of connections synchronized during the period + connections_account: 'connections_account_example', # String | the number of Bank API connections synchronized during the period + transfers_synced: 'transfers_synced_example', # String | the number of transfers done during the period + all: 'all_example', # String | get all the invoicing data at once + detail: 'detail_example' # String | get full ids list instead of numbers } begin - #Get number of accounts, connections and users synced. + #Get invoicing data for a given period (default is the current month). api_instance.invoicing_get(opts) rescue BudgeaClient::ApiError => e puts "Exception when calling BanksApi->invoicing_get: #{e}" end ``` @@ -1638,12 +1978,20 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **min_date** | **Date**| minimal date | [optional] **max_date** | **Date**| maximum date | [optional] - **period** | **String**| period to group logs | [optional] - **all** | **String**| get full ids list instead of numbers | [optional] + **users_synced** | **String**| the number of user synchronized during the period | [optional] + **users_bank** | **String**| the number of user of the Bank API synchronized during the period | [optional] + **users_bill** | **String**| the number of user of the Bill API synchronized during the period | [optional] + **accounts_synced** | **String**| the number of accounts synchronized during the period | [optional] + **subscriptions_synced** | **String**| the number of subscriptions synchronized during the period | [optional] + **connections_synced** | **String**| the number of connections synchronized during the period | [optional] + **connections_account** | **String**| the number of Bank API connections synchronized during the period | [optional] + **transfers_synced** | **String**| the number of transfers done during the period | [optional] + **all** | **String**| get all the invoicing data at once | [optional] + **detail** | **String**| get full ids list instead of numbers | [optional] ### Return type nil (empty response body) @@ -1651,17 +1999,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **logs_get** -> InlineResponse20017 logs_get(opts) +> InlineResponse20015 logs_get(opts) Get connection logs Get logs about connections.<br><br> @@ -1688,10 +2036,11 @@ period: 'period_example', # String | period to group logs id_user: 56, # Integer | ID of a user id_connection: 56, # Integer | ID of a connection id_connector: 56, # Integer | ID of a connector charged: true, # BOOLEAN | consider only logs for charged connectors + id_source: 56, # Integer | ID of a source expand: 'expand_example' # String | } begin #Get connection logs @@ -1714,29 +2063,30 @@ **period** | **String**| period to group logs | [optional] **id_user** | **Integer**| ID of a user | [optional] **id_connection** | **Integer**| ID of a connection | [optional] **id_connector** | **Integer**| ID of a connector | [optional] **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] + **id_source** | **Integer**| ID of a source | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20017**](InlineResponse20017.md) +[**InlineResponse20015**](InlineResponse20015.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **providers_get** -> InlineResponse20018 providers_get(opts) +> InlineResponse20019 providers_get(opts) Get list of connectors @@ -1773,19 +2123,19 @@ ------------- | ------------- | ------------- | ------------- **expand** | **String**| | [optional] ### Return type -[**InlineResponse20018**](InlineResponse20018.md) +[**InlineResponse20019**](InlineResponse20019.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **providers_id_connector_connections_get** @@ -1841,17 +2191,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **providers_id_connector_logos_get** -> InlineResponse20019 providers_id_connector_logos_get(id_connector, opts) +> InlineResponse20010 providers_id_connector_logos_get(id_connector, opts) Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @@ -1891,19 +2241,19 @@ **id_connector** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20019**](InlineResponse20019.md) +[**InlineResponse20010**](InlineResponse20010.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **providers_id_connector_logos_main_get** @@ -1957,11 +2307,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **providers_id_connector_logos_thumbnail_get** @@ -2015,15 +2365,73 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **providers_id_connector_sources_get** +> InlineResponse20011 providers_id_connector_sources_get(id_connector, opts) + +Get list of connector sources + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_connector = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Get list of connector sources + result = api_instance.providers_id_connector_sources_get(id_connector, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->providers_id_connector_sources_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_connector** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20011**](InlineResponse20011.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **users_id_user_account_types_get** > InlineResponse200 users_id_user_account_types_get(id_user, opts) Get account types @@ -2073,11 +2481,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_account_types_id_account_type_get** @@ -2134,11 +2542,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_delete** @@ -2192,11 +2600,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_get** @@ -2250,11 +2658,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_categories_get** @@ -2306,11 +2714,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_delete** @@ -2367,11 +2775,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_delta_get** @@ -2431,21 +2839,21 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_logs_get** > InlineResponse20026 users_id_user_accounts_id_account_logs_get(id_user, id_account, opts) Get accounts logs. -Get logs of account.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> +Get logs of account. By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> ### Example ```ruby # load the gem require 'budgea_client' @@ -2500,11 +2908,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_put** @@ -2575,15 +2983,76 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **users_id_user_accounts_id_account_sources_get** +> InlineResponse20030 users_id_user_accounts_id_account_sources_get(id_user, id_account, opts) + +Get account sources + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' + +id_account = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Get account sources + result = api_instance.users_id_user_accounts_id_account_sources_get(id_user, id_account, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->users_id_user_accounts_id_account_sources_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **id_account** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20030**](InlineResponse20030.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **users_id_user_accounts_id_account_transactions_delete** > Transaction users_id_user_accounts_id_account_transactions_delete(id_user, id_account, opts) Delete transactions @@ -2636,17 +3105,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_get** -> InlineResponse20030 users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts) +> InlineResponse20031 users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -2715,19 +3184,19 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_informations_delete** @@ -2787,17 +3256,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_informations_get** -> InlineResponse20032 users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts) +> InlineResponse20033 users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -2843,19 +3312,19 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete** @@ -2918,11 +3387,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get** @@ -2985,11 +3454,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_informations_put** @@ -3049,11 +3518,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_id_transaction_put** @@ -3123,11 +3592,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactions_post** @@ -3207,17 +3676,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactionsclusters_get** -> InlineResponse20033 users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts) +> InlineResponse20034 users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts) Get clustered transactions @@ -3260,19 +3729,19 @@ **id_account** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20033**](InlineResponse20033.md) +[**InlineResponse20034**](InlineResponse20034.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete** @@ -3332,11 +3801,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put** @@ -3396,11 +3865,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_id_account_transactionsclusters_post** @@ -3457,17 +3926,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_post** -> Account users_id_user_accounts_post(id_user, name, balance, opts) +> Account users_id_user_accounts_post(id_user, name, opts) Create an account This endpoint creates an account related to a connection or not.<br><br> @@ -3487,23 +3956,22 @@ id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' name = 'name_example' # String | name of account -balance = 3.4 # Float | balance of account - opts = { + balance: 3.4, # Float | balance of account number: 'number_example', # String | number of account iban: 'iban_example', # String | IBAN of account id_currency: 'id_currency_example', # String | the currency of the account (default: 'EUR') id_connection: 56, # Integer | the connection to attach to the account expand: 'expand_example' # String | } begin #Create an account - result = api_instance.users_id_user_accounts_post(id_user, name, balance, opts) + result = api_instance.users_id_user_accounts_post(id_user, name, opts) p result rescue BudgeaClient::ApiError => e puts "Exception when calling BanksApi->users_id_user_accounts_post: #{e}" end ``` @@ -3512,11 +3980,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **name** | **String**| name of account | - **balance** | **Float**| balance of account | + **balance** | **Float**| balance of account | [optional] **number** | **String**| number of account | [optional] **iban** | **String**| IBAN of account | [optional] **id_currency** | **String**| the currency of the account (default: &#39;EUR&#39;) | [optional] **id_connection** | **Integer**| the connection to attach to the account | [optional] **expand** | **String**| | [optional] @@ -3529,11 +3997,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_accounts_put** @@ -3587,17 +4055,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_alerts_get** -> InlineResponse20034 users_id_user_alerts_get(id_user, opts) +> InlineResponse20035 users_id_user_alerts_get(id_user, opts) Get alerts @@ -3637,25 +4105,25 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20034**](InlineResponse20034.md) +[**InlineResponse20035**](InlineResponse20035.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_categories_full_get** -> InlineResponse20035 users_id_user_categories_full_get(id_user, opts) +> InlineResponse20036 users_id_user_categories_full_get(id_user, opts) Get the category Ressource to get categories<br><br> @@ -3695,19 +4163,19 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20035**](InlineResponse20035.md) +[**InlineResponse20036**](InlineResponse20036.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_categories_full_id_full_delete** @@ -3764,11 +4232,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_categories_full_id_full_put** @@ -3829,11 +4297,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_categories_full_post** @@ -3901,11 +4369,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_categories_get** @@ -3954,11 +4422,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_delete** @@ -4012,11 +4480,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_get** @@ -4070,11 +4538,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_delete** @@ -4131,11 +4599,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_get** @@ -4192,11 +4660,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_categories_get** @@ -4251,11 +4719,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_delete** @@ -4315,11 +4783,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_delta_get** @@ -4382,21 +4850,21 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_logs_get** > InlineResponse20026 users_id_user_connections_id_connection_accounts_id_account_logs_get(id_user, id_connection, id_account, opts) Get accounts logs. -Get logs of account.<br><br>By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> +Get logs of account. By default, it selects logs for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> ### Example ```ruby # load the gem require 'budgea_client' @@ -4454,11 +4922,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_put** @@ -4532,15 +5000,79 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **users_id_user_connections_id_connection_accounts_id_account_sources_get** +> InlineResponse20030 users_id_user_connections_id_connection_accounts_id_account_sources_get(id_user, id_connection, id_account, opts) + +Get account sources + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' + +id_connection = 56 # Integer | + +id_account = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Get account sources + result = api_instance.users_id_user_connections_id_connection_accounts_id_account_sources_get(id_user, id_connection, id_account, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->users_id_user_connections_id_connection_accounts_id_account_sources_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **id_connection** | **Integer**| | + **id_account** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20030**](InlineResponse20030.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **users_id_user_connections_id_connection_accounts_id_account_transactions_delete** > Transaction users_id_user_connections_id_connection_accounts_id_account_transactions_delete(id_user, id_connection, id_account, opts) Delete transactions @@ -4596,17 +5128,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_get** -> InlineResponse20030 users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts) +> InlineResponse20031 users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -4678,19 +5210,19 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete** @@ -4753,17 +5285,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get** -> InlineResponse20032 users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts) +> InlineResponse20033 users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -4812,19 +5344,19 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete** @@ -4890,11 +5422,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get** @@ -4960,11 +5492,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put** @@ -5027,11 +5559,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put** @@ -5104,11 +5636,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactions_post** @@ -5191,17 +5723,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get** -> InlineResponse20033 users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts) +> InlineResponse20034 users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts) Get clustered transactions @@ -5247,19 +5779,19 @@ **id_account** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20033**](InlineResponse20033.md) +[**InlineResponse20034**](InlineResponse20034.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete** @@ -5322,11 +5854,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put** @@ -5389,11 +5921,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post** @@ -5453,17 +5985,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_accounts_post** -> Account users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, balance, opts) +> Account users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, opts) Create an account This endpoint creates an account related to a connection or not.<br><br> @@ -5485,23 +6017,22 @@ id_connection = 56 # Integer | name = 'name_example' # String | name of account -balance = 3.4 # Float | balance of account - opts = { + balance: 3.4, # Float | balance of account number: 'number_example', # String | number of account iban: 'iban_example', # String | IBAN of account id_currency: 'id_currency_example', # String | the currency of the account (default: 'EUR') id_connection2: 56, # Integer | the connection to attach to the account expand: 'expand_example' # String | } begin #Create an account - result = api_instance.users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, balance, opts) + result = api_instance.users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, opts) p result rescue BudgeaClient::ApiError => e puts "Exception when calling BanksApi->users_id_user_connections_id_connection_accounts_post: #{e}" end ``` @@ -5511,11 +6042,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **id_connection** | **Integer**| | **name** | **String**| name of account | - **balance** | **Float**| balance of account | + **balance** | **Float**| balance of account | [optional] **number** | **String**| number of account | [optional] **iban** | **String**| IBAN of account | [optional] **id_currency** | **String**| the currency of the account (default: &#39;EUR&#39;) | [optional] **id_connection2** | **Integer**| the connection to attach to the account | [optional] **expand** | **String**| | [optional] @@ -5589,11 +6120,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_delete** @@ -5650,11 +6181,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_get** @@ -5711,11 +6242,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_informations_get** @@ -5772,17 +6303,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_logs_get** -> InlineResponse20017 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts) +> InlineResponse20015 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts) Get connection logs Get logs about connections.<br><br> @@ -5813,10 +6344,11 @@ period: 'period_example', # String | period to group logs id_user2: 56, # Integer | ID of a user id_connection2: 56, # Integer | ID of a connection id_connector: 56, # Integer | ID of a connector charged: true, # BOOLEAN | consider only logs for charged connectors + id_source: 56, # Integer | ID of a source expand: 'expand_example' # String | } begin #Get connection logs @@ -5841,23 +6373,24 @@ **period** | **String**| period to group logs | [optional] **id_user2** | **Integer**| ID of a user | [optional] **id_connection2** | **Integer**| ID of a connection | [optional] **id_connector** | **Integer**| ID of a connector | [optional] **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] + **id_source** | **Integer**| ID of a source | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20017**](InlineResponse20017.md) +[**InlineResponse20015**](InlineResponse20015.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_post** @@ -5985,15 +6518,268 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json +# **users_id_user_connections_id_connection_sources_get** +> InlineResponse20030 users_id_user_connections_id_connection_sources_get(id_user, id_connection, opts) + +Get connection sources + + + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' + +id_connection = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Get connection sources + result = api_instance.users_id_user_connections_id_connection_sources_get(id_user, id_connection, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->users_id_user_connections_id_connection_sources_get: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **id_connection** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**InlineResponse20030**](InlineResponse20030.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + +# **users_id_user_connections_id_connection_sources_id_source_delete** +> ConnectionSource users_id_user_connections_id_connection_sources_id_source_delete(id_user, id_connection, id_source, opts) + +Disable a connection source + +This will make it so the specified source will not be synchronized anymore.<br><br> + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' + +id_connection = 56 # Integer | + +id_source = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Disable a connection source + result = api_instance.users_id_user_connections_id_connection_sources_id_source_delete(id_user, id_connection, id_source, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->users_id_user_connections_id_connection_sources_id_source_delete: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **id_connection** | **Integer**| | + **id_source** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**ConnectionSource**](ConnectionSource.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + +# **users_id_user_connections_id_connection_sources_id_source_post** +> ConnectionSource users_id_user_connections_id_connection_sources_id_source_post(id_user, id_connection, id_source, opts) + +Enable connection source + +This will make it so the specified source will be able to be synchronized.<br><br> + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' + +id_connection = 56 # Integer | + +id_source = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Enable connection source + result = api_instance.users_id_user_connections_id_connection_sources_id_source_post(id_user, id_connection, id_source, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->users_id_user_connections_id_connection_sources_id_source_post: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **id_connection** | **Integer**| | + **id_source** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**ConnectionSource**](ConnectionSource.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + +# **users_id_user_connections_id_connection_sources_id_source_put** +> ConnectionSource users_id_user_connections_id_connection_sources_id_source_put(id_user, id_connection, id_source, opts) + +Enable connection source + +This will make it so the specified source will be able to be synchronized.<br><br> + +### Example +```ruby +# load the gem +require 'budgea_client' +# setup authorization +BudgeaClient.configure do |config| + # Configure API key authorization: api_key + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = BudgeaClient::BanksApi.new + +id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' + +id_connection = 56 # Integer | + +id_source = 56 # Integer | + +opts = { + expand: 'expand_example' # String | +} + +begin + #Enable connection source + result = api_instance.users_id_user_connections_id_connection_sources_id_source_put(id_user, id_connection, id_source, opts) + p result +rescue BudgeaClient::ApiError => e + puts "Exception when calling BanksApi->users_id_user_connections_id_connection_sources_id_source_put: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **id_connection** | **Integer**| | + **id_source** | **Integer**| | + **expand** | **String**| | [optional] + +### Return type + +[**ConnectionSource**](ConnectionSource.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: application/json, multipart/form-data + - **Accept**: application/json + + + # **users_id_user_connections_id_connection_transactions_delete** > Transaction users_id_user_connections_id_connection_transactions_delete(id_user, id_connection, opts) Delete transactions @@ -6046,17 +6832,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_get** -> InlineResponse20030 users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts) +> InlineResponse20031 users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -6125,19 +6911,19 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_informations_delete** @@ -6197,17 +6983,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_informations_get** -> InlineResponse20032 users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts) +> InlineResponse20033 users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -6253,19 +7039,19 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete** @@ -6328,11 +7114,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get** @@ -6395,11 +7181,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_informations_put** @@ -6459,11 +7245,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_id_transaction_put** @@ -6533,11 +7319,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactions_post** @@ -6617,17 +7403,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactionsclusters_get** -> InlineResponse20033 users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts) +> InlineResponse20034 users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts) Get clustered transactions @@ -6670,19 +7456,19 @@ **id_connection** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20033**](InlineResponse20033.md) +[**InlineResponse20034**](InlineResponse20034.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete** @@ -6742,11 +7528,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put** @@ -6806,11 +7592,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_id_connection_transactionsclusters_post** @@ -6867,11 +7653,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_connections_post** @@ -6896,10 +7682,11 @@ api_instance = BudgeaClient::BanksApi.new id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all' opts = { + source: 'source_example', # String | optional comma-separated list of sources to use for the connection synchronization id_connector: 56, # Integer | ID of the connector connector_uuid: 'connector_uuid_example', # String | optional uuid of the connector (replaces id_connector) birthday: 'birthday_example', # String | bank additional login parameter password: 'password_example', # String | bank additional login parameter oauth_token: 'oauth_token_example', # String | bank additional login parameter @@ -6908,10 +7695,12 @@ secret: 'secret_example', # String | bank additional login parameter type: 'type_example', # String | bank additional login parameter birthdate: 'birthdate_example', # String | bank additional login parameter nuser: 'nuser_example', # String | bank additional login parameter website: 'website_example', # String | bank additional login parameter + openapiwebsite: 'openapiwebsite_example', # String | bank additional login parameter + website2: 'website_example', # String | bank additional login parameter login: 'login_example', # String | bank additional login parameter id_provider: 56, # Integer | ID of the provider expand: 'expand_example' # String | } @@ -6927,10 +7716,11 @@ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | + **source** | **String**| optional comma-separated list of sources to use for the connection synchronization | [optional] **id_connector** | **Integer**| ID of the connector | [optional] **connector_uuid** | **String**| optional uuid of the connector (replaces id_connector) | [optional] **birthday** | **String**| bank additional login parameter | [optional] **password** | **String**| bank additional login parameter | [optional] **oauth_token** | **String**| bank additional login parameter | [optional] @@ -6939,10 +7729,12 @@ **secret** | **String**| bank additional login parameter | [optional] **type** | **String**| bank additional login parameter | [optional] **birthdate** | **String**| bank additional login parameter | [optional] **nuser** | **String**| bank additional login parameter | [optional] **website** | **String**| bank additional login parameter | [optional] + **openapiwebsite** | **String**| bank additional login parameter | [optional] + **website2** | **String**| bank additional login parameter | [optional] **login** | **String**| bank additional login parameter | [optional] **id_provider** | **Integer**| ID of the provider | [optional] **expand** | **String**| | [optional] ### Return type @@ -7006,17 +7798,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_logs_get** -> InlineResponse20017 users_id_user_logs_get(id_user, opts) +> InlineResponse20015 users_id_user_logs_get(id_user, opts) Get connection logs Get logs about connections.<br><br> @@ -7045,10 +7837,11 @@ period: 'period_example', # String | period to group logs id_user2: 56, # Integer | ID of a user id_connection: 56, # Integer | ID of a connection id_connector: 56, # Integer | ID of a connector charged: true, # BOOLEAN | consider only logs for charged connectors + id_source: 56, # Integer | ID of a source expand: 'expand_example' # String | } begin #Get connection logs @@ -7072,23 +7865,24 @@ **period** | **String**| period to group logs | [optional] **id_user2** | **Integer**| ID of a user | [optional] **id_connection** | **Integer**| ID of a connection | [optional] **id_connector** | **Integer**| ID of a connector | [optional] **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional] + **id_source** | **Integer**| ID of a source | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20017**](InlineResponse20017.md) +[**InlineResponse20015**](InlineResponse20015.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_delete** @@ -7142,17 +7936,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_get** -> InlineResponse20030 users_id_user_transactions_get(id_user, opts) +> InlineResponse20031 users_id_user_transactions_get(id_user, opts) Get transactions Get list of transactions.<br><br>By default, it selects transactions for the last month. You can use \"min_date\" and \"max_date\" to change boundary dates.<br><br> @@ -7218,19 +8012,19 @@ **value** | **String**| \&quot;XX|-XX\&quot; or \&quot;±XX\&quot; | [optional] **expand** | **String**| | [optional] ### Return type -[**InlineResponse20030**](InlineResponse20030.md) +[**InlineResponse20031**](InlineResponse20031.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_id_transaction_informations_delete** @@ -7287,17 +8081,17 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_id_transaction_informations_get** -> InlineResponse20032 users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts) +> InlineResponse20033 users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts) List all arbitrary key-value pairs on a transaction @@ -7340,19 +8134,19 @@ **id_transaction** | **Integer**| | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20032**](InlineResponse20032.md) +[**InlineResponse20033**](InlineResponse20033.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_id_transaction_informations_id_information_delete** @@ -7412,11 +8206,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_id_transaction_informations_id_information_get** @@ -7476,11 +8270,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_id_transaction_informations_put** @@ -7537,11 +8331,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactions_id_transaction_put** @@ -7695,11 +8489,11 @@ - **Accept**: application/json # **users_id_user_transactionsclusters_get** -> InlineResponse20033 users_id_user_transactionsclusters_get(id_user, opts) +> InlineResponse20034 users_id_user_transactionsclusters_get(id_user, opts) Get clustered transactions @@ -7739,19 +8533,19 @@ **id_user** | **String**| Hint: you can use &#39;me&#39; or &#39;all&#39; | **expand** | **String**| | [optional] ### Return type -[**InlineResponse20033**](InlineResponse20033.md) +[**InlineResponse20034**](InlineResponse20034.md) ### Authorization [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactionsclusters_id_transactionscluster_delete** @@ -7808,11 +8602,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactionsclusters_id_transactionscluster_put** @@ -7869,11 +8663,11 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json # **users_id_user_transactionsclusters_post** @@ -7927,10 +8721,10 @@ [api_key](../README.md#api_key) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded + - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json