factpulse 4.0.2 → 4.0.3

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 (59) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -4
  3. data/Gemfile.lock +2 -2
  4. data/README.md +12 -0
  5. data/docs/AFNORPDPPAApi.md +9 -2
  6. data/docs/AsyncTasksApi.md +6 -1
  7. data/docs/ChorusProApi.md +96 -16
  8. data/docs/ClientManagementApi.md +359 -13
  9. data/docs/ConvertResumeRequest.md +5 -1
  10. data/docs/DownloadsApi.md +12 -2
  11. data/docs/ElectronicSignatureApi.md +24 -4
  12. data/docs/FacturXConversionApi.md +101 -4
  13. data/docs/FacturXGenerationApi.md +18 -3
  14. data/docs/FacturXPDFXMLVerificationApi.md +18 -3
  15. data/docs/FacturXValidationApi.md +18 -3
  16. data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
  17. data/docs/Flux10EReportingApi.md +36 -6
  18. data/docs/Flux6InvoiceLifecycleCDARApi.md +18 -3
  19. data/docs/HealthApi.md +6 -1
  20. data/docs/KeyRotationRequest.md +20 -0
  21. data/docs/KeyRotationResponse.md +24 -0
  22. data/docs/PDPConfigResponse.md +2 -0
  23. data/docs/PDPConfigUpdateRequest.md +3 -1
  24. data/docs/SecretStatus.md +5 -1
  25. data/docs/ValidateCDARResponse.md +2 -2
  26. data/docs/ValidationErrorResponse.md +8 -2
  27. data/docs/WebhookSecretDeleteResponse.md +20 -0
  28. data/docs/WebhookSecretGenerateResponse.md +24 -0
  29. data/docs/WebhookSecretStatusResponse.md +20 -0
  30. data/lib/factpulse/api/afnorpdppa_api.rb +4 -1
  31. data/lib/factpulse/api/async_tasks_api.rb +1 -1
  32. data/lib/factpulse/api/chorus_pro_api.rb +16 -16
  33. data/lib/factpulse/api/client_management_api.rb +276 -10
  34. data/lib/factpulse/api/downloads_api.rb +2 -2
  35. data/lib/factpulse/api/electronic_signature_api.rb +4 -4
  36. data/lib/factpulse/api/factur_x_conversion_api.rb +78 -4
  37. data/lib/factpulse/api/factur_x_generation_api.rb +3 -3
  38. data/lib/factpulse/api/factur_x_validation_api.rb +3 -3
  39. data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +3 -3
  40. data/lib/factpulse/api/flux10_e_reporting_api.rb +6 -6
  41. data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +3 -3
  42. data/lib/factpulse/api/health_api.rb +1 -1
  43. data/lib/factpulse/configuration.rb +7 -0
  44. data/lib/factpulse/models/convert_resume_request.rb +27 -5
  45. data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
  46. data/lib/factpulse/models/key_rotation_request.rb +211 -0
  47. data/lib/factpulse/models/key_rotation_response.rb +232 -0
  48. data/lib/factpulse/models/pdp_config_response.rb +11 -1
  49. data/lib/factpulse/models/pdp_config_update_request.rb +49 -5
  50. data/lib/factpulse/models/secret_status.rb +24 -4
  51. data/lib/factpulse/models/validate_cdar_response.rb +2 -2
  52. data/lib/factpulse/models/validation_error_response.rb +67 -20
  53. data/lib/factpulse/models/{facture_electronique_rest_api_schemas_cdar_validation_error_response.rb → webhook_secret_delete_response.rb} +25 -47
  54. data/lib/factpulse/models/webhook_secret_generate_response.rb +247 -0
  55. data/lib/factpulse/models/webhook_secret_status_response.rb +176 -0
  56. data/lib/factpulse/version.rb +1 -1
  57. data/lib/factpulse.rb +6 -1
  58. metadata +14 -4
  59. data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +0 -24
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ed5220794155d6c2396f8f0d804472921e343e24de4da8a14e39e4635ab3140c
4
- data.tar.gz: 4e967d6bd2992759be3e9c26e35f78832fb033c84b676166507ecf434d857b7a
3
+ metadata.gz: 96e2ad7479a61507f6da1c0b8f08e041067ea950efa62524278c45bfba813b54
4
+ data.tar.gz: 42c166ea2d80ce759f9d16f939a0a0d9fef31bcaff1b2b0b958483edb261b7d2
5
5
  SHA512:
6
- metadata.gz: 24aee2a48d55854a1695d7e4602f05ae00da5f31e567657b3c168610299ee4640594c448e6c4f8f99a87da7308c98e2345bd02e4e9ca7c348afaa345bc717acc
7
- data.tar.gz: 1c3ece1e7befab53f5998e15a469064262e9e6aceabe3a7012c4fa478a46309ad9cfb9c966f04141b881c2d43b020d468ebea1d8f5eff412c1cfdcccbcddc6fa
6
+ metadata.gz: 6fc016dddf8fdd97d0ef18945ecea58130bbcf4204b75da9dce978e8d23f912dc3cde7da9c08aa90ddc42182ed1fe36847a52f3935d99c037048b7ad12ccbbb1
7
+ data.tar.gz: efcc9a1a9597989f737861407e9418a78e94bbae5cfffd12337382b0048755b0613ffce91599d2829832c05dd796838d4c07927a7a18a4c8f65245a6dfd5cd73
data/CHANGELOG.md CHANGED
@@ -7,11 +7,11 @@ et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7
7
 
8
8
  ## [Unreleased]
9
9
 
10
- ## [4.0.2] - 2026-01-24
10
+ ## [4.0.3] - 2026-02-06
11
11
 
12
12
  ### Fixed
13
- - Meilleures conformité validation/génération erportings
13
+ - gestion des numéros de versions lors de la publication...
14
14
 
15
15
 
16
- [Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v4.0.2...HEAD
17
- [4.0.2]: https://github.com/factpulse/sdk-ruby/releases/tag/v4.0.2
16
+ [Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v4.0.3...HEAD
17
+ [4.0.3]: https://github.com/factpulse/sdk-ruby/releases/tag/v4.0.3
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- factpulse (4.0.2)
4
+ factpulse (4.0.3)
5
5
  typhoeus (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
@@ -45,7 +45,7 @@ GEM
45
45
  rspec-mocks (3.13.7)
46
46
  diff-lcs (>= 1.2.0, < 2.0)
47
47
  rspec-support (~> 3.13.0)
48
- rspec-support (3.13.6)
48
+ rspec-support (3.13.7)
49
49
  rubocop (0.66.0)
50
50
  jaro_winkler (~> 1.5.1)
51
51
  parallel (~> 1.10)
data/README.md CHANGED
@@ -43,11 +43,13 @@ result = client.post('processing/invoices/submit-complete-async',
43
43
  invoiceData: {
44
44
  number: 'INV-2025-001',
45
45
  supplier: {
46
+ name: 'ACME Corporation',
46
47
  siret: '12345678901234',
47
48
  iban: 'FR7630001007941234567890185',
48
49
  routing_address: '12345678901234'
49
50
  },
50
51
  recipient: {
52
+ name: 'Client Company SA',
51
53
  siret: '98765432109876',
52
54
  routing_address: '98765432109876'
53
55
  },
@@ -198,6 +200,16 @@ rescue FactPulse::Error => e
198
200
  end
199
201
  ```
200
202
 
203
+ ## Available Helpers
204
+
205
+ The SDK provides the following helper classes:
206
+
207
+ - `FactPulse::Client`: Main HTTP client with auto-auth and polling
208
+ - `FactPulse::Error`: Base exception class
209
+ - `FactPulse::AuthError`: Authentication failure
210
+ - `FactPulse::ValidationError`: Validation errors with details
211
+ - `FactPulse::PollingTimeout`: Task polling timeout
212
+
201
213
  ## Resources
202
214
 
203
215
  - **API Documentation**: https://factpulse.fr/api/facturation/documentation
@@ -23,6 +23,11 @@ require 'time'
23
23
  require 'factpulse'
24
24
  # setup authorization
25
25
  FactPulse.configure do |config|
26
+ # Configure API key authorization: APIKeyHeader
27
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
30
+
26
31
  # Configure Bearer authorization: HTTPBearer
27
32
  config.access_token = 'YOUR_BEARER_TOKEN'
28
33
  end
@@ -30,7 +35,8 @@ end
30
35
  api_instance = FactPulse::AFNORPDPPAApi.new
31
36
  flow_id = 'flow_id_example' # String | AFNOR flow ID (UUID format)
32
37
  opts = {
33
- include_document: true # Boolean | Include base64-encoded document in response
38
+ include_document: true, # Boolean | Include base64-encoded document in response
39
+ x_encryption_key: 'x_encryption_key_example' # String | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode='double'.
34
40
  }
35
41
 
36
42
  begin
@@ -66,6 +72,7 @@ end
66
72
  | ---- | ---- | ----------- | ----- |
67
73
  | **flow_id** | **String** | AFNOR flow ID (UUID format) | |
68
74
  | **include_document** | **Boolean** | Include base64-encoded document in response | [optional][default to false] |
75
+ | **x_encryption_key** | **String** | Client encryption key for double encryption mode. Must be a base64-encoded AES-256 key (32 bytes). Required only when accessing resources encrypted with encryption_mode&#x3D;&#39;double&#39;. | [optional] |
69
76
 
70
77
  ### Return type
71
78
 
@@ -73,7 +80,7 @@ end
73
80
 
74
81
  ### Authorization
75
82
 
76
- [HTTPBearer](../README.md#HTTPBearer)
83
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
77
84
 
78
85
  ### HTTP request headers
79
86
 
@@ -22,6 +22,11 @@ require 'time'
22
22
  require 'factpulse'
23
23
  # setup authorization
24
24
  FactPulse.configure do |config|
25
+ # Configure API key authorization: APIKeyHeader
26
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
27
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
29
+
25
30
  # Configure Bearer authorization: HTTPBearer
26
31
  config.access_token = 'YOUR_BEARER_TOKEN'
27
32
  end
@@ -68,7 +73,7 @@ end
68
73
 
69
74
  ### Authorization
70
75
 
71
- [HTTPBearer](../README.md#HTTPBearer)
76
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
72
77
 
73
78
  ### HTTP request headers
74
79
 
data/docs/ChorusProApi.md CHANGED
@@ -37,6 +37,11 @@ require 'time'
37
37
  require 'factpulse'
38
38
  # setup authorization
39
39
  FactPulse.configure do |config|
40
+ # Configure API key authorization: APIKeyHeader
41
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
42
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
43
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
44
+
40
45
  # Configure Bearer authorization: HTTPBearer
41
46
  config.access_token = 'YOUR_BEARER_TOKEN'
42
47
  end
@@ -83,7 +88,7 @@ end
83
88
 
84
89
  ### Authorization
85
90
 
86
- [HTTPBearer](../README.md#HTTPBearer)
91
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
87
92
 
88
93
  ### HTTP request headers
89
94
 
@@ -106,6 +111,11 @@ require 'time'
106
111
  require 'factpulse'
107
112
  # setup authorization
108
113
  FactPulse.configure do |config|
114
+ # Configure API key authorization: APIKeyHeader
115
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
116
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
117
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
118
+
109
119
  # Configure Bearer authorization: HTTPBearer
110
120
  config.access_token = 'YOUR_BEARER_TOKEN'
111
121
  end
@@ -152,7 +162,7 @@ end
152
162
 
153
163
  ### Authorization
154
164
 
155
- [HTTPBearer](../README.md#HTTPBearer)
165
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
156
166
 
157
167
  ### HTTP request headers
158
168
 
@@ -175,6 +185,11 @@ require 'time'
175
185
  require 'factpulse'
176
186
  # setup authorization
177
187
  FactPulse.configure do |config|
188
+ # Configure API key authorization: APIKeyHeader
189
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
190
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
191
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
192
+
178
193
  # Configure Bearer authorization: HTTPBearer
179
194
  config.access_token = 'YOUR_BEARER_TOKEN'
180
195
  end
@@ -221,7 +236,7 @@ end
221
236
 
222
237
  ### Authorization
223
238
 
224
- [HTTPBearer](../README.md#HTTPBearer)
239
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
225
240
 
226
241
  ### HTTP request headers
227
242
 
@@ -244,6 +259,11 @@ require 'time'
244
259
  require 'factpulse'
245
260
  # setup authorization
246
261
  FactPulse.configure do |config|
262
+ # Configure API key authorization: APIKeyHeader
263
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
264
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
265
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
266
+
247
267
  # Configure Bearer authorization: HTTPBearer
248
268
  config.access_token = 'YOUR_BEARER_TOKEN'
249
269
  end
@@ -290,7 +310,7 @@ end
290
310
 
291
311
  ### Authorization
292
312
 
293
- [HTTPBearer](../README.md#HTTPBearer)
313
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
294
314
 
295
315
  ### HTTP request headers
296
316
 
@@ -313,6 +333,11 @@ require 'time'
313
333
  require 'factpulse'
314
334
  # setup authorization
315
335
  FactPulse.configure do |config|
336
+ # Configure API key authorization: APIKeyHeader
337
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
340
+
316
341
  # Configure Bearer authorization: HTTPBearer
317
342
  config.access_token = 'YOUR_BEARER_TOKEN'
318
343
  end
@@ -359,7 +384,7 @@ end
359
384
 
360
385
  ### Authorization
361
386
 
362
- [HTTPBearer](../README.md#HTTPBearer)
387
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
363
388
 
364
389
  ### HTTP request headers
365
390
 
@@ -382,6 +407,11 @@ require 'time'
382
407
  require 'factpulse'
383
408
  # setup authorization
384
409
  FactPulse.configure do |config|
410
+ # Configure API key authorization: APIKeyHeader
411
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
412
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
413
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
414
+
385
415
  # Configure Bearer authorization: HTTPBearer
386
416
  config.access_token = 'YOUR_BEARER_TOKEN'
387
417
  end
@@ -428,7 +458,7 @@ end
428
458
 
429
459
  ### Authorization
430
460
 
431
- [HTTPBearer](../README.md#HTTPBearer)
461
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
432
462
 
433
463
  ### HTTP request headers
434
464
 
@@ -451,6 +481,11 @@ require 'time'
451
481
  require 'factpulse'
452
482
  # setup authorization
453
483
  FactPulse.configure do |config|
484
+ # Configure API key authorization: APIKeyHeader
485
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
486
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
487
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
488
+
454
489
  # Configure Bearer authorization: HTTPBearer
455
490
  config.access_token = 'YOUR_BEARER_TOKEN'
456
491
  end
@@ -497,7 +532,7 @@ end
497
532
 
498
533
  ### Authorization
499
534
 
500
- [HTTPBearer](../README.md#HTTPBearer)
535
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
501
536
 
502
537
  ### HTTP request headers
503
538
 
@@ -520,6 +555,11 @@ require 'time'
520
555
  require 'factpulse'
521
556
  # setup authorization
522
557
  FactPulse.configure do |config|
558
+ # Configure API key authorization: APIKeyHeader
559
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
560
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
561
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
562
+
523
563
  # Configure Bearer authorization: HTTPBearer
524
564
  config.access_token = 'YOUR_BEARER_TOKEN'
525
565
  end
@@ -566,7 +606,7 @@ end
566
606
 
567
607
  ### Authorization
568
608
 
569
- [HTTPBearer](../README.md#HTTPBearer)
609
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
570
610
 
571
611
  ### HTTP request headers
572
612
 
@@ -589,6 +629,11 @@ require 'time'
589
629
  require 'factpulse'
590
630
  # setup authorization
591
631
  FactPulse.configure do |config|
632
+ # Configure API key authorization: APIKeyHeader
633
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
634
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
635
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
636
+
592
637
  # Configure Bearer authorization: HTTPBearer
593
638
  config.access_token = 'YOUR_BEARER_TOKEN'
594
639
  end
@@ -635,7 +680,7 @@ end
635
680
 
636
681
  ### Authorization
637
682
 
638
- [HTTPBearer](../README.md#HTTPBearer)
683
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
639
684
 
640
685
  ### HTTP request headers
641
686
 
@@ -658,6 +703,11 @@ require 'time'
658
703
  require 'factpulse'
659
704
  # setup authorization
660
705
  FactPulse.configure do |config|
706
+ # Configure API key authorization: APIKeyHeader
707
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
708
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
709
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
710
+
661
711
  # Configure Bearer authorization: HTTPBearer
662
712
  config.access_token = 'YOUR_BEARER_TOKEN'
663
713
  end
@@ -704,7 +754,7 @@ end
704
754
 
705
755
  ### Authorization
706
756
 
707
- [HTTPBearer](../README.md#HTTPBearer)
757
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
708
758
 
709
759
  ### HTTP request headers
710
760
 
@@ -727,6 +777,11 @@ require 'time'
727
777
  require 'factpulse'
728
778
  # setup authorization
729
779
  FactPulse.configure do |config|
780
+ # Configure API key authorization: APIKeyHeader
781
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
782
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
783
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
784
+
730
785
  # Configure Bearer authorization: HTTPBearer
731
786
  config.access_token = 'YOUR_BEARER_TOKEN'
732
787
  end
@@ -773,7 +828,7 @@ end
773
828
 
774
829
  ### Authorization
775
830
 
776
- [HTTPBearer](../README.md#HTTPBearer)
831
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
777
832
 
778
833
  ### HTTP request headers
779
834
 
@@ -796,6 +851,11 @@ require 'time'
796
851
  require 'factpulse'
797
852
  # setup authorization
798
853
  FactPulse.configure do |config|
854
+ # Configure API key authorization: APIKeyHeader
855
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
856
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
857
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
858
+
799
859
  # Configure Bearer authorization: HTTPBearer
800
860
  config.access_token = 'YOUR_BEARER_TOKEN'
801
861
  end
@@ -842,7 +902,7 @@ end
842
902
 
843
903
  ### Authorization
844
904
 
845
- [HTTPBearer](../README.md#HTTPBearer)
905
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
846
906
 
847
907
  ### HTTP request headers
848
908
 
@@ -865,6 +925,11 @@ require 'time'
865
925
  require 'factpulse'
866
926
  # setup authorization
867
927
  FactPulse.configure do |config|
928
+ # Configure API key authorization: APIKeyHeader
929
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
930
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
931
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
932
+
868
933
  # Configure Bearer authorization: HTTPBearer
869
934
  config.access_token = 'YOUR_BEARER_TOKEN'
870
935
  end
@@ -911,7 +976,7 @@ end
911
976
 
912
977
  ### Authorization
913
978
 
914
- [HTTPBearer](../README.md#HTTPBearer)
979
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
915
980
 
916
981
  ### HTTP request headers
917
982
 
@@ -934,6 +999,11 @@ require 'time'
934
999
  require 'factpulse'
935
1000
  # setup authorization
936
1001
  FactPulse.configure do |config|
1002
+ # Configure API key authorization: APIKeyHeader
1003
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1004
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1005
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1006
+
937
1007
  # Configure Bearer authorization: HTTPBearer
938
1008
  config.access_token = 'YOUR_BEARER_TOKEN'
939
1009
  end
@@ -980,7 +1050,7 @@ end
980
1050
 
981
1051
  ### Authorization
982
1052
 
983
- [HTTPBearer](../README.md#HTTPBearer)
1053
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
984
1054
 
985
1055
  ### HTTP request headers
986
1056
 
@@ -1003,6 +1073,11 @@ require 'time'
1003
1073
  require 'factpulse'
1004
1074
  # setup authorization
1005
1075
  FactPulse.configure do |config|
1076
+ # Configure API key authorization: APIKeyHeader
1077
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1078
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1079
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1080
+
1006
1081
  # Configure Bearer authorization: HTTPBearer
1007
1082
  config.access_token = 'YOUR_BEARER_TOKEN'
1008
1083
  end
@@ -1049,7 +1124,7 @@ end
1049
1124
 
1050
1125
  ### Authorization
1051
1126
 
1052
- [HTTPBearer](../README.md#HTTPBearer)
1127
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
1053
1128
 
1054
1129
  ### HTTP request headers
1055
1130
 
@@ -1072,6 +1147,11 @@ require 'time'
1072
1147
  require 'factpulse'
1073
1148
  # setup authorization
1074
1149
  FactPulse.configure do |config|
1150
+ # Configure API key authorization: APIKeyHeader
1151
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1152
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1153
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1154
+
1075
1155
  # Configure Bearer authorization: HTTPBearer
1076
1156
  config.access_token = 'YOUR_BEARER_TOKEN'
1077
1157
  end
@@ -1118,7 +1198,7 @@ end
1118
1198
 
1119
1199
  ### Authorization
1120
1200
 
1121
- [HTTPBearer](../README.md#HTTPBearer)
1201
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
1122
1202
 
1123
1203
  ### HTTP request headers
1124
1204