@factpulse/sdk 2.0.12 → 3.0.1

package/docs/PDFXMLVerificationApi.md

@@ -0,0 +1,335 @@
+# PDFXMLVerificationApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet**](#getverificationstatusapiv1verificationverifyasynctaskidstatusget) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification|
+|[**getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet_0**](#getverificationstatusapiv1verificationverifyasynctaskidstatusget_0) | **GET** /api/v1/verification/verify-async/{task_id}/status | Get status of an asynchronous verification|
+|[**verifyPdfAsyncApiV1VerificationVerifyAsyncPost**](#verifypdfasyncapiv1verificationverifyasyncpost) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous)|
+|[**verifyPdfAsyncApiV1VerificationVerifyAsyncPost_0**](#verifypdfasyncapiv1verificationverifyasyncpost_0) | **POST** /api/v1/verification/verify-async | Verify PDF/XML Factur-X compliance (asynchronous)|
+|[**verifyPdfSyncApiV1VerificationVerifyPost**](#verifypdfsyncapiv1verificationverifypost) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous)|
+|[**verifyPdfSyncApiV1VerificationVerifyPost_0**](#verifypdfsyncapiv1verificationverifypost_0) | **POST** /api/v1/verification/verify | Verify PDF/XML Factur-X compliance (synchronous)|
+
+# **getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet**
+> TaskStatus getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet()
+
+Retrieves the status and result of an asynchronous verification task.  **Possible statuses:** - `PENDING`: Task waiting in queue - `STARTED`: Task currently running - `SUCCESS`: Task completed successfully (see `result`) - `FAILURE`: System error (unhandled exception)  **Note:** The `result.status` field can be \"SUCCESS\" or \"ERROR\" independently of Celery status (which will always be SUCCESS if the task ran).
+
+### Example
+
+```typescript
+import {
+    PDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PDFXMLVerificationApi(configuration);
+
+let taskId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TaskStatus**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet_0**
+> TaskStatus getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet_0()
+
+Retrieves the status and result of an asynchronous verification task.  **Possible statuses:** - `PENDING`: Task waiting in queue - `STARTED`: Task currently running - `SUCCESS`: Task completed successfully (see `result`) - `FAILURE`: System error (unhandled exception)  **Note:** The `result.status` field can be \"SUCCESS\" or \"ERROR\" independently of Celery status (which will always be SUCCESS if the task ran).
+
+### Example
+
+```typescript
+import {
+    PDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PDFXMLVerificationApi(configuration);
+
+let taskId: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getVerificationStatusApiV1VerificationVerifyAsyncTaskIdStatusGet_0(
+    taskId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **taskId** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**TaskStatus**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **verifyPdfAsyncApiV1VerificationVerifyAsyncPost**
+> TaskResponse verifyPdfAsyncApiV1VerificationVerifyAsyncPost()
+
+Verifies PDF/XML Factur-X compliance asynchronously.  **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will return a `NOT_FACTURX` error in the result.  This version uses a Celery task and can call the OCR service if the PDF is an image or if `force_ocr=true`.  **Returns immediately** a task ID. Use `/verify-async/{task_id}/status` to retrieve the result.  **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF  **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency  **Advantages over synchronous version:** - OCR support for image PDFs (via DocTR service) - Longer timeout for large documents - Doesn\'t block the server
+
+### Example
+
+```typescript
+import {
+    PDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PDFXMLVerificationApi(configuration);
+
+let pdfFile: File; //Factur-X PDF file to verify (default to undefined)
+let forceOcr: boolean; //Force OCR usage even if PDF contains native text (optional) (default to false)
+
+const { status, data } = await apiInstance.verifyPdfAsyncApiV1VerificationVerifyAsyncPost(
+    pdfFile,
+    forceOcr
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pdfFile** | [**File**] | Factur-X PDF file to verify | defaults to undefined|
+| **forceOcr** | [**boolean**] | Force OCR usage even if PDF contains native text | (optional) defaults to false|
+
+
+### Return type
+
+**TaskResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **verifyPdfAsyncApiV1VerificationVerifyAsyncPost_0**
+> TaskResponse verifyPdfAsyncApiV1VerificationVerifyAsyncPost_0()
+
+Verifies PDF/XML Factur-X compliance asynchronously.  **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will return a `NOT_FACTURX` error in the result.  This version uses a Celery task and can call the OCR service if the PDF is an image or if `force_ocr=true`.  **Returns immediately** a task ID. Use `/verify-async/{task_id}/status` to retrieve the result.  **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF  **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency  **Advantages over synchronous version:** - OCR support for image PDFs (via DocTR service) - Longer timeout for large documents - Doesn\'t block the server
+
+### Example
+
+```typescript
+import {
+    PDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PDFXMLVerificationApi(configuration);
+
+let pdfFile: File; //Factur-X PDF file to verify (default to undefined)
+let forceOcr: boolean; //Force OCR usage even if PDF contains native text (optional) (default to false)
+
+const { status, data } = await apiInstance.verifyPdfAsyncApiV1VerificationVerifyAsyncPost_0(
+    pdfFile,
+    forceOcr
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pdfFile** | [**File**] | Factur-X PDF file to verify | defaults to undefined|
+| **forceOcr** | [**boolean**] | Force OCR usage even if PDF contains native text | (optional) defaults to false|
+
+
+### Return type
+
+**TaskResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**202** | Successful Response |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **verifyPdfSyncApiV1VerificationVerifyPost**
+> VerificationSuccessResponse verifyPdfSyncApiV1VerificationVerifyPost()
+
+Verifies compliance between the PDF and its embedded Factur-X XML.  **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will be rejected with a 400 error.  This synchronous version uses only native PDF extraction (pdfplumber). For image PDFs requiring OCR, use the `/verify-async` endpoint.  **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF  **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency
+
+### Example
+
+```typescript
+import {
+    PDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PDFXMLVerificationApi(configuration);
+
+let pdfFile: File; //Factur-X PDF file to verify (default to undefined)
+
+const { status, data } = await apiInstance.verifyPdfSyncApiV1VerificationVerifyPost(
+    pdfFile
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pdfFile** | [**File**] | Factur-X PDF file to verify | defaults to undefined|
+
+
+### Return type
+
+**VerificationSuccessResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Verification successful |  -  |
+|**400** | Verification error (non Factur-X PDF, invalid, etc.) |  -  |
+|**413** | PDF too large or too many pages |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **verifyPdfSyncApiV1VerificationVerifyPost_0**
+> VerificationSuccessResponse verifyPdfSyncApiV1VerificationVerifyPost_0()
+
+Verifies compliance between the PDF and its embedded Factur-X XML.  **IMPORTANT**: Only Factur-X PDFs (with embedded XML) are accepted. PDFs without Factur-X XML will be rejected with a 400 error.  This synchronous version uses only native PDF extraction (pdfplumber). For image PDFs requiring OCR, use the `/verify-async` endpoint.  **Verification principle (Factur-X 1.08):** - Principle #2: XML can only contain info present in the PDF - Principle #4: All XML info must be present and compliant in the PDF  **Verified fields:** - Identification: BT-1 (invoice #), BT-2 (date), BT-3 (type), BT-5 (currency), BT-23 (framework) - Seller: BT-27 (name), BT-29 (SIRET), BT-30 (SIREN), BT-31 (VAT) - Buyer: BT-44 (name), BT-46 (SIRET), BT-47 (SIREN), BT-48 (VAT) - Amounts: BT-109 (excl. tax), BT-110 (VAT), BT-112 (incl. tax), BT-115 (amount due) - VAT breakdown: BT-116, BT-117, BT-118, BT-119 - Invoice lines: BT-153, BT-129, BT-146, BT-131 - Mandatory notes: PMT, PMD, AAB - Rule BR-FR-09: SIRET/SIREN consistency
+
+### Example
+
+```typescript
+import {
+    PDFXMLVerificationApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new PDFXMLVerificationApi(configuration);
+
+let pdfFile: File; //Factur-X PDF file to verify (default to undefined)
+
+const { status, data } = await apiInstance.verifyPdfSyncApiV1VerificationVerifyPost_0(
+    pdfFile
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pdfFile** | [**File**] | Factur-X PDF file to verify | defaults to undefined|
+
+
+### Return type
+
+**VerificationSuccessResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Verification successful |  -  |
+|**400** | Verification error (non Factur-X PDF, invalid, etc.) |  -  |
+|**413** | PDF too large or too many pages |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+

package/docs/PDPCredentials.md

@@ -0,0 +1,29 @@
+# PDPCredentials
+
+PDP credentials for zero-storage strategy (Strategy B).  Allows providing PDP credentials directly in the request instead of storing them in Django.  Useful for: - Ad-hoc tests without persisting credentials - Temporary integrations - Development environments
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**flow_service_url** | **string** | Base URL of the AFNOR Flow Service | [default to undefined]
+**directory_service_url** | **string** |  | [optional] [default to undefined]
+**token_url** | **string** | OAuth2 server URL | [default to undefined]
+**client_id** | **string** | OAuth2 Client ID | [default to undefined]
+**client_secret** | **string** | OAuth2 Client Secret (sensitive) | [default to undefined]
+
+## Example
+
+```typescript
+import { PDPCredentials } from '@factpulse/sdk';
+
+const instance: PDPCredentials = {
+    flow_service_url,
+    directory_service_url,
+    token_url,
+    client_id,
+    client_secret,
+};
+```
+
+[[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/PageDimensionsSchema.md

@@ -0,0 +1,23 @@
+# PageDimensionsSchema
+
+PDF page dimensions.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**width** | **number** | Width in PDF points | [default to undefined]
+**height** | **number** | Height in PDF points | [default to undefined]
+
+## Example
+
+```typescript
+import { PageDimensionsSchema } from '@factpulse/sdk';
+
+const instance: PageDimensionsSchema = {
+    width,
+    height,
+};
+```
+
+[[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/Payee.md

@@ -0,0 +1,31 @@
+# Payee
+
+Information about the payment beneficiary (BG-10 / PayeeTradeParty).  The payee is the party receiving payment. This block is used only if the payee is different from the seller (supplier).  **Main use case**: Factoring When an invoice is factored, the factor (factoring company) becomes the payment beneficiary instead of the supplier.  **Business Terms (EN16931)**: - BT-59: Payee name (mandatory) - BT-60: Payee identifier (SIRET with schemeID 0009) - BT-61: Payee legal identifier (SIREN with schemeID 0002)  **Reference**: docs/guide_affacturage.md
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nom** | **string** | Payee name (BT-59). Mandatory. | [default to undefined]
+**siret** | **string** |  | [optional] [default to undefined]
+**siren** | **string** |  | [optional] [default to undefined]
+**electronicAddress** | [**ElectronicAddress**](ElectronicAddress.md) |  | [optional] [default to undefined]
+**iban** | **string** |  | [optional] [default to undefined]
+**bic** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Payee } from '@factpulse/sdk';
+
+const instance: Payee = {
+    nom,
+    siret,
+    siren,
+    electronicAddress,
+    iban,
+    bic,
+};
+```
+
+[[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/PaymentMeans.md

@@ -0,0 +1,31 @@
+# PaymentMeans
+
+Accepted payment methods.
+
+## Enum
+
+* `Cheque` (value: `'CHEQUE'`)
+
+* `Prelevement` (value: `'PRELEVEMENT'`)
+
+* `Virement` (value: `'VIREMENT'`)
+
+* `Espece` (value: `'ESPECE'`)
+
+* `Autre` (value: `'AUTRE'`)
+
+* `Report` (value: `'REPORT'`)
+
+* `Cheque2` (value: `'CHEQUE'`)
+
+* `Prelevement2` (value: `'PRELEVEMENT'`)
+
+* `Virement2` (value: `'VIREMENT'`)
+
+* `Espece2` (value: `'ESPECE'`)
+
+* `Autre2` (value: `'AUTRE'`)
+
+* `Report2` (value: `'REPORT'`)
+
+[[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/PostalAddress.md

@@ -0,0 +1,29 @@
+# PostalAddress
+
+Represents a postal address.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**postalCode** | **string** |  | [optional] [default to undefined]
+**lineOne** | **string** |  | [optional] [default to undefined]
+**lineTwo** | **string** |  | [optional] [default to undefined]
+**city** | **string** |  | [optional] [default to undefined]
+**countryCode** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PostalAddress } from '@factpulse/sdk';
+
+const instance: PostalAddress = {
+    postalCode,
+    lineOne,
+    lineTwo,
+    city,
+    countryCode,
+};
+```
+
+[[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/ProcessingOptions.md

@@ -0,0 +1,27 @@
+# ProcessingOptions
+
+Processing options for generation and submission.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**facturxProfile** | [**APIProfile**](APIProfile.md) | Factur-X profile to use | [optional] [default to undefined]
+**autoEnrich** | **boolean** | Auto-enrich data (Company APIs, Chorus Pro, etc.) | [optional] [default to true]
+**validate** | **boolean** | Validate Factur-X XML with Schematron | [optional] [default to true]
+**verifyDestinationParameters** | **boolean** | Verify required parameters for destination (e.g., service_code for Chorus) | [optional] [default to true]
+
+## Example
+
+```typescript
+import { ProcessingOptions } from '@factpulse/sdk';
+
+const instance: ProcessingOptions = {
+    facturxProfile,
+    autoEnrich,
+    validate,
+    verifyDestinationParameters,
+};
+```
+
+[[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/Quantity.md

@@ -0,0 +1,19 @@
+# Quantity
+
+Invoiced quantity for this line.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { Quantity } from '@factpulse/sdk';
+
+const instance: Quantity = {
+};
+```
+
+[[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/Recipient.md

@@ -0,0 +1,31 @@
+# Recipient
+
+Information about the invoice recipient (the customer).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**electronic_address** | [**ElectronicAddress**](ElectronicAddress.md) |  | [default to undefined]
+**executing_service_code** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**siren** | **string** |  | [optional] [default to undefined]
+**siret** | **string** |  | [optional] [default to undefined]
+**postal_address** | [**PostalAddress**](PostalAddress.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Recipient } from '@factpulse/sdk';
+
+const instance: Recipient = {
+    electronic_address,
+    executing_service_code,
+    name,
+    siren,
+    siret,
+    postal_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/SchemeID.md

@@ -1,6 +1,6 @@
 # SchemeID
 
-Codes de schémas d\'identification (Electronic Address Scheme - EAS), principalement pour l\'adressage des factures électroniques.  **Valeurs possibles :** - `0225` : FR_SIREN - SIREN français (le plus commun pour la France, remplace l\'ancien 0002) - `0088` : GLN - Global Location Number - `0060` : DUNS - Data Universal Numbering System - `9957` : FR_TVA_INTRA - Numéro de TVA intracommunautaire français - `0199` : GLEIF - Global Legal Entity Identifier Foundation
+Identification scheme codes (Electronic Address Scheme - EAS), mainly for electronic invoice addressing.  **Possible values:** - `0225`: FR_SIREN - French SIREN (most common for France, replaces old 0002) - `0088`: GLN - Global Location Number - `0060`: DUNS - Data Universal Numbering System - `9957`: FR_VAT_INTRA - French intra-community VAT number - `0199`: GLEIF - Global Legal Entity Identifier Foundation
 
 ## Enum
 

package/docs/SearchFlowRequest.md

@@ -0,0 +1,37 @@
+# SearchFlowRequest
+
+Request to search submitted flows.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**updated_after** | **string** |  | [optional] [default to undefined]
+**updated_before** | **string** |  | [optional] [default to undefined]
+**flow_types** | [**Array<FlowType>**](FlowType.md) |  | [optional] [default to undefined]
+**flow_directions** | [**Array<FlowDirection>**](FlowDirection.md) |  | [optional] [default to undefined]
+**tracking_id** | **string** |  | [optional] [default to undefined]
+**flow_id** | **string** |  | [optional] [default to undefined]
+**acknowledgment_status** | [**AcknowledgmentStatus**](AcknowledgmentStatus.md) |  | [optional] [default to undefined]
+**offset** | **number** | Offset for pagination | [optional] [default to 0]
+**limit** | **number** | Maximum number of results (max 100) | [optional] [default to 25]
+
+## Example
+
+```typescript
+import { SearchFlowRequest } from '@factpulse/sdk';
+
+const instance: SearchFlowRequest = {
+    updated_after,
+    updated_before,
+    flow_types,
+    flow_directions,
+    tracking_id,
+    flow_id,
+    acknowledgment_status,
+    offset,
+    limit,
+};
+```
+
+[[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/SearchFlowResponse.md

@@ -0,0 +1,27 @@
+# SearchFlowResponse
+
+Response from a flow search.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** | Total number of results | [default to undefined]
+**offset** | **number** | Applied offset | [default to undefined]
+**limit** | **number** | Results limit | [default to undefined]
+**results** | [**Array<FlowSummary>**](FlowSummary.md) | List of found flows | [default to undefined]
+
+## Example
+
+```typescript
+import { SearchFlowResponse } from '@factpulse/sdk';
+
+const instance: SearchFlowResponse = {
+    total,
+    offset,
+    limit,
+    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/SearchServicesResponse.md

@@ -0,0 +1,27 @@
+# SearchServicesResponse
+
+Structure services list.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**returnCode** | **number** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**services** | [**Array<StructureService>**](StructureService.md) |  | [optional] [default to undefined]
+**total** | **number** | Number of services | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { SearchServicesResponse } from '@factpulse/sdk';
+
+const instance: SearchServicesResponse = {
+    returnCode,
+    message,
+    services,
+    total,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)