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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -4
- data/Gemfile.lock +2 -2
- data/README.md +12 -0
- data/docs/AFNORPDPPAApi.md +9 -2
- data/docs/AsyncTasksApi.md +6 -1
- data/docs/ChorusProApi.md +96 -16
- data/docs/ClientManagementApi.md +359 -13
- data/docs/ConvertResumeRequest.md +5 -1
- data/docs/DownloadsApi.md +12 -2
- data/docs/ElectronicSignatureApi.md +24 -4
- data/docs/FacturXConversionApi.md +101 -4
- data/docs/FacturXGenerationApi.md +18 -3
- data/docs/FacturXPDFXMLVerificationApi.md +18 -3
- data/docs/FacturXValidationApi.md +18 -3
- data/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +18 -0
- data/docs/Flux10EReportingApi.md +36 -6
- data/docs/Flux6InvoiceLifecycleCDARApi.md +18 -3
- data/docs/HealthApi.md +6 -1
- data/docs/KeyRotationRequest.md +20 -0
- data/docs/KeyRotationResponse.md +24 -0
- data/docs/PDPConfigResponse.md +2 -0
- data/docs/PDPConfigUpdateRequest.md +3 -1
- data/docs/SecretStatus.md +5 -1
- data/docs/ValidateCDARResponse.md +2 -2
- data/docs/ValidationErrorResponse.md +8 -2
- data/docs/WebhookSecretDeleteResponse.md +20 -0
- data/docs/WebhookSecretGenerateResponse.md +24 -0
- data/docs/WebhookSecretStatusResponse.md +20 -0
- data/lib/factpulse/api/afnorpdppa_api.rb +4 -1
- data/lib/factpulse/api/async_tasks_api.rb +1 -1
- data/lib/factpulse/api/chorus_pro_api.rb +16 -16
- data/lib/factpulse/api/client_management_api.rb +276 -10
- data/lib/factpulse/api/downloads_api.rb +2 -2
- data/lib/factpulse/api/electronic_signature_api.rb +4 -4
- data/lib/factpulse/api/factur_x_conversion_api.rb +78 -4
- data/lib/factpulse/api/factur_x_generation_api.rb +3 -3
- data/lib/factpulse/api/factur_x_validation_api.rb +3 -3
- data/lib/factpulse/api/factur_xpdfxml_verification_api.rb +3 -3
- data/lib/factpulse/api/flux10_e_reporting_api.rb +6 -6
- data/lib/factpulse/api/flux6_invoice_lifecycle_cdar_api.rb +3 -3
- data/lib/factpulse/api/health_api.rb +1 -1
- data/lib/factpulse/configuration.rb +7 -0
- data/lib/factpulse/models/convert_resume_request.rb +27 -5
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb +168 -0
- data/lib/factpulse/models/key_rotation_request.rb +211 -0
- data/lib/factpulse/models/key_rotation_response.rb +232 -0
- data/lib/factpulse/models/pdp_config_response.rb +11 -1
- data/lib/factpulse/models/pdp_config_update_request.rb +49 -5
- data/lib/factpulse/models/secret_status.rb +24 -4
- data/lib/factpulse/models/validate_cdar_response.rb +2 -2
- data/lib/factpulse/models/validation_error_response.rb +67 -20
- data/lib/factpulse/models/{facture_electronique_rest_api_schemas_cdar_validation_error_response.rb → webhook_secret_delete_response.rb} +25 -47
- data/lib/factpulse/models/webhook_secret_generate_response.rb +247 -0
- data/lib/factpulse/models/webhook_secret_status_response.rb +176 -0
- data/lib/factpulse/version.rb +1 -1
- data/lib/factpulse.rb +6 -1
- metadata +14 -4
- data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +0 -24
data/docs/ClientManagementApi.md
CHANGED
|
@@ -7,9 +7,13 @@ All URIs are relative to *https://factpulse.fr*
|
|
|
7
7
|
| [**activate_client_api_v1_clients_uid_activer_post**](ClientManagementApi.md#activate_client_api_v1_clients_uid_activer_post) | **POST** /api/v1/clients/{uid}/activer | Activate a client |
|
|
8
8
|
| [**create_client_api_v1_clients_post**](ClientManagementApi.md#create_client_api_v1_clients_post) | **POST** /api/v1/clients | Create a client |
|
|
9
9
|
| [**deactivate_client_api_v1_clients_uid_desactiver_post**](ClientManagementApi.md#deactivate_client_api_v1_clients_uid_desactiver_post) | **POST** /api/v1/clients/{uid}/desactiver | Deactivate a client |
|
|
10
|
+
| [**delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete**](ClientManagementApi.md#delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete) | **DELETE** /api/v1/clients/{uid}/webhook-secret | Delete webhook secret |
|
|
11
|
+
| [**generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post**](ClientManagementApi.md#generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post) | **POST** /api/v1/clients/{uid}/webhook-secret/generate | Generate webhook secret |
|
|
10
12
|
| [**get_client_api_v1_clients_uid_get**](ClientManagementApi.md#get_client_api_v1_clients_uid_get) | **GET** /api/v1/clients/{uid} | Get client details |
|
|
11
13
|
| [**get_pdp_config_api_v1_clients_uid_pdp_config_get**](ClientManagementApi.md#get_pdp_config_api_v1_clients_uid_pdp_config_get) | **GET** /api/v1/clients/{uid}/pdp-config | Get client PDP configuration |
|
|
14
|
+
| [**get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get**](ClientManagementApi.md#get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get) | **GET** /api/v1/clients/{uid}/webhook-secret/status | Get webhook secret status |
|
|
12
15
|
| [**list_clients_api_v1_clients_get**](ClientManagementApi.md#list_clients_api_v1_clients_get) | **GET** /api/v1/clients | List clients |
|
|
16
|
+
| [**rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post**](ClientManagementApi.md#rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post) | **POST** /api/v1/clients/{uid}/rotate-encryption-key | Rotate client encryption key |
|
|
13
17
|
| [**update_client_api_v1_clients_uid_patch**](ClientManagementApi.md#update_client_api_v1_clients_uid_patch) | **PATCH** /api/v1/clients/{uid} | Update a client |
|
|
14
18
|
| [**update_pdp_config_api_v1_clients_uid_pdp_config_put**](ClientManagementApi.md#update_pdp_config_api_v1_clients_uid_pdp_config_put) | **PUT** /api/v1/clients/{uid}/pdp-config | Configure client PDP |
|
|
15
19
|
|
|
@@ -29,6 +33,11 @@ require 'time'
|
|
|
29
33
|
require 'factpulse'
|
|
30
34
|
# setup authorization
|
|
31
35
|
FactPulse.configure do |config|
|
|
36
|
+
# Configure API key authorization: APIKeyHeader
|
|
37
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
39
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
40
|
+
|
|
32
41
|
# Configure Bearer authorization: HTTPBearer
|
|
33
42
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
34
43
|
end
|
|
@@ -75,7 +84,7 @@ end
|
|
|
75
84
|
|
|
76
85
|
### Authorization
|
|
77
86
|
|
|
78
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
87
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
79
88
|
|
|
80
89
|
### HTTP request headers
|
|
81
90
|
|
|
@@ -98,6 +107,11 @@ require 'time'
|
|
|
98
107
|
require 'factpulse'
|
|
99
108
|
# setup authorization
|
|
100
109
|
FactPulse.configure do |config|
|
|
110
|
+
# Configure API key authorization: APIKeyHeader
|
|
111
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
112
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
113
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
114
|
+
|
|
101
115
|
# Configure Bearer authorization: HTTPBearer
|
|
102
116
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
103
117
|
end
|
|
@@ -144,7 +158,7 @@ end
|
|
|
144
158
|
|
|
145
159
|
### Authorization
|
|
146
160
|
|
|
147
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
161
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
148
162
|
|
|
149
163
|
### HTTP request headers
|
|
150
164
|
|
|
@@ -167,6 +181,11 @@ require 'time'
|
|
|
167
181
|
require 'factpulse'
|
|
168
182
|
# setup authorization
|
|
169
183
|
FactPulse.configure do |config|
|
|
184
|
+
# Configure API key authorization: APIKeyHeader
|
|
185
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
186
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
187
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
188
|
+
|
|
170
189
|
# Configure Bearer authorization: HTTPBearer
|
|
171
190
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
172
191
|
end
|
|
@@ -213,7 +232,155 @@ end
|
|
|
213
232
|
|
|
214
233
|
### Authorization
|
|
215
234
|
|
|
216
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
235
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
236
|
+
|
|
237
|
+
### HTTP request headers
|
|
238
|
+
|
|
239
|
+
- **Content-Type**: Not defined
|
|
240
|
+
- **Accept**: application/json
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
## delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete
|
|
244
|
+
|
|
245
|
+
> <WebhookSecretDeleteResponse> delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete(uid)
|
|
246
|
+
|
|
247
|
+
Delete webhook secret
|
|
248
|
+
|
|
249
|
+
Delete the webhook secret for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **After deletion**: Webhooks for this client will use the global server key for HMAC signature instead of a client-specific key.
|
|
250
|
+
|
|
251
|
+
### Examples
|
|
252
|
+
|
|
253
|
+
```ruby
|
|
254
|
+
require 'time'
|
|
255
|
+
require 'factpulse'
|
|
256
|
+
# setup authorization
|
|
257
|
+
FactPulse.configure do |config|
|
|
258
|
+
# Configure API key authorization: APIKeyHeader
|
|
259
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
260
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
261
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
262
|
+
|
|
263
|
+
# Configure Bearer authorization: HTTPBearer
|
|
264
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
268
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
269
|
+
|
|
270
|
+
begin
|
|
271
|
+
# Delete webhook secret
|
|
272
|
+
result = api_instance.delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete(uid)
|
|
273
|
+
p result
|
|
274
|
+
rescue FactPulse::ApiError => e
|
|
275
|
+
puts "Error when calling ClientManagementApi->delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete: #{e}"
|
|
276
|
+
end
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
#### Using the delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info variant
|
|
280
|
+
|
|
281
|
+
This returns an Array which contains the response data, status code and headers.
|
|
282
|
+
|
|
283
|
+
> <Array(<WebhookSecretDeleteResponse>, Integer, Hash)> delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info(uid)
|
|
284
|
+
|
|
285
|
+
```ruby
|
|
286
|
+
begin
|
|
287
|
+
# Delete webhook secret
|
|
288
|
+
data, status_code, headers = api_instance.delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info(uid)
|
|
289
|
+
p status_code # => 2xx
|
|
290
|
+
p headers # => { ... }
|
|
291
|
+
p data # => <WebhookSecretDeleteResponse>
|
|
292
|
+
rescue FactPulse::ApiError => e
|
|
293
|
+
puts "Error when calling ClientManagementApi->delete_webhook_secret_api_v1_clients_uid_webhook_secret_delete_with_http_info: #{e}"
|
|
294
|
+
end
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
### Parameters
|
|
298
|
+
|
|
299
|
+
| Name | Type | Description | Notes |
|
|
300
|
+
| ---- | ---- | ----------- | ----- |
|
|
301
|
+
| **uid** | **String** | | |
|
|
302
|
+
|
|
303
|
+
### Return type
|
|
304
|
+
|
|
305
|
+
[**WebhookSecretDeleteResponse**](WebhookSecretDeleteResponse.md)
|
|
306
|
+
|
|
307
|
+
### Authorization
|
|
308
|
+
|
|
309
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
310
|
+
|
|
311
|
+
### HTTP request headers
|
|
312
|
+
|
|
313
|
+
- **Content-Type**: Not defined
|
|
314
|
+
- **Accept**: application/json
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
## generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post
|
|
318
|
+
|
|
319
|
+
> <WebhookSecretGenerateResponse> generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post(uid)
|
|
320
|
+
|
|
321
|
+
Generate webhook secret
|
|
322
|
+
|
|
323
|
+
Generate or regenerate the webhook secret for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Important**: Save the returned secret immediately - it will never be shown again. The secret is used to sign webhooks sent by the server (HMAC-SHA256). **If a secret already exists**: It will be replaced by the new one.
|
|
324
|
+
|
|
325
|
+
### Examples
|
|
326
|
+
|
|
327
|
+
```ruby
|
|
328
|
+
require 'time'
|
|
329
|
+
require 'factpulse'
|
|
330
|
+
# setup authorization
|
|
331
|
+
FactPulse.configure do |config|
|
|
332
|
+
# Configure API key authorization: APIKeyHeader
|
|
333
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
334
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
335
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
336
|
+
|
|
337
|
+
# Configure Bearer authorization: HTTPBearer
|
|
338
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
342
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
343
|
+
|
|
344
|
+
begin
|
|
345
|
+
# Generate webhook secret
|
|
346
|
+
result = api_instance.generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post(uid)
|
|
347
|
+
p result
|
|
348
|
+
rescue FactPulse::ApiError => e
|
|
349
|
+
puts "Error when calling ClientManagementApi->generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post: #{e}"
|
|
350
|
+
end
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
#### Using the generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info variant
|
|
354
|
+
|
|
355
|
+
This returns an Array which contains the response data, status code and headers.
|
|
356
|
+
|
|
357
|
+
> <Array(<WebhookSecretGenerateResponse>, Integer, Hash)> generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info(uid)
|
|
358
|
+
|
|
359
|
+
```ruby
|
|
360
|
+
begin
|
|
361
|
+
# Generate webhook secret
|
|
362
|
+
data, status_code, headers = api_instance.generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info(uid)
|
|
363
|
+
p status_code # => 2xx
|
|
364
|
+
p headers # => { ... }
|
|
365
|
+
p data # => <WebhookSecretGenerateResponse>
|
|
366
|
+
rescue FactPulse::ApiError => e
|
|
367
|
+
puts "Error when calling ClientManagementApi->generate_webhook_secret_api_v1_clients_uid_webhook_secret_generate_post_with_http_info: #{e}"
|
|
368
|
+
end
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
### Parameters
|
|
372
|
+
|
|
373
|
+
| Name | Type | Description | Notes |
|
|
374
|
+
| ---- | ---- | ----------- | ----- |
|
|
375
|
+
| **uid** | **String** | | |
|
|
376
|
+
|
|
377
|
+
### Return type
|
|
378
|
+
|
|
379
|
+
[**WebhookSecretGenerateResponse**](WebhookSecretGenerateResponse.md)
|
|
380
|
+
|
|
381
|
+
### Authorization
|
|
382
|
+
|
|
383
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
217
384
|
|
|
218
385
|
### HTTP request headers
|
|
219
386
|
|
|
@@ -236,6 +403,11 @@ require 'time'
|
|
|
236
403
|
require 'factpulse'
|
|
237
404
|
# setup authorization
|
|
238
405
|
FactPulse.configure do |config|
|
|
406
|
+
# Configure API key authorization: APIKeyHeader
|
|
407
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
408
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
409
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
410
|
+
|
|
239
411
|
# Configure Bearer authorization: HTTPBearer
|
|
240
412
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
241
413
|
end
|
|
@@ -282,7 +454,7 @@ end
|
|
|
282
454
|
|
|
283
455
|
### Authorization
|
|
284
456
|
|
|
285
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
457
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
286
458
|
|
|
287
459
|
### HTTP request headers
|
|
288
460
|
|
|
@@ -305,6 +477,11 @@ require 'time'
|
|
|
305
477
|
require 'factpulse'
|
|
306
478
|
# setup authorization
|
|
307
479
|
FactPulse.configure do |config|
|
|
480
|
+
# Configure API key authorization: APIKeyHeader
|
|
481
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
482
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
483
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
484
|
+
|
|
308
485
|
# Configure Bearer authorization: HTTPBearer
|
|
309
486
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
310
487
|
end
|
|
@@ -351,7 +528,81 @@ end
|
|
|
351
528
|
|
|
352
529
|
### Authorization
|
|
353
530
|
|
|
354
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
531
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
532
|
+
|
|
533
|
+
### HTTP request headers
|
|
534
|
+
|
|
535
|
+
- **Content-Type**: Not defined
|
|
536
|
+
- **Accept**: application/json
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
## get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get
|
|
540
|
+
|
|
541
|
+
> <WebhookSecretStatusResponse> get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get(uid)
|
|
542
|
+
|
|
543
|
+
Get webhook secret status
|
|
544
|
+
|
|
545
|
+
Check if a webhook secret is configured for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Response**: - `hasSecret`: Whether a webhook secret is configured - `createdAt`: When the secret was created (if exists) **Note**: The secret value is never returned, only its status.
|
|
546
|
+
|
|
547
|
+
### Examples
|
|
548
|
+
|
|
549
|
+
```ruby
|
|
550
|
+
require 'time'
|
|
551
|
+
require 'factpulse'
|
|
552
|
+
# setup authorization
|
|
553
|
+
FactPulse.configure do |config|
|
|
554
|
+
# Configure API key authorization: APIKeyHeader
|
|
555
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
556
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
557
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
558
|
+
|
|
559
|
+
# Configure Bearer authorization: HTTPBearer
|
|
560
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
564
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
565
|
+
|
|
566
|
+
begin
|
|
567
|
+
# Get webhook secret status
|
|
568
|
+
result = api_instance.get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get(uid)
|
|
569
|
+
p result
|
|
570
|
+
rescue FactPulse::ApiError => e
|
|
571
|
+
puts "Error when calling ClientManagementApi->get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get: #{e}"
|
|
572
|
+
end
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
#### Using the get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info variant
|
|
576
|
+
|
|
577
|
+
This returns an Array which contains the response data, status code and headers.
|
|
578
|
+
|
|
579
|
+
> <Array(<WebhookSecretStatusResponse>, Integer, Hash)> get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info(uid)
|
|
580
|
+
|
|
581
|
+
```ruby
|
|
582
|
+
begin
|
|
583
|
+
# Get webhook secret status
|
|
584
|
+
data, status_code, headers = api_instance.get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info(uid)
|
|
585
|
+
p status_code # => 2xx
|
|
586
|
+
p headers # => { ... }
|
|
587
|
+
p data # => <WebhookSecretStatusResponse>
|
|
588
|
+
rescue FactPulse::ApiError => e
|
|
589
|
+
puts "Error when calling ClientManagementApi->get_webhook_secret_status_api_v1_clients_uid_webhook_secret_status_get_with_http_info: #{e}"
|
|
590
|
+
end
|
|
591
|
+
```
|
|
592
|
+
|
|
593
|
+
### Parameters
|
|
594
|
+
|
|
595
|
+
| Name | Type | Description | Notes |
|
|
596
|
+
| ---- | ---- | ----------- | ----- |
|
|
597
|
+
| **uid** | **String** | | |
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
[**WebhookSecretStatusResponse**](WebhookSecretStatusResponse.md)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
355
606
|
|
|
356
607
|
### HTTP request headers
|
|
357
608
|
|
|
@@ -374,6 +625,11 @@ require 'time'
|
|
|
374
625
|
require 'factpulse'
|
|
375
626
|
# setup authorization
|
|
376
627
|
FactPulse.configure do |config|
|
|
628
|
+
# Configure API key authorization: APIKeyHeader
|
|
629
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
630
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
631
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
632
|
+
|
|
377
633
|
# Configure Bearer authorization: HTTPBearer
|
|
378
634
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
379
635
|
end
|
|
@@ -424,7 +680,7 @@ end
|
|
|
424
680
|
|
|
425
681
|
### Authorization
|
|
426
682
|
|
|
427
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
683
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
428
684
|
|
|
429
685
|
### HTTP request headers
|
|
430
686
|
|
|
@@ -432,6 +688,82 @@ end
|
|
|
432
688
|
- **Accept**: application/json
|
|
433
689
|
|
|
434
690
|
|
|
691
|
+
## rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post
|
|
692
|
+
|
|
693
|
+
> <KeyRotationResponse> rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post(uid, key_rotation_request)
|
|
694
|
+
|
|
695
|
+
Rotate client encryption key
|
|
696
|
+
|
|
697
|
+
Rotate the client encryption key for all secrets in double encryption mode. **Scope**: Client level (JWT with client_uid that must match {uid}) **What this does**: 1. Decrypts all secrets (PDP, Chorus Pro) using the old key 2. Re-encrypts them using the new key 3. Saves to database **Important notes**: - Both keys must be base64-encoded AES-256 keys (32 bytes each) - The old key becomes invalid immediately after rotation - Only secrets encrypted with `encryptionMode: \"double\"` are affected - If the client has no double-encrypted secrets, returns 404 **Security**: - The old key must be valid (decryption is verified) - If decryption fails, rotation is aborted (atomic operation) - Neither key is logged or stored by the server
|
|
698
|
+
|
|
699
|
+
### Examples
|
|
700
|
+
|
|
701
|
+
```ruby
|
|
702
|
+
require 'time'
|
|
703
|
+
require 'factpulse'
|
|
704
|
+
# setup authorization
|
|
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
|
+
|
|
711
|
+
# Configure Bearer authorization: HTTPBearer
|
|
712
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
713
|
+
end
|
|
714
|
+
|
|
715
|
+
api_instance = FactPulse::ClientManagementApi.new
|
|
716
|
+
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
717
|
+
key_rotation_request = FactPulse::KeyRotationRequest.new({old_key: 'old_key_example', new_key: 'new_key_example'}) # KeyRotationRequest |
|
|
718
|
+
|
|
719
|
+
begin
|
|
720
|
+
# Rotate client encryption key
|
|
721
|
+
result = api_instance.rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post(uid, key_rotation_request)
|
|
722
|
+
p result
|
|
723
|
+
rescue FactPulse::ApiError => e
|
|
724
|
+
puts "Error when calling ClientManagementApi->rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post: #{e}"
|
|
725
|
+
end
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
#### Using the rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info variant
|
|
729
|
+
|
|
730
|
+
This returns an Array which contains the response data, status code and headers.
|
|
731
|
+
|
|
732
|
+
> <Array(<KeyRotationResponse>, Integer, Hash)> rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info(uid, key_rotation_request)
|
|
733
|
+
|
|
734
|
+
```ruby
|
|
735
|
+
begin
|
|
736
|
+
# Rotate client encryption key
|
|
737
|
+
data, status_code, headers = api_instance.rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info(uid, key_rotation_request)
|
|
738
|
+
p status_code # => 2xx
|
|
739
|
+
p headers # => { ... }
|
|
740
|
+
p data # => <KeyRotationResponse>
|
|
741
|
+
rescue FactPulse::ApiError => e
|
|
742
|
+
puts "Error when calling ClientManagementApi->rotate_encryption_key_api_v1_clients_uid_rotate_encryption_key_post_with_http_info: #{e}"
|
|
743
|
+
end
|
|
744
|
+
```
|
|
745
|
+
|
|
746
|
+
### Parameters
|
|
747
|
+
|
|
748
|
+
| Name | Type | Description | Notes |
|
|
749
|
+
| ---- | ---- | ----------- | ----- |
|
|
750
|
+
| **uid** | **String** | | |
|
|
751
|
+
| **key_rotation_request** | [**KeyRotationRequest**](KeyRotationRequest.md) | | |
|
|
752
|
+
|
|
753
|
+
### Return type
|
|
754
|
+
|
|
755
|
+
[**KeyRotationResponse**](KeyRotationResponse.md)
|
|
756
|
+
|
|
757
|
+
### Authorization
|
|
758
|
+
|
|
759
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
760
|
+
|
|
761
|
+
### HTTP request headers
|
|
762
|
+
|
|
763
|
+
- **Content-Type**: application/json
|
|
764
|
+
- **Accept**: application/json
|
|
765
|
+
|
|
766
|
+
|
|
435
767
|
## update_client_api_v1_clients_uid_patch
|
|
436
768
|
|
|
437
769
|
> <ClientDetail> update_client_api_v1_clients_uid_patch(uid, client_update_request)
|
|
@@ -447,6 +779,11 @@ require 'time'
|
|
|
447
779
|
require 'factpulse'
|
|
448
780
|
# setup authorization
|
|
449
781
|
FactPulse.configure do |config|
|
|
782
|
+
# Configure API key authorization: APIKeyHeader
|
|
783
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
784
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
785
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
786
|
+
|
|
450
787
|
# Configure Bearer authorization: HTTPBearer
|
|
451
788
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
452
789
|
end
|
|
@@ -495,7 +832,7 @@ end
|
|
|
495
832
|
|
|
496
833
|
### Authorization
|
|
497
834
|
|
|
498
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
835
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
499
836
|
|
|
500
837
|
### HTTP request headers
|
|
501
838
|
|
|
@@ -505,11 +842,11 @@ end
|
|
|
505
842
|
|
|
506
843
|
## update_pdp_config_api_v1_clients_uid_pdp_config_put
|
|
507
844
|
|
|
508
|
-
> <PDPConfigResponse> update_pdp_config_api_v1_clients_uid_pdp_config_put(uid, pdp_config_update_request)
|
|
845
|
+
> <PDPConfigResponse> update_pdp_config_api_v1_clients_uid_pdp_config_put(uid, pdp_config_update_request, opts)
|
|
509
846
|
|
|
510
847
|
Configure client PDP
|
|
511
848
|
|
|
512
|
-
Configure or update the PDP (PA/PDP) configuration for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Required fields**: - `flowServiceUrl`: PDP Flow Service URL - `tokenUrl`: PDP OAuth token URL - `oauthClientId`: OAuth Client ID - `clientSecret`: OAuth Client Secret (sent but NEVER returned) **Optional fields**: - `isActive`: Enable/disable the config (default: true) - `modeSandbox`: Sandbox mode (default: false) **Security**: The `clientSecret` is stored encrypted on Django side and is never returned in API responses.
|
|
849
|
+
Configure or update the PDP (PA/PDP) configuration for a client. **Scope**: Client level (JWT with client_uid that must match {uid}) **Required fields**: - `flowServiceUrl`: PDP Flow Service URL - `tokenUrl`: PDP OAuth token URL - `oauthClientId`: OAuth Client ID - `clientSecret`: OAuth Client Secret (sent but NEVER returned) **Optional fields**: - `isActive`: Enable/disable the config (default: true) - `modeSandbox`: Sandbox mode (default: false) - `encryptionMode`: Encryption mode (default: \"fernet\") - \"fernet\": Server-side encryption only - \"double\": Client AES-256-GCM + Server Fernet (requires X-Encryption-Key header) **Double Encryption Mode**: When `encryptionMode` is set to \"double\", you MUST also provide the `X-Encryption-Key` header containing a base64-encoded AES-256 key (32 bytes). This key is used to encrypt the `clientSecret` on the client side before the server encrypts it again with Fernet. The server cannot decrypt the secret without the client key. **Security**: The `clientSecret` is stored encrypted on Django side and is never returned in API responses.
|
|
513
850
|
|
|
514
851
|
### Examples
|
|
515
852
|
|
|
@@ -518,6 +855,11 @@ require 'time'
|
|
|
518
855
|
require 'factpulse'
|
|
519
856
|
# setup authorization
|
|
520
857
|
FactPulse.configure do |config|
|
|
858
|
+
# Configure API key authorization: APIKeyHeader
|
|
859
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
860
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
861
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
862
|
+
|
|
521
863
|
# Configure Bearer authorization: HTTPBearer
|
|
522
864
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
523
865
|
end
|
|
@@ -525,10 +867,13 @@ end
|
|
|
525
867
|
api_instance = FactPulse::ClientManagementApi.new
|
|
526
868
|
uid = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
527
869
|
pdp_config_update_request = FactPulse::PDPConfigUpdateRequest.new({flow_service_url: 'flow_service_url_example', token_url: 'token_url_example', oauth_client_id: 'oauth_client_id_example', client_secret: 'client_secret_example'}) # PDPConfigUpdateRequest |
|
|
870
|
+
opts = {
|
|
871
|
+
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'.
|
|
872
|
+
}
|
|
528
873
|
|
|
529
874
|
begin
|
|
530
875
|
# Configure client PDP
|
|
531
|
-
result = api_instance.update_pdp_config_api_v1_clients_uid_pdp_config_put(uid, pdp_config_update_request)
|
|
876
|
+
result = api_instance.update_pdp_config_api_v1_clients_uid_pdp_config_put(uid, pdp_config_update_request, opts)
|
|
532
877
|
p result
|
|
533
878
|
rescue FactPulse::ApiError => e
|
|
534
879
|
puts "Error when calling ClientManagementApi->update_pdp_config_api_v1_clients_uid_pdp_config_put: #{e}"
|
|
@@ -539,12 +884,12 @@ end
|
|
|
539
884
|
|
|
540
885
|
This returns an Array which contains the response data, status code and headers.
|
|
541
886
|
|
|
542
|
-
> <Array(<PDPConfigResponse>, Integer, Hash)> update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info(uid, pdp_config_update_request)
|
|
887
|
+
> <Array(<PDPConfigResponse>, Integer, Hash)> update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info(uid, pdp_config_update_request, opts)
|
|
543
888
|
|
|
544
889
|
```ruby
|
|
545
890
|
begin
|
|
546
891
|
# Configure client PDP
|
|
547
|
-
data, status_code, headers = api_instance.update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info(uid, pdp_config_update_request)
|
|
892
|
+
data, status_code, headers = api_instance.update_pdp_config_api_v1_clients_uid_pdp_config_put_with_http_info(uid, pdp_config_update_request, opts)
|
|
548
893
|
p status_code # => 2xx
|
|
549
894
|
p headers # => { ... }
|
|
550
895
|
p data # => <PDPConfigResponse>
|
|
@@ -559,6 +904,7 @@ end
|
|
|
559
904
|
| ---- | ---- | ----------- | ----- |
|
|
560
905
|
| **uid** | **String** | | |
|
|
561
906
|
| **pdp_config_update_request** | [**PDPConfigUpdateRequest**](PDPConfigUpdateRequest.md) | | |
|
|
907
|
+
| **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='double'. | [optional] |
|
|
562
908
|
|
|
563
909
|
### Return type
|
|
564
910
|
|
|
@@ -566,7 +912,7 @@ end
|
|
|
566
912
|
|
|
567
913
|
### Authorization
|
|
568
914
|
|
|
569
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
915
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
570
916
|
|
|
571
917
|
### HTTP request headers
|
|
572
918
|
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **overrides** | **Hash<String, Object>** | Sous-ensemble de FacturXInvoice a mettre a jour (merge profond) | [optional] |
|
|
8
|
+
| **callback_url** | **String** | | [optional] |
|
|
9
|
+
| **webhook_mode** | **String** | Mode de livraison webhook: 'inline' ou 'download_url' | [optional][default to 'inline'] |
|
|
8
10
|
|
|
9
11
|
## Example
|
|
10
12
|
|
|
@@ -12,7 +14,9 @@
|
|
|
12
14
|
require 'factpulse'
|
|
13
15
|
|
|
14
16
|
instance = FactPulse::ConvertResumeRequest.new(
|
|
15
|
-
overrides: null
|
|
17
|
+
overrides: null,
|
|
18
|
+
callback_url: null,
|
|
19
|
+
webhook_mode: null
|
|
16
20
|
)
|
|
17
21
|
```
|
|
18
22
|
|
data/docs/DownloadsApi.md
CHANGED
|
@@ -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
|
|
@@ -69,7 +74,7 @@ end
|
|
|
69
74
|
|
|
70
75
|
### Authorization
|
|
71
76
|
|
|
72
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
77
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
73
78
|
|
|
74
79
|
### HTTP request headers
|
|
75
80
|
|
|
@@ -92,6 +97,11 @@ require 'time'
|
|
|
92
97
|
require 'factpulse'
|
|
93
98
|
# setup authorization
|
|
94
99
|
FactPulse.configure do |config|
|
|
100
|
+
# Configure API key authorization: APIKeyHeader
|
|
101
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
102
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
103
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
104
|
+
|
|
95
105
|
# Configure Bearer authorization: HTTPBearer
|
|
96
106
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
97
107
|
end
|
|
@@ -142,7 +152,7 @@ end
|
|
|
142
152
|
|
|
143
153
|
### Authorization
|
|
144
154
|
|
|
145
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
155
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
146
156
|
|
|
147
157
|
### HTTP request headers
|
|
148
158
|
|
|
@@ -25,6 +25,11 @@ require 'time'
|
|
|
25
25
|
require 'factpulse'
|
|
26
26
|
# setup authorization
|
|
27
27
|
FactPulse.configure do |config|
|
|
28
|
+
# Configure API key authorization: APIKeyHeader
|
|
29
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
30
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
31
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
32
|
+
|
|
28
33
|
# Configure Bearer authorization: HTTPBearer
|
|
29
34
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
35
|
end
|
|
@@ -71,7 +76,7 @@ end
|
|
|
71
76
|
|
|
72
77
|
### Authorization
|
|
73
78
|
|
|
74
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
79
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
75
80
|
|
|
76
81
|
### HTTP request headers
|
|
77
82
|
|
|
@@ -94,6 +99,11 @@ require 'time'
|
|
|
94
99
|
require 'factpulse'
|
|
95
100
|
# setup authorization
|
|
96
101
|
FactPulse.configure do |config|
|
|
102
|
+
# Configure API key authorization: APIKeyHeader
|
|
103
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
104
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
105
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
106
|
+
|
|
97
107
|
# Configure Bearer authorization: HTTPBearer
|
|
98
108
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
99
109
|
end
|
|
@@ -154,7 +164,7 @@ end
|
|
|
154
164
|
|
|
155
165
|
### Authorization
|
|
156
166
|
|
|
157
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
167
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
158
168
|
|
|
159
169
|
### HTTP request headers
|
|
160
170
|
|
|
@@ -177,6 +187,11 @@ require 'time'
|
|
|
177
187
|
require 'factpulse'
|
|
178
188
|
# setup authorization
|
|
179
189
|
FactPulse.configure do |config|
|
|
190
|
+
# Configure API key authorization: APIKeyHeader
|
|
191
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
192
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
193
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
194
|
+
|
|
180
195
|
# Configure Bearer authorization: HTTPBearer
|
|
181
196
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
182
197
|
end
|
|
@@ -241,7 +256,7 @@ end
|
|
|
241
256
|
|
|
242
257
|
### Authorization
|
|
243
258
|
|
|
244
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
259
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
245
260
|
|
|
246
261
|
### HTTP request headers
|
|
247
262
|
|
|
@@ -264,6 +279,11 @@ require 'time'
|
|
|
264
279
|
require 'factpulse'
|
|
265
280
|
# setup authorization
|
|
266
281
|
FactPulse.configure do |config|
|
|
282
|
+
# Configure API key authorization: APIKeyHeader
|
|
283
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
|
284
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
285
|
+
# config.api_key_prefix['X-API-Key'] = 'Bearer'
|
|
286
|
+
|
|
267
287
|
# Configure Bearer authorization: HTTPBearer
|
|
268
288
|
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
269
289
|
end
|
|
@@ -310,7 +330,7 @@ end
|
|
|
310
330
|
|
|
311
331
|
### Authorization
|
|
312
332
|
|
|
313
|
-
[HTTPBearer](../README.md#HTTPBearer)
|
|
333
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [HTTPBearer](../README.md#HTTPBearer)
|
|
314
334
|
|
|
315
335
|
### HTTP request headers
|
|
316
336
|
|