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
@@ -0,0 +1,176 @@
1
+ =begin
2
+ #FactPulse REST API
3
+
4
+ # REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### πŸ“„ Factur-X - Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **πŸ†• Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### βœ… Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) ### ✍️ Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification ### πŸ“‹ Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212) ### πŸ“Š Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments) ### πŸ“‘ AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user ### πŸ›οΈ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete ## πŸ”’ Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### πŸ”‘ Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d '{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - βœ… Full automation (CI/CD, scripts) - βœ… Programmatic token management - βœ… Refresh token support for automatic access renewal - βœ… Easy integration in any language/tool #### πŸ–₯️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - βœ… Quick for API testing - βœ… No password required - βœ… Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### πŸ“š Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: contact@factpulse.fr
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.20.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module FactPulse
17
+ # Webhook secret status for a client.
18
+ class WebhookSecretStatusResponse < ApiModelBase
19
+ # Whether a webhook secret is configured
20
+ attr_accessor :has_secret
21
+
22
+ attr_accessor :created_at
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'has_secret' => :'hasSecret',
28
+ :'created_at' => :'createdAt'
29
+ }
30
+ end
31
+
32
+ # Returns attribute mapping this model knows about
33
+ def self.acceptable_attribute_map
34
+ attribute_map
35
+ end
36
+
37
+ # Returns all the JSON keys this model knows about
38
+ def self.acceptable_attributes
39
+ acceptable_attribute_map.values
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.openapi_types
44
+ {
45
+ :'has_secret' => :'Boolean',
46
+ :'created_at' => :'Time'
47
+ }
48
+ end
49
+
50
+ # List of attributes with nullable: true
51
+ def self.openapi_nullable
52
+ Set.new([
53
+ :'created_at'
54
+ ])
55
+ end
56
+
57
+ # Initializes the object
58
+ # @param [Hash] attributes Model attributes in the form of hash
59
+ def initialize(attributes = {})
60
+ if (!attributes.is_a?(Hash))
61
+ fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::WebhookSecretStatusResponse` initialize method"
62
+ end
63
+
64
+ # check to see if the attribute exists and convert string to symbol for hash key
65
+ acceptable_attribute_map = self.class.acceptable_attribute_map
66
+ attributes = attributes.each_with_object({}) { |(k, v), h|
67
+ if (!acceptable_attribute_map.key?(k.to_sym))
68
+ fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::WebhookSecretStatusResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
69
+ end
70
+ h[k.to_sym] = v
71
+ }
72
+
73
+ if attributes.key?(:'has_secret')
74
+ self.has_secret = attributes[:'has_secret']
75
+ else
76
+ self.has_secret = nil
77
+ end
78
+
79
+ if attributes.key?(:'created_at')
80
+ self.created_at = attributes[:'created_at']
81
+ end
82
+ end
83
+
84
+ # Show invalid properties with the reasons. Usually used together with valid?
85
+ # @return Array for valid properties with the reasons
86
+ def list_invalid_properties
87
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
88
+ invalid_properties = Array.new
89
+ if @has_secret.nil?
90
+ invalid_properties.push('invalid value for "has_secret", has_secret cannot be nil.')
91
+ end
92
+
93
+ invalid_properties
94
+ end
95
+
96
+ # Check to see if the all the properties in the model are valid
97
+ # @return true if the model is valid
98
+ def valid?
99
+ warn '[DEPRECATED] the `valid?` method is obsolete'
100
+ return false if @has_secret.nil?
101
+ true
102
+ end
103
+
104
+ # Custom attribute writer method with validation
105
+ # @param [Object] has_secret Value to be assigned
106
+ def has_secret=(has_secret)
107
+ if has_secret.nil?
108
+ fail ArgumentError, 'has_secret cannot be nil'
109
+ end
110
+
111
+ @has_secret = has_secret
112
+ end
113
+
114
+ # Checks equality by comparing each attribute.
115
+ # @param [Object] Object to be compared
116
+ def ==(o)
117
+ return true if self.equal?(o)
118
+ self.class == o.class &&
119
+ has_secret == o.has_secret &&
120
+ created_at == o.created_at
121
+ end
122
+
123
+ # @see the `==` method
124
+ # @param [Object] Object to be compared
125
+ def eql?(o)
126
+ self == o
127
+ end
128
+
129
+ # Calculates hash code according to all attributes.
130
+ # @return [Integer] Hash code
131
+ def hash
132
+ [has_secret, created_at].hash
133
+ end
134
+
135
+ # Builds the object from hash
136
+ # @param [Hash] attributes Model attributes in the form of hash
137
+ # @return [Object] Returns the model itself
138
+ def self.build_from_hash(attributes)
139
+ return nil unless attributes.is_a?(Hash)
140
+ attributes = attributes.transform_keys(&:to_sym)
141
+ transformed_hash = {}
142
+ openapi_types.each_pair do |key, type|
143
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
144
+ transformed_hash["#{key}"] = nil
145
+ elsif type =~ /\AArray<(.*)>/i
146
+ # check to ensure the input is an array given that the attribute
147
+ # is documented as an array but the input is not
148
+ if attributes[attribute_map[key]].is_a?(Array)
149
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
150
+ end
151
+ elsif !attributes[attribute_map[key]].nil?
152
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
153
+ end
154
+ end
155
+ new(transformed_hash)
156
+ end
157
+
158
+ # Returns the object in the form of hash
159
+ # @return [Hash] Returns the object in the form of hash
160
+ def to_hash
161
+ hash = {}
162
+ self.class.attribute_map.each_pair do |attr, param|
163
+ value = self.send(attr)
164
+ if value.nil?
165
+ is_nullable = self.class.openapi_nullable.include?(attr)
166
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
167
+ end
168
+
169
+ hash[param] = _to_hash(value)
170
+ end
171
+ hash
172
+ end
173
+
174
+ end
175
+
176
+ end
@@ -11,5 +11,5 @@ Generator version: 7.20.0-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module FactPulse
14
- VERSION = '4.0.2'
14
+ VERSION = '4.0.3'
15
15
  end
data/lib/factpulse.rb CHANGED
@@ -171,9 +171,9 @@ require 'factpulse/models/error_source'
171
171
  require 'factpulse/models/extraction_info'
172
172
  require 'factpulse/models/factur_x_invoice'
173
173
  require 'factpulse/models/factur_xpdf_info'
174
- require 'factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response'
175
174
  require 'factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials'
176
175
  require 'factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code'
176
+ require 'factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response'
177
177
  require 'factpulse/models/field_status'
178
178
  require 'factpulse/models/file_info'
179
179
  require 'factpulse/models/files_info'
@@ -213,6 +213,8 @@ require 'factpulse/models/invoice_type_code_output'
213
213
  require 'factpulse/models/invoicing_framework'
214
214
  require 'factpulse/models/invoicing_framework_code'
215
215
  require 'factpulse/models/issuer_role_code'
216
+ require 'factpulse/models/key_rotation_request'
217
+ require 'factpulse/models/key_rotation_response'
216
218
  require 'factpulse/models/line_net_amount'
217
219
  require 'factpulse/models/line_sub_type'
218
220
  require 'factpulse/models/line_total_amount'
@@ -324,6 +326,9 @@ require 'factpulse/models/validation_success_response'
324
326
  require 'factpulse/models/vat_rate'
325
327
  require 'factpulse/models/verification_success_response'
326
328
  require 'factpulse/models/verified_field_schema'
329
+ require 'factpulse/models/webhook_secret_delete_response'
330
+ require 'factpulse/models/webhook_secret_generate_response'
331
+ require 'factpulse/models/webhook_secret_status_response'
327
332
 
328
333
  # APIs
329
334
  require 'factpulse/api/afnorpdppa_api'
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: factpulse
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.0.2
4
+ version: 4.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-01-24 00:00:00.000000000 Z
11
+ date: 2026-02-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -282,9 +282,9 @@ files:
282
282
  - docs/FacturXPDFInfo.md
283
283
  - docs/FacturXPDFXMLVerificationApi.md
284
284
  - docs/FacturXValidationApi.md
285
- - docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md
286
285
  - docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md
287
286
  - docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md
287
+ - docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md
288
288
  - docs/FieldStatus.md
289
289
  - docs/FileInfo.md
290
290
  - docs/FilesInfo.md
@@ -327,6 +327,8 @@ files:
327
327
  - docs/InvoicingFramework.md
328
328
  - docs/InvoicingFrameworkCode.md
329
329
  - docs/IssuerRoleCode.md
330
+ - docs/KeyRotationRequest.md
331
+ - docs/KeyRotationResponse.md
330
332
  - docs/LineNetAmount.md
331
333
  - docs/LineSubType.md
332
334
  - docs/LineTotalAmount.md
@@ -438,6 +440,9 @@ files:
438
440
  - docs/VatRate.md
439
441
  - docs/VerificationSuccessResponse.md
440
442
  - docs/VerifiedFieldSchema.md
443
+ - docs/WebhookSecretDeleteResponse.md
444
+ - docs/WebhookSecretGenerateResponse.md
445
+ - docs/WebhookSecretStatusResponse.md
441
446
  - factpulse.gemspec
442
447
  - git_push.sh
443
448
  - lib/factpulse.rb
@@ -616,9 +621,9 @@ files:
616
621
  - lib/factpulse/models/extraction_info.rb
617
622
  - lib/factpulse/models/factur_x_invoice.rb
618
623
  - lib/factpulse/models/factur_xpdf_info.rb
619
- - lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb
620
624
  - lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb
621
625
  - lib/factpulse/models/facture_electronique_rest_api_schemas_ereporting_invoice_type_code.rb
626
+ - lib/factpulse/models/facture_electronique_rest_api_schemas_validation_validation_error_response.rb
622
627
  - lib/factpulse/models/field_status.rb
623
628
  - lib/factpulse/models/file_info.rb
624
629
  - lib/factpulse/models/files_info.rb
@@ -658,6 +663,8 @@ files:
658
663
  - lib/factpulse/models/invoicing_framework.rb
659
664
  - lib/factpulse/models/invoicing_framework_code.rb
660
665
  - lib/factpulse/models/issuer_role_code.rb
666
+ - lib/factpulse/models/key_rotation_request.rb
667
+ - lib/factpulse/models/key_rotation_response.rb
661
668
  - lib/factpulse/models/line_net_amount.rb
662
669
  - lib/factpulse/models/line_sub_type.rb
663
670
  - lib/factpulse/models/line_total_amount.rb
@@ -769,6 +776,9 @@ files:
769
776
  - lib/factpulse/models/vat_rate.rb
770
777
  - lib/factpulse/models/verification_success_response.rb
771
778
  - lib/factpulse/models/verified_field_schema.rb
779
+ - lib/factpulse/models/webhook_secret_delete_response.rb
780
+ - lib/factpulse/models/webhook_secret_generate_response.rb
781
+ - lib/factpulse/models/webhook_secret_status_response.rb
772
782
  - lib/factpulse/version.rb
773
783
  homepage: https://openapi-generator.tech
774
784
  licenses:
@@ -1,24 +0,0 @@
1
- # FactPulse::FactureElectroniqueRestApiSchemasCdarValidationErrorResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **field** | **String** | Champ concernΓ© | |
8
- | **message** | **String** | Message d&#39;erreur | |
9
- | **rule** | **String** | | [optional] |
10
- | **severity** | **String** | SΓ©vΓ©ritΓ© (error/warning) | [optional][default to &#39;error&#39;] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'factpulse'
16
-
17
- instance = FactPulse::FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.new(
18
- field: null,
19
- message: null,
20
- rule: null,
21
- severity: null
22
- )
23
- ```
24
-