budgea_client 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +89 -0
- data/README.md +619 -0
- data/Rakefile +13 -0
- data/budgea_client.gemspec +35 -0
- data/docs/Access.md +12 -0
- data/docs/Account.md +25 -0
- data/docs/AccountLog.md +15 -0
- data/docs/AccountType.md +15 -0
- data/docs/AdministrationApi.md +944 -0
- data/docs/Alert.md +15 -0
- data/docs/AuthenticationApi.md +398 -0
- data/docs/Bank.md +18 -0
- data/docs/BankCategory.md +9 -0
- data/docs/BanksApi.md +6558 -0
- data/docs/Category.md +17 -0
- data/docs/Client.md +18 -0
- data/docs/Connection.md +16 -0
- data/docs/ConnectionContact.md +17 -0
- data/docs/ConnectionLog.md +21 -0
- data/docs/ConnectionsApi.md +934 -0
- data/docs/ConnectorLogo.md +11 -0
- data/docs/Currency.md +10 -0
- data/docs/Device.md +14 -0
- data/docs/Document.md +29 -0
- data/docs/DocumentType.md +10 -0
- data/docs/DocumentsApi.md +5228 -0
- data/docs/Field.md +15 -0
- data/docs/File.md +11 -0
- data/docs/Group.md +15 -0
- data/docs/HashTable.md +11 -0
- data/docs/InlineResponse200.md +8 -0
- data/docs/InlineResponse2001.md +9 -0
- data/docs/InlineResponse20010.md +8 -0
- data/docs/InlineResponse20011.md +8 -0
- data/docs/InlineResponse20012.md +8 -0
- data/docs/InlineResponse20013.md +8 -0
- data/docs/InlineResponse20014.md +8 -0
- data/docs/InlineResponse20015.md +8 -0
- data/docs/InlineResponse20016.md +8 -0
- data/docs/InlineResponse20017.md +8 -0
- data/docs/InlineResponse20018.md +8 -0
- data/docs/InlineResponse20019.md +8 -0
- data/docs/InlineResponse2002.md +10 -0
- data/docs/InlineResponse20020.md +8 -0
- data/docs/InlineResponse20021.md +8 -0
- data/docs/InlineResponse20022.md +8 -0
- data/docs/InlineResponse20023.md +8 -0
- data/docs/InlineResponse20024.md +8 -0
- data/docs/InlineResponse20025.md +8 -0
- data/docs/InlineResponse20026.md +8 -0
- data/docs/InlineResponse20027.md +8 -0
- data/docs/InlineResponse20028.md +8 -0
- data/docs/InlineResponse20029.md +8 -0
- data/docs/InlineResponse2003.md +10 -0
- data/docs/InlineResponse20030.md +8 -0
- data/docs/InlineResponse20031.md +8 -0
- data/docs/InlineResponse20032.md +8 -0
- data/docs/InlineResponse20033.md +8 -0
- data/docs/InlineResponse2004.md +12 -0
- data/docs/InlineResponse2005.md +9 -0
- data/docs/InlineResponse2006.md +10 -0
- data/docs/InlineResponse2007.md +8 -0
- data/docs/InlineResponse2008.md +8 -0
- data/docs/InlineResponse2009.md +8 -0
- data/docs/Investment.md +32 -0
- data/docs/InvestmentValue.md +13 -0
- data/docs/Invite.md +13 -0
- data/docs/LockedUser.md +10 -0
- data/docs/OCRApi.md +117 -0
- data/docs/OIDCApi.md +167 -0
- data/docs/OidcWhitelist.md +9 -0
- data/docs/PFMApi.md +2204 -0
- data/docs/Pocket.md +17 -0
- data/docs/Profile.md +15 -0
- data/docs/Project.md +16 -0
- data/docs/ProjectType.md +10 -0
- data/docs/ProvidersApi.md +7014 -0
- data/docs/Recipient.md +22 -0
- data/docs/RecipientsApi.md +244 -0
- data/docs/Security.md +12 -0
- data/docs/Subscription.md +18 -0
- data/docs/TermsApi.md +218 -0
- data/docs/TermsOfService.md +12 -0
- data/docs/Transaction.md +33 -0
- data/docs/TransactionInformation.md +11 -0
- data/docs/TransactionsCluster.md +16 -0
- data/docs/Transfer.md +23 -0
- data/docs/TransfersApi.md +2404 -0
- data/docs/User.md +10 -0
- data/docs/UserAlert.md +21 -0
- data/docs/UsersManagementApi.md +608 -0
- data/docs/WealthApi.md +828 -0
- data/docs/Webhook.md +15 -0
- data/git_push.sh +55 -0
- data/lib/budgea_client.rb +118 -0
- data/lib/budgea_client/api/administration_api.rb +1059 -0
- data/lib/budgea_client/api/authentication_api.rb +467 -0
- data/lib/budgea_client/api/banks_api.rb +7837 -0
- data/lib/budgea_client/api/connections_api.rb +1088 -0
- data/lib/budgea_client/api/documents_api.rb +6637 -0
- data/lib/budgea_client/api/ocr_api.rb +141 -0
- data/lib/budgea_client/api/oidc_api.rb +195 -0
- data/lib/budgea_client/api/pfm_api.rb +2630 -0
- data/lib/budgea_client/api/providers_api.rb +8694 -0
- data/lib/budgea_client/api/recipients_api.rb +293 -0
- data/lib/budgea_client/api/terms_api.rb +245 -0
- data/lib/budgea_client/api/transfers_api.rb +2941 -0
- data/lib/budgea_client/api/users_management_api.rb +695 -0
- data/lib/budgea_client/api/wealth_api.rb +994 -0
- data/lib/budgea_client/api_client.rb +378 -0
- data/lib/budgea_client/api_error.rb +28 -0
- data/lib/budgea_client/configuration.rb +192 -0
- data/lib/budgea_client/models/access.rb +224 -0
- data/lib/budgea_client/models/account.rb +383 -0
- data/lib/budgea_client/models/account_log.rb +266 -0
- data/lib/budgea_client/models/account_type.rb +281 -0
- data/lib/budgea_client/models/alert.rb +273 -0
- data/lib/budgea_client/models/bank.rb +308 -0
- data/lib/budgea_client/models/bank_category.rb +201 -0
- data/lib/budgea_client/models/category.rb +299 -0
- data/lib/budgea_client/models/client.rb +305 -0
- data/lib/budgea_client/models/connection.rb +276 -0
- data/lib/budgea_client/models/connection_contact.rb +274 -0
- data/lib/budgea_client/models/connection_log.rb +324 -0
- data/lib/budgea_client/models/connector_logo.rb +223 -0
- data/lib/budgea_client/models/currency.rb +216 -0
- data/lib/budgea_client/models/device.rb +269 -0
- data/lib/budgea_client/models/document.rb +398 -0
- data/lib/budgea_client/models/document_type.rb +213 -0
- data/lib/budgea_client/models/field.rb +273 -0
- data/lib/budgea_client/models/file.rb +225 -0
- data/lib/budgea_client/models/group.rb +246 -0
- data/lib/budgea_client/models/hash_table.rb +227 -0
- data/lib/budgea_client/models/inline_response_200.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_1.rb +199 -0
- data/lib/budgea_client/models/inline_response_200_10.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_11.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_12.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_13.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_14.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_15.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_16.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_17.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_18.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_19.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_2.rb +209 -0
- data/lib/budgea_client/models/inline_response_200_20.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_21.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_22.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_23.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_24.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_25.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_26.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_27.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_28.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_29.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_3.rb +214 -0
- data/lib/budgea_client/models/inline_response_200_30.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_31.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_32.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_33.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_4.rb +239 -0
- data/lib/budgea_client/models/inline_response_200_5.rb +199 -0
- data/lib/budgea_client/models/inline_response_200_6.rb +214 -0
- data/lib/budgea_client/models/inline_response_200_7.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_8.rb +185 -0
- data/lib/budgea_client/models/inline_response_200_9.rb +185 -0
- data/lib/budgea_client/models/investment.rb +449 -0
- data/lib/budgea_client/models/investment_value.rb +249 -0
- data/lib/budgea_client/models/invite.rb +233 -0
- data/lib/budgea_client/models/locked_user.rb +206 -0
- data/lib/budgea_client/models/oidc_whitelist.rb +198 -0
- data/lib/budgea_client/models/pocket.rb +298 -0
- data/lib/budgea_client/models/profile.rb +308 -0
- data/lib/budgea_client/models/project.rb +301 -0
- data/lib/budgea_client/models/project_type.rb +206 -0
- data/lib/budgea_client/models/recipient.rb +343 -0
- data/lib/budgea_client/models/security.rb +229 -0
- data/lib/budgea_client/models/subscription.rb +299 -0
- data/lib/budgea_client/models/terms_of_service.rb +229 -0
- data/lib/budgea_client/models/transaction.rb +507 -0
- data/lib/budgea_client/models/transaction_information.rb +224 -0
- data/lib/budgea_client/models/transactions_cluster.rb +277 -0
- data/lib/budgea_client/models/transfer.rb +354 -0
- data/lib/budgea_client/models/user.rb +244 -0
- data/lib/budgea_client/models/user_alert.rb +333 -0
- data/lib/budgea_client/models/webhook.rb +264 -0
- data/lib/budgea_client/version.rb +5 -0
- data/pkg/budgea_client-1.0.0.gem +0 -0
- data/spec/api/administration_api_spec.rb +271 -0
- data/spec/api/authentication_api_spec.rb +126 -0
- data/spec/api/banks_api_spec.rb +1787 -0
- data/spec/api/connections_api_spec.rb +279 -0
- data/spec/api/documents_api_spec.rb +1557 -0
- data/spec/api/ocr_api_spec.rb +54 -0
- data/spec/api/oidc_api_spec.rb +65 -0
- data/spec/api/pfm_api_spec.rb +613 -0
- data/spec/api/providers_api_spec.rb +2029 -0
- data/spec/api/recipients_api_spec.rb +89 -0
- data/spec/api/terms_api_spec.rb +79 -0
- data/spec/api/transfers_api_spec.rb +661 -0
- data/spec/api/users_management_api_spec.rb +177 -0
- data/spec/api/wealth_api_spec.rb +246 -0
- data/spec/api_client_spec.rb +216 -0
- data/spec/configuration_spec.rb +32 -0
- data/spec/models/access_spec.rb +56 -0
- data/spec/models/account_log_spec.rb +74 -0
- data/spec/models/account_spec.rb +134 -0
- data/spec/models/account_type_spec.rb +74 -0
- data/spec/models/alert_spec.rb +74 -0
- data/spec/models/bank_category_spec.rb +38 -0
- data/spec/models/bank_spec.rb +92 -0
- data/spec/models/category_spec.rb +86 -0
- data/spec/models/client_spec.rb +92 -0
- data/spec/models/connection_contact_spec.rb +86 -0
- data/spec/models/connection_log_spec.rb +110 -0
- data/spec/models/connection_spec.rb +80 -0
- data/spec/models/connector_logo_spec.rb +50 -0
- data/spec/models/currency_spec.rb +44 -0
- data/spec/models/device_spec.rb +68 -0
- data/spec/models/document_spec.rb +158 -0
- data/spec/models/document_type_spec.rb +44 -0
- data/spec/models/field_spec.rb +74 -0
- data/spec/models/file_spec.rb +50 -0
- data/spec/models/group_spec.rb +74 -0
- data/spec/models/hash_table_spec.rb +50 -0
- data/spec/models/inline_response_200_10_spec.rb +32 -0
- data/spec/models/inline_response_200_11_spec.rb +32 -0
- data/spec/models/inline_response_200_12_spec.rb +32 -0
- data/spec/models/inline_response_200_13_spec.rb +32 -0
- data/spec/models/inline_response_200_14_spec.rb +32 -0
- data/spec/models/inline_response_200_15_spec.rb +32 -0
- data/spec/models/inline_response_200_16_spec.rb +32 -0
- data/spec/models/inline_response_200_17_spec.rb +32 -0
- data/spec/models/inline_response_200_18_spec.rb +32 -0
- data/spec/models/inline_response_200_19_spec.rb +32 -0
- data/spec/models/inline_response_200_1_spec.rb +38 -0
- data/spec/models/inline_response_200_20_spec.rb +32 -0
- data/spec/models/inline_response_200_21_spec.rb +32 -0
- data/spec/models/inline_response_200_22_spec.rb +32 -0
- data/spec/models/inline_response_200_23_spec.rb +32 -0
- data/spec/models/inline_response_200_24_spec.rb +32 -0
- data/spec/models/inline_response_200_25_spec.rb +32 -0
- data/spec/models/inline_response_200_26_spec.rb +32 -0
- data/spec/models/inline_response_200_27_spec.rb +32 -0
- data/spec/models/inline_response_200_28_spec.rb +32 -0
- data/spec/models/inline_response_200_29_spec.rb +32 -0
- data/spec/models/inline_response_200_2_spec.rb +44 -0
- data/spec/models/inline_response_200_30_spec.rb +32 -0
- data/spec/models/inline_response_200_31_spec.rb +32 -0
- data/spec/models/inline_response_200_32_spec.rb +32 -0
- data/spec/models/inline_response_200_33_spec.rb +32 -0
- data/spec/models/inline_response_200_3_spec.rb +44 -0
- data/spec/models/inline_response_200_4_spec.rb +56 -0
- data/spec/models/inline_response_200_5_spec.rb +38 -0
- data/spec/models/inline_response_200_6_spec.rb +44 -0
- data/spec/models/inline_response_200_7_spec.rb +32 -0
- data/spec/models/inline_response_200_8_spec.rb +32 -0
- data/spec/models/inline_response_200_9_spec.rb +32 -0
- data/spec/models/inline_response_200_spec.rb +32 -0
- data/spec/models/investment_spec.rb +176 -0
- data/spec/models/investment_value_spec.rb +62 -0
- data/spec/models/invite_spec.rb +62 -0
- data/spec/models/locked_user_spec.rb +44 -0
- data/spec/models/oidc_whitelist_spec.rb +38 -0
- data/spec/models/pocket_spec.rb +86 -0
- data/spec/models/profile_spec.rb +78 -0
- data/spec/models/project_spec.rb +80 -0
- data/spec/models/project_type_spec.rb +44 -0
- data/spec/models/recipient_spec.rb +116 -0
- data/spec/models/security_spec.rb +56 -0
- data/spec/models/subscription_spec.rb +92 -0
- data/spec/models/terms_of_service_spec.rb +56 -0
- data/spec/models/transaction_information_spec.rb +50 -0
- data/spec/models/transaction_spec.rb +182 -0
- data/spec/models/transactions_cluster_spec.rb +80 -0
- data/spec/models/transfer_spec.rb +122 -0
- data/spec/models/user_alert_spec.rb +110 -0
- data/spec/models/user_spec.rb +48 -0
- data/spec/models/webhook_spec.rb +74 -0
- data/spec/spec_helper.rb +51 -0
- metadata +599 -0
data/docs/Category.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# BudgeaClient::Category
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | ID of the category |
|
|
7
|
+
**id_parent_category** | **Integer** | ID of the parent category. If this is a parent category, it will be equal to its own ID |
|
|
8
|
+
**name** | **String** | Name of the category |
|
|
9
|
+
**income** | **BOOLEAN** | Is an income category. If null, this is both an income and an expense category | [optional]
|
|
10
|
+
**color** | **String** | Color of the category |
|
|
11
|
+
**id_parent_category_in_menu** | **Integer** | ID of the parent category to be displayed |
|
|
12
|
+
**name_displayed** | **String** | Displayed name, with HTML tags | [optional]
|
|
13
|
+
**refundable** | **BOOLEAN** | This category accepts opposite sign of transactions |
|
|
14
|
+
**id_user** | **Integer** | If not null, this category is specific to a user | [optional]
|
|
15
|
+
**id_logo** | **Integer** | ID of the logo | [optional]
|
|
16
|
+
|
|
17
|
+
|
data/docs/Client.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# BudgeaClient::Client
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | |
|
|
7
|
+
**name** | **String** | | [default to ""]
|
|
8
|
+
**secret** | **String** | |
|
|
9
|
+
**redirect_uri** | **String** | | [default to ""]
|
|
10
|
+
**primary_color** | **String** | Primary color of client | [optional]
|
|
11
|
+
**secondary_color** | **String** | Secondary color of client | [optional]
|
|
12
|
+
**pro** | **BOOLEAN** | Should the client display the company manager page. | [default to false]
|
|
13
|
+
**description** | **String** | Text to display as a default description. | [optional]
|
|
14
|
+
**description_banks** | **String** | Text to display as a description for banks. | [optional]
|
|
15
|
+
**description_providers** | **String** | Text to display as a description for providers. | [optional]
|
|
16
|
+
**id_logo** | **Integer** | | [optional]
|
|
17
|
+
|
|
18
|
+
|
data/docs/Connection.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# BudgeaClient::Connection
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | ID of connection |
|
|
7
|
+
**id_user** | **Integer** | ID of the related user | [optional]
|
|
8
|
+
**id_bank** | **Integer** | ID of the related bank or provider |
|
|
9
|
+
**last_update** | **DateTime** | Last successful update | [optional]
|
|
10
|
+
**error** | **String** | If the last update has failed, the error code | [optional]
|
|
11
|
+
**expire** | **DateTime** | Expiration of the connection. Used during add of a two-factor authentication, to purge the connection if the user abort | [optional]
|
|
12
|
+
**active** | **BOOLEAN** | This connection is active and will be automatically synced | [default to true]
|
|
13
|
+
**last_push** | **DateTime** | Last successful push | [optional]
|
|
14
|
+
**next_try** | **DateTime** | Date of next synchronization | [optional]
|
|
15
|
+
|
|
16
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# BudgeaClient::ConnectionContact
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | |
|
|
7
|
+
**id_connection** | **Integer** | |
|
|
8
|
+
**name** | **String** | |
|
|
9
|
+
**email** | **String** | | [optional]
|
|
10
|
+
**phone** | **String** | | [optional]
|
|
11
|
+
**mobile** | **String** | | [optional]
|
|
12
|
+
**fax** | **String** | | [optional]
|
|
13
|
+
**agency** | **String** | | [optional]
|
|
14
|
+
**address** | **String** | | [optional]
|
|
15
|
+
**role** | **String** | | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# BudgeaClient::ConnectionLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | ID of the log |
|
|
7
|
+
**id_user** | **Integer** | ID of the user | [optional]
|
|
8
|
+
**id_connection** | **Integer** | ID of the connection |
|
|
9
|
+
**id_bank** | **Integer** | ID of the bank | [optional]
|
|
10
|
+
**login** | **String** | bcrypt hash of the login | [optional]
|
|
11
|
+
**error_uid** | **String** | MD5 hash of the exception backtrace | [optional]
|
|
12
|
+
**timestamp** | **DateTime** | Timestamp of log, when the synchronization has finished |
|
|
13
|
+
**next_try** | **DateTime** | If fail, the date represents the next try to connect | [optional]
|
|
14
|
+
**error** | **String** | If fail, contains the error code | [optional]
|
|
15
|
+
**error_message** | **String** | If fail, error message received from bank or provider | [optional]
|
|
16
|
+
**statut** | **Integer** | Status of user (1 = charged user) | [optional]
|
|
17
|
+
**nb_accounts** | **Integer** | In case of bank connection, number of accounts | [optional]
|
|
18
|
+
**start** | **DateTime** | Timestamp when the synchronization has started | [optional]
|
|
19
|
+
**worker** | **String** | Worker used to do synchronization | [optional]
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,934 @@
|
|
|
1
|
+
# BudgeaClient::ConnectionsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**banks_get**](ConnectionsApi.md#banks_get) | **GET** /banks | Get list of connectors
|
|
8
|
+
[**banks_id_bank_connections_get**](ConnectionsApi.md#banks_id_bank_connections_get) | **GET** /banks/{id_bank}/connections | Get a subset of id_connection with the largest diversity of account
|
|
9
|
+
[**connections_get**](ConnectionsApi.md#connections_get) | **GET** /connections | Get connections without a user
|
|
10
|
+
[**connectors_get**](ConnectionsApi.md#connectors_get) | **GET** /connectors | Get list of connectors
|
|
11
|
+
[**connectors_post**](ConnectionsApi.md#connectors_post) | **POST** /connectors | Request a new connector
|
|
12
|
+
[**logs_get**](ConnectionsApi.md#logs_get) | **GET** /logs | Get connection logs
|
|
13
|
+
[**providers_get**](ConnectionsApi.md#providers_get) | **GET** /providers | Get list of connectors
|
|
14
|
+
[**users_id_user_connections_delete**](ConnectionsApi.md#users_id_user_connections_delete) | **DELETE** /users/{id_user}/connections | Delete all connections
|
|
15
|
+
[**users_id_user_connections_get**](ConnectionsApi.md#users_id_user_connections_get) | **GET** /users/{id_user}/connections | Get connections
|
|
16
|
+
[**users_id_user_connections_id_connection_delete**](ConnectionsApi.md#users_id_user_connections_id_connection_delete) | **DELETE** /users/{id_user}/connections/{id_connection} | Delete a connection.
|
|
17
|
+
[**users_id_user_connections_id_connection_informations_get**](ConnectionsApi.md#users_id_user_connections_id_connection_informations_get) | **GET** /users/{id_user}/connections/{id_connection}/informations | Get connection additionnal informations
|
|
18
|
+
[**users_id_user_connections_id_connection_logs_get**](ConnectionsApi.md#users_id_user_connections_id_connection_logs_get) | **GET** /users/{id_user}/connections/{id_connection}/logs | Get connection logs
|
|
19
|
+
[**users_id_user_connections_id_connection_post**](ConnectionsApi.md#users_id_user_connections_id_connection_post) | **POST** /users/{id_user}/connections/{id_connection} | Update a connection.
|
|
20
|
+
[**users_id_user_connections_id_connection_put**](ConnectionsApi.md#users_id_user_connections_id_connection_put) | **PUT** /users/{id_user}/connections/{id_connection} | Force synchronisation of a connection.
|
|
21
|
+
[**users_id_user_connections_post**](ConnectionsApi.md#users_id_user_connections_post) | **POST** /users/{id_user}/connections | Add a new connection.
|
|
22
|
+
[**users_id_user_logs_get**](ConnectionsApi.md#users_id_user_logs_get) | **GET** /users/{id_user}/logs | Get connection logs
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# **banks_get**
|
|
26
|
+
> InlineResponse2007 banks_get(opts)
|
|
27
|
+
|
|
28
|
+
Get list of connectors
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Example
|
|
33
|
+
```ruby
|
|
34
|
+
# load the gem
|
|
35
|
+
require 'budgea_client'
|
|
36
|
+
|
|
37
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
38
|
+
|
|
39
|
+
opts = {
|
|
40
|
+
expand: "expand_example" # String |
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
begin
|
|
44
|
+
#Get list of connectors
|
|
45
|
+
result = api_instance.banks_get(opts)
|
|
46
|
+
p result
|
|
47
|
+
rescue BudgeaClient::ApiError => e
|
|
48
|
+
puts "Exception when calling ConnectionsApi->banks_get: #{e}"
|
|
49
|
+
end
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Parameters
|
|
53
|
+
|
|
54
|
+
Name | Type | Description | Notes
|
|
55
|
+
------------- | ------------- | ------------- | -------------
|
|
56
|
+
**expand** | **String**| | [optional]
|
|
57
|
+
|
|
58
|
+
### Return type
|
|
59
|
+
|
|
60
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
|
61
|
+
|
|
62
|
+
### Authorization
|
|
63
|
+
|
|
64
|
+
No authorization required
|
|
65
|
+
|
|
66
|
+
### HTTP request headers
|
|
67
|
+
|
|
68
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
69
|
+
- **Accept**: application/json
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
# **banks_id_bank_connections_get**
|
|
74
|
+
> InlineResponse2008 banks_id_bank_connections_get(id_bank, opts)
|
|
75
|
+
|
|
76
|
+
Get a subset of id_connection with the largest diversity of account
|
|
77
|
+
|
|
78
|
+
By default, it selects a set of 3 connections.<br><br>
|
|
79
|
+
|
|
80
|
+
### Example
|
|
81
|
+
```ruby
|
|
82
|
+
# load the gem
|
|
83
|
+
require 'budgea_client'
|
|
84
|
+
|
|
85
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
86
|
+
|
|
87
|
+
id_bank = 56 # Integer |
|
|
88
|
+
|
|
89
|
+
opts = {
|
|
90
|
+
range: 56, # Integer | the length of the connection subset
|
|
91
|
+
type: 56, # Integer | to target a specific account type which will be
|
|
92
|
+
expand: "expand_example" # String |
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
begin
|
|
96
|
+
#Get a subset of id_connection with the largest diversity of account
|
|
97
|
+
result = api_instance.banks_id_bank_connections_get(id_bank, opts)
|
|
98
|
+
p result
|
|
99
|
+
rescue BudgeaClient::ApiError => e
|
|
100
|
+
puts "Exception when calling ConnectionsApi->banks_id_bank_connections_get: #{e}"
|
|
101
|
+
end
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameters
|
|
105
|
+
|
|
106
|
+
Name | Type | Description | Notes
|
|
107
|
+
------------- | ------------- | ------------- | -------------
|
|
108
|
+
**id_bank** | **Integer**| |
|
|
109
|
+
**range** | **Integer**| the length of the connection subset | [optional]
|
|
110
|
+
**type** | **Integer**| to target a specific account type which will be | [optional]
|
|
111
|
+
**expand** | **String**| | [optional]
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
116
|
+
|
|
117
|
+
### Authorization
|
|
118
|
+
|
|
119
|
+
No authorization required
|
|
120
|
+
|
|
121
|
+
### HTTP request headers
|
|
122
|
+
|
|
123
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
124
|
+
- **Accept**: application/json
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
# **connections_get**
|
|
129
|
+
> InlineResponse2008 connections_get(opts)
|
|
130
|
+
|
|
131
|
+
Get connections without a user
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
### Example
|
|
136
|
+
```ruby
|
|
137
|
+
# load the gem
|
|
138
|
+
require 'budgea_client'
|
|
139
|
+
|
|
140
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
141
|
+
|
|
142
|
+
opts = {
|
|
143
|
+
expand: "expand_example" # String |
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
begin
|
|
147
|
+
#Get connections without a user
|
|
148
|
+
result = api_instance.connections_get(opts)
|
|
149
|
+
p result
|
|
150
|
+
rescue BudgeaClient::ApiError => e
|
|
151
|
+
puts "Exception when calling ConnectionsApi->connections_get: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
Name | Type | Description | Notes
|
|
158
|
+
------------- | ------------- | ------------- | -------------
|
|
159
|
+
**expand** | **String**| | [optional]
|
|
160
|
+
|
|
161
|
+
### Return type
|
|
162
|
+
|
|
163
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
164
|
+
|
|
165
|
+
### Authorization
|
|
166
|
+
|
|
167
|
+
No authorization required
|
|
168
|
+
|
|
169
|
+
### HTTP request headers
|
|
170
|
+
|
|
171
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
172
|
+
- **Accept**: application/json
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
# **connectors_get**
|
|
177
|
+
> InlineResponse20012 connectors_get(opts)
|
|
178
|
+
|
|
179
|
+
Get list of connectors
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
### Example
|
|
184
|
+
```ruby
|
|
185
|
+
# load the gem
|
|
186
|
+
require 'budgea_client'
|
|
187
|
+
|
|
188
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
189
|
+
|
|
190
|
+
opts = {
|
|
191
|
+
expand: "expand_example" # String |
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
begin
|
|
195
|
+
#Get list of connectors
|
|
196
|
+
result = api_instance.connectors_get(opts)
|
|
197
|
+
p result
|
|
198
|
+
rescue BudgeaClient::ApiError => e
|
|
199
|
+
puts "Exception when calling ConnectionsApi->connectors_get: #{e}"
|
|
200
|
+
end
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
Name | Type | Description | Notes
|
|
206
|
+
------------- | ------------- | ------------- | -------------
|
|
207
|
+
**expand** | **String**| | [optional]
|
|
208
|
+
|
|
209
|
+
### Return type
|
|
210
|
+
|
|
211
|
+
[**InlineResponse20012**](InlineResponse20012.md)
|
|
212
|
+
|
|
213
|
+
### Authorization
|
|
214
|
+
|
|
215
|
+
No authorization required
|
|
216
|
+
|
|
217
|
+
### HTTP request headers
|
|
218
|
+
|
|
219
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
220
|
+
- **Accept**: application/json
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
# **connectors_post**
|
|
225
|
+
> Bank connectors_post(name, login, password, opts)
|
|
226
|
+
|
|
227
|
+
Request a new connector
|
|
228
|
+
|
|
229
|
+
Send a request to add a new connector<br><br>
|
|
230
|
+
|
|
231
|
+
### Example
|
|
232
|
+
```ruby
|
|
233
|
+
# load the gem
|
|
234
|
+
require 'budgea_client'
|
|
235
|
+
|
|
236
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
237
|
+
|
|
238
|
+
name = "name_example" # String | Name of the bank or provider
|
|
239
|
+
|
|
240
|
+
login = "login_example" # String | Users login
|
|
241
|
+
|
|
242
|
+
password = "password_example" # String | Users password
|
|
243
|
+
|
|
244
|
+
opts = {
|
|
245
|
+
api: "api_example", # String | Name of the API
|
|
246
|
+
url: "url_example", # String | Url of the bank
|
|
247
|
+
email: "email_example", # String | Email of the user
|
|
248
|
+
types: "types_example", # String | Type of connector, eg. banks or providers
|
|
249
|
+
comment: "comment_example", # String | Optionnal comment
|
|
250
|
+
sendmail: true, # BOOLEAN | if set, send an email to user
|
|
251
|
+
expand: "expand_example" # String |
|
|
252
|
+
}
|
|
253
|
+
|
|
254
|
+
begin
|
|
255
|
+
#Request a new connector
|
|
256
|
+
result = api_instance.connectors_post(name, login, password, opts)
|
|
257
|
+
p result
|
|
258
|
+
rescue BudgeaClient::ApiError => e
|
|
259
|
+
puts "Exception when calling ConnectionsApi->connectors_post: #{e}"
|
|
260
|
+
end
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
### Parameters
|
|
264
|
+
|
|
265
|
+
Name | Type | Description | Notes
|
|
266
|
+
------------- | ------------- | ------------- | -------------
|
|
267
|
+
**name** | **String**| Name of the bank or provider |
|
|
268
|
+
**login** | **String**| Users login |
|
|
269
|
+
**password** | **String**| Users password |
|
|
270
|
+
**api** | **String**| Name of the API | [optional]
|
|
271
|
+
**url** | **String**| Url of the bank | [optional]
|
|
272
|
+
**email** | **String**| Email of the user | [optional]
|
|
273
|
+
**types** | **String**| Type of connector, eg. banks or providers | [optional]
|
|
274
|
+
**comment** | **String**| Optionnal comment | [optional]
|
|
275
|
+
**sendmail** | **BOOLEAN**| if set, send an email to user | [optional]
|
|
276
|
+
**expand** | **String**| | [optional]
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
[**Bank**](Bank.md)
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
No authorization required
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
289
|
+
- **Accept**: application/json
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
# **logs_get**
|
|
294
|
+
> InlineResponse20015 logs_get(opts)
|
|
295
|
+
|
|
296
|
+
Get connection logs
|
|
297
|
+
|
|
298
|
+
Get logs about connections.<br><br>
|
|
299
|
+
|
|
300
|
+
### Example
|
|
301
|
+
```ruby
|
|
302
|
+
# load the gem
|
|
303
|
+
require 'budgea_client'
|
|
304
|
+
|
|
305
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
306
|
+
|
|
307
|
+
opts = {
|
|
308
|
+
limit: 56, # Integer | limit number of results
|
|
309
|
+
offset: 56, # Integer | offset of first result
|
|
310
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal date
|
|
311
|
+
max_date: Date.parse("2013-10-20"), # Date | maximum date
|
|
312
|
+
state: 56, # Integer | state of user
|
|
313
|
+
period: "period_example", # String | period to group logs
|
|
314
|
+
id_user: 56, # Integer | ID of a user
|
|
315
|
+
id_connection: 56, # Integer | ID of a connection
|
|
316
|
+
id_bank: 56, # Integer | ID of a bank
|
|
317
|
+
charged: true, # BOOLEAN | consider only logs for charged banks
|
|
318
|
+
expand: "expand_example" # String |
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
begin
|
|
322
|
+
#Get connection logs
|
|
323
|
+
result = api_instance.logs_get(opts)
|
|
324
|
+
p result
|
|
325
|
+
rescue BudgeaClient::ApiError => e
|
|
326
|
+
puts "Exception when calling ConnectionsApi->logs_get: #{e}"
|
|
327
|
+
end
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
### Parameters
|
|
331
|
+
|
|
332
|
+
Name | Type | Description | Notes
|
|
333
|
+
------------- | ------------- | ------------- | -------------
|
|
334
|
+
**limit** | **Integer**| limit number of results | [optional]
|
|
335
|
+
**offset** | **Integer**| offset of first result | [optional]
|
|
336
|
+
**min_date** | **Date**| minimal date | [optional]
|
|
337
|
+
**max_date** | **Date**| maximum date | [optional]
|
|
338
|
+
**state** | **Integer**| state of user | [optional]
|
|
339
|
+
**period** | **String**| period to group logs | [optional]
|
|
340
|
+
**id_user** | **Integer**| ID of a user | [optional]
|
|
341
|
+
**id_connection** | **Integer**| ID of a connection | [optional]
|
|
342
|
+
**id_bank** | **Integer**| ID of a bank | [optional]
|
|
343
|
+
**charged** | **BOOLEAN**| consider only logs for charged banks | [optional]
|
|
344
|
+
**expand** | **String**| | [optional]
|
|
345
|
+
|
|
346
|
+
### Return type
|
|
347
|
+
|
|
348
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
|
349
|
+
|
|
350
|
+
### Authorization
|
|
351
|
+
|
|
352
|
+
No authorization required
|
|
353
|
+
|
|
354
|
+
### HTTP request headers
|
|
355
|
+
|
|
356
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
357
|
+
- **Accept**: application/json
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
# **providers_get**
|
|
362
|
+
> InlineResponse2007 providers_get(opts)
|
|
363
|
+
|
|
364
|
+
Get list of connectors
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
### Example
|
|
369
|
+
```ruby
|
|
370
|
+
# load the gem
|
|
371
|
+
require 'budgea_client'
|
|
372
|
+
|
|
373
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
374
|
+
|
|
375
|
+
opts = {
|
|
376
|
+
expand: "expand_example" # String |
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
begin
|
|
380
|
+
#Get list of connectors
|
|
381
|
+
result = api_instance.providers_get(opts)
|
|
382
|
+
p result
|
|
383
|
+
rescue BudgeaClient::ApiError => e
|
|
384
|
+
puts "Exception when calling ConnectionsApi->providers_get: #{e}"
|
|
385
|
+
end
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
### Parameters
|
|
389
|
+
|
|
390
|
+
Name | Type | Description | Notes
|
|
391
|
+
------------- | ------------- | ------------- | -------------
|
|
392
|
+
**expand** | **String**| | [optional]
|
|
393
|
+
|
|
394
|
+
### Return type
|
|
395
|
+
|
|
396
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
|
397
|
+
|
|
398
|
+
### Authorization
|
|
399
|
+
|
|
400
|
+
No authorization required
|
|
401
|
+
|
|
402
|
+
### HTTP request headers
|
|
403
|
+
|
|
404
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
405
|
+
- **Accept**: application/json
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
# **users_id_user_connections_delete**
|
|
410
|
+
> Connection users_id_user_connections_delete(id_user, opts)
|
|
411
|
+
|
|
412
|
+
Delete all connections
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
### Example
|
|
417
|
+
```ruby
|
|
418
|
+
# load the gem
|
|
419
|
+
require 'budgea_client'
|
|
420
|
+
|
|
421
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
422
|
+
|
|
423
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
424
|
+
|
|
425
|
+
opts = {
|
|
426
|
+
expand: "expand_example" # String |
|
|
427
|
+
}
|
|
428
|
+
|
|
429
|
+
begin
|
|
430
|
+
#Delete all connections
|
|
431
|
+
result = api_instance.users_id_user_connections_delete(id_user, opts)
|
|
432
|
+
p result
|
|
433
|
+
rescue BudgeaClient::ApiError => e
|
|
434
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_delete: #{e}"
|
|
435
|
+
end
|
|
436
|
+
```
|
|
437
|
+
|
|
438
|
+
### Parameters
|
|
439
|
+
|
|
440
|
+
Name | Type | Description | Notes
|
|
441
|
+
------------- | ------------- | ------------- | -------------
|
|
442
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
443
|
+
**expand** | **String**| | [optional]
|
|
444
|
+
|
|
445
|
+
### Return type
|
|
446
|
+
|
|
447
|
+
[**Connection**](Connection.md)
|
|
448
|
+
|
|
449
|
+
### Authorization
|
|
450
|
+
|
|
451
|
+
No authorization required
|
|
452
|
+
|
|
453
|
+
### HTTP request headers
|
|
454
|
+
|
|
455
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
456
|
+
- **Accept**: application/json
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
# **users_id_user_connections_get**
|
|
461
|
+
> InlineResponse2008 users_id_user_connections_get(id_user, opts)
|
|
462
|
+
|
|
463
|
+
Get connections
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
### Example
|
|
468
|
+
```ruby
|
|
469
|
+
# load the gem
|
|
470
|
+
require 'budgea_client'
|
|
471
|
+
|
|
472
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
473
|
+
|
|
474
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
475
|
+
|
|
476
|
+
opts = {
|
|
477
|
+
expand: "expand_example" # String |
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
begin
|
|
481
|
+
#Get connections
|
|
482
|
+
result = api_instance.users_id_user_connections_get(id_user, opts)
|
|
483
|
+
p result
|
|
484
|
+
rescue BudgeaClient::ApiError => e
|
|
485
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_get: #{e}"
|
|
486
|
+
end
|
|
487
|
+
```
|
|
488
|
+
|
|
489
|
+
### Parameters
|
|
490
|
+
|
|
491
|
+
Name | Type | Description | Notes
|
|
492
|
+
------------- | ------------- | ------------- | -------------
|
|
493
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
494
|
+
**expand** | **String**| | [optional]
|
|
495
|
+
|
|
496
|
+
### Return type
|
|
497
|
+
|
|
498
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
499
|
+
|
|
500
|
+
### Authorization
|
|
501
|
+
|
|
502
|
+
No authorization required
|
|
503
|
+
|
|
504
|
+
### HTTP request headers
|
|
505
|
+
|
|
506
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
507
|
+
- **Accept**: application/json
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
# **users_id_user_connections_id_connection_delete**
|
|
512
|
+
> Connection users_id_user_connections_id_connection_delete(id_user, id_connection, opts)
|
|
513
|
+
|
|
514
|
+
Delete a connection.
|
|
515
|
+
|
|
516
|
+
This endpoint deletes a connection and all related accounts and transactions.<br><br>
|
|
517
|
+
|
|
518
|
+
### Example
|
|
519
|
+
```ruby
|
|
520
|
+
# load the gem
|
|
521
|
+
require 'budgea_client'
|
|
522
|
+
|
|
523
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
524
|
+
|
|
525
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
526
|
+
|
|
527
|
+
id_connection = 56 # Integer |
|
|
528
|
+
|
|
529
|
+
opts = {
|
|
530
|
+
expand: "expand_example" # String |
|
|
531
|
+
}
|
|
532
|
+
|
|
533
|
+
begin
|
|
534
|
+
#Delete a connection.
|
|
535
|
+
result = api_instance.users_id_user_connections_id_connection_delete(id_user, id_connection, opts)
|
|
536
|
+
p result
|
|
537
|
+
rescue BudgeaClient::ApiError => e
|
|
538
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_id_connection_delete: #{e}"
|
|
539
|
+
end
|
|
540
|
+
```
|
|
541
|
+
|
|
542
|
+
### Parameters
|
|
543
|
+
|
|
544
|
+
Name | Type | Description | Notes
|
|
545
|
+
------------- | ------------- | ------------- | -------------
|
|
546
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
547
|
+
**id_connection** | **Integer**| |
|
|
548
|
+
**expand** | **String**| | [optional]
|
|
549
|
+
|
|
550
|
+
### Return type
|
|
551
|
+
|
|
552
|
+
[**Connection**](Connection.md)
|
|
553
|
+
|
|
554
|
+
### Authorization
|
|
555
|
+
|
|
556
|
+
No authorization required
|
|
557
|
+
|
|
558
|
+
### HTTP request headers
|
|
559
|
+
|
|
560
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
561
|
+
- **Accept**: application/json
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
# **users_id_user_connections_id_connection_informations_get**
|
|
566
|
+
> InlineResponse2008 users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts)
|
|
567
|
+
|
|
568
|
+
Get connection additionnal informations
|
|
569
|
+
|
|
570
|
+
<br><br>
|
|
571
|
+
|
|
572
|
+
### Example
|
|
573
|
+
```ruby
|
|
574
|
+
# load the gem
|
|
575
|
+
require 'budgea_client'
|
|
576
|
+
|
|
577
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
578
|
+
|
|
579
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
580
|
+
|
|
581
|
+
id_connection = 56 # Integer |
|
|
582
|
+
|
|
583
|
+
opts = {
|
|
584
|
+
expand: "expand_example" # String |
|
|
585
|
+
}
|
|
586
|
+
|
|
587
|
+
begin
|
|
588
|
+
#Get connection additionnal informations
|
|
589
|
+
result = api_instance.users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts)
|
|
590
|
+
p result
|
|
591
|
+
rescue BudgeaClient::ApiError => e
|
|
592
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_id_connection_informations_get: #{e}"
|
|
593
|
+
end
|
|
594
|
+
```
|
|
595
|
+
|
|
596
|
+
### Parameters
|
|
597
|
+
|
|
598
|
+
Name | Type | Description | Notes
|
|
599
|
+
------------- | ------------- | ------------- | -------------
|
|
600
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
601
|
+
**id_connection** | **Integer**| |
|
|
602
|
+
**expand** | **String**| | [optional]
|
|
603
|
+
|
|
604
|
+
### Return type
|
|
605
|
+
|
|
606
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
607
|
+
|
|
608
|
+
### Authorization
|
|
609
|
+
|
|
610
|
+
No authorization required
|
|
611
|
+
|
|
612
|
+
### HTTP request headers
|
|
613
|
+
|
|
614
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
615
|
+
- **Accept**: application/json
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
# **users_id_user_connections_id_connection_logs_get**
|
|
620
|
+
> InlineResponse20015 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts)
|
|
621
|
+
|
|
622
|
+
Get connection logs
|
|
623
|
+
|
|
624
|
+
Get logs about connections.<br><br>
|
|
625
|
+
|
|
626
|
+
### Example
|
|
627
|
+
```ruby
|
|
628
|
+
# load the gem
|
|
629
|
+
require 'budgea_client'
|
|
630
|
+
|
|
631
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
632
|
+
|
|
633
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
634
|
+
|
|
635
|
+
id_connection = 56 # Integer |
|
|
636
|
+
|
|
637
|
+
opts = {
|
|
638
|
+
limit: 56, # Integer | limit number of results
|
|
639
|
+
offset: 56, # Integer | offset of first result
|
|
640
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal date
|
|
641
|
+
max_date: Date.parse("2013-10-20"), # Date | maximum date
|
|
642
|
+
state: 56, # Integer | state of user
|
|
643
|
+
period: "period_example", # String | period to group logs
|
|
644
|
+
id_user2: 56, # Integer | ID of a user
|
|
645
|
+
id_connection2: 56, # Integer | ID of a connection
|
|
646
|
+
id_bank: 56, # Integer | ID of a bank
|
|
647
|
+
charged: true, # BOOLEAN | consider only logs for charged banks
|
|
648
|
+
expand: "expand_example" # String |
|
|
649
|
+
}
|
|
650
|
+
|
|
651
|
+
begin
|
|
652
|
+
#Get connection logs
|
|
653
|
+
result = api_instance.users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts)
|
|
654
|
+
p result
|
|
655
|
+
rescue BudgeaClient::ApiError => e
|
|
656
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_id_connection_logs_get: #{e}"
|
|
657
|
+
end
|
|
658
|
+
```
|
|
659
|
+
|
|
660
|
+
### Parameters
|
|
661
|
+
|
|
662
|
+
Name | Type | Description | Notes
|
|
663
|
+
------------- | ------------- | ------------- | -------------
|
|
664
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
665
|
+
**id_connection** | **Integer**| |
|
|
666
|
+
**limit** | **Integer**| limit number of results | [optional]
|
|
667
|
+
**offset** | **Integer**| offset of first result | [optional]
|
|
668
|
+
**min_date** | **Date**| minimal date | [optional]
|
|
669
|
+
**max_date** | **Date**| maximum date | [optional]
|
|
670
|
+
**state** | **Integer**| state of user | [optional]
|
|
671
|
+
**period** | **String**| period to group logs | [optional]
|
|
672
|
+
**id_user2** | **Integer**| ID of a user | [optional]
|
|
673
|
+
**id_connection2** | **Integer**| ID of a connection | [optional]
|
|
674
|
+
**id_bank** | **Integer**| ID of a bank | [optional]
|
|
675
|
+
**charged** | **BOOLEAN**| consider only logs for charged banks | [optional]
|
|
676
|
+
**expand** | **String**| | [optional]
|
|
677
|
+
|
|
678
|
+
### Return type
|
|
679
|
+
|
|
680
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
|
681
|
+
|
|
682
|
+
### Authorization
|
|
683
|
+
|
|
684
|
+
No authorization required
|
|
685
|
+
|
|
686
|
+
### HTTP request headers
|
|
687
|
+
|
|
688
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
689
|
+
- **Accept**: application/json
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
# **users_id_user_connections_id_connection_post**
|
|
694
|
+
> Connection users_id_user_connections_id_connection_post(id_user, id_connection, opts)
|
|
695
|
+
|
|
696
|
+
Update a connection.
|
|
697
|
+
|
|
698
|
+
Give new parameters to change on the configuration of this connection (for example \"password\").<br><br>It tests connection to website, and if it fails, a 400 response is given with the error code \"wrongpass\" or \"websiteUnavailable\".<br><br>You can also supply meta-parameters on connection, like 'active' or 'expire'.<br><br>
|
|
699
|
+
|
|
700
|
+
### Example
|
|
701
|
+
```ruby
|
|
702
|
+
# load the gem
|
|
703
|
+
require 'budgea_client'
|
|
704
|
+
|
|
705
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
706
|
+
|
|
707
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
708
|
+
|
|
709
|
+
id_connection = 56 # Integer |
|
|
710
|
+
|
|
711
|
+
opts = {
|
|
712
|
+
active: true, # BOOLEAN | Set if the connection synchronisation is active
|
|
713
|
+
expire: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | Set expiration of the connection to this date
|
|
714
|
+
login: "login_example", # String | Set login to this new login
|
|
715
|
+
password: "password_example", # String | Set password to this new password
|
|
716
|
+
expand: "expand_example" # String |
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
begin
|
|
720
|
+
#Update a connection.
|
|
721
|
+
result = api_instance.users_id_user_connections_id_connection_post(id_user, id_connection, opts)
|
|
722
|
+
p result
|
|
723
|
+
rescue BudgeaClient::ApiError => e
|
|
724
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_id_connection_post: #{e}"
|
|
725
|
+
end
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
### Parameters
|
|
729
|
+
|
|
730
|
+
Name | Type | Description | Notes
|
|
731
|
+
------------- | ------------- | ------------- | -------------
|
|
732
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
733
|
+
**id_connection** | **Integer**| |
|
|
734
|
+
**active** | **BOOLEAN**| Set if the connection synchronisation is active | [optional]
|
|
735
|
+
**expire** | **DateTime**| Set expiration of the connection to this date | [optional]
|
|
736
|
+
**login** | **String**| Set login to this new login | [optional]
|
|
737
|
+
**password** | **String**| Set password to this new password | [optional]
|
|
738
|
+
**expand** | **String**| | [optional]
|
|
739
|
+
|
|
740
|
+
### Return type
|
|
741
|
+
|
|
742
|
+
[**Connection**](Connection.md)
|
|
743
|
+
|
|
744
|
+
### Authorization
|
|
745
|
+
|
|
746
|
+
No authorization required
|
|
747
|
+
|
|
748
|
+
### HTTP request headers
|
|
749
|
+
|
|
750
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
751
|
+
- **Accept**: application/json
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
# **users_id_user_connections_id_connection_put**
|
|
756
|
+
> Connection users_id_user_connections_id_connection_put(id_user, id_connection, opts)
|
|
757
|
+
|
|
758
|
+
Force synchronisation of a connection.
|
|
759
|
+
|
|
760
|
+
We suggest to pass parameter expand=accounts[transactions] to get all *new* and *updated* transactions.<br><br>Query params: - expand (string): fields to expand - last_update (dateTime): if supplied, get transactions inserted since this date<br><br>
|
|
761
|
+
|
|
762
|
+
### Example
|
|
763
|
+
```ruby
|
|
764
|
+
# load the gem
|
|
765
|
+
require 'budgea_client'
|
|
766
|
+
|
|
767
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
768
|
+
|
|
769
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
770
|
+
|
|
771
|
+
id_connection = 56 # Integer |
|
|
772
|
+
|
|
773
|
+
opts = {
|
|
774
|
+
expand: "expand_example" # String |
|
|
775
|
+
}
|
|
776
|
+
|
|
777
|
+
begin
|
|
778
|
+
#Force synchronisation of a connection.
|
|
779
|
+
result = api_instance.users_id_user_connections_id_connection_put(id_user, id_connection, opts)
|
|
780
|
+
p result
|
|
781
|
+
rescue BudgeaClient::ApiError => e
|
|
782
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_id_connection_put: #{e}"
|
|
783
|
+
end
|
|
784
|
+
```
|
|
785
|
+
|
|
786
|
+
### Parameters
|
|
787
|
+
|
|
788
|
+
Name | Type | Description | Notes
|
|
789
|
+
------------- | ------------- | ------------- | -------------
|
|
790
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
791
|
+
**id_connection** | **Integer**| |
|
|
792
|
+
**expand** | **String**| | [optional]
|
|
793
|
+
|
|
794
|
+
### Return type
|
|
795
|
+
|
|
796
|
+
[**Connection**](Connection.md)
|
|
797
|
+
|
|
798
|
+
### Authorization
|
|
799
|
+
|
|
800
|
+
No authorization required
|
|
801
|
+
|
|
802
|
+
### HTTP request headers
|
|
803
|
+
|
|
804
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
805
|
+
- **Accept**: application/json
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
# **users_id_user_connections_post**
|
|
810
|
+
> Connection users_id_user_connections_post(id_user, opts)
|
|
811
|
+
|
|
812
|
+
Add a new connection.
|
|
813
|
+
|
|
814
|
+
Create a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).<br><br>
|
|
815
|
+
|
|
816
|
+
### Example
|
|
817
|
+
```ruby
|
|
818
|
+
# load the gem
|
|
819
|
+
require 'budgea_client'
|
|
820
|
+
|
|
821
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
822
|
+
|
|
823
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
824
|
+
|
|
825
|
+
opts = {
|
|
826
|
+
id_bank: 56, # Integer | ID of the bank
|
|
827
|
+
id_provider: 56, # Integer | ID of the provider
|
|
828
|
+
expand: "expand_example" # String |
|
|
829
|
+
}
|
|
830
|
+
|
|
831
|
+
begin
|
|
832
|
+
#Add a new connection.
|
|
833
|
+
result = api_instance.users_id_user_connections_post(id_user, opts)
|
|
834
|
+
p result
|
|
835
|
+
rescue BudgeaClient::ApiError => e
|
|
836
|
+
puts "Exception when calling ConnectionsApi->users_id_user_connections_post: #{e}"
|
|
837
|
+
end
|
|
838
|
+
```
|
|
839
|
+
|
|
840
|
+
### Parameters
|
|
841
|
+
|
|
842
|
+
Name | Type | Description | Notes
|
|
843
|
+
------------- | ------------- | ------------- | -------------
|
|
844
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
845
|
+
**id_bank** | **Integer**| ID of the bank | [optional]
|
|
846
|
+
**id_provider** | **Integer**| ID of the provider | [optional]
|
|
847
|
+
**expand** | **String**| | [optional]
|
|
848
|
+
|
|
849
|
+
### Return type
|
|
850
|
+
|
|
851
|
+
[**Connection**](Connection.md)
|
|
852
|
+
|
|
853
|
+
### Authorization
|
|
854
|
+
|
|
855
|
+
No authorization required
|
|
856
|
+
|
|
857
|
+
### HTTP request headers
|
|
858
|
+
|
|
859
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
860
|
+
- **Accept**: application/json
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
# **users_id_user_logs_get**
|
|
865
|
+
> InlineResponse20015 users_id_user_logs_get(id_user, opts)
|
|
866
|
+
|
|
867
|
+
Get connection logs
|
|
868
|
+
|
|
869
|
+
Get logs about connections.<br><br>
|
|
870
|
+
|
|
871
|
+
### Example
|
|
872
|
+
```ruby
|
|
873
|
+
# load the gem
|
|
874
|
+
require 'budgea_client'
|
|
875
|
+
|
|
876
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
877
|
+
|
|
878
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
879
|
+
|
|
880
|
+
opts = {
|
|
881
|
+
limit: 56, # Integer | limit number of results
|
|
882
|
+
offset: 56, # Integer | offset of first result
|
|
883
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal date
|
|
884
|
+
max_date: Date.parse("2013-10-20"), # Date | maximum date
|
|
885
|
+
state: 56, # Integer | state of user
|
|
886
|
+
period: "period_example", # String | period to group logs
|
|
887
|
+
id_user2: 56, # Integer | ID of a user
|
|
888
|
+
id_connection: 56, # Integer | ID of a connection
|
|
889
|
+
id_bank: 56, # Integer | ID of a bank
|
|
890
|
+
charged: true, # BOOLEAN | consider only logs for charged banks
|
|
891
|
+
expand: "expand_example" # String |
|
|
892
|
+
}
|
|
893
|
+
|
|
894
|
+
begin
|
|
895
|
+
#Get connection logs
|
|
896
|
+
result = api_instance.users_id_user_logs_get(id_user, opts)
|
|
897
|
+
p result
|
|
898
|
+
rescue BudgeaClient::ApiError => e
|
|
899
|
+
puts "Exception when calling ConnectionsApi->users_id_user_logs_get: #{e}"
|
|
900
|
+
end
|
|
901
|
+
```
|
|
902
|
+
|
|
903
|
+
### Parameters
|
|
904
|
+
|
|
905
|
+
Name | Type | Description | Notes
|
|
906
|
+
------------- | ------------- | ------------- | -------------
|
|
907
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
908
|
+
**limit** | **Integer**| limit number of results | [optional]
|
|
909
|
+
**offset** | **Integer**| offset of first result | [optional]
|
|
910
|
+
**min_date** | **Date**| minimal date | [optional]
|
|
911
|
+
**max_date** | **Date**| maximum date | [optional]
|
|
912
|
+
**state** | **Integer**| state of user | [optional]
|
|
913
|
+
**period** | **String**| period to group logs | [optional]
|
|
914
|
+
**id_user2** | **Integer**| ID of a user | [optional]
|
|
915
|
+
**id_connection** | **Integer**| ID of a connection | [optional]
|
|
916
|
+
**id_bank** | **Integer**| ID of a bank | [optional]
|
|
917
|
+
**charged** | **BOOLEAN**| consider only logs for charged banks | [optional]
|
|
918
|
+
**expand** | **String**| | [optional]
|
|
919
|
+
|
|
920
|
+
### Return type
|
|
921
|
+
|
|
922
|
+
[**InlineResponse20015**](InlineResponse20015.md)
|
|
923
|
+
|
|
924
|
+
### Authorization
|
|
925
|
+
|
|
926
|
+
No authorization required
|
|
927
|
+
|
|
928
|
+
### HTTP request headers
|
|
929
|
+
|
|
930
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
931
|
+
- **Accept**: application/json
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|