budgea_client 1.4.4 → 2.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 +4 -4
- data/Gemfile.lock +5 -5
- data/README.md +67 -725
- data/budgea_client.gemspec +15 -3
- data/budgea_openapi.json +2011 -524
- data/docs/Account.md +3 -1
- data/docs/AccountLog.md +2 -2
- data/docs/AdministrationApi.md +354 -34
- data/docs/AuthenticationApi.md +264 -18
- data/docs/BankCategory.md +1 -1
- data/docs/BanksApi.md +939 -550
- data/docs/Certificate.md +12 -0
- data/docs/Client.md +5 -2
- data/docs/Connection.md +1 -1
- data/docs/ConnectionLog.md +3 -2
- data/docs/ConnectionsApi.md +162 -103
- data/docs/Connector.md +21 -0
- data/docs/ConnectorCategory.md +9 -0
- data/docs/ConnectorLogo.md +1 -1
- data/docs/Currency.md +4 -0
- data/docs/DocumentsApi.md +350 -350
- data/docs/Field.md +3 -2
- data/docs/InlineResponse20010.md +1 -1
- data/docs/InlineResponse20011.md +1 -1
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +1 -1
- data/docs/InlineResponse20014.md +1 -1
- data/docs/InlineResponse20015.md +1 -1
- data/docs/InlineResponse20016.md +1 -1
- data/docs/InlineResponse20017.md +1 -1
- data/docs/InlineResponse20018.md +1 -1
- data/docs/InlineResponse20019.md +1 -1
- data/docs/InlineResponse20020.md +1 -1
- data/docs/InlineResponse20021.md +1 -1
- data/docs/InlineResponse20022.md +1 -1
- data/docs/InlineResponse20023.md +1 -1
- data/docs/InlineResponse20024.md +1 -1
- data/docs/InlineResponse20025.md +1 -1
- data/docs/InlineResponse20026.md +1 -1
- data/docs/InlineResponse20027.md +1 -1
- data/docs/InlineResponse20028.md +1 -1
- data/docs/InlineResponse20029.md +1 -1
- data/docs/InlineResponse2003.md +2 -3
- data/docs/InlineResponse20030.md +1 -1
- data/docs/InlineResponse20031.md +1 -1
- data/docs/InlineResponse20032.md +1 -1
- data/docs/InlineResponse20033.md +1 -1
- data/docs/InlineResponse20034.md +8 -0
- data/docs/InlineResponse20035.md +8 -0
- data/docs/InlineResponse20036.md +8 -0
- data/docs/InlineResponse2004.md +0 -2
- data/docs/InlineResponse2005.md +5 -2
- data/docs/InlineResponse2006.md +2 -3
- data/docs/InlineResponse2007.md +3 -1
- data/docs/InlineResponse2008.md +1 -1
- data/docs/InlineResponse2009.md +1 -1
- data/docs/OCRApi.md +5 -5
- data/docs/OIDCApi.md +5 -5
- data/docs/PFMApi.md +122 -122
- data/docs/Pocket.md +1 -1
- data/docs/Profile.md +1 -1
- data/docs/Project.md +1 -1
- data/docs/ProvidersApi.md +602 -604
- data/docs/Recipient.md +3 -0
- data/docs/RecipientLog.md +14 -0
- data/docs/RecipientsApi.md +28 -20
- data/docs/Subscription.md +2 -1
- data/docs/TermsApi.md +13 -15
- data/docs/Transaction.md +8 -3
- data/docs/Transfer.md +1 -0
- data/docs/TransferLog.md +14 -0
- data/docs/TransfersApi.md +165 -141
- data/docs/UserAlert.md +2 -2
- data/docs/UsersManagementApi.md +24 -24
- data/docs/WealthApi.md +54 -54
- data/docs/WebhookLog.md +15 -0
- data/lib/budgea_client.rb +27 -3
- data/lib/budgea_client/api/administration_api.rb +425 -106
- data/lib/budgea_client/api/authentication_api.rb +287 -46
- data/lib/budgea_client/api/banks_api.rb +1271 -974
- data/lib/budgea_client/api/connections_api.rb +207 -156
- data/lib/budgea_client/api/documents_api.rb +627 -693
- data/lib/budgea_client/api/ocr_api.rb +24 -16
- data/lib/budgea_client/api/oidc_api.rb +23 -16
- data/lib/budgea_client/api/pfm_api.rb +219 -248
- data/lib/budgea_client/api/providers_api.rb +998 -1099
- data/lib/budgea_client/api/recipients_api.rb +52 -34
- data/lib/budgea_client/api/terms_api.rb +34 -31
- data/lib/budgea_client/api/transfers_api.rb +245 -239
- data/lib/budgea_client/api/users_management_api.rb +56 -58
- data/lib/budgea_client/api/wealth_api.rb +81 -85
- data/lib/budgea_client/api_client.rb +20 -11
- data/lib/budgea_client/api_error.rb +11 -1
- data/lib/budgea_client/configuration.rb +12 -2
- data/lib/budgea_client/models/access.rb +18 -13
- data/lib/budgea_client/models/account.rb +44 -23
- data/lib/budgea_client/models/account_log.rb +33 -28
- data/lib/budgea_client/models/account_type.rb +22 -17
- data/lib/budgea_client/models/alert.rb +21 -16
- data/lib/budgea_client/models/bank.rb +21 -16
- data/lib/budgea_client/models/bank_category.rb +19 -14
- data/lib/budgea_client/models/category.rb +22 -17
- data/lib/budgea_client/models/certificate.rb +244 -0
- data/lib/budgea_client/models/client.rb +53 -20
- data/lib/budgea_client/models/connection.rb +29 -24
- data/lib/budgea_client/models/connection_log.rb +39 -24
- data/lib/budgea_client/models/connector.rb +345 -0
- data/lib/budgea_client/models/connector_category.rb +206 -0
- data/lib/budgea_client/models/connector_logo.rb +29 -24
- data/lib/budgea_client/models/currency.rb +63 -16
- data/lib/budgea_client/models/device.rb +23 -18
- data/lib/budgea_client/models/document.rb +21 -16
- data/lib/budgea_client/models/document_type.rb +19 -14
- data/lib/budgea_client/models/field.rb +44 -27
- data/lib/budgea_client/models/field_value.rb +18 -13
- data/lib/budgea_client/models/file.rb +20 -15
- data/lib/budgea_client/models/group.rb +17 -12
- data/lib/budgea_client/models/hash_table.rb +20 -15
- data/lib/budgea_client/models/inline_response_200.rb +17 -12
- data/lib/budgea_client/models/inline_response_200_1.rb +18 -13
- data/lib/budgea_client/models/inline_response_200_10.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_11.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_12.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_13.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_14.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_15.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_16.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_17.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_18.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_19.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_2.rb +18 -13
- data/lib/budgea_client/models/inline_response_200_20.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_21.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_22.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_23.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_24.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_25.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_26.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_27.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_28.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_29.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_3.rb +37 -47
- data/lib/budgea_client/models/inline_response_200_30.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_31.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_32.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_33.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_34.rb +190 -0
- data/lib/budgea_client/models/inline_response_200_35.rb +190 -0
- data/lib/budgea_client/models/inline_response_200_36.rb +190 -0
- data/lib/budgea_client/models/inline_response_200_4.rb +20 -40
- data/lib/budgea_client/models/inline_response_200_5.rb +75 -30
- data/lib/budgea_client/models/inline_response_200_6.rb +37 -47
- data/lib/budgea_client/models/inline_response_200_7.rb +55 -21
- data/lib/budgea_client/models/inline_response_200_8.rb +27 -22
- data/lib/budgea_client/models/inline_response_200_9.rb +27 -22
- data/lib/budgea_client/models/investment.rb +20 -15
- data/lib/budgea_client/models/investment_value.rb +20 -15
- data/lib/budgea_client/models/invite.rb +18 -13
- data/lib/budgea_client/models/locked_user.rb +18 -13
- data/lib/budgea_client/models/oidc_whitelist.rb +18 -13
- data/lib/budgea_client/models/pocket.rb +22 -17
- data/lib/budgea_client/models/profile.rb +26 -20
- data/lib/budgea_client/models/project.rb +26 -21
- data/lib/budgea_client/models/project_type.rb +18 -13
- data/lib/budgea_client/models/recipient.rb +52 -17
- data/lib/budgea_client/models/recipient_log.rb +254 -0
- data/lib/budgea_client/models/security.rb +18 -13
- data/lib/budgea_client/models/subscription.rb +31 -21
- data/lib/budgea_client/models/terms_of_service.rb +19 -14
- data/lib/budgea_client/models/transaction.rb +83 -33
- data/lib/budgea_client/models/transaction_information.rb +19 -14
- data/lib/budgea_client/models/transactions_cluster.rb +21 -16
- data/lib/budgea_client/models/transfer.rb +32 -16
- data/lib/budgea_client/models/transfer_log.rb +254 -0
- data/lib/budgea_client/models/user.rb +22 -16
- data/lib/budgea_client/models/user_alert.rb +22 -16
- data/lib/budgea_client/models/webhook.rb +19 -14
- data/lib/budgea_client/models/webhook_log.rb +264 -0
- data/lib/budgea_client/version.rb +12 -2
- data/original_budgea_openapi.json +23188 -0
- data/spec/models/certificate_spec.rb +65 -0
- data/spec/models/connector_category_spec.rb +47 -0
- data/spec/models/connector_spec.rb +119 -0
- data/spec/models/inline_response_200_34_spec.rb +41 -0
- data/spec/models/inline_response_200_35_spec.rb +41 -0
- data/spec/models/inline_response_200_36_spec.rb +41 -0
- data/spec/models/recipient_log_spec.rb +77 -0
- data/spec/models/transfer_log_spec.rb +77 -0
- data/spec/models/webhook_log_spec.rb +83 -0
- metadata +52 -18
- data/pkg/budgea_client-1.3.9.gem +0 -0
- data/pkg/budgea_client-1.4.2.gem +0 -0
- data/pkg/budgea_client-1.4.3.gem +0 -0
data/docs/Certificate.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# BudgeaClient::Certificate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | |
|
|
7
|
+
**id_public_key_file** | **Integer** | |
|
|
8
|
+
**id_private_key_file** | **Integer** | |
|
|
9
|
+
**type** | **String** | |
|
|
10
|
+
**created** | **DateTime** | |
|
|
11
|
+
|
|
12
|
+
|
data/docs/Client.md
CHANGED
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**id** | **Integer** | |
|
|
7
|
-
**name** | **String** | | [default to
|
|
7
|
+
**name** | **String** | | [default to '']
|
|
8
8
|
**secret** | **String** | |
|
|
9
|
-
**
|
|
9
|
+
**public_key** | **String** | | [optional]
|
|
10
|
+
**private_key** | **String** | | [optional]
|
|
11
|
+
**redirect_uri** | **String** | | [default to '']
|
|
10
12
|
**primary_color** | **String** | Primary color of client | [optional]
|
|
11
13
|
**secondary_color** | **String** | Secondary color of client | [optional]
|
|
12
14
|
**pro** | **BOOLEAN** | Should the client display the company manager page. | [default to false]
|
|
@@ -14,5 +16,6 @@ Name | Type | Description | Notes
|
|
|
14
16
|
**description_banks** | **String** | Text to display as a description for banks. | [optional]
|
|
15
17
|
**description_providers** | **String** | Text to display as a description for providers. | [optional]
|
|
16
18
|
**id_logo** | **Integer** | | [optional]
|
|
19
|
+
**information** | **String** | customizable information | [optional]
|
|
17
20
|
|
|
18
21
|
|
data/docs/Connection.md
CHANGED
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**id** | **Integer** | ID of connection |
|
|
7
7
|
**id_user** | **Integer** | ID of the related user | [optional]
|
|
8
|
-
**
|
|
8
|
+
**id_connector** | **Integer** | ID of the related connector |
|
|
9
9
|
**last_update** | **DateTime** | Last successful update | [optional]
|
|
10
10
|
**error** | **String** | If the last update has failed, the error code | [optional]
|
|
11
11
|
**expire** | **DateTime** | Expiration of the connection. Used during add of a two-factor authentication, to purge the connection if the user abort | [optional]
|
data/docs/ConnectionLog.md
CHANGED
|
@@ -6,16 +6,17 @@ Name | Type | Description | Notes
|
|
|
6
6
|
**id** | **Integer** | ID of the log |
|
|
7
7
|
**id_user** | **Integer** | ID of the user | [optional]
|
|
8
8
|
**id_connection** | **Integer** | ID of the connection |
|
|
9
|
-
**
|
|
9
|
+
**id_connector** | **Integer** | ID of the connector | [optional]
|
|
10
10
|
**login** | **String** | bcrypt hash of the login | [optional]
|
|
11
11
|
**error_uid** | **String** | MD5 hash of the exception backtrace | [optional]
|
|
12
12
|
**timestamp** | **DateTime** | Timestamp of log, when the synchronization has finished |
|
|
13
13
|
**next_try** | **DateTime** | If fail, the date represents the next try to connect | [optional]
|
|
14
14
|
**error** | **String** | If fail, contains the error code | [optional]
|
|
15
|
-
**error_message** | **String** | If fail, error message received from
|
|
15
|
+
**error_message** | **String** | If fail, error message received from connector | [optional]
|
|
16
16
|
**statut** | **Integer** | Status of user (1 = charged user) | [optional]
|
|
17
17
|
**nb_accounts** | **Integer** | In case of bank connection, number of accounts | [optional]
|
|
18
18
|
**start** | **DateTime** | Timestamp when the synchronization has started | [optional]
|
|
19
19
|
**worker** | **String** | Worker used to do synchronization | [optional]
|
|
20
|
+
**session_folder_id** | **String** | Session folder uid | [optional]
|
|
20
21
|
|
|
21
22
|
|
data/docs/ConnectionsApi.md
CHANGED
|
@@ -5,12 +5,13 @@ All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**banks_get**](ConnectionsApi.md#banks_get) | **GET** /banks | Get list of connectors
|
|
8
|
-
[**
|
|
8
|
+
[**banks_id_connector_connections_get**](ConnectionsApi.md#banks_id_connector_connections_get) | **GET** /banks/{id_connector}/connections | Get a subset of id_connection with the largest diversity of account
|
|
9
9
|
[**connections_get**](ConnectionsApi.md#connections_get) | **GET** /connections | Get connections without a user
|
|
10
10
|
[**connectors_get**](ConnectionsApi.md#connectors_get) | **GET** /connectors | Get list of connectors
|
|
11
11
|
[**connectors_post**](ConnectionsApi.md#connectors_post) | **POST** /connectors | Request a new connector
|
|
12
12
|
[**logs_get**](ConnectionsApi.md#logs_get) | **GET** /logs | Get connection logs
|
|
13
13
|
[**providers_get**](ConnectionsApi.md#providers_get) | **GET** /providers | Get list of connectors
|
|
14
|
+
[**providers_id_connector_connections_get**](ConnectionsApi.md#providers_id_connector_connections_get) | **GET** /providers/{id_connector}/connections | Get a random subset of provider's id_connection
|
|
14
15
|
[**users_id_user_connections_delete**](ConnectionsApi.md#users_id_user_connections_delete) | **DELETE** /users/{id_user}/connections | Delete all connections
|
|
15
16
|
[**users_id_user_connections_get**](ConnectionsApi.md#users_id_user_connections_get) | **GET** /users/{id_user}/connections | Get connections
|
|
16
17
|
[**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.
|
|
@@ -23,7 +24,7 @@ Method | HTTP request | Description
|
|
|
23
24
|
|
|
24
25
|
|
|
25
26
|
# **banks_get**
|
|
26
|
-
>
|
|
27
|
+
> InlineResponse2008 banks_get(opts)
|
|
27
28
|
|
|
28
29
|
Get list of connectors
|
|
29
30
|
|
|
@@ -44,7 +45,7 @@ end
|
|
|
44
45
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
45
46
|
|
|
46
47
|
opts = {
|
|
47
|
-
expand:
|
|
48
|
+
expand: 'expand_example' # String |
|
|
48
49
|
}
|
|
49
50
|
|
|
50
51
|
begin
|
|
@@ -64,7 +65,7 @@ Name | Type | Description | Notes
|
|
|
64
65
|
|
|
65
66
|
### Return type
|
|
66
67
|
|
|
67
|
-
[**
|
|
68
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
68
69
|
|
|
69
70
|
### Authorization
|
|
70
71
|
|
|
@@ -77,8 +78,8 @@ Name | Type | Description | Notes
|
|
|
77
78
|
|
|
78
79
|
|
|
79
80
|
|
|
80
|
-
# **
|
|
81
|
-
>
|
|
81
|
+
# **banks_id_connector_connections_get**
|
|
82
|
+
> InlineResponse2009 banks_id_connector_connections_get(id_connector, opts)
|
|
82
83
|
|
|
83
84
|
Get a subset of id_connection with the largest diversity of account
|
|
84
85
|
|
|
@@ -98,20 +99,20 @@ end
|
|
|
98
99
|
|
|
99
100
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
100
101
|
|
|
101
|
-
|
|
102
|
+
id_connector = 56 # Integer |
|
|
102
103
|
|
|
103
104
|
opts = {
|
|
104
105
|
range: 56, # Integer | the length of the connection subset
|
|
105
106
|
type: 56, # Integer | to target a specific account type which will be
|
|
106
|
-
expand:
|
|
107
|
+
expand: 'expand_example' # String |
|
|
107
108
|
}
|
|
108
109
|
|
|
109
110
|
begin
|
|
110
111
|
#Get a subset of id_connection with the largest diversity of account
|
|
111
|
-
result = api_instance.
|
|
112
|
+
result = api_instance.banks_id_connector_connections_get(id_connector, opts)
|
|
112
113
|
p result
|
|
113
114
|
rescue BudgeaClient::ApiError => e
|
|
114
|
-
puts "Exception when calling ConnectionsApi->
|
|
115
|
+
puts "Exception when calling ConnectionsApi->banks_id_connector_connections_get: #{e}"
|
|
115
116
|
end
|
|
116
117
|
```
|
|
117
118
|
|
|
@@ -119,14 +120,14 @@ end
|
|
|
119
120
|
|
|
120
121
|
Name | Type | Description | Notes
|
|
121
122
|
------------- | ------------- | ------------- | -------------
|
|
122
|
-
**
|
|
123
|
+
**id_connector** | **Integer**| |
|
|
123
124
|
**range** | **Integer**| the length of the connection subset | [optional]
|
|
124
125
|
**type** | **Integer**| to target a specific account type which will be | [optional]
|
|
125
126
|
**expand** | **String**| | [optional]
|
|
126
127
|
|
|
127
128
|
### Return type
|
|
128
129
|
|
|
129
|
-
[**
|
|
130
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
|
130
131
|
|
|
131
132
|
### Authorization
|
|
132
133
|
|
|
@@ -140,7 +141,7 @@ Name | Type | Description | Notes
|
|
|
140
141
|
|
|
141
142
|
|
|
142
143
|
# **connections_get**
|
|
143
|
-
>
|
|
144
|
+
> InlineResponse2009 connections_get(opts)
|
|
144
145
|
|
|
145
146
|
Get connections without a user
|
|
146
147
|
|
|
@@ -161,7 +162,7 @@ end
|
|
|
161
162
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
162
163
|
|
|
163
164
|
opts = {
|
|
164
|
-
expand:
|
|
165
|
+
expand: 'expand_example' # String |
|
|
165
166
|
}
|
|
166
167
|
|
|
167
168
|
begin
|
|
@@ -181,7 +182,7 @@ Name | Type | Description | Notes
|
|
|
181
182
|
|
|
182
183
|
### Return type
|
|
183
184
|
|
|
184
|
-
[**
|
|
185
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
|
185
186
|
|
|
186
187
|
### Authorization
|
|
187
188
|
|
|
@@ -195,7 +196,7 @@ Name | Type | Description | Notes
|
|
|
195
196
|
|
|
196
197
|
|
|
197
198
|
# **connectors_get**
|
|
198
|
-
>
|
|
199
|
+
> InlineResponse20013 connectors_get(opts)
|
|
199
200
|
|
|
200
201
|
Get list of connectors
|
|
201
202
|
|
|
@@ -216,7 +217,7 @@ end
|
|
|
216
217
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
217
218
|
|
|
218
219
|
opts = {
|
|
219
|
-
expand:
|
|
220
|
+
expand: 'expand_example' # String |
|
|
220
221
|
}
|
|
221
222
|
|
|
222
223
|
begin
|
|
@@ -236,7 +237,7 @@ Name | Type | Description | Notes
|
|
|
236
237
|
|
|
237
238
|
### Return type
|
|
238
239
|
|
|
239
|
-
[**
|
|
240
|
+
[**InlineResponse20013**](InlineResponse20013.md)
|
|
240
241
|
|
|
241
242
|
### Authorization
|
|
242
243
|
|
|
@@ -250,7 +251,7 @@ Name | Type | Description | Notes
|
|
|
250
251
|
|
|
251
252
|
|
|
252
253
|
# **connectors_post**
|
|
253
|
-
>
|
|
254
|
+
> Connector connectors_post(name, login, password, opts)
|
|
254
255
|
|
|
255
256
|
Request a new connector
|
|
256
257
|
|
|
@@ -270,20 +271,20 @@ end
|
|
|
270
271
|
|
|
271
272
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
272
273
|
|
|
273
|
-
name =
|
|
274
|
+
name = 'name_example' # String | Name of the bank or provider
|
|
274
275
|
|
|
275
|
-
login =
|
|
276
|
+
login = 'login_example' # String | Users login
|
|
276
277
|
|
|
277
|
-
password =
|
|
278
|
+
password = 'password_example' # String | Users password
|
|
278
279
|
|
|
279
280
|
opts = {
|
|
280
|
-
api:
|
|
281
|
-
url:
|
|
282
|
-
email:
|
|
283
|
-
types:
|
|
284
|
-
comment:
|
|
281
|
+
api: 'api_example', # String | Name of the API
|
|
282
|
+
url: 'url_example', # String | Url of the bank
|
|
283
|
+
email: 'email_example', # String | Email of the user
|
|
284
|
+
types: 'types_example', # String | Type of connector, eg. banks or providers
|
|
285
|
+
comment: 'comment_example', # String | Optionnal comment
|
|
285
286
|
sendmail: true, # BOOLEAN | if set, send an email to user
|
|
286
|
-
expand:
|
|
287
|
+
expand: 'expand_example' # String |
|
|
287
288
|
}
|
|
288
289
|
|
|
289
290
|
begin
|
|
@@ -312,7 +313,7 @@ Name | Type | Description | Notes
|
|
|
312
313
|
|
|
313
314
|
### Return type
|
|
314
315
|
|
|
315
|
-
[**
|
|
316
|
+
[**Connector**](Connector.md)
|
|
316
317
|
|
|
317
318
|
### Authorization
|
|
318
319
|
|
|
@@ -320,13 +321,13 @@ Name | Type | Description | Notes
|
|
|
320
321
|
|
|
321
322
|
### HTTP request headers
|
|
322
323
|
|
|
323
|
-
- **Content-Type**:
|
|
324
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
324
325
|
- **Accept**: application/json
|
|
325
326
|
|
|
326
327
|
|
|
327
328
|
|
|
328
329
|
# **logs_get**
|
|
329
|
-
>
|
|
330
|
+
> InlineResponse20016 logs_get(opts)
|
|
330
331
|
|
|
331
332
|
Get connection logs
|
|
332
333
|
|
|
@@ -349,15 +350,15 @@ api_instance = BudgeaClient::ConnectionsApi.new
|
|
|
349
350
|
opts = {
|
|
350
351
|
limit: 56, # Integer | limit number of results
|
|
351
352
|
offset: 56, # Integer | offset of first result
|
|
352
|
-
min_date: Date.parse(
|
|
353
|
-
max_date: Date.parse(
|
|
353
|
+
min_date: Date.parse('2013-10-20'), # Date | minimal date
|
|
354
|
+
max_date: Date.parse('2013-10-20'), # Date | maximum date
|
|
354
355
|
state: 56, # Integer | state of user
|
|
355
|
-
period:
|
|
356
|
+
period: 'period_example', # String | period to group logs
|
|
356
357
|
id_user: 56, # Integer | ID of a user
|
|
357
358
|
id_connection: 56, # Integer | ID of a connection
|
|
358
|
-
|
|
359
|
-
charged: true, # BOOLEAN | consider only logs for charged
|
|
360
|
-
expand:
|
|
359
|
+
id_connector: 56, # Integer | ID of a connector
|
|
360
|
+
charged: true, # BOOLEAN | consider only logs for charged connectors
|
|
361
|
+
expand: 'expand_example' # String |
|
|
361
362
|
}
|
|
362
363
|
|
|
363
364
|
begin
|
|
@@ -381,13 +382,13 @@ Name | Type | Description | Notes
|
|
|
381
382
|
**period** | **String**| period to group logs | [optional]
|
|
382
383
|
**id_user** | **Integer**| ID of a user | [optional]
|
|
383
384
|
**id_connection** | **Integer**| ID of a connection | [optional]
|
|
384
|
-
**
|
|
385
|
-
**charged** | **BOOLEAN**| consider only logs for charged
|
|
385
|
+
**id_connector** | **Integer**| ID of a connector | [optional]
|
|
386
|
+
**charged** | **BOOLEAN**| consider only logs for charged connectors | [optional]
|
|
386
387
|
**expand** | **String**| | [optional]
|
|
387
388
|
|
|
388
389
|
### Return type
|
|
389
390
|
|
|
390
|
-
[**
|
|
391
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
|
391
392
|
|
|
392
393
|
### Authorization
|
|
393
394
|
|
|
@@ -401,7 +402,7 @@ Name | Type | Description | Notes
|
|
|
401
402
|
|
|
402
403
|
|
|
403
404
|
# **providers_get**
|
|
404
|
-
>
|
|
405
|
+
> InlineResponse20017 providers_get(opts)
|
|
405
406
|
|
|
406
407
|
Get list of connectors
|
|
407
408
|
|
|
@@ -422,7 +423,7 @@ end
|
|
|
422
423
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
423
424
|
|
|
424
425
|
opts = {
|
|
425
|
-
expand:
|
|
426
|
+
expand: 'expand_example' # String |
|
|
426
427
|
}
|
|
427
428
|
|
|
428
429
|
begin
|
|
@@ -442,7 +443,67 @@ Name | Type | Description | Notes
|
|
|
442
443
|
|
|
443
444
|
### Return type
|
|
444
445
|
|
|
445
|
-
[**
|
|
446
|
+
[**InlineResponse20017**](InlineResponse20017.md)
|
|
447
|
+
|
|
448
|
+
### Authorization
|
|
449
|
+
|
|
450
|
+
[api_key](../README.md#api_key)
|
|
451
|
+
|
|
452
|
+
### HTTP request headers
|
|
453
|
+
|
|
454
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
455
|
+
- **Accept**: application/json
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
# **providers_id_connector_connections_get**
|
|
460
|
+
> InlineResponse2009 providers_id_connector_connections_get(id_connector, opts)
|
|
461
|
+
|
|
462
|
+
Get a random subset of provider's id_connection
|
|
463
|
+
|
|
464
|
+
By default, it selects a set of 3 connections.<br><br>
|
|
465
|
+
|
|
466
|
+
### Example
|
|
467
|
+
```ruby
|
|
468
|
+
# load the gem
|
|
469
|
+
require 'budgea_client'
|
|
470
|
+
# setup authorization
|
|
471
|
+
BudgeaClient.configure do |config|
|
|
472
|
+
# Configure API key authorization: api_key
|
|
473
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
474
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
475
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
476
|
+
end
|
|
477
|
+
|
|
478
|
+
api_instance = BudgeaClient::ConnectionsApi.new
|
|
479
|
+
|
|
480
|
+
id_connector = 56 # Integer |
|
|
481
|
+
|
|
482
|
+
opts = {
|
|
483
|
+
range: 56, # Integer | the length of the connection subset
|
|
484
|
+
expand: 'expand_example' # String |
|
|
485
|
+
}
|
|
486
|
+
|
|
487
|
+
begin
|
|
488
|
+
#Get a random subset of provider's id_connection
|
|
489
|
+
result = api_instance.providers_id_connector_connections_get(id_connector, opts)
|
|
490
|
+
p result
|
|
491
|
+
rescue BudgeaClient::ApiError => e
|
|
492
|
+
puts "Exception when calling ConnectionsApi->providers_id_connector_connections_get: #{e}"
|
|
493
|
+
end
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
### Parameters
|
|
497
|
+
|
|
498
|
+
Name | Type | Description | Notes
|
|
499
|
+
------------- | ------------- | ------------- | -------------
|
|
500
|
+
**id_connector** | **Integer**| |
|
|
501
|
+
**range** | **Integer**| the length of the connection subset | [optional]
|
|
502
|
+
**expand** | **String**| | [optional]
|
|
503
|
+
|
|
504
|
+
### Return type
|
|
505
|
+
|
|
506
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
|
446
507
|
|
|
447
508
|
### Authorization
|
|
448
509
|
|
|
@@ -476,10 +537,10 @@ end
|
|
|
476
537
|
|
|
477
538
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
478
539
|
|
|
479
|
-
id_user =
|
|
540
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
480
541
|
|
|
481
542
|
opts = {
|
|
482
|
-
expand:
|
|
543
|
+
expand: 'expand_example' # String |
|
|
483
544
|
}
|
|
484
545
|
|
|
485
546
|
begin
|
|
@@ -514,7 +575,7 @@ Name | Type | Description | Notes
|
|
|
514
575
|
|
|
515
576
|
|
|
516
577
|
# **users_id_user_connections_get**
|
|
517
|
-
>
|
|
578
|
+
> InlineResponse2009 users_id_user_connections_get(id_user, opts)
|
|
518
579
|
|
|
519
580
|
Get connections
|
|
520
581
|
|
|
@@ -534,10 +595,10 @@ end
|
|
|
534
595
|
|
|
535
596
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
536
597
|
|
|
537
|
-
id_user =
|
|
598
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
538
599
|
|
|
539
600
|
opts = {
|
|
540
|
-
expand:
|
|
601
|
+
expand: 'expand_example' # String |
|
|
541
602
|
}
|
|
542
603
|
|
|
543
604
|
begin
|
|
@@ -558,7 +619,7 @@ Name | Type | Description | Notes
|
|
|
558
619
|
|
|
559
620
|
### Return type
|
|
560
621
|
|
|
561
|
-
[**
|
|
622
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
|
562
623
|
|
|
563
624
|
### Authorization
|
|
564
625
|
|
|
@@ -592,12 +653,12 @@ end
|
|
|
592
653
|
|
|
593
654
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
594
655
|
|
|
595
|
-
id_user =
|
|
656
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
596
657
|
|
|
597
658
|
id_connection = 56 # Integer |
|
|
598
659
|
|
|
599
660
|
opts = {
|
|
600
|
-
expand:
|
|
661
|
+
expand: 'expand_example' # String |
|
|
601
662
|
}
|
|
602
663
|
|
|
603
664
|
begin
|
|
@@ -633,7 +694,7 @@ Name | Type | Description | Notes
|
|
|
633
694
|
|
|
634
695
|
|
|
635
696
|
# **users_id_user_connections_id_connection_informations_get**
|
|
636
|
-
>
|
|
697
|
+
> InlineResponse2009 users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts)
|
|
637
698
|
|
|
638
699
|
Get connection additionnal informations
|
|
639
700
|
|
|
@@ -653,12 +714,12 @@ end
|
|
|
653
714
|
|
|
654
715
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
655
716
|
|
|
656
|
-
id_user =
|
|
717
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
657
718
|
|
|
658
719
|
id_connection = 56 # Integer |
|
|
659
720
|
|
|
660
721
|
opts = {
|
|
661
|
-
expand:
|
|
722
|
+
expand: 'expand_example' # String |
|
|
662
723
|
}
|
|
663
724
|
|
|
664
725
|
begin
|
|
@@ -680,7 +741,7 @@ Name | Type | Description | Notes
|
|
|
680
741
|
|
|
681
742
|
### Return type
|
|
682
743
|
|
|
683
|
-
[**
|
|
744
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
|
684
745
|
|
|
685
746
|
### Authorization
|
|
686
747
|
|
|
@@ -694,7 +755,7 @@ Name | Type | Description | Notes
|
|
|
694
755
|
|
|
695
756
|
|
|
696
757
|
# **users_id_user_connections_id_connection_logs_get**
|
|
697
|
-
>
|
|
758
|
+
> InlineResponse20016 users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts)
|
|
698
759
|
|
|
699
760
|
Get connection logs
|
|
700
761
|
|
|
@@ -714,22 +775,22 @@ end
|
|
|
714
775
|
|
|
715
776
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
716
777
|
|
|
717
|
-
id_user =
|
|
778
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
718
779
|
|
|
719
780
|
id_connection = 56 # Integer |
|
|
720
781
|
|
|
721
782
|
opts = {
|
|
722
783
|
limit: 56, # Integer | limit number of results
|
|
723
784
|
offset: 56, # Integer | offset of first result
|
|
724
|
-
min_date: Date.parse(
|
|
725
|
-
max_date: Date.parse(
|
|
785
|
+
min_date: Date.parse('2013-10-20'), # Date | minimal date
|
|
786
|
+
max_date: Date.parse('2013-10-20'), # Date | maximum date
|
|
726
787
|
state: 56, # Integer | state of user
|
|
727
|
-
period:
|
|
788
|
+
period: 'period_example', # String | period to group logs
|
|
728
789
|
id_user2: 56, # Integer | ID of a user
|
|
729
790
|
id_connection2: 56, # Integer | ID of a connection
|
|
730
|
-
|
|
731
|
-
charged: true, # BOOLEAN | consider only logs for charged
|
|
732
|
-
expand:
|
|
791
|
+
id_connector: 56, # Integer | ID of a connector
|
|
792
|
+
charged: true, # BOOLEAN | consider only logs for charged connectors
|
|
793
|
+
expand: 'expand_example' # String |
|
|
733
794
|
}
|
|
734
795
|
|
|
735
796
|
begin
|
|
@@ -755,13 +816,13 @@ Name | Type | Description | Notes
|
|
|
755
816
|
**period** | **String**| period to group logs | [optional]
|
|
756
817
|
**id_user2** | **Integer**| ID of a user | [optional]
|
|
757
818
|
**id_connection2** | **Integer**| ID of a connection | [optional]
|
|
758
|
-
**
|
|
759
|
-
**charged** | **BOOLEAN**| consider only logs for charged
|
|
819
|
+
**id_connector** | **Integer**| ID of a connector | [optional]
|
|
820
|
+
**charged** | **BOOLEAN**| consider only logs for charged connectors | [optional]
|
|
760
821
|
**expand** | **String**| | [optional]
|
|
761
822
|
|
|
762
823
|
### Return type
|
|
763
824
|
|
|
764
|
-
[**
|
|
825
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
|
765
826
|
|
|
766
827
|
### Authorization
|
|
767
828
|
|
|
@@ -795,16 +856,16 @@ end
|
|
|
795
856
|
|
|
796
857
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
797
858
|
|
|
798
|
-
id_user =
|
|
859
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
799
860
|
|
|
800
861
|
id_connection = 56 # Integer |
|
|
801
862
|
|
|
802
863
|
opts = {
|
|
803
864
|
active: true, # BOOLEAN | Set if the connection synchronisation is active
|
|
804
|
-
expire: DateTime.parse(
|
|
805
|
-
login:
|
|
806
|
-
password:
|
|
807
|
-
expand:
|
|
865
|
+
expire: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Set expiration of the connection to this date
|
|
866
|
+
login: 'login_example', # String | Set login to this new login
|
|
867
|
+
password: 'password_example', # String | Set password to this new password
|
|
868
|
+
expand: 'expand_example' # String |
|
|
808
869
|
}
|
|
809
870
|
|
|
810
871
|
begin
|
|
@@ -838,7 +899,7 @@ Name | Type | Description | Notes
|
|
|
838
899
|
|
|
839
900
|
### HTTP request headers
|
|
840
901
|
|
|
841
|
-
- **Content-Type**:
|
|
902
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
842
903
|
- **Accept**: application/json
|
|
843
904
|
|
|
844
905
|
|
|
@@ -864,12 +925,12 @@ end
|
|
|
864
925
|
|
|
865
926
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
866
927
|
|
|
867
|
-
id_user =
|
|
928
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
868
929
|
|
|
869
930
|
id_connection = 56 # Integer |
|
|
870
931
|
|
|
871
932
|
opts = {
|
|
872
|
-
expand:
|
|
933
|
+
expand: 'expand_example' # String |
|
|
873
934
|
}
|
|
874
935
|
|
|
875
936
|
begin
|
|
@@ -925,24 +986,23 @@ end
|
|
|
925
986
|
|
|
926
987
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
927
988
|
|
|
928
|
-
id_user =
|
|
989
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
929
990
|
|
|
930
991
|
opts = {
|
|
931
|
-
|
|
932
|
-
birthday:
|
|
933
|
-
password:
|
|
934
|
-
oauth_token:
|
|
935
|
-
oauth_token_secret:
|
|
936
|
-
auth_type:
|
|
937
|
-
secret:
|
|
938
|
-
type:
|
|
939
|
-
birthdate:
|
|
940
|
-
nuser:
|
|
941
|
-
website:
|
|
942
|
-
|
|
943
|
-
login: "login_example", # String | bank additional login parameter
|
|
992
|
+
id_connector: 56, # Integer | ID of the connector
|
|
993
|
+
birthday: 'birthday_example', # String | bank additional login parameter
|
|
994
|
+
password: 'password_example', # String | bank additional login parameter
|
|
995
|
+
oauth_token: 'oauth_token_example', # String | bank additional login parameter
|
|
996
|
+
oauth_token_secret: 'oauth_token_secret_example', # String | bank additional login parameter
|
|
997
|
+
auth_type: 'auth_type_example', # String | bank additional login parameter
|
|
998
|
+
secret: 'secret_example', # String | bank additional login parameter
|
|
999
|
+
type: 'type_example', # String | bank additional login parameter
|
|
1000
|
+
birthdate: 'birthdate_example', # String | bank additional login parameter
|
|
1001
|
+
nuser: 'nuser_example', # String | bank additional login parameter
|
|
1002
|
+
website: 'website_example', # String | bank additional login parameter
|
|
1003
|
+
login: 'login_example', # String | bank additional login parameter
|
|
944
1004
|
id_provider: 56, # Integer | ID of the provider
|
|
945
|
-
expand:
|
|
1005
|
+
expand: 'expand_example' # String |
|
|
946
1006
|
}
|
|
947
1007
|
|
|
948
1008
|
begin
|
|
@@ -959,7 +1019,7 @@ end
|
|
|
959
1019
|
Name | Type | Description | Notes
|
|
960
1020
|
------------- | ------------- | ------------- | -------------
|
|
961
1021
|
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
962
|
-
**
|
|
1022
|
+
**id_connector** | **Integer**| ID of the connector | [optional]
|
|
963
1023
|
**birthday** | **String**| bank additional login parameter | [optional]
|
|
964
1024
|
**password** | **String**| bank additional login parameter | [optional]
|
|
965
1025
|
**oauth_token** | **String**| bank additional login parameter | [optional]
|
|
@@ -970,7 +1030,6 @@ Name | Type | Description | Notes
|
|
|
970
1030
|
**birthdate** | **String**| bank additional login parameter | [optional]
|
|
971
1031
|
**nuser** | **String**| bank additional login parameter | [optional]
|
|
972
1032
|
**website** | **String**| bank additional login parameter | [optional]
|
|
973
|
-
**password2** | **String**| bank additional login parameter | [optional]
|
|
974
1033
|
**login** | **String**| bank additional login parameter | [optional]
|
|
975
1034
|
**id_provider** | **Integer**| ID of the provider | [optional]
|
|
976
1035
|
**expand** | **String**| | [optional]
|
|
@@ -985,13 +1044,13 @@ Name | Type | Description | Notes
|
|
|
985
1044
|
|
|
986
1045
|
### HTTP request headers
|
|
987
1046
|
|
|
988
|
-
- **Content-Type**:
|
|
1047
|
+
- **Content-Type**: application/x-www-form-urlencoded
|
|
989
1048
|
- **Accept**: application/json
|
|
990
1049
|
|
|
991
1050
|
|
|
992
1051
|
|
|
993
1052
|
# **users_id_user_logs_get**
|
|
994
|
-
>
|
|
1053
|
+
> InlineResponse20016 users_id_user_logs_get(id_user, opts)
|
|
995
1054
|
|
|
996
1055
|
Get connection logs
|
|
997
1056
|
|
|
@@ -1011,20 +1070,20 @@ end
|
|
|
1011
1070
|
|
|
1012
1071
|
api_instance = BudgeaClient::ConnectionsApi.new
|
|
1013
1072
|
|
|
1014
|
-
id_user =
|
|
1073
|
+
id_user = 'id_user_example' # String | Hint: you can use 'me' or 'all'
|
|
1015
1074
|
|
|
1016
1075
|
opts = {
|
|
1017
1076
|
limit: 56, # Integer | limit number of results
|
|
1018
1077
|
offset: 56, # Integer | offset of first result
|
|
1019
|
-
min_date: Date.parse(
|
|
1020
|
-
max_date: Date.parse(
|
|
1078
|
+
min_date: Date.parse('2013-10-20'), # Date | minimal date
|
|
1079
|
+
max_date: Date.parse('2013-10-20'), # Date | maximum date
|
|
1021
1080
|
state: 56, # Integer | state of user
|
|
1022
|
-
period:
|
|
1081
|
+
period: 'period_example', # String | period to group logs
|
|
1023
1082
|
id_user2: 56, # Integer | ID of a user
|
|
1024
1083
|
id_connection: 56, # Integer | ID of a connection
|
|
1025
|
-
|
|
1026
|
-
charged: true, # BOOLEAN | consider only logs for charged
|
|
1027
|
-
expand:
|
|
1084
|
+
id_connector: 56, # Integer | ID of a connector
|
|
1085
|
+
charged: true, # BOOLEAN | consider only logs for charged connectors
|
|
1086
|
+
expand: 'expand_example' # String |
|
|
1028
1087
|
}
|
|
1029
1088
|
|
|
1030
1089
|
begin
|
|
@@ -1049,13 +1108,13 @@ Name | Type | Description | Notes
|
|
|
1049
1108
|
**period** | **String**| period to group logs | [optional]
|
|
1050
1109
|
**id_user2** | **Integer**| ID of a user | [optional]
|
|
1051
1110
|
**id_connection** | **Integer**| ID of a connection | [optional]
|
|
1052
|
-
**
|
|
1053
|
-
**charged** | **BOOLEAN**| consider only logs for charged
|
|
1111
|
+
**id_connector** | **Integer**| ID of a connector | [optional]
|
|
1112
|
+
**charged** | **BOOLEAN**| consider only logs for charged connectors | [optional]
|
|
1054
1113
|
**expand** | **String**| | [optional]
|
|
1055
1114
|
|
|
1056
1115
|
### Return type
|
|
1057
1116
|
|
|
1058
|
-
[**
|
|
1117
|
+
[**InlineResponse20016**](InlineResponse20016.md)
|
|
1059
1118
|
|
|
1060
1119
|
### Authorization
|
|
1061
1120
|
|