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
data/docs/FacturXConversionApi.md CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://factpulse.fr*
8
8
  | [**download_file_api_v1_convert_conversion_id_download_filename_get**](FacturXConversionApi.md#download_file_api_v1_convert_conversion_id_download_filename_get) | **GET** /api/v1/convert/{conversion_id}/download/{filename} | Download a generated file |
9
9
  | [**get_conversion_status_api_v1_convert_conversion_id_status_get**](FacturXConversionApi.md#get_conversion_status_api_v1_convert_conversion_id_status_get) | **GET** /api/v1/convert/{conversion_id}/status | Check conversion status |
10
10
  | [**resume_conversion_api_v1_convert_conversion_id_resume_post**](FacturXConversionApi.md#resume_conversion_api_v1_convert_conversion_id_resume_post) | **POST** /api/v1/convert/{conversion_id}/resume | Resume a conversion with corrections |
11
+ | [**resume_conversion_async_api_v1_convert_conversion_id_resume_async_post**](FacturXConversionApi.md#resume_conversion_async_api_v1_convert_conversion_id_resume_async_post) | **POST** /api/v1/convert/{conversion_id}/resume/async | Resume a conversion asynchronously |
11
12
 
12
13
 
13
14
  ## convert_document_async_api_v1_convert_async_post
@@ -25,6 +26,11 @@ require 'time'
25
26
  require 'factpulse'
26
27
  # setup authorization
27
28
  FactPulse.configure do |config|
29
+ # Configure API key authorization: APIKeyHeader
30
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
33
+
28
34
  # Configure Bearer authorization: HTTPBearer
29
35
  config.access_token = 'YOUR_BEARER_TOKEN'
30
36
  end
@@ -79,7 +85,7 @@ end
79
85
 
80
86
  ### Authorization
81
87
 
82
- [HTTPBearer](../README.md#HTTPBearer)
88
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
83
89
 
84
90
  ### HTTP request headers
85
91
 
@@ -102,6 +108,11 @@ require 'time'
102
108
  require 'factpulse'
103
109
  # setup authorization
104
110
  FactPulse.configure do |config|
111
+ # Configure API key authorization: APIKeyHeader
112
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
113
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
114
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
115
+
105
116
  # Configure Bearer authorization: HTTPBearer
106
117
  config.access_token = 'YOUR_BEARER_TOKEN'
107
118
  end
@@ -150,7 +161,7 @@ end
150
161
 
151
162
  ### Authorization
152
163
 
153
- [HTTPBearer](../README.md#HTTPBearer)
164
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
154
165
 
155
166
  ### HTTP request headers
156
167
 
@@ -173,6 +184,11 @@ require 'time'
173
184
  require 'factpulse'
174
185
  # setup authorization
175
186
  FactPulse.configure do |config|
187
+ # Configure API key authorization: APIKeyHeader
188
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
189
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
190
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
191
+
176
192
  # Configure Bearer authorization: HTTPBearer
177
193
  config.access_token = 'YOUR_BEARER_TOKEN'
178
194
  end
@@ -219,7 +235,7 @@ end
219
235
 
220
236
  ### Authorization
221
237
 
222
- [HTTPBearer](../README.md#HTTPBearer)
238
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
223
239
 
224
240
  ### HTTP request headers
225
241
 
@@ -242,6 +258,11 @@ require 'time'
242
258
  require 'factpulse'
243
259
  # setup authorization
244
260
  FactPulse.configure do |config|
261
+ # Configure API key authorization: APIKeyHeader
262
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
263
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
264
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
265
+
245
266
  # Configure Bearer authorization: HTTPBearer
246
267
  config.access_token = 'YOUR_BEARER_TOKEN'
247
268
  end
@@ -290,7 +311,83 @@ end
290
311
 
291
312
  ### Authorization
292
313
 
293
- [HTTPBearer](../README.md#HTTPBearer)
314
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
315
+
316
+ ### HTTP request headers
317
+
318
+ - **Content-Type**: application/json
319
+ - **Accept**: application/json
320
+
321
+
322
+ ## resume_conversion_async_api_v1_convert_conversion_id_resume_async_post
323
+
324
+ > Object resume_conversion_async_api_v1_convert_conversion_id_resume_async_post(conversion_id, convert_resume_request)
325
+
326
+ Resume a conversion asynchronously
327
+
328
+ Resume a conversion after completing missing data or correcting errors (async mode). The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery. ## Workflow 1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion ## Possible responses - **202**: Task accepted, processing - **404**: Conversion not found or expired
329
+
330
+ ### Examples
331
+
332
+ ```ruby
333
+ require 'time'
334
+ require 'factpulse'
335
+ # setup authorization
336
+ FactPulse.configure do |config|
337
+ # Configure API key authorization: APIKeyHeader
338
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
339
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
340
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
341
+
342
+ # Configure Bearer authorization: HTTPBearer
343
+ config.access_token = 'YOUR_BEARER_TOKEN'
344
+ end
345
+
346
+ api_instance = FactPulse::FacturXConversionApi.new
347
+ conversion_id = 'conversion_id_example' # String | Conversion ID returned by POST /convert (UUID format)
348
+ convert_resume_request = FactPulse::ConvertResumeRequest.new # ConvertResumeRequest |
349
+
350
+ begin
351
+ # Resume a conversion asynchronously
352
+ result = api_instance.resume_conversion_async_api_v1_convert_conversion_id_resume_async_post(conversion_id, convert_resume_request)
353
+ p result
354
+ rescue FactPulse::ApiError => e
355
+ puts "Error when calling FacturXConversionApi->resume_conversion_async_api_v1_convert_conversion_id_resume_async_post: #{e}"
356
+ end
357
+ ```
358
+
359
+ #### Using the resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info variant
360
+
361
+ This returns an Array which contains the response data, status code and headers.
362
+
363
+ > <Array(Object, Integer, Hash)> resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info(conversion_id, convert_resume_request)
364
+
365
+ ```ruby
366
+ begin
367
+ # Resume a conversion asynchronously
368
+ data, status_code, headers = api_instance.resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info(conversion_id, convert_resume_request)
369
+ p status_code # => 2xx
370
+ p headers # => { ... }
371
+ p data # => Object
372
+ rescue FactPulse::ApiError => e
373
+ puts "Error when calling FacturXConversionApi->resume_conversion_async_api_v1_convert_conversion_id_resume_async_post_with_http_info: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ | Name | Type | Description | Notes |
380
+ | ---- | ---- | ----------- | ----- |
381
+ | **conversion_id** | **String** | Conversion ID returned by POST /convert (UUID format) | |
382
+ | **convert_resume_request** | [**ConvertResumeRequest**](ConvertResumeRequest.md) | | |
383
+
384
+ ### Return type
385
+
386
+ **Object**
387
+
388
+ ### Authorization
389
+
390
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
294
391
 
295
392
  ### HTTP request headers
296
393
 
data/docs/FacturXGenerationApi.md CHANGED
@@ -24,6 +24,11 @@ require 'time'
24
24
  require 'factpulse'
25
25
  # setup authorization
26
26
  FactPulse.configure do |config|
27
+ # Configure API key authorization: APIKeyHeader
28
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
31
+
27
32
  # Configure Bearer authorization: HTTPBearer
28
33
  config.access_token = 'YOUR_BEARER_TOKEN'
29
34
  end
@@ -86,7 +91,7 @@ end
86
91
 
87
92
  ### Authorization
88
93
 
89
- [HTTPBearer](../README.md#HTTPBearer)
94
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
90
95
 
91
96
  ### HTTP request headers
92
97
 
@@ -109,6 +114,11 @@ require 'time'
109
114
  require 'factpulse'
110
115
  # setup authorization
111
116
  FactPulse.configure do |config|
117
+ # Configure API key authorization: APIKeyHeader
118
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
119
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
120
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
121
+
112
122
  # Configure Bearer authorization: HTTPBearer
113
123
  config.access_token = 'YOUR_BEARER_TOKEN'
114
124
  end
@@ -155,7 +165,7 @@ end
155
165
 
156
166
  ### Authorization
157
167
 
158
- [HTTPBearer](../README.md#HTTPBearer)
168
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
159
169
 
160
170
  ### HTTP request headers
161
171
 
@@ -178,6 +188,11 @@ require 'time'
178
188
  require 'factpulse'
179
189
  # setup authorization
180
190
  FactPulse.configure do |config|
191
+ # Configure API key authorization: APIKeyHeader
192
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
193
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
194
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
195
+
181
196
  # Configure Bearer authorization: HTTPBearer
182
197
  config.access_token = 'YOUR_BEARER_TOKEN'
183
198
  end
@@ -230,7 +245,7 @@ end
230
245
 
231
246
  ### Authorization
232
247
 
233
- [HTTPBearer](../README.md#HTTPBearer)
248
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
234
249
 
235
250
  ### HTTP request headers
236
251
 
data/docs/FacturXPDFXMLVerificationApi.md CHANGED
@@ -24,6 +24,11 @@ require 'time'
24
24
  require 'factpulse'
25
25
  # setup authorization
26
26
  FactPulse.configure do |config|
27
+ # Configure API key authorization: APIKeyHeader
28
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
31
+
27
32
  # Configure Bearer authorization: HTTPBearer
28
33
  config.access_token = 'YOUR_BEARER_TOKEN'
29
34
  end
@@ -70,7 +75,7 @@ end
70
75
 
71
76
  ### Authorization
72
77
 
73
- [HTTPBearer](../README.md#HTTPBearer)
78
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
74
79
 
75
80
  ### HTTP request headers
76
81
 
@@ -93,6 +98,11 @@ require 'time'
93
98
  require 'factpulse'
94
99
  # setup authorization
95
100
  FactPulse.configure do |config|
101
+ # Configure API key authorization: APIKeyHeader
102
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
103
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
104
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
105
+
96
106
  # Configure Bearer authorization: HTTPBearer
97
107
  config.access_token = 'YOUR_BEARER_TOKEN'
98
108
  end
@@ -147,7 +157,7 @@ end
147
157
 
148
158
  ### Authorization
149
159
 
150
- [HTTPBearer](../README.md#HTTPBearer)
160
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
151
161
 
152
162
  ### HTTP request headers
153
163
 
@@ -170,6 +180,11 @@ require 'time'
170
180
  require 'factpulse'
171
181
  # setup authorization
172
182
  FactPulse.configure do |config|
183
+ # Configure API key authorization: APIKeyHeader
184
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
185
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
186
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
187
+
173
188
  # Configure Bearer authorization: HTTPBearer
174
189
  config.access_token = 'YOUR_BEARER_TOKEN'
175
190
  end
@@ -216,7 +231,7 @@ end
216
231
 
217
232
  ### Authorization
218
233
 
219
- [HTTPBearer](../README.md#HTTPBearer)
234
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
220
235
 
221
236
  ### HTTP request headers
222
237
 
data/docs/FacturXValidationApi.md CHANGED
@@ -24,6 +24,11 @@ require 'time'
24
24
  require 'factpulse'
25
25
  # setup authorization
26
26
  FactPulse.configure do |config|
27
+ # Configure API key authorization: APIKeyHeader
28
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
31
+
27
32
  # Configure Bearer authorization: HTTPBearer
28
33
  config.access_token = 'YOUR_BEARER_TOKEN'
29
34
  end
@@ -78,7 +83,7 @@ end
78
83
 
79
84
  ### Authorization
80
85
 
81
- [HTTPBearer](../README.md#HTTPBearer)
86
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
82
87
 
83
88
  ### HTTP request headers
84
89
 
@@ -101,6 +106,11 @@ require 'time'
101
106
  require 'factpulse'
102
107
  # setup authorization
103
108
  FactPulse.configure do |config|
109
+ # Configure API key authorization: APIKeyHeader
110
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
111
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
112
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
113
+
104
114
  # Configure Bearer authorization: HTTPBearer
105
115
  config.access_token = 'YOUR_BEARER_TOKEN'
106
116
  end
@@ -157,7 +167,7 @@ end
157
167
 
158
168
  ### Authorization
159
169
 
160
- [HTTPBearer](../README.md#HTTPBearer)
170
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
161
171
 
162
172
  ### HTTP request headers
163
173
 
@@ -180,6 +190,11 @@ require 'time'
180
190
  require 'factpulse'
181
191
  # setup authorization
182
192
  FactPulse.configure do |config|
193
+ # Configure API key authorization: APIKeyHeader
194
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
195
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
196
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
197
+
183
198
  # Configure Bearer authorization: HTTPBearer
184
199
  config.access_token = 'YOUR_BEARER_TOKEN'
185
200
  end
@@ -232,7 +247,7 @@ end
232
247
 
233
248
  ### Authorization
234
249
 
235
- [HTTPBearer](../README.md#HTTPBearer)
250
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
236
251
 
237
252
  ### HTTP request headers
238
253
 
data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md ADDED
@@ -0,0 +1,18 @@
1
+ # FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **detail** | **Array&lt;String&gt;** | List of detected validation errors. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'factpulse'
13
+
14
+ instance = FactPulse::FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.new(
15
+ detail: null
16
+ )
17
+ ```
18
+
data/docs/Flux10EReportingApi.md CHANGED
@@ -32,6 +32,11 @@ require 'time'
32
32
  require 'factpulse'
33
33
  # setup authorization
34
34
  FactPulse.configure do |config|
35
+ # Configure API key authorization: APIKeyHeader
36
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
37
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
39
+
35
40
  # Configure Bearer authorization: HTTPBearer
36
41
  config.access_token = 'YOUR_BEARER_TOKEN'
37
42
  end
@@ -78,7 +83,7 @@ end
78
83
 
79
84
  ### Authorization
80
85
 
81
- [HTTPBearer](../README.md#HTTPBearer)
86
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
82
87
 
83
88
  ### HTTP request headers
84
89
 
@@ -101,6 +106,11 @@ require 'time'
101
106
  require 'factpulse'
102
107
  # setup authorization
103
108
  FactPulse.configure do |config|
109
+ # Configure API key authorization: APIKeyHeader
110
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
111
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
112
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
113
+
104
114
  # Configure Bearer authorization: HTTPBearer
105
115
  config.access_token = 'YOUR_BEARER_TOKEN'
106
116
  end
@@ -147,7 +157,7 @@ end
147
157
 
148
158
  ### Authorization
149
159
 
150
- [HTTPBearer](../README.md#HTTPBearer)
160
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
151
161
 
152
162
  ### HTTP request headers
153
163
 
@@ -170,6 +180,11 @@ require 'time'
170
180
  require 'factpulse'
171
181
  # setup authorization
172
182
  FactPulse.configure do |config|
183
+ # Configure API key authorization: APIKeyHeader
184
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
185
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
186
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
187
+
173
188
  # Configure Bearer authorization: HTTPBearer
174
189
  config.access_token = 'YOUR_BEARER_TOKEN'
175
190
  end
@@ -219,7 +234,7 @@ nil (empty response body)
219
234
 
220
235
  ### Authorization
221
236
 
222
- [HTTPBearer](../README.md#HTTPBearer)
237
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
223
238
 
224
239
  ### HTTP request headers
225
240
 
@@ -585,6 +600,11 @@ require 'time'
585
600
  require 'factpulse'
586
601
  # setup authorization
587
602
  FactPulse.configure do |config|
603
+ # Configure API key authorization: APIKeyHeader
604
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
605
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
606
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
607
+
588
608
  # Configure Bearer authorization: HTTPBearer
589
609
  config.access_token = 'YOUR_BEARER_TOKEN'
590
610
  end
@@ -631,7 +651,7 @@ end
631
651
 
632
652
  ### Authorization
633
653
 
634
- [HTTPBearer](../README.md#HTTPBearer)
654
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
635
655
 
636
656
  ### HTTP request headers
637
657
 
@@ -654,6 +674,11 @@ require 'time'
654
674
  require 'factpulse'
655
675
  # setup authorization
656
676
  FactPulse.configure do |config|
677
+ # Configure API key authorization: APIKeyHeader
678
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
679
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
680
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
681
+
657
682
  # Configure Bearer authorization: HTTPBearer
658
683
  config.access_token = 'YOUR_BEARER_TOKEN'
659
684
  end
@@ -700,7 +725,7 @@ end
700
725
 
701
726
  ### Authorization
702
727
 
703
- [HTTPBearer](../README.md#HTTPBearer)
728
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
704
729
 
705
730
  ### HTTP request headers
706
731
 
@@ -723,6 +748,11 @@ require 'time'
723
748
  require 'factpulse'
724
749
  # setup authorization
725
750
  FactPulse.configure do |config|
751
+ # Configure API key authorization: APIKeyHeader
752
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
753
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
754
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
755
+
726
756
  # Configure Bearer authorization: HTTPBearer
727
757
  config.access_token = 'YOUR_BEARER_TOKEN'
728
758
  end
@@ -775,7 +805,7 @@ end
775
805
 
776
806
  ### Authorization
777
807
 
778
- [HTTPBearer](../README.md#HTTPBearer)
808
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
779
809
 
780
810
  ### HTTP request headers
781
811
 
data/docs/Flux6InvoiceLifecycleCDARApi.md CHANGED
@@ -31,6 +31,11 @@ require 'time'
31
31
  require 'factpulse'
32
32
  # setup authorization
33
33
  FactPulse.configure do |config|
34
+ # Configure API key authorization: APIKeyHeader
35
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
36
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
37
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
38
+
34
39
  # Configure Bearer authorization: HTTPBearer
35
40
  config.access_token = 'YOUR_BEARER_TOKEN'
36
41
  end
@@ -77,7 +82,7 @@ end
77
82
 
78
83
  ### Authorization
79
84
 
80
- [HTTPBearer](../README.md#HTTPBearer)
85
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
81
86
 
82
87
  ### HTTP request headers
83
88
 
@@ -559,6 +564,11 @@ require 'time'
559
564
  require 'factpulse'
560
565
  # setup authorization
561
566
  FactPulse.configure do |config|
567
+ # Configure API key authorization: APIKeyHeader
568
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
569
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
570
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
571
+
562
572
  # Configure Bearer authorization: HTTPBearer
563
573
  config.access_token = 'YOUR_BEARER_TOKEN'
564
574
  end
@@ -605,7 +615,7 @@ end
605
615
 
606
616
  ### Authorization
607
617
 
608
- [HTTPBearer](../README.md#HTTPBearer)
618
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
609
619
 
610
620
  ### HTTP request headers
611
621
 
@@ -628,6 +638,11 @@ require 'time'
628
638
  require 'factpulse'
629
639
  # setup authorization
630
640
  FactPulse.configure do |config|
641
+ # Configure API key authorization: APIKeyHeader
642
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
643
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
644
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
645
+
631
646
  # Configure Bearer authorization: HTTPBearer
632
647
  config.access_token = 'YOUR_BEARER_TOKEN'
633
648
  end
@@ -674,7 +689,7 @@ end
674
689
 
675
690
  ### Authorization
676
691
 
677
- [HTTPBearer](../README.md#HTTPBearer)
692
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
678
693
 
679
694
  ### HTTP request headers
680
695
 
data/docs/HealthApi.md CHANGED
@@ -24,6 +24,11 @@ require 'time'
24
24
  require 'factpulse'
25
25
  # setup authorization
26
26
  FactPulse.configure do |config|
27
+ # Configure API key authorization: APIKeyHeader
28
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
29
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
31
+
27
32
  # Configure Bearer authorization: HTTPBearer
28
33
  config.access_token = 'YOUR_BEARER_TOKEN'
29
34
  end
@@ -67,7 +72,7 @@ This endpoint does not need any parameter.
67
72
 
68
73
  ### Authorization
69
74
 
70
- [HTTPBearer](../README.md#HTTPBearer)
75
+ [APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
71
76
 
72
77
  ### HTTP request headers
73
78
 
data/docs/KeyRotationRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # FactPulse::KeyRotationRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **old_key** | **String** | Current encryption key (base64-encoded AES-256) | |
8
+ | **new_key** | **String** | New encryption key (base64-encoded AES-256) | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'factpulse'
14
+
15
+ instance = FactPulse::KeyRotationRequest.new(
16
+ old_key: null,
17
+ new_key: null
18
+ )
19
+ ```
20
+
data/docs/KeyRotationResponse.md ADDED
@@ -0,0 +1,24 @@
1
+ # FactPulse::KeyRotationResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **success** | **Boolean** | Whether rotation was successful | |
8
+ | **message** | **String** | Result message | |
9
+ | **rotated_count** | **Integer** | Number of secrets that were rotated | |
10
+ | **partial_errors** | **Array&lt;String&gt;** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'factpulse'
16
+
17
+ instance = FactPulse::KeyRotationResponse.new(
18
+ success: null,
19
+ message: null,
20
+ rotated_count: null,
21
+ partial_errors: null
22
+ )
23
+ ```
24
+
data/docs/PDPConfigResponse.md CHANGED
@@ -11,6 +11,7 @@
11
11
  | **flow_service_url** | **String** | | [optional] |
12
12
  | **token_url** | **String** | | [optional] |
13
13
  | **oauth_client_id** | **String** | | [optional] |
14
+ | **encryption_mode** | **String** | | [optional] |
14
15
  | **secret_status** | [**SecretStatus**](SecretStatus.md) | | [optional] |
15
16
  | **last_test_at** | **Time** | | [optional] |
16
17
  | **last_test_success** | **Boolean** | | [optional] |
@@ -32,6 +33,7 @@ instance = FactPulse::PDPConfigResponse.new(
32
33
  flow_service_url: null,
33
34
  token_url: null,
34
35
  oauth_client_id: null,
36
+ encryption_mode: null,
35
37
  secret_status: null,
36
38
  last_test_at: null,
37
39
  last_test_success: null,
data/docs/PDPConfigUpdateRequest.md CHANGED
@@ -10,6 +10,7 @@
10
10
  | **token_url** | **String** | PDP OAuth token URL | |
11
11
  | **oauth_client_id** | **String** | OAuth Client ID | |
12
12
  | **client_secret** | **String** | OAuth Client Secret (sent but never returned) | |
13
+ | **encryption_mode** | **String** | | [optional] |
13
14
 
14
15
  ## Example
15
16
 
@@ -22,7 +23,8 @@ instance = FactPulse::PDPConfigUpdateRequest.new(
22
23
  flow_service_url: null,
23
24
  token_url: null,
24
25
  oauth_client_id: null,
25
- client_secret: null
26
+ client_secret: null,
27
+ encryption_mode: null
26
28
  )
27
29
  ```
28
30
 
data/docs/SecretStatus.md CHANGED
@@ -6,6 +6,8 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **status** | **String** | Secret status: &#39;active&#39;, &#39;missing&#39;, etc. | |
8
8
  | **message** | **String** | Descriptive status message | |
9
+ | **encryption_mode** | **String** | | [optional] |
10
+ | **requires_client_key** | **Boolean** | | [optional] |
9
11
 
10
12
  ## Example
11
13
 
@@ -14,7 +16,9 @@ require 'factpulse'
14
16
 
15
17
  instance = FactPulse::SecretStatus.new(
16
18
  status: null,
17
- message: null
19
+ message: null,
20
+ encryption_mode: null,
21
+ requires_client_key: null
18
22
  )
19
23
  ```
20
24
 
data/docs/ValidateCDARResponse.md CHANGED
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **valid** | **Boolean** | Résultat de validation | |
8
- | **errors** | [**Array&lt;FactureElectroniqueRestApiSchemasCdarValidationErrorResponse&gt;**](FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md) | Liste des erreurs | [optional] |
9
- | **warnings** | [**Array&lt;FactureElectroniqueRestApiSchemasCdarValidationErrorResponse&gt;**](FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md) | Liste des avertissements | [optional] |
8
+ | **errors** | [**Array&lt;ValidationErrorResponse&gt;**](ValidationErrorResponse.md) | Liste des erreurs | [optional] |
9
+ | **warnings** | [**Array&lt;ValidationErrorResponse&gt;**](ValidationErrorResponse.md) | Liste des avertissements | [optional] |
10
10
 
11
11
  ## Example
12
12