@factpulse/sdk 3.0.9 → 3.0.13

package/dist/models/verified-field-schema.d.ts

@@ -1,9 +1,9 @@
 /**
  * FactPulse REST API
- *  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://www.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://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://www.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://www.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://www.factpulse.fr/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://www.factpulse.fr/documentation-api/
+ *  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/
  *
  * The version of the OpenAPI document: 1.0.0
- *
+ * Contact: contact@factpulse.fr
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/dist/models/verified-field-schema.js

@@ -3,10 +3,10 @@
 /* eslint-disable */
 /**
  * FactPulse REST API
- *  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://www.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://www.factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API  **Request example:** ```bash curl -X POST https://www.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://www.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://www.factpulse.fr/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://www.factpulse.fr/documentation-api/
+ *  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/
  *
  * The version of the OpenAPI document: 1.0.0
- *
+ * Contact: contact@factpulse.fr
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/docs/AFNORAcknowledgement.md

@@ -0,0 +1,22 @@
+# AFNORAcknowledgement
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**AFNORFlowAckStatus**](AFNORFlowAckStatus.md) |  | [default to undefined]
+**details** | [**Array<AFNORAcknowledgementDetail>**](AFNORAcknowledgementDetail.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORAcknowledgement } from '@factpulse/sdk';
+
+const instance: AFNORAcknowledgement = {
+    status,
+    details,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORAcknowledgementDetail.md

@@ -0,0 +1,26 @@
+# AFNORAcknowledgementDetail
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **string** |  | [default to undefined]
+**item** | **string** | Item on which the error refers | [default to undefined]
+**reasonCode** | [**AFNORReasonCode**](AFNORReasonCode.md) |  | [default to undefined]
+**reasonMessage** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORAcknowledgementDetail } from '@factpulse/sdk';
+
+const instance: AFNORAcknowledgementDetail = {
+    level,
+    item,
+    reasonCode,
+    reasonMessage,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORAddressEdit.md

@@ -0,0 +1,33 @@
+# AFNORAddressEdit
+
+Wrapper for postal addresses without country name.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ligneAdresse1** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**ligneAdresse2** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**ligneAdresse3** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**postalCode** | **string** | Service postal code | [optional] [default to undefined]
+**countrySubdivision** | **string** | Subdivision of the country | [optional] [default to undefined]
+**locality** | **string** | Municipality of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**codePays** | **string** | Corresponds to the country of the recipient structure. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORAddressEdit } from '@factpulse/sdk';
+
+const instance: AFNORAddressEdit = {
+    ligneAdresse1,
+    ligneAdresse2,
+    ligneAdresse3,
+    postalCode,
+    countrySubdivision,
+    locality,
+    codePays,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORAddressPatch.md

@@ -0,0 +1,33 @@
+# AFNORAddressPatch
+
+Wrapper for postal addresses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ligneAdresse1** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**ligneAdresse2** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**ligneAdresse3** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**postalCode** | **string** | Service postal code | [optional] [default to undefined]
+**countrySubdivision** | **string** | Subdivision of the country | [optional] [default to undefined]
+**locality** | **string** | Corresponds to the municipality of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**codePays** | **string** | Corresponds to the country code of the recipient structure | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORAddressPatch } from '@factpulse/sdk';
+
+const instance: AFNORAddressPatch = {
+    ligneAdresse1,
+    ligneAdresse2,
+    ligneAdresse3,
+    postalCode,
+    countrySubdivision,
+    locality,
+    codePays,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORAddressPut.md

@@ -0,0 +1,33 @@
+# AFNORAddressPut
+
+Wrapper for postal addresses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ligneAdresse1** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [default to undefined]
+**ligneAdresse2** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [default to undefined]
+**ligneAdresse3** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [default to undefined]
+**postalCode** | **string** | Service postal code | [default to undefined]
+**countrySubdivision** | **string** | Subdivision of the country | [default to undefined]
+**locality** | **string** | Corresponds to the municipality of the recipient structure having defined the directory line(s). | [default to undefined]
+**codePays** | **string** | Corresponds to the country code of the recipient structure | [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORAddressPut } from '@factpulse/sdk';
+
+const instance: AFNORAddressPut = {
+    ligneAdresse1,
+    ligneAdresse2,
+    ligneAdresse3,
+    postalCode,
+    countrySubdivision,
+    locality,
+    codePays,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORAddressRead.md

@@ -0,0 +1,35 @@
+# AFNORAddressRead
+
+Wrapper for postal addresses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addressLine1** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**addressLine2** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**addressLine3** | **string** | Corresponds to the address of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**postalCode** | **string** | Service postal code | [optional] [default to undefined]
+**countrySubdivision** | **string** | Subdivision of the country | [optional] [default to undefined]
+**locality** | **string** | Municipality of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+**countryCode** | **string** | Corresponds to the country of the recipient structure. | [optional] [default to undefined]
+**countryName** | **string** | Corresponds to the country of the recipient structure having defined the directory line(s). | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORAddressRead } from '@factpulse/sdk';
+
+const instance: AFNORAddressRead = {
+    addressLine1,
+    addressLine2,
+    addressLine3,
+    postalCode,
+    countrySubdivision,
+    locality,
+    countryCode,
+    countryName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORAlgorithm.md

@@ -0,0 +1,16 @@
+# AFNORAlgorithm
+
+
+## Enum
+
+* `Rsa` (value: `'RSA'`)
+
+* `Ecdsa` (value: `'ECDSA'`)
+
+* `RsaPss` (value: `'RSA_PSS'`)
+
+* `Eddsa25519` (value: `'EDDSA_25519'`)
+
+* `Eddsa448` (value: `'EDDSA_448'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORContainsOperator.md

@@ -0,0 +1,9 @@
+# AFNORContainsOperator
+
+\\\"contains\\\" comparison operator
+
+## Enum
+
+* `Contains` (value: `'contains'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORCreateDirectoryLineBody.md

@@ -0,0 +1,22 @@
+# AFNORCreateDirectoryLineBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**period** | [**AFNORCreateDirectoryLineBodyPeriod**](AFNORCreateDirectoryLineBodyPeriod.md) |  | [optional] [default to undefined]
+**addressingInformation** | [**AFNORCreateDirectoryLineBodyAddressingInformation**](AFNORCreateDirectoryLineBodyAddressingInformation.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORCreateDirectoryLineBody } from '@factpulse/sdk';
+
+const instance: AFNORCreateDirectoryLineBody = {
+    period,
+    addressingInformation,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORCreateDirectoryLineBodyAddressingInformation.md

@@ -0,0 +1,26 @@
+# AFNORCreateDirectoryLineBodyAddressingInformation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**siren** | **string** | SIREN number | [default to undefined]
+**siret** | **string** | SIRET Number | [optional] [default to undefined]
+**routingIdentifier** | **string** | Routing identifier od a routing code. | [optional] [default to undefined]
+**addressingSuffix** | **string** | suffix of the directory line which defines an address mesh not attached to a facility | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORCreateDirectoryLineBodyAddressingInformation } from '@factpulse/sdk';
+
+const instance: AFNORCreateDirectoryLineBodyAddressingInformation = {
+    siren,
+    siret,
+    routingIdentifier,
+    addressingSuffix,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORCreateDirectoryLineBodyPeriod.md

@@ -0,0 +1,22 @@
+# AFNORCreateDirectoryLineBodyPeriod
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dateFrom** | **string** | Effective start date of the directory line.. | [default to undefined]
+**dateTo** | **string** | Effective end date of the directory line. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORCreateDirectoryLineBodyPeriod } from '@factpulse/sdk';
+
+const instance: AFNORCreateDirectoryLineBodyPeriod = {
+    dateFrom,
+    dateTo,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORCreateRoutingCodeBody.md

@@ -0,0 +1,34 @@
+# AFNORCreateRoutingCodeBody
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**facilityNature** | [**AFNORFacilityNature**](AFNORFacilityNature.md) |  | [default to undefined]
+**routingIdentifier** | **string** | Routing identifier od a routing code. | [default to undefined]
+**siret** | **string** | SIRET Number | [default to undefined]
+**routingIdentifierType** | **string** | Routing Identifier type. | [optional] [default to undefined]
+**routingCodeName** | **string** | Name of the directory line routing code. This attribute is only returned if the directory line is defined at the SIREN / SIRET / Routing code mesh. | [default to undefined]
+**managesLegalCommitmentCode** | **boolean** | Indicates whether the public structure requires a legal commitment number. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] [default to undefined]
+**administrativeStatus** | [**AFNORRoutingCodeAdministrativeStatus**](AFNORRoutingCodeAdministrativeStatus.md) |  | [default to undefined]
+**address** | [**AFNORAddressEdit**](AFNORAddressEdit.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORCreateRoutingCodeBody } from '@factpulse/sdk';
+
+const instance: AFNORCreateRoutingCodeBody = {
+    facilityNature,
+    routingIdentifier,
+    siret,
+    routingIdentifierType,
+    routingCodeName,
+    managesLegalCommitmentCode,
+    administrativeStatus,
+    address,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDestination.md

@@ -8,8 +8,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **string** |  | [optional] [default to TypeEnum_Afnor]
 **credentials** | [**AFNORCredentials**](AFNORCredentials.md) |  | [optional] [default to undefined]
-**flowSyntax** | **string** | Flow syntax to send | [optional] [default to FlowSyntaxEnum_FacturX]
+**flowSyntax** | [**FlowSyntax**](FlowSyntax.md) | Flow syntax (AFNOR XP Z12-013) | [optional] [default to undefined]
 **trackingId** | **string** |  | [optional] [default to undefined]
+**processingRule** | [**ProcessingRule**](ProcessingRule.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -21,6 +22,7 @@ const instance: AFNORDestination = {
     credentials,
     flowSyntax,
     trackingId,
+    processingRule,
 };
 ```
 

package/docs/AFNORDiffusionStatus.md

@@ -0,0 +1,11 @@
+# AFNORDiffusionStatus
+
+Diffusion status of the structure [O - Yes, P - Partially diffusible]
+
+## Enum
+
+* `O` (value: `'O'`)
+
+* `P` (value: `'P'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDirectoryLineField.md

@@ -0,0 +1,19 @@
+# AFNORDirectoryLineField
+
+Fields of the directory line resource
+
+## Enum
+
+* `AddressingIdentifier` (value: `'addressingIdentifier'`)
+
+* `Siren` (value: `'siren'`)
+
+* `Siret` (value: `'siret'`)
+
+* `RoutingIdentifier` (value: `'routingIdentifier'`)
+
+* `AddressingSuffix` (value: `'addressingSuffix'`)
+
+* `IdInstance` (value: `'idInstance'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md

@@ -0,0 +1,34 @@
+# AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**addressingIdentifier** | **string** | Addressing identifier of the directory line. | [optional] [default to undefined]
+**siren** | **string** | SIREN number | [optional] [default to undefined]
+**siret** | **string** | SIRET Number | [optional] [default to undefined]
+**addressingSuffix** | **string** | suffix of the directory line which defines an address mesh not attached to a facility | [optional] [default to undefined]
+**routingCode** | [**AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode**](AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md) |  | [optional] [default to undefined]
+**platform** | [**AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform**](AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md) |  | [optional] [default to undefined]
+**legalUnit** | [**AFNORLegalUnitPayloadIncludedNoSiren**](AFNORLegalUnitPayloadIncludedNoSiren.md) |  | [optional] [default to undefined]
+**facility** | [**AFNORFacilityPayloadIncluded**](AFNORFacilityPayloadIncluded.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode } from '@factpulse/sdk';
+
+const instance: AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode = {
+    addressingIdentifier,
+    siren,
+    siret,
+    addressingSuffix,
+    routingCode,
+    platform,
+    legalUnit,
+    facility,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform.md

@@ -0,0 +1,22 @@
+# AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**platformType** | [**AFNORRecipientPlatformType**](AFNORRecipientPlatformType.md) |  | [optional] [default to undefined]
+**platformStatus** | [**AFNORPlatformStatus**](AFNORPlatformStatus.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform } from '@factpulse/sdk';
+
+const instance: AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodePlatform = {
+    platformType,
+    platformStatus,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode.md

@@ -0,0 +1,30 @@
+# AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**routingIdentifier** | **string** | Routing identifier od a routing code. | [optional] [default to undefined]
+**routingIdentifierType** | **string** | Routing Identifier type. | [optional] [default to undefined]
+**routingCodeName** | **string** | Name of the directory line routing code. This attribute is only returned if the directory line is defined at the SIREN / SIRET / Routing code mesh. | [optional] [default to undefined]
+**managesLegalCommitment** | **boolean** | Indicates whether the public structure requires a legal commitment number. This attribute is only returned if the directory line is defined for a public structure at the SIREN / SIRET or SIREN / SIRET / Routing code level. | [optional] [default to undefined]
+**administrativeStatus** | [**AFNORRoutingCodeAdministrativeStatus**](AFNORRoutingCodeAdministrativeStatus.md) |  | [optional] [default to undefined]
+**address** | [**AFNORAddressRead**](AFNORAddressRead.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode } from '@factpulse/sdk';
+
+const instance: AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCodeRoutingCode = {
+    routingIdentifier,
+    routingIdentifierType,
+    routingCodeName,
+    managesLegalCommitment,
+    administrativeStatus,
+    address,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDirectoryLinePost201Response.md

@@ -0,0 +1,24 @@
+# AFNORDirectoryLinePost201Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**idInstance** | **number** | Platform instance identifier in the directory | [optional] [default to undefined]
+**addressingIdentifier** | **string** | Addressing identifier of the directory line. | [optional] [default to undefined]
+**dateFrom** | **string** | Effective start date of the directory line.. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORDirectoryLinePost201Response } from '@factpulse/sdk';
+
+const instance: AFNORDirectoryLinePost201Response = {
+    idInstance,
+    addressingIdentifier,
+    dateFrom,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORDirectoryLineSearchPost200Response.md

@@ -0,0 +1,24 @@
+# AFNORDirectoryLineSearchPost200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**search** | [**AFNORSearchDirectoryLine**](AFNORSearchDirectoryLine.md) |  | [optional] [default to undefined]
+**totalNumberOfResults** | **number** | The total number of results | [optional] [default to undefined]
+**results** | [**Array<AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode>**](AFNORDirectoryLinePayloadHistoryLegalUnitFacilityRoutingCode.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORDirectoryLineSearchPost200Response } from '@factpulse/sdk';
+
+const instance: AFNORDirectoryLineSearchPost200Response = {
+    search,
+    totalNumberOfResults,
+    results,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNOREntityType.md

@@ -0,0 +1,11 @@
+# AFNOREntityType
+
+Business structure type
+
+## Enum
+
+* `Public` (value: `'Public'`)
+
+* `PrivateVatRegistered` (value: `'PrivateVatRegistered'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORError.md

@@ -0,0 +1,28 @@
+# AFNORError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to 'about:blank']
+**message** | **string** |  | [optional] [default to undefined]
+**status** | **number** | The HTTP status code generated by the origin server for this occurrence of the problem.  | [optional] [default to undefined]
+**details** | **string** |  | [optional] [default to undefined]
+**instance** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORError } from '@factpulse/sdk';
+
+const instance: AFNORError = {
+    type,
+    message,
+    status,
+    details,
+    instance,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AFNORFacilityAdministrativeStatus.md

@@ -0,0 +1,11 @@
+# AFNORFacilityAdministrativeStatus
+
+Facility administrative status [A - Active , C - Closed]
+
+## Enum
+
+* `A` (value: `'A'`)
+
+* `C` (value: `'C'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)