docs/BanksApi.md in budgea_client-1.4.4 vs docs/BanksApi.md in budgea_client-2.0.0
- old
+ new
@@ -8,33 +8,34 @@
[**account_types_id_account_type_get**](BanksApi.md#account_types_id_account_type_get) | **GET** /account_types/{id_account_type} | Get an account type
[**banks_categories_id_category_delete**](BanksApi.md#banks_categories_id_category_delete) | **DELETE** /banks/categories/{id_category} | Delete the supplied category
[**banks_categories_id_category_post**](BanksApi.md#banks_categories_id_category_post) | **POST** /banks/categories/{id_category} | Edit a bank categories
[**banks_categories_post**](BanksApi.md#banks_categories_post) | **POST** /banks/categories | Create bank categories
[**banks_get**](BanksApi.md#banks_get) | **GET** /banks | Get list of connectors
-[**banks_id_bank_connections_get**](BanksApi.md#banks_id_bank_connections_get) | **GET** /banks/{id_bank}/connections | Get a subset of id_connection with the largest diversity of account
-[**banks_id_bank_logos_get**](BanksApi.md#banks_id_bank_logos_get) | **GET** /banks/{id_bank}/logos | Get all links to the files associated with this bank.
-[**banks_id_bank_logos_main_get**](BanksApi.md#banks_id_bank_logos_main_get) | **GET** /banks/{id_bank}/logos/main | Get all links to the files associated with this bank.
-[**banks_id_bank_logos_thumbnail_get**](BanksApi.md#banks_id_bank_logos_thumbnail_get) | **GET** /banks/{id_bank}/logos/thumbnail | Get all links to the files associated with this bank.
+[**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.
[**categories_get**](BanksApi.md#categories_get) | **GET** /categories | Get all categories
[**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
[**connectors_get**](BanksApi.md#connectors_get) | **GET** /connectors | Get list of connectors
-[**connectors_id_bank_logos_get**](BanksApi.md#connectors_id_bank_logos_get) | **GET** /connectors/{id_bank}/logos | Get all links to the files associated with this bank.
-[**connectors_id_bank_logos_id_logo_delete**](BanksApi.md#connectors_id_bank_logos_id_logo_delete) | **DELETE** /connectors/{id_bank}/logos/{id_logo} | Delete a single Logo object.
-[**connectors_id_bank_logos_id_logo_put**](BanksApi.md#connectors_id_bank_logos_id_logo_put) | **PUT** /connectors/{id_bank}/logos/{id_logo} | Create or Update a Bank Logo.
-[**connectors_id_bank_logos_main_get**](BanksApi.md#connectors_id_bank_logos_main_get) | **GET** /connectors/{id_bank}/logos/main | Get all links to the files associated with this bank.
-[**connectors_id_bank_logos_post**](BanksApi.md#connectors_id_bank_logos_post) | **POST** /connectors/{id_bank}/logos | Create a Bank Logo
-[**connectors_id_bank_logos_put**](BanksApi.md#connectors_id_bank_logos_put) | **PUT** /connectors/{id_bank}/logos | Create or Update a Bank Logo
-[**connectors_id_bank_logos_thumbnail_get**](BanksApi.md#connectors_id_bank_logos_thumbnail_get) | **GET** /connectors/{id_bank}/logos/thumbnail | Get all links to the files associated with this bank.
-[**connectors_id_connector_put**](BanksApi.md#connectors_id_connector_put) | **PUT** /connectors/{id_connector} | Edit the provided bank
+[**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_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.
[**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_bank_logos_get**](BanksApi.md#providers_id_bank_logos_get) | **GET** /providers/{id_bank}/logos | Get all links to the files associated with this bank.
-[**providers_id_bank_logos_main_get**](BanksApi.md#providers_id_bank_logos_main_get) | **GET** /providers/{id_bank}/logos/main | Get all links to the files associated with this bank.
-[**providers_id_bank_logos_thumbnail_get**](BanksApi.md#providers_id_bank_logos_thumbnail_get) | **GET** /providers/{id_bank}/logos/thumbnail | Get all links to the files associated with this bank.
+[**providers_id_connector_connections_get**](BanksApi.md#providers_id_connector_connections_get) | **GET** /providers/{id_connector}/connections | Get a random subset of provider'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.
[**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
@@ -54,12 +55,16 @@
[**users_id_user_accounts_id_account_transactionsclusters_get**](BanksApi.md#users_id_user_accounts_id_account_transactionsclusters_get) | **GET** /users/{id_user}/accounts/{id_account}/transactionsclusters | Get clustered transactions
[**users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete**](BanksApi.md#users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster} | Delete a clustered transaction
[**users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put**](BanksApi.md#users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put) | **PUT** /users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactionscluster} | Edit a clustered transaction
[**users_id_user_accounts_id_account_transactionsclusters_post**](BanksApi.md#users_id_user_accounts_id_account_transactionsclusters_post) | **POST** /users/{id_user}/accounts/{id_account}/transactionsclusters | Create clustered transaction
[**users_id_user_accounts_post**](BanksApi.md#users_id_user_accounts_post) | **POST** /users/{id_user}/accounts | Create an account
+[**users_id_user_accounts_put**](BanksApi.md#users_id_user_accounts_put) | **PUT** /users/{id_user}/accounts | Update many accounts at once
[**users_id_user_alerts_get**](BanksApi.md#users_id_user_alerts_get) | **GET** /users/{id_user}/alerts | Get alerts
[**users_id_user_categories_full_get**](BanksApi.md#users_id_user_categories_full_get) | **GET** /users/{id_user}/categories/full | Get the category
+[**users_id_user_categories_full_id_full_delete**](BanksApi.md#users_id_user_categories_full_id_full_delete) | **DELETE** /users/{id_user}/categories/full/{id_full} | Delete a user-created transaction category
+[**users_id_user_categories_full_id_full_put**](BanksApi.md#users_id_user_categories_full_id_full_put) | **PUT** /users/{id_user}/categories/full/{id_full} | Modify a user-created category
+[**users_id_user_categories_full_post**](BanksApi.md#users_id_user_categories_full_post) | **POST** /users/{id_user}/categories/full | Create a new transaction category
[**users_id_user_categories_get**](BanksApi.md#users_id_user_categories_get) | **GET** /users/{id_user}/categories | Get the category
[**users_id_user_connections_delete**](BanksApi.md#users_id_user_connections_delete) | **DELETE** /users/{id_user}/connections | Delete all connections
[**users_id_user_connections_get**](BanksApi.md#users_id_user_connections_get) | **GET** /users/{id_user}/connections | Get connections
[**users_id_user_connections_id_connection_accounts_delete**](BanksApi.md#users_id_user_connections_id_connection_accounts_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts | Delete all accounts
[**users_id_user_connections_id_connection_accounts_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts | Get accounts list.
@@ -80,10 +85,11 @@
[**users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters | Get clustered transactions
[**users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster} | Delete a clustered transaction
[**users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put) | **PUT** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactionscluster} | Edit a clustered transaction
[**users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post**](BanksApi.md#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters | Create clustered transaction
[**users_id_user_connections_id_connection_accounts_post**](BanksApi.md#users_id_user_connections_id_connection_accounts_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts | Create an account
+[**users_id_user_connections_id_connection_accounts_put**](BanksApi.md#users_id_user_connections_id_connection_accounts_put) | **PUT** /users/{id_user}/connections/{id_connection}/accounts | Update many accounts at once
[**users_id_user_connections_id_connection_delete**](BanksApi.md#users_id_user_connections_id_connection_delete) | **DELETE** /users/{id_user}/connections/{id_connection} | Delete a 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.
@@ -138,11 +144,11 @@
end
api_instance = BudgeaClient::BanksApi.new
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get account types
result = api_instance.account_types_get(opts)
@@ -195,11 +201,11 @@
api_instance = BudgeaClient::BanksApi.new
id_account_type = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get an account type
result = api_instance.account_types_id_account_type_get(id_account_type, opts)
@@ -230,11 +236,11 @@
- **Accept**: application/json
# **banks_categories_id_category_delete**
-> BankCategory banks_categories_id_category_delete(id_category, opts)
+> ConnectorCategory banks_categories_id_category_delete(id_category, opts)
Delete the supplied category
@@ -253,11 +259,11 @@
api_instance = BudgeaClient::BanksApi.new
id_category = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete the supplied category
result = api_instance.banks_categories_id_category_delete(id_category, opts)
@@ -274,11 +280,11 @@
**id_category** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**BankCategory**](BankCategory.md)
+[**ConnectorCategory**](ConnectorCategory.md)
### Authorization
[api_key](../README.md#api_key)
@@ -288,11 +294,11 @@
- **Accept**: application/json
# **banks_categories_id_category_post**
-> BankCategory banks_categories_id_category_post(id_category, name, opts)
+> ConnectorCategory banks_categories_id_category_post(id_category, name, opts)
Edit a bank categories
Edit the name for the supplied category.<br><br>
@@ -310,14 +316,14 @@
api_instance = BudgeaClient::BanksApi.new
id_category = 56 # Integer |
-name = "name_example" # String | new name for the supplied category
+name = 'name_example' # String | new name for the supplied category
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a bank categories
result = api_instance.banks_categories_id_category_post(id_category, name, opts)
@@ -335,11 +341,11 @@
**name** | **String**| new name for the supplied category |
**expand** | **String**| | [optional]
### Return type
-[**BankCategory**](BankCategory.md)
+[**ConnectorCategory**](ConnectorCategory.md)
### Authorization
[api_key](../README.md#api_key)
@@ -349,11 +355,11 @@
- **Accept**: application/json
# **banks_categories_post**
-> BankCategory banks_categories_post(name, opts)
+> ConnectorCategory banks_categories_post(name, opts)
Create bank categories
It requires the name of the category to be created<br><br>
@@ -369,14 +375,14 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-name = "name_example" # String | name of the category to be created
+name = 'name_example' # String | name of the category to be created
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create bank categories
result = api_instance.banks_categories_post(name, opts)
@@ -393,11 +399,11 @@
**name** | **String**| name of the category to be created |
**expand** | **String**| | [optional]
### Return type
-[**BankCategory**](BankCategory.md)
+[**ConnectorCategory**](ConnectorCategory.md)
### Authorization
[api_key](../README.md#api_key)
@@ -407,11 +413,11 @@
- **Accept**: application/json
# **banks_get**
-> InlineResponse2007 banks_get(opts)
+> InlineResponse2008 banks_get(opts)
Get list of connectors
@@ -428,11 +434,11 @@
end
api_instance = BudgeaClient::BanksApi.new
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get list of connectors
result = api_instance.banks_get(opts)
@@ -448,11 +454,11 @@
------------- | ------------- | ------------- | -------------
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2007**](InlineResponse2007.md)
+[**InlineResponse2008**](InlineResponse2008.md)
### Authorization
[api_key](../README.md#api_key)
@@ -461,12 +467,12 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **banks_id_bank_connections_get**
-> InlineResponse2008 banks_id_bank_connections_get(id_bank, opts)
+# **banks_id_connector_connections_get**
+> InlineResponse2009 banks_id_connector_connections_get(id_connector, opts)
Get a subset of id_connection with the largest diversity of account
By default, it selects a set of 3 connections.<br><br>
@@ -482,39 +488,39 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
range: 56, # Integer | the length of the connection subset
type: 56, # Integer | to target a specific account type which will be
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get a subset of id_connection with the largest diversity of account
- result = api_instance.banks_id_bank_connections_get(id_bank, opts)
+ result = api_instance.banks_id_connector_connections_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->banks_id_bank_connections_get: #{e}"
+ puts "Exception when calling BanksApi->banks_id_connector_connections_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**range** | **Integer**| the length of the connection subset | [optional]
**type** | **Integer**| to target a specific account type which will be | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2008**](InlineResponse2008.md)
+[**InlineResponse2009**](InlineResponse2009.md)
### Authorization
[api_key](../README.md#api_key)
@@ -523,16 +529,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **banks_id_bank_logos_get**
-> InlineResponse2009 banks_id_bank_logos_get(id_bank, opts)
+# **banks_id_connector_logos_get**
+> InlineResponse20010 banks_id_connector_logos_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -544,35 +550,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.banks_id_bank_logos_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.banks_id_connector_logos_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->banks_id_bank_logos_get: #{e}"
+ puts "Exception when calling BanksApi->banks_id_connector_logos_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -581,16 +587,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **banks_id_bank_logos_main_get**
-> InlineResponse2009 banks_id_bank_logos_main_get(id_bank, opts)
+# **banks_id_connector_logos_main_get**
+> InlineResponse20010 banks_id_connector_logos_main_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -602,35 +608,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.banks_id_bank_logos_main_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.banks_id_connector_logos_main_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->banks_id_bank_logos_main_get: #{e}"
+ puts "Exception when calling BanksApi->banks_id_connector_logos_main_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -639,16 +645,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **banks_id_bank_logos_thumbnail_get**
-> InlineResponse2009 banks_id_bank_logos_thumbnail_get(id_bank, opts)
+# **banks_id_connector_logos_thumbnail_get**
+> InlineResponse20010 banks_id_connector_logos_thumbnail_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -660,35 +666,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.banks_id_bank_logos_thumbnail_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.banks_id_connector_logos_thumbnail_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->banks_id_bank_logos_thumbnail_get: #{e}"
+ puts "Exception when calling BanksApi->banks_id_connector_logos_thumbnail_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -698,11 +704,11 @@
- **Accept**: application/json
# **categories_get**
-> InlineResponse20010 categories_get(opts)
+> InlineResponse20011 categories_get(opts)
Get all categories
Ressource to get all existing categories<br><br>
@@ -719,11 +725,11 @@
end
api_instance = BudgeaClient::BanksApi.new
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get all categories
result = api_instance.categories_get(opts)
@@ -739,11 +745,11 @@
------------- | ------------- | ------------- | -------------
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20010**](InlineResponse20010.md)
+[**InlineResponse20011**](InlineResponse20011.md)
### Authorization
[api_key](../README.md#api_key)
@@ -773,15 +779,15 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-wording = "wording_example" # String | label of the transaction
+wording = 'wording_example' # String | label of the transaction
-value = 56 # Integer | vallue of the transaction
+value = 56 # Integer | value of the transaction
-type = "type_example" # String | type of the transaction (default: unknown)
+type = 'type_example' # String | type of the transaction (default: unknown)
begin
#categorize transactions without storing them
result = api_instance.categorize_post(wording, value, type)
@@ -794,11 +800,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**wording** | **String**| label of the transaction |
- **value** | **Integer**| vallue of the transaction |
+ **value** | **Integer**| value of the transaction |
**type** | **String**| type of the transaction (default: unknown) |
### Return type
**Object**
@@ -813,11 +819,11 @@
- **Accept**: application/json
# **connections_get**
-> InlineResponse2008 connections_get(opts)
+> InlineResponse2009 connections_get(opts)
Get connections without a user
@@ -834,11 +840,11 @@
end
api_instance = BudgeaClient::BanksApi.new
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get connections without a user
result = api_instance.connections_get(opts)
@@ -854,11 +860,11 @@
------------- | ------------- | ------------- | -------------
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2008**](InlineResponse2008.md)
+[**InlineResponse2009**](InlineResponse2009.md)
### Authorization
[api_key](../README.md#api_key)
@@ -868,11 +874,11 @@
- **Accept**: application/json
# **connectors_get**
-> InlineResponse20012 connectors_get(opts)
+> InlineResponse20013 connectors_get(opts)
Get list of connectors
@@ -889,11 +895,11 @@
end
api_instance = BudgeaClient::BanksApi.new
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get list of connectors
result = api_instance.connectors_get(opts)
@@ -909,11 +915,11 @@
------------- | ------------- | ------------- | -------------
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20012**](InlineResponse20012.md)
+[**InlineResponse20013**](InlineResponse20013.md)
### Authorization
[api_key](../README.md#api_key)
@@ -922,16 +928,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_get**
-> InlineResponse2009 connectors_id_bank_logos_get(id_bank, opts)
+# **connectors_id_connector_logos_get**
+> InlineResponse20010 connectors_id_connector_logos_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -943,35 +949,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.connectors_id_bank_logos_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.connectors_id_connector_logos_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_get: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -980,12 +986,12 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_id_logo_delete**
-> ConnectorLogo connectors_id_bank_logos_id_logo_delete(id_bank, id_logo, opts)
+# **connectors_id_connector_logos_id_logo_delete**
+> ConnectorLogo connectors_id_connector_logos_id_logo_delete(id_connector, id_logo, opts)
Delete a single Logo object.
@@ -1001,32 +1007,32 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
id_logo = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a single Logo object.
- result = api_instance.connectors_id_bank_logos_id_logo_delete(id_bank, id_logo, opts)
+ result = api_instance.connectors_id_connector_logos_id_logo_delete(id_connector, id_logo, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_id_logo_delete: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_id_logo_delete: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**id_logo** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
@@ -1041,16 +1047,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_id_logo_put**
-> ConnectorLogo connectors_id_bank_logos_id_logo_put(id_bank, id_logo, opts)
+# **connectors_id_connector_logos_id_logo_put**
+> ConnectorLogo connectors_id_connector_logos_id_logo_put(id_connector, id_logo, opts)
-Create or Update a Bank Logo.
+Create or Update a connector Logo.
-This endpoint creates or update a bank logo. This logo is a mapping between a file (/file route) and a bank (/banks route) or a provider (/providers route).<br><br>Form params: - id_file (integer): The id of the file to link with that bank.<br><br>
+This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).<br><br>Form params: - id_file (integer): The id of the file to link with that connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1062,32 +1068,32 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
id_logo = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Create or Update a Bank Logo.
- result = api_instance.connectors_id_bank_logos_id_logo_put(id_bank, id_logo, opts)
+ #Create or Update a connector Logo.
+ result = api_instance.connectors_id_connector_logos_id_logo_put(id_connector, id_logo, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_id_logo_put: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_id_logo_put: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**id_logo** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
@@ -1102,16 +1108,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_main_get**
-> InlineResponse2009 connectors_id_bank_logos_main_get(id_bank, opts)
+# **connectors_id_connector_logos_main_get**
+> InlineResponse20010 connectors_id_connector_logos_main_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1123,35 +1129,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.connectors_id_bank_logos_main_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.connectors_id_connector_logos_main_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_main_get: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_main_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1160,16 +1166,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_post**
-> ConnectorLogo connectors_id_bank_logos_post(id_bank, opts)
+# **connectors_id_connector_logos_post**
+> ConnectorLogo connectors_id_connector_logos_post(id_connector, opts)
-Create a Bank Logo
+Create a connector Logo
-This endpoint creates a bank logo. You can either pass a file to as a parameter to insert and link it with the bank or pass an id_file to link a bank with an existing file. Will fail if the file is already linked with that bank.<br><br>Form params: - id_file (integer): The id of the file to link with that bank. - img (string): Path to the image to link with that bank.<br><br>
+This endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a connector with an existing file. Will fail if the file is already linked with that connector.<br><br>Form params: - id_file (integer): The id of the file to link with that connector. - img (string): Path to the image to link with that connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1181,30 +1187,30 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Create a Bank Logo
- result = api_instance.connectors_id_bank_logos_post(id_bank, opts)
+ #Create a connector Logo
+ result = api_instance.connectors_id_connector_logos_post(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_post: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_post: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
[**ConnectorLogo**](ConnectorLogo.md)
@@ -1218,16 +1224,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_put**
-> ConnectorLogo connectors_id_bank_logos_put(id_bank, opts)
+# **connectors_id_connector_logos_put**
+> ConnectorLogo connectors_id_connector_logos_put(id_connector, opts)
-Create or Update a Bank Logo
+Create or Update a connector Logo
-This endpoint creates or update a bank logo. This logo is a mapping between a file (/file route) and a bank (/banks route) or a provider (/providers route).<br><br>Form params: - id_file (integer): The id of the file to link with that bank.<br><br>
+This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).<br><br>Form params: - id_file (integer): The id of the file to link with that connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1239,30 +1245,30 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Create or Update a Bank Logo
- result = api_instance.connectors_id_bank_logos_put(id_bank, opts)
+ #Create or Update a connector Logo
+ result = api_instance.connectors_id_connector_logos_put(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_put: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_put: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
[**ConnectorLogo**](ConnectorLogo.md)
@@ -1276,16 +1282,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **connectors_id_bank_logos_thumbnail_get**
-> InlineResponse2009 connectors_id_bank_logos_thumbnail_get(id_bank, opts)
+# **connectors_id_connector_logos_thumbnail_get**
+> InlineResponse20010 connectors_id_connector_logos_thumbnail_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1297,35 +1303,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.connectors_id_bank_logos_thumbnail_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.connectors_id_connector_logos_thumbnail_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->connectors_id_bank_logos_thumbnail_get: #{e}"
+ puts "Exception when calling BanksApi->connectors_id_connector_logos_thumbnail_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1335,13 +1341,13 @@
- **Accept**: application/json
# **connectors_id_connector_put**
-> Bank connectors_id_connector_put(id_connector, opts)
+> Connector connectors_id_connector_put(id_connector, opts)
-Edit the provided bank
+Edit the provided connector
<br><br>
### Example
```ruby
@@ -1358,18 +1364,18 @@
api_instance = BudgeaClient::BanksApi.new
id_connector = 56 # Integer |
opts = {
- id_categories: "id_categories_example", # String | one or several comma separated categories to map to the given bank (or null to map no category)
+ 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
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Edit the provided bank
+ #Edit the provided connector
result = api_instance.connectors_id_connector_put(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
puts "Exception when calling BanksApi->connectors_id_connector_put: #{e}"
end
@@ -1378,18 +1384,18 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id_connector** | **Integer**| |
- **id_categories** | **String**| one or several comma separated categories to map to the given bank (or null to map no category) | [optional]
+ **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]
**expand** | **String**| | [optional]
### Return type
-[**Bank**](Bank.md)
+[**Connector**](Connector.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1399,11 +1405,11 @@
- **Accept**: application/json
# **connectors_post**
-> Bank connectors_post(name, login, password, opts)
+> Connector connectors_post(name, login, password, opts)
Request a new connector
Send a request to add a new connector<br><br>
@@ -1419,24 +1425,24 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-name = "name_example" # String | Name of the bank or provider
+name = 'name_example' # String | Name of the bank or provider
-login = "login_example" # String | Users login
+login = 'login_example' # String | Users login
-password = "password_example" # String | Users password
+password = 'password_example' # String | Users password
opts = {
- api: "api_example", # String | Name of the API
- url: "url_example", # String | Url of the bank
- email: "email_example", # String | Email of the user
- types: "types_example", # String | Type of connector, eg. banks or providers
- comment: "comment_example", # String | Optionnal comment
+ api: 'api_example', # String | Name of the API
+ url: 'url_example', # String | Url of the bank
+ email: 'email_example', # String | Email of the user
+ types: 'types_example', # String | Type of connector, eg. banks or providers
+ comment: 'comment_example', # String | Optionnal comment
sendmail: true, # BOOLEAN | if set, send an email to user
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Request a new connector
result = api_instance.connectors_post(name, login, password, opts)
@@ -1461,19 +1467,19 @@
**sendmail** | **BOOLEAN**| if set, send an email to user | [optional]
**expand** | **String**| | [optional]
### Return type
-[**Bank**](Bank.md)
+[**Connector**](Connector.md)
### Authorization
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
# **invoicing_get**
@@ -1496,14 +1502,14 @@
end
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
+ 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
}
begin
#Get number of accounts, connections and users synced.
api_instance.invoicing_get(opts)
@@ -1535,11 +1541,11 @@
- **Accept**: application/json
# **logs_get**
-> InlineResponse20015 logs_get(opts)
+> InlineResponse20016 logs_get(opts)
Get connection logs
Get logs about connections.<br><br>
@@ -1558,19 +1564,19 @@
api_instance = BudgeaClient::BanksApi.new
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
+ 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
+ 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_bank: 56, # Integer | ID of a bank
- charged: true, # BOOLEAN | consider only logs for charged banks
- expand: "expand_example" # String |
+ id_connector: 56, # Integer | ID of a connector
+ charged: true, # BOOLEAN | consider only logs for charged connectors
+ expand: 'expand_example' # String |
}
begin
#Get connection logs
result = api_instance.logs_get(opts)
@@ -1590,17 +1596,17 @@
**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_connection** | **Integer**| ID of a connection | [optional]
- **id_bank** | **Integer**| ID of a bank | [optional]
- **charged** | **BOOLEAN**| consider only logs for charged banks | [optional]
+ **id_connector** | **Integer**| ID of a connector | [optional]
+ **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20015**](InlineResponse20015.md)
+[**InlineResponse20016**](InlineResponse20016.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1610,11 +1616,11 @@
- **Accept**: application/json
# **providers_get**
-> InlineResponse2007 providers_get(opts)
+> InlineResponse20017 providers_get(opts)
Get list of connectors
@@ -1631,11 +1637,11 @@
end
api_instance = BudgeaClient::BanksApi.new
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get list of connectors
result = api_instance.providers_get(opts)
@@ -1651,11 +1657,11 @@
------------- | ------------- | ------------- | -------------
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2007**](InlineResponse2007.md)
+[**InlineResponse20017**](InlineResponse20017.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1664,16 +1670,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **providers_id_bank_logos_get**
-> InlineResponse2009 providers_id_bank_logos_get(id_bank, opts)
+# **providers_id_connector_connections_get**
+> InlineResponse2009 providers_id_connector_connections_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get a random subset of provider's id_connection
-This endpoint returns all links to files associated with this bank.<br><br>
+By default, it selects a set of 3 connections.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1685,30 +1691,32 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ range: 56, # Integer | the length of the connection subset
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.providers_id_bank_logos_get(id_bank, opts)
+ #Get a random subset of provider's id_connection
+ result = api_instance.providers_id_connector_connections_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->providers_id_bank_logos_get: #{e}"
+ puts "Exception when calling BanksApi->providers_id_connector_connections_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
+ **range** | **Integer**| the length of the connection subset | [optional]
**expand** | **String**| | [optional]
### Return type
[**InlineResponse2009**](InlineResponse2009.md)
@@ -1722,16 +1730,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **providers_id_bank_logos_main_get**
-> InlineResponse2009 providers_id_bank_logos_main_get(id_bank, opts)
+# **providers_id_connector_logos_get**
+> InlineResponse20010 providers_id_connector_logos_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1743,35 +1751,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.providers_id_bank_logos_main_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.providers_id_connector_logos_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->providers_id_bank_logos_main_get: #{e}"
+ puts "Exception when calling BanksApi->providers_id_connector_logos_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1780,16 +1788,16 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
-# **providers_id_bank_logos_thumbnail_get**
-> InlineResponse2009 providers_id_bank_logos_thumbnail_get(id_bank, opts)
+# **providers_id_connector_logos_main_get**
+> InlineResponse20010 providers_id_connector_logos_main_get(id_connector, opts)
-Get all links to the files associated with this bank.
+Get all links to the files associated with this connector.
-This endpoint returns all links to files associated with this bank.<br><br>
+This endpoint returns all links to files associated with this connector.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -1801,35 +1809,35 @@
#config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = BudgeaClient::BanksApi.new
-id_bank = 56 # Integer |
+id_connector = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
- #Get all links to the files associated with this bank.
- result = api_instance.providers_id_bank_logos_thumbnail_get(id_bank, opts)
+ #Get all links to the files associated with this connector.
+ result = api_instance.providers_id_connector_logos_main_get(id_connector, opts)
p result
rescue BudgeaClient::ApiError => e
- puts "Exception when calling BanksApi->providers_id_bank_logos_thumbnail_get: #{e}"
+ puts "Exception when calling BanksApi->providers_id_connector_logos_main_get: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
- **id_bank** | **Integer**| |
+ **id_connector** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20010**](InlineResponse20010.md)
### Authorization
[api_key](../README.md#api_key)
@@ -1838,10 +1846,68 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
+# **providers_id_connector_logos_thumbnail_get**
+> InlineResponse20010 providers_id_connector_logos_thumbnail_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>
+
+### 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 all links to the files associated with this connector.
+ result = api_instance.providers_id_connector_logos_thumbnail_get(id_connector, opts)
+ p result
+rescue BudgeaClient::ApiError => e
+ puts "Exception when calling BanksApi->providers_id_connector_logos_thumbnail_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id_connector** | **Integer**| |
+ **expand** | **String**| | [optional]
+
+### Return type
+
+[**InlineResponse20010**](InlineResponse20010.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
@@ -1859,14 +1925,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get account types
result = api_instance.users_id_user_account_types_get(id_user, opts)
@@ -1917,16 +1983,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account_type = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get an account type
result = api_instance.users_id_user_account_types_id_account_type_get(id_user, id_account_type, opts)
@@ -1978,14 +2044,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all accounts
result = api_instance.users_id_user_accounts_delete(id_user, opts)
@@ -2016,11 +2082,11 @@
- **Accept**: application/json
# **users_id_user_accounts_get**
-> InlineResponse20018 users_id_user_accounts_get(id_user, opts)
+> InlineResponse20020 users_id_user_accounts_get(id_user, opts)
Get accounts list.
@@ -2036,14 +2102,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get accounts list.
result = api_instance.users_id_user_accounts_get(id_user, opts)
@@ -2060,11 +2126,11 @@
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20018**](InlineResponse20018.md)
+[**InlineResponse20020**](InlineResponse20020.md)
### Authorization
[api_key](../README.md#api_key)
@@ -2094,11 +2160,11 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
begin
@@ -2134,11 +2200,11 @@
# **users_id_user_accounts_id_account_delete**
> Account users_id_user_accounts_id_account_delete(id_user, id_account, opts)
Delete an account.
-It deletes a specific account. If this is the last synced account of a connection, it will be removed too.<br><br>
+It deletes a specific account.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -2150,16 +2216,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete an account.
result = api_instance.users_id_user_accounts_id_account_delete(id_user, id_account, opts)
@@ -2211,18 +2277,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
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
+ 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
}
begin
#Get deltas of accounts
api_instance.users_id_user_accounts_id_account_delta_get(id_user, id_account, opts)
@@ -2255,11 +2321,11 @@
- **Accept**: application/json
# **users_id_user_accounts_id_account_logs_get**
-> InlineResponse20021 users_id_user_accounts_id_account_logs_get(id_user, id_account, opts)
+> InlineResponse20023 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>
@@ -2275,20 +2341,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 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 (inclusive) date
- max_date: Date.parse("2013-10-20"), # Date | maximum (inclusive) date
- expand: "expand_example" # String |
+ min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
+ max_date: Date.parse('2013-10-20'), # Date | maximum (inclusive) date
+ expand: 'expand_example' # String |
}
begin
#Get accounts logs.
result = api_instance.users_id_user_accounts_id_account_logs_get(id_user, id_account, opts)
@@ -2310,11 +2376,11 @@
**max_date** | **Date**| maximum (inclusive) date | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20021**](InlineResponse20021.md)
+[**InlineResponse20023**](InlineResponse20023.md)
### Authorization
[api_key](../README.md#api_key)
@@ -2344,22 +2410,23 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
opts = {
display: true, # BOOLEAN | If the account is displayed
- name: "name_example", # String | Label of the account
+ name: 'name_example', # String | Label of the account
balance: 3.4, # Float | Balance of the account
disabled: true, # BOOLEAN | If the account is disabled (not synchronized)
- iban: "iban_example", # String | IBAN of the account
+ iban: 'iban_example', # String | IBAN of the account
bookmarked: true, # BOOLEAN | If the account is bookmarked
- expand: "expand_example" # String |
+ usage: 'usage_example', # String | Usage of the account : PRIV, ORGA or ASSO
+ expand: 'expand_example' # String |
}
begin
#Update an account
result = api_instance.users_id_user_accounts_id_account_put(id_user, id_account, opts)
@@ -2379,10 +2446,11 @@
**name** | **String**| Label of the account | [optional]
**balance** | **Float**| Balance of the account | [optional]
**disabled** | **BOOLEAN**| If the account is disabled (not synchronized) | [optional]
**iban** | **String**| IBAN of the account | [optional]
**bookmarked** | **BOOLEAN**| If the account is bookmarked | [optional]
+ **usage** | **String**| Usage of the account : PRIV, ORGA or ASSO | [optional]
**expand** | **String**| | [optional]
### Return type
[**Account**](Account.md)
@@ -2417,16 +2485,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete transactions
result = api_instance.users_id_user_accounts_id_account_transactions_delete(id_user, id_account, opts)
@@ -2458,11 +2526,11 @@
- **Accept**: application/json
# **users_id_user_accounts_id_account_transactions_get**
-> InlineResponse20025 users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts)
+> InlineResponse20027 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>
@@ -2478,29 +2546,29 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 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 (inclusive) date
- max_date: Date.parse("2013-10-20"), # Date | maximum (inclusive) date
+ min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
+ max_date: Date.parse('2013-10-20'), # Date | maximum (inclusive) date
income: true, # BOOLEAN | filter on income or expenditures
deleted: true, # BOOLEAN | display only deleted transactions
all: true, # BOOLEAN | display all transactions, including deleted ones
- last_update: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | get only transactions updated after the specified datetime
- wording: "wording_example", # String | filter transactions containing the given string
+ last_update: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | get only transactions updated after the specified datetime
+ wording: 'wording_example', # String | filter transactions containing the given string
min_value: 3.4, # Float | minimal (inclusive) value
max_value: 3.4, # Float | maximum (inclusive) value
- search: "search_example", # String | search in labels, dates, values and categories
- value: "value_example", # String | \"XX|-XX\" or \"±XX\"
- expand: "expand_example" # String |
+ search: 'search_example', # String | search in labels, dates, values and categories
+ value: 'value_example', # String | \"XX|-XX\" or \"±XX\"
+ expand: 'expand_example' # String |
}
begin
#Get transactions
result = api_instance.users_id_user_accounts_id_account_transactions_get(id_user, id_account, opts)
@@ -2531,11 +2599,11 @@
**value** | **String**| \"XX|-XX\" or \"±XX\" | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20025**](InlineResponse20025.md)
+[**InlineResponse20027**](InlineResponse20027.md)
### Authorization
[api_key](../README.md#api_key)
@@ -2565,18 +2633,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all arbitrary key-value pairs of a transaction
result = api_instance.users_id_user_accounts_id_account_transactions_id_transaction_informations_delete(id_user, id_account, id_transaction, opts)
@@ -2609,11 +2677,11 @@
- **Accept**: application/json
# **users_id_user_accounts_id_account_transactions_id_transaction_informations_get**
-> InlineResponse20027 users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts)
+> InlineResponse20029 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
@@ -2629,18 +2697,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#List all arbitrary key-value pairs on a transaction
result = api_instance.users_id_user_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_account, id_transaction, opts)
@@ -2659,11 +2727,11 @@
**id_transaction** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20027**](InlineResponse20027.md)
+[**InlineResponse20029**](InlineResponse20029.md)
### Authorization
[api_key](../README.md#api_key)
@@ -2693,20 +2761,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a particular key-value pair on a transaction.
result = api_instance.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_delete(id_user, id_account, id_transaction, id_information, opts)
@@ -2760,20 +2828,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get a particular arbitrary key-value pair on a transaction
result = api_instance.users_id_user_accounts_id_account_transactions_id_transaction_informations_id_information_get(id_user, id_account, id_transaction, id_information, opts)
@@ -2827,18 +2895,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Add or edit transaction arbitrary key-value pairs
result = api_instance.users_id_user_accounts_id_account_transactions_id_transaction_informations_put(id_user, id_account, id_transaction, opts)
@@ -2891,23 +2959,23 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- wording: "wording_example", # String | user rewording of the transaction
- application_date: Date.parse("2013-10-20"), # Date | change application date of the transaction
+ wording: 'wording_example', # String | user rewording of the transaction
+ application_date: Date.parse('2013-10-20'), # Date | change application date of the transaction
id_category: 56, # Integer | ID of the associated category
- comment: "comment_example", # String | change comment
+ comment: 'comment_example', # String | change comment
active: true, # BOOLEAN | if false, transaction isn't considered in analyzisis endpoints (like /balances)
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a transaction meta-data
result = api_instance.users_id_user_accounts_id_account_transactions_id_transaction_put(id_user, id_account, id_transaction, opts)
@@ -2965,29 +3033,29 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
-original_wording = "original_wording_example" # String | label of the transaction
+original_wording = 'original_wording_example' # String | label of the transaction
value = 56 # Integer | vallue of the transaction
-date = Date.parse("2013-10-20") # Date | date of the transaction
+date = Date.parse('2013-10-20') # Date | date of the transaction
opts = {
- type: "type_example", # String | type of the transaction (default: unknown)
- state: "state_example", # String | nature of the transaction (default: new)
- rdate: Date.parse("2013-10-20"), # Date | realisation date of the transaction (default: value of date)
+ type: 'type_example', # String | type of the transaction (default: unknown)
+ state: 'state_example', # String | nature of the transaction (default: new)
+ rdate: Date.parse('2013-10-20'), # Date | realisation date of the transaction (default: value of date)
coming: true, # BOOLEAN | 1 if the transaction has already been debited (default: 0)
active: true, # BOOLEAN | 1 if the transaction should be taken into account by pfm services (default: 1)
- date_scraped: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
+ date_scraped: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
id_account2: 56, # Integer | account of the transaction. If not supplied, it has to be given in the route
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create transactions
result = api_instance.users_id_user_accounts_id_account_transactions_post(id_user, id_account, original_wording, value, date, opts)
@@ -3029,11 +3097,11 @@
- **Accept**: application/json
# **users_id_user_accounts_id_account_transactionsclusters_get**
-> InlineResponse20028 users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts)
+> InlineResponse20030 users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts)
Get clustered transactions
@@ -3049,16 +3117,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get clustered transactions
result = api_instance.users_id_user_accounts_id_account_transactionsclusters_get(id_user, id_account, opts)
@@ -3076,11 +3144,11 @@
**id_account** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20028**](InlineResponse20028.md)
+[**InlineResponse20030**](InlineResponse20030.md)
### Authorization
[api_key](../README.md#api_key)
@@ -3110,18 +3178,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a clustered transaction
result = api_instance.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_delete(id_user, id_account, id_transactionscluster, opts)
@@ -3174,18 +3242,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a clustered transaction
result = api_instance.users_id_user_accounts_id_account_transactionsclusters_id_transactionscluster_put(id_user, id_account, id_transactionscluster, opts)
@@ -3238,16 +3306,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_account = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create clustered transaction
result = api_instance.users_id_user_accounts_id_account_transactionsclusters_post(id_user, id_account, opts)
@@ -3283,11 +3351,11 @@
# **users_id_user_accounts_post**
> Account users_id_user_accounts_post(id_user, name, balance, opts)
Create an account
-This endpoint creates an account not related to a connection.<br><br>
+This endpoint creates an account related to a connection or not.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -3299,21 +3367,22 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
-name = "name_example" # String | name of account
+name = 'name_example' # String | name of account
balance = 3.4 # Float | balance of account
opts = {
- 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')
- expand: "expand_example" # String |
+ 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)
@@ -3331,10 +3400,11 @@
**name** | **String**| name of account |
**balance** | **Float**| balance of account |
**number** | **String**| number of account | [optional]
**iban** | **String**| IBAN of account | [optional]
**id_currency** | **String**| the currency of the account (default: 'EUR') | [optional]
+ **id_connection** | **Integer**| the connection to attach to the account | [optional]
**expand** | **String**| | [optional]
### Return type
[**Account**](Account.md)
@@ -3348,12 +3418,70 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
+# **users_id_user_accounts_put**
+> Account users_id_user_accounts_put(id_user, opts)
+
+Update many accounts at once
+
+
+
+### 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'
+
+opts = {
+ expand: 'expand_example' # String |
+}
+
+begin
+ #Update many accounts at once
+ result = api_instance.users_id_user_accounts_put(id_user, opts)
+ p result
+rescue BudgeaClient::ApiError => e
+ puts "Exception when calling BanksApi->users_id_user_accounts_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' |
+ **expand** | **String**| | [optional]
+
+### Return type
+
+[**Account**](Account.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
# **users_id_user_alerts_get**
-> InlineResponse20029 users_id_user_alerts_get(id_user, opts)
+> InlineResponse20031 users_id_user_alerts_get(id_user, opts)
Get alerts
@@ -3369,14 +3497,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get alerts
result = api_instance.users_id_user_alerts_get(id_user, opts)
@@ -3393,11 +3521,11 @@
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20029**](InlineResponse20029.md)
+[**InlineResponse20031**](InlineResponse20031.md)
### Authorization
[api_key](../README.md#api_key)
@@ -3407,11 +3535,11 @@
- **Accept**: application/json
# **users_id_user_categories_full_get**
-> InlineResponse20030 users_id_user_categories_full_get(id_user, opts)
+> InlineResponse20032 users_id_user_categories_full_get(id_user, opts)
Get the category
Ressource to get categories<br><br>
@@ -3427,14 +3555,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get the category
result = api_instance.users_id_user_categories_full_get(id_user, opts)
@@ -3451,11 +3579,11 @@
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20030**](InlineResponse20030.md)
+[**InlineResponse20032**](InlineResponse20032.md)
### Authorization
[api_key](../README.md#api_key)
@@ -3464,10 +3592,208 @@
- **Content-Type**: application/json, multipart/form-data
- **Accept**: application/json
+# **users_id_user_categories_full_id_full_delete**
+> Category users_id_user_categories_full_id_full_delete(id_user, id_full, opts)
+
+Delete a user-created transaction category
+
+
+
+### 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_full = 56 # Integer |
+
+opts = {
+ expand: 'expand_example' # String |
+}
+
+begin
+ #Delete a user-created transaction category
+ result = api_instance.users_id_user_categories_full_id_full_delete(id_user, id_full, opts)
+ p result
+rescue BudgeaClient::ApiError => e
+ puts "Exception when calling BanksApi->users_id_user_categories_full_id_full_delete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' |
+ **id_full** | **Integer**| |
+ **expand** | **String**| | [optional]
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **users_id_user_categories_full_id_full_put**
+> Category users_id_user_categories_full_id_full_put(id_user, id_full, opts)
+
+Modify a user-created category
+
+
+
+### 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_full = 56 # Integer |
+
+opts = {
+ hide: 'hide_example', # String | Hide (but not delete) a category. Must be 0, 1 or toggle.
+ accountant_account: 'accountant_account_example', # String | Accountant account number.
+ expand: 'expand_example' # String |
+}
+
+begin
+ #Modify a user-created category
+ result = api_instance.users_id_user_categories_full_id_full_put(id_user, id_full, opts)
+ p result
+rescue BudgeaClient::ApiError => e
+ puts "Exception when calling BanksApi->users_id_user_categories_full_id_full_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' |
+ **id_full** | **Integer**| |
+ **hide** | **String**| Hide (but not delete) a category. Must be 0, 1 or toggle. | [optional]
+ **accountant_account** | **String**| Accountant account number. | [optional]
+ **expand** | **String**| | [optional]
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **users_id_user_categories_full_post**
+> Category users_id_user_categories_full_post(id_user, opts)
+
+Create a new transaction category
+
+
+
+### 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'
+
+opts = {
+ name: 'name_example', # String | Name of the category.
+ id_parent_category: 56, # Integer | ID of the parent category.
+ id_parent_category_in_menu: 56, # Integer | ID of the parent category to be displayed.
+ color: 'color_example', # String | Color of the category.
+ income: true, # BOOLEAN | Is an income category. If null, this is both an income and an expense category.
+ refundable: true, # BOOLEAN | This category accepts opposite sign of transactions.
+ accountant_account: 'accountant_account_example', # String | Accountant account number.
+ expand: 'expand_example' # String |
+}
+
+begin
+ #Create a new transaction category
+ result = api_instance.users_id_user_categories_full_post(id_user, opts)
+ p result
+rescue BudgeaClient::ApiError => e
+ puts "Exception when calling BanksApi->users_id_user_categories_full_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' |
+ **name** | **String**| Name of the category. | [optional]
+ **id_parent_category** | **Integer**| ID of the parent category. | [optional]
+ **id_parent_category_in_menu** | **Integer**| ID of the parent category to be displayed. | [optional]
+ **color** | **String**| Color of the category. | [optional]
+ **income** | **BOOLEAN**| Is an income category. If null, this is both an income and an expense category. | [optional]
+ **refundable** | **BOOLEAN**| This category accepts opposite sign of transactions. | [optional]
+ **accountant_account** | **String**| Accountant account number. | [optional]
+ **expand** | **String**| | [optional]
+
+### Return type
+
+[**Category**](Category.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: application/json
+
+
+
# **users_id_user_categories_get**
> users_id_user_categories_get(id_user)
Get the category
@@ -3485,11 +3811,11 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
begin
#Get the category
api_instance.users_id_user_categories_get(id_user)
@@ -3538,14 +3864,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all connections
result = api_instance.users_id_user_connections_delete(id_user, opts)
@@ -3576,11 +3902,11 @@
- **Accept**: application/json
# **users_id_user_connections_get**
-> InlineResponse2008 users_id_user_connections_get(id_user, opts)
+> InlineResponse2009 users_id_user_connections_get(id_user, opts)
Get connections
@@ -3596,14 +3922,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get connections
result = api_instance.users_id_user_connections_get(id_user, opts)
@@ -3620,11 +3946,11 @@
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2008**](InlineResponse2008.md)
+[**InlineResponse2009**](InlineResponse2009.md)
### Authorization
[api_key](../README.md#api_key)
@@ -3654,16 +3980,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all accounts
result = api_instance.users_id_user_connections_id_connection_accounts_delete(id_user, id_connection, opts)
@@ -3695,11 +4021,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_accounts_get**
-> InlineResponse20018 users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts)
+> InlineResponse20020 users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts)
Get accounts list.
@@ -3715,16 +4041,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get accounts list.
result = api_instance.users_id_user_connections_id_connection_accounts_get(id_user, id_connection, opts)
@@ -3742,11 +4068,11 @@
**id_connection** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20018**](InlineResponse20018.md)
+[**InlineResponse20020**](InlineResponse20020.md)
### Authorization
[api_key](../README.md#api_key)
@@ -3776,11 +4102,11 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
@@ -3819,11 +4145,11 @@
# **users_id_user_connections_id_connection_accounts_id_account_delete**
> Account users_id_user_connections_id_connection_accounts_id_account_delete(id_user, id_connection, id_account, opts)
Delete an account.
-It deletes a specific account. If this is the last synced account of a connection, it will be removed too.<br><br>
+It deletes a specific account.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -3835,18 +4161,18 @@
#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_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 |
+ expand: 'expand_example' # String |
}
begin
#Delete an account.
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_delete(id_user, id_connection, id_account, opts)
@@ -3899,20 +4225,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
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
+ 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
}
begin
#Get deltas of accounts
api_instance.users_id_user_connections_id_connection_accounts_id_account_delta_get(id_user, id_connection, id_account, opts)
@@ -3946,11 +4272,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_accounts_id_account_logs_get**
-> InlineResponse20021 users_id_user_connections_id_connection_accounts_id_account_logs_get(id_user, id_connection, id_account, opts)
+> InlineResponse20023 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>
@@ -3966,22 +4292,22 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 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 (inclusive) date
- max_date: Date.parse("2013-10-20"), # Date | maximum (inclusive) date
- expand: "expand_example" # String |
+ min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
+ max_date: Date.parse('2013-10-20'), # Date | maximum (inclusive) date
+ expand: 'expand_example' # String |
}
begin
#Get accounts logs.
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_logs_get(id_user, id_connection, id_account, opts)
@@ -4004,11 +4330,11 @@
**max_date** | **Date**| maximum (inclusive) date | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20021**](InlineResponse20021.md)
+[**InlineResponse20023**](InlineResponse20023.md)
### Authorization
[api_key](../README.md#api_key)
@@ -4038,24 +4364,25 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
opts = {
display: true, # BOOLEAN | If the account is displayed
- name: "name_example", # String | Label of the account
+ name: 'name_example', # String | Label of the account
balance: 3.4, # Float | Balance of the account
disabled: true, # BOOLEAN | If the account is disabled (not synchronized)
- iban: "iban_example", # String | IBAN of the account
+ iban: 'iban_example', # String | IBAN of the account
bookmarked: true, # BOOLEAN | If the account is bookmarked
- expand: "expand_example" # String |
+ usage: 'usage_example', # String | Usage of the account : PRIV, ORGA or ASSO
+ expand: 'expand_example' # String |
}
begin
#Update an account
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_put(id_user, id_connection, id_account, opts)
@@ -4076,10 +4403,11 @@
**name** | **String**| Label of the account | [optional]
**balance** | **Float**| Balance of the account | [optional]
**disabled** | **BOOLEAN**| If the account is disabled (not synchronized) | [optional]
**iban** | **String**| IBAN of the account | [optional]
**bookmarked** | **BOOLEAN**| If the account is bookmarked | [optional]
+ **usage** | **String**| Usage of the account : PRIV, ORGA or ASSO | [optional]
**expand** | **String**| | [optional]
### Return type
[**Account**](Account.md)
@@ -4114,18 +4442,18 @@
#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_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 |
+ expand: 'expand_example' # String |
}
begin
#Delete transactions
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_delete(id_user, id_connection, id_account, opts)
@@ -4158,11 +4486,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_accounts_id_account_transactions_get**
-> InlineResponse20025 users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts)
+> InlineResponse20027 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>
@@ -4178,31 +4506,31 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 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 (inclusive) date
- max_date: Date.parse("2013-10-20"), # Date | maximum (inclusive) date
+ min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
+ max_date: Date.parse('2013-10-20'), # Date | maximum (inclusive) date
income: true, # BOOLEAN | filter on income or expenditures
deleted: true, # BOOLEAN | display only deleted transactions
all: true, # BOOLEAN | display all transactions, including deleted ones
- last_update: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | get only transactions updated after the specified datetime
- wording: "wording_example", # String | filter transactions containing the given string
+ last_update: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | get only transactions updated after the specified datetime
+ wording: 'wording_example', # String | filter transactions containing the given string
min_value: 3.4, # Float | minimal (inclusive) value
max_value: 3.4, # Float | maximum (inclusive) value
- search: "search_example", # String | search in labels, dates, values and categories
- value: "value_example", # String | \"XX|-XX\" or \"±XX\"
- expand: "expand_example" # String |
+ search: 'search_example', # String | search in labels, dates, values and categories
+ value: 'value_example', # String | \"XX|-XX\" or \"±XX\"
+ expand: 'expand_example' # String |
}
begin
#Get transactions
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_get(id_user, id_connection, id_account, opts)
@@ -4234,11 +4562,11 @@
**value** | **String**| \"XX|-XX\" or \"±XX\" | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20025**](InlineResponse20025.md)
+[**InlineResponse20027**](InlineResponse20027.md)
### Authorization
[api_key](../README.md#api_key)
@@ -4268,20 +4596,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all arbitrary key-value pairs of a transaction
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_delete(id_user, id_connection, id_account, id_transaction, opts)
@@ -4315,11 +4643,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get**
-> InlineResponse20027 users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts)
+> InlineResponse20029 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
@@ -4335,20 +4663,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#List all arbitrary key-value pairs on a transaction
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_get(id_user, id_connection, id_account, id_transaction, opts)
@@ -4368,11 +4696,11 @@
**id_transaction** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20027**](InlineResponse20027.md)
+[**InlineResponse20029**](InlineResponse20029.md)
### Authorization
[api_key](../README.md#api_key)
@@ -4402,22 +4730,22 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a particular key-value pair on a transaction.
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_delete(id_user, id_connection, id_account, id_transaction, id_information, opts)
@@ -4472,22 +4800,22 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get a particular arbitrary key-value pair on a transaction
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_id_information_get(id_user, id_connection, id_account, id_transaction, id_information, opts)
@@ -4542,20 +4870,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Add or edit transaction arbitrary key-value pairs
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_informations_put(id_user, id_connection, id_account, id_transaction, opts)
@@ -4609,25 +4937,25 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- wording: "wording_example", # String | user rewording of the transaction
- application_date: Date.parse("2013-10-20"), # Date | change application date of the transaction
+ wording: 'wording_example', # String | user rewording of the transaction
+ application_date: Date.parse('2013-10-20'), # Date | change application date of the transaction
id_category: 56, # Integer | ID of the associated category
- comment: "comment_example", # String | change comment
+ comment: 'comment_example', # String | change comment
active: true, # BOOLEAN | if false, transaction isn't considered in analyzisis endpoints (like /balances)
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a transaction meta-data
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_put(id_user, id_connection, id_account, id_transaction, opts)
@@ -4686,31 +5014,31 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
-original_wording = "original_wording_example" # String | label of the transaction
+original_wording = 'original_wording_example' # String | label of the transaction
value = 56 # Integer | vallue of the transaction
-date = Date.parse("2013-10-20") # Date | date of the transaction
+date = Date.parse('2013-10-20') # Date | date of the transaction
opts = {
- type: "type_example", # String | type of the transaction (default: unknown)
- state: "state_example", # String | nature of the transaction (default: new)
- rdate: Date.parse("2013-10-20"), # Date | realisation date of the transaction (default: value of date)
+ type: 'type_example', # String | type of the transaction (default: unknown)
+ state: 'state_example', # String | nature of the transaction (default: new)
+ rdate: Date.parse('2013-10-20'), # Date | realisation date of the transaction (default: value of date)
coming: true, # BOOLEAN | 1 if the transaction has already been debited (default: 0)
active: true, # BOOLEAN | 1 if the transaction should be taken into account by pfm services (default: 1)
- date_scraped: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
+ date_scraped: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
id_account2: 56, # Integer | account of the transaction. If not supplied, it has to be given in the route
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create transactions
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactions_post(id_user, id_connection, id_account, original_wording, value, date, opts)
@@ -4753,11 +5081,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get**
-> InlineResponse20028 users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts)
+> InlineResponse20030 users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts)
Get clustered transactions
@@ -4773,18 +5101,18 @@
#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_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 |
+ expand: 'expand_example' # String |
}
begin
#Get clustered transactions
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_get(id_user, id_connection, id_account, opts)
@@ -4803,11 +5131,11 @@
**id_account** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20028**](InlineResponse20028.md)
+[**InlineResponse20030**](InlineResponse20030.md)
### Authorization
[api_key](../README.md#api_key)
@@ -4837,20 +5165,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a clustered transaction
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_delete(id_user, id_connection, id_account, id_transactionscluster, opts)
@@ -4904,20 +5232,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_account = 56 # Integer |
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a clustered transaction
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactionscluster_put(id_user, id_connection, id_account, id_transactionscluster, opts)
@@ -4971,18 +5299,18 @@
#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_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 |
+ expand: 'expand_example' # String |
}
begin
#Create clustered transaction
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_post(id_user, id_connection, id_account, opts)
@@ -5019,11 +5347,11 @@
# **users_id_user_connections_id_connection_accounts_post**
> Account users_id_user_connections_id_connection_accounts_post(id_user, id_connection, name, balance, opts)
Create an account
-This endpoint creates an account not related to a connection.<br><br>
+This endpoint creates an account related to a connection or not.<br><br>
### Example
```ruby
# load the gem
require 'budgea_client'
@@ -5035,23 +5363,24 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
-name = "name_example" # String | name of account
+name = 'name_example' # String | name of account
balance = 3.4 # Float | balance of account
opts = {
- 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')
- expand: "expand_example" # String |
+ 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)
@@ -5070,10 +5399,11 @@
**name** | **String**| name of account |
**balance** | **Float**| balance of account |
**number** | **String**| number of account | [optional]
**iban** | **String**| IBAN of account | [optional]
**id_currency** | **String**| the currency of the account (default: 'EUR') | [optional]
+ **id_connection2** | **Integer**| the connection to attach to the account | [optional]
**expand** | **String**| | [optional]
### Return type
[**Account**](Account.md)
@@ -5082,15 +5412,76 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
+# **users_id_user_connections_id_connection_accounts_put**
+> Account users_id_user_connections_id_connection_accounts_put(id_user, id_connection, opts)
+
+Update many accounts at once
+
+
+
+### 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
+ #Update many accounts at once
+ result = api_instance.users_id_user_connections_id_connection_accounts_put(id_user, id_connection, opts)
+ p result
+rescue BudgeaClient::ApiError => e
+ puts "Exception when calling BanksApi->users_id_user_connections_id_connection_accounts_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **id_user** | **String**| Hint: you can use 'me' or 'all' |
+ **id_connection** | **Integer**| |
+ **expand** | **String**| | [optional]
+
+### Return type
+
+[**Account**](Account.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_delete**
> Connection users_id_user_connections_id_connection_delete(id_user, id_connection, opts)
Delete a connection.
@@ -5108,16 +5499,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a connection.
result = api_instance.users_id_user_connections_id_connection_delete(id_user, id_connection, opts)
@@ -5149,11 +5540,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_informations_get**
-> InlineResponse2008 users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts)
+> InlineResponse2009 users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts)
Get connection additionnal informations
<br><br>
@@ -5169,16 +5560,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get connection additionnal informations
result = api_instance.users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts)
@@ -5196,11 +5587,11 @@
**id_connection** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse2008**](InlineResponse2008.md)
+[**InlineResponse2009**](InlineResponse2009.md)
### Authorization
[api_key](../README.md#api_key)
@@ -5210,11 +5601,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_logs_get**
-> InlineResponse20015 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts)
+> InlineResponse20016 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts)
Get connection logs
Get logs about connections.<br><br>
@@ -5230,26 +5621,26 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
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
+ 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
+ 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_bank: 56, # Integer | ID of a bank
- charged: true, # BOOLEAN | consider only logs for charged banks
- expand: "expand_example" # String |
+ id_connector: 56, # Integer | ID of a connector
+ charged: true, # BOOLEAN | consider only logs for charged connectors
+ expand: 'expand_example' # String |
}
begin
#Get connection logs
result = api_instance.users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts)
@@ -5271,17 +5662,17 @@
**max_date** | **Date**| maximum date | [optional]
**state** | **Integer**| state of user | [optional]
**period** | **String**| period to group logs | [optional]
**id_user2** | **Integer**| ID of a user | [optional]
**id_connection2** | **Integer**| ID of a connection | [optional]
- **id_bank** | **Integer**| ID of a bank | [optional]
- **charged** | **BOOLEAN**| consider only logs for charged banks | [optional]
+ **id_connector** | **Integer**| ID of a connector | [optional]
+ **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20015**](InlineResponse20015.md)
+[**InlineResponse20016**](InlineResponse20016.md)
### Authorization
[api_key](../README.md#api_key)
@@ -5311,20 +5702,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
active: true, # BOOLEAN | Set if the connection synchronisation is active
- expire: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Set expiration of the connection to this date
- login: "login_example", # String | Set login to this new login
- password: "password_example", # String | Set password to this new password
- expand: "expand_example" # String |
+ expire: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Set expiration of the connection to this date
+ login: 'login_example', # String | Set login to this new login
+ password: 'password_example', # String | Set password to this new password
+ expand: 'expand_example' # String |
}
begin
#Update a connection.
result = api_instance.users_id_user_connections_id_connection_post(id_user, id_connection, opts)
@@ -5354,11 +5745,11 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
# **users_id_user_connections_id_connection_put**
@@ -5380,16 +5771,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Force synchronisation of a connection.
result = api_instance.users_id_user_connections_id_connection_put(id_user, id_connection, opts)
@@ -5441,16 +5832,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete transactions
result = api_instance.users_id_user_connections_id_connection_transactions_delete(id_user, id_connection, opts)
@@ -5482,11 +5873,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_transactions_get**
-> InlineResponse20025 users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts)
+> InlineResponse20027 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>
@@ -5502,29 +5893,29 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
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 (inclusive) date
- max_date: Date.parse("2013-10-20"), # Date | maximum (inclusive) date
+ min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
+ max_date: Date.parse('2013-10-20'), # Date | maximum (inclusive) date
income: true, # BOOLEAN | filter on income or expenditures
deleted: true, # BOOLEAN | display only deleted transactions
all: true, # BOOLEAN | display all transactions, including deleted ones
- last_update: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | get only transactions updated after the specified datetime
- wording: "wording_example", # String | filter transactions containing the given string
+ last_update: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | get only transactions updated after the specified datetime
+ wording: 'wording_example', # String | filter transactions containing the given string
min_value: 3.4, # Float | minimal (inclusive) value
max_value: 3.4, # Float | maximum (inclusive) value
- search: "search_example", # String | search in labels, dates, values and categories
- value: "value_example", # String | \"XX|-XX\" or \"±XX\"
- expand: "expand_example" # String |
+ search: 'search_example', # String | search in labels, dates, values and categories
+ value: 'value_example', # String | \"XX|-XX\" or \"±XX\"
+ expand: 'expand_example' # String |
}
begin
#Get transactions
result = api_instance.users_id_user_connections_id_connection_transactions_get(id_user, id_connection, opts)
@@ -5555,11 +5946,11 @@
**value** | **String**| \"XX|-XX\" or \"±XX\" | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20025**](InlineResponse20025.md)
+[**InlineResponse20027**](InlineResponse20027.md)
### Authorization
[api_key](../README.md#api_key)
@@ -5589,18 +5980,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all arbitrary key-value pairs of a transaction
result = api_instance.users_id_user_connections_id_connection_transactions_id_transaction_informations_delete(id_user, id_connection, id_transaction, opts)
@@ -5633,11 +6024,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_transactions_id_transaction_informations_get**
-> InlineResponse20027 users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts)
+> InlineResponse20029 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
@@ -5653,18 +6044,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#List all arbitrary key-value pairs on a transaction
result = api_instance.users_id_user_connections_id_connection_transactions_id_transaction_informations_get(id_user, id_connection, id_transaction, opts)
@@ -5683,11 +6074,11 @@
**id_transaction** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20027**](InlineResponse20027.md)
+[**InlineResponse20029**](InlineResponse20029.md)
### Authorization
[api_key](../README.md#api_key)
@@ -5717,20 +6108,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a particular key-value pair on a transaction.
result = api_instance.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_delete(id_user, id_connection, id_transaction, id_information, opts)
@@ -5784,20 +6175,20 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get a particular arbitrary key-value pair on a transaction
result = api_instance.users_id_user_connections_id_connection_transactions_id_transaction_informations_id_information_get(id_user, id_connection, id_transaction, id_information, opts)
@@ -5851,18 +6242,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Add or edit transaction arbitrary key-value pairs
result = api_instance.users_id_user_connections_id_connection_transactions_id_transaction_informations_put(id_user, id_connection, id_transaction, opts)
@@ -5915,23 +6306,23 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transaction = 56 # Integer |
opts = {
- wording: "wording_example", # String | user rewording of the transaction
- application_date: Date.parse("2013-10-20"), # Date | change application date of the transaction
+ wording: 'wording_example', # String | user rewording of the transaction
+ application_date: Date.parse('2013-10-20'), # Date | change application date of the transaction
id_category: 56, # Integer | ID of the associated category
- comment: "comment_example", # String | change comment
+ comment: 'comment_example', # String | change comment
active: true, # BOOLEAN | if false, transaction isn't considered in analyzisis endpoints (like /balances)
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a transaction meta-data
result = api_instance.users_id_user_connections_id_connection_transactions_id_transaction_put(id_user, id_connection, id_transaction, opts)
@@ -5989,29 +6380,29 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
-original_wording = "original_wording_example" # String | label of the transaction
+original_wording = 'original_wording_example' # String | label of the transaction
value = 56 # Integer | vallue of the transaction
-date = Date.parse("2013-10-20") # Date | date of the transaction
+date = Date.parse('2013-10-20') # Date | date of the transaction
opts = {
- type: "type_example", # String | type of the transaction (default: unknown)
- state: "state_example", # String | nature of the transaction (default: new)
- rdate: Date.parse("2013-10-20"), # Date | realisation date of the transaction (default: value of date)
+ type: 'type_example', # String | type of the transaction (default: unknown)
+ state: 'state_example', # String | nature of the transaction (default: new)
+ rdate: Date.parse('2013-10-20'), # Date | realisation date of the transaction (default: value of date)
coming: true, # BOOLEAN | 1 if the transaction has already been debited (default: 0)
active: true, # BOOLEAN | 1 if the transaction should be taken into account by pfm services (default: 1)
- date_scraped: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
+ date_scraped: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
id_account: 56, # Integer | account of the transaction. If not supplied, it has to be given in the route
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create transactions
result = api_instance.users_id_user_connections_id_connection_transactions_post(id_user, id_connection, original_wording, value, date, opts)
@@ -6053,11 +6444,11 @@
- **Accept**: application/json
# **users_id_user_connections_id_connection_transactionsclusters_get**
-> InlineResponse20028 users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts)
+> InlineResponse20030 users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts)
Get clustered transactions
@@ -6073,16 +6464,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get clustered transactions
result = api_instance.users_id_user_connections_id_connection_transactionsclusters_get(id_user, id_connection, opts)
@@ -6100,11 +6491,11 @@
**id_connection** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20028**](InlineResponse20028.md)
+[**InlineResponse20030**](InlineResponse20030.md)
### Authorization
[api_key](../README.md#api_key)
@@ -6134,18 +6525,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a clustered transaction
result = api_instance.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_delete(id_user, id_connection, id_transactionscluster, opts)
@@ -6198,18 +6589,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a clustered transaction
result = api_instance.users_id_user_connections_id_connection_transactionsclusters_id_transactionscluster_put(id_user, id_connection, id_transactionscluster, opts)
@@ -6262,16 +6653,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_connection = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create clustered transaction
result = api_instance.users_id_user_connections_id_connection_transactionsclusters_post(id_user, id_connection, opts)
@@ -6323,28 +6714,27 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- id_bank: 56, # Integer | ID of the bank
- 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
- oauth_token_secret: "oauth_token_secret_example", # String | bank additional login parameter
- auth_type: "auth_type_example", # String | bank additional login parameter
- 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
- password2: "password_example", # String | bank additional login parameter
- login: "login_example", # String | bank additional login parameter
+ id_connector: 56, # Integer | ID of the 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
+ oauth_token_secret: 'oauth_token_secret_example', # String | bank additional login parameter
+ auth_type: 'auth_type_example', # String | bank additional login parameter
+ 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
+ login: 'login_example', # String | bank additional login parameter
id_provider: 56, # Integer | ID of the provider
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Add a new connection.
result = api_instance.users_id_user_connections_post(id_user, opts)
@@ -6357,22 +6747,21 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id_user** | **String**| Hint: you can use 'me' or 'all' |
- **id_bank** | **Integer**| ID of the bank | [optional]
+ **id_connector** | **Integer**| ID of the connector | [optional]
**birthday** | **String**| bank additional login parameter | [optional]
**password** | **String**| bank additional login parameter | [optional]
**oauth_token** | **String**| bank additional login parameter | [optional]
**oauth_token_secret** | **String**| bank additional login parameter | [optional]
**auth_type** | **String**| bank additional login parameter | [optional]
**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]
- **password2** | **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
@@ -6383,11 +6772,11 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
# **users_id_user_forecast_get**
@@ -6409,11 +6798,11 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
begin
#Get forecast
api_instance.users_id_user_forecast_get(id_user)
@@ -6442,11 +6831,11 @@
- **Accept**: application/json
# **users_id_user_logs_get**
-> InlineResponse20015 users_id_user_logs_get(id_user, opts)
+> InlineResponse20016 users_id_user_logs_get(id_user, opts)
Get connection logs
Get logs about connections.<br><br>
@@ -6462,24 +6851,24 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
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
+ 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
+ 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_bank: 56, # Integer | ID of a bank
- charged: true, # BOOLEAN | consider only logs for charged banks
- expand: "expand_example" # String |
+ id_connector: 56, # Integer | ID of a connector
+ charged: true, # BOOLEAN | consider only logs for charged connectors
+ expand: 'expand_example' # String |
}
begin
#Get connection logs
result = api_instance.users_id_user_logs_get(id_user, opts)
@@ -6500,17 +6889,17 @@
**max_date** | **Date**| maximum date | [optional]
**state** | **Integer**| state of user | [optional]
**period** | **String**| period to group logs | [optional]
**id_user2** | **Integer**| ID of a user | [optional]
**id_connection** | **Integer**| ID of a connection | [optional]
- **id_bank** | **Integer**| ID of a bank | [optional]
- **charged** | **BOOLEAN**| consider only logs for charged banks | [optional]
+ **id_connector** | **Integer**| ID of a connector | [optional]
+ **charged** | **BOOLEAN**| consider only logs for charged connectors | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20015**](InlineResponse20015.md)
+[**InlineResponse20016**](InlineResponse20016.md)
### Authorization
[api_key](../README.md#api_key)
@@ -6540,14 +6929,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete transactions
result = api_instance.users_id_user_transactions_delete(id_user, opts)
@@ -6578,11 +6967,11 @@
- **Accept**: application/json
# **users_id_user_transactions_get**
-> InlineResponse20025 users_id_user_transactions_get(id_user, opts)
+> InlineResponse20027 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>
@@ -6598,27 +6987,27 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
limit: 56, # Integer | limit number of results
offset: 56, # Integer | offset of first result
- min_date: Date.parse("2013-10-20"), # Date | minimal (inclusive) date
- max_date: Date.parse("2013-10-20"), # Date | maximum (inclusive) date
+ min_date: Date.parse('2013-10-20'), # Date | minimal (inclusive) date
+ max_date: Date.parse('2013-10-20'), # Date | maximum (inclusive) date
income: true, # BOOLEAN | filter on income or expenditures
deleted: true, # BOOLEAN | display only deleted transactions
all: true, # BOOLEAN | display all transactions, including deleted ones
- last_update: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | get only transactions updated after the specified datetime
- wording: "wording_example", # String | filter transactions containing the given string
+ last_update: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | get only transactions updated after the specified datetime
+ wording: 'wording_example', # String | filter transactions containing the given string
min_value: 3.4, # Float | minimal (inclusive) value
max_value: 3.4, # Float | maximum (inclusive) value
- search: "search_example", # String | search in labels, dates, values and categories
- value: "value_example", # String | \"XX|-XX\" or \"±XX\"
- expand: "expand_example" # String |
+ search: 'search_example', # String | search in labels, dates, values and categories
+ value: 'value_example', # String | \"XX|-XX\" or \"±XX\"
+ expand: 'expand_example' # String |
}
begin
#Get transactions
result = api_instance.users_id_user_transactions_get(id_user, opts)
@@ -6648,11 +7037,11 @@
**value** | **String**| \"XX|-XX\" or \"±XX\" | [optional]
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20025**](InlineResponse20025.md)
+[**InlineResponse20027**](InlineResponse20027.md)
### Authorization
[api_key](../README.md#api_key)
@@ -6682,16 +7071,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete all arbitrary key-value pairs of a transaction
result = api_instance.users_id_user_transactions_id_transaction_informations_delete(id_user, id_transaction, opts)
@@ -6723,11 +7112,11 @@
- **Accept**: application/json
# **users_id_user_transactions_id_transaction_informations_get**
-> InlineResponse20027 users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts)
+> InlineResponse20029 users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts)
List all arbitrary key-value pairs on a transaction
@@ -6743,16 +7132,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#List all arbitrary key-value pairs on a transaction
result = api_instance.users_id_user_transactions_id_transaction_informations_get(id_user, id_transaction, opts)
@@ -6770,11 +7159,11 @@
**id_transaction** | **Integer**| |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20027**](InlineResponse20027.md)
+[**InlineResponse20029**](InlineResponse20029.md)
### Authorization
[api_key](../README.md#api_key)
@@ -6804,18 +7193,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a particular key-value pair on a transaction.
result = api_instance.users_id_user_transactions_id_transaction_informations_id_information_delete(id_user, id_transaction, id_information, opts)
@@ -6868,18 +7257,18 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transaction = 56 # Integer |
id_information = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get a particular arbitrary key-value pair on a transaction
result = api_instance.users_id_user_transactions_id_transaction_informations_id_information_get(id_user, id_transaction, id_information, opts)
@@ -6932,16 +7321,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transaction = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Add or edit transaction arbitrary key-value pairs
result = api_instance.users_id_user_transactions_id_transaction_informations_put(id_user, id_transaction, opts)
@@ -6993,21 +7382,21 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transaction = 56 # Integer |
opts = {
- wording: "wording_example", # String | user rewording of the transaction
- application_date: Date.parse("2013-10-20"), # Date | change application date of the transaction
+ wording: 'wording_example', # String | user rewording of the transaction
+ application_date: Date.parse('2013-10-20'), # Date | change application date of the transaction
id_category: 56, # Integer | ID of the associated category
- comment: "comment_example", # String | change comment
+ comment: 'comment_example', # String | change comment
active: true, # BOOLEAN | if false, transaction isn't considered in analyzisis endpoints (like /balances)
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a transaction meta-data
result = api_instance.users_id_user_transactions_id_transaction_put(id_user, id_transaction, opts)
@@ -7038,11 +7427,11 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
# **users_id_user_transactions_post**
@@ -7064,27 +7453,27 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
-original_wording = "original_wording_example" # String | label of the transaction
+original_wording = 'original_wording_example' # String | label of the transaction
value = 56 # Integer | vallue of the transaction
-date = Date.parse("2013-10-20") # Date | date of the transaction
+date = Date.parse('2013-10-20') # Date | date of the transaction
opts = {
- type: "type_example", # String | type of the transaction (default: unknown)
- state: "state_example", # String | nature of the transaction (default: new)
- rdate: Date.parse("2013-10-20"), # Date | realisation date of the transaction (default: value of date)
+ type: 'type_example', # String | type of the transaction (default: unknown)
+ state: 'state_example', # String | nature of the transaction (default: new)
+ rdate: Date.parse('2013-10-20'), # Date | realisation date of the transaction (default: value of date)
coming: true, # BOOLEAN | 1 if the transaction has already been debited (default: 0)
active: true, # BOOLEAN | 1 if the transaction should be taken into account by pfm services (default: 1)
- date_scraped: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
+ date_scraped: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | date on which the transaction has been found for the first time. YYYY-MM-DD HH:MM:SS(default: now)
id_account: 56, # Integer | account of the transaction. If not supplied, it has to be given in the route
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create transactions
result = api_instance.users_id_user_transactions_post(id_user, original_wording, value, date, opts)
@@ -7119,17 +7508,17 @@
[api_key](../README.md#api_key)
### HTTP request headers
- - **Content-Type**: multipart/form-data
+ - **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json
# **users_id_user_transactionsclusters_get**
-> InlineResponse20028 users_id_user_transactionsclusters_get(id_user, opts)
+> InlineResponse20030 users_id_user_transactionsclusters_get(id_user, opts)
Get clustered transactions
@@ -7145,14 +7534,14 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Get clustered transactions
result = api_instance.users_id_user_transactionsclusters_get(id_user, opts)
@@ -7169,11 +7558,11 @@
**id_user** | **String**| Hint: you can use 'me' or 'all' |
**expand** | **String**| | [optional]
### Return type
-[**InlineResponse20028**](InlineResponse20028.md)
+[**InlineResponse20030**](InlineResponse20030.md)
### Authorization
[api_key](../README.md#api_key)
@@ -7203,16 +7592,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Delete a clustered transaction
result = api_instance.users_id_user_transactionsclusters_id_transactionscluster_delete(id_user, id_transactionscluster, opts)
@@ -7264,16 +7653,16 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
id_transactionscluster = 56 # Integer |
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Edit a clustered transaction
result = api_instance.users_id_user_transactionsclusters_id_transactionscluster_put(id_user, id_transactionscluster, opts)
@@ -7325,13 +7714,13 @@
#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_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
opts = {
- expand: "expand_example" # String |
+ expand: 'expand_example' # String |
}
begin
#Create clustered transaction
result = api_instance.users_id_user_transactionsclusters_post(id_user, opts)