budgea_client 1.3.6 → 1.3.9

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.
Files changed (40) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +0 -5
  3. data/Gemfile.lock +3 -23
  4. data/README.md +14 -1
  5. data/budgea_openapi.json +12 -0
  6. data/config.json +2 -1
  7. data/docs/AdministrationApi.md +144 -18
  8. data/docs/AuthenticationApi.md +64 -8
  9. data/docs/BanksApi.md +896 -112
  10. data/docs/ConnectionsApi.md +128 -16
  11. data/docs/DocumentsApi.md +608 -76
  12. data/docs/OCRApi.md +16 -2
  13. data/docs/OIDCApi.md +24 -3
  14. data/docs/PFMApi.md +312 -39
  15. data/docs/ProvidersApi.md +864 -108
  16. data/docs/RecipientsApi.md +32 -4
  17. data/docs/TermsApi.md +32 -4
  18. data/docs/TransfersApi.md +320 -40
  19. data/docs/UsersManagementApi.md +96 -12
  20. data/docs/WealthApi.md +112 -14
  21. data/lib/budgea_client/api/administration_api.rb +18 -18
  22. data/lib/budgea_client/api/authentication_api.rb +8 -8
  23. data/lib/budgea_client/api/banks_api.rb +112 -112
  24. data/lib/budgea_client/api/connections_api.rb +16 -16
  25. data/lib/budgea_client/api/documents_api.rb +76 -76
  26. data/lib/budgea_client/api/ocr_api.rb +2 -2
  27. data/lib/budgea_client/api/oidc_api.rb +3 -3
  28. data/lib/budgea_client/api/pfm_api.rb +39 -39
  29. data/lib/budgea_client/api/providers_api.rb +108 -108
  30. data/lib/budgea_client/api/recipients_api.rb +4 -4
  31. data/lib/budgea_client/api/terms_api.rb +4 -4
  32. data/lib/budgea_client/api/transfers_api.rb +40 -40
  33. data/lib/budgea_client/api/users_management_api.rb +12 -12
  34. data/lib/budgea_client/api/wealth_api.rb +14 -14
  35. data/lib/budgea_client/api_client.rb +1 -0
  36. data/lib/budgea_client/configuration.rb +7 -0
  37. data/lib/budgea_client/version.rb +1 -1
  38. metadata +2 -4
  39. data/pkg/budgea_client-1.3.5.gem +0 -0
  40. data/pkg/budgea_client-1.3.6.gem +0 -0
data/docs/OCRApi.md CHANGED
@@ -19,6 +19,13 @@ Post an image and apply OCR on it to obtain found meta-data.<br><br>
19
19
  ```ruby
20
20
  # load the gem
21
21
  require 'budgea_client'
22
+ # setup authorization
23
+ BudgeaClient.configure do |config|
24
+ # Configure API key authorization: api_key
25
+ config.api_key['Authorization'] = 'YOUR API KEY'
26
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
27
+ #config.api_key_prefix['Authorization'] = 'Bearer'
28
+ end
22
29
 
23
30
  api_instance = BudgeaClient::OCRApi.new
24
31
 
@@ -51,7 +58,7 @@ nil (empty response body)
51
58
 
52
59
  ### Authorization
53
60
 
54
- No authorization required
61
+ [api_key](../README.md#api_key)
55
62
 
56
63
  ### HTTP request headers
57
64
 
@@ -71,6 +78,13 @@ Post an image and apply OCR on it to obtain found meta-data.<br><br>
71
78
  ```ruby
72
79
  # load the gem
73
80
  require 'budgea_client'
81
+ # setup authorization
82
+ BudgeaClient.configure do |config|
83
+ # Configure API key authorization: api_key
84
+ config.api_key['Authorization'] = 'YOUR API KEY'
85
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
86
+ #config.api_key_prefix['Authorization'] = 'Bearer'
87
+ end
74
88
 
75
89
  api_instance = BudgeaClient::OCRApi.new
76
90
 
@@ -106,7 +120,7 @@ nil (empty response body)
106
120
 
107
121
  ### Authorization
108
122
 
109
- No authorization required
123
+ [api_key](../README.md#api_key)
110
124
 
111
125
  ### HTTP request headers
112
126
 
data/docs/OIDCApi.md CHANGED
@@ -20,6 +20,13 @@ Delete the supplied authorized redirect uri
20
20
  ```ruby
21
21
  # load the gem
22
22
  require 'budgea_client'
23
+ # setup authorization
24
+ BudgeaClient.configure do |config|
25
+ # Configure API key authorization: api_key
26
+ config.api_key['Authorization'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ #config.api_key_prefix['Authorization'] = 'Bearer'
29
+ end
23
30
 
24
31
  api_instance = BudgeaClient::OIDCApi.new
25
32
 
@@ -51,7 +58,7 @@ Name | Type | Description | Notes
51
58
 
52
59
  ### Authorization
53
60
 
54
- No authorization required
61
+ [api_key](../README.md#api_key)
55
62
 
56
63
  ### HTTP request headers
57
64
 
@@ -71,6 +78,13 @@ Edit the uri for the supplied authorized redirect uri.<br><br>
71
78
  ```ruby
72
79
  # load the gem
73
80
  require 'budgea_client'
81
+ # setup authorization
82
+ BudgeaClient.configure do |config|
83
+ # Configure API key authorization: api_key
84
+ config.api_key['Authorization'] = 'YOUR API KEY'
85
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
86
+ #config.api_key_prefix['Authorization'] = 'Bearer'
87
+ end
74
88
 
75
89
  api_instance = BudgeaClient::OIDCApi.new
76
90
 
@@ -105,7 +119,7 @@ Name | Type | Description | Notes
105
119
 
106
120
  ### Authorization
107
121
 
108
- No authorization required
122
+ [api_key](../README.md#api_key)
109
123
 
110
124
  ### HTTP request headers
111
125
 
@@ -125,6 +139,13 @@ It requires the authorized redirect uri to be created<br><br>
125
139
  ```ruby
126
140
  # load the gem
127
141
  require 'budgea_client'
142
+ # setup authorization
143
+ BudgeaClient.configure do |config|
144
+ # Configure API key authorization: api_key
145
+ config.api_key['Authorization'] = 'YOUR API KEY'
146
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
147
+ #config.api_key_prefix['Authorization'] = 'Bearer'
148
+ end
128
149
 
129
150
  api_instance = BudgeaClient::OIDCApi.new
130
151
 
@@ -156,7 +177,7 @@ Name | Type | Description | Notes
156
177
 
157
178
  ### Authorization
158
179
 
159
- No authorization required
180
+ [api_key](../README.md#api_key)
160
181
 
161
182
  ### HTTP request headers
162
183
 
data/docs/PFMApi.md CHANGED
@@ -56,6 +56,13 @@ Confirm new email address
56
56
  ```ruby
57
57
  # load the gem
58
58
  require 'budgea_client'
59
+ # setup authorization
60
+ BudgeaClient.configure do |config|
61
+ # Configure API key authorization: api_key
62
+ config.api_key['Authorization'] = 'YOUR API KEY'
63
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
64
+ #config.api_key_prefix['Authorization'] = 'Bearer'
65
+ end
59
66
 
60
67
  api_instance = BudgeaClient::PFMApi.new
61
68
 
@@ -82,7 +89,7 @@ nil (empty response body)
82
89
 
83
90
  ### Authorization
84
91
 
85
- No authorization required
92
+ [api_key](../README.md#api_key)
86
93
 
87
94
  ### HTTP request headers
88
95
 
@@ -102,6 +109,13 @@ Confirm email address
102
109
  ```ruby
103
110
  # load the gem
104
111
  require 'budgea_client'
112
+ # setup authorization
113
+ BudgeaClient.configure do |config|
114
+ # Configure API key authorization: api_key
115
+ config.api_key['Authorization'] = 'YOUR API KEY'
116
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
117
+ #config.api_key_prefix['Authorization'] = 'Bearer'
118
+ end
105
119
 
106
120
  api_instance = BudgeaClient::PFMApi.new
107
121
 
@@ -132,7 +146,7 @@ Name | Type | Description | Notes
132
146
 
133
147
  ### Authorization
134
148
 
135
- No authorization required
149
+ [api_key](../README.md#api_key)
136
150
 
137
151
  ### HTTP request headers
138
152
 
@@ -152,6 +166,13 @@ Login with credentials and set as cookie
152
166
  ```ruby
153
167
  # load the gem
154
168
  require 'budgea_client'
169
+ # setup authorization
170
+ BudgeaClient.configure do |config|
171
+ # Configure API key authorization: api_key
172
+ config.api_key['Authorization'] = 'YOUR API KEY'
173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
174
+ #config.api_key_prefix['Authorization'] = 'Bearer'
175
+ end
155
176
 
156
177
  api_instance = BudgeaClient::PFMApi.new
157
178
 
@@ -188,7 +209,7 @@ nil (empty response body)
188
209
 
189
210
  ### Authorization
190
211
 
191
- No authorization required
212
+ [api_key](../README.md#api_key)
192
213
 
193
214
  ### HTTP request headers
194
215
 
@@ -208,6 +229,13 @@ Create a new user with his email address and password.<br><br><br><br>
208
229
  ```ruby
209
230
  # load the gem
210
231
  require 'budgea_client'
232
+ # setup authorization
233
+ BudgeaClient.configure do |config|
234
+ # Configure API key authorization: api_key
235
+ config.api_key['Authorization'] = 'YOUR API KEY'
236
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
237
+ #config.api_key_prefix['Authorization'] = 'Bearer'
238
+ end
211
239
 
212
240
  api_instance = BudgeaClient::PFMApi.new
213
241
 
@@ -247,7 +275,7 @@ Name | Type | Description | Notes
247
275
 
248
276
  ### Authorization
249
277
 
250
- No authorization required
278
+ [api_key](../README.md#api_key)
251
279
 
252
280
  ### HTTP request headers
253
281
 
@@ -267,6 +295,13 @@ This endpoint removes the token in use.<br><br>
267
295
  ```ruby
268
296
  # load the gem
269
297
  require 'budgea_client'
298
+ # setup authorization
299
+ BudgeaClient.configure do |config|
300
+ # Configure API key authorization: api_key
301
+ config.api_key['Authorization'] = 'YOUR API KEY'
302
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
303
+ #config.api_key_prefix['Authorization'] = 'Bearer'
304
+ end
270
305
 
271
306
  api_instance = BudgeaClient::PFMApi.new
272
307
 
@@ -287,7 +322,7 @@ nil (empty response body)
287
322
 
288
323
  ### Authorization
289
324
 
290
- No authorization required
325
+ [api_key](../README.md#api_key)
291
326
 
292
327
  ### HTTP request headers
293
328
 
@@ -307,6 +342,13 @@ Request a new user token by giving an username and a password.<br><br><br><br>
307
342
  ```ruby
308
343
  # load the gem
309
344
  require 'budgea_client'
345
+ # setup authorization
346
+ BudgeaClient.configure do |config|
347
+ # Configure API key authorization: api_key
348
+ config.api_key['Authorization'] = 'YOUR API KEY'
349
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
350
+ #config.api_key_prefix['Authorization'] = 'Bearer'
351
+ end
310
352
 
311
353
  api_instance = BudgeaClient::PFMApi.new
312
354
 
@@ -344,7 +386,7 @@ Name | Type | Description | Notes
344
386
 
345
387
  ### Authorization
346
388
 
347
- No authorization required
389
+ [api_key](../README.md#api_key)
348
390
 
349
391
  ### HTTP request headers
350
392
 
@@ -364,6 +406,13 @@ deletes all connections of the user given his hash<br><br>
364
406
  ```ruby
365
407
  # load the gem
366
408
  require 'budgea_client'
409
+ # setup authorization
410
+ BudgeaClient.configure do |config|
411
+ # Configure API key authorization: api_key
412
+ config.api_key['Authorization'] = 'YOUR API KEY'
413
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
414
+ #config.api_key_prefix['Authorization'] = 'Bearer'
415
+ end
367
416
 
368
417
  api_instance = BudgeaClient::PFMApi.new
369
418
 
@@ -384,7 +433,7 @@ nil (empty response body)
384
433
 
385
434
  ### Authorization
386
435
 
387
- No authorization required
436
+ [api_key](../README.md#api_key)
388
437
 
389
438
  ### HTTP request headers
390
439
 
@@ -404,6 +453,13 @@ Get balance (income/outcome/balance) of enabled accounts for the given period.<b
404
453
  ```ruby
405
454
  # load the gem
406
455
  require 'budgea_client'
456
+ # setup authorization
457
+ BudgeaClient.configure do |config|
458
+ # Configure API key authorization: api_key
459
+ config.api_key['Authorization'] = 'YOUR API KEY'
460
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
461
+ #config.api_key_prefix['Authorization'] = 'Bearer'
462
+ end
407
463
 
408
464
  api_instance = BudgeaClient::PFMApi.new
409
465
 
@@ -441,7 +497,7 @@ nil (empty response body)
441
497
 
442
498
  ### Authorization
443
499
 
444
- No authorization required
500
+ [api_key](../README.md#api_key)
445
501
 
446
502
  ### HTTP request headers
447
503
 
@@ -461,6 +517,13 @@ Get a list of configurated alerts
461
517
  ```ruby
462
518
  # load the gem
463
519
  require 'budgea_client'
520
+ # setup authorization
521
+ BudgeaClient.configure do |config|
522
+ # Configure API key authorization: api_key
523
+ config.api_key['Authorization'] = 'YOUR API KEY'
524
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
525
+ #config.api_key_prefix['Authorization'] = 'Bearer'
526
+ end
464
527
 
465
528
  api_instance = BudgeaClient::PFMApi.new
466
529
 
@@ -495,7 +558,7 @@ Name | Type | Description | Notes
495
558
 
496
559
  ### Authorization
497
560
 
498
- No authorization required
561
+ [api_key](../README.md#api_key)
499
562
 
500
563
  ### HTTP request headers
501
564
 
@@ -515,6 +578,13 @@ Delete an alert on transactions or investemens
515
578
  ```ruby
516
579
  # load the gem
517
580
  require 'budgea_client'
581
+ # setup authorization
582
+ BudgeaClient.configure do |config|
583
+ # Configure API key authorization: api_key
584
+ config.api_key['Authorization'] = 'YOUR API KEY'
585
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
586
+ #config.api_key_prefix['Authorization'] = 'Bearer'
587
+ end
518
588
 
519
589
  api_instance = BudgeaClient::PFMApi.new
520
590
 
@@ -552,7 +622,7 @@ Name | Type | Description | Notes
552
622
 
553
623
  ### Authorization
554
624
 
555
- No authorization required
625
+ [api_key](../README.md#api_key)
556
626
 
557
627
  ### HTTP request headers
558
628
 
@@ -572,6 +642,13 @@ Edit an alert on transactions or investemens
572
642
  ```ruby
573
643
  # load the gem
574
644
  require 'budgea_client'
645
+ # setup authorization
646
+ BudgeaClient.configure do |config|
647
+ # Configure API key authorization: api_key
648
+ config.api_key['Authorization'] = 'YOUR API KEY'
649
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
650
+ #config.api_key_prefix['Authorization'] = 'Bearer'
651
+ end
575
652
 
576
653
  api_instance = BudgeaClient::PFMApi.new
577
654
 
@@ -619,7 +696,7 @@ Name | Type | Description | Notes
619
696
 
620
697
  ### Authorization
621
698
 
622
- No authorization required
699
+ [api_key](../README.md#api_key)
623
700
 
624
701
  ### HTTP request headers
625
702
 
@@ -639,6 +716,13 @@ Create an alert on transactions or investemens of a given user
639
716
  ```ruby
640
717
  # load the gem
641
718
  require 'budgea_client'
719
+ # setup authorization
720
+ BudgeaClient.configure do |config|
721
+ # Configure API key authorization: api_key
722
+ config.api_key['Authorization'] = 'YOUR API KEY'
723
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
724
+ #config.api_key_prefix['Authorization'] = 'Bearer'
725
+ end
642
726
 
643
727
  api_instance = BudgeaClient::PFMApi.new
644
728
 
@@ -683,7 +767,7 @@ Name | Type | Description | Notes
683
767
 
684
768
  ### Authorization
685
769
 
686
- No authorization required
770
+ [api_key](../README.md#api_key)
687
771
 
688
772
  ### HTTP request headers
689
773
 
@@ -703,6 +787,13 @@ Get alert configuration of a specific account
703
787
  ```ruby
704
788
  # load the gem
705
789
  require 'budgea_client'
790
+ # setup authorization
791
+ BudgeaClient.configure do |config|
792
+ # Configure API key authorization: api_key
793
+ config.api_key['Authorization'] = 'YOUR API KEY'
794
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
795
+ #config.api_key_prefix['Authorization'] = 'Bearer'
796
+ end
706
797
 
707
798
  api_instance = BudgeaClient::PFMApi.new
708
799
 
@@ -730,7 +821,7 @@ Name | Type | Description | Notes
730
821
 
731
822
  ### Authorization
732
823
 
733
- No authorization required
824
+ [api_key](../README.md#api_key)
734
825
 
735
826
  ### HTTP request headers
736
827
 
@@ -750,6 +841,13 @@ It updates the alert configuration of a specific account<br><br><br><br>
750
841
  ```ruby
751
842
  # load the gem
752
843
  require 'budgea_client'
844
+ # setup authorization
845
+ BudgeaClient.configure do |config|
846
+ # Configure API key authorization: api_key
847
+ config.api_key['Authorization'] = 'YOUR API KEY'
848
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
849
+ #config.api_key_prefix['Authorization'] = 'Bearer'
850
+ end
753
851
 
754
852
  api_instance = BudgeaClient::PFMApi.new
755
853
 
@@ -789,7 +887,7 @@ Name | Type | Description | Notes
789
887
 
790
888
  ### Authorization
791
889
 
792
- No authorization required
890
+ [api_key](../README.md#api_key)
793
891
 
794
892
  ### HTTP request headers
795
893
 
@@ -809,6 +907,13 @@ Get balance (income/outcome/balance) of enabled accounts for the given period.<b
809
907
  ```ruby
810
908
  # load the gem
811
909
  require 'budgea_client'
910
+ # setup authorization
911
+ BudgeaClient.configure do |config|
912
+ # Configure API key authorization: api_key
913
+ config.api_key['Authorization'] = 'YOUR API KEY'
914
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
915
+ #config.api_key_prefix['Authorization'] = 'Bearer'
916
+ end
812
917
 
813
918
  api_instance = BudgeaClient::PFMApi.new
814
919
 
@@ -843,7 +948,7 @@ nil (empty response body)
843
948
 
844
949
  ### Authorization
845
950
 
846
- No authorization required
951
+ [api_key](../README.md#api_key)
847
952
 
848
953
  ### HTTP request headers
849
954
 
@@ -863,6 +968,13 @@ Get balance (income/outcome/balance) of enabled accounts for the given period.<b
863
968
  ```ruby
864
969
  # load the gem
865
970
  require 'budgea_client'
971
+ # setup authorization
972
+ BudgeaClient.configure do |config|
973
+ # Configure API key authorization: api_key
974
+ config.api_key['Authorization'] = 'YOUR API KEY'
975
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
976
+ #config.api_key_prefix['Authorization'] = 'Bearer'
977
+ end
866
978
 
867
979
  api_instance = BudgeaClient::PFMApi.new
868
980
 
@@ -903,7 +1015,7 @@ nil (empty response body)
903
1015
 
904
1016
  ### Authorization
905
1017
 
906
- No authorization required
1018
+ [api_key](../README.md#api_key)
907
1019
 
908
1020
  ### HTTP request headers
909
1021
 
@@ -923,6 +1035,13 @@ Get a list of configurated alerts
923
1035
  ```ruby
924
1036
  # load the gem
925
1037
  require 'budgea_client'
1038
+ # setup authorization
1039
+ BudgeaClient.configure do |config|
1040
+ # Configure API key authorization: api_key
1041
+ config.api_key['Authorization'] = 'YOUR API KEY'
1042
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1043
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1044
+ end
926
1045
 
927
1046
  api_instance = BudgeaClient::PFMApi.new
928
1047
 
@@ -960,7 +1079,7 @@ Name | Type | Description | Notes
960
1079
 
961
1080
  ### Authorization
962
1081
 
963
- No authorization required
1082
+ [api_key](../README.md#api_key)
964
1083
 
965
1084
  ### HTTP request headers
966
1085
 
@@ -980,6 +1099,13 @@ Delete an alert on transactions or investemens
980
1099
  ```ruby
981
1100
  # load the gem
982
1101
  require 'budgea_client'
1102
+ # setup authorization
1103
+ BudgeaClient.configure do |config|
1104
+ # Configure API key authorization: api_key
1105
+ config.api_key['Authorization'] = 'YOUR API KEY'
1106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1107
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1108
+ end
983
1109
 
984
1110
  api_instance = BudgeaClient::PFMApi.new
985
1111
 
@@ -1020,7 +1146,7 @@ Name | Type | Description | Notes
1020
1146
 
1021
1147
  ### Authorization
1022
1148
 
1023
- No authorization required
1149
+ [api_key](../README.md#api_key)
1024
1150
 
1025
1151
  ### HTTP request headers
1026
1152
 
@@ -1040,6 +1166,13 @@ Edit an alert on transactions or investemens
1040
1166
  ```ruby
1041
1167
  # load the gem
1042
1168
  require 'budgea_client'
1169
+ # setup authorization
1170
+ BudgeaClient.configure do |config|
1171
+ # Configure API key authorization: api_key
1172
+ config.api_key['Authorization'] = 'YOUR API KEY'
1173
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1174
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1175
+ end
1043
1176
 
1044
1177
  api_instance = BudgeaClient::PFMApi.new
1045
1178
 
@@ -1090,7 +1223,7 @@ Name | Type | Description | Notes
1090
1223
 
1091
1224
  ### Authorization
1092
1225
 
1093
- No authorization required
1226
+ [api_key](../README.md#api_key)
1094
1227
 
1095
1228
  ### HTTP request headers
1096
1229
 
@@ -1110,6 +1243,13 @@ Create an alert on transactions or investemens of a given user
1110
1243
  ```ruby
1111
1244
  # load the gem
1112
1245
  require 'budgea_client'
1246
+ # setup authorization
1247
+ BudgeaClient.configure do |config|
1248
+ # Configure API key authorization: api_key
1249
+ config.api_key['Authorization'] = 'YOUR API KEY'
1250
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1251
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1252
+ end
1113
1253
 
1114
1254
  api_instance = BudgeaClient::PFMApi.new
1115
1255
 
@@ -1157,7 +1297,7 @@ Name | Type | Description | Notes
1157
1297
 
1158
1298
  ### Authorization
1159
1299
 
1160
- No authorization required
1300
+ [api_key](../README.md#api_key)
1161
1301
 
1162
1302
  ### HTTP request headers
1163
1303
 
@@ -1177,6 +1317,13 @@ Get balance (income/outcome/balance) of enabled accounts for the given period.<b
1177
1317
  ```ruby
1178
1318
  # load the gem
1179
1319
  require 'budgea_client'
1320
+ # setup authorization
1321
+ BudgeaClient.configure do |config|
1322
+ # Configure API key authorization: api_key
1323
+ config.api_key['Authorization'] = 'YOUR API KEY'
1324
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1325
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1326
+ end
1180
1327
 
1181
1328
  api_instance = BudgeaClient::PFMApi.new
1182
1329
 
@@ -1214,7 +1361,7 @@ nil (empty response body)
1214
1361
 
1215
1362
  ### Authorization
1216
1363
 
1217
- No authorization required
1364
+ [api_key](../README.md#api_key)
1218
1365
 
1219
1366
  ### HTTP request headers
1220
1367
 
@@ -1234,6 +1381,13 @@ Get devices
1234
1381
  ```ruby
1235
1382
  # load the gem
1236
1383
  require 'budgea_client'
1384
+ # setup authorization
1385
+ BudgeaClient.configure do |config|
1386
+ # Configure API key authorization: api_key
1387
+ config.api_key['Authorization'] = 'YOUR API KEY'
1388
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1389
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1390
+ end
1237
1391
 
1238
1392
  api_instance = BudgeaClient::PFMApi.new
1239
1393
 
@@ -1265,7 +1419,7 @@ Name | Type | Description | Notes
1265
1419
 
1266
1420
  ### Authorization
1267
1421
 
1268
- No authorization required
1422
+ [api_key](../README.md#api_key)
1269
1423
 
1270
1424
  ### HTTP request headers
1271
1425
 
@@ -1285,6 +1439,13 @@ Delete device.
1285
1439
  ```ruby
1286
1440
  # load the gem
1287
1441
  require 'budgea_client'
1442
+ # setup authorization
1443
+ BudgeaClient.configure do |config|
1444
+ # Configure API key authorization: api_key
1445
+ config.api_key['Authorization'] = 'YOUR API KEY'
1446
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1447
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1448
+ end
1288
1449
 
1289
1450
  api_instance = BudgeaClient::PFMApi.new
1290
1451
 
@@ -1319,7 +1480,7 @@ Name | Type | Description | Notes
1319
1480
 
1320
1481
  ### Authorization
1321
1482
 
1322
- No authorization required
1483
+ [api_key](../README.md#api_key)
1323
1484
 
1324
1485
  ### HTTP request headers
1325
1486
 
@@ -1339,6 +1500,13 @@ Get a device
1339
1500
  ```ruby
1340
1501
  # load the gem
1341
1502
  require 'budgea_client'
1503
+ # setup authorization
1504
+ BudgeaClient.configure do |config|
1505
+ # Configure API key authorization: api_key
1506
+ config.api_key['Authorization'] = 'YOUR API KEY'
1507
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1508
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1509
+ end
1342
1510
 
1343
1511
  api_instance = BudgeaClient::PFMApi.new
1344
1512
 
@@ -1373,7 +1541,7 @@ Name | Type | Description | Notes
1373
1541
 
1374
1542
  ### Authorization
1375
1543
 
1376
- No authorization required
1544
+ [api_key](../README.md#api_key)
1377
1545
 
1378
1546
  ### HTTP request headers
1379
1547
 
@@ -1393,6 +1561,13 @@ Update attributes of the device.
1393
1561
  ```ruby
1394
1562
  # load the gem
1395
1563
  require 'budgea_client'
1564
+ # setup authorization
1565
+ BudgeaClient.configure do |config|
1566
+ # Configure API key authorization: api_key
1567
+ config.api_key['Authorization'] = 'YOUR API KEY'
1568
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1569
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1570
+ end
1396
1571
 
1397
1572
  api_instance = BudgeaClient::PFMApi.new
1398
1573
 
@@ -1435,7 +1610,7 @@ Name | Type | Description | Notes
1435
1610
 
1436
1611
  ### Authorization
1437
1612
 
1438
- No authorization required
1613
+ [api_key](../README.md#api_key)
1439
1614
 
1440
1615
  ### HTTP request headers
1441
1616
 
@@ -1455,6 +1630,13 @@ Create a device linked to specified token.
1455
1630
  ```ruby
1456
1631
  # load the gem
1457
1632
  require 'budgea_client'
1633
+ # setup authorization
1634
+ BudgeaClient.configure do |config|
1635
+ # Configure API key authorization: api_key
1636
+ config.api_key['Authorization'] = 'YOUR API KEY'
1637
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1638
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1639
+ end
1458
1640
 
1459
1641
  api_instance = BudgeaClient::PFMApi.new
1460
1642
 
@@ -1494,7 +1676,7 @@ Name | Type | Description | Notes
1494
1676
 
1495
1677
  ### Authorization
1496
1678
 
1497
- No authorization required
1679
+ [api_key](../README.md#api_key)
1498
1680
 
1499
1681
  ### HTTP request headers
1500
1682
 
@@ -1514,6 +1696,13 @@ Get forecast
1514
1696
  ```ruby
1515
1697
  # load the gem
1516
1698
  require 'budgea_client'
1699
+ # setup authorization
1700
+ BudgeaClient.configure do |config|
1701
+ # Configure API key authorization: api_key
1702
+ config.api_key['Authorization'] = 'YOUR API KEY'
1703
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1704
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1705
+ end
1517
1706
 
1518
1707
  api_instance = BudgeaClient::PFMApi.new
1519
1708
 
@@ -1540,7 +1729,7 @@ nil (empty response body)
1540
1729
 
1541
1730
  ### Authorization
1542
1731
 
1543
- No authorization required
1732
+ [api_key](../README.md#api_key)
1544
1733
 
1545
1734
  ### HTTP request headers
1546
1735
 
@@ -1560,6 +1749,13 @@ Get a user
1560
1749
  ```ruby
1561
1750
  # load the gem
1562
1751
  require 'budgea_client'
1752
+ # setup authorization
1753
+ BudgeaClient.configure do |config|
1754
+ # Configure API key authorization: api_key
1755
+ config.api_key['Authorization'] = 'YOUR API KEY'
1756
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1757
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1758
+ end
1563
1759
 
1564
1760
  api_instance = BudgeaClient::PFMApi.new
1565
1761
 
@@ -1591,7 +1787,7 @@ Name | Type | Description | Notes
1591
1787
 
1592
1788
  ### Authorization
1593
1789
 
1594
- No authorization required
1790
+ [api_key](../README.md#api_key)
1595
1791
 
1596
1792
  ### HTTP request headers
1597
1793
 
@@ -1611,6 +1807,13 @@ Get a list of configurated alerts
1611
1807
  ```ruby
1612
1808
  # load the gem
1613
1809
  require 'budgea_client'
1810
+ # setup authorization
1811
+ BudgeaClient.configure do |config|
1812
+ # Configure API key authorization: api_key
1813
+ config.api_key['Authorization'] = 'YOUR API KEY'
1814
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1815
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1816
+ end
1614
1817
 
1615
1818
  api_instance = BudgeaClient::PFMApi.new
1616
1819
 
@@ -1642,7 +1845,7 @@ Name | Type | Description | Notes
1642
1845
 
1643
1846
  ### Authorization
1644
1847
 
1645
- No authorization required
1848
+ [api_key](../README.md#api_key)
1646
1849
 
1647
1850
  ### HTTP request headers
1648
1851
 
@@ -1662,6 +1865,13 @@ Delete an alert on transactions or investemens
1662
1865
  ```ruby
1663
1866
  # load the gem
1664
1867
  require 'budgea_client'
1868
+ # setup authorization
1869
+ BudgeaClient.configure do |config|
1870
+ # Configure API key authorization: api_key
1871
+ config.api_key['Authorization'] = 'YOUR API KEY'
1872
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1873
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1874
+ end
1665
1875
 
1666
1876
  api_instance = BudgeaClient::PFMApi.new
1667
1877
 
@@ -1696,7 +1906,7 @@ Name | Type | Description | Notes
1696
1906
 
1697
1907
  ### Authorization
1698
1908
 
1699
- No authorization required
1909
+ [api_key](../README.md#api_key)
1700
1910
 
1701
1911
  ### HTTP request headers
1702
1912
 
@@ -1716,6 +1926,13 @@ Edit an alert on transactions or investemens
1716
1926
  ```ruby
1717
1927
  # load the gem
1718
1928
  require 'budgea_client'
1929
+ # setup authorization
1930
+ BudgeaClient.configure do |config|
1931
+ # Configure API key authorization: api_key
1932
+ config.api_key['Authorization'] = 'YOUR API KEY'
1933
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1934
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1935
+ end
1719
1936
 
1720
1937
  api_instance = BudgeaClient::PFMApi.new
1721
1938
 
@@ -1760,7 +1977,7 @@ Name | Type | Description | Notes
1760
1977
 
1761
1978
  ### Authorization
1762
1979
 
1763
- No authorization required
1980
+ [api_key](../README.md#api_key)
1764
1981
 
1765
1982
  ### HTTP request headers
1766
1983
 
@@ -1780,6 +1997,13 @@ Create an alert on transactions or investemens of a given user
1780
1997
  ```ruby
1781
1998
  # load the gem
1782
1999
  require 'budgea_client'
2000
+ # setup authorization
2001
+ BudgeaClient.configure do |config|
2002
+ # Configure API key authorization: api_key
2003
+ config.api_key['Authorization'] = 'YOUR API KEY'
2004
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2005
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2006
+ end
1783
2007
 
1784
2008
  api_instance = BudgeaClient::PFMApi.new
1785
2009
 
@@ -1821,7 +2045,7 @@ Name | Type | Description | Notes
1821
2045
 
1822
2046
  ### Authorization
1823
2047
 
1824
- No authorization required
2048
+ [api_key](../README.md#api_key)
1825
2049
 
1826
2050
  ### HTTP request headers
1827
2051
 
@@ -1841,6 +2065,13 @@ Get profiles
1841
2065
  ```ruby
1842
2066
  # load the gem
1843
2067
  require 'budgea_client'
2068
+ # setup authorization
2069
+ BudgeaClient.configure do |config|
2070
+ # Configure API key authorization: api_key
2071
+ config.api_key['Authorization'] = 'YOUR API KEY'
2072
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2073
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2074
+ end
1844
2075
 
1845
2076
  api_instance = BudgeaClient::PFMApi.new
1846
2077
 
@@ -1872,7 +2103,7 @@ Name | Type | Description | Notes
1872
2103
 
1873
2104
  ### Authorization
1874
2105
 
1875
- No authorization required
2106
+ [api_key](../README.md#api_key)
1876
2107
 
1877
2108
  ### HTTP request headers
1878
2109
 
@@ -1892,6 +2123,13 @@ Get a profile
1892
2123
  ```ruby
1893
2124
  # load the gem
1894
2125
  require 'budgea_client'
2126
+ # setup authorization
2127
+ BudgeaClient.configure do |config|
2128
+ # Configure API key authorization: api_key
2129
+ config.api_key['Authorization'] = 'YOUR API KEY'
2130
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2131
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2132
+ end
1895
2133
 
1896
2134
  api_instance = BudgeaClient::PFMApi.new
1897
2135
 
@@ -1926,7 +2164,7 @@ Name | Type | Description | Notes
1926
2164
 
1927
2165
  ### Authorization
1928
2166
 
1929
- No authorization required
2167
+ [api_key](../README.md#api_key)
1930
2168
 
1931
2169
  ### HTTP request headers
1932
2170
 
@@ -1946,6 +2184,13 @@ Get the main profile
1946
2184
  ```ruby
1947
2185
  # load the gem
1948
2186
  require 'budgea_client'
2187
+ # setup authorization
2188
+ BudgeaClient.configure do |config|
2189
+ # Configure API key authorization: api_key
2190
+ config.api_key['Authorization'] = 'YOUR API KEY'
2191
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2192
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2193
+ end
1949
2194
 
1950
2195
  api_instance = BudgeaClient::PFMApi.new
1951
2196
 
@@ -1977,7 +2222,7 @@ Name | Type | Description | Notes
1977
2222
 
1978
2223
  ### Authorization
1979
2224
 
1980
- No authorization required
2225
+ [api_key](../README.md#api_key)
1981
2226
 
1982
2227
  ### HTTP request headers
1983
2228
 
@@ -1997,6 +2242,13 @@ Get my profile
1997
2242
  ```ruby
1998
2243
  # load the gem
1999
2244
  require 'budgea_client'
2245
+ # setup authorization
2246
+ BudgeaClient.configure do |config|
2247
+ # Configure API key authorization: api_key
2248
+ config.api_key['Authorization'] = 'YOUR API KEY'
2249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2250
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2251
+ end
2000
2252
 
2001
2253
  api_instance = BudgeaClient::PFMApi.new
2002
2254
 
@@ -2028,7 +2280,7 @@ Name | Type | Description | Notes
2028
2280
 
2029
2281
  ### Authorization
2030
2282
 
2031
- No authorization required
2283
+ [api_key](../README.md#api_key)
2032
2284
 
2033
2285
  ### HTTP request headers
2034
2286
 
@@ -2048,6 +2300,13 @@ Change settings of the profile.
2048
2300
  ```ruby
2049
2301
  # load the gem
2050
2302
  require 'budgea_client'
2303
+ # setup authorization
2304
+ BudgeaClient.configure do |config|
2305
+ # Configure API key authorization: api_key
2306
+ config.api_key['Authorization'] = 'YOUR API KEY'
2307
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2308
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2309
+ end
2051
2310
 
2052
2311
  api_instance = BudgeaClient::PFMApi.new
2053
2312
 
@@ -2093,7 +2352,7 @@ Name | Type | Description | Notes
2093
2352
 
2094
2353
  ### Authorization
2095
2354
 
2096
- No authorization required
2355
+ [api_key](../README.md#api_key)
2097
2356
 
2098
2357
  ### HTTP request headers
2099
2358
 
@@ -2113,6 +2372,13 @@ Get synthesis configuration of a specific user
2113
2372
  ```ruby
2114
2373
  # load the gem
2115
2374
  require 'budgea_client'
2375
+ # setup authorization
2376
+ BudgeaClient.configure do |config|
2377
+ # Configure API key authorization: api_key
2378
+ config.api_key['Authorization'] = 'YOUR API KEY'
2379
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2380
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2381
+ end
2116
2382
 
2117
2383
  api_instance = BudgeaClient::PFMApi.new
2118
2384
 
@@ -2140,7 +2406,7 @@ Name | Type | Description | Notes
2140
2406
 
2141
2407
  ### Authorization
2142
2408
 
2143
- No authorization required
2409
+ [api_key](../README.md#api_key)
2144
2410
 
2145
2411
  ### HTTP request headers
2146
2412
 
@@ -2160,6 +2426,13 @@ Update synthesis configuration
2160
2426
  ```ruby
2161
2427
  # load the gem
2162
2428
  require 'budgea_client'
2429
+ # setup authorization
2430
+ BudgeaClient.configure do |config|
2431
+ # Configure API key authorization: api_key
2432
+ config.api_key['Authorization'] = 'YOUR API KEY'
2433
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2434
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2435
+ end
2163
2436
 
2164
2437
  api_instance = BudgeaClient::PFMApi.new
2165
2438
 
@@ -2193,7 +2466,7 @@ Name | Type | Description | Notes
2193
2466
 
2194
2467
  ### Authorization
2195
2468
 
2196
- No authorization required
2469
+ [api_key](../README.md#api_key)
2197
2470
 
2198
2471
  ### HTTP request headers
2199
2472