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
@@ -29,6 +29,13 @@ deletes all connections of the user given his hash<br><br>
29
29
  ```ruby
30
30
  # load the gem
31
31
  require 'budgea_client'
32
+ # setup authorization
33
+ BudgeaClient.configure do |config|
34
+ # Configure API key authorization: api_key
35
+ config.api_key['Authorization'] = 'YOUR API KEY'
36
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
37
+ #config.api_key_prefix['Authorization'] = 'Bearer'
38
+ end
32
39
 
33
40
  api_instance = BudgeaClient::UsersManagementApi.new
34
41
 
@@ -49,7 +56,7 @@ nil (empty response body)
49
56
 
50
57
  ### Authorization
51
58
 
52
- No authorization required
59
+ [api_key](../README.md#api_key)
53
60
 
54
61
  ### HTTP request headers
55
62
 
@@ -69,6 +76,13 @@ Get users
69
76
  ```ruby
70
77
  # load the gem
71
78
  require 'budgea_client'
79
+ # setup authorization
80
+ BudgeaClient.configure do |config|
81
+ # Configure API key authorization: api_key
82
+ config.api_key['Authorization'] = 'YOUR API KEY'
83
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
84
+ #config.api_key_prefix['Authorization'] = 'Bearer'
85
+ end
72
86
 
73
87
  api_instance = BudgeaClient::UsersManagementApi.new
74
88
 
@@ -99,7 +113,7 @@ Name | Type | Description | Notes
99
113
 
100
114
  ### Authorization
101
115
 
102
- No authorization required
116
+ [api_key](../README.md#api_key)
103
117
 
104
118
  ### HTTP request headers
105
119
 
@@ -119,6 +133,13 @@ Delete the given user configurations. deletions on keys prefixed by 'biapi.' (ex
119
133
  ```ruby
120
134
  # load the gem
121
135
  require 'budgea_client'
136
+ # setup authorization
137
+ BudgeaClient.configure do |config|
138
+ # Configure API key authorization: api_key
139
+ config.api_key['Authorization'] = 'YOUR API KEY'
140
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
141
+ #config.api_key_prefix['Authorization'] = 'Bearer'
142
+ end
122
143
 
123
144
  api_instance = BudgeaClient::UsersManagementApi.new
124
145
 
@@ -145,7 +166,7 @@ nil (empty response body)
145
166
 
146
167
  ### Authorization
147
168
 
148
- No authorization required
169
+ [api_key](../README.md#api_key)
149
170
 
150
171
  ### HTTP request headers
151
172
 
@@ -165,6 +186,13 @@ Get configuration of a user.
165
186
  ```ruby
166
187
  # load the gem
167
188
  require 'budgea_client'
189
+ # setup authorization
190
+ BudgeaClient.configure do |config|
191
+ # Configure API key authorization: api_key
192
+ config.api_key['Authorization'] = 'YOUR API KEY'
193
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
194
+ #config.api_key_prefix['Authorization'] = 'Bearer'
195
+ end
168
196
 
169
197
  api_instance = BudgeaClient::UsersManagementApi.new
170
198
 
@@ -192,7 +220,7 @@ Name | Type | Description | Notes
192
220
 
193
221
  ### Authorization
194
222
 
195
- No authorization required
223
+ [api_key](../README.md#api_key)
196
224
 
197
225
  ### HTTP request headers
198
226
 
@@ -212,6 +240,13 @@ Change configuration of a user. modifications on keys prefixed by 'biapi.' (exce
212
240
  ```ruby
213
241
  # load the gem
214
242
  require 'budgea_client'
243
+ # setup authorization
244
+ BudgeaClient.configure do |config|
245
+ # Configure API key authorization: api_key
246
+ config.api_key['Authorization'] = 'YOUR API KEY'
247
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
248
+ #config.api_key_prefix['Authorization'] = 'Bearer'
249
+ end
215
250
 
216
251
  api_instance = BudgeaClient::UsersManagementApi.new
217
252
 
@@ -238,7 +273,7 @@ nil (empty response body)
238
273
 
239
274
  ### Authorization
240
275
 
241
- No authorization required
276
+ [api_key](../README.md#api_key)
242
277
 
243
278
  ### HTTP request headers
244
279
 
@@ -258,6 +293,13 @@ This endpoint deletes the user.<br><br>
258
293
  ```ruby
259
294
  # load the gem
260
295
  require 'budgea_client'
296
+ # setup authorization
297
+ BudgeaClient.configure do |config|
298
+ # Configure API key authorization: api_key
299
+ config.api_key['Authorization'] = 'YOUR API KEY'
300
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
301
+ #config.api_key_prefix['Authorization'] = 'Bearer'
302
+ end
261
303
 
262
304
  api_instance = BudgeaClient::UsersManagementApi.new
263
305
 
@@ -289,7 +331,7 @@ Name | Type | Description | Notes
289
331
 
290
332
  ### Authorization
291
333
 
292
- No authorization required
334
+ [api_key](../README.md#api_key)
293
335
 
294
336
  ### HTTP request headers
295
337
 
@@ -309,6 +351,13 @@ Get a user
309
351
  ```ruby
310
352
  # load the gem
311
353
  require 'budgea_client'
354
+ # setup authorization
355
+ BudgeaClient.configure do |config|
356
+ # Configure API key authorization: api_key
357
+ config.api_key['Authorization'] = 'YOUR API KEY'
358
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
359
+ #config.api_key_prefix['Authorization'] = 'Bearer'
360
+ end
312
361
 
313
362
  api_instance = BudgeaClient::UsersManagementApi.new
314
363
 
@@ -340,7 +389,7 @@ Name | Type | Description | Notes
340
389
 
341
390
  ### Authorization
342
391
 
343
- No authorization required
392
+ [api_key](../README.md#api_key)
344
393
 
345
394
  ### HTTP request headers
346
395
 
@@ -360,6 +409,13 @@ Get profiles
360
409
  ```ruby
361
410
  # load the gem
362
411
  require 'budgea_client'
412
+ # setup authorization
413
+ BudgeaClient.configure do |config|
414
+ # Configure API key authorization: api_key
415
+ config.api_key['Authorization'] = 'YOUR API KEY'
416
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
417
+ #config.api_key_prefix['Authorization'] = 'Bearer'
418
+ end
363
419
 
364
420
  api_instance = BudgeaClient::UsersManagementApi.new
365
421
 
@@ -391,7 +447,7 @@ Name | Type | Description | Notes
391
447
 
392
448
  ### Authorization
393
449
 
394
- No authorization required
450
+ [api_key](../README.md#api_key)
395
451
 
396
452
  ### HTTP request headers
397
453
 
@@ -411,6 +467,13 @@ Get a profile
411
467
  ```ruby
412
468
  # load the gem
413
469
  require 'budgea_client'
470
+ # setup authorization
471
+ BudgeaClient.configure do |config|
472
+ # Configure API key authorization: api_key
473
+ config.api_key['Authorization'] = 'YOUR API KEY'
474
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
475
+ #config.api_key_prefix['Authorization'] = 'Bearer'
476
+ end
414
477
 
415
478
  api_instance = BudgeaClient::UsersManagementApi.new
416
479
 
@@ -445,7 +508,7 @@ Name | Type | Description | Notes
445
508
 
446
509
  ### Authorization
447
510
 
448
- No authorization required
511
+ [api_key](../README.md#api_key)
449
512
 
450
513
  ### HTTP request headers
451
514
 
@@ -465,6 +528,13 @@ Get the main profile
465
528
  ```ruby
466
529
  # load the gem
467
530
  require 'budgea_client'
531
+ # setup authorization
532
+ BudgeaClient.configure do |config|
533
+ # Configure API key authorization: api_key
534
+ config.api_key['Authorization'] = 'YOUR API KEY'
535
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
536
+ #config.api_key_prefix['Authorization'] = 'Bearer'
537
+ end
468
538
 
469
539
  api_instance = BudgeaClient::UsersManagementApi.new
470
540
 
@@ -496,7 +566,7 @@ Name | Type | Description | Notes
496
566
 
497
567
  ### Authorization
498
568
 
499
- No authorization required
569
+ [api_key](../README.md#api_key)
500
570
 
501
571
  ### HTTP request headers
502
572
 
@@ -516,6 +586,13 @@ Get my profile
516
586
  ```ruby
517
587
  # load the gem
518
588
  require 'budgea_client'
589
+ # setup authorization
590
+ BudgeaClient.configure do |config|
591
+ # Configure API key authorization: api_key
592
+ config.api_key['Authorization'] = 'YOUR API KEY'
593
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
594
+ #config.api_key_prefix['Authorization'] = 'Bearer'
595
+ end
519
596
 
520
597
  api_instance = BudgeaClient::UsersManagementApi.new
521
598
 
@@ -547,7 +624,7 @@ Name | Type | Description | Notes
547
624
 
548
625
  ### Authorization
549
626
 
550
- No authorization required
627
+ [api_key](../README.md#api_key)
551
628
 
552
629
  ### HTTP request headers
553
630
 
@@ -567,6 +644,13 @@ Create an access_token for this user and get it.<br><br>
567
644
  ```ruby
568
645
  # load the gem
569
646
  require 'budgea_client'
647
+ # setup authorization
648
+ BudgeaClient.configure do |config|
649
+ # Configure API key authorization: api_key
650
+ config.api_key['Authorization'] = 'YOUR API KEY'
651
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
652
+ #config.api_key_prefix['Authorization'] = 'Bearer'
653
+ end
570
654
 
571
655
  api_instance = BudgeaClient::UsersManagementApi.new
572
656
 
@@ -597,7 +681,7 @@ Name | Type | Description | Notes
597
681
 
598
682
  ### Authorization
599
683
 
600
- No authorization required
684
+ [api_key](../README.md#api_key)
601
685
 
602
686
  ### HTTP request headers
603
687
 
data/docs/WealthApi.md CHANGED
@@ -31,6 +31,13 @@ Get securities
31
31
  ```ruby
32
32
  # load the gem
33
33
  require 'budgea_client'
34
+ # setup authorization
35
+ BudgeaClient.configure do |config|
36
+ # Configure API key authorization: api_key
37
+ config.api_key['Authorization'] = 'YOUR API KEY'
38
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
39
+ #config.api_key_prefix['Authorization'] = 'Bearer'
40
+ end
34
41
 
35
42
  api_instance = BudgeaClient::WealthApi.new
36
43
 
@@ -59,7 +66,7 @@ Name | Type | Description | Notes
59
66
 
60
67
  ### Authorization
61
68
 
62
- No authorization required
69
+ [api_key](../README.md#api_key)
63
70
 
64
71
  ### HTTP request headers
65
72
 
@@ -79,6 +86,13 @@ Get logs about connections.<br><br>
79
86
  ```ruby
80
87
  # load the gem
81
88
  require 'budgea_client'
89
+ # setup authorization
90
+ BudgeaClient.configure do |config|
91
+ # Configure API key authorization: api_key
92
+ config.api_key['Authorization'] = 'YOUR API KEY'
93
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
94
+ #config.api_key_prefix['Authorization'] = 'Bearer'
95
+ end
82
96
 
83
97
  api_instance = BudgeaClient::WealthApi.new
84
98
 
@@ -117,7 +131,7 @@ nil (empty response body)
117
131
 
118
132
  ### Authorization
119
133
 
120
- No authorization required
134
+ [api_key](../README.md#api_key)
121
135
 
122
136
  ### HTTP request headers
123
137
 
@@ -137,6 +151,13 @@ Get investments
137
151
  ```ruby
138
152
  # load the gem
139
153
  require 'budgea_client'
154
+ # setup authorization
155
+ BudgeaClient.configure do |config|
156
+ # Configure API key authorization: api_key
157
+ config.api_key['Authorization'] = 'YOUR API KEY'
158
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
159
+ #config.api_key_prefix['Authorization'] = 'Bearer'
160
+ end
140
161
 
141
162
  api_instance = BudgeaClient::WealthApi.new
142
163
 
@@ -171,7 +192,7 @@ Name | Type | Description | Notes
171
192
 
172
193
  ### Authorization
173
194
 
174
- No authorization required
195
+ [api_key](../README.md#api_key)
175
196
 
176
197
  ### HTTP request headers
177
198
 
@@ -191,6 +212,13 @@ Get investment values
191
212
  ```ruby
192
213
  # load the gem
193
214
  require 'budgea_client'
215
+ # setup authorization
216
+ BudgeaClient.configure do |config|
217
+ # Configure API key authorization: api_key
218
+ config.api_key['Authorization'] = 'YOUR API KEY'
219
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
220
+ #config.api_key_prefix['Authorization'] = 'Bearer'
221
+ end
194
222
 
195
223
  api_instance = BudgeaClient::WealthApi.new
196
224
 
@@ -228,7 +256,7 @@ Name | Type | Description | Notes
228
256
 
229
257
  ### Authorization
230
258
 
231
- No authorization required
259
+ [api_key](../README.md#api_key)
232
260
 
233
261
  ### HTTP request headers
234
262
 
@@ -248,6 +276,13 @@ Get logs about connections.<br><br>
248
276
  ```ruby
249
277
  # load the gem
250
278
  require 'budgea_client'
279
+ # setup authorization
280
+ BudgeaClient.configure do |config|
281
+ # Configure API key authorization: api_key
282
+ config.api_key['Authorization'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ #config.api_key_prefix['Authorization'] = 'Bearer'
285
+ end
251
286
 
252
287
  api_instance = BudgeaClient::WealthApi.new
253
288
 
@@ -292,7 +327,7 @@ nil (empty response body)
292
327
 
293
328
  ### Authorization
294
329
 
295
- No authorization required
330
+ [api_key](../README.md#api_key)
296
331
 
297
332
  ### HTTP request headers
298
333
 
@@ -312,6 +347,13 @@ Get investments
312
347
  ```ruby
313
348
  # load the gem
314
349
  require 'budgea_client'
350
+ # setup authorization
351
+ BudgeaClient.configure do |config|
352
+ # Configure API key authorization: api_key
353
+ config.api_key['Authorization'] = 'YOUR API KEY'
354
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
355
+ #config.api_key_prefix['Authorization'] = 'Bearer'
356
+ end
315
357
 
316
358
  api_instance = BudgeaClient::WealthApi.new
317
359
 
@@ -349,7 +391,7 @@ Name | Type | Description | Notes
349
391
 
350
392
  ### Authorization
351
393
 
352
- No authorization required
394
+ [api_key](../README.md#api_key)
353
395
 
354
396
  ### HTTP request headers
355
397
 
@@ -369,6 +411,13 @@ Get investment values
369
411
  ```ruby
370
412
  # load the gem
371
413
  require 'budgea_client'
414
+ # setup authorization
415
+ BudgeaClient.configure do |config|
416
+ # Configure API key authorization: api_key
417
+ config.api_key['Authorization'] = 'YOUR API KEY'
418
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
419
+ #config.api_key_prefix['Authorization'] = 'Bearer'
420
+ end
372
421
 
373
422
  api_instance = BudgeaClient::WealthApi.new
374
423
 
@@ -409,7 +458,7 @@ Name | Type | Description | Notes
409
458
 
410
459
  ### Authorization
411
460
 
412
- No authorization required
461
+ [api_key](../README.md#api_key)
413
462
 
414
463
  ### HTTP request headers
415
464
 
@@ -429,6 +478,13 @@ Get logs about connections.<br><br>
429
478
  ```ruby
430
479
  # load the gem
431
480
  require 'budgea_client'
481
+ # setup authorization
482
+ BudgeaClient.configure do |config|
483
+ # Configure API key authorization: api_key
484
+ config.api_key['Authorization'] = 'YOUR API KEY'
485
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
486
+ #config.api_key_prefix['Authorization'] = 'Bearer'
487
+ end
432
488
 
433
489
  api_instance = BudgeaClient::WealthApi.new
434
490
 
@@ -476,7 +532,7 @@ nil (empty response body)
476
532
 
477
533
  ### Authorization
478
534
 
479
- No authorization required
535
+ [api_key](../README.md#api_key)
480
536
 
481
537
  ### HTTP request headers
482
538
 
@@ -496,6 +552,13 @@ Get investments
496
552
  ```ruby
497
553
  # load the gem
498
554
  require 'budgea_client'
555
+ # setup authorization
556
+ BudgeaClient.configure do |config|
557
+ # Configure API key authorization: api_key
558
+ config.api_key['Authorization'] = 'YOUR API KEY'
559
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
560
+ #config.api_key_prefix['Authorization'] = 'Bearer'
561
+ end
499
562
 
500
563
  api_instance = BudgeaClient::WealthApi.new
501
564
 
@@ -530,7 +593,7 @@ Name | Type | Description | Notes
530
593
 
531
594
  ### Authorization
532
595
 
533
- No authorization required
596
+ [api_key](../README.md#api_key)
534
597
 
535
598
  ### HTTP request headers
536
599
 
@@ -550,6 +613,13 @@ Get investment values
550
613
  ```ruby
551
614
  # load the gem
552
615
  require 'budgea_client'
616
+ # setup authorization
617
+ BudgeaClient.configure do |config|
618
+ # Configure API key authorization: api_key
619
+ config.api_key['Authorization'] = 'YOUR API KEY'
620
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
621
+ #config.api_key_prefix['Authorization'] = 'Bearer'
622
+ end
553
623
 
554
624
  api_instance = BudgeaClient::WealthApi.new
555
625
 
@@ -587,7 +657,7 @@ Name | Type | Description | Notes
587
657
 
588
658
  ### Authorization
589
659
 
590
- No authorization required
660
+ [api_key](../README.md#api_key)
591
661
 
592
662
  ### HTTP request headers
593
663
 
@@ -607,6 +677,13 @@ Get logs about connections.<br><br>
607
677
  ```ruby
608
678
  # load the gem
609
679
  require 'budgea_client'
680
+ # setup authorization
681
+ BudgeaClient.configure do |config|
682
+ # Configure API key authorization: api_key
683
+ config.api_key['Authorization'] = 'YOUR API KEY'
684
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
685
+ #config.api_key_prefix['Authorization'] = 'Bearer'
686
+ end
610
687
 
611
688
  api_instance = BudgeaClient::WealthApi.new
612
689
 
@@ -651,7 +728,7 @@ nil (empty response body)
651
728
 
652
729
  ### Authorization
653
730
 
654
- No authorization required
731
+ [api_key](../README.md#api_key)
655
732
 
656
733
  ### HTTP request headers
657
734
 
@@ -671,6 +748,13 @@ Get investments
671
748
  ```ruby
672
749
  # load the gem
673
750
  require 'budgea_client'
751
+ # setup authorization
752
+ BudgeaClient.configure do |config|
753
+ # Configure API key authorization: api_key
754
+ config.api_key['Authorization'] = 'YOUR API KEY'
755
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
756
+ #config.api_key_prefix['Authorization'] = 'Bearer'
757
+ end
674
758
 
675
759
  api_instance = BudgeaClient::WealthApi.new
676
760
 
@@ -702,7 +786,7 @@ Name | Type | Description | Notes
702
786
 
703
787
  ### Authorization
704
788
 
705
- No authorization required
789
+ [api_key](../README.md#api_key)
706
790
 
707
791
  ### HTTP request headers
708
792
 
@@ -722,6 +806,13 @@ Get investment values
722
806
  ```ruby
723
807
  # load the gem
724
808
  require 'budgea_client'
809
+ # setup authorization
810
+ BudgeaClient.configure do |config|
811
+ # Configure API key authorization: api_key
812
+ config.api_key['Authorization'] = 'YOUR API KEY'
813
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
814
+ #config.api_key_prefix['Authorization'] = 'Bearer'
815
+ end
725
816
 
726
817
  api_instance = BudgeaClient::WealthApi.new
727
818
 
@@ -756,7 +847,7 @@ Name | Type | Description | Notes
756
847
 
757
848
  ### Authorization
758
849
 
759
- No authorization required
850
+ [api_key](../README.md#api_key)
760
851
 
761
852
  ### HTTP request headers
762
853
 
@@ -776,6 +867,13 @@ Get logs about connections.<br><br>
776
867
  ```ruby
777
868
  # load the gem
778
869
  require 'budgea_client'
870
+ # setup authorization
871
+ BudgeaClient.configure do |config|
872
+ # Configure API key authorization: api_key
873
+ config.api_key['Authorization'] = 'YOUR API KEY'
874
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
875
+ #config.api_key_prefix['Authorization'] = 'Bearer'
876
+ end
779
877
 
780
878
  api_instance = BudgeaClient::WealthApi.new
781
879
 
@@ -817,7 +915,7 @@ nil (empty response body)
817
915
 
818
916
  ### Authorization
819
917
 
820
- No authorization required
918
+ [api_key](../README.md#api_key)
821
919
 
822
920
  ### HTTP request headers
823
921