@factpulse/sdk 3.0.31 → 3.0.33

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 (212) hide show
  1. package/.openapi-generator/FILES +44 -4
  2. package/CHANGELOG.md +9 -17
  3. package/api/afnorpdppaapi.ts +1 -1
  4. package/api/afnorpdppadirectory-service-api.ts +1 -1
  5. package/api/afnorpdppaflow-service-api.ts +1 -1
  6. package/api/cdarcycle-de-vie-api.ts +603 -0
  7. package/api/chorus-pro-api.ts +1 -1
  8. package/api/document-conversion-api.ts +1 -1
  9. package/api/downloads-api.ts +1 -1
  10. package/api/ereporting-api.ts +1 -1
  11. package/api/health-api.ts +1 -1
  12. package/api/invoice-processing-api.ts +3 -3
  13. package/api/pdfxmlverification-api.ts +1 -1
  14. package/api/user-api.ts +1 -1
  15. package/api.ts +1 -0
  16. package/dist/api/cdarcycle-de-vie-api.d.ts +280 -0
  17. package/dist/api/cdarcycle-de-vie-api.js +569 -0
  18. package/dist/api.d.ts +1 -0
  19. package/dist/api.js +1 -0
  20. package/dist/esm/api/cdarcycle-de-vie-api.d.ts +280 -0
  21. package/dist/esm/api/cdarcycle-de-vie-api.js +559 -0
  22. package/dist/esm/api.d.ts +1 -0
  23. package/dist/esm/api.js +1 -0
  24. package/dist/{models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts → esm/models/action-code-info.d.ts} +12 -8
  25. package/dist/esm/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts → action-codes-response.d.ts} +13 -8
  26. package/dist/esm/models/action-codes-response.js +14 -0
  27. package/dist/esm/models/body-submit-cdar-api-v1-cdar-submit-post.d.ts +17 -0
  28. package/dist/esm/models/body-submit-cdar-api-v1-cdar-submit-post.js +14 -0
  29. package/dist/esm/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +17 -0
  30. package/dist/esm/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js +14 -0
  31. package/dist/esm/models/chorus-pro-credentials.d.ts +7 -19
  32. package/dist/esm/models/chorus-pro-destination.d.ts +2 -2
  33. package/dist/esm/models/create-cdarrequest.d.ts +66 -0
  34. package/dist/esm/models/create-cdarrequest.js +14 -0
  35. package/dist/esm/models/encaisseamount.d.ts +16 -0
  36. package/dist/esm/models/encaisseamount.js +14 -0
  37. package/dist/esm/models/encaisseamount1.d.ts +13 -0
  38. package/dist/esm/models/encaisseamount1.js +14 -0
  39. package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +36 -0
  40. package/dist/esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js +14 -0
  41. package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
  42. package/dist/esm/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +23 -0
  43. package/dist/esm/models/facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts +20 -0
  44. package/dist/esm/models/facture-electronique-rest-api-schemas-validation-validation-error-response.js +14 -0
  45. package/dist/esm/models/generate-cdarresponse.d.ts +33 -0
  46. package/dist/esm/models/generate-cdarresponse.js +14 -0
  47. package/dist/esm/models/get-chorus-pro-id-request.d.ts +2 -2
  48. package/dist/esm/models/get-invoice-request.d.ts +2 -2
  49. package/dist/esm/models/get-structure-request.d.ts +2 -2
  50. package/dist/esm/models/index.d.ts +21 -2
  51. package/dist/esm/models/index.js +21 -2
  52. package/dist/esm/models/invoice-input.d.ts +2 -2
  53. package/dist/esm/models/invoice-type-code.d.ts +65 -6
  54. package/dist/esm/models/invoice-type-code.js +65 -6
  55. package/dist/esm/models/reason-code-info.d.ts +28 -0
  56. package/dist/esm/models/reason-code-info.js +14 -0
  57. package/dist/esm/models/reason-codes-response.d.ts +29 -0
  58. package/dist/esm/models/reason-codes-response.js +14 -0
  59. package/dist/esm/models/recipient-input.d.ts +24 -0
  60. package/dist/esm/models/recipient-input.js +14 -0
  61. package/dist/esm/models/search-structure-request.d.ts +2 -2
  62. package/dist/esm/models/simplified-invoice-data.d.ts +2 -2
  63. package/dist/esm/models/status-code-info.d.ts +28 -0
  64. package/dist/esm/models/status-code-info.js +14 -0
  65. package/dist/esm/models/status-codes-response.d.ts +29 -0
  66. package/dist/esm/models/status-codes-response.js +14 -0
  67. package/dist/esm/models/submit-cdarrequest.d.ts +70 -0
  68. package/dist/esm/models/submit-cdarrequest.js +14 -0
  69. package/dist/esm/models/submit-cdarresponse.d.ts +26 -0
  70. package/dist/esm/models/submit-cdarresponse.js +14 -0
  71. package/dist/esm/models/submit-cdarxmlrequest.d.ts +25 -0
  72. package/dist/esm/models/submit-cdarxmlrequest.js +14 -0
  73. package/dist/esm/models/submit-invoice-request.d.ts +2 -2
  74. package/dist/esm/models/validate-cdarrequest.d.ts +25 -0
  75. package/dist/esm/models/validate-cdarrequest.js +14 -0
  76. package/dist/esm/models/validate-cdarresponse.d.ts +29 -0
  77. package/dist/esm/models/validate-cdarresponse.js +14 -0
  78. package/dist/esm/models/validation-error-response.d.ts +12 -3
  79. package/dist/esm/src/helpers/client.js +3 -0
  80. package/dist/models/action-code-info.d.ts +28 -0
  81. package/dist/models/action-codes-response.d.ts +29 -0
  82. package/dist/models/action-codes-response.js +15 -0
  83. package/dist/models/body-submit-cdar-api-v1-cdar-submit-post.d.ts +17 -0
  84. package/dist/models/body-submit-cdar-api-v1-cdar-submit-post.js +15 -0
  85. package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +17 -0
  86. package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js +15 -0
  87. package/dist/models/chorus-pro-credentials.d.ts +7 -19
  88. package/dist/models/chorus-pro-destination.d.ts +2 -2
  89. package/dist/models/create-cdarrequest.d.ts +66 -0
  90. package/dist/models/create-cdarrequest.js +15 -0
  91. package/dist/models/encaisseamount.d.ts +16 -0
  92. package/dist/models/encaisseamount.js +15 -0
  93. package/dist/models/encaisseamount1.d.ts +13 -0
  94. package/dist/models/encaisseamount1.js +15 -0
  95. package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts +36 -0
  96. package/dist/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js +15 -0
  97. package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.d.ts +22 -0
  98. package/dist/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.js +26 -0
  99. package/dist/models/facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts +20 -0
  100. package/dist/models/facture-electronique-rest-api-schemas-validation-validation-error-response.js +15 -0
  101. package/dist/models/generate-cdarresponse.d.ts +33 -0
  102. package/dist/models/generate-cdarresponse.js +15 -0
  103. package/dist/models/get-chorus-pro-id-request.d.ts +2 -2
  104. package/dist/models/get-invoice-request.d.ts +2 -2
  105. package/dist/models/get-structure-request.d.ts +2 -2
  106. package/dist/models/index.d.ts +21 -2
  107. package/dist/models/index.js +21 -2
  108. package/dist/models/invoice-input.d.ts +2 -2
  109. package/dist/models/invoice-type-code.d.ts +65 -6
  110. package/dist/models/invoice-type-code.js +65 -6
  111. package/dist/models/reason-code-info.d.ts +28 -0
  112. package/dist/models/reason-code-info.js +15 -0
  113. package/dist/models/reason-codes-response.d.ts +29 -0
  114. package/dist/models/reason-codes-response.js +15 -0
  115. package/dist/models/recipient-input.d.ts +24 -0
  116. package/dist/models/recipient-input.js +15 -0
  117. package/dist/models/search-structure-request.d.ts +2 -2
  118. package/dist/models/simplified-invoice-data.d.ts +2 -2
  119. package/dist/models/status-code-info.d.ts +28 -0
  120. package/dist/models/status-code-info.js +15 -0
  121. package/dist/models/status-codes-response.d.ts +29 -0
  122. package/dist/models/status-codes-response.js +15 -0
  123. package/dist/models/submit-cdarrequest.d.ts +70 -0
  124. package/dist/models/submit-cdarrequest.js +15 -0
  125. package/dist/models/submit-cdarresponse.d.ts +26 -0
  126. package/dist/models/submit-cdarresponse.js +15 -0
  127. package/dist/models/submit-cdarxmlrequest.d.ts +25 -0
  128. package/dist/models/submit-cdarxmlrequest.js +15 -0
  129. package/dist/models/submit-invoice-request.d.ts +2 -2
  130. package/dist/models/validate-cdarrequest.d.ts +25 -0
  131. package/dist/models/validate-cdarrequest.js +15 -0
  132. package/dist/models/validate-cdarresponse.d.ts +29 -0
  133. package/dist/models/validate-cdarresponse.js +15 -0
  134. package/dist/models/validation-error-response.d.ts +12 -3
  135. package/dist/src/helpers/client.js +3 -0
  136. package/docs/ActionCodeInfo.md +25 -0
  137. package/docs/ActionCodesResponse.md +25 -0
  138. package/docs/BodySubmitCdarApiV1CdarSubmitPost.md +22 -0
  139. package/docs/BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md +22 -0
  140. package/docs/CDARCycleDeVieApi.md +397 -0
  141. package/docs/ChorusProCredentials.md +9 -9
  142. package/docs/ChorusProDestination.md +1 -1
  143. package/docs/CreateCDARRequest.md +55 -0
  144. package/docs/Encaisseamount.md +19 -0
  145. package/docs/Encaisseamount1.md +18 -0
  146. package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +29 -0
  147. package/docs/FactureElectroniqueRestApiSchemasEreportingInvoiceTypeCode.md +17 -0
  148. package/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +21 -0
  149. package/docs/GenerateCDARResponse.md +29 -0
  150. package/docs/GetChorusProIdRequest.md +1 -1
  151. package/docs/GetInvoiceRequest.md +1 -1
  152. package/docs/GetStructureRequest.md +1 -1
  153. package/docs/InvoiceInput.md +1 -1
  154. package/docs/InvoiceTypeCode.md +28 -6
  155. package/docs/ReasonCodeInfo.md +25 -0
  156. package/docs/ReasonCodesResponse.md +25 -0
  157. package/docs/RecipientInput.md +29 -0
  158. package/docs/SearchStructureRequest.md +1 -1
  159. package/docs/SimplifiedInvoiceData.md +1 -1
  160. package/docs/StatusCodeInfo.md +25 -0
  161. package/docs/StatusCodesResponse.md +25 -0
  162. package/docs/SubmitCDARRequest.md +57 -0
  163. package/docs/SubmitCDARResponse.md +27 -0
  164. package/docs/SubmitCDARXMLRequest.md +25 -0
  165. package/docs/SubmitInvoiceRequest.md +1 -1
  166. package/docs/ValidateCDARRequest.md +35 -0
  167. package/docs/ValidateCDARResponse.md +25 -0
  168. package/docs/ValidationErrorResponse.md +9 -3
  169. package/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.ts → action-code-info.ts} +12 -8
  170. package/models/action-codes-response.ts +37 -0
  171. package/models/body-submit-cdar-api-v1-cdar-submit-post.ts +27 -0
  172. package/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.ts +27 -0
  173. package/models/chorus-pro-credentials.ts +7 -19
  174. package/models/chorus-pro-destination.ts +2 -2
  175. package/models/create-cdarrequest.ts +76 -0
  176. package/models/encaisseamount.ts +22 -0
  177. package/models/encaisseamount1.ts +19 -0
  178. package/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts +42 -0
  179. package/models/facture-electronique-rest-api-schemas-ereporting-invoice-type-code.ts +32 -0
  180. package/models/facture-electronique-rest-api-schemas-validation-validation-error-response.ts +26 -0
  181. package/models/generate-cdarresponse.ts +39 -0
  182. package/models/get-chorus-pro-id-request.ts +2 -2
  183. package/models/get-invoice-request.ts +2 -2
  184. package/models/get-structure-request.ts +2 -2
  185. package/models/index.ts +21 -2
  186. package/models/invoice-input.ts +2 -2
  187. package/models/invoice-type-code.ts +65 -6
  188. package/models/reason-code-info.ts +34 -0
  189. package/models/reason-codes-response.ts +37 -0
  190. package/models/recipient-input.ts +30 -0
  191. package/models/search-structure-request.ts +2 -2
  192. package/models/simplified-invoice-data.ts +2 -2
  193. package/models/status-code-info.ts +34 -0
  194. package/models/status-codes-response.ts +37 -0
  195. package/models/submit-cdarrequest.ts +80 -0
  196. package/models/submit-cdarresponse.ts +32 -0
  197. package/models/submit-cdarxmlrequest.ts +31 -0
  198. package/models/submit-invoice-request.ts +2 -2
  199. package/models/validate-cdarrequest.ts +33 -0
  200. package/models/validate-cdarresponse.ts +37 -0
  201. package/models/validation-error-response.ts +12 -3
  202. package/package.json +1 -1
  203. package/src/helpers/client.ts +3 -0
  204. package/dist/esm/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
  205. package/dist/esm/models/facture-electronique-models-invoice-type-code.js +0 -82
  206. package/dist/models/facture-electronique-models-invoice-type-code.d.ts +0 -81
  207. package/dist/models/facture-electronique-models-invoice-type-code.js +0 -85
  208. package/docs/FactureElectroniqueModelsInvoiceTypeCode.md +0 -39
  209. package/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +0 -29
  210. package/models/facture-electronique-models-invoice-type-code.ts +0 -91
  211. /package/dist/esm/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js → action-code-info.js} +0 -0
  212. /package/dist/models/{facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js → action-code-info.js} +0 -0
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * FactPulse REST API
6
+ * REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice 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) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF 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 - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 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/
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: contact@factpulse.fr
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -10,11 +10,20 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Response for validation errors.
13
+ * Erreur de validation.
14
14
  */
15
15
  export interface ValidationErrorResponse {
16
16
  /**
17
- * List of detected validation errors.
17
+ * Champ concerné
18
18
  */
19
- 'detail': Array<string>;
19
+ 'field': string;
20
+ /**
21
+ * Message d\'erreur
22
+ */
23
+ 'message': string;
24
+ 'rule'?: string | null;
25
+ /**
26
+ * Sévérité (error/warning)
27
+ */
28
+ 'severity'?: string;
20
29
  }
@@ -861,6 +861,9 @@ class FactPulseClient {
861
861
  if (validate) {
862
862
  const validation = yield this.validateFacturxPdf(pdfBuffer, { profile });
863
863
  result.validation = validation;
864
+ if (!validation.isCompliant) {
865
+ return result;
866
+ }
864
867
  }
865
868
  // 3. Signature (uses the server-configured certificate)
866
869
  if (sign) {
@@ -0,0 +1,25 @@
1
+ # ActionCodeInfo
2
+
3
+ Information sur un code action.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **code** | **string** | Code | [default to undefined]
10
+ **name** | **string** | Nom Python de l\&#39;enum | [default to undefined]
11
+ **description** | **string** | Description | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { ActionCodeInfo } from '@factpulse/sdk';
17
+
18
+ const instance: ActionCodeInfo = {
19
+ code,
20
+ name,
21
+ description,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,25 @@
1
+ # ActionCodesResponse
2
+
3
+ Liste des codes action disponibles.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **codes** | [**Array&lt;ActionCodeInfo&gt;**](ActionCodeInfo.md) | Liste des codes action | [default to undefined]
10
+ **count** | **number** | Nombre de codes | [default to undefined]
11
+ **source** | **string** | Règle source | [optional] [default to 'BR-FR-CDV-CL-10']
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { ActionCodesResponse } from '@factpulse/sdk';
17
+
18
+ const instance: ActionCodesResponse = {
19
+ codes,
20
+ count,
21
+ source,
22
+ };
23
+ ```
24
+
25
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # BodySubmitCdarApiV1CdarSubmitPost
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **request** | [**SubmitCDARRequest**](SubmitCDARRequest.md) | | [default to undefined]
9
+ **pdp_credentials** | [**PDPCredentials**](PDPCredentials.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { BodySubmitCdarApiV1CdarSubmitPost } from '@factpulse/sdk';
15
+
16
+ const instance: BodySubmitCdarApiV1CdarSubmitPost = {
17
+ request,
18
+ pdp_credentials,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # BodySubmitCdarXmlApiV1CdarSubmitXmlPost
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **request** | [**SubmitCDARXMLRequest**](SubmitCDARXMLRequest.md) | | [default to undefined]
9
+ **pdp_credentials** | [**PDPCredentials**](PDPCredentials.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { BodySubmitCdarXmlApiV1CdarSubmitXmlPost } from '@factpulse/sdk';
15
+
16
+ const instance: BodySubmitCdarXmlApiV1CdarSubmitXmlPost = {
17
+ request,
18
+ pdp_credentials,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,397 @@
1
+ # CDARCycleDeVieApi
2
+
3
+ All URIs are relative to *https://factpulse.fr*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**generateCdarApiV1CdarGeneratePost**](#generatecdarapiv1cdargeneratepost) | **POST** /api/v1/cdar/generate | Générer un message CDAR|
8
+ |[**getActionCodesApiV1CdarActionCodesGet**](#getactioncodesapiv1cdaractioncodesget) | **GET** /api/v1/cdar/action-codes | Liste des codes action CDAR|
9
+ |[**getReasonCodesApiV1CdarReasonCodesGet**](#getreasoncodesapiv1cdarreasoncodesget) | **GET** /api/v1/cdar/reason-codes | Liste des codes motif CDAR|
10
+ |[**getStatusCodesApiV1CdarStatusCodesGet**](#getstatuscodesapiv1cdarstatuscodesget) | **GET** /api/v1/cdar/status-codes | Liste des codes statut CDAR|
11
+ |[**submitCdarApiV1CdarSubmitPost**](#submitcdarapiv1cdarsubmitpost) | **POST** /api/v1/cdar/submit | Générer et soumettre un message CDAR|
12
+ |[**submitCdarXmlApiV1CdarSubmitXmlPost**](#submitcdarxmlapiv1cdarsubmitxmlpost) | **POST** /api/v1/cdar/submit-xml | Soumettre un XML CDAR pré-généré|
13
+ |[**validateCdarApiV1CdarValidatePost**](#validatecdarapiv1cdarvalidatepost) | **POST** /api/v1/cdar/validate | Valider des données CDAR|
14
+
15
+ # **generateCdarApiV1CdarGeneratePost**
16
+ > GenerateCDARResponse generateCdarApiV1CdarGeneratePost(createCDARRequest)
17
+
18
+ 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
19
+
20
+ ### Example
21
+
22
+ ```typescript
23
+ import {
24
+ CDARCycleDeVieApi,
25
+ Configuration,
26
+ CreateCDARRequest
27
+ } from '@factpulse/sdk';
28
+
29
+ const configuration = new Configuration();
30
+ const apiInstance = new CDARCycleDeVieApi(configuration);
31
+
32
+ let createCDARRequest: CreateCDARRequest; //
33
+
34
+ const { status, data } = await apiInstance.generateCdarApiV1CdarGeneratePost(
35
+ createCDARRequest
36
+ );
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes|
42
+ |------------- | ------------- | ------------- | -------------|
43
+ | **createCDARRequest** | **CreateCDARRequest**| | |
44
+
45
+
46
+ ### Return type
47
+
48
+ **GenerateCDARResponse**
49
+
50
+ ### Authorization
51
+
52
+ [HTTPBearer](../README.md#HTTPBearer)
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: application/json
57
+ - **Accept**: application/json
58
+
59
+
60
+ ### HTTP response details
61
+ | Status code | Description | Response headers |
62
+ |-------------|-------------|------------------|
63
+ |**200** | Successful Response | - |
64
+ |**400** | Requête invalide | - |
65
+ |**422** | Erreur de validation | - |
66
+ |**500** | Erreur serveur | - |
67
+ |**401** | Authentication required - Invalid or missing JWT token | - |
68
+
69
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
70
+
71
+ # **getActionCodesApiV1CdarActionCodesGet**
72
+ > ActionCodesResponse getActionCodesApiV1CdarActionCodesGet()
73
+
74
+ Retourne la liste complète des codes action (BR-FR-CDV-CL-10). Ces codes indiquent l\'action demandée sur la facture.
75
+
76
+ ### Example
77
+
78
+ ```typescript
79
+ import {
80
+ CDARCycleDeVieApi,
81
+ Configuration
82
+ } from '@factpulse/sdk';
83
+
84
+ const configuration = new Configuration();
85
+ const apiInstance = new CDARCycleDeVieApi(configuration);
86
+
87
+ const { status, data } = await apiInstance.getActionCodesApiV1CdarActionCodesGet();
88
+ ```
89
+
90
+ ### Parameters
91
+ This endpoint does not have any parameters.
92
+
93
+
94
+ ### Return type
95
+
96
+ **ActionCodesResponse**
97
+
98
+ ### Authorization
99
+
100
+ No authorization required
101
+
102
+ ### HTTP request headers
103
+
104
+ - **Content-Type**: Not defined
105
+ - **Accept**: application/json
106
+
107
+
108
+ ### HTTP response details
109
+ | Status code | Description | Response headers |
110
+ |-------------|-------------|------------------|
111
+ |**200** | Successful Response | - |
112
+ |**400** | Requête invalide | - |
113
+ |**422** | Erreur de validation | - |
114
+ |**500** | Erreur serveur | - |
115
+
116
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
117
+
118
+ # **getReasonCodesApiV1CdarReasonCodesGet**
119
+ > ReasonCodesResponse getReasonCodesApiV1CdarReasonCodesGet()
120
+
121
+ Retourne la liste complète des codes motif de statut (BR-FR-CDV-CL-09). Ces codes expliquent la raison d\'un statut particulier.
122
+
123
+ ### Example
124
+
125
+ ```typescript
126
+ import {
127
+ CDARCycleDeVieApi,
128
+ Configuration
129
+ } from '@factpulse/sdk';
130
+
131
+ const configuration = new Configuration();
132
+ const apiInstance = new CDARCycleDeVieApi(configuration);
133
+
134
+ const { status, data } = await apiInstance.getReasonCodesApiV1CdarReasonCodesGet();
135
+ ```
136
+
137
+ ### Parameters
138
+ This endpoint does not have any parameters.
139
+
140
+
141
+ ### Return type
142
+
143
+ **ReasonCodesResponse**
144
+
145
+ ### Authorization
146
+
147
+ No authorization required
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: Not defined
152
+ - **Accept**: application/json
153
+
154
+
155
+ ### HTTP response details
156
+ | Status code | Description | Response headers |
157
+ |-------------|-------------|------------------|
158
+ |**200** | Successful Response | - |
159
+ |**400** | Requête invalide | - |
160
+ |**422** | Erreur de validation | - |
161
+ |**500** | Erreur serveur | - |
162
+
163
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
164
+
165
+ # **getStatusCodesApiV1CdarStatusCodesGet**
166
+ > StatusCodesResponse getStatusCodesApiV1CdarStatusCodesGet()
167
+
168
+ 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.
169
+
170
+ ### Example
171
+
172
+ ```typescript
173
+ import {
174
+ CDARCycleDeVieApi,
175
+ Configuration
176
+ } from '@factpulse/sdk';
177
+
178
+ const configuration = new Configuration();
179
+ const apiInstance = new CDARCycleDeVieApi(configuration);
180
+
181
+ const { status, data } = await apiInstance.getStatusCodesApiV1CdarStatusCodesGet();
182
+ ```
183
+
184
+ ### Parameters
185
+ This endpoint does not have any parameters.
186
+
187
+
188
+ ### Return type
189
+
190
+ **StatusCodesResponse**
191
+
192
+ ### Authorization
193
+
194
+ No authorization required
195
+
196
+ ### HTTP request headers
197
+
198
+ - **Content-Type**: Not defined
199
+ - **Accept**: application/json
200
+
201
+
202
+ ### HTTP response details
203
+ | Status code | Description | Response headers |
204
+ |-------------|-------------|------------------|
205
+ |**200** | Successful Response | - |
206
+ |**400** | Requête invalide | - |
207
+ |**422** | Erreur de validation | - |
208
+ |**500** | Erreur serveur | - |
209
+
210
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
211
+
212
+ # **submitCdarApiV1CdarSubmitPost**
213
+ > SubmitCDARResponse submitCdarApiV1CdarSubmitPost(bodySubmitCdarApiV1CdarSubmitPost)
214
+
215
+ 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)
216
+
217
+ ### Example
218
+
219
+ ```typescript
220
+ import {
221
+ CDARCycleDeVieApi,
222
+ Configuration,
223
+ BodySubmitCdarApiV1CdarSubmitPost
224
+ } from '@factpulse/sdk';
225
+
226
+ const configuration = new Configuration();
227
+ const apiInstance = new CDARCycleDeVieApi(configuration);
228
+
229
+ let userId: number; // (default to undefined)
230
+ let bodySubmitCdarApiV1CdarSubmitPost: BodySubmitCdarApiV1CdarSubmitPost; //
231
+ let jwtToken: string; // (optional) (default to undefined)
232
+ let clientUid: string; // (optional) (default to undefined)
233
+
234
+ const { status, data } = await apiInstance.submitCdarApiV1CdarSubmitPost(
235
+ userId,
236
+ bodySubmitCdarApiV1CdarSubmitPost,
237
+ jwtToken,
238
+ clientUid
239
+ );
240
+ ```
241
+
242
+ ### Parameters
243
+
244
+ |Name | Type | Description | Notes|
245
+ |------------- | ------------- | ------------- | -------------|
246
+ | **bodySubmitCdarApiV1CdarSubmitPost** | **BodySubmitCdarApiV1CdarSubmitPost**| | |
247
+ | **userId** | [**number**] | | defaults to undefined|
248
+ | **jwtToken** | [**string**] | | (optional) defaults to undefined|
249
+ | **clientUid** | [**string**] | | (optional) defaults to undefined|
250
+
251
+
252
+ ### Return type
253
+
254
+ **SubmitCDARResponse**
255
+
256
+ ### Authorization
257
+
258
+ [HTTPBearer](../README.md#HTTPBearer)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: application/json
263
+ - **Accept**: application/json
264
+
265
+
266
+ ### HTTP response details
267
+ | Status code | Description | Response headers |
268
+ |-------------|-------------|------------------|
269
+ |**200** | Successful Response | - |
270
+ |**400** | Requête invalide | - |
271
+ |**422** | Erreur de validation | - |
272
+ |**500** | Erreur serveur | - |
273
+ |**401** | Authentication required - Invalid or missing JWT token | - |
274
+
275
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
276
+
277
+ # **submitCdarXmlApiV1CdarSubmitXmlPost**
278
+ > SubmitCDARResponse submitCdarXmlApiV1CdarSubmitXmlPost(bodySubmitCdarXmlApiV1CdarSubmitXmlPost)
279
+
280
+ 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.
281
+
282
+ ### Example
283
+
284
+ ```typescript
285
+ import {
286
+ CDARCycleDeVieApi,
287
+ Configuration,
288
+ BodySubmitCdarXmlApiV1CdarSubmitXmlPost
289
+ } from '@factpulse/sdk';
290
+
291
+ const configuration = new Configuration();
292
+ const apiInstance = new CDARCycleDeVieApi(configuration);
293
+
294
+ let userId: number; // (default to undefined)
295
+ let bodySubmitCdarXmlApiV1CdarSubmitXmlPost: BodySubmitCdarXmlApiV1CdarSubmitXmlPost; //
296
+ let jwtToken: string; // (optional) (default to undefined)
297
+ let clientUid: string; // (optional) (default to undefined)
298
+
299
+ const { status, data } = await apiInstance.submitCdarXmlApiV1CdarSubmitXmlPost(
300
+ userId,
301
+ bodySubmitCdarXmlApiV1CdarSubmitXmlPost,
302
+ jwtToken,
303
+ clientUid
304
+ );
305
+ ```
306
+
307
+ ### Parameters
308
+
309
+ |Name | Type | Description | Notes|
310
+ |------------- | ------------- | ------------- | -------------|
311
+ | **bodySubmitCdarXmlApiV1CdarSubmitXmlPost** | **BodySubmitCdarXmlApiV1CdarSubmitXmlPost**| | |
312
+ | **userId** | [**number**] | | defaults to undefined|
313
+ | **jwtToken** | [**string**] | | (optional) defaults to undefined|
314
+ | **clientUid** | [**string**] | | (optional) defaults to undefined|
315
+
316
+
317
+ ### Return type
318
+
319
+ **SubmitCDARResponse**
320
+
321
+ ### Authorization
322
+
323
+ [HTTPBearer](../README.md#HTTPBearer)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: application/json
328
+ - **Accept**: application/json
329
+
330
+
331
+ ### HTTP response details
332
+ | Status code | Description | Response headers |
333
+ |-------------|-------------|------------------|
334
+ |**200** | Successful Response | - |
335
+ |**400** | Requête invalide | - |
336
+ |**422** | Erreur de validation | - |
337
+ |**500** | Erreur serveur | - |
338
+ |**401** | Authentication required - Invalid or missing JWT token | - |
339
+
340
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
341
+
342
+ # **validateCdarApiV1CdarValidatePost**
343
+ > ValidateCDARResponse validateCdarApiV1CdarValidatePost(validateCDARRequest)
344
+
345
+ 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-*
346
+
347
+ ### Example
348
+
349
+ ```typescript
350
+ import {
351
+ CDARCycleDeVieApi,
352
+ Configuration,
353
+ ValidateCDARRequest
354
+ } from '@factpulse/sdk';
355
+
356
+ const configuration = new Configuration();
357
+ const apiInstance = new CDARCycleDeVieApi(configuration);
358
+
359
+ let validateCDARRequest: ValidateCDARRequest; //
360
+
361
+ const { status, data } = await apiInstance.validateCdarApiV1CdarValidatePost(
362
+ validateCDARRequest
363
+ );
364
+ ```
365
+
366
+ ### Parameters
367
+
368
+ |Name | Type | Description | Notes|
369
+ |------------- | ------------- | ------------- | -------------|
370
+ | **validateCDARRequest** | **ValidateCDARRequest**| | |
371
+
372
+
373
+ ### Return type
374
+
375
+ **ValidateCDARResponse**
376
+
377
+ ### Authorization
378
+
379
+ [HTTPBearer](../README.md#HTTPBearer)
380
+
381
+ ### HTTP request headers
382
+
383
+ - **Content-Type**: application/json
384
+ - **Accept**: application/json
385
+
386
+
387
+ ### HTTP response details
388
+ | Status code | Description | Response headers |
389
+ |-------------|-------------|------------------|
390
+ |**200** | Successful Response | - |
391
+ |**400** | Requête invalide | - |
392
+ |**422** | Erreur de validation | - |
393
+ |**500** | Erreur serveur | - |
394
+ |**401** | Authentication required - Invalid or missing JWT token | - |
395
+
396
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
397
+
@@ -1,16 +1,16 @@
1
1
  # ChorusProCredentials
2
2
 
3
- Chorus Pro credentials for Zero-Trust mode. **Zero-Trust Mode**: Credentials are passed in each request and are NEVER stored. **Security**: - Credentials are never persisted in the database - They are used only for the duration of the request - Secure transmission via HTTPS **Use cases**: - High-security environments (banks, administrations) - Strict GDPR compliance - Tests with temporary credentials - Users who don\'t want to store their credentials
3
+ Optional Chorus Pro credentials. **MODE 1 - JWT retrieval (recommended):** Do not provide this `credentials` field in the payload. Credentials will be automatically retrieved via client_uid from JWT (0-trust). **MODE 2 - Credentials in payload:** Provide all required fields below. Useful for tests or third-party integrations.
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **pisteClientId** | **string** | PISTE Client ID (government API portal) | [default to undefined]
10
- **pisteClientSecret** | **string** | PISTE Client Secret | [default to undefined]
11
- **chorusProLogin** | **string** | Chorus Pro login | [default to undefined]
12
- **chorusProPassword** | **string** | Chorus Pro password | [default to undefined]
13
- **sandbox** | **boolean** | Use sandbox environment (true) or production (false) | [optional] [default to true]
9
+ **pisteClientId** | **string** | | [optional] [default to undefined]
10
+ **pisteClientSecret** | **string** | | [optional] [default to undefined]
11
+ **chorusLogin** | **string** | | [optional] [default to undefined]
12
+ **chorusPassword** | **string** | | [optional] [default to undefined]
13
+ **sandboxMode** | **boolean** | [MODE 2] Use sandbox mode (default: True) | [optional] [default to true]
14
14
 
15
15
  ## Example
16
16
 
@@ -20,9 +20,9 @@ import { ChorusProCredentials } from '@factpulse/sdk';
20
20
  const instance: ChorusProCredentials = {
21
21
  pisteClientId,
22
22
  pisteClientSecret,
23
- chorusProLogin,
24
- chorusProPassword,
25
- sandbox,
23
+ chorusLogin,
24
+ chorusPassword,
25
+ sandboxMode,
26
26
  };
27
27
  ```
28
28
 
@@ -7,7 +7,7 @@ Specific configuration for Chorus Pro destination.
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **type** | **string** | | [optional] [default to TypeEnum_ChorusPro]
10
- **credentials** | [**FactureElectroniqueRestApiSchemasProcessingChorusProCredentials**](FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md) | | [optional] [default to undefined]
10
+ **credentials** | [**ChorusProCredentials**](ChorusProCredentials.md) | | [optional] [default to undefined]
11
11
 
12
12
  ## Example
13
13
 
@@ -0,0 +1,55 @@
1
+ # CreateCDARRequest
2
+
3
+ Requête de création d\'un message CDAR.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **documentId** | **string** | Identifiant unique du message CDAR | [default to undefined]
10
+ **businessProcess** | **string** | Code processus métier (REGULATED, B2C, B2BINT, etc.) | [optional] [default to 'REGULATED']
11
+ **typeCode** | **string** | Type de message (23&#x3D;Traitement, 305&#x3D;Transmission) | [optional] [default to '23']
12
+ **senderSiren** | **string** | SIREN de l\&#39;émetteur (9 chiffres) | [default to undefined]
13
+ **senderRole** | **string** | Rôle de l\&#39;émetteur (WK, SE, BY, etc.) | [optional] [default to 'WK']
14
+ **senderName** | **string** | | [optional] [default to undefined]
15
+ **senderEmail** | **string** | | [optional] [default to undefined]
16
+ **recipients** | [**Array&lt;RecipientInput&gt;**](RecipientInput.md) | Liste des destinataires | [optional] [default to undefined]
17
+ **invoiceId** | **string** | Identifiant de la facture (BT-1) | [default to undefined]
18
+ **invoiceIssueDate** | **string** | Date d\&#39;émission de la facture (YYYY-MM-DD) | [default to undefined]
19
+ **invoiceTypeCode** | **string** | Type de document (380&#x3D;Facture, 381&#x3D;Avoir) | [optional] [default to '380']
20
+ **invoiceSellerSiren** | **string** | | [optional] [default to undefined]
21
+ **invoiceBuyerSiren** | **string** | | [optional] [default to undefined]
22
+ **status** | **string** | Code statut de la facture (200-601) | [default to undefined]
23
+ **reasonCode** | **string** | | [optional] [default to undefined]
24
+ **reasonText** | **string** | | [optional] [default to undefined]
25
+ **actionCode** | **string** | | [optional] [default to undefined]
26
+ **encaisseAmount** | [**Encaisseamount**](Encaisseamount.md) | | [optional] [default to undefined]
27
+
28
+ ## Example
29
+
30
+ ```typescript
31
+ import { CreateCDARRequest } from '@factpulse/sdk';
32
+
33
+ const instance: CreateCDARRequest = {
34
+ documentId,
35
+ businessProcess,
36
+ typeCode,
37
+ senderSiren,
38
+ senderRole,
39
+ senderName,
40
+ senderEmail,
41
+ recipients,
42
+ invoiceId,
43
+ invoiceIssueDate,
44
+ invoiceTypeCode,
45
+ invoiceSellerSiren,
46
+ invoiceBuyerSiren,
47
+ status,
48
+ reasonCode,
49
+ reasonText,
50
+ actionCode,
51
+ encaisseAmount,
52
+ };
53
+ ```
54
+
55
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,19 @@
1
+ # Encaisseamount
2
+
3
+ Montant encaissé (requis pour statut 212)
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { Encaisseamount } from '@factpulse/sdk';
14
+
15
+ const instance: Encaisseamount = {
16
+ };
17
+ ```
18
+
19
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)