factpulse 3.0.32 → 3.0.34
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 +5 -16
- data/Gemfile.lock +1 -1
- data/docs/ActionCodeInfo.md +22 -0
- data/docs/ActionCodesResponse.md +22 -0
- data/docs/BodySubmitCdarApiV1CdarSubmitPost.md +20 -0
- data/docs/BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md +20 -0
- data/docs/CDARCycleDeVieApi.md +489 -0
- data/docs/ChorusProCredentials.md +8 -8
- data/docs/ChorusProDestination.md +1 -1
- data/docs/CreateCDARRequest.md +52 -0
- data/docs/Encaisseamount.md +15 -0
- data/docs/Encaisseamount1.md +15 -0
- data/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +24 -0
- data/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +26 -0
- data/docs/GenerateCDARResponse.md +26 -0
- data/docs/GetChorusProIdRequest.md +1 -1
- data/docs/GetInvoiceRequest.md +1 -1
- data/docs/GetStructureRequest.md +1 -1
- data/docs/ReasonCodeInfo.md +22 -0
- data/docs/ReasonCodesResponse.md +22 -0
- data/docs/RecipientInput.md +26 -0
- data/docs/SearchStructureRequest.md +1 -1
- data/docs/StatusCodeInfo.md +22 -0
- data/docs/StatusCodesResponse.md +22 -0
- data/docs/SubmitCDARRequest.md +54 -0
- data/docs/SubmitCDARResponse.md +24 -0
- data/docs/SubmitCDARXMLRequest.md +22 -0
- data/docs/SubmitInvoiceRequest.md +1 -1
- data/docs/ValidateCDARRequest.md +32 -0
- data/docs/ValidateCDARResponse.md +22 -0
- data/lib/factpulse/api/cdar_cycle_de_vie_api.rb +491 -0
- data/lib/factpulse/helpers/client.rb +17 -1
- data/lib/factpulse/models/action_code_info.rb +220 -0
- data/lib/factpulse/models/action_codes_response.rb +207 -0
- data/lib/factpulse/models/body_submit_cdar_api_v1_cdar_submit_post.rb +174 -0
- data/lib/factpulse/models/body_submit_cdar_xml_api_v1_cdar_submit_xml_post.rb +174 -0
- data/lib/factpulse/models/chorus_pro_credentials.rb +26 -94
- data/lib/factpulse/models/chorus_pro_destination.rb +1 -1
- data/lib/factpulse/models/create_cdar_request.rb +414 -0
- data/lib/factpulse/models/encaisseamount.rb +104 -0
- data/lib/factpulse/models/encaisseamount1.rb +103 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_cdar_validation_error_response.rb +215 -0
- data/lib/factpulse/models/facture_electronique_rest_api_schemas_chorus_pro_chorus_pro_credentials.rb +259 -0
- data/lib/factpulse/models/generate_cdar_response.rb +273 -0
- data/lib/factpulse/models/get_chorus_pro_id_request.rb +1 -1
- data/lib/factpulse/models/get_invoice_request.rb +1 -1
- data/lib/factpulse/models/get_structure_request.rb +1 -1
- data/lib/factpulse/models/reason_code_info.rb +220 -0
- data/lib/factpulse/models/reason_codes_response.rb +207 -0
- data/lib/factpulse/models/recipient_input.rb +191 -0
- data/lib/factpulse/models/search_structure_request.rb +1 -1
- data/lib/factpulse/models/status_code_info.rb +220 -0
- data/lib/factpulse/models/status_codes_response.rb +207 -0
- data/lib/factpulse/models/submit_cdar_request.rb +426 -0
- data/lib/factpulse/models/submit_cdar_response.rb +213 -0
- data/lib/factpulse/models/submit_cdarxml_request.rb +188 -0
- data/lib/factpulse/models/submit_invoice_request.rb +1 -1
- data/lib/factpulse/models/validate_cdar_request.rb +219 -0
- data/lib/factpulse/models/{facture_electronique_rest_api_schemas_processing_chorus_pro_credentials.rb → validate_cdar_response.rb} +47 -48
- data/lib/factpulse/version.rb +1 -1
- data/lib/factpulse.rb +21 -1
- metadata +44 -4
- data/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +0 -26
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eae78264ee3b2ac1f57aeb4e067dece096c2ecde9d822a9727029be8fcbae24e
|
|
4
|
+
data.tar.gz: '07545528aead7e76703579aec585a5290281880ad24ce449aab9818cae17b39b'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c04efc02125978efa3eb6d7c00a4008ed55e4b649826195e50d86b67a6cd0521a65ad4314e2502df70cd8409af029f572ca2dd1c7a2772f7f9ad5d87df351366
|
|
7
|
+
data.tar.gz: 9c2cce5e0b386d5d66a419f5644732f1f6f0118bff230e3d862b11b70cdd237498311df45a9142201770199f50b3bf2dcc316e0f7d4b03d0def3e43b535176da
|
data/CHANGELOG.md
CHANGED
|
@@ -7,22 +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
|
-
## [3.0.
|
|
10
|
+
## [3.0.34] - 2026-01-17
|
|
11
11
|
|
|
12
|
-
###
|
|
13
|
-
-
|
|
14
|
-
- Support complet de l'API FactPulse v1.0.0
|
|
15
|
-
- Endpoints Factur-X (génération, validation)
|
|
16
|
-
- Endpoints AFNOR PDP/PA (Flow Service, Directory Service)
|
|
17
|
-
- Endpoints Chorus Pro (recherche entreprise, soumission factures)
|
|
18
|
-
- Endpoints Signature électronique (PAdES-B-B, PAdES-B-T, PAdES-B-LT)
|
|
19
|
-
- Support des deux modes d'authentification (stored credentials et zero-trust)
|
|
20
|
-
- Documentation complète et exemples
|
|
12
|
+
### Fixed
|
|
13
|
+
- Gestion des erreurs métier (`result.status === "ERROR"`) dans tous les SDK - corrige l'erreur "No content" lors d'échecs de validation
|
|
21
14
|
|
|
22
|
-
### Documentation
|
|
23
|
-
- README.md avec quickstart et exemples
|
|
24
|
-
- Guide d'authentification JWT
|
|
25
|
-
- Configuration avancée (timeout, proxy, debug)
|
|
26
15
|
|
|
27
|
-
[Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v3.0.
|
|
28
|
-
[3.0.
|
|
16
|
+
[Unreleased]: https://github.com/factpulse/sdk-ruby/compare/v3.0.34...HEAD
|
|
17
|
+
[3.0.34]: https://github.com/factpulse/sdk-ruby/releases/tag/v3.0.34
|
data/Gemfile.lock
CHANGED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::ActionCodeInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Code | |
|
|
8
|
+
| **name** | **String** | Nom Python de l'enum | |
|
|
9
|
+
| **description** | **String** | Description | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::ActionCodeInfo.new(
|
|
17
|
+
code: null,
|
|
18
|
+
name: null,
|
|
19
|
+
description: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FactPulse::ActionCodesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **codes** | [**Array<ActionCodeInfo>**](ActionCodeInfo.md) | Liste des codes action | |
|
|
8
|
+
| **count** | **Integer** | Nombre de codes | |
|
|
9
|
+
| **source** | **String** | Règle source | [optional][default to 'BR-FR-CDV-CL-10'] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'factpulse'
|
|
15
|
+
|
|
16
|
+
instance = FactPulse::ActionCodesResponse.new(
|
|
17
|
+
codes: null,
|
|
18
|
+
count: null,
|
|
19
|
+
source: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::BodySubmitCdarApiV1CdarSubmitPost
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request** | [**SubmitCDARRequest**](SubmitCDARRequest.md) | | |
|
|
8
|
+
| **pdp_credentials** | [**PDPCredentials**](PDPCredentials.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::BodySubmitCdarApiV1CdarSubmitPost.new(
|
|
16
|
+
request: null,
|
|
17
|
+
pdp_credentials: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FactPulse::BodySubmitCdarXmlApiV1CdarSubmitXmlPost
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **request** | [**SubmitCDARXMLRequest**](SubmitCDARXMLRequest.md) | | |
|
|
8
|
+
| **pdp_credentials** | [**PDPCredentials**](PDPCredentials.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'factpulse'
|
|
14
|
+
|
|
15
|
+
instance = FactPulse::BodySubmitCdarXmlApiV1CdarSubmitXmlPost.new(
|
|
16
|
+
request: null,
|
|
17
|
+
pdp_credentials: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,489 @@
|
|
|
1
|
+
# FactPulse::CDARCycleDeVieApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://factpulse.fr*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**generate_cdar_api_v1_cdar_generate_post**](CDARCycleDeVieApi.md#generate_cdar_api_v1_cdar_generate_post) | **POST** /api/v1/cdar/generate | Générer un message CDAR |
|
|
8
|
+
| [**get_action_codes_api_v1_cdar_action_codes_get**](CDARCycleDeVieApi.md#get_action_codes_api_v1_cdar_action_codes_get) | **GET** /api/v1/cdar/action-codes | Liste des codes action CDAR |
|
|
9
|
+
| [**get_reason_codes_api_v1_cdar_reason_codes_get**](CDARCycleDeVieApi.md#get_reason_codes_api_v1_cdar_reason_codes_get) | **GET** /api/v1/cdar/reason-codes | Liste des codes motif CDAR |
|
|
10
|
+
| [**get_status_codes_api_v1_cdar_status_codes_get**](CDARCycleDeVieApi.md#get_status_codes_api_v1_cdar_status_codes_get) | **GET** /api/v1/cdar/status-codes | Liste des codes statut CDAR |
|
|
11
|
+
| [**submit_cdar_api_v1_cdar_submit_post**](CDARCycleDeVieApi.md#submit_cdar_api_v1_cdar_submit_post) | **POST** /api/v1/cdar/submit | Générer et soumettre un message CDAR |
|
|
12
|
+
| [**submit_cdar_xml_api_v1_cdar_submit_xml_post**](CDARCycleDeVieApi.md#submit_cdar_xml_api_v1_cdar_submit_xml_post) | **POST** /api/v1/cdar/submit-xml | Soumettre un XML CDAR pré-généré |
|
|
13
|
+
| [**validate_cdar_api_v1_cdar_validate_post**](CDARCycleDeVieApi.md#validate_cdar_api_v1_cdar_validate_post) | **POST** /api/v1/cdar/validate | Valider des données CDAR |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## generate_cdar_api_v1_cdar_generate_post
|
|
17
|
+
|
|
18
|
+
> <GenerateCDARResponse> generate_cdar_api_v1_cdar_generate_post(create_cdar_request)
|
|
19
|
+
|
|
20
|
+
Générer un message CDAR
|
|
21
|
+
|
|
22
|
+
Génère un message XML CDAR (Cross Domain Acknowledgement and Response) pour communiquer le statut d'une facture. **Types de messages:** - **23** (Traitement): Message de cycle de vie standard - **305** (Transmission): Message de transmission entre plateformes **Règles métier:** - BR-FR-CDV-14: Le statut 212 (ENCAISSEE) requiert un montant encaissé - BR-FR-CDV-15: Les statuts 206/207/208/210/213/501 requièrent un code motif
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
require 'time'
|
|
28
|
+
require 'factpulse'
|
|
29
|
+
# setup authorization
|
|
30
|
+
FactPulse.configure do |config|
|
|
31
|
+
# Configure Bearer authorization: HTTPBearer
|
|
32
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
36
|
+
create_cdar_request = FactPulse::CreateCDARRequest.new({document_id: 'document_id_example', sender_siren: 'sender_siren_example', invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, status: 'status_example'}) # CreateCDARRequest |
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
# Générer un message CDAR
|
|
40
|
+
result = api_instance.generate_cdar_api_v1_cdar_generate_post(create_cdar_request)
|
|
41
|
+
p result
|
|
42
|
+
rescue FactPulse::ApiError => e
|
|
43
|
+
puts "Error when calling CDARCycleDeVieApi->generate_cdar_api_v1_cdar_generate_post: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
#### Using the generate_cdar_api_v1_cdar_generate_post_with_http_info variant
|
|
48
|
+
|
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
|
50
|
+
|
|
51
|
+
> <Array(<GenerateCDARResponse>, Integer, Hash)> generate_cdar_api_v1_cdar_generate_post_with_http_info(create_cdar_request)
|
|
52
|
+
|
|
53
|
+
```ruby
|
|
54
|
+
begin
|
|
55
|
+
# Générer un message CDAR
|
|
56
|
+
data, status_code, headers = api_instance.generate_cdar_api_v1_cdar_generate_post_with_http_info(create_cdar_request)
|
|
57
|
+
p status_code # => 2xx
|
|
58
|
+
p headers # => { ... }
|
|
59
|
+
p data # => <GenerateCDARResponse>
|
|
60
|
+
rescue FactPulse::ApiError => e
|
|
61
|
+
puts "Error when calling CDARCycleDeVieApi->generate_cdar_api_v1_cdar_generate_post_with_http_info: #{e}"
|
|
62
|
+
end
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Parameters
|
|
66
|
+
|
|
67
|
+
| Name | Type | Description | Notes |
|
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
|
69
|
+
| **create_cdar_request** | [**CreateCDARRequest**](CreateCDARRequest.md) | | |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**GenerateCDARResponse**](GenerateCDARResponse.md)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: application/json
|
|
82
|
+
- **Accept**: application/json
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## get_action_codes_api_v1_cdar_action_codes_get
|
|
86
|
+
|
|
87
|
+
> <ActionCodesResponse> get_action_codes_api_v1_cdar_action_codes_get
|
|
88
|
+
|
|
89
|
+
Liste des codes action CDAR
|
|
90
|
+
|
|
91
|
+
Retourne la liste complète des codes action (BR-FR-CDV-CL-10). Ces codes indiquent l'action demandée sur la facture.
|
|
92
|
+
|
|
93
|
+
### Examples
|
|
94
|
+
|
|
95
|
+
```ruby
|
|
96
|
+
require 'time'
|
|
97
|
+
require 'factpulse'
|
|
98
|
+
|
|
99
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
100
|
+
|
|
101
|
+
begin
|
|
102
|
+
# Liste des codes action CDAR
|
|
103
|
+
result = api_instance.get_action_codes_api_v1_cdar_action_codes_get
|
|
104
|
+
p result
|
|
105
|
+
rescue FactPulse::ApiError => e
|
|
106
|
+
puts "Error when calling CDARCycleDeVieApi->get_action_codes_api_v1_cdar_action_codes_get: #{e}"
|
|
107
|
+
end
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
#### Using the get_action_codes_api_v1_cdar_action_codes_get_with_http_info variant
|
|
111
|
+
|
|
112
|
+
This returns an Array which contains the response data, status code and headers.
|
|
113
|
+
|
|
114
|
+
> <Array(<ActionCodesResponse>, Integer, Hash)> get_action_codes_api_v1_cdar_action_codes_get_with_http_info
|
|
115
|
+
|
|
116
|
+
```ruby
|
|
117
|
+
begin
|
|
118
|
+
# Liste des codes action CDAR
|
|
119
|
+
data, status_code, headers = api_instance.get_action_codes_api_v1_cdar_action_codes_get_with_http_info
|
|
120
|
+
p status_code # => 2xx
|
|
121
|
+
p headers # => { ... }
|
|
122
|
+
p data # => <ActionCodesResponse>
|
|
123
|
+
rescue FactPulse::ApiError => e
|
|
124
|
+
puts "Error when calling CDARCycleDeVieApi->get_action_codes_api_v1_cdar_action_codes_get_with_http_info: #{e}"
|
|
125
|
+
end
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Parameters
|
|
129
|
+
|
|
130
|
+
This endpoint does not need any parameter.
|
|
131
|
+
|
|
132
|
+
### Return type
|
|
133
|
+
|
|
134
|
+
[**ActionCodesResponse**](ActionCodesResponse.md)
|
|
135
|
+
|
|
136
|
+
### Authorization
|
|
137
|
+
|
|
138
|
+
No authorization required
|
|
139
|
+
|
|
140
|
+
### HTTP request headers
|
|
141
|
+
|
|
142
|
+
- **Content-Type**: Not defined
|
|
143
|
+
- **Accept**: application/json
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
## get_reason_codes_api_v1_cdar_reason_codes_get
|
|
147
|
+
|
|
148
|
+
> <ReasonCodesResponse> get_reason_codes_api_v1_cdar_reason_codes_get
|
|
149
|
+
|
|
150
|
+
Liste des codes motif CDAR
|
|
151
|
+
|
|
152
|
+
Retourne la liste complète des codes motif de statut (BR-FR-CDV-CL-09). Ces codes expliquent la raison d'un statut particulier.
|
|
153
|
+
|
|
154
|
+
### Examples
|
|
155
|
+
|
|
156
|
+
```ruby
|
|
157
|
+
require 'time'
|
|
158
|
+
require 'factpulse'
|
|
159
|
+
|
|
160
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
161
|
+
|
|
162
|
+
begin
|
|
163
|
+
# Liste des codes motif CDAR
|
|
164
|
+
result = api_instance.get_reason_codes_api_v1_cdar_reason_codes_get
|
|
165
|
+
p result
|
|
166
|
+
rescue FactPulse::ApiError => e
|
|
167
|
+
puts "Error when calling CDARCycleDeVieApi->get_reason_codes_api_v1_cdar_reason_codes_get: #{e}"
|
|
168
|
+
end
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
#### Using the get_reason_codes_api_v1_cdar_reason_codes_get_with_http_info variant
|
|
172
|
+
|
|
173
|
+
This returns an Array which contains the response data, status code and headers.
|
|
174
|
+
|
|
175
|
+
> <Array(<ReasonCodesResponse>, Integer, Hash)> get_reason_codes_api_v1_cdar_reason_codes_get_with_http_info
|
|
176
|
+
|
|
177
|
+
```ruby
|
|
178
|
+
begin
|
|
179
|
+
# Liste des codes motif CDAR
|
|
180
|
+
data, status_code, headers = api_instance.get_reason_codes_api_v1_cdar_reason_codes_get_with_http_info
|
|
181
|
+
p status_code # => 2xx
|
|
182
|
+
p headers # => { ... }
|
|
183
|
+
p data # => <ReasonCodesResponse>
|
|
184
|
+
rescue FactPulse::ApiError => e
|
|
185
|
+
puts "Error when calling CDARCycleDeVieApi->get_reason_codes_api_v1_cdar_reason_codes_get_with_http_info: #{e}"
|
|
186
|
+
end
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Parameters
|
|
190
|
+
|
|
191
|
+
This endpoint does not need any parameter.
|
|
192
|
+
|
|
193
|
+
### Return type
|
|
194
|
+
|
|
195
|
+
[**ReasonCodesResponse**](ReasonCodesResponse.md)
|
|
196
|
+
|
|
197
|
+
### Authorization
|
|
198
|
+
|
|
199
|
+
No authorization required
|
|
200
|
+
|
|
201
|
+
### HTTP request headers
|
|
202
|
+
|
|
203
|
+
- **Content-Type**: Not defined
|
|
204
|
+
- **Accept**: application/json
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
## get_status_codes_api_v1_cdar_status_codes_get
|
|
208
|
+
|
|
209
|
+
> <StatusCodesResponse> get_status_codes_api_v1_cdar_status_codes_get
|
|
210
|
+
|
|
211
|
+
Liste des codes statut CDAR
|
|
212
|
+
|
|
213
|
+
Retourne la liste complète des codes statut de facture (BR-FR-CDV-CL-06). Ces codes indiquent l'état du cycle de vie d'une facture.
|
|
214
|
+
|
|
215
|
+
### Examples
|
|
216
|
+
|
|
217
|
+
```ruby
|
|
218
|
+
require 'time'
|
|
219
|
+
require 'factpulse'
|
|
220
|
+
|
|
221
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
222
|
+
|
|
223
|
+
begin
|
|
224
|
+
# Liste des codes statut CDAR
|
|
225
|
+
result = api_instance.get_status_codes_api_v1_cdar_status_codes_get
|
|
226
|
+
p result
|
|
227
|
+
rescue FactPulse::ApiError => e
|
|
228
|
+
puts "Error when calling CDARCycleDeVieApi->get_status_codes_api_v1_cdar_status_codes_get: #{e}"
|
|
229
|
+
end
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
#### Using the get_status_codes_api_v1_cdar_status_codes_get_with_http_info variant
|
|
233
|
+
|
|
234
|
+
This returns an Array which contains the response data, status code and headers.
|
|
235
|
+
|
|
236
|
+
> <Array(<StatusCodesResponse>, Integer, Hash)> get_status_codes_api_v1_cdar_status_codes_get_with_http_info
|
|
237
|
+
|
|
238
|
+
```ruby
|
|
239
|
+
begin
|
|
240
|
+
# Liste des codes statut CDAR
|
|
241
|
+
data, status_code, headers = api_instance.get_status_codes_api_v1_cdar_status_codes_get_with_http_info
|
|
242
|
+
p status_code # => 2xx
|
|
243
|
+
p headers # => { ... }
|
|
244
|
+
p data # => <StatusCodesResponse>
|
|
245
|
+
rescue FactPulse::ApiError => e
|
|
246
|
+
puts "Error when calling CDARCycleDeVieApi->get_status_codes_api_v1_cdar_status_codes_get_with_http_info: #{e}"
|
|
247
|
+
end
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Parameters
|
|
251
|
+
|
|
252
|
+
This endpoint does not need any parameter.
|
|
253
|
+
|
|
254
|
+
### Return type
|
|
255
|
+
|
|
256
|
+
[**StatusCodesResponse**](StatusCodesResponse.md)
|
|
257
|
+
|
|
258
|
+
### Authorization
|
|
259
|
+
|
|
260
|
+
No authorization required
|
|
261
|
+
|
|
262
|
+
### HTTP request headers
|
|
263
|
+
|
|
264
|
+
- **Content-Type**: Not defined
|
|
265
|
+
- **Accept**: application/json
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
## submit_cdar_api_v1_cdar_submit_post
|
|
269
|
+
|
|
270
|
+
> <SubmitCDARResponse> submit_cdar_api_v1_cdar_submit_post(user_id, body_submit_cdar_api_v1_cdar_submit_post, opts)
|
|
271
|
+
|
|
272
|
+
Générer et soumettre un message CDAR
|
|
273
|
+
|
|
274
|
+
Génère un message CDAR et le soumet à la plateforme PA/PDP. Nécessite une authentification AFNOR valide. **Types de flux (flowType):** - `CustomerInvoiceLC`: Cycle de vie côté client (acheteur) - `SupplierInvoiceLC`: Cycle de vie côté fournisseur (vendeur)
|
|
275
|
+
|
|
276
|
+
### Examples
|
|
277
|
+
|
|
278
|
+
```ruby
|
|
279
|
+
require 'time'
|
|
280
|
+
require 'factpulse'
|
|
281
|
+
# setup authorization
|
|
282
|
+
FactPulse.configure do |config|
|
|
283
|
+
# Configure Bearer authorization: HTTPBearer
|
|
284
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
288
|
+
user_id = 56 # Integer |
|
|
289
|
+
body_submit_cdar_api_v1_cdar_submit_post = FactPulse::BodySubmitCdarApiV1CdarSubmitPost.new({request: FactPulse::SubmitCDARRequest.new({document_id: 'document_id_example', sender_siren: 'sender_siren_example', invoice_id: 'invoice_id_example', invoice_issue_date: Date.today, status: 'status_example'})}) # BodySubmitCdarApiV1CdarSubmitPost |
|
|
290
|
+
opts = {
|
|
291
|
+
jwt_token: 'jwt_token_example', # String |
|
|
292
|
+
client_uid: 'client_uid_example' # String |
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
begin
|
|
296
|
+
# Générer et soumettre un message CDAR
|
|
297
|
+
result = api_instance.submit_cdar_api_v1_cdar_submit_post(user_id, body_submit_cdar_api_v1_cdar_submit_post, opts)
|
|
298
|
+
p result
|
|
299
|
+
rescue FactPulse::ApiError => e
|
|
300
|
+
puts "Error when calling CDARCycleDeVieApi->submit_cdar_api_v1_cdar_submit_post: #{e}"
|
|
301
|
+
end
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
#### Using the submit_cdar_api_v1_cdar_submit_post_with_http_info variant
|
|
305
|
+
|
|
306
|
+
This returns an Array which contains the response data, status code and headers.
|
|
307
|
+
|
|
308
|
+
> <Array(<SubmitCDARResponse>, Integer, Hash)> submit_cdar_api_v1_cdar_submit_post_with_http_info(user_id, body_submit_cdar_api_v1_cdar_submit_post, opts)
|
|
309
|
+
|
|
310
|
+
```ruby
|
|
311
|
+
begin
|
|
312
|
+
# Générer et soumettre un message CDAR
|
|
313
|
+
data, status_code, headers = api_instance.submit_cdar_api_v1_cdar_submit_post_with_http_info(user_id, body_submit_cdar_api_v1_cdar_submit_post, opts)
|
|
314
|
+
p status_code # => 2xx
|
|
315
|
+
p headers # => { ... }
|
|
316
|
+
p data # => <SubmitCDARResponse>
|
|
317
|
+
rescue FactPulse::ApiError => e
|
|
318
|
+
puts "Error when calling CDARCycleDeVieApi->submit_cdar_api_v1_cdar_submit_post_with_http_info: #{e}"
|
|
319
|
+
end
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### Parameters
|
|
323
|
+
|
|
324
|
+
| Name | Type | Description | Notes |
|
|
325
|
+
| ---- | ---- | ----------- | ----- |
|
|
326
|
+
| **user_id** | **Integer** | | |
|
|
327
|
+
| **body_submit_cdar_api_v1_cdar_submit_post** | [**BodySubmitCdarApiV1CdarSubmitPost**](BodySubmitCdarApiV1CdarSubmitPost.md) | | |
|
|
328
|
+
| **jwt_token** | **String** | | [optional] |
|
|
329
|
+
| **client_uid** | **String** | | [optional] |
|
|
330
|
+
|
|
331
|
+
### Return type
|
|
332
|
+
|
|
333
|
+
[**SubmitCDARResponse**](SubmitCDARResponse.md)
|
|
334
|
+
|
|
335
|
+
### Authorization
|
|
336
|
+
|
|
337
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
338
|
+
|
|
339
|
+
### HTTP request headers
|
|
340
|
+
|
|
341
|
+
- **Content-Type**: application/json
|
|
342
|
+
- **Accept**: application/json
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
## submit_cdar_xml_api_v1_cdar_submit_xml_post
|
|
346
|
+
|
|
347
|
+
> <SubmitCDARResponse> submit_cdar_xml_api_v1_cdar_submit_xml_post(user_id, body_submit_cdar_xml_api_v1_cdar_submit_xml_post, opts)
|
|
348
|
+
|
|
349
|
+
Soumettre un XML CDAR pré-généré
|
|
350
|
+
|
|
351
|
+
Soumet un message XML CDAR pré-généré à la plateforme PA/PDP. Utile pour soumettre des XML générés par d'autres systèmes.
|
|
352
|
+
|
|
353
|
+
### Examples
|
|
354
|
+
|
|
355
|
+
```ruby
|
|
356
|
+
require 'time'
|
|
357
|
+
require 'factpulse'
|
|
358
|
+
# setup authorization
|
|
359
|
+
FactPulse.configure do |config|
|
|
360
|
+
# Configure Bearer authorization: HTTPBearer
|
|
361
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
362
|
+
end
|
|
363
|
+
|
|
364
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
365
|
+
user_id = 56 # Integer |
|
|
366
|
+
body_submit_cdar_xml_api_v1_cdar_submit_xml_post = FactPulse::BodySubmitCdarXmlApiV1CdarSubmitXmlPost.new({request: FactPulse::SubmitCDARXMLRequest.new({xml: 'xml_example'})}) # BodySubmitCdarXmlApiV1CdarSubmitXmlPost |
|
|
367
|
+
opts = {
|
|
368
|
+
jwt_token: 'jwt_token_example', # String |
|
|
369
|
+
client_uid: 'client_uid_example' # String |
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
begin
|
|
373
|
+
# Soumettre un XML CDAR pré-généré
|
|
374
|
+
result = api_instance.submit_cdar_xml_api_v1_cdar_submit_xml_post(user_id, body_submit_cdar_xml_api_v1_cdar_submit_xml_post, opts)
|
|
375
|
+
p result
|
|
376
|
+
rescue FactPulse::ApiError => e
|
|
377
|
+
puts "Error when calling CDARCycleDeVieApi->submit_cdar_xml_api_v1_cdar_submit_xml_post: #{e}"
|
|
378
|
+
end
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
#### Using the submit_cdar_xml_api_v1_cdar_submit_xml_post_with_http_info variant
|
|
382
|
+
|
|
383
|
+
This returns an Array which contains the response data, status code and headers.
|
|
384
|
+
|
|
385
|
+
> <Array(<SubmitCDARResponse>, Integer, Hash)> submit_cdar_xml_api_v1_cdar_submit_xml_post_with_http_info(user_id, body_submit_cdar_xml_api_v1_cdar_submit_xml_post, opts)
|
|
386
|
+
|
|
387
|
+
```ruby
|
|
388
|
+
begin
|
|
389
|
+
# Soumettre un XML CDAR pré-généré
|
|
390
|
+
data, status_code, headers = api_instance.submit_cdar_xml_api_v1_cdar_submit_xml_post_with_http_info(user_id, body_submit_cdar_xml_api_v1_cdar_submit_xml_post, opts)
|
|
391
|
+
p status_code # => 2xx
|
|
392
|
+
p headers # => { ... }
|
|
393
|
+
p data # => <SubmitCDARResponse>
|
|
394
|
+
rescue FactPulse::ApiError => e
|
|
395
|
+
puts "Error when calling CDARCycleDeVieApi->submit_cdar_xml_api_v1_cdar_submit_xml_post_with_http_info: #{e}"
|
|
396
|
+
end
|
|
397
|
+
```
|
|
398
|
+
|
|
399
|
+
### Parameters
|
|
400
|
+
|
|
401
|
+
| Name | Type | Description | Notes |
|
|
402
|
+
| ---- | ---- | ----------- | ----- |
|
|
403
|
+
| **user_id** | **Integer** | | |
|
|
404
|
+
| **body_submit_cdar_xml_api_v1_cdar_submit_xml_post** | [**BodySubmitCdarXmlApiV1CdarSubmitXmlPost**](BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md) | | |
|
|
405
|
+
| **jwt_token** | **String** | | [optional] |
|
|
406
|
+
| **client_uid** | **String** | | [optional] |
|
|
407
|
+
|
|
408
|
+
### Return type
|
|
409
|
+
|
|
410
|
+
[**SubmitCDARResponse**](SubmitCDARResponse.md)
|
|
411
|
+
|
|
412
|
+
### Authorization
|
|
413
|
+
|
|
414
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
415
|
+
|
|
416
|
+
### HTTP request headers
|
|
417
|
+
|
|
418
|
+
- **Content-Type**: application/json
|
|
419
|
+
- **Accept**: application/json
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
## validate_cdar_api_v1_cdar_validate_post
|
|
423
|
+
|
|
424
|
+
> <ValidateCDARResponse> validate_cdar_api_v1_cdar_validate_post(validate_cdar_request)
|
|
425
|
+
|
|
426
|
+
Valider des données CDAR
|
|
427
|
+
|
|
428
|
+
Valide les données CDAR sans générer le XML. Vérifie: - Les formats des champs (SIREN, dates, etc.) - Les codes enums (statut, motif, action) - Les règles métier BR-FR-CDV-*
|
|
429
|
+
|
|
430
|
+
### Examples
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
require 'time'
|
|
434
|
+
require 'factpulse'
|
|
435
|
+
# setup authorization
|
|
436
|
+
FactPulse.configure do |config|
|
|
437
|
+
# Configure Bearer authorization: HTTPBearer
|
|
438
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
439
|
+
end
|
|
440
|
+
|
|
441
|
+
api_instance = FactPulse::CDARCycleDeVieApi.new
|
|
442
|
+
validate_cdar_request = FactPulse::ValidateCDARRequest.new # ValidateCDARRequest |
|
|
443
|
+
|
|
444
|
+
begin
|
|
445
|
+
# Valider des données CDAR
|
|
446
|
+
result = api_instance.validate_cdar_api_v1_cdar_validate_post(validate_cdar_request)
|
|
447
|
+
p result
|
|
448
|
+
rescue FactPulse::ApiError => e
|
|
449
|
+
puts "Error when calling CDARCycleDeVieApi->validate_cdar_api_v1_cdar_validate_post: #{e}"
|
|
450
|
+
end
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
#### Using the validate_cdar_api_v1_cdar_validate_post_with_http_info variant
|
|
454
|
+
|
|
455
|
+
This returns an Array which contains the response data, status code and headers.
|
|
456
|
+
|
|
457
|
+
> <Array(<ValidateCDARResponse>, Integer, Hash)> validate_cdar_api_v1_cdar_validate_post_with_http_info(validate_cdar_request)
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
begin
|
|
461
|
+
# Valider des données CDAR
|
|
462
|
+
data, status_code, headers = api_instance.validate_cdar_api_v1_cdar_validate_post_with_http_info(validate_cdar_request)
|
|
463
|
+
p status_code # => 2xx
|
|
464
|
+
p headers # => { ... }
|
|
465
|
+
p data # => <ValidateCDARResponse>
|
|
466
|
+
rescue FactPulse::ApiError => e
|
|
467
|
+
puts "Error when calling CDARCycleDeVieApi->validate_cdar_api_v1_cdar_validate_post_with_http_info: #{e}"
|
|
468
|
+
end
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
### Parameters
|
|
472
|
+
|
|
473
|
+
| Name | Type | Description | Notes |
|
|
474
|
+
| ---- | ---- | ----------- | ----- |
|
|
475
|
+
| **validate_cdar_request** | [**ValidateCDARRequest**](ValidateCDARRequest.md) | | |
|
|
476
|
+
|
|
477
|
+
### Return type
|
|
478
|
+
|
|
479
|
+
[**ValidateCDARResponse**](ValidateCDARResponse.md)
|
|
480
|
+
|
|
481
|
+
### Authorization
|
|
482
|
+
|
|
483
|
+
[HTTPBearer](../README.md#HTTPBearer)
|
|
484
|
+
|
|
485
|
+
### HTTP request headers
|
|
486
|
+
|
|
487
|
+
- **Content-Type**: application/json
|
|
488
|
+
- **Accept**: application/json
|
|
489
|
+
|
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **piste_client_id** | **String** |
|
|
8
|
-
| **piste_client_secret** | **String** |
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
7
|
+
| **piste_client_id** | **String** | | [optional] |
|
|
8
|
+
| **piste_client_secret** | **String** | | [optional] |
|
|
9
|
+
| **chorus_login** | **String** | | [optional] |
|
|
10
|
+
| **chorus_password** | **String** | | [optional] |
|
|
11
|
+
| **sandbox_mode** | **Boolean** | [MODE 2] Use sandbox mode (default: True) | [optional][default to true] |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
@@ -18,9 +18,9 @@ require 'factpulse'
|
|
|
18
18
|
instance = FactPulse::ChorusProCredentials.new(
|
|
19
19
|
piste_client_id: null,
|
|
20
20
|
piste_client_secret: null,
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
21
|
+
chorus_login: null,
|
|
22
|
+
chorus_password: null,
|
|
23
|
+
sandbox_mode: null
|
|
24
24
|
)
|
|
25
25
|
```
|
|
26
26
|
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **type** | **String** | | [optional][default to 'chorus_pro'] |
|
|
8
|
-
| **credentials** | [**
|
|
8
|
+
| **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) | | [optional] |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|