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/Invite.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# BudgeaClient::Invite
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **Integer** | |
|
|
7
|
+
**id_unsubscribe** | **Integer** | | [optional]
|
|
8
|
+
**id_user_inviting** | **Integer** | |
|
|
9
|
+
**id_user_invited** | **Integer** | | [optional]
|
|
10
|
+
**email_invited** | **String** | | [optional]
|
|
11
|
+
**timestamp** | **DateTime** | | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/LockedUser.md
ADDED
data/docs/OCRApi.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# BudgeaClient::OCRApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**ocr_post**](OCRApi.md#ocr_post) | **POST** /ocr | Post an image with OCR
|
|
8
|
+
[**users_id_user_ocr_post**](OCRApi.md#users_id_user_ocr_post) | **POST** /users/{id_user}/ocr | Post an image with OCR
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# **ocr_post**
|
|
12
|
+
> ocr_post(file, opts)
|
|
13
|
+
|
|
14
|
+
Post an image with OCR
|
|
15
|
+
|
|
16
|
+
Post an image and apply OCR on it to obtain found meta-data.<br><br>
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
```ruby
|
|
20
|
+
# load the gem
|
|
21
|
+
require 'budgea_client'
|
|
22
|
+
|
|
23
|
+
api_instance = BudgeaClient::OCRApi.new
|
|
24
|
+
|
|
25
|
+
file = File.new("/path/to/file.txt") # File | File of the document
|
|
26
|
+
|
|
27
|
+
opts = {
|
|
28
|
+
id_transaction: 56, # Integer | Transaction used to help OCR to find data
|
|
29
|
+
name: "name_example" # String | Name of the document
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
begin
|
|
33
|
+
#Post an image with OCR
|
|
34
|
+
api_instance.ocr_post(file, opts)
|
|
35
|
+
rescue BudgeaClient::ApiError => e
|
|
36
|
+
puts "Exception when calling OCRApi->ocr_post: #{e}"
|
|
37
|
+
end
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
Name | Type | Description | Notes
|
|
43
|
+
------------- | ------------- | ------------- | -------------
|
|
44
|
+
**file** | **File**| File of the document |
|
|
45
|
+
**id_transaction** | **Integer**| Transaction used to help OCR to find data | [optional]
|
|
46
|
+
**name** | **String**| Name of the document | [optional]
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
nil (empty response body)
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: multipart/form-data
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
# **users_id_user_ocr_post**
|
|
64
|
+
> users_id_user_ocr_post(id_user, file, opts)
|
|
65
|
+
|
|
66
|
+
Post an image with OCR
|
|
67
|
+
|
|
68
|
+
Post an image and apply OCR on it to obtain found meta-data.<br><br>
|
|
69
|
+
|
|
70
|
+
### Example
|
|
71
|
+
```ruby
|
|
72
|
+
# load the gem
|
|
73
|
+
require 'budgea_client'
|
|
74
|
+
|
|
75
|
+
api_instance = BudgeaClient::OCRApi.new
|
|
76
|
+
|
|
77
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
78
|
+
|
|
79
|
+
file = File.new("/path/to/file.txt") # File | File of the document
|
|
80
|
+
|
|
81
|
+
opts = {
|
|
82
|
+
id_transaction: 56, # Integer | Transaction used to help OCR to find data
|
|
83
|
+
name: "name_example" # String | Name of the document
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
begin
|
|
87
|
+
#Post an image with OCR
|
|
88
|
+
api_instance.users_id_user_ocr_post(id_user, file, opts)
|
|
89
|
+
rescue BudgeaClient::ApiError => e
|
|
90
|
+
puts "Exception when calling OCRApi->users_id_user_ocr_post: #{e}"
|
|
91
|
+
end
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
Name | Type | Description | Notes
|
|
97
|
+
------------- | ------------- | ------------- | -------------
|
|
98
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
99
|
+
**file** | **File**| File of the document |
|
|
100
|
+
**id_transaction** | **Integer**| Transaction used to help OCR to find data | [optional]
|
|
101
|
+
**name** | **String**| Name of the document | [optional]
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
nil (empty response body)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
No authorization required
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: multipart/form-data
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
data/docs/OIDCApi.md
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
# BudgeaClient::OIDCApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**oidc_whitelist_id_whitelist_delete**](OIDCApi.md#oidc_whitelist_id_whitelist_delete) | **DELETE** /oidc/whitelist/{id_whitelist} | Delete the supplied authorized redirect uri
|
|
8
|
+
[**oidc_whitelist_id_whitelist_post**](OIDCApi.md#oidc_whitelist_id_whitelist_post) | **POST** /oidc/whitelist/{id_whitelist} | Edit a authorized redirect uri
|
|
9
|
+
[**oidc_whitelist_post**](OIDCApi.md#oidc_whitelist_post) | **POST** /oidc/whitelist | Adds an authorized redirect uri
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
# **oidc_whitelist_id_whitelist_delete**
|
|
13
|
+
> OidcWhitelist oidc_whitelist_id_whitelist_delete(id_whitelist, opts)
|
|
14
|
+
|
|
15
|
+
Delete the supplied authorized redirect uri
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
```ruby
|
|
21
|
+
# load the gem
|
|
22
|
+
require 'budgea_client'
|
|
23
|
+
|
|
24
|
+
api_instance = BudgeaClient::OIDCApi.new
|
|
25
|
+
|
|
26
|
+
id_whitelist = 56 # Integer |
|
|
27
|
+
|
|
28
|
+
opts = {
|
|
29
|
+
expand: "expand_example" # String |
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
begin
|
|
33
|
+
#Delete the supplied authorized redirect uri
|
|
34
|
+
result = api_instance.oidc_whitelist_id_whitelist_delete(id_whitelist, opts)
|
|
35
|
+
p result
|
|
36
|
+
rescue BudgeaClient::ApiError => e
|
|
37
|
+
puts "Exception when calling OIDCApi->oidc_whitelist_id_whitelist_delete: #{e}"
|
|
38
|
+
end
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Parameters
|
|
42
|
+
|
|
43
|
+
Name | Type | Description | Notes
|
|
44
|
+
------------- | ------------- | ------------- | -------------
|
|
45
|
+
**id_whitelist** | **Integer**| |
|
|
46
|
+
**expand** | **String**| | [optional]
|
|
47
|
+
|
|
48
|
+
### Return type
|
|
49
|
+
|
|
50
|
+
[**OidcWhitelist**](OidcWhitelist.md)
|
|
51
|
+
|
|
52
|
+
### Authorization
|
|
53
|
+
|
|
54
|
+
No authorization required
|
|
55
|
+
|
|
56
|
+
### HTTP request headers
|
|
57
|
+
|
|
58
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
59
|
+
- **Accept**: application/json
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
# **oidc_whitelist_id_whitelist_post**
|
|
64
|
+
> OidcWhitelist oidc_whitelist_id_whitelist_post(id_whitelist, redirect_uri, opts)
|
|
65
|
+
|
|
66
|
+
Edit a authorized redirect uri
|
|
67
|
+
|
|
68
|
+
Edit the uri for the supplied authorized redirect uri.<br><br>
|
|
69
|
+
|
|
70
|
+
### Example
|
|
71
|
+
```ruby
|
|
72
|
+
# load the gem
|
|
73
|
+
require 'budgea_client'
|
|
74
|
+
|
|
75
|
+
api_instance = BudgeaClient::OIDCApi.new
|
|
76
|
+
|
|
77
|
+
id_whitelist = 56 # Integer |
|
|
78
|
+
|
|
79
|
+
redirect_uri = "redirect_uri_example" # String | new authorized redirect uri
|
|
80
|
+
|
|
81
|
+
opts = {
|
|
82
|
+
expand: "expand_example" # String |
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
begin
|
|
86
|
+
#Edit a authorized redirect uri
|
|
87
|
+
result = api_instance.oidc_whitelist_id_whitelist_post(id_whitelist, redirect_uri, opts)
|
|
88
|
+
p result
|
|
89
|
+
rescue BudgeaClient::ApiError => e
|
|
90
|
+
puts "Exception when calling OIDCApi->oidc_whitelist_id_whitelist_post: #{e}"
|
|
91
|
+
end
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
Name | Type | Description | Notes
|
|
97
|
+
------------- | ------------- | ------------- | -------------
|
|
98
|
+
**id_whitelist** | **Integer**| |
|
|
99
|
+
**redirect_uri** | **String**| new authorized redirect uri |
|
|
100
|
+
**expand** | **String**| | [optional]
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
[**OidcWhitelist**](OidcWhitelist.md)
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
No authorization required
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
# **oidc_whitelist_post**
|
|
118
|
+
> OidcWhitelist oidc_whitelist_post(redirect_uri, opts)
|
|
119
|
+
|
|
120
|
+
Adds an authorized redirect uri
|
|
121
|
+
|
|
122
|
+
It requires the authorized redirect uri to be created<br><br>
|
|
123
|
+
|
|
124
|
+
### Example
|
|
125
|
+
```ruby
|
|
126
|
+
# load the gem
|
|
127
|
+
require 'budgea_client'
|
|
128
|
+
|
|
129
|
+
api_instance = BudgeaClient::OIDCApi.new
|
|
130
|
+
|
|
131
|
+
redirect_uri = "redirect_uri_example" # String | authorized redirect uri to be created
|
|
132
|
+
|
|
133
|
+
opts = {
|
|
134
|
+
expand: "expand_example" # String |
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
begin
|
|
138
|
+
#Adds an authorized redirect uri
|
|
139
|
+
result = api_instance.oidc_whitelist_post(redirect_uri, opts)
|
|
140
|
+
p result
|
|
141
|
+
rescue BudgeaClient::ApiError => e
|
|
142
|
+
puts "Exception when calling OIDCApi->oidc_whitelist_post: #{e}"
|
|
143
|
+
end
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
|
|
148
|
+
Name | Type | Description | Notes
|
|
149
|
+
------------- | ------------- | ------------- | -------------
|
|
150
|
+
**redirect_uri** | **String**| authorized redirect uri to be created |
|
|
151
|
+
**expand** | **String**| | [optional]
|
|
152
|
+
|
|
153
|
+
### Return type
|
|
154
|
+
|
|
155
|
+
[**OidcWhitelist**](OidcWhitelist.md)
|
|
156
|
+
|
|
157
|
+
### Authorization
|
|
158
|
+
|
|
159
|
+
No authorization required
|
|
160
|
+
|
|
161
|
+
### HTTP request headers
|
|
162
|
+
|
|
163
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
164
|
+
- **Accept**: application/json
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
data/docs/PFMApi.md
ADDED
|
@@ -0,0 +1,2204 @@
|
|
|
1
|
+
# BudgeaClient::PFMApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://demo.biapi.pro/2.0/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**auth_confirm_new_email_post**](PFMApi.md#auth_confirm_new_email_post) | **POST** /auth/confirmNewEmail | Confirm new email address
|
|
8
|
+
[**auth_confirm_post**](PFMApi.md#auth_confirm_post) | **POST** /auth/confirm | Confirm email address
|
|
9
|
+
[**auth_cookie_post**](PFMApi.md#auth_cookie_post) | **POST** /auth/cookie | Login with credentials and set as cookie
|
|
10
|
+
[**auth_register_post**](PFMApi.md#auth_register_post) | **POST** /auth/register | Register to API
|
|
11
|
+
[**auth_token_delete**](PFMApi.md#auth_token_delete) | **DELETE** /auth/token | Remove user access
|
|
12
|
+
[**auth_token_post**](PFMApi.md#auth_token_post) | **POST** /auth/token | Login to API with credentials
|
|
13
|
+
[**hash_delete**](PFMApi.md#hash_delete) | **DELETE** /hash | Delete the user's connections
|
|
14
|
+
[**users_id_user_accounts_id_account_balances_get**](PFMApi.md#users_id_user_accounts_id_account_balances_get) | **GET** /users/{id_user}/accounts/{id_account}/balances | Get balances of accounts
|
|
15
|
+
[**users_id_user_accounts_id_account_operationsalert_get**](PFMApi.md#users_id_user_accounts_id_account_operationsalert_get) | **GET** /users/{id_user}/accounts/{id_account}/operationsalert | Get a list of configurated alerts
|
|
16
|
+
[**users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete**](PFMApi.md#users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete) | **DELETE** /users/{id_user}/accounts/{id_account}/operationsalert/{id_operationsalert} | Delete an alert on transactions or investemens
|
|
17
|
+
[**users_id_user_accounts_id_account_operationsalert_id_operationsalert_put**](PFMApi.md#users_id_user_accounts_id_account_operationsalert_id_operationsalert_put) | **PUT** /users/{id_user}/accounts/{id_account}/operationsalert/{id_operationsalert} | Edit an alert on transactions or investemens
|
|
18
|
+
[**users_id_user_accounts_id_account_operationsalert_post**](PFMApi.md#users_id_user_accounts_id_account_operationsalert_post) | **POST** /users/{id_user}/accounts/{id_account}/operationsalert | Create an alert on transactions or investemens of a given user
|
|
19
|
+
[**users_id_user_accountsalert_get**](PFMApi.md#users_id_user_accountsalert_get) | **GET** /users/{id_user}/accountsalert | Get alert configuration of a specific account
|
|
20
|
+
[**users_id_user_accountsalert_put**](PFMApi.md#users_id_user_accountsalert_put) | **PUT** /users/{id_user}/accountsalert | Update alert configuration of an account
|
|
21
|
+
[**users_id_user_balances_get**](PFMApi.md#users_id_user_balances_get) | **GET** /users/{id_user}/balances | Get balances of accounts
|
|
22
|
+
[**users_id_user_connections_id_connection_accounts_id_account_balances_get**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_balances_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/balances | Get balances of accounts
|
|
23
|
+
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_get**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_get) | **GET** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert | Get a list of configurated alerts
|
|
24
|
+
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete) | **DELETE** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert} | Delete an alert on transactions or investemens
|
|
25
|
+
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put) | **PUT** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert/{id_operationsalert} | Edit an alert on transactions or investemens
|
|
26
|
+
[**users_id_user_connections_id_connection_accounts_id_account_operationsalert_post**](PFMApi.md#users_id_user_connections_id_connection_accounts_id_account_operationsalert_post) | **POST** /users/{id_user}/connections/{id_connection}/accounts/{id_account}/operationsalert | Create an alert on transactions or investemens of a given user
|
|
27
|
+
[**users_id_user_connections_id_connection_balances_get**](PFMApi.md#users_id_user_connections_id_connection_balances_get) | **GET** /users/{id_user}/connections/{id_connection}/balances | Get balances of accounts
|
|
28
|
+
[**users_id_user_devices_get**](PFMApi.md#users_id_user_devices_get) | **GET** /users/{id_user}/devices | Get devices
|
|
29
|
+
[**users_id_user_devices_id_device_delete**](PFMApi.md#users_id_user_devices_id_device_delete) | **DELETE** /users/{id_user}/devices/{id_device} | Delete device.
|
|
30
|
+
[**users_id_user_devices_id_device_get**](PFMApi.md#users_id_user_devices_id_device_get) | **GET** /users/{id_user}/devices/{id_device} | Get a device
|
|
31
|
+
[**users_id_user_devices_id_device_put**](PFMApi.md#users_id_user_devices_id_device_put) | **PUT** /users/{id_user}/devices/{id_device} | Update attributes of the device.
|
|
32
|
+
[**users_id_user_devices_post**](PFMApi.md#users_id_user_devices_post) | **POST** /users/{id_user}/devices | Create a device linked to specified token.
|
|
33
|
+
[**users_id_user_forecast_get**](PFMApi.md#users_id_user_forecast_get) | **GET** /users/{id_user}/forecast | Get forecast
|
|
34
|
+
[**users_id_user_get**](PFMApi.md#users_id_user_get) | **GET** /users/{id_user} | Get a user
|
|
35
|
+
[**users_id_user_operationsalert_get**](PFMApi.md#users_id_user_operationsalert_get) | **GET** /users/{id_user}/operationsalert | Get a list of configurated alerts
|
|
36
|
+
[**users_id_user_operationsalert_id_operationsalert_delete**](PFMApi.md#users_id_user_operationsalert_id_operationsalert_delete) | **DELETE** /users/{id_user}/operationsalert/{id_operationsalert} | Delete an alert on transactions or investemens
|
|
37
|
+
[**users_id_user_operationsalert_id_operationsalert_put**](PFMApi.md#users_id_user_operationsalert_id_operationsalert_put) | **PUT** /users/{id_user}/operationsalert/{id_operationsalert} | Edit an alert on transactions or investemens
|
|
38
|
+
[**users_id_user_operationsalert_post**](PFMApi.md#users_id_user_operationsalert_post) | **POST** /users/{id_user}/operationsalert | Create an alert on transactions or investemens of a given user
|
|
39
|
+
[**users_id_user_profiles_get**](PFMApi.md#users_id_user_profiles_get) | **GET** /users/{id_user}/profiles | Get profiles
|
|
40
|
+
[**users_id_user_profiles_id_profile_get**](PFMApi.md#users_id_user_profiles_id_profile_get) | **GET** /users/{id_user}/profiles/{id_profile} | Get a profile
|
|
41
|
+
[**users_id_user_profiles_main_get**](PFMApi.md#users_id_user_profiles_main_get) | **GET** /users/{id_user}/profiles/main | Get the main profile
|
|
42
|
+
[**users_id_user_profiles_me_get**](PFMApi.md#users_id_user_profiles_me_get) | **GET** /users/{id_user}/profiles/me | Get my profile
|
|
43
|
+
[**users_id_user_profiles_me_put**](PFMApi.md#users_id_user_profiles_me_put) | **PUT** /users/{id_user}/profiles/me | Change settings of the profile.
|
|
44
|
+
[**users_id_user_resume_get**](PFMApi.md#users_id_user_resume_get) | **GET** /users/{id_user}/resume | Get synthesis configuration of a specific user
|
|
45
|
+
[**users_id_user_resume_post**](PFMApi.md#users_id_user_resume_post) | **POST** /users/{id_user}/resume | Update synthesis configuration
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
# **auth_confirm_new_email_post**
|
|
49
|
+
> auth_confirm_new_email_post(token)
|
|
50
|
+
|
|
51
|
+
Confirm new email address
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
### Example
|
|
56
|
+
```ruby
|
|
57
|
+
# load the gem
|
|
58
|
+
require 'budgea_client'
|
|
59
|
+
|
|
60
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
61
|
+
|
|
62
|
+
token = "token_example" # String | token received by email
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
begin
|
|
66
|
+
#Confirm new email address
|
|
67
|
+
api_instance.auth_confirm_new_email_post(token)
|
|
68
|
+
rescue BudgeaClient::ApiError => e
|
|
69
|
+
puts "Exception when calling PFMApi->auth_confirm_new_email_post: #{e}"
|
|
70
|
+
end
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
Name | Type | Description | Notes
|
|
76
|
+
------------- | ------------- | ------------- | -------------
|
|
77
|
+
**token** | **String**| token received by email |
|
|
78
|
+
|
|
79
|
+
### Return type
|
|
80
|
+
|
|
81
|
+
nil (empty response body)
|
|
82
|
+
|
|
83
|
+
### Authorization
|
|
84
|
+
|
|
85
|
+
No authorization required
|
|
86
|
+
|
|
87
|
+
### HTTP request headers
|
|
88
|
+
|
|
89
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
90
|
+
- **Accept**: application/json
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
# **auth_confirm_post**
|
|
95
|
+
> InlineResponse2001 auth_confirm_post(token, application)
|
|
96
|
+
|
|
97
|
+
Confirm email address
|
|
98
|
+
|
|
99
|
+
<br><br>
|
|
100
|
+
|
|
101
|
+
### Example
|
|
102
|
+
```ruby
|
|
103
|
+
# load the gem
|
|
104
|
+
require 'budgea_client'
|
|
105
|
+
|
|
106
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
107
|
+
|
|
108
|
+
token = "token_example" # String | token received in email
|
|
109
|
+
|
|
110
|
+
application = "application_example" # String | application in use
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
begin
|
|
114
|
+
#Confirm email address
|
|
115
|
+
result = api_instance.auth_confirm_post(token, application)
|
|
116
|
+
p result
|
|
117
|
+
rescue BudgeaClient::ApiError => e
|
|
118
|
+
puts "Exception when calling PFMApi->auth_confirm_post: #{e}"
|
|
119
|
+
end
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Parameters
|
|
123
|
+
|
|
124
|
+
Name | Type | Description | Notes
|
|
125
|
+
------------- | ------------- | ------------- | -------------
|
|
126
|
+
**token** | **String**| token received in email |
|
|
127
|
+
**application** | **String**| application in use |
|
|
128
|
+
|
|
129
|
+
### Return type
|
|
130
|
+
|
|
131
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
|
132
|
+
|
|
133
|
+
### Authorization
|
|
134
|
+
|
|
135
|
+
No authorization required
|
|
136
|
+
|
|
137
|
+
### HTTP request headers
|
|
138
|
+
|
|
139
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
140
|
+
- **Accept**: application/json
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
# **auth_cookie_post**
|
|
145
|
+
> auth_cookie_post(username, password, application, opts)
|
|
146
|
+
|
|
147
|
+
Login with credentials and set as cookie
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
### Example
|
|
152
|
+
```ruby
|
|
153
|
+
# load the gem
|
|
154
|
+
require 'budgea_client'
|
|
155
|
+
|
|
156
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
157
|
+
|
|
158
|
+
username = "username_example" # String | username
|
|
159
|
+
|
|
160
|
+
password = "password_example" # String | password
|
|
161
|
+
|
|
162
|
+
application = "application_example" # String | application name
|
|
163
|
+
|
|
164
|
+
opts = {
|
|
165
|
+
scope: "scope_example" # String | scope requested for the token
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
begin
|
|
169
|
+
#Login with credentials and set as cookie
|
|
170
|
+
api_instance.auth_cookie_post(username, password, application, opts)
|
|
171
|
+
rescue BudgeaClient::ApiError => e
|
|
172
|
+
puts "Exception when calling PFMApi->auth_cookie_post: #{e}"
|
|
173
|
+
end
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
Name | Type | Description | Notes
|
|
179
|
+
------------- | ------------- | ------------- | -------------
|
|
180
|
+
**username** | **String**| username |
|
|
181
|
+
**password** | **String**| password |
|
|
182
|
+
**application** | **String**| application name |
|
|
183
|
+
**scope** | **String**| scope requested for the token | [optional]
|
|
184
|
+
|
|
185
|
+
### Return type
|
|
186
|
+
|
|
187
|
+
nil (empty response body)
|
|
188
|
+
|
|
189
|
+
### Authorization
|
|
190
|
+
|
|
191
|
+
No authorization required
|
|
192
|
+
|
|
193
|
+
### HTTP request headers
|
|
194
|
+
|
|
195
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
196
|
+
- **Accept**: application/json
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
# **auth_register_post**
|
|
201
|
+
> InlineResponse2003 auth_register_post(email, password, application, opts)
|
|
202
|
+
|
|
203
|
+
Register to API
|
|
204
|
+
|
|
205
|
+
Create a new user with his email address and password.<br><br><br><br>
|
|
206
|
+
|
|
207
|
+
### Example
|
|
208
|
+
```ruby
|
|
209
|
+
# load the gem
|
|
210
|
+
require 'budgea_client'
|
|
211
|
+
|
|
212
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
213
|
+
|
|
214
|
+
email = "email_example" # String | email address
|
|
215
|
+
|
|
216
|
+
password = "password_example" # String | password
|
|
217
|
+
|
|
218
|
+
application = "application_example" # String | application in use
|
|
219
|
+
|
|
220
|
+
opts = {
|
|
221
|
+
sponsor: "sponsor_example", # String | sponsor code to get advantages
|
|
222
|
+
notification_token: "notification_token_example" # String | APNS or GCM token to send notifications to device
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
begin
|
|
226
|
+
#Register to API
|
|
227
|
+
result = api_instance.auth_register_post(email, password, application, opts)
|
|
228
|
+
p result
|
|
229
|
+
rescue BudgeaClient::ApiError => e
|
|
230
|
+
puts "Exception when calling PFMApi->auth_register_post: #{e}"
|
|
231
|
+
end
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Parameters
|
|
235
|
+
|
|
236
|
+
Name | Type | Description | Notes
|
|
237
|
+
------------- | ------------- | ------------- | -------------
|
|
238
|
+
**email** | **String**| email address |
|
|
239
|
+
**password** | **String**| password |
|
|
240
|
+
**application** | **String**| application in use |
|
|
241
|
+
**sponsor** | **String**| sponsor code to get advantages | [optional]
|
|
242
|
+
**notification_token** | **String**| APNS or GCM token to send notifications to device | [optional]
|
|
243
|
+
|
|
244
|
+
### Return type
|
|
245
|
+
|
|
246
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
|
247
|
+
|
|
248
|
+
### Authorization
|
|
249
|
+
|
|
250
|
+
No authorization required
|
|
251
|
+
|
|
252
|
+
### HTTP request headers
|
|
253
|
+
|
|
254
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
255
|
+
- **Accept**: application/json
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
# **auth_token_delete**
|
|
260
|
+
> auth_token_delete
|
|
261
|
+
|
|
262
|
+
Remove user access
|
|
263
|
+
|
|
264
|
+
This endpoint removes the token in use.<br><br>
|
|
265
|
+
|
|
266
|
+
### Example
|
|
267
|
+
```ruby
|
|
268
|
+
# load the gem
|
|
269
|
+
require 'budgea_client'
|
|
270
|
+
|
|
271
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
272
|
+
|
|
273
|
+
begin
|
|
274
|
+
#Remove user access
|
|
275
|
+
api_instance.auth_token_delete
|
|
276
|
+
rescue BudgeaClient::ApiError => e
|
|
277
|
+
puts "Exception when calling PFMApi->auth_token_delete: #{e}"
|
|
278
|
+
end
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
### Parameters
|
|
282
|
+
This endpoint does not need any parameter.
|
|
283
|
+
|
|
284
|
+
### Return type
|
|
285
|
+
|
|
286
|
+
nil (empty response body)
|
|
287
|
+
|
|
288
|
+
### Authorization
|
|
289
|
+
|
|
290
|
+
No authorization required
|
|
291
|
+
|
|
292
|
+
### HTTP request headers
|
|
293
|
+
|
|
294
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
295
|
+
- **Accept**: application/json
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
# **auth_token_post**
|
|
300
|
+
> InlineResponse2004 auth_token_post(username, password, application, opts)
|
|
301
|
+
|
|
302
|
+
Login to API with credentials
|
|
303
|
+
|
|
304
|
+
Request a new user token by giving an username and a password.<br><br><br><br>
|
|
305
|
+
|
|
306
|
+
### Example
|
|
307
|
+
```ruby
|
|
308
|
+
# load the gem
|
|
309
|
+
require 'budgea_client'
|
|
310
|
+
|
|
311
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
312
|
+
|
|
313
|
+
username = "username_example" # String | username
|
|
314
|
+
|
|
315
|
+
password = "password_example" # String | password
|
|
316
|
+
|
|
317
|
+
application = "application_example" # String | application name
|
|
318
|
+
|
|
319
|
+
opts = {
|
|
320
|
+
scope: "scope_example" # String | scope requested for the token
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
begin
|
|
324
|
+
#Login to API with credentials
|
|
325
|
+
result = api_instance.auth_token_post(username, password, application, opts)
|
|
326
|
+
p result
|
|
327
|
+
rescue BudgeaClient::ApiError => e
|
|
328
|
+
puts "Exception when calling PFMApi->auth_token_post: #{e}"
|
|
329
|
+
end
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
Name | Type | Description | Notes
|
|
335
|
+
------------- | ------------- | ------------- | -------------
|
|
336
|
+
**username** | **String**| username |
|
|
337
|
+
**password** | **String**| password |
|
|
338
|
+
**application** | **String**| application name |
|
|
339
|
+
**scope** | **String**| scope requested for the token | [optional]
|
|
340
|
+
|
|
341
|
+
### Return type
|
|
342
|
+
|
|
343
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
|
344
|
+
|
|
345
|
+
### Authorization
|
|
346
|
+
|
|
347
|
+
No authorization required
|
|
348
|
+
|
|
349
|
+
### HTTP request headers
|
|
350
|
+
|
|
351
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
352
|
+
- **Accept**: application/json
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
# **hash_delete**
|
|
357
|
+
> hash_delete
|
|
358
|
+
|
|
359
|
+
Delete the user's connections
|
|
360
|
+
|
|
361
|
+
deletes all connections of the user given his hash<br><br>
|
|
362
|
+
|
|
363
|
+
### Example
|
|
364
|
+
```ruby
|
|
365
|
+
# load the gem
|
|
366
|
+
require 'budgea_client'
|
|
367
|
+
|
|
368
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
369
|
+
|
|
370
|
+
begin
|
|
371
|
+
#Delete the user's connections
|
|
372
|
+
api_instance.hash_delete
|
|
373
|
+
rescue BudgeaClient::ApiError => e
|
|
374
|
+
puts "Exception when calling PFMApi->hash_delete: #{e}"
|
|
375
|
+
end
|
|
376
|
+
```
|
|
377
|
+
|
|
378
|
+
### Parameters
|
|
379
|
+
This endpoint does not need any parameter.
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
nil (empty response body)
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
No authorization required
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
# **users_id_user_accounts_id_account_balances_get**
|
|
397
|
+
> users_id_user_accounts_id_account_balances_get(id_user, id_account, opts)
|
|
398
|
+
|
|
399
|
+
Get balances of accounts
|
|
400
|
+
|
|
401
|
+
Get balance (income/outcome/balance) of enabled accounts for the given period.<br><br>By default, min_date and max_date are the current month, and period is a single month.<br><br>The period is composed with units (days, months, years) and numbers. You can give for example \"1month\", \"15days\", \"1year6months\", etc.<br><br>
|
|
402
|
+
|
|
403
|
+
### Example
|
|
404
|
+
```ruby
|
|
405
|
+
# load the gem
|
|
406
|
+
require 'budgea_client'
|
|
407
|
+
|
|
408
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
409
|
+
|
|
410
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
411
|
+
|
|
412
|
+
id_account = 56 # Integer |
|
|
413
|
+
|
|
414
|
+
opts = {
|
|
415
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal (inclusive) date
|
|
416
|
+
max_date: Date.parse("2013-10-20"), # Date | maximal (inclusive) date
|
|
417
|
+
period: "period_example" # String | split output with the given period (default: month)
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
begin
|
|
421
|
+
#Get balances of accounts
|
|
422
|
+
api_instance.users_id_user_accounts_id_account_balances_get(id_user, id_account, opts)
|
|
423
|
+
rescue BudgeaClient::ApiError => e
|
|
424
|
+
puts "Exception when calling PFMApi->users_id_user_accounts_id_account_balances_get: #{e}"
|
|
425
|
+
end
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
### Parameters
|
|
429
|
+
|
|
430
|
+
Name | Type | Description | Notes
|
|
431
|
+
------------- | ------------- | ------------- | -------------
|
|
432
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
433
|
+
**id_account** | **Integer**| |
|
|
434
|
+
**min_date** | **Date**| minimal (inclusive) date | [optional]
|
|
435
|
+
**max_date** | **Date**| maximal (inclusive) date | [optional]
|
|
436
|
+
**period** | **String**| split output with the given period (default: month) | [optional]
|
|
437
|
+
|
|
438
|
+
### Return type
|
|
439
|
+
|
|
440
|
+
nil (empty response body)
|
|
441
|
+
|
|
442
|
+
### Authorization
|
|
443
|
+
|
|
444
|
+
No authorization required
|
|
445
|
+
|
|
446
|
+
### HTTP request headers
|
|
447
|
+
|
|
448
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
449
|
+
- **Accept**: application/json
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
# **users_id_user_accounts_id_account_operationsalert_get**
|
|
454
|
+
> InlineResponse20022 users_id_user_accounts_id_account_operationsalert_get(id_user, id_account, opts)
|
|
455
|
+
|
|
456
|
+
Get a list of configurated alerts
|
|
457
|
+
|
|
458
|
+
<br><br>
|
|
459
|
+
|
|
460
|
+
### Example
|
|
461
|
+
```ruby
|
|
462
|
+
# load the gem
|
|
463
|
+
require 'budgea_client'
|
|
464
|
+
|
|
465
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
466
|
+
|
|
467
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
468
|
+
|
|
469
|
+
id_account = 56 # Integer |
|
|
470
|
+
|
|
471
|
+
opts = {
|
|
472
|
+
expand: "expand_example" # String |
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
begin
|
|
476
|
+
#Get a list of configurated alerts
|
|
477
|
+
result = api_instance.users_id_user_accounts_id_account_operationsalert_get(id_user, id_account, opts)
|
|
478
|
+
p result
|
|
479
|
+
rescue BudgeaClient::ApiError => e
|
|
480
|
+
puts "Exception when calling PFMApi->users_id_user_accounts_id_account_operationsalert_get: #{e}"
|
|
481
|
+
end
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Parameters
|
|
485
|
+
|
|
486
|
+
Name | Type | Description | Notes
|
|
487
|
+
------------- | ------------- | ------------- | -------------
|
|
488
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
489
|
+
**id_account** | **Integer**| |
|
|
490
|
+
**expand** | **String**| | [optional]
|
|
491
|
+
|
|
492
|
+
### Return type
|
|
493
|
+
|
|
494
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
|
495
|
+
|
|
496
|
+
### Authorization
|
|
497
|
+
|
|
498
|
+
No authorization required
|
|
499
|
+
|
|
500
|
+
### HTTP request headers
|
|
501
|
+
|
|
502
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
503
|
+
- **Accept**: application/json
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
# **users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete**
|
|
508
|
+
> UserAlert users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete(id_user, id_account, id_operationsalert, opts)
|
|
509
|
+
|
|
510
|
+
Delete an alert on transactions or investemens
|
|
511
|
+
|
|
512
|
+
<br><br>
|
|
513
|
+
|
|
514
|
+
### Example
|
|
515
|
+
```ruby
|
|
516
|
+
# load the gem
|
|
517
|
+
require 'budgea_client'
|
|
518
|
+
|
|
519
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
520
|
+
|
|
521
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
522
|
+
|
|
523
|
+
id_account = 56 # Integer |
|
|
524
|
+
|
|
525
|
+
id_operationsalert = 56 # Integer |
|
|
526
|
+
|
|
527
|
+
opts = {
|
|
528
|
+
expand: "expand_example" # String |
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
begin
|
|
532
|
+
#Delete an alert on transactions or investemens
|
|
533
|
+
result = api_instance.users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete(id_user, id_account, id_operationsalert, opts)
|
|
534
|
+
p result
|
|
535
|
+
rescue BudgeaClient::ApiError => e
|
|
536
|
+
puts "Exception when calling PFMApi->users_id_user_accounts_id_account_operationsalert_id_operationsalert_delete: #{e}"
|
|
537
|
+
end
|
|
538
|
+
```
|
|
539
|
+
|
|
540
|
+
### Parameters
|
|
541
|
+
|
|
542
|
+
Name | Type | Description | Notes
|
|
543
|
+
------------- | ------------- | ------------- | -------------
|
|
544
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
545
|
+
**id_account** | **Integer**| |
|
|
546
|
+
**id_operationsalert** | **Integer**| |
|
|
547
|
+
**expand** | **String**| | [optional]
|
|
548
|
+
|
|
549
|
+
### Return type
|
|
550
|
+
|
|
551
|
+
[**UserAlert**](UserAlert.md)
|
|
552
|
+
|
|
553
|
+
### Authorization
|
|
554
|
+
|
|
555
|
+
No authorization required
|
|
556
|
+
|
|
557
|
+
### HTTP request headers
|
|
558
|
+
|
|
559
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
560
|
+
- **Accept**: application/json
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
# **users_id_user_accounts_id_account_operationsalert_id_operationsalert_put**
|
|
565
|
+
> UserAlert users_id_user_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_account, id_operationsalert, opts)
|
|
566
|
+
|
|
567
|
+
Edit an alert on transactions or investemens
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
### Example
|
|
572
|
+
```ruby
|
|
573
|
+
# load the gem
|
|
574
|
+
require 'budgea_client'
|
|
575
|
+
|
|
576
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
577
|
+
|
|
578
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
579
|
+
|
|
580
|
+
id_account = 56 # Integer |
|
|
581
|
+
|
|
582
|
+
id_operationsalert = 56 # Integer |
|
|
583
|
+
|
|
584
|
+
opts = {
|
|
585
|
+
type: "type_example", # String | parameter to choose the scope of the alert. accepted: transactions, investements
|
|
586
|
+
income_max: 56, # Integer | capital gain thresholds
|
|
587
|
+
expense_max: 56, # Integer | capital loss thresholds
|
|
588
|
+
value_type: "value_type_example", # String | whether the threshold is given in absolut value or percent. accepted: percent, flat
|
|
589
|
+
date_range: 56, # Integer | (number of days) range on which the analysis has to be done
|
|
590
|
+
expand: "expand_example" # String |
|
|
591
|
+
}
|
|
592
|
+
|
|
593
|
+
begin
|
|
594
|
+
#Edit an alert on transactions or investemens
|
|
595
|
+
result = api_instance.users_id_user_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_account, id_operationsalert, opts)
|
|
596
|
+
p result
|
|
597
|
+
rescue BudgeaClient::ApiError => e
|
|
598
|
+
puts "Exception when calling PFMApi->users_id_user_accounts_id_account_operationsalert_id_operationsalert_put: #{e}"
|
|
599
|
+
end
|
|
600
|
+
```
|
|
601
|
+
|
|
602
|
+
### Parameters
|
|
603
|
+
|
|
604
|
+
Name | Type | Description | Notes
|
|
605
|
+
------------- | ------------- | ------------- | -------------
|
|
606
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
607
|
+
**id_account** | **Integer**| |
|
|
608
|
+
**id_operationsalert** | **Integer**| |
|
|
609
|
+
**type** | **String**| parameter to choose the scope of the alert. accepted: transactions, investements | [optional]
|
|
610
|
+
**income_max** | **Integer**| capital gain thresholds | [optional]
|
|
611
|
+
**expense_max** | **Integer**| capital loss thresholds | [optional]
|
|
612
|
+
**value_type** | **String**| whether the threshold is given in absolut value or percent. accepted: percent, flat | [optional]
|
|
613
|
+
**date_range** | **Integer**| (number of days) range on which the analysis has to be done | [optional]
|
|
614
|
+
**expand** | **String**| | [optional]
|
|
615
|
+
|
|
616
|
+
### Return type
|
|
617
|
+
|
|
618
|
+
[**UserAlert**](UserAlert.md)
|
|
619
|
+
|
|
620
|
+
### Authorization
|
|
621
|
+
|
|
622
|
+
No authorization required
|
|
623
|
+
|
|
624
|
+
### HTTP request headers
|
|
625
|
+
|
|
626
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
627
|
+
- **Accept**: application/json
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
# **users_id_user_accounts_id_account_operationsalert_post**
|
|
632
|
+
> UserAlert users_id_user_accounts_id_account_operationsalert_post(id_user, id_account, opts)
|
|
633
|
+
|
|
634
|
+
Create an alert on transactions or investemens of a given user
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
### Example
|
|
639
|
+
```ruby
|
|
640
|
+
# load the gem
|
|
641
|
+
require 'budgea_client'
|
|
642
|
+
|
|
643
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
644
|
+
|
|
645
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
646
|
+
|
|
647
|
+
id_account = 56 # Integer |
|
|
648
|
+
|
|
649
|
+
opts = {
|
|
650
|
+
type: "type_example", # String | parameter to choose the scope of the alert. accepted: transactions, investements
|
|
651
|
+
income_max: 56, # Integer | capital gain thresholds
|
|
652
|
+
expense_max: 56, # Integer | capital loss thresholds
|
|
653
|
+
value_type: "value_type_example", # String | whether the threshold is given in absolut value or percent. accepted: percent, flat
|
|
654
|
+
date_range: 56, # Integer | (number of days) range on which the analysis has to be done
|
|
655
|
+
expand: "expand_example" # String |
|
|
656
|
+
}
|
|
657
|
+
|
|
658
|
+
begin
|
|
659
|
+
#Create an alert on transactions or investemens of a given user
|
|
660
|
+
result = api_instance.users_id_user_accounts_id_account_operationsalert_post(id_user, id_account, opts)
|
|
661
|
+
p result
|
|
662
|
+
rescue BudgeaClient::ApiError => e
|
|
663
|
+
puts "Exception when calling PFMApi->users_id_user_accounts_id_account_operationsalert_post: #{e}"
|
|
664
|
+
end
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
### Parameters
|
|
668
|
+
|
|
669
|
+
Name | Type | Description | Notes
|
|
670
|
+
------------- | ------------- | ------------- | -------------
|
|
671
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
672
|
+
**id_account** | **Integer**| |
|
|
673
|
+
**type** | **String**| parameter to choose the scope of the alert. accepted: transactions, investements | [optional]
|
|
674
|
+
**income_max** | **Integer**| capital gain thresholds | [optional]
|
|
675
|
+
**expense_max** | **Integer**| capital loss thresholds | [optional]
|
|
676
|
+
**value_type** | **String**| whether the threshold is given in absolut value or percent. accepted: percent, flat | [optional]
|
|
677
|
+
**date_range** | **Integer**| (number of days) range on which the analysis has to be done | [optional]
|
|
678
|
+
**expand** | **String**| | [optional]
|
|
679
|
+
|
|
680
|
+
### Return type
|
|
681
|
+
|
|
682
|
+
[**UserAlert**](UserAlert.md)
|
|
683
|
+
|
|
684
|
+
### Authorization
|
|
685
|
+
|
|
686
|
+
No authorization required
|
|
687
|
+
|
|
688
|
+
### HTTP request headers
|
|
689
|
+
|
|
690
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
691
|
+
- **Accept**: application/json
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
# **users_id_user_accountsalert_get**
|
|
696
|
+
> Object users_id_user_accountsalert_get(id_user)
|
|
697
|
+
|
|
698
|
+
Get alert configuration of a specific account
|
|
699
|
+
|
|
700
|
+
<br><br>
|
|
701
|
+
|
|
702
|
+
### Example
|
|
703
|
+
```ruby
|
|
704
|
+
# load the gem
|
|
705
|
+
require 'budgea_client'
|
|
706
|
+
|
|
707
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
708
|
+
|
|
709
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
begin
|
|
713
|
+
#Get alert configuration of a specific account
|
|
714
|
+
result = api_instance.users_id_user_accountsalert_get(id_user)
|
|
715
|
+
p result
|
|
716
|
+
rescue BudgeaClient::ApiError => e
|
|
717
|
+
puts "Exception when calling PFMApi->users_id_user_accountsalert_get: #{e}"
|
|
718
|
+
end
|
|
719
|
+
```
|
|
720
|
+
|
|
721
|
+
### Parameters
|
|
722
|
+
|
|
723
|
+
Name | Type | Description | Notes
|
|
724
|
+
------------- | ------------- | ------------- | -------------
|
|
725
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
726
|
+
|
|
727
|
+
### Return type
|
|
728
|
+
|
|
729
|
+
**Object**
|
|
730
|
+
|
|
731
|
+
### Authorization
|
|
732
|
+
|
|
733
|
+
No authorization required
|
|
734
|
+
|
|
735
|
+
### HTTP request headers
|
|
736
|
+
|
|
737
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
738
|
+
- **Accept**: application/json
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
# **users_id_user_accountsalert_put**
|
|
743
|
+
> Object users_id_user_accountsalert_put(id_user, opts)
|
|
744
|
+
|
|
745
|
+
Update alert configuration of an account
|
|
746
|
+
|
|
747
|
+
It updates the alert configuration of a specific account<br><br><br><br>
|
|
748
|
+
|
|
749
|
+
### Example
|
|
750
|
+
```ruby
|
|
751
|
+
# load the gem
|
|
752
|
+
require 'budgea_client'
|
|
753
|
+
|
|
754
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
755
|
+
|
|
756
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
757
|
+
|
|
758
|
+
opts = {
|
|
759
|
+
expense_max: 56, # Integer | threshold from which an alert has to be sent for a high expense
|
|
760
|
+
accounts: 56, # Integer | list of accounts (id coma separated) on wich the alert has to be applied. If 'all' is given, it is applied on all accounts. default: all
|
|
761
|
+
income_max: 56, # Integer | threshold from which an alert has to be sent for a high income
|
|
762
|
+
balance_min2: 56, # Integer | second threshold from which an alert has to be sent for a low balance
|
|
763
|
+
enabled: true # BOOLEAN | if false, the alert is not taken into account
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
begin
|
|
767
|
+
#Update alert configuration of an account
|
|
768
|
+
result = api_instance.users_id_user_accountsalert_put(id_user, opts)
|
|
769
|
+
p result
|
|
770
|
+
rescue BudgeaClient::ApiError => e
|
|
771
|
+
puts "Exception when calling PFMApi->users_id_user_accountsalert_put: #{e}"
|
|
772
|
+
end
|
|
773
|
+
```
|
|
774
|
+
|
|
775
|
+
### Parameters
|
|
776
|
+
|
|
777
|
+
Name | Type | Description | Notes
|
|
778
|
+
------------- | ------------- | ------------- | -------------
|
|
779
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
780
|
+
**expense_max** | **Integer**| threshold from which an alert has to be sent for a high expense | [optional]
|
|
781
|
+
**accounts** | **Integer**| list of accounts (id coma separated) on wich the alert has to be applied. If 'all' is given, it is applied on all accounts. default: all | [optional]
|
|
782
|
+
**income_max** | **Integer**| threshold from which an alert has to be sent for a high income | [optional]
|
|
783
|
+
**balance_min2** | **Integer**| second threshold from which an alert has to be sent for a low balance | [optional]
|
|
784
|
+
**enabled** | **BOOLEAN**| if false, the alert is not taken into account | [optional]
|
|
785
|
+
|
|
786
|
+
### Return type
|
|
787
|
+
|
|
788
|
+
**Object**
|
|
789
|
+
|
|
790
|
+
### Authorization
|
|
791
|
+
|
|
792
|
+
No authorization required
|
|
793
|
+
|
|
794
|
+
### HTTP request headers
|
|
795
|
+
|
|
796
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
797
|
+
- **Accept**: application/json
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
# **users_id_user_balances_get**
|
|
802
|
+
> users_id_user_balances_get(id_user, opts)
|
|
803
|
+
|
|
804
|
+
Get balances of accounts
|
|
805
|
+
|
|
806
|
+
Get balance (income/outcome/balance) of enabled accounts for the given period.<br><br>By default, min_date and max_date are the current month, and period is a single month.<br><br>The period is composed with units (days, months, years) and numbers. You can give for example \"1month\", \"15days\", \"1year6months\", etc.<br><br>
|
|
807
|
+
|
|
808
|
+
### Example
|
|
809
|
+
```ruby
|
|
810
|
+
# load the gem
|
|
811
|
+
require 'budgea_client'
|
|
812
|
+
|
|
813
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
814
|
+
|
|
815
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
816
|
+
|
|
817
|
+
opts = {
|
|
818
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal (inclusive) date
|
|
819
|
+
max_date: Date.parse("2013-10-20"), # Date | maximal (inclusive) date
|
|
820
|
+
period: "period_example" # String | split output with the given period (default: month)
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
begin
|
|
824
|
+
#Get balances of accounts
|
|
825
|
+
api_instance.users_id_user_balances_get(id_user, opts)
|
|
826
|
+
rescue BudgeaClient::ApiError => e
|
|
827
|
+
puts "Exception when calling PFMApi->users_id_user_balances_get: #{e}"
|
|
828
|
+
end
|
|
829
|
+
```
|
|
830
|
+
|
|
831
|
+
### Parameters
|
|
832
|
+
|
|
833
|
+
Name | Type | Description | Notes
|
|
834
|
+
------------- | ------------- | ------------- | -------------
|
|
835
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
836
|
+
**min_date** | **Date**| minimal (inclusive) date | [optional]
|
|
837
|
+
**max_date** | **Date**| maximal (inclusive) date | [optional]
|
|
838
|
+
**period** | **String**| split output with the given period (default: month) | [optional]
|
|
839
|
+
|
|
840
|
+
### Return type
|
|
841
|
+
|
|
842
|
+
nil (empty response body)
|
|
843
|
+
|
|
844
|
+
### Authorization
|
|
845
|
+
|
|
846
|
+
No authorization required
|
|
847
|
+
|
|
848
|
+
### HTTP request headers
|
|
849
|
+
|
|
850
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
851
|
+
- **Accept**: application/json
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
# **users_id_user_connections_id_connection_accounts_id_account_balances_get**
|
|
856
|
+
> users_id_user_connections_id_connection_accounts_id_account_balances_get(id_user, id_connection, id_account, opts)
|
|
857
|
+
|
|
858
|
+
Get balances of accounts
|
|
859
|
+
|
|
860
|
+
Get balance (income/outcome/balance) of enabled accounts for the given period.<br><br>By default, min_date and max_date are the current month, and period is a single month.<br><br>The period is composed with units (days, months, years) and numbers. You can give for example \"1month\", \"15days\", \"1year6months\", etc.<br><br>
|
|
861
|
+
|
|
862
|
+
### Example
|
|
863
|
+
```ruby
|
|
864
|
+
# load the gem
|
|
865
|
+
require 'budgea_client'
|
|
866
|
+
|
|
867
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
868
|
+
|
|
869
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
870
|
+
|
|
871
|
+
id_connection = 56 # Integer |
|
|
872
|
+
|
|
873
|
+
id_account = 56 # Integer |
|
|
874
|
+
|
|
875
|
+
opts = {
|
|
876
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal (inclusive) date
|
|
877
|
+
max_date: Date.parse("2013-10-20"), # Date | maximal (inclusive) date
|
|
878
|
+
period: "period_example" # String | split output with the given period (default: month)
|
|
879
|
+
}
|
|
880
|
+
|
|
881
|
+
begin
|
|
882
|
+
#Get balances of accounts
|
|
883
|
+
api_instance.users_id_user_connections_id_connection_accounts_id_account_balances_get(id_user, id_connection, id_account, opts)
|
|
884
|
+
rescue BudgeaClient::ApiError => e
|
|
885
|
+
puts "Exception when calling PFMApi->users_id_user_connections_id_connection_accounts_id_account_balances_get: #{e}"
|
|
886
|
+
end
|
|
887
|
+
```
|
|
888
|
+
|
|
889
|
+
### Parameters
|
|
890
|
+
|
|
891
|
+
Name | Type | Description | Notes
|
|
892
|
+
------------- | ------------- | ------------- | -------------
|
|
893
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
894
|
+
**id_connection** | **Integer**| |
|
|
895
|
+
**id_account** | **Integer**| |
|
|
896
|
+
**min_date** | **Date**| minimal (inclusive) date | [optional]
|
|
897
|
+
**max_date** | **Date**| maximal (inclusive) date | [optional]
|
|
898
|
+
**period** | **String**| split output with the given period (default: month) | [optional]
|
|
899
|
+
|
|
900
|
+
### Return type
|
|
901
|
+
|
|
902
|
+
nil (empty response body)
|
|
903
|
+
|
|
904
|
+
### Authorization
|
|
905
|
+
|
|
906
|
+
No authorization required
|
|
907
|
+
|
|
908
|
+
### HTTP request headers
|
|
909
|
+
|
|
910
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
911
|
+
- **Accept**: application/json
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
# **users_id_user_connections_id_connection_accounts_id_account_operationsalert_get**
|
|
916
|
+
> InlineResponse20022 users_id_user_connections_id_connection_accounts_id_account_operationsalert_get(id_user, id_connection, id_account, opts)
|
|
917
|
+
|
|
918
|
+
Get a list of configurated alerts
|
|
919
|
+
|
|
920
|
+
<br><br>
|
|
921
|
+
|
|
922
|
+
### Example
|
|
923
|
+
```ruby
|
|
924
|
+
# load the gem
|
|
925
|
+
require 'budgea_client'
|
|
926
|
+
|
|
927
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
928
|
+
|
|
929
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
930
|
+
|
|
931
|
+
id_connection = 56 # Integer |
|
|
932
|
+
|
|
933
|
+
id_account = 56 # Integer |
|
|
934
|
+
|
|
935
|
+
opts = {
|
|
936
|
+
expand: "expand_example" # String |
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
begin
|
|
940
|
+
#Get a list of configurated alerts
|
|
941
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_operationsalert_get(id_user, id_connection, id_account, opts)
|
|
942
|
+
p result
|
|
943
|
+
rescue BudgeaClient::ApiError => e
|
|
944
|
+
puts "Exception when calling PFMApi->users_id_user_connections_id_connection_accounts_id_account_operationsalert_get: #{e}"
|
|
945
|
+
end
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
### Parameters
|
|
949
|
+
|
|
950
|
+
Name | Type | Description | Notes
|
|
951
|
+
------------- | ------------- | ------------- | -------------
|
|
952
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
953
|
+
**id_connection** | **Integer**| |
|
|
954
|
+
**id_account** | **Integer**| |
|
|
955
|
+
**expand** | **String**| | [optional]
|
|
956
|
+
|
|
957
|
+
### Return type
|
|
958
|
+
|
|
959
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
|
960
|
+
|
|
961
|
+
### Authorization
|
|
962
|
+
|
|
963
|
+
No authorization required
|
|
964
|
+
|
|
965
|
+
### HTTP request headers
|
|
966
|
+
|
|
967
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
968
|
+
- **Accept**: application/json
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
# **users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete**
|
|
973
|
+
> UserAlert users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete(id_user, id_connection, id_account, id_operationsalert, opts)
|
|
974
|
+
|
|
975
|
+
Delete an alert on transactions or investemens
|
|
976
|
+
|
|
977
|
+
<br><br>
|
|
978
|
+
|
|
979
|
+
### Example
|
|
980
|
+
```ruby
|
|
981
|
+
# load the gem
|
|
982
|
+
require 'budgea_client'
|
|
983
|
+
|
|
984
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
985
|
+
|
|
986
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
987
|
+
|
|
988
|
+
id_connection = 56 # Integer |
|
|
989
|
+
|
|
990
|
+
id_account = 56 # Integer |
|
|
991
|
+
|
|
992
|
+
id_operationsalert = 56 # Integer |
|
|
993
|
+
|
|
994
|
+
opts = {
|
|
995
|
+
expand: "expand_example" # String |
|
|
996
|
+
}
|
|
997
|
+
|
|
998
|
+
begin
|
|
999
|
+
#Delete an alert on transactions or investemens
|
|
1000
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete(id_user, id_connection, id_account, id_operationsalert, opts)
|
|
1001
|
+
p result
|
|
1002
|
+
rescue BudgeaClient::ApiError => e
|
|
1003
|
+
puts "Exception when calling PFMApi->users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_delete: #{e}"
|
|
1004
|
+
end
|
|
1005
|
+
```
|
|
1006
|
+
|
|
1007
|
+
### Parameters
|
|
1008
|
+
|
|
1009
|
+
Name | Type | Description | Notes
|
|
1010
|
+
------------- | ------------- | ------------- | -------------
|
|
1011
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1012
|
+
**id_connection** | **Integer**| |
|
|
1013
|
+
**id_account** | **Integer**| |
|
|
1014
|
+
**id_operationsalert** | **Integer**| |
|
|
1015
|
+
**expand** | **String**| | [optional]
|
|
1016
|
+
|
|
1017
|
+
### Return type
|
|
1018
|
+
|
|
1019
|
+
[**UserAlert**](UserAlert.md)
|
|
1020
|
+
|
|
1021
|
+
### Authorization
|
|
1022
|
+
|
|
1023
|
+
No authorization required
|
|
1024
|
+
|
|
1025
|
+
### HTTP request headers
|
|
1026
|
+
|
|
1027
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1028
|
+
- **Accept**: application/json
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
# **users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put**
|
|
1033
|
+
> UserAlert users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_connection, id_account, id_operationsalert, opts)
|
|
1034
|
+
|
|
1035
|
+
Edit an alert on transactions or investemens
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
### Example
|
|
1040
|
+
```ruby
|
|
1041
|
+
# load the gem
|
|
1042
|
+
require 'budgea_client'
|
|
1043
|
+
|
|
1044
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1045
|
+
|
|
1046
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1047
|
+
|
|
1048
|
+
id_connection = 56 # Integer |
|
|
1049
|
+
|
|
1050
|
+
id_account = 56 # Integer |
|
|
1051
|
+
|
|
1052
|
+
id_operationsalert = 56 # Integer |
|
|
1053
|
+
|
|
1054
|
+
opts = {
|
|
1055
|
+
type: "type_example", # String | parameter to choose the scope of the alert. accepted: transactions, investements
|
|
1056
|
+
income_max: 56, # Integer | capital gain thresholds
|
|
1057
|
+
expense_max: 56, # Integer | capital loss thresholds
|
|
1058
|
+
value_type: "value_type_example", # String | whether the threshold is given in absolut value or percent. accepted: percent, flat
|
|
1059
|
+
date_range: 56, # Integer | (number of days) range on which the analysis has to be done
|
|
1060
|
+
expand: "expand_example" # String |
|
|
1061
|
+
}
|
|
1062
|
+
|
|
1063
|
+
begin
|
|
1064
|
+
#Edit an alert on transactions or investemens
|
|
1065
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put(id_user, id_connection, id_account, id_operationsalert, opts)
|
|
1066
|
+
p result
|
|
1067
|
+
rescue BudgeaClient::ApiError => e
|
|
1068
|
+
puts "Exception when calling PFMApi->users_id_user_connections_id_connection_accounts_id_account_operationsalert_id_operationsalert_put: #{e}"
|
|
1069
|
+
end
|
|
1070
|
+
```
|
|
1071
|
+
|
|
1072
|
+
### Parameters
|
|
1073
|
+
|
|
1074
|
+
Name | Type | Description | Notes
|
|
1075
|
+
------------- | ------------- | ------------- | -------------
|
|
1076
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1077
|
+
**id_connection** | **Integer**| |
|
|
1078
|
+
**id_account** | **Integer**| |
|
|
1079
|
+
**id_operationsalert** | **Integer**| |
|
|
1080
|
+
**type** | **String**| parameter to choose the scope of the alert. accepted: transactions, investements | [optional]
|
|
1081
|
+
**income_max** | **Integer**| capital gain thresholds | [optional]
|
|
1082
|
+
**expense_max** | **Integer**| capital loss thresholds | [optional]
|
|
1083
|
+
**value_type** | **String**| whether the threshold is given in absolut value or percent. accepted: percent, flat | [optional]
|
|
1084
|
+
**date_range** | **Integer**| (number of days) range on which the analysis has to be done | [optional]
|
|
1085
|
+
**expand** | **String**| | [optional]
|
|
1086
|
+
|
|
1087
|
+
### Return type
|
|
1088
|
+
|
|
1089
|
+
[**UserAlert**](UserAlert.md)
|
|
1090
|
+
|
|
1091
|
+
### Authorization
|
|
1092
|
+
|
|
1093
|
+
No authorization required
|
|
1094
|
+
|
|
1095
|
+
### HTTP request headers
|
|
1096
|
+
|
|
1097
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1098
|
+
- **Accept**: application/json
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
# **users_id_user_connections_id_connection_accounts_id_account_operationsalert_post**
|
|
1103
|
+
> UserAlert users_id_user_connections_id_connection_accounts_id_account_operationsalert_post(id_user, id_connection, id_account, opts)
|
|
1104
|
+
|
|
1105
|
+
Create an alert on transactions or investemens of a given user
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
### Example
|
|
1110
|
+
```ruby
|
|
1111
|
+
# load the gem
|
|
1112
|
+
require 'budgea_client'
|
|
1113
|
+
|
|
1114
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1115
|
+
|
|
1116
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1117
|
+
|
|
1118
|
+
id_connection = 56 # Integer |
|
|
1119
|
+
|
|
1120
|
+
id_account = 56 # Integer |
|
|
1121
|
+
|
|
1122
|
+
opts = {
|
|
1123
|
+
type: "type_example", # String | parameter to choose the scope of the alert. accepted: transactions, investements
|
|
1124
|
+
income_max: 56, # Integer | capital gain thresholds
|
|
1125
|
+
expense_max: 56, # Integer | capital loss thresholds
|
|
1126
|
+
value_type: "value_type_example", # String | whether the threshold is given in absolut value or percent. accepted: percent, flat
|
|
1127
|
+
date_range: 56, # Integer | (number of days) range on which the analysis has to be done
|
|
1128
|
+
expand: "expand_example" # String |
|
|
1129
|
+
}
|
|
1130
|
+
|
|
1131
|
+
begin
|
|
1132
|
+
#Create an alert on transactions or investemens of a given user
|
|
1133
|
+
result = api_instance.users_id_user_connections_id_connection_accounts_id_account_operationsalert_post(id_user, id_connection, id_account, opts)
|
|
1134
|
+
p result
|
|
1135
|
+
rescue BudgeaClient::ApiError => e
|
|
1136
|
+
puts "Exception when calling PFMApi->users_id_user_connections_id_connection_accounts_id_account_operationsalert_post: #{e}"
|
|
1137
|
+
end
|
|
1138
|
+
```
|
|
1139
|
+
|
|
1140
|
+
### Parameters
|
|
1141
|
+
|
|
1142
|
+
Name | Type | Description | Notes
|
|
1143
|
+
------------- | ------------- | ------------- | -------------
|
|
1144
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1145
|
+
**id_connection** | **Integer**| |
|
|
1146
|
+
**id_account** | **Integer**| |
|
|
1147
|
+
**type** | **String**| parameter to choose the scope of the alert. accepted: transactions, investements | [optional]
|
|
1148
|
+
**income_max** | **Integer**| capital gain thresholds | [optional]
|
|
1149
|
+
**expense_max** | **Integer**| capital loss thresholds | [optional]
|
|
1150
|
+
**value_type** | **String**| whether the threshold is given in absolut value or percent. accepted: percent, flat | [optional]
|
|
1151
|
+
**date_range** | **Integer**| (number of days) range on which the analysis has to be done | [optional]
|
|
1152
|
+
**expand** | **String**| | [optional]
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
[**UserAlert**](UserAlert.md)
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
No authorization required
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
# **users_id_user_connections_id_connection_balances_get**
|
|
1170
|
+
> users_id_user_connections_id_connection_balances_get(id_user, id_connection, opts)
|
|
1171
|
+
|
|
1172
|
+
Get balances of accounts
|
|
1173
|
+
|
|
1174
|
+
Get balance (income/outcome/balance) of enabled accounts for the given period.<br><br>By default, min_date and max_date are the current month, and period is a single month.<br><br>The period is composed with units (days, months, years) and numbers. You can give for example \"1month\", \"15days\", \"1year6months\", etc.<br><br>
|
|
1175
|
+
|
|
1176
|
+
### Example
|
|
1177
|
+
```ruby
|
|
1178
|
+
# load the gem
|
|
1179
|
+
require 'budgea_client'
|
|
1180
|
+
|
|
1181
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1182
|
+
|
|
1183
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1184
|
+
|
|
1185
|
+
id_connection = 56 # Integer |
|
|
1186
|
+
|
|
1187
|
+
opts = {
|
|
1188
|
+
min_date: Date.parse("2013-10-20"), # Date | minimal (inclusive) date
|
|
1189
|
+
max_date: Date.parse("2013-10-20"), # Date | maximal (inclusive) date
|
|
1190
|
+
period: "period_example" # String | split output with the given period (default: month)
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
begin
|
|
1194
|
+
#Get balances of accounts
|
|
1195
|
+
api_instance.users_id_user_connections_id_connection_balances_get(id_user, id_connection, opts)
|
|
1196
|
+
rescue BudgeaClient::ApiError => e
|
|
1197
|
+
puts "Exception when calling PFMApi->users_id_user_connections_id_connection_balances_get: #{e}"
|
|
1198
|
+
end
|
|
1199
|
+
```
|
|
1200
|
+
|
|
1201
|
+
### Parameters
|
|
1202
|
+
|
|
1203
|
+
Name | Type | Description | Notes
|
|
1204
|
+
------------- | ------------- | ------------- | -------------
|
|
1205
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1206
|
+
**id_connection** | **Integer**| |
|
|
1207
|
+
**min_date** | **Date**| minimal (inclusive) date | [optional]
|
|
1208
|
+
**max_date** | **Date**| maximal (inclusive) date | [optional]
|
|
1209
|
+
**period** | **String**| split output with the given period (default: month) | [optional]
|
|
1210
|
+
|
|
1211
|
+
### Return type
|
|
1212
|
+
|
|
1213
|
+
nil (empty response body)
|
|
1214
|
+
|
|
1215
|
+
### Authorization
|
|
1216
|
+
|
|
1217
|
+
No authorization required
|
|
1218
|
+
|
|
1219
|
+
### HTTP request headers
|
|
1220
|
+
|
|
1221
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1222
|
+
- **Accept**: application/json
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
# **users_id_user_devices_get**
|
|
1227
|
+
> InlineResponse20031 users_id_user_devices_get(id_user, opts)
|
|
1228
|
+
|
|
1229
|
+
Get devices
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
### Example
|
|
1234
|
+
```ruby
|
|
1235
|
+
# load the gem
|
|
1236
|
+
require 'budgea_client'
|
|
1237
|
+
|
|
1238
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1239
|
+
|
|
1240
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1241
|
+
|
|
1242
|
+
opts = {
|
|
1243
|
+
expand: "expand_example" # String |
|
|
1244
|
+
}
|
|
1245
|
+
|
|
1246
|
+
begin
|
|
1247
|
+
#Get devices
|
|
1248
|
+
result = api_instance.users_id_user_devices_get(id_user, opts)
|
|
1249
|
+
p result
|
|
1250
|
+
rescue BudgeaClient::ApiError => e
|
|
1251
|
+
puts "Exception when calling PFMApi->users_id_user_devices_get: #{e}"
|
|
1252
|
+
end
|
|
1253
|
+
```
|
|
1254
|
+
|
|
1255
|
+
### Parameters
|
|
1256
|
+
|
|
1257
|
+
Name | Type | Description | Notes
|
|
1258
|
+
------------- | ------------- | ------------- | -------------
|
|
1259
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1260
|
+
**expand** | **String**| | [optional]
|
|
1261
|
+
|
|
1262
|
+
### Return type
|
|
1263
|
+
|
|
1264
|
+
[**InlineResponse20031**](InlineResponse20031.md)
|
|
1265
|
+
|
|
1266
|
+
### Authorization
|
|
1267
|
+
|
|
1268
|
+
No authorization required
|
|
1269
|
+
|
|
1270
|
+
### HTTP request headers
|
|
1271
|
+
|
|
1272
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1273
|
+
- **Accept**: application/json
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
# **users_id_user_devices_id_device_delete**
|
|
1278
|
+
> Device users_id_user_devices_id_device_delete(id_user, id_device, opts)
|
|
1279
|
+
|
|
1280
|
+
Delete device.
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
### Example
|
|
1285
|
+
```ruby
|
|
1286
|
+
# load the gem
|
|
1287
|
+
require 'budgea_client'
|
|
1288
|
+
|
|
1289
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1290
|
+
|
|
1291
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1292
|
+
|
|
1293
|
+
id_device = 56 # Integer |
|
|
1294
|
+
|
|
1295
|
+
opts = {
|
|
1296
|
+
expand: "expand_example" # String |
|
|
1297
|
+
}
|
|
1298
|
+
|
|
1299
|
+
begin
|
|
1300
|
+
#Delete device.
|
|
1301
|
+
result = api_instance.users_id_user_devices_id_device_delete(id_user, id_device, opts)
|
|
1302
|
+
p result
|
|
1303
|
+
rescue BudgeaClient::ApiError => e
|
|
1304
|
+
puts "Exception when calling PFMApi->users_id_user_devices_id_device_delete: #{e}"
|
|
1305
|
+
end
|
|
1306
|
+
```
|
|
1307
|
+
|
|
1308
|
+
### Parameters
|
|
1309
|
+
|
|
1310
|
+
Name | Type | Description | Notes
|
|
1311
|
+
------------- | ------------- | ------------- | -------------
|
|
1312
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1313
|
+
**id_device** | **Integer**| |
|
|
1314
|
+
**expand** | **String**| | [optional]
|
|
1315
|
+
|
|
1316
|
+
### Return type
|
|
1317
|
+
|
|
1318
|
+
[**Device**](Device.md)
|
|
1319
|
+
|
|
1320
|
+
### Authorization
|
|
1321
|
+
|
|
1322
|
+
No authorization required
|
|
1323
|
+
|
|
1324
|
+
### HTTP request headers
|
|
1325
|
+
|
|
1326
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1327
|
+
- **Accept**: application/json
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
|
|
1331
|
+
# **users_id_user_devices_id_device_get**
|
|
1332
|
+
> Device users_id_user_devices_id_device_get(id_user, id_device, opts)
|
|
1333
|
+
|
|
1334
|
+
Get a device
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
### Example
|
|
1339
|
+
```ruby
|
|
1340
|
+
# load the gem
|
|
1341
|
+
require 'budgea_client'
|
|
1342
|
+
|
|
1343
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1344
|
+
|
|
1345
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1346
|
+
|
|
1347
|
+
id_device = 56 # Integer |
|
|
1348
|
+
|
|
1349
|
+
opts = {
|
|
1350
|
+
expand: "expand_example" # String |
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
begin
|
|
1354
|
+
#Get a device
|
|
1355
|
+
result = api_instance.users_id_user_devices_id_device_get(id_user, id_device, opts)
|
|
1356
|
+
p result
|
|
1357
|
+
rescue BudgeaClient::ApiError => e
|
|
1358
|
+
puts "Exception when calling PFMApi->users_id_user_devices_id_device_get: #{e}"
|
|
1359
|
+
end
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### Parameters
|
|
1363
|
+
|
|
1364
|
+
Name | Type | Description | Notes
|
|
1365
|
+
------------- | ------------- | ------------- | -------------
|
|
1366
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1367
|
+
**id_device** | **Integer**| |
|
|
1368
|
+
**expand** | **String**| | [optional]
|
|
1369
|
+
|
|
1370
|
+
### Return type
|
|
1371
|
+
|
|
1372
|
+
[**Device**](Device.md)
|
|
1373
|
+
|
|
1374
|
+
### Authorization
|
|
1375
|
+
|
|
1376
|
+
No authorization required
|
|
1377
|
+
|
|
1378
|
+
### HTTP request headers
|
|
1379
|
+
|
|
1380
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1381
|
+
- **Accept**: application/json
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
# **users_id_user_devices_id_device_put**
|
|
1386
|
+
> Device users_id_user_devices_id_device_put(id_user, id_device, notification_token, application, opts)
|
|
1387
|
+
|
|
1388
|
+
Update attributes of the device.
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
### Example
|
|
1393
|
+
```ruby
|
|
1394
|
+
# load the gem
|
|
1395
|
+
require 'budgea_client'
|
|
1396
|
+
|
|
1397
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1398
|
+
|
|
1399
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1400
|
+
|
|
1401
|
+
id_device = 56 # Integer |
|
|
1402
|
+
|
|
1403
|
+
notification_token = "notification_token_example" # String | the GCM or APNS notification_token to use
|
|
1404
|
+
|
|
1405
|
+
application = "application_example" # String | the device in use
|
|
1406
|
+
|
|
1407
|
+
opts = {
|
|
1408
|
+
notification_version: 56, # Integer | version of notifications
|
|
1409
|
+
expand: "expand_example" # String |
|
|
1410
|
+
}
|
|
1411
|
+
|
|
1412
|
+
begin
|
|
1413
|
+
#Update attributes of the device.
|
|
1414
|
+
result = api_instance.users_id_user_devices_id_device_put(id_user, id_device, notification_token, application, opts)
|
|
1415
|
+
p result
|
|
1416
|
+
rescue BudgeaClient::ApiError => e
|
|
1417
|
+
puts "Exception when calling PFMApi->users_id_user_devices_id_device_put: #{e}"
|
|
1418
|
+
end
|
|
1419
|
+
```
|
|
1420
|
+
|
|
1421
|
+
### Parameters
|
|
1422
|
+
|
|
1423
|
+
Name | Type | Description | Notes
|
|
1424
|
+
------------- | ------------- | ------------- | -------------
|
|
1425
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1426
|
+
**id_device** | **Integer**| |
|
|
1427
|
+
**notification_token** | **String**| the GCM or APNS notification_token to use |
|
|
1428
|
+
**application** | **String**| the device in use |
|
|
1429
|
+
**notification_version** | **Integer**| version of notifications | [optional]
|
|
1430
|
+
**expand** | **String**| | [optional]
|
|
1431
|
+
|
|
1432
|
+
### Return type
|
|
1433
|
+
|
|
1434
|
+
[**Device**](Device.md)
|
|
1435
|
+
|
|
1436
|
+
### Authorization
|
|
1437
|
+
|
|
1438
|
+
No authorization required
|
|
1439
|
+
|
|
1440
|
+
### HTTP request headers
|
|
1441
|
+
|
|
1442
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1443
|
+
- **Accept**: application/json
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
# **users_id_user_devices_post**
|
|
1448
|
+
> Device users_id_user_devices_post(id_user, notification_token, application, opts)
|
|
1449
|
+
|
|
1450
|
+
Create a device linked to specified token.
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
### Example
|
|
1455
|
+
```ruby
|
|
1456
|
+
# load the gem
|
|
1457
|
+
require 'budgea_client'
|
|
1458
|
+
|
|
1459
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1460
|
+
|
|
1461
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1462
|
+
|
|
1463
|
+
notification_token = "notification_token_example" # String | the GCM or APNS notification_token to use
|
|
1464
|
+
|
|
1465
|
+
application = "application_example" # String | the device in use
|
|
1466
|
+
|
|
1467
|
+
opts = {
|
|
1468
|
+
notification_version: 56, # Integer | version of notifications
|
|
1469
|
+
expand: "expand_example" # String |
|
|
1470
|
+
}
|
|
1471
|
+
|
|
1472
|
+
begin
|
|
1473
|
+
#Create a device linked to specified token.
|
|
1474
|
+
result = api_instance.users_id_user_devices_post(id_user, notification_token, application, opts)
|
|
1475
|
+
p result
|
|
1476
|
+
rescue BudgeaClient::ApiError => e
|
|
1477
|
+
puts "Exception when calling PFMApi->users_id_user_devices_post: #{e}"
|
|
1478
|
+
end
|
|
1479
|
+
```
|
|
1480
|
+
|
|
1481
|
+
### Parameters
|
|
1482
|
+
|
|
1483
|
+
Name | Type | Description | Notes
|
|
1484
|
+
------------- | ------------- | ------------- | -------------
|
|
1485
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1486
|
+
**notification_token** | **String**| the GCM or APNS notification_token to use |
|
|
1487
|
+
**application** | **String**| the device in use |
|
|
1488
|
+
**notification_version** | **Integer**| version of notifications | [optional]
|
|
1489
|
+
**expand** | **String**| | [optional]
|
|
1490
|
+
|
|
1491
|
+
### Return type
|
|
1492
|
+
|
|
1493
|
+
[**Device**](Device.md)
|
|
1494
|
+
|
|
1495
|
+
### Authorization
|
|
1496
|
+
|
|
1497
|
+
No authorization required
|
|
1498
|
+
|
|
1499
|
+
### HTTP request headers
|
|
1500
|
+
|
|
1501
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1502
|
+
- **Accept**: application/json
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
# **users_id_user_forecast_get**
|
|
1507
|
+
> users_id_user_forecast_get(id_user)
|
|
1508
|
+
|
|
1509
|
+
Get forecast
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
### Example
|
|
1514
|
+
```ruby
|
|
1515
|
+
# load the gem
|
|
1516
|
+
require 'budgea_client'
|
|
1517
|
+
|
|
1518
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1519
|
+
|
|
1520
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
begin
|
|
1524
|
+
#Get forecast
|
|
1525
|
+
api_instance.users_id_user_forecast_get(id_user)
|
|
1526
|
+
rescue BudgeaClient::ApiError => e
|
|
1527
|
+
puts "Exception when calling PFMApi->users_id_user_forecast_get: #{e}"
|
|
1528
|
+
end
|
|
1529
|
+
```
|
|
1530
|
+
|
|
1531
|
+
### Parameters
|
|
1532
|
+
|
|
1533
|
+
Name | Type | Description | Notes
|
|
1534
|
+
------------- | ------------- | ------------- | -------------
|
|
1535
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1536
|
+
|
|
1537
|
+
### Return type
|
|
1538
|
+
|
|
1539
|
+
nil (empty response body)
|
|
1540
|
+
|
|
1541
|
+
### Authorization
|
|
1542
|
+
|
|
1543
|
+
No authorization required
|
|
1544
|
+
|
|
1545
|
+
### HTTP request headers
|
|
1546
|
+
|
|
1547
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1548
|
+
- **Accept**: application/json
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
# **users_id_user_get**
|
|
1553
|
+
> User users_id_user_get(id_user, opts)
|
|
1554
|
+
|
|
1555
|
+
Get a user
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
### Example
|
|
1560
|
+
```ruby
|
|
1561
|
+
# load the gem
|
|
1562
|
+
require 'budgea_client'
|
|
1563
|
+
|
|
1564
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1565
|
+
|
|
1566
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1567
|
+
|
|
1568
|
+
opts = {
|
|
1569
|
+
expand: "expand_example" # String |
|
|
1570
|
+
}
|
|
1571
|
+
|
|
1572
|
+
begin
|
|
1573
|
+
#Get a user
|
|
1574
|
+
result = api_instance.users_id_user_get(id_user, opts)
|
|
1575
|
+
p result
|
|
1576
|
+
rescue BudgeaClient::ApiError => e
|
|
1577
|
+
puts "Exception when calling PFMApi->users_id_user_get: #{e}"
|
|
1578
|
+
end
|
|
1579
|
+
```
|
|
1580
|
+
|
|
1581
|
+
### Parameters
|
|
1582
|
+
|
|
1583
|
+
Name | Type | Description | Notes
|
|
1584
|
+
------------- | ------------- | ------------- | -------------
|
|
1585
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1586
|
+
**expand** | **String**| | [optional]
|
|
1587
|
+
|
|
1588
|
+
### Return type
|
|
1589
|
+
|
|
1590
|
+
[**User**](User.md)
|
|
1591
|
+
|
|
1592
|
+
### Authorization
|
|
1593
|
+
|
|
1594
|
+
No authorization required
|
|
1595
|
+
|
|
1596
|
+
### HTTP request headers
|
|
1597
|
+
|
|
1598
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1599
|
+
- **Accept**: application/json
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
# **users_id_user_operationsalert_get**
|
|
1604
|
+
> InlineResponse20022 users_id_user_operationsalert_get(id_user, opts)
|
|
1605
|
+
|
|
1606
|
+
Get a list of configurated alerts
|
|
1607
|
+
|
|
1608
|
+
<br><br>
|
|
1609
|
+
|
|
1610
|
+
### Example
|
|
1611
|
+
```ruby
|
|
1612
|
+
# load the gem
|
|
1613
|
+
require 'budgea_client'
|
|
1614
|
+
|
|
1615
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1616
|
+
|
|
1617
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1618
|
+
|
|
1619
|
+
opts = {
|
|
1620
|
+
expand: "expand_example" # String |
|
|
1621
|
+
}
|
|
1622
|
+
|
|
1623
|
+
begin
|
|
1624
|
+
#Get a list of configurated alerts
|
|
1625
|
+
result = api_instance.users_id_user_operationsalert_get(id_user, opts)
|
|
1626
|
+
p result
|
|
1627
|
+
rescue BudgeaClient::ApiError => e
|
|
1628
|
+
puts "Exception when calling PFMApi->users_id_user_operationsalert_get: #{e}"
|
|
1629
|
+
end
|
|
1630
|
+
```
|
|
1631
|
+
|
|
1632
|
+
### Parameters
|
|
1633
|
+
|
|
1634
|
+
Name | Type | Description | Notes
|
|
1635
|
+
------------- | ------------- | ------------- | -------------
|
|
1636
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1637
|
+
**expand** | **String**| | [optional]
|
|
1638
|
+
|
|
1639
|
+
### Return type
|
|
1640
|
+
|
|
1641
|
+
[**InlineResponse20022**](InlineResponse20022.md)
|
|
1642
|
+
|
|
1643
|
+
### Authorization
|
|
1644
|
+
|
|
1645
|
+
No authorization required
|
|
1646
|
+
|
|
1647
|
+
### HTTP request headers
|
|
1648
|
+
|
|
1649
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1650
|
+
- **Accept**: application/json
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
# **users_id_user_operationsalert_id_operationsalert_delete**
|
|
1655
|
+
> UserAlert users_id_user_operationsalert_id_operationsalert_delete(id_user, id_operationsalert, opts)
|
|
1656
|
+
|
|
1657
|
+
Delete an alert on transactions or investemens
|
|
1658
|
+
|
|
1659
|
+
<br><br>
|
|
1660
|
+
|
|
1661
|
+
### Example
|
|
1662
|
+
```ruby
|
|
1663
|
+
# load the gem
|
|
1664
|
+
require 'budgea_client'
|
|
1665
|
+
|
|
1666
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1667
|
+
|
|
1668
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1669
|
+
|
|
1670
|
+
id_operationsalert = 56 # Integer |
|
|
1671
|
+
|
|
1672
|
+
opts = {
|
|
1673
|
+
expand: "expand_example" # String |
|
|
1674
|
+
}
|
|
1675
|
+
|
|
1676
|
+
begin
|
|
1677
|
+
#Delete an alert on transactions or investemens
|
|
1678
|
+
result = api_instance.users_id_user_operationsalert_id_operationsalert_delete(id_user, id_operationsalert, opts)
|
|
1679
|
+
p result
|
|
1680
|
+
rescue BudgeaClient::ApiError => e
|
|
1681
|
+
puts "Exception when calling PFMApi->users_id_user_operationsalert_id_operationsalert_delete: #{e}"
|
|
1682
|
+
end
|
|
1683
|
+
```
|
|
1684
|
+
|
|
1685
|
+
### Parameters
|
|
1686
|
+
|
|
1687
|
+
Name | Type | Description | Notes
|
|
1688
|
+
------------- | ------------- | ------------- | -------------
|
|
1689
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1690
|
+
**id_operationsalert** | **Integer**| |
|
|
1691
|
+
**expand** | **String**| | [optional]
|
|
1692
|
+
|
|
1693
|
+
### Return type
|
|
1694
|
+
|
|
1695
|
+
[**UserAlert**](UserAlert.md)
|
|
1696
|
+
|
|
1697
|
+
### Authorization
|
|
1698
|
+
|
|
1699
|
+
No authorization required
|
|
1700
|
+
|
|
1701
|
+
### HTTP request headers
|
|
1702
|
+
|
|
1703
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1704
|
+
- **Accept**: application/json
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
# **users_id_user_operationsalert_id_operationsalert_put**
|
|
1709
|
+
> UserAlert users_id_user_operationsalert_id_operationsalert_put(id_user, id_operationsalert, opts)
|
|
1710
|
+
|
|
1711
|
+
Edit an alert on transactions or investemens
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
### Example
|
|
1716
|
+
```ruby
|
|
1717
|
+
# load the gem
|
|
1718
|
+
require 'budgea_client'
|
|
1719
|
+
|
|
1720
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1721
|
+
|
|
1722
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1723
|
+
|
|
1724
|
+
id_operationsalert = 56 # Integer |
|
|
1725
|
+
|
|
1726
|
+
opts = {
|
|
1727
|
+
type: "type_example", # String | parameter to choose the scope of the alert. accepted: transactions, investements
|
|
1728
|
+
income_max: 56, # Integer | capital gain thresholds
|
|
1729
|
+
expense_max: 56, # Integer | capital loss thresholds
|
|
1730
|
+
value_type: "value_type_example", # String | whether the threshold is given in absolut value or percent. accepted: percent, flat
|
|
1731
|
+
date_range: 56, # Integer | (number of days) range on which the analysis has to be done
|
|
1732
|
+
expand: "expand_example" # String |
|
|
1733
|
+
}
|
|
1734
|
+
|
|
1735
|
+
begin
|
|
1736
|
+
#Edit an alert on transactions or investemens
|
|
1737
|
+
result = api_instance.users_id_user_operationsalert_id_operationsalert_put(id_user, id_operationsalert, opts)
|
|
1738
|
+
p result
|
|
1739
|
+
rescue BudgeaClient::ApiError => e
|
|
1740
|
+
puts "Exception when calling PFMApi->users_id_user_operationsalert_id_operationsalert_put: #{e}"
|
|
1741
|
+
end
|
|
1742
|
+
```
|
|
1743
|
+
|
|
1744
|
+
### Parameters
|
|
1745
|
+
|
|
1746
|
+
Name | Type | Description | Notes
|
|
1747
|
+
------------- | ------------- | ------------- | -------------
|
|
1748
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1749
|
+
**id_operationsalert** | **Integer**| |
|
|
1750
|
+
**type** | **String**| parameter to choose the scope of the alert. accepted: transactions, investements | [optional]
|
|
1751
|
+
**income_max** | **Integer**| capital gain thresholds | [optional]
|
|
1752
|
+
**expense_max** | **Integer**| capital loss thresholds | [optional]
|
|
1753
|
+
**value_type** | **String**| whether the threshold is given in absolut value or percent. accepted: percent, flat | [optional]
|
|
1754
|
+
**date_range** | **Integer**| (number of days) range on which the analysis has to be done | [optional]
|
|
1755
|
+
**expand** | **String**| | [optional]
|
|
1756
|
+
|
|
1757
|
+
### Return type
|
|
1758
|
+
|
|
1759
|
+
[**UserAlert**](UserAlert.md)
|
|
1760
|
+
|
|
1761
|
+
### Authorization
|
|
1762
|
+
|
|
1763
|
+
No authorization required
|
|
1764
|
+
|
|
1765
|
+
### HTTP request headers
|
|
1766
|
+
|
|
1767
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1768
|
+
- **Accept**: application/json
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
# **users_id_user_operationsalert_post**
|
|
1773
|
+
> UserAlert users_id_user_operationsalert_post(id_user, opts)
|
|
1774
|
+
|
|
1775
|
+
Create an alert on transactions or investemens of a given user
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
### Example
|
|
1780
|
+
```ruby
|
|
1781
|
+
# load the gem
|
|
1782
|
+
require 'budgea_client'
|
|
1783
|
+
|
|
1784
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1785
|
+
|
|
1786
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1787
|
+
|
|
1788
|
+
opts = {
|
|
1789
|
+
type: "type_example", # String | parameter to choose the scope of the alert. accepted: transactions, investements
|
|
1790
|
+
income_max: 56, # Integer | capital gain thresholds
|
|
1791
|
+
expense_max: 56, # Integer | capital loss thresholds
|
|
1792
|
+
value_type: "value_type_example", # String | whether the threshold is given in absolut value or percent. accepted: percent, flat
|
|
1793
|
+
date_range: 56, # Integer | (number of days) range on which the analysis has to be done
|
|
1794
|
+
expand: "expand_example" # String |
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
begin
|
|
1798
|
+
#Create an alert on transactions or investemens of a given user
|
|
1799
|
+
result = api_instance.users_id_user_operationsalert_post(id_user, opts)
|
|
1800
|
+
p result
|
|
1801
|
+
rescue BudgeaClient::ApiError => e
|
|
1802
|
+
puts "Exception when calling PFMApi->users_id_user_operationsalert_post: #{e}"
|
|
1803
|
+
end
|
|
1804
|
+
```
|
|
1805
|
+
|
|
1806
|
+
### Parameters
|
|
1807
|
+
|
|
1808
|
+
Name | Type | Description | Notes
|
|
1809
|
+
------------- | ------------- | ------------- | -------------
|
|
1810
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1811
|
+
**type** | **String**| parameter to choose the scope of the alert. accepted: transactions, investements | [optional]
|
|
1812
|
+
**income_max** | **Integer**| capital gain thresholds | [optional]
|
|
1813
|
+
**expense_max** | **Integer**| capital loss thresholds | [optional]
|
|
1814
|
+
**value_type** | **String**| whether the threshold is given in absolut value or percent. accepted: percent, flat | [optional]
|
|
1815
|
+
**date_range** | **Integer**| (number of days) range on which the analysis has to be done | [optional]
|
|
1816
|
+
**expand** | **String**| | [optional]
|
|
1817
|
+
|
|
1818
|
+
### Return type
|
|
1819
|
+
|
|
1820
|
+
[**UserAlert**](UserAlert.md)
|
|
1821
|
+
|
|
1822
|
+
### Authorization
|
|
1823
|
+
|
|
1824
|
+
No authorization required
|
|
1825
|
+
|
|
1826
|
+
### HTTP request headers
|
|
1827
|
+
|
|
1828
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1829
|
+
- **Accept**: application/json
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
# **users_id_user_profiles_get**
|
|
1834
|
+
> InlineResponse20032 users_id_user_profiles_get(id_user, opts)
|
|
1835
|
+
|
|
1836
|
+
Get profiles
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
### Example
|
|
1841
|
+
```ruby
|
|
1842
|
+
# load the gem
|
|
1843
|
+
require 'budgea_client'
|
|
1844
|
+
|
|
1845
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1846
|
+
|
|
1847
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1848
|
+
|
|
1849
|
+
opts = {
|
|
1850
|
+
expand: "expand_example" # String |
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
begin
|
|
1854
|
+
#Get profiles
|
|
1855
|
+
result = api_instance.users_id_user_profiles_get(id_user, opts)
|
|
1856
|
+
p result
|
|
1857
|
+
rescue BudgeaClient::ApiError => e
|
|
1858
|
+
puts "Exception when calling PFMApi->users_id_user_profiles_get: #{e}"
|
|
1859
|
+
end
|
|
1860
|
+
```
|
|
1861
|
+
|
|
1862
|
+
### Parameters
|
|
1863
|
+
|
|
1864
|
+
Name | Type | Description | Notes
|
|
1865
|
+
------------- | ------------- | ------------- | -------------
|
|
1866
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1867
|
+
**expand** | **String**| | [optional]
|
|
1868
|
+
|
|
1869
|
+
### Return type
|
|
1870
|
+
|
|
1871
|
+
[**InlineResponse20032**](InlineResponse20032.md)
|
|
1872
|
+
|
|
1873
|
+
### Authorization
|
|
1874
|
+
|
|
1875
|
+
No authorization required
|
|
1876
|
+
|
|
1877
|
+
### HTTP request headers
|
|
1878
|
+
|
|
1879
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1880
|
+
- **Accept**: application/json
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
# **users_id_user_profiles_id_profile_get**
|
|
1885
|
+
> Profile users_id_user_profiles_id_profile_get(id_user, id_profile, opts)
|
|
1886
|
+
|
|
1887
|
+
Get a profile
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
### Example
|
|
1892
|
+
```ruby
|
|
1893
|
+
# load the gem
|
|
1894
|
+
require 'budgea_client'
|
|
1895
|
+
|
|
1896
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1897
|
+
|
|
1898
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1899
|
+
|
|
1900
|
+
id_profile = 56 # Integer |
|
|
1901
|
+
|
|
1902
|
+
opts = {
|
|
1903
|
+
expand: "expand_example" # String |
|
|
1904
|
+
}
|
|
1905
|
+
|
|
1906
|
+
begin
|
|
1907
|
+
#Get a profile
|
|
1908
|
+
result = api_instance.users_id_user_profiles_id_profile_get(id_user, id_profile, opts)
|
|
1909
|
+
p result
|
|
1910
|
+
rescue BudgeaClient::ApiError => e
|
|
1911
|
+
puts "Exception when calling PFMApi->users_id_user_profiles_id_profile_get: #{e}"
|
|
1912
|
+
end
|
|
1913
|
+
```
|
|
1914
|
+
|
|
1915
|
+
### Parameters
|
|
1916
|
+
|
|
1917
|
+
Name | Type | Description | Notes
|
|
1918
|
+
------------- | ------------- | ------------- | -------------
|
|
1919
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1920
|
+
**id_profile** | **Integer**| |
|
|
1921
|
+
**expand** | **String**| | [optional]
|
|
1922
|
+
|
|
1923
|
+
### Return type
|
|
1924
|
+
|
|
1925
|
+
[**Profile**](Profile.md)
|
|
1926
|
+
|
|
1927
|
+
### Authorization
|
|
1928
|
+
|
|
1929
|
+
No authorization required
|
|
1930
|
+
|
|
1931
|
+
### HTTP request headers
|
|
1932
|
+
|
|
1933
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1934
|
+
- **Accept**: application/json
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
# **users_id_user_profiles_main_get**
|
|
1939
|
+
> Profile users_id_user_profiles_main_get(id_user, opts)
|
|
1940
|
+
|
|
1941
|
+
Get the main profile
|
|
1942
|
+
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
### Example
|
|
1946
|
+
```ruby
|
|
1947
|
+
# load the gem
|
|
1948
|
+
require 'budgea_client'
|
|
1949
|
+
|
|
1950
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
1951
|
+
|
|
1952
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
1953
|
+
|
|
1954
|
+
opts = {
|
|
1955
|
+
expand: "expand_example" # String |
|
|
1956
|
+
}
|
|
1957
|
+
|
|
1958
|
+
begin
|
|
1959
|
+
#Get the main profile
|
|
1960
|
+
result = api_instance.users_id_user_profiles_main_get(id_user, opts)
|
|
1961
|
+
p result
|
|
1962
|
+
rescue BudgeaClient::ApiError => e
|
|
1963
|
+
puts "Exception when calling PFMApi->users_id_user_profiles_main_get: #{e}"
|
|
1964
|
+
end
|
|
1965
|
+
```
|
|
1966
|
+
|
|
1967
|
+
### Parameters
|
|
1968
|
+
|
|
1969
|
+
Name | Type | Description | Notes
|
|
1970
|
+
------------- | ------------- | ------------- | -------------
|
|
1971
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
1972
|
+
**expand** | **String**| | [optional]
|
|
1973
|
+
|
|
1974
|
+
### Return type
|
|
1975
|
+
|
|
1976
|
+
[**Profile**](Profile.md)
|
|
1977
|
+
|
|
1978
|
+
### Authorization
|
|
1979
|
+
|
|
1980
|
+
No authorization required
|
|
1981
|
+
|
|
1982
|
+
### HTTP request headers
|
|
1983
|
+
|
|
1984
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
1985
|
+
- **Accept**: application/json
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
# **users_id_user_profiles_me_get**
|
|
1990
|
+
> Profile users_id_user_profiles_me_get(id_user, opts)
|
|
1991
|
+
|
|
1992
|
+
Get my profile
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
### Example
|
|
1997
|
+
```ruby
|
|
1998
|
+
# load the gem
|
|
1999
|
+
require 'budgea_client'
|
|
2000
|
+
|
|
2001
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
2002
|
+
|
|
2003
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2004
|
+
|
|
2005
|
+
opts = {
|
|
2006
|
+
expand: "expand_example" # String |
|
|
2007
|
+
}
|
|
2008
|
+
|
|
2009
|
+
begin
|
|
2010
|
+
#Get my profile
|
|
2011
|
+
result = api_instance.users_id_user_profiles_me_get(id_user, opts)
|
|
2012
|
+
p result
|
|
2013
|
+
rescue BudgeaClient::ApiError => e
|
|
2014
|
+
puts "Exception when calling PFMApi->users_id_user_profiles_me_get: #{e}"
|
|
2015
|
+
end
|
|
2016
|
+
```
|
|
2017
|
+
|
|
2018
|
+
### Parameters
|
|
2019
|
+
|
|
2020
|
+
Name | Type | Description | Notes
|
|
2021
|
+
------------- | ------------- | ------------- | -------------
|
|
2022
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2023
|
+
**expand** | **String**| | [optional]
|
|
2024
|
+
|
|
2025
|
+
### Return type
|
|
2026
|
+
|
|
2027
|
+
[**Profile**](Profile.md)
|
|
2028
|
+
|
|
2029
|
+
### Authorization
|
|
2030
|
+
|
|
2031
|
+
No authorization required
|
|
2032
|
+
|
|
2033
|
+
### HTTP request headers
|
|
2034
|
+
|
|
2035
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2036
|
+
- **Accept**: application/json
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
# **users_id_user_profiles_me_put**
|
|
2041
|
+
> Profile users_id_user_profiles_me_put(id_user, opts)
|
|
2042
|
+
|
|
2043
|
+
Change settings of the profile.
|
|
2044
|
+
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
### Example
|
|
2048
|
+
```ruby
|
|
2049
|
+
# load the gem
|
|
2050
|
+
require 'budgea_client'
|
|
2051
|
+
|
|
2052
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
2053
|
+
|
|
2054
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2055
|
+
|
|
2056
|
+
opts = {
|
|
2057
|
+
email: "email_example", # String | change email of profile
|
|
2058
|
+
password: "password_example", # String | change password of profile
|
|
2059
|
+
current_password: "current_password_example", # String | needed when changing the password or the email
|
|
2060
|
+
contact: "contact_example", # String | change contact information of a profile
|
|
2061
|
+
conf: "conf_example", # String | change config of a profile
|
|
2062
|
+
state: true, # BOOLEAN | state of the profile
|
|
2063
|
+
lang: "lang_example", # String | change lang of the profile
|
|
2064
|
+
expand: "expand_example" # String |
|
|
2065
|
+
}
|
|
2066
|
+
|
|
2067
|
+
begin
|
|
2068
|
+
#Change settings of the profile.
|
|
2069
|
+
result = api_instance.users_id_user_profiles_me_put(id_user, opts)
|
|
2070
|
+
p result
|
|
2071
|
+
rescue BudgeaClient::ApiError => e
|
|
2072
|
+
puts "Exception when calling PFMApi->users_id_user_profiles_me_put: #{e}"
|
|
2073
|
+
end
|
|
2074
|
+
```
|
|
2075
|
+
|
|
2076
|
+
### Parameters
|
|
2077
|
+
|
|
2078
|
+
Name | Type | Description | Notes
|
|
2079
|
+
------------- | ------------- | ------------- | -------------
|
|
2080
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2081
|
+
**email** | **String**| change email of profile | [optional]
|
|
2082
|
+
**password** | **String**| change password of profile | [optional]
|
|
2083
|
+
**current_password** | **String**| needed when changing the password or the email | [optional]
|
|
2084
|
+
**contact** | **String**| change contact information of a profile | [optional]
|
|
2085
|
+
**conf** | **String**| change config of a profile | [optional]
|
|
2086
|
+
**state** | **BOOLEAN**| state of the profile | [optional]
|
|
2087
|
+
**lang** | **String**| change lang of the profile | [optional]
|
|
2088
|
+
**expand** | **String**| | [optional]
|
|
2089
|
+
|
|
2090
|
+
### Return type
|
|
2091
|
+
|
|
2092
|
+
[**Profile**](Profile.md)
|
|
2093
|
+
|
|
2094
|
+
### Authorization
|
|
2095
|
+
|
|
2096
|
+
No authorization required
|
|
2097
|
+
|
|
2098
|
+
### HTTP request headers
|
|
2099
|
+
|
|
2100
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2101
|
+
- **Accept**: application/json
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
# **users_id_user_resume_get**
|
|
2106
|
+
> Object users_id_user_resume_get(id_user)
|
|
2107
|
+
|
|
2108
|
+
Get synthesis configuration of a specific user
|
|
2109
|
+
|
|
2110
|
+
<br><br>
|
|
2111
|
+
|
|
2112
|
+
### Example
|
|
2113
|
+
```ruby
|
|
2114
|
+
# load the gem
|
|
2115
|
+
require 'budgea_client'
|
|
2116
|
+
|
|
2117
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
2118
|
+
|
|
2119
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
begin
|
|
2123
|
+
#Get synthesis configuration of a specific user
|
|
2124
|
+
result = api_instance.users_id_user_resume_get(id_user)
|
|
2125
|
+
p result
|
|
2126
|
+
rescue BudgeaClient::ApiError => e
|
|
2127
|
+
puts "Exception when calling PFMApi->users_id_user_resume_get: #{e}"
|
|
2128
|
+
end
|
|
2129
|
+
```
|
|
2130
|
+
|
|
2131
|
+
### Parameters
|
|
2132
|
+
|
|
2133
|
+
Name | Type | Description | Notes
|
|
2134
|
+
------------- | ------------- | ------------- | -------------
|
|
2135
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2136
|
+
|
|
2137
|
+
### Return type
|
|
2138
|
+
|
|
2139
|
+
**Object**
|
|
2140
|
+
|
|
2141
|
+
### Authorization
|
|
2142
|
+
|
|
2143
|
+
No authorization required
|
|
2144
|
+
|
|
2145
|
+
### HTTP request headers
|
|
2146
|
+
|
|
2147
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2148
|
+
- **Accept**: application/json
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
# **users_id_user_resume_post**
|
|
2153
|
+
> Object users_id_user_resume_post(id_user, opts)
|
|
2154
|
+
|
|
2155
|
+
Update synthesis configuration
|
|
2156
|
+
|
|
2157
|
+
<br><br>
|
|
2158
|
+
|
|
2159
|
+
### Example
|
|
2160
|
+
```ruby
|
|
2161
|
+
# load the gem
|
|
2162
|
+
require 'budgea_client'
|
|
2163
|
+
|
|
2164
|
+
api_instance = BudgeaClient::PFMApi.new
|
|
2165
|
+
|
|
2166
|
+
id_user = "id_user_example" # String | Hint: you can use 'me' or 'all'
|
|
2167
|
+
|
|
2168
|
+
opts = {
|
|
2169
|
+
resume_enabled: true, # BOOLEAN | whether the synthesis is activated or not
|
|
2170
|
+
resume_frequency: 56 # Integer | frequency of the synthesis given in days
|
|
2171
|
+
}
|
|
2172
|
+
|
|
2173
|
+
begin
|
|
2174
|
+
#Update synthesis configuration
|
|
2175
|
+
result = api_instance.users_id_user_resume_post(id_user, opts)
|
|
2176
|
+
p result
|
|
2177
|
+
rescue BudgeaClient::ApiError => e
|
|
2178
|
+
puts "Exception when calling PFMApi->users_id_user_resume_post: #{e}"
|
|
2179
|
+
end
|
|
2180
|
+
```
|
|
2181
|
+
|
|
2182
|
+
### Parameters
|
|
2183
|
+
|
|
2184
|
+
Name | Type | Description | Notes
|
|
2185
|
+
------------- | ------------- | ------------- | -------------
|
|
2186
|
+
**id_user** | **String**| Hint: you can use 'me' or 'all' |
|
|
2187
|
+
**resume_enabled** | **BOOLEAN**| whether the synthesis is activated or not | [optional]
|
|
2188
|
+
**resume_frequency** | **Integer**| frequency of the synthesis given in days | [optional]
|
|
2189
|
+
|
|
2190
|
+
### Return type
|
|
2191
|
+
|
|
2192
|
+
**Object**
|
|
2193
|
+
|
|
2194
|
+
### Authorization
|
|
2195
|
+
|
|
2196
|
+
No authorization required
|
|
2197
|
+
|
|
2198
|
+
### HTTP request headers
|
|
2199
|
+
|
|
2200
|
+
- **Content-Type**: application/json, multipart/form-data
|
|
2201
|
+
- **Accept**: application/json
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|