budgea_client 1.3.6 → 1.3.9

Sign up to get free protection for your applications and to get access to all the features.
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
@@ -33,6 +33,13 @@ Get list of connectors
33
33
  ```ruby
34
34
  # load the gem
35
35
  require 'budgea_client'
36
+ # setup authorization
37
+ BudgeaClient.configure do |config|
38
+ # Configure API key authorization: api_key
39
+ config.api_key['Authorization'] = 'YOUR API KEY'
40
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
41
+ #config.api_key_prefix['Authorization'] = 'Bearer'
42
+ end
36
43
 
37
44
  api_instance = BudgeaClient::ConnectionsApi.new
38
45
 
@@ -61,7 +68,7 @@ Name | Type | Description | Notes
61
68
 
62
69
  ### Authorization
63
70
 
64
- No authorization required
71
+ [api_key](../README.md#api_key)
65
72
 
66
73
  ### HTTP request headers
67
74
 
@@ -81,6 +88,13 @@ By default, it selects a set of 3 connections.<br><br>
81
88
  ```ruby
82
89
  # load the gem
83
90
  require 'budgea_client'
91
+ # setup authorization
92
+ BudgeaClient.configure do |config|
93
+ # Configure API key authorization: api_key
94
+ config.api_key['Authorization'] = 'YOUR API KEY'
95
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
96
+ #config.api_key_prefix['Authorization'] = 'Bearer'
97
+ end
84
98
 
85
99
  api_instance = BudgeaClient::ConnectionsApi.new
86
100
 
@@ -116,7 +130,7 @@ Name | Type | Description | Notes
116
130
 
117
131
  ### Authorization
118
132
 
119
- No authorization required
133
+ [api_key](../README.md#api_key)
120
134
 
121
135
  ### HTTP request headers
122
136
 
@@ -136,6 +150,13 @@ Get connections without a user
136
150
  ```ruby
137
151
  # load the gem
138
152
  require 'budgea_client'
153
+ # setup authorization
154
+ BudgeaClient.configure do |config|
155
+ # Configure API key authorization: api_key
156
+ config.api_key['Authorization'] = 'YOUR API KEY'
157
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
158
+ #config.api_key_prefix['Authorization'] = 'Bearer'
159
+ end
139
160
 
140
161
  api_instance = BudgeaClient::ConnectionsApi.new
141
162
 
@@ -164,7 +185,7 @@ Name | Type | Description | Notes
164
185
 
165
186
  ### Authorization
166
187
 
167
- No authorization required
188
+ [api_key](../README.md#api_key)
168
189
 
169
190
  ### HTTP request headers
170
191
 
@@ -184,6 +205,13 @@ Get list of connectors
184
205
  ```ruby
185
206
  # load the gem
186
207
  require 'budgea_client'
208
+ # setup authorization
209
+ BudgeaClient.configure do |config|
210
+ # Configure API key authorization: api_key
211
+ config.api_key['Authorization'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ #config.api_key_prefix['Authorization'] = 'Bearer'
214
+ end
187
215
 
188
216
  api_instance = BudgeaClient::ConnectionsApi.new
189
217
 
@@ -212,7 +240,7 @@ Name | Type | Description | Notes
212
240
 
213
241
  ### Authorization
214
242
 
215
- No authorization required
243
+ [api_key](../README.md#api_key)
216
244
 
217
245
  ### HTTP request headers
218
246
 
@@ -232,6 +260,13 @@ Send a request to add a new connector<br><br>
232
260
  ```ruby
233
261
  # load the gem
234
262
  require 'budgea_client'
263
+ # setup authorization
264
+ BudgeaClient.configure do |config|
265
+ # Configure API key authorization: api_key
266
+ config.api_key['Authorization'] = 'YOUR API KEY'
267
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
268
+ #config.api_key_prefix['Authorization'] = 'Bearer'
269
+ end
235
270
 
236
271
  api_instance = BudgeaClient::ConnectionsApi.new
237
272
 
@@ -281,7 +316,7 @@ Name | Type | Description | Notes
281
316
 
282
317
  ### Authorization
283
318
 
284
- No authorization required
319
+ [api_key](../README.md#api_key)
285
320
 
286
321
  ### HTTP request headers
287
322
 
@@ -301,6 +336,13 @@ Get logs about connections.<br><br>
301
336
  ```ruby
302
337
  # load the gem
303
338
  require 'budgea_client'
339
+ # setup authorization
340
+ BudgeaClient.configure do |config|
341
+ # Configure API key authorization: api_key
342
+ config.api_key['Authorization'] = 'YOUR API KEY'
343
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
344
+ #config.api_key_prefix['Authorization'] = 'Bearer'
345
+ end
304
346
 
305
347
  api_instance = BudgeaClient::ConnectionsApi.new
306
348
 
@@ -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 list of connectors
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::ConnectionsApi.new
374
423
 
@@ -397,7 +446,7 @@ Name | Type | Description | Notes
397
446
 
398
447
  ### Authorization
399
448
 
400
- No authorization required
449
+ [api_key](../README.md#api_key)
401
450
 
402
451
  ### HTTP request headers
403
452
 
@@ -417,6 +466,13 @@ Delete all connections
417
466
  ```ruby
418
467
  # load the gem
419
468
  require 'budgea_client'
469
+ # setup authorization
470
+ BudgeaClient.configure do |config|
471
+ # Configure API key authorization: api_key
472
+ config.api_key['Authorization'] = 'YOUR API KEY'
473
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
474
+ #config.api_key_prefix['Authorization'] = 'Bearer'
475
+ end
420
476
 
421
477
  api_instance = BudgeaClient::ConnectionsApi.new
422
478
 
@@ -448,7 +504,7 @@ Name | Type | Description | Notes
448
504
 
449
505
  ### Authorization
450
506
 
451
- No authorization required
507
+ [api_key](../README.md#api_key)
452
508
 
453
509
  ### HTTP request headers
454
510
 
@@ -468,6 +524,13 @@ Get connections
468
524
  ```ruby
469
525
  # load the gem
470
526
  require 'budgea_client'
527
+ # setup authorization
528
+ BudgeaClient.configure do |config|
529
+ # Configure API key authorization: api_key
530
+ config.api_key['Authorization'] = 'YOUR API KEY'
531
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
532
+ #config.api_key_prefix['Authorization'] = 'Bearer'
533
+ end
471
534
 
472
535
  api_instance = BudgeaClient::ConnectionsApi.new
473
536
 
@@ -499,7 +562,7 @@ Name | Type | Description | Notes
499
562
 
500
563
  ### Authorization
501
564
 
502
- No authorization required
565
+ [api_key](../README.md#api_key)
503
566
 
504
567
  ### HTTP request headers
505
568
 
@@ -519,6 +582,13 @@ This endpoint deletes a connection and all related accounts and transactions.<br
519
582
  ```ruby
520
583
  # load the gem
521
584
  require 'budgea_client'
585
+ # setup authorization
586
+ BudgeaClient.configure do |config|
587
+ # Configure API key authorization: api_key
588
+ config.api_key['Authorization'] = 'YOUR API KEY'
589
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
590
+ #config.api_key_prefix['Authorization'] = 'Bearer'
591
+ end
522
592
 
523
593
  api_instance = BudgeaClient::ConnectionsApi.new
524
594
 
@@ -553,7 +623,7 @@ Name | Type | Description | Notes
553
623
 
554
624
  ### Authorization
555
625
 
556
- No authorization required
626
+ [api_key](../README.md#api_key)
557
627
 
558
628
  ### HTTP request headers
559
629
 
@@ -573,6 +643,13 @@ Get connection additionnal informations
573
643
  ```ruby
574
644
  # load the gem
575
645
  require 'budgea_client'
646
+ # setup authorization
647
+ BudgeaClient.configure do |config|
648
+ # Configure API key authorization: api_key
649
+ config.api_key['Authorization'] = 'YOUR API KEY'
650
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
651
+ #config.api_key_prefix['Authorization'] = 'Bearer'
652
+ end
576
653
 
577
654
  api_instance = BudgeaClient::ConnectionsApi.new
578
655
 
@@ -607,7 +684,7 @@ Name | Type | Description | Notes
607
684
 
608
685
  ### Authorization
609
686
 
610
- No authorization required
687
+ [api_key](../README.md#api_key)
611
688
 
612
689
  ### HTTP request headers
613
690
 
@@ -627,6 +704,13 @@ Get logs about connections.<br><br>
627
704
  ```ruby
628
705
  # load the gem
629
706
  require 'budgea_client'
707
+ # setup authorization
708
+ BudgeaClient.configure do |config|
709
+ # Configure API key authorization: api_key
710
+ config.api_key['Authorization'] = 'YOUR API KEY'
711
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
712
+ #config.api_key_prefix['Authorization'] = 'Bearer'
713
+ end
630
714
 
631
715
  api_instance = BudgeaClient::ConnectionsApi.new
632
716
 
@@ -681,7 +765,7 @@ Name | Type | Description | Notes
681
765
 
682
766
  ### Authorization
683
767
 
684
- No authorization required
768
+ [api_key](../README.md#api_key)
685
769
 
686
770
  ### HTTP request headers
687
771
 
@@ -701,6 +785,13 @@ Give new parameters to change on the configuration of this connection (for examp
701
785
  ```ruby
702
786
  # load the gem
703
787
  require 'budgea_client'
788
+ # setup authorization
789
+ BudgeaClient.configure do |config|
790
+ # Configure API key authorization: api_key
791
+ config.api_key['Authorization'] = 'YOUR API KEY'
792
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
793
+ #config.api_key_prefix['Authorization'] = 'Bearer'
794
+ end
704
795
 
705
796
  api_instance = BudgeaClient::ConnectionsApi.new
706
797
 
@@ -743,7 +834,7 @@ Name | Type | Description | Notes
743
834
 
744
835
  ### Authorization
745
836
 
746
- No authorization required
837
+ [api_key](../README.md#api_key)
747
838
 
748
839
  ### HTTP request headers
749
840
 
@@ -763,6 +854,13 @@ We suggest to pass parameter expand=accounts[transactions] to get all *new* and
763
854
  ```ruby
764
855
  # load the gem
765
856
  require 'budgea_client'
857
+ # setup authorization
858
+ BudgeaClient.configure do |config|
859
+ # Configure API key authorization: api_key
860
+ config.api_key['Authorization'] = 'YOUR API KEY'
861
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
862
+ #config.api_key_prefix['Authorization'] = 'Bearer'
863
+ end
766
864
 
767
865
  api_instance = BudgeaClient::ConnectionsApi.new
768
866
 
@@ -797,7 +895,7 @@ Name | Type | Description | Notes
797
895
 
798
896
  ### Authorization
799
897
 
800
- No authorization required
898
+ [api_key](../README.md#api_key)
801
899
 
802
900
  ### HTTP request headers
803
901
 
@@ -817,6 +915,13 @@ Create a new connection to a given bank or provider. You have to give all needed
817
915
  ```ruby
818
916
  # load the gem
819
917
  require 'budgea_client'
918
+ # setup authorization
919
+ BudgeaClient.configure do |config|
920
+ # Configure API key authorization: api_key
921
+ config.api_key['Authorization'] = 'YOUR API KEY'
922
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
923
+ #config.api_key_prefix['Authorization'] = 'Bearer'
924
+ end
820
925
 
821
926
  api_instance = BudgeaClient::ConnectionsApi.new
822
927
 
@@ -852,7 +957,7 @@ Name | Type | Description | Notes
852
957
 
853
958
  ### Authorization
854
959
 
855
- No authorization required
960
+ [api_key](../README.md#api_key)
856
961
 
857
962
  ### HTTP request headers
858
963
 
@@ -872,6 +977,13 @@ Get logs about connections.<br><br>
872
977
  ```ruby
873
978
  # load the gem
874
979
  require 'budgea_client'
980
+ # setup authorization
981
+ BudgeaClient.configure do |config|
982
+ # Configure API key authorization: api_key
983
+ config.api_key['Authorization'] = 'YOUR API KEY'
984
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
985
+ #config.api_key_prefix['Authorization'] = 'Bearer'
986
+ end
875
987
 
876
988
  api_instance = BudgeaClient::ConnectionsApi.new
877
989
 
@@ -923,7 +1035,7 @@ Name | Type | Description | Notes
923
1035
 
924
1036
  ### Authorization
925
1037
 
926
- No authorization required
1038
+ [api_key](../README.md#api_key)
927
1039
 
928
1040
  ### HTTP request headers
929
1041
 
data/docs/DocumentsApi.md CHANGED
@@ -93,6 +93,13 @@ Get document types
93
93
  ```ruby
94
94
  # load the gem
95
95
  require 'budgea_client'
96
+ # setup authorization
97
+ BudgeaClient.configure do |config|
98
+ # Configure API key authorization: api_key
99
+ config.api_key['Authorization'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ #config.api_key_prefix['Authorization'] = 'Bearer'
102
+ end
96
103
 
97
104
  api_instance = BudgeaClient::DocumentsApi.new
98
105
 
@@ -121,7 +128,7 @@ Name | Type | Description | Notes
121
128
 
122
129
  ### Authorization
123
130
 
124
- No authorization required
131
+ [api_key](../README.md#api_key)
125
132
 
126
133
  ### HTTP request headers
127
134
 
@@ -141,6 +148,13 @@ Change value of a document type.<br><br>
141
148
  ```ruby
142
149
  # load the gem
143
150
  require 'budgea_client'
151
+ # setup authorization
152
+ BudgeaClient.configure do |config|
153
+ # Configure API key authorization: api_key
154
+ config.api_key['Authorization'] = 'YOUR API KEY'
155
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
156
+ #config.api_key_prefix['Authorization'] = 'Bearer'
157
+ end
144
158
 
145
159
  api_instance = BudgeaClient::DocumentsApi.new
146
160
 
@@ -178,7 +192,7 @@ Name | Type | Description | Notes
178
192
 
179
193
  ### Authorization
180
194
 
181
- No authorization required
195
+ [api_key](../README.md#api_key)
182
196
 
183
197
  ### HTTP request headers
184
198
 
@@ -198,6 +212,13 @@ Post an image and apply OCR on it to obtain found meta-data.<br><br>
198
212
  ```ruby
199
213
  # load the gem
200
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
201
222
 
202
223
  api_instance = BudgeaClient::DocumentsApi.new
203
224
 
@@ -230,7 +251,7 @@ nil (empty response body)
230
251
 
231
252
  ### Authorization
232
253
 
233
- No authorization required
254
+ [api_key](../README.md#api_key)
234
255
 
235
256
  ### HTTP request headers
236
257
 
@@ -250,6 +271,13 @@ Delete documents
250
271
  ```ruby
251
272
  # load the gem
252
273
  require 'budgea_client'
274
+ # setup authorization
275
+ BudgeaClient.configure do |config|
276
+ # Configure API key authorization: api_key
277
+ config.api_key['Authorization'] = 'YOUR API KEY'
278
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
279
+ #config.api_key_prefix['Authorization'] = 'Bearer'
280
+ end
253
281
 
254
282
  api_instance = BudgeaClient::DocumentsApi.new
255
283
 
@@ -287,7 +315,7 @@ Name | Type | Description | Notes
287
315
 
288
316
  ### Authorization
289
317
 
290
- No authorization required
318
+ [api_key](../README.md#api_key)
291
319
 
292
320
  ### HTTP request headers
293
321
 
@@ -307,6 +335,13 @@ Get list of documents<br><br>
307
335
  ```ruby
308
336
  # load the gem
309
337
  require 'budgea_client'
338
+ # setup authorization
339
+ BudgeaClient.configure do |config|
340
+ # Configure API key authorization: api_key
341
+ config.api_key['Authorization'] = 'YOUR API KEY'
342
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
343
+ #config.api_key_prefix['Authorization'] = 'Bearer'
344
+ end
310
345
 
311
346
  api_instance = BudgeaClient::DocumentsApi.new
312
347
 
@@ -362,7 +397,7 @@ Name | Type | Description | Notes
362
397
 
363
398
  ### Authorization
364
399
 
365
- No authorization required
400
+ [api_key](../README.md#api_key)
366
401
 
367
402
  ### HTTP request headers
368
403
 
@@ -382,6 +417,13 @@ Delete a document
382
417
  ```ruby
383
418
  # load the gem
384
419
  require 'budgea_client'
420
+ # setup authorization
421
+ BudgeaClient.configure do |config|
422
+ # Configure API key authorization: api_key
423
+ config.api_key['Authorization'] = 'YOUR API KEY'
424
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
425
+ #config.api_key_prefix['Authorization'] = 'Bearer'
426
+ end
385
427
 
386
428
  api_instance = BudgeaClient::DocumentsApi.new
387
429
 
@@ -422,7 +464,7 @@ Name | Type | Description | Notes
422
464
 
423
465
  ### Authorization
424
466
 
425
- No authorization required
467
+ [api_key](../README.md#api_key)
426
468
 
427
469
  ### HTTP request headers
428
470
 
@@ -442,6 +484,13 @@ Edit meta-data of a specific document.
442
484
  ```ruby
443
485
  # load the gem
444
486
  require 'budgea_client'
487
+ # setup authorization
488
+ BudgeaClient.configure do |config|
489
+ # Configure API key authorization: api_key
490
+ config.api_key['Authorization'] = 'YOUR API KEY'
491
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
492
+ #config.api_key_prefix['Authorization'] = 'Bearer'
493
+ end
445
494
 
446
495
  api_instance = BudgeaClient::DocumentsApi.new
447
496
 
@@ -504,7 +553,7 @@ Name | Type | Description | Notes
504
553
 
505
554
  ### Authorization
506
555
 
507
- No authorization required
556
+ [api_key](../README.md#api_key)
508
557
 
509
558
  ### HTTP request headers
510
559
 
@@ -524,6 +573,13 @@ Add a new document<br><br>
524
573
  ```ruby
525
574
  # load the gem
526
575
  require 'budgea_client'
576
+ # setup authorization
577
+ BudgeaClient.configure do |config|
578
+ # Configure API key authorization: api_key
579
+ config.api_key['Authorization'] = 'YOUR API KEY'
580
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
581
+ #config.api_key_prefix['Authorization'] = 'Bearer'
582
+ end
527
583
 
528
584
  api_instance = BudgeaClient::DocumentsApi.new
529
585
 
@@ -587,7 +643,7 @@ Name | Type | Description | Notes
587
643
 
588
644
  ### Authorization
589
645
 
590
- No authorization required
646
+ [api_key](../README.md#api_key)
591
647
 
592
648
  ### HTTP request headers
593
649
 
@@ -607,6 +663,13 @@ Attach an existing document to a transaction or a transactions_cluster
607
663
  ```ruby
608
664
  # load the gem
609
665
  require 'budgea_client'
666
+ # setup authorization
667
+ BudgeaClient.configure do |config|
668
+ # Configure API key authorization: api_key
669
+ config.api_key['Authorization'] = 'YOUR API KEY'
670
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
671
+ #config.api_key_prefix['Authorization'] = 'Bearer'
672
+ end
610
673
 
611
674
  api_instance = BudgeaClient::DocumentsApi.new
612
675
 
@@ -647,7 +710,7 @@ Name | Type | Description | Notes
647
710
 
648
711
  ### Authorization
649
712
 
650
- No authorization required
713
+ [api_key](../README.md#api_key)
651
714
 
652
715
  ### HTTP request headers
653
716
 
@@ -667,6 +730,13 @@ Delete documents
667
730
  ```ruby
668
731
  # load the gem
669
732
  require 'budgea_client'
733
+ # setup authorization
734
+ BudgeaClient.configure do |config|
735
+ # Configure API key authorization: api_key
736
+ config.api_key['Authorization'] = 'YOUR API KEY'
737
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
738
+ #config.api_key_prefix['Authorization'] = 'Bearer'
739
+ end
670
740
 
671
741
  api_instance = BudgeaClient::DocumentsApi.new
672
742
 
@@ -704,7 +774,7 @@ Name | Type | Description | Notes
704
774
 
705
775
  ### Authorization
706
776
 
707
- No authorization required
777
+ [api_key](../README.md#api_key)
708
778
 
709
779
  ### HTTP request headers
710
780
 
@@ -724,6 +794,13 @@ Get list of documents<br><br>
724
794
  ```ruby
725
795
  # load the gem
726
796
  require 'budgea_client'
797
+ # setup authorization
798
+ BudgeaClient.configure do |config|
799
+ # Configure API key authorization: api_key
800
+ config.api_key['Authorization'] = 'YOUR API KEY'
801
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
802
+ #config.api_key_prefix['Authorization'] = 'Bearer'
803
+ end
727
804
 
728
805
  api_instance = BudgeaClient::DocumentsApi.new
729
806
 
@@ -779,7 +856,7 @@ Name | Type | Description | Notes
779
856
 
780
857
  ### Authorization
781
858
 
782
- No authorization required
859
+ [api_key](../README.md#api_key)
783
860
 
784
861
  ### HTTP request headers
785
862
 
@@ -799,6 +876,13 @@ Delete a document
799
876
  ```ruby
800
877
  # load the gem
801
878
  require 'budgea_client'
879
+ # setup authorization
880
+ BudgeaClient.configure do |config|
881
+ # Configure API key authorization: api_key
882
+ config.api_key['Authorization'] = 'YOUR API KEY'
883
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
884
+ #config.api_key_prefix['Authorization'] = 'Bearer'
885
+ end
802
886
 
803
887
  api_instance = BudgeaClient::DocumentsApi.new
804
888
 
@@ -839,7 +923,7 @@ Name | Type | Description | Notes
839
923
 
840
924
  ### Authorization
841
925
 
842
- No authorization required
926
+ [api_key](../README.md#api_key)
843
927
 
844
928
  ### HTTP request headers
845
929
 
@@ -859,6 +943,13 @@ Edit meta-data of a specific document.
859
943
  ```ruby
860
944
  # load the gem
861
945
  require 'budgea_client'
946
+ # setup authorization
947
+ BudgeaClient.configure do |config|
948
+ # Configure API key authorization: api_key
949
+ config.api_key['Authorization'] = 'YOUR API KEY'
950
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
951
+ #config.api_key_prefix['Authorization'] = 'Bearer'
952
+ end
862
953
 
863
954
  api_instance = BudgeaClient::DocumentsApi.new
864
955
 
@@ -921,7 +1012,7 @@ Name | Type | Description | Notes
921
1012
 
922
1013
  ### Authorization
923
1014
 
924
- No authorization required
1015
+ [api_key](../README.md#api_key)
925
1016
 
926
1017
  ### HTTP request headers
927
1018
 
@@ -941,6 +1032,13 @@ Add a new document<br><br>
941
1032
  ```ruby
942
1033
  # load the gem
943
1034
  require 'budgea_client'
1035
+ # setup authorization
1036
+ BudgeaClient.configure do |config|
1037
+ # Configure API key authorization: api_key
1038
+ config.api_key['Authorization'] = 'YOUR API KEY'
1039
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1040
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1041
+ end
944
1042
 
945
1043
  api_instance = BudgeaClient::DocumentsApi.new
946
1044
 
@@ -1004,7 +1102,7 @@ Name | Type | Description | Notes
1004
1102
 
1005
1103
  ### Authorization
1006
1104
 
1007
- No authorization required
1105
+ [api_key](../README.md#api_key)
1008
1106
 
1009
1107
  ### HTTP request headers
1010
1108
 
@@ -1024,6 +1122,13 @@ Attach an existing document to a transaction or a transactions_cluster
1024
1122
  ```ruby
1025
1123
  # load the gem
1026
1124
  require 'budgea_client'
1125
+ # setup authorization
1126
+ BudgeaClient.configure do |config|
1127
+ # Configure API key authorization: api_key
1128
+ config.api_key['Authorization'] = 'YOUR API KEY'
1129
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1130
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1131
+ end
1027
1132
 
1028
1133
  api_instance = BudgeaClient::DocumentsApi.new
1029
1134
 
@@ -1064,7 +1169,7 @@ Name | Type | Description | Notes
1064
1169
 
1065
1170
  ### Authorization
1066
1171
 
1067
- No authorization required
1172
+ [api_key](../README.md#api_key)
1068
1173
 
1069
1174
  ### HTTP request headers
1070
1175
 
@@ -1084,6 +1189,13 @@ Delete documents
1084
1189
  ```ruby
1085
1190
  # load the gem
1086
1191
  require 'budgea_client'
1192
+ # setup authorization
1193
+ BudgeaClient.configure do |config|
1194
+ # Configure API key authorization: api_key
1195
+ config.api_key['Authorization'] = 'YOUR API KEY'
1196
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1197
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1198
+ end
1087
1199
 
1088
1200
  api_instance = BudgeaClient::DocumentsApi.new
1089
1201
 
@@ -1124,7 +1236,7 @@ Name | Type | Description | Notes
1124
1236
 
1125
1237
  ### Authorization
1126
1238
 
1127
- No authorization required
1239
+ [api_key](../README.md#api_key)
1128
1240
 
1129
1241
  ### HTTP request headers
1130
1242
 
@@ -1144,6 +1256,13 @@ Get list of documents<br><br>
1144
1256
  ```ruby
1145
1257
  # load the gem
1146
1258
  require 'budgea_client'
1259
+ # setup authorization
1260
+ BudgeaClient.configure do |config|
1261
+ # Configure API key authorization: api_key
1262
+ config.api_key['Authorization'] = 'YOUR API KEY'
1263
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1264
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1265
+ end
1147
1266
 
1148
1267
  api_instance = BudgeaClient::DocumentsApi.new
1149
1268
 
@@ -1202,7 +1321,7 @@ Name | Type | Description | Notes
1202
1321
 
1203
1322
  ### Authorization
1204
1323
 
1205
- No authorization required
1324
+ [api_key](../README.md#api_key)
1206
1325
 
1207
1326
  ### HTTP request headers
1208
1327
 
@@ -1222,6 +1341,13 @@ Delete a document
1222
1341
  ```ruby
1223
1342
  # load the gem
1224
1343
  require 'budgea_client'
1344
+ # setup authorization
1345
+ BudgeaClient.configure do |config|
1346
+ # Configure API key authorization: api_key
1347
+ config.api_key['Authorization'] = 'YOUR API KEY'
1348
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1349
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1350
+ end
1225
1351
 
1226
1352
  api_instance = BudgeaClient::DocumentsApi.new
1227
1353
 
@@ -1265,7 +1391,7 @@ Name | Type | Description | Notes
1265
1391
 
1266
1392
  ### Authorization
1267
1393
 
1268
- No authorization required
1394
+ [api_key](../README.md#api_key)
1269
1395
 
1270
1396
  ### HTTP request headers
1271
1397
 
@@ -1285,6 +1411,13 @@ Edit meta-data of a specific document.
1285
1411
  ```ruby
1286
1412
  # load the gem
1287
1413
  require 'budgea_client'
1414
+ # setup authorization
1415
+ BudgeaClient.configure do |config|
1416
+ # Configure API key authorization: api_key
1417
+ config.api_key['Authorization'] = 'YOUR API KEY'
1418
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1419
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1420
+ end
1288
1421
 
1289
1422
  api_instance = BudgeaClient::DocumentsApi.new
1290
1423
 
@@ -1350,7 +1483,7 @@ Name | Type | Description | Notes
1350
1483
 
1351
1484
  ### Authorization
1352
1485
 
1353
- No authorization required
1486
+ [api_key](../README.md#api_key)
1354
1487
 
1355
1488
  ### HTTP request headers
1356
1489
 
@@ -1370,6 +1503,13 @@ Add a new document<br><br>
1370
1503
  ```ruby
1371
1504
  # load the gem
1372
1505
  require 'budgea_client'
1506
+ # setup authorization
1507
+ BudgeaClient.configure do |config|
1508
+ # Configure API key authorization: api_key
1509
+ config.api_key['Authorization'] = 'YOUR API KEY'
1510
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1511
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1512
+ end
1373
1513
 
1374
1514
  api_instance = BudgeaClient::DocumentsApi.new
1375
1515
 
@@ -1436,7 +1576,7 @@ Name | Type | Description | Notes
1436
1576
 
1437
1577
  ### Authorization
1438
1578
 
1439
- No authorization required
1579
+ [api_key](../README.md#api_key)
1440
1580
 
1441
1581
  ### HTTP request headers
1442
1582
 
@@ -1456,6 +1596,13 @@ Attach an existing document to a transaction or a transactions_cluster
1456
1596
  ```ruby
1457
1597
  # load the gem
1458
1598
  require 'budgea_client'
1599
+ # setup authorization
1600
+ BudgeaClient.configure do |config|
1601
+ # Configure API key authorization: api_key
1602
+ config.api_key['Authorization'] = 'YOUR API KEY'
1603
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1604
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1605
+ end
1459
1606
 
1460
1607
  api_instance = BudgeaClient::DocumentsApi.new
1461
1608
 
@@ -1499,7 +1646,7 @@ Name | Type | Description | Notes
1499
1646
 
1500
1647
  ### Authorization
1501
1648
 
1502
- No authorization required
1649
+ [api_key](../README.md#api_key)
1503
1650
 
1504
1651
  ### HTTP request headers
1505
1652
 
@@ -1519,6 +1666,13 @@ Delete documents
1519
1666
  ```ruby
1520
1667
  # load the gem
1521
1668
  require 'budgea_client'
1669
+ # setup authorization
1670
+ BudgeaClient.configure do |config|
1671
+ # Configure API key authorization: api_key
1672
+ config.api_key['Authorization'] = 'YOUR API KEY'
1673
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1674
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1675
+ end
1522
1676
 
1523
1677
  api_instance = BudgeaClient::DocumentsApi.new
1524
1678
 
@@ -1559,7 +1713,7 @@ Name | Type | Description | Notes
1559
1713
 
1560
1714
  ### Authorization
1561
1715
 
1562
- No authorization required
1716
+ [api_key](../README.md#api_key)
1563
1717
 
1564
1718
  ### HTTP request headers
1565
1719
 
@@ -1579,6 +1733,13 @@ Get list of documents<br><br>
1579
1733
  ```ruby
1580
1734
  # load the gem
1581
1735
  require 'budgea_client'
1736
+ # setup authorization
1737
+ BudgeaClient.configure do |config|
1738
+ # Configure API key authorization: api_key
1739
+ config.api_key['Authorization'] = 'YOUR API KEY'
1740
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1741
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1742
+ end
1582
1743
 
1583
1744
  api_instance = BudgeaClient::DocumentsApi.new
1584
1745
 
@@ -1637,7 +1798,7 @@ Name | Type | Description | Notes
1637
1798
 
1638
1799
  ### Authorization
1639
1800
 
1640
- No authorization required
1801
+ [api_key](../README.md#api_key)
1641
1802
 
1642
1803
  ### HTTP request headers
1643
1804
 
@@ -1657,6 +1818,13 @@ Delete a document
1657
1818
  ```ruby
1658
1819
  # load the gem
1659
1820
  require 'budgea_client'
1821
+ # setup authorization
1822
+ BudgeaClient.configure do |config|
1823
+ # Configure API key authorization: api_key
1824
+ config.api_key['Authorization'] = 'YOUR API KEY'
1825
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1826
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1827
+ end
1660
1828
 
1661
1829
  api_instance = BudgeaClient::DocumentsApi.new
1662
1830
 
@@ -1700,7 +1868,7 @@ Name | Type | Description | Notes
1700
1868
 
1701
1869
  ### Authorization
1702
1870
 
1703
- No authorization required
1871
+ [api_key](../README.md#api_key)
1704
1872
 
1705
1873
  ### HTTP request headers
1706
1874
 
@@ -1720,6 +1888,13 @@ Edit meta-data of a specific document.
1720
1888
  ```ruby
1721
1889
  # load the gem
1722
1890
  require 'budgea_client'
1891
+ # setup authorization
1892
+ BudgeaClient.configure do |config|
1893
+ # Configure API key authorization: api_key
1894
+ config.api_key['Authorization'] = 'YOUR API KEY'
1895
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1896
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1897
+ end
1723
1898
 
1724
1899
  api_instance = BudgeaClient::DocumentsApi.new
1725
1900
 
@@ -1785,7 +1960,7 @@ Name | Type | Description | Notes
1785
1960
 
1786
1961
  ### Authorization
1787
1962
 
1788
- No authorization required
1963
+ [api_key](../README.md#api_key)
1789
1964
 
1790
1965
  ### HTTP request headers
1791
1966
 
@@ -1805,6 +1980,13 @@ Add a new document<br><br>
1805
1980
  ```ruby
1806
1981
  # load the gem
1807
1982
  require 'budgea_client'
1983
+ # setup authorization
1984
+ BudgeaClient.configure do |config|
1985
+ # Configure API key authorization: api_key
1986
+ config.api_key['Authorization'] = 'YOUR API KEY'
1987
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1988
+ #config.api_key_prefix['Authorization'] = 'Bearer'
1989
+ end
1808
1990
 
1809
1991
  api_instance = BudgeaClient::DocumentsApi.new
1810
1992
 
@@ -1871,7 +2053,7 @@ Name | Type | Description | Notes
1871
2053
 
1872
2054
  ### Authorization
1873
2055
 
1874
- No authorization required
2056
+ [api_key](../README.md#api_key)
1875
2057
 
1876
2058
  ### HTTP request headers
1877
2059
 
@@ -1891,6 +2073,13 @@ Attach an existing document to a transaction or a transactions_cluster
1891
2073
  ```ruby
1892
2074
  # load the gem
1893
2075
  require 'budgea_client'
2076
+ # setup authorization
2077
+ BudgeaClient.configure do |config|
2078
+ # Configure API key authorization: api_key
2079
+ config.api_key['Authorization'] = 'YOUR API KEY'
2080
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2081
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2082
+ end
1894
2083
 
1895
2084
  api_instance = BudgeaClient::DocumentsApi.new
1896
2085
 
@@ -1934,7 +2123,7 @@ Name | Type | Description | Notes
1934
2123
 
1935
2124
  ### Authorization
1936
2125
 
1937
- No authorization required
2126
+ [api_key](../README.md#api_key)
1938
2127
 
1939
2128
  ### HTTP request headers
1940
2129
 
@@ -1954,6 +2143,13 @@ Delete documents
1954
2143
  ```ruby
1955
2144
  # load the gem
1956
2145
  require 'budgea_client'
2146
+ # setup authorization
2147
+ BudgeaClient.configure do |config|
2148
+ # Configure API key authorization: api_key
2149
+ config.api_key['Authorization'] = 'YOUR API KEY'
2150
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2151
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2152
+ end
1957
2153
 
1958
2154
  api_instance = BudgeaClient::DocumentsApi.new
1959
2155
 
@@ -1988,7 +2184,7 @@ Name | Type | Description | Notes
1988
2184
 
1989
2185
  ### Authorization
1990
2186
 
1991
- No authorization required
2187
+ [api_key](../README.md#api_key)
1992
2188
 
1993
2189
  ### HTTP request headers
1994
2190
 
@@ -2008,6 +2204,13 @@ Get list of documents<br><br>
2008
2204
  ```ruby
2009
2205
  # load the gem
2010
2206
  require 'budgea_client'
2207
+ # setup authorization
2208
+ BudgeaClient.configure do |config|
2209
+ # Configure API key authorization: api_key
2210
+ config.api_key['Authorization'] = 'YOUR API KEY'
2211
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2212
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2213
+ end
2011
2214
 
2012
2215
  api_instance = BudgeaClient::DocumentsApi.new
2013
2216
 
@@ -2060,7 +2263,7 @@ Name | Type | Description | Notes
2060
2263
 
2061
2264
  ### Authorization
2062
2265
 
2063
- No authorization required
2266
+ [api_key](../README.md#api_key)
2064
2267
 
2065
2268
  ### HTTP request headers
2066
2269
 
@@ -2080,6 +2283,13 @@ Delete a document
2080
2283
  ```ruby
2081
2284
  # load the gem
2082
2285
  require 'budgea_client'
2286
+ # setup authorization
2287
+ BudgeaClient.configure do |config|
2288
+ # Configure API key authorization: api_key
2289
+ config.api_key['Authorization'] = 'YOUR API KEY'
2290
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2291
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2292
+ end
2083
2293
 
2084
2294
  api_instance = BudgeaClient::DocumentsApi.new
2085
2295
 
@@ -2117,7 +2327,7 @@ Name | Type | Description | Notes
2117
2327
 
2118
2328
  ### Authorization
2119
2329
 
2120
- No authorization required
2330
+ [api_key](../README.md#api_key)
2121
2331
 
2122
2332
  ### HTTP request headers
2123
2333
 
@@ -2137,6 +2347,13 @@ Edit meta-data of a specific document.
2137
2347
  ```ruby
2138
2348
  # load the gem
2139
2349
  require 'budgea_client'
2350
+ # setup authorization
2351
+ BudgeaClient.configure do |config|
2352
+ # Configure API key authorization: api_key
2353
+ config.api_key['Authorization'] = 'YOUR API KEY'
2354
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2355
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2356
+ end
2140
2357
 
2141
2358
  api_instance = BudgeaClient::DocumentsApi.new
2142
2359
 
@@ -2196,7 +2413,7 @@ Name | Type | Description | Notes
2196
2413
 
2197
2414
  ### Authorization
2198
2415
 
2199
- No authorization required
2416
+ [api_key](../README.md#api_key)
2200
2417
 
2201
2418
  ### HTTP request headers
2202
2419
 
@@ -2216,6 +2433,13 @@ Add a new document<br><br>
2216
2433
  ```ruby
2217
2434
  # load the gem
2218
2435
  require 'budgea_client'
2436
+ # setup authorization
2437
+ BudgeaClient.configure do |config|
2438
+ # Configure API key authorization: api_key
2439
+ config.api_key['Authorization'] = 'YOUR API KEY'
2440
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2441
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2442
+ end
2219
2443
 
2220
2444
  api_instance = BudgeaClient::DocumentsApi.new
2221
2445
 
@@ -2276,7 +2500,7 @@ Name | Type | Description | Notes
2276
2500
 
2277
2501
  ### Authorization
2278
2502
 
2279
- No authorization required
2503
+ [api_key](../README.md#api_key)
2280
2504
 
2281
2505
  ### HTTP request headers
2282
2506
 
@@ -2296,6 +2520,13 @@ Attach an existing document to a transaction or a transactions_cluster
2296
2520
  ```ruby
2297
2521
  # load the gem
2298
2522
  require 'budgea_client'
2523
+ # setup authorization
2524
+ BudgeaClient.configure do |config|
2525
+ # Configure API key authorization: api_key
2526
+ config.api_key['Authorization'] = 'YOUR API KEY'
2527
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2528
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2529
+ end
2299
2530
 
2300
2531
  api_instance = BudgeaClient::DocumentsApi.new
2301
2532
 
@@ -2333,7 +2564,7 @@ Name | Type | Description | Notes
2333
2564
 
2334
2565
  ### Authorization
2335
2566
 
2336
- No authorization required
2567
+ [api_key](../README.md#api_key)
2337
2568
 
2338
2569
  ### HTTP request headers
2339
2570
 
@@ -2353,6 +2584,13 @@ Delete documents
2353
2584
  ```ruby
2354
2585
  # load the gem
2355
2586
  require 'budgea_client'
2587
+ # setup authorization
2588
+ BudgeaClient.configure do |config|
2589
+ # Configure API key authorization: api_key
2590
+ config.api_key['Authorization'] = 'YOUR API KEY'
2591
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2592
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2593
+ end
2356
2594
 
2357
2595
  api_instance = BudgeaClient::DocumentsApi.new
2358
2596
 
@@ -2390,7 +2628,7 @@ Name | Type | Description | Notes
2390
2628
 
2391
2629
  ### Authorization
2392
2630
 
2393
- No authorization required
2631
+ [api_key](../README.md#api_key)
2394
2632
 
2395
2633
  ### HTTP request headers
2396
2634
 
@@ -2410,6 +2648,13 @@ Get list of documents<br><br>
2410
2648
  ```ruby
2411
2649
  # load the gem
2412
2650
  require 'budgea_client'
2651
+ # setup authorization
2652
+ BudgeaClient.configure do |config|
2653
+ # Configure API key authorization: api_key
2654
+ config.api_key['Authorization'] = 'YOUR API KEY'
2655
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2656
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2657
+ end
2413
2658
 
2414
2659
  api_instance = BudgeaClient::DocumentsApi.new
2415
2660
 
@@ -2465,7 +2710,7 @@ Name | Type | Description | Notes
2465
2710
 
2466
2711
  ### Authorization
2467
2712
 
2468
- No authorization required
2713
+ [api_key](../README.md#api_key)
2469
2714
 
2470
2715
  ### HTTP request headers
2471
2716
 
@@ -2485,6 +2730,13 @@ Delete a document
2485
2730
  ```ruby
2486
2731
  # load the gem
2487
2732
  require 'budgea_client'
2733
+ # setup authorization
2734
+ BudgeaClient.configure do |config|
2735
+ # Configure API key authorization: api_key
2736
+ config.api_key['Authorization'] = 'YOUR API KEY'
2737
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2738
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2739
+ end
2488
2740
 
2489
2741
  api_instance = BudgeaClient::DocumentsApi.new
2490
2742
 
@@ -2525,7 +2777,7 @@ Name | Type | Description | Notes
2525
2777
 
2526
2778
  ### Authorization
2527
2779
 
2528
- No authorization required
2780
+ [api_key](../README.md#api_key)
2529
2781
 
2530
2782
  ### HTTP request headers
2531
2783
 
@@ -2545,6 +2797,13 @@ Edit meta-data of a specific document.
2545
2797
  ```ruby
2546
2798
  # load the gem
2547
2799
  require 'budgea_client'
2800
+ # setup authorization
2801
+ BudgeaClient.configure do |config|
2802
+ # Configure API key authorization: api_key
2803
+ config.api_key['Authorization'] = 'YOUR API KEY'
2804
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2805
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2806
+ end
2548
2807
 
2549
2808
  api_instance = BudgeaClient::DocumentsApi.new
2550
2809
 
@@ -2607,7 +2866,7 @@ Name | Type | Description | Notes
2607
2866
 
2608
2867
  ### Authorization
2609
2868
 
2610
- No authorization required
2869
+ [api_key](../README.md#api_key)
2611
2870
 
2612
2871
  ### HTTP request headers
2613
2872
 
@@ -2627,6 +2886,13 @@ Add a new document<br><br>
2627
2886
  ```ruby
2628
2887
  # load the gem
2629
2888
  require 'budgea_client'
2889
+ # setup authorization
2890
+ BudgeaClient.configure do |config|
2891
+ # Configure API key authorization: api_key
2892
+ config.api_key['Authorization'] = 'YOUR API KEY'
2893
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2894
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2895
+ end
2630
2896
 
2631
2897
  api_instance = BudgeaClient::DocumentsApi.new
2632
2898
 
@@ -2690,7 +2956,7 @@ Name | Type | Description | Notes
2690
2956
 
2691
2957
  ### Authorization
2692
2958
 
2693
- No authorization required
2959
+ [api_key](../README.md#api_key)
2694
2960
 
2695
2961
  ### HTTP request headers
2696
2962
 
@@ -2710,6 +2976,13 @@ Attach an existing document to a transaction or a transactions_cluster
2710
2976
  ```ruby
2711
2977
  # load the gem
2712
2978
  require 'budgea_client'
2979
+ # setup authorization
2980
+ BudgeaClient.configure do |config|
2981
+ # Configure API key authorization: api_key
2982
+ config.api_key['Authorization'] = 'YOUR API KEY'
2983
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2984
+ #config.api_key_prefix['Authorization'] = 'Bearer'
2985
+ end
2713
2986
 
2714
2987
  api_instance = BudgeaClient::DocumentsApi.new
2715
2988
 
@@ -2750,7 +3023,7 @@ Name | Type | Description | Notes
2750
3023
 
2751
3024
  ### Authorization
2752
3025
 
2753
- No authorization required
3026
+ [api_key](../README.md#api_key)
2754
3027
 
2755
3028
  ### HTTP request headers
2756
3029
 
@@ -2770,6 +3043,13 @@ Delete documents
2770
3043
  ```ruby
2771
3044
  # load the gem
2772
3045
  require 'budgea_client'
3046
+ # setup authorization
3047
+ BudgeaClient.configure do |config|
3048
+ # Configure API key authorization: api_key
3049
+ config.api_key['Authorization'] = 'YOUR API KEY'
3050
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3051
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3052
+ end
2773
3053
 
2774
3054
  api_instance = BudgeaClient::DocumentsApi.new
2775
3055
 
@@ -2807,7 +3087,7 @@ Name | Type | Description | Notes
2807
3087
 
2808
3088
  ### Authorization
2809
3089
 
2810
- No authorization required
3090
+ [api_key](../README.md#api_key)
2811
3091
 
2812
3092
  ### HTTP request headers
2813
3093
 
@@ -2827,6 +3107,13 @@ Get list of documents<br><br>
2827
3107
  ```ruby
2828
3108
  # load the gem
2829
3109
  require 'budgea_client'
3110
+ # setup authorization
3111
+ BudgeaClient.configure do |config|
3112
+ # Configure API key authorization: api_key
3113
+ config.api_key['Authorization'] = 'YOUR API KEY'
3114
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3115
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3116
+ end
2830
3117
 
2831
3118
  api_instance = BudgeaClient::DocumentsApi.new
2832
3119
 
@@ -2882,7 +3169,7 @@ Name | Type | Description | Notes
2882
3169
 
2883
3170
  ### Authorization
2884
3171
 
2885
- No authorization required
3172
+ [api_key](../README.md#api_key)
2886
3173
 
2887
3174
  ### HTTP request headers
2888
3175
 
@@ -2902,6 +3189,13 @@ Delete a document
2902
3189
  ```ruby
2903
3190
  # load the gem
2904
3191
  require 'budgea_client'
3192
+ # setup authorization
3193
+ BudgeaClient.configure do |config|
3194
+ # Configure API key authorization: api_key
3195
+ config.api_key['Authorization'] = 'YOUR API KEY'
3196
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3197
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3198
+ end
2905
3199
 
2906
3200
  api_instance = BudgeaClient::DocumentsApi.new
2907
3201
 
@@ -2942,7 +3236,7 @@ Name | Type | Description | Notes
2942
3236
 
2943
3237
  ### Authorization
2944
3238
 
2945
- No authorization required
3239
+ [api_key](../README.md#api_key)
2946
3240
 
2947
3241
  ### HTTP request headers
2948
3242
 
@@ -2962,6 +3256,13 @@ Edit meta-data of a specific document.
2962
3256
  ```ruby
2963
3257
  # load the gem
2964
3258
  require 'budgea_client'
3259
+ # setup authorization
3260
+ BudgeaClient.configure do |config|
3261
+ # Configure API key authorization: api_key
3262
+ config.api_key['Authorization'] = 'YOUR API KEY'
3263
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3264
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3265
+ end
2965
3266
 
2966
3267
  api_instance = BudgeaClient::DocumentsApi.new
2967
3268
 
@@ -3024,7 +3325,7 @@ Name | Type | Description | Notes
3024
3325
 
3025
3326
  ### Authorization
3026
3327
 
3027
- No authorization required
3328
+ [api_key](../README.md#api_key)
3028
3329
 
3029
3330
  ### HTTP request headers
3030
3331
 
@@ -3044,6 +3345,13 @@ Add a new document<br><br>
3044
3345
  ```ruby
3045
3346
  # load the gem
3046
3347
  require 'budgea_client'
3348
+ # setup authorization
3349
+ BudgeaClient.configure do |config|
3350
+ # Configure API key authorization: api_key
3351
+ config.api_key['Authorization'] = 'YOUR API KEY'
3352
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3353
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3354
+ end
3047
3355
 
3048
3356
  api_instance = BudgeaClient::DocumentsApi.new
3049
3357
 
@@ -3107,7 +3415,7 @@ Name | Type | Description | Notes
3107
3415
 
3108
3416
  ### Authorization
3109
3417
 
3110
- No authorization required
3418
+ [api_key](../README.md#api_key)
3111
3419
 
3112
3420
  ### HTTP request headers
3113
3421
 
@@ -3127,6 +3435,13 @@ Attach an existing document to a transaction or a transactions_cluster
3127
3435
  ```ruby
3128
3436
  # load the gem
3129
3437
  require 'budgea_client'
3438
+ # setup authorization
3439
+ BudgeaClient.configure do |config|
3440
+ # Configure API key authorization: api_key
3441
+ config.api_key['Authorization'] = 'YOUR API KEY'
3442
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3443
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3444
+ end
3130
3445
 
3131
3446
  api_instance = BudgeaClient::DocumentsApi.new
3132
3447
 
@@ -3167,7 +3482,7 @@ Name | Type | Description | Notes
3167
3482
 
3168
3483
  ### Authorization
3169
3484
 
3170
- No authorization required
3485
+ [api_key](../README.md#api_key)
3171
3486
 
3172
3487
  ### HTTP request headers
3173
3488
 
@@ -3187,6 +3502,13 @@ Delete documents
3187
3502
  ```ruby
3188
3503
  # load the gem
3189
3504
  require 'budgea_client'
3505
+ # setup authorization
3506
+ BudgeaClient.configure do |config|
3507
+ # Configure API key authorization: api_key
3508
+ config.api_key['Authorization'] = 'YOUR API KEY'
3509
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3510
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3511
+ end
3190
3512
 
3191
3513
  api_instance = BudgeaClient::DocumentsApi.new
3192
3514
 
@@ -3224,7 +3546,7 @@ Name | Type | Description | Notes
3224
3546
 
3225
3547
  ### Authorization
3226
3548
 
3227
- No authorization required
3549
+ [api_key](../README.md#api_key)
3228
3550
 
3229
3551
  ### HTTP request headers
3230
3552
 
@@ -3244,6 +3566,13 @@ Get list of documents<br><br>
3244
3566
  ```ruby
3245
3567
  # load the gem
3246
3568
  require 'budgea_client'
3569
+ # setup authorization
3570
+ BudgeaClient.configure do |config|
3571
+ # Configure API key authorization: api_key
3572
+ config.api_key['Authorization'] = 'YOUR API KEY'
3573
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3574
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3575
+ end
3247
3576
 
3248
3577
  api_instance = BudgeaClient::DocumentsApi.new
3249
3578
 
@@ -3299,7 +3628,7 @@ Name | Type | Description | Notes
3299
3628
 
3300
3629
  ### Authorization
3301
3630
 
3302
- No authorization required
3631
+ [api_key](../README.md#api_key)
3303
3632
 
3304
3633
  ### HTTP request headers
3305
3634
 
@@ -3319,6 +3648,13 @@ Delete a document
3319
3648
  ```ruby
3320
3649
  # load the gem
3321
3650
  require 'budgea_client'
3651
+ # setup authorization
3652
+ BudgeaClient.configure do |config|
3653
+ # Configure API key authorization: api_key
3654
+ config.api_key['Authorization'] = 'YOUR API KEY'
3655
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3656
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3657
+ end
3322
3658
 
3323
3659
  api_instance = BudgeaClient::DocumentsApi.new
3324
3660
 
@@ -3359,7 +3695,7 @@ Name | Type | Description | Notes
3359
3695
 
3360
3696
  ### Authorization
3361
3697
 
3362
- No authorization required
3698
+ [api_key](../README.md#api_key)
3363
3699
 
3364
3700
  ### HTTP request headers
3365
3701
 
@@ -3379,6 +3715,13 @@ Edit meta-data of a specific document.
3379
3715
  ```ruby
3380
3716
  # load the gem
3381
3717
  require 'budgea_client'
3718
+ # setup authorization
3719
+ BudgeaClient.configure do |config|
3720
+ # Configure API key authorization: api_key
3721
+ config.api_key['Authorization'] = 'YOUR API KEY'
3722
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3723
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3724
+ end
3382
3725
 
3383
3726
  api_instance = BudgeaClient::DocumentsApi.new
3384
3727
 
@@ -3441,7 +3784,7 @@ Name | Type | Description | Notes
3441
3784
 
3442
3785
  ### Authorization
3443
3786
 
3444
- No authorization required
3787
+ [api_key](../README.md#api_key)
3445
3788
 
3446
3789
  ### HTTP request headers
3447
3790
 
@@ -3461,6 +3804,13 @@ Add a new document<br><br>
3461
3804
  ```ruby
3462
3805
  # load the gem
3463
3806
  require 'budgea_client'
3807
+ # setup authorization
3808
+ BudgeaClient.configure do |config|
3809
+ # Configure API key authorization: api_key
3810
+ config.api_key['Authorization'] = 'YOUR API KEY'
3811
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3812
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3813
+ end
3464
3814
 
3465
3815
  api_instance = BudgeaClient::DocumentsApi.new
3466
3816
 
@@ -3524,7 +3874,7 @@ Name | Type | Description | Notes
3524
3874
 
3525
3875
  ### Authorization
3526
3876
 
3527
- No authorization required
3877
+ [api_key](../README.md#api_key)
3528
3878
 
3529
3879
  ### HTTP request headers
3530
3880
 
@@ -3544,6 +3894,13 @@ Attach an existing document to a transaction or a transactions_cluster
3544
3894
  ```ruby
3545
3895
  # load the gem
3546
3896
  require 'budgea_client'
3897
+ # setup authorization
3898
+ BudgeaClient.configure do |config|
3899
+ # Configure API key authorization: api_key
3900
+ config.api_key['Authorization'] = 'YOUR API KEY'
3901
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3902
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3903
+ end
3547
3904
 
3548
3905
  api_instance = BudgeaClient::DocumentsApi.new
3549
3906
 
@@ -3584,7 +3941,7 @@ Name | Type | Description | Notes
3584
3941
 
3585
3942
  ### Authorization
3586
3943
 
3587
- No authorization required
3944
+ [api_key](../README.md#api_key)
3588
3945
 
3589
3946
  ### HTTP request headers
3590
3947
 
@@ -3604,6 +3961,13 @@ Delete documents
3604
3961
  ```ruby
3605
3962
  # load the gem
3606
3963
  require 'budgea_client'
3964
+ # setup authorization
3965
+ BudgeaClient.configure do |config|
3966
+ # Configure API key authorization: api_key
3967
+ config.api_key['Authorization'] = 'YOUR API KEY'
3968
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
3969
+ #config.api_key_prefix['Authorization'] = 'Bearer'
3970
+ end
3607
3971
 
3608
3972
  api_instance = BudgeaClient::DocumentsApi.new
3609
3973
 
@@ -3635,7 +3999,7 @@ Name | Type | Description | Notes
3635
3999
 
3636
4000
  ### Authorization
3637
4001
 
3638
- No authorization required
4002
+ [api_key](../README.md#api_key)
3639
4003
 
3640
4004
  ### HTTP request headers
3641
4005
 
@@ -3655,6 +4019,13 @@ Get list of documents<br><br>
3655
4019
  ```ruby
3656
4020
  # load the gem
3657
4021
  require 'budgea_client'
4022
+ # setup authorization
4023
+ BudgeaClient.configure do |config|
4024
+ # Configure API key authorization: api_key
4025
+ config.api_key['Authorization'] = 'YOUR API KEY'
4026
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4027
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4028
+ end
3658
4029
 
3659
4030
  api_instance = BudgeaClient::DocumentsApi.new
3660
4031
 
@@ -3704,7 +4075,7 @@ Name | Type | Description | Notes
3704
4075
 
3705
4076
  ### Authorization
3706
4077
 
3707
- No authorization required
4078
+ [api_key](../README.md#api_key)
3708
4079
 
3709
4080
  ### HTTP request headers
3710
4081
 
@@ -3724,6 +4095,13 @@ Delete a document
3724
4095
  ```ruby
3725
4096
  # load the gem
3726
4097
  require 'budgea_client'
4098
+ # setup authorization
4099
+ BudgeaClient.configure do |config|
4100
+ # Configure API key authorization: api_key
4101
+ config.api_key['Authorization'] = 'YOUR API KEY'
4102
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4103
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4104
+ end
3727
4105
 
3728
4106
  api_instance = BudgeaClient::DocumentsApi.new
3729
4107
 
@@ -3758,7 +4136,7 @@ Name | Type | Description | Notes
3758
4136
 
3759
4137
  ### Authorization
3760
4138
 
3761
- No authorization required
4139
+ [api_key](../README.md#api_key)
3762
4140
 
3763
4141
  ### HTTP request headers
3764
4142
 
@@ -3778,6 +4156,13 @@ Edit meta-data of a specific document.
3778
4156
  ```ruby
3779
4157
  # load the gem
3780
4158
  require 'budgea_client'
4159
+ # setup authorization
4160
+ BudgeaClient.configure do |config|
4161
+ # Configure API key authorization: api_key
4162
+ config.api_key['Authorization'] = 'YOUR API KEY'
4163
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4164
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4165
+ end
3781
4166
 
3782
4167
  api_instance = BudgeaClient::DocumentsApi.new
3783
4168
 
@@ -3834,7 +4219,7 @@ Name | Type | Description | Notes
3834
4219
 
3835
4220
  ### Authorization
3836
4221
 
3837
- No authorization required
4222
+ [api_key](../README.md#api_key)
3838
4223
 
3839
4224
  ### HTTP request headers
3840
4225
 
@@ -3854,6 +4239,13 @@ Add a new document<br><br>
3854
4239
  ```ruby
3855
4240
  # load the gem
3856
4241
  require 'budgea_client'
4242
+ # setup authorization
4243
+ BudgeaClient.configure do |config|
4244
+ # Configure API key authorization: api_key
4245
+ config.api_key['Authorization'] = 'YOUR API KEY'
4246
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4247
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4248
+ end
3857
4249
 
3858
4250
  api_instance = BudgeaClient::DocumentsApi.new
3859
4251
 
@@ -3911,7 +4303,7 @@ Name | Type | Description | Notes
3911
4303
 
3912
4304
  ### Authorization
3913
4305
 
3914
- No authorization required
4306
+ [api_key](../README.md#api_key)
3915
4307
 
3916
4308
  ### HTTP request headers
3917
4309
 
@@ -3931,6 +4323,13 @@ Attach an existing document to a transaction or a transactions_cluster
3931
4323
  ```ruby
3932
4324
  # load the gem
3933
4325
  require 'budgea_client'
4326
+ # setup authorization
4327
+ BudgeaClient.configure do |config|
4328
+ # Configure API key authorization: api_key
4329
+ config.api_key['Authorization'] = 'YOUR API KEY'
4330
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4331
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4332
+ end
3934
4333
 
3935
4334
  api_instance = BudgeaClient::DocumentsApi.new
3936
4335
 
@@ -3965,7 +4364,7 @@ Name | Type | Description | Notes
3965
4364
 
3966
4365
  ### Authorization
3967
4366
 
3968
- No authorization required
4367
+ [api_key](../README.md#api_key)
3969
4368
 
3970
4369
  ### HTTP request headers
3971
4370
 
@@ -3985,6 +4384,13 @@ Post an image and apply OCR on it to obtain found meta-data.<br><br>
3985
4384
  ```ruby
3986
4385
  # load the gem
3987
4386
  require 'budgea_client'
4387
+ # setup authorization
4388
+ BudgeaClient.configure do |config|
4389
+ # Configure API key authorization: api_key
4390
+ config.api_key['Authorization'] = 'YOUR API KEY'
4391
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4392
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4393
+ end
3988
4394
 
3989
4395
  api_instance = BudgeaClient::DocumentsApi.new
3990
4396
 
@@ -4020,7 +4426,7 @@ nil (empty response body)
4020
4426
 
4021
4427
  ### Authorization
4022
4428
 
4023
- No authorization required
4429
+ [api_key](../README.md#api_key)
4024
4430
 
4025
4431
  ### HTTP request headers
4026
4432
 
@@ -4040,6 +4446,13 @@ Delete documents
4040
4446
  ```ruby
4041
4447
  # load the gem
4042
4448
  require 'budgea_client'
4449
+ # setup authorization
4450
+ BudgeaClient.configure do |config|
4451
+ # Configure API key authorization: api_key
4452
+ config.api_key['Authorization'] = 'YOUR API KEY'
4453
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4454
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4455
+ end
4043
4456
 
4044
4457
  api_instance = BudgeaClient::DocumentsApi.new
4045
4458
 
@@ -4074,7 +4487,7 @@ Name | Type | Description | Notes
4074
4487
 
4075
4488
  ### Authorization
4076
4489
 
4077
- No authorization required
4490
+ [api_key](../README.md#api_key)
4078
4491
 
4079
4492
  ### HTTP request headers
4080
4493
 
@@ -4094,6 +4507,13 @@ Get list of documents<br><br>
4094
4507
  ```ruby
4095
4508
  # load the gem
4096
4509
  require 'budgea_client'
4510
+ # setup authorization
4511
+ BudgeaClient.configure do |config|
4512
+ # Configure API key authorization: api_key
4513
+ config.api_key['Authorization'] = 'YOUR API KEY'
4514
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4515
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4516
+ end
4097
4517
 
4098
4518
  api_instance = BudgeaClient::DocumentsApi.new
4099
4519
 
@@ -4146,7 +4566,7 @@ Name | Type | Description | Notes
4146
4566
 
4147
4567
  ### Authorization
4148
4568
 
4149
- No authorization required
4569
+ [api_key](../README.md#api_key)
4150
4570
 
4151
4571
  ### HTTP request headers
4152
4572
 
@@ -4166,6 +4586,13 @@ Delete a document
4166
4586
  ```ruby
4167
4587
  # load the gem
4168
4588
  require 'budgea_client'
4589
+ # setup authorization
4590
+ BudgeaClient.configure do |config|
4591
+ # Configure API key authorization: api_key
4592
+ config.api_key['Authorization'] = 'YOUR API KEY'
4593
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4594
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4595
+ end
4169
4596
 
4170
4597
  api_instance = BudgeaClient::DocumentsApi.new
4171
4598
 
@@ -4203,7 +4630,7 @@ Name | Type | Description | Notes
4203
4630
 
4204
4631
  ### Authorization
4205
4632
 
4206
- No authorization required
4633
+ [api_key](../README.md#api_key)
4207
4634
 
4208
4635
  ### HTTP request headers
4209
4636
 
@@ -4223,6 +4650,13 @@ Edit meta-data of a specific document.
4223
4650
  ```ruby
4224
4651
  # load the gem
4225
4652
  require 'budgea_client'
4653
+ # setup authorization
4654
+ BudgeaClient.configure do |config|
4655
+ # Configure API key authorization: api_key
4656
+ config.api_key['Authorization'] = 'YOUR API KEY'
4657
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4658
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4659
+ end
4226
4660
 
4227
4661
  api_instance = BudgeaClient::DocumentsApi.new
4228
4662
 
@@ -4282,7 +4716,7 @@ Name | Type | Description | Notes
4282
4716
 
4283
4717
  ### Authorization
4284
4718
 
4285
- No authorization required
4719
+ [api_key](../README.md#api_key)
4286
4720
 
4287
4721
  ### HTTP request headers
4288
4722
 
@@ -4302,6 +4736,13 @@ Add a new document<br><br>
4302
4736
  ```ruby
4303
4737
  # load the gem
4304
4738
  require 'budgea_client'
4739
+ # setup authorization
4740
+ BudgeaClient.configure do |config|
4741
+ # Configure API key authorization: api_key
4742
+ config.api_key['Authorization'] = 'YOUR API KEY'
4743
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4744
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4745
+ end
4305
4746
 
4306
4747
  api_instance = BudgeaClient::DocumentsApi.new
4307
4748
 
@@ -4362,7 +4803,7 @@ Name | Type | Description | Notes
4362
4803
 
4363
4804
  ### Authorization
4364
4805
 
4365
- No authorization required
4806
+ [api_key](../README.md#api_key)
4366
4807
 
4367
4808
  ### HTTP request headers
4368
4809
 
@@ -4382,6 +4823,13 @@ Attach an existing document to a transaction or a transactions_cluster
4382
4823
  ```ruby
4383
4824
  # load the gem
4384
4825
  require 'budgea_client'
4826
+ # setup authorization
4827
+ BudgeaClient.configure do |config|
4828
+ # Configure API key authorization: api_key
4829
+ config.api_key['Authorization'] = 'YOUR API KEY'
4830
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4831
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4832
+ end
4385
4833
 
4386
4834
  api_instance = BudgeaClient::DocumentsApi.new
4387
4835
 
@@ -4419,7 +4867,7 @@ Name | Type | Description | Notes
4419
4867
 
4420
4868
  ### Authorization
4421
4869
 
4422
- No authorization required
4870
+ [api_key](../README.md#api_key)
4423
4871
 
4424
4872
  ### HTTP request headers
4425
4873
 
@@ -4439,6 +4887,13 @@ Delete documents
4439
4887
  ```ruby
4440
4888
  # load the gem
4441
4889
  require 'budgea_client'
4890
+ # setup authorization
4891
+ BudgeaClient.configure do |config|
4892
+ # Configure API key authorization: api_key
4893
+ config.api_key['Authorization'] = 'YOUR API KEY'
4894
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4895
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4896
+ end
4442
4897
 
4443
4898
  api_instance = BudgeaClient::DocumentsApi.new
4444
4899
 
@@ -4473,7 +4928,7 @@ Name | Type | Description | Notes
4473
4928
 
4474
4929
  ### Authorization
4475
4930
 
4476
- No authorization required
4931
+ [api_key](../README.md#api_key)
4477
4932
 
4478
4933
  ### HTTP request headers
4479
4934
 
@@ -4493,6 +4948,13 @@ Get list of documents<br><br>
4493
4948
  ```ruby
4494
4949
  # load the gem
4495
4950
  require 'budgea_client'
4951
+ # setup authorization
4952
+ BudgeaClient.configure do |config|
4953
+ # Configure API key authorization: api_key
4954
+ config.api_key['Authorization'] = 'YOUR API KEY'
4955
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
4956
+ #config.api_key_prefix['Authorization'] = 'Bearer'
4957
+ end
4496
4958
 
4497
4959
  api_instance = BudgeaClient::DocumentsApi.new
4498
4960
 
@@ -4545,7 +5007,7 @@ Name | Type | Description | Notes
4545
5007
 
4546
5008
  ### Authorization
4547
5009
 
4548
- No authorization required
5010
+ [api_key](../README.md#api_key)
4549
5011
 
4550
5012
  ### HTTP request headers
4551
5013
 
@@ -4565,6 +5027,13 @@ Delete a document
4565
5027
  ```ruby
4566
5028
  # load the gem
4567
5029
  require 'budgea_client'
5030
+ # setup authorization
5031
+ BudgeaClient.configure do |config|
5032
+ # Configure API key authorization: api_key
5033
+ config.api_key['Authorization'] = 'YOUR API KEY'
5034
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5035
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5036
+ end
4568
5037
 
4569
5038
  api_instance = BudgeaClient::DocumentsApi.new
4570
5039
 
@@ -4602,7 +5071,7 @@ Name | Type | Description | Notes
4602
5071
 
4603
5072
  ### Authorization
4604
5073
 
4605
- No authorization required
5074
+ [api_key](../README.md#api_key)
4606
5075
 
4607
5076
  ### HTTP request headers
4608
5077
 
@@ -4622,6 +5091,13 @@ Edit meta-data of a specific document.
4622
5091
  ```ruby
4623
5092
  # load the gem
4624
5093
  require 'budgea_client'
5094
+ # setup authorization
5095
+ BudgeaClient.configure do |config|
5096
+ # Configure API key authorization: api_key
5097
+ config.api_key['Authorization'] = 'YOUR API KEY'
5098
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5099
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5100
+ end
4625
5101
 
4626
5102
  api_instance = BudgeaClient::DocumentsApi.new
4627
5103
 
@@ -4681,7 +5157,7 @@ Name | Type | Description | Notes
4681
5157
 
4682
5158
  ### Authorization
4683
5159
 
4684
- No authorization required
5160
+ [api_key](../README.md#api_key)
4685
5161
 
4686
5162
  ### HTTP request headers
4687
5163
 
@@ -4701,6 +5177,13 @@ Add a new document<br><br>
4701
5177
  ```ruby
4702
5178
  # load the gem
4703
5179
  require 'budgea_client'
5180
+ # setup authorization
5181
+ BudgeaClient.configure do |config|
5182
+ # Configure API key authorization: api_key
5183
+ config.api_key['Authorization'] = 'YOUR API KEY'
5184
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5185
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5186
+ end
4704
5187
 
4705
5188
  api_instance = BudgeaClient::DocumentsApi.new
4706
5189
 
@@ -4761,7 +5244,7 @@ Name | Type | Description | Notes
4761
5244
 
4762
5245
  ### Authorization
4763
5246
 
4764
- No authorization required
5247
+ [api_key](../README.md#api_key)
4765
5248
 
4766
5249
  ### HTTP request headers
4767
5250
 
@@ -4781,6 +5264,13 @@ Attach an existing document to a transaction or a transactions_cluster
4781
5264
  ```ruby
4782
5265
  # load the gem
4783
5266
  require 'budgea_client'
5267
+ # setup authorization
5268
+ BudgeaClient.configure do |config|
5269
+ # Configure API key authorization: api_key
5270
+ config.api_key['Authorization'] = 'YOUR API KEY'
5271
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5272
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5273
+ end
4784
5274
 
4785
5275
  api_instance = BudgeaClient::DocumentsApi.new
4786
5276
 
@@ -4818,7 +5308,7 @@ Name | Type | Description | Notes
4818
5308
 
4819
5309
  ### Authorization
4820
5310
 
4821
- No authorization required
5311
+ [api_key](../README.md#api_key)
4822
5312
 
4823
5313
  ### HTTP request headers
4824
5314
 
@@ -4838,6 +5328,13 @@ Delete documents
4838
5328
  ```ruby
4839
5329
  # load the gem
4840
5330
  require 'budgea_client'
5331
+ # setup authorization
5332
+ BudgeaClient.configure do |config|
5333
+ # Configure API key authorization: api_key
5334
+ config.api_key['Authorization'] = 'YOUR API KEY'
5335
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5336
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5337
+ end
4841
5338
 
4842
5339
  api_instance = BudgeaClient::DocumentsApi.new
4843
5340
 
@@ -4872,7 +5369,7 @@ Name | Type | Description | Notes
4872
5369
 
4873
5370
  ### Authorization
4874
5371
 
4875
- No authorization required
5372
+ [api_key](../README.md#api_key)
4876
5373
 
4877
5374
  ### HTTP request headers
4878
5375
 
@@ -4892,6 +5389,13 @@ Get list of documents<br><br>
4892
5389
  ```ruby
4893
5390
  # load the gem
4894
5391
  require 'budgea_client'
5392
+ # setup authorization
5393
+ BudgeaClient.configure do |config|
5394
+ # Configure API key authorization: api_key
5395
+ config.api_key['Authorization'] = 'YOUR API KEY'
5396
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5397
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5398
+ end
4895
5399
 
4896
5400
  api_instance = BudgeaClient::DocumentsApi.new
4897
5401
 
@@ -4944,7 +5448,7 @@ Name | Type | Description | Notes
4944
5448
 
4945
5449
  ### Authorization
4946
5450
 
4947
- No authorization required
5451
+ [api_key](../README.md#api_key)
4948
5452
 
4949
5453
  ### HTTP request headers
4950
5454
 
@@ -4964,6 +5468,13 @@ Delete a document
4964
5468
  ```ruby
4965
5469
  # load the gem
4966
5470
  require 'budgea_client'
5471
+ # setup authorization
5472
+ BudgeaClient.configure do |config|
5473
+ # Configure API key authorization: api_key
5474
+ config.api_key['Authorization'] = 'YOUR API KEY'
5475
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5476
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5477
+ end
4967
5478
 
4968
5479
  api_instance = BudgeaClient::DocumentsApi.new
4969
5480
 
@@ -5001,7 +5512,7 @@ Name | Type | Description | Notes
5001
5512
 
5002
5513
  ### Authorization
5003
5514
 
5004
- No authorization required
5515
+ [api_key](../README.md#api_key)
5005
5516
 
5006
5517
  ### HTTP request headers
5007
5518
 
@@ -5021,6 +5532,13 @@ Edit meta-data of a specific document.
5021
5532
  ```ruby
5022
5533
  # load the gem
5023
5534
  require 'budgea_client'
5535
+ # setup authorization
5536
+ BudgeaClient.configure do |config|
5537
+ # Configure API key authorization: api_key
5538
+ config.api_key['Authorization'] = 'YOUR API KEY'
5539
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5540
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5541
+ end
5024
5542
 
5025
5543
  api_instance = BudgeaClient::DocumentsApi.new
5026
5544
 
@@ -5080,7 +5598,7 @@ Name | Type | Description | Notes
5080
5598
 
5081
5599
  ### Authorization
5082
5600
 
5083
- No authorization required
5601
+ [api_key](../README.md#api_key)
5084
5602
 
5085
5603
  ### HTTP request headers
5086
5604
 
@@ -5100,6 +5618,13 @@ Add a new document<br><br>
5100
5618
  ```ruby
5101
5619
  # load the gem
5102
5620
  require 'budgea_client'
5621
+ # setup authorization
5622
+ BudgeaClient.configure do |config|
5623
+ # Configure API key authorization: api_key
5624
+ config.api_key['Authorization'] = 'YOUR API KEY'
5625
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5626
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5627
+ end
5103
5628
 
5104
5629
  api_instance = BudgeaClient::DocumentsApi.new
5105
5630
 
@@ -5160,7 +5685,7 @@ Name | Type | Description | Notes
5160
5685
 
5161
5686
  ### Authorization
5162
5687
 
5163
- No authorization required
5688
+ [api_key](../README.md#api_key)
5164
5689
 
5165
5690
  ### HTTP request headers
5166
5691
 
@@ -5180,6 +5705,13 @@ Attach an existing document to a transaction or a transactions_cluster
5180
5705
  ```ruby
5181
5706
  # load the gem
5182
5707
  require 'budgea_client'
5708
+ # setup authorization
5709
+ BudgeaClient.configure do |config|
5710
+ # Configure API key authorization: api_key
5711
+ config.api_key['Authorization'] = 'YOUR API KEY'
5712
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
5713
+ #config.api_key_prefix['Authorization'] = 'Bearer'
5714
+ end
5183
5715
 
5184
5716
  api_instance = BudgeaClient::DocumentsApi.new
5185
5717
 
@@ -5217,7 +5749,7 @@ Name | Type | Description | Notes
5217
5749
 
5218
5750
  ### Authorization
5219
5751
 
5220
- No authorization required
5752
+ [api_key](../README.md#api_key)
5221
5753
 
5222
5754
  ### HTTP request headers
5223
5755