@factpulse/sdk 2.0.49 → 3.0.2

package/docs/AFNORPDPPAFlowServiceApi.md

@@ -4,15 +4,15 @@ All URIs are relative to *http://localhost*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
-|[**downloadFlowProxyApiV1AfnorFlowV1FlowsFlowIdGet**](#downloadflowproxyapiv1afnorflowv1flowsflowidget) | **GET** /api/v1/afnor/flow/v1/flows/{flowId} | Télécharger un flux|
+|[**downloadFlowProxyApiV1AfnorFlowV1FlowsFlowIdGet**](#downloadflowproxyapiv1afnorflowv1flowsflowidget) | **GET** /api/v1/afnor/flow/v1/flows/{flowId} | Download a flow|
 |[**flowHealthcheckProxyApiV1AfnorFlowV1HealthcheckGet**](#flowhealthcheckproxyapiv1afnorflowv1healthcheckget) | **GET** /api/v1/afnor/flow/v1/healthcheck | Healthcheck Flow Service|
-|[**searchFlowsProxyApiV1AfnorFlowV1FlowsSearchPost**](#searchflowsproxyapiv1afnorflowv1flowssearchpost) | **POST** /api/v1/afnor/flow/v1/flows/search | Rechercher des flux|
-|[**submitFlowProxyApiV1AfnorFlowV1FlowsPost**](#submitflowproxyapiv1afnorflowv1flowspost) | **POST** /api/v1/afnor/flow/v1/flows | Soumettre un flux de facturation|
+|[**searchFlowsProxyApiV1AfnorFlowV1FlowsSearchPost**](#searchflowsproxyapiv1afnorflowv1flowssearchpost) | **POST** /api/v1/afnor/flow/v1/flows/search | Search flows|
+|[**submitFlowProxyApiV1AfnorFlowV1FlowsPost**](#submitflowproxyapiv1afnorflowv1flowspost) | **POST** /api/v1/afnor/flow/v1/flows | Submit an invoicing flow|
 
 # **downloadFlowProxyApiV1AfnorFlowV1FlowsFlowIdGet**
 > any downloadFlowProxyApiV1AfnorFlowV1FlowsFlowIdGet()
 
-Télécharger le fichier PDF/A-3 d\'un flux de facturation (utilise le client_uid du JWT)
+Download the PDF/A-3 file of an invoicing flow (uses JWT client_uid)
 
 ### Example
 
@@ -56,10 +56,10 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Fichier PDF/A-3 |  -  |
-|**400** | Configuration PDP manquante |  -  |
-|**401** | Non authentifié - Token JWT manquant ou invalide |  -  |
-|**404** | Flux non trouvé ou client_uid invalide |  -  |
+|**200** | PDF/A-3 file |  -  |
+|**400** | Missing PDP configuration |  -  |
+|**401** | Not authenticated - Missing or invalid JWT token |  -  |
+|**404** | Flow not found or invalid client_uid |  -  |
 |**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)
@@ -67,7 +67,7 @@ No authorization required
 # **flowHealthcheckProxyApiV1AfnorFlowV1HealthcheckGet**
 > any flowHealthcheckProxyApiV1AfnorFlowV1HealthcheckGet()
 
-Vérifier la disponibilité du Flow Service
+Check Flow Service availability
 
 ### Example
 
@@ -104,14 +104,14 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Service opérationnel |  -  |
+|**200** | Service operational |  -  |
 
 [[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)
 
 # **searchFlowsProxyApiV1AfnorFlowV1FlowsSearchPost**
 > any searchFlowsProxyApiV1AfnorFlowV1FlowsSearchPost()
 
-Rechercher des flux de facturation selon des critères (utilise le client_uid du JWT)
+Search invoicing flows by criteria (uses JWT client_uid)
 
 ### Example
 
@@ -148,18 +148,18 @@ No authorization required
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-|**200** | Résultats de recherche |  -  |
-|**400** | Configuration PDP manquante |  -  |
-|**401** | Non authentifié - Token JWT manquant ou invalide |  -  |
-|**404** | Client PDP non trouvé (client_uid invalide) |  -  |
-|**429** | Trop de requêtes - Rate limit atteint (60 recherches/minute) |  -  |
+|**200** | Search results |  -  |
+|**400** | Missing PDP configuration |  -  |
+|**401** | Not authenticated - Missing or invalid JWT token |  -  |
+|**404** | PDP client not found (invalid client_uid) |  -  |
+|**429** | Too many requests - Rate limit reached (60 searches/minute) |  -  |
 
 [[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)
 
 # **submitFlowProxyApiV1AfnorFlowV1FlowsPost**
 > any submitFlowProxyApiV1AfnorFlowV1FlowsPost()
 
-Soumet une facture électronique à une Plateforme de Dématérialisation Partenaire (PDP) conformément à la norme AFNOR XP Z12-013
+Submits an electronic invoice to a Partner Dematerialization Platform (PDP) in compliance with the AFNOR XP Z12-013 standard
 
 ### Example
 
@@ -197,12 +197,12 @@ No authorization required
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 |**200** | Successful Response |  -  |
-|**201** | Flux soumis avec succès |  -  |
-|**400** | Requête invalide ou configuration PDP manquante |  -  |
-|**401** | Non authentifié - Token JWT manquant ou invalide |  -  |
-|**403** | Non autorisé - Quota dépassé ou permissions insuffisantes |  -  |
-|**404** | Client PDP non trouvé (client_uid invalide) |  -  |
-|**429** | Trop de requêtes - Rate limit atteint (30 soumissions/minute) |  -  |
+|**201** | Flow submitted successfully |  -  |
+|**400** | Invalid request or missing PDP configuration |  -  |
+|**401** | Not authenticated - Missing or invalid JWT token |  -  |
+|**403** | Not authorized - Quota exceeded or insufficient permissions |  -  |
+|**404** | PDP client not found (invalid client_uid) |  -  |
+|**429** | Too many requests - Rate limit reached (30 submissions/minute) |  -  |
 
 [[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/AFNORResult.md

@@ -0,0 +1,29 @@
+# AFNORResult
+
+Result of submission to AFNOR PDP.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**flowId** | **string** | Submitted flow identifier | [default to undefined]
+**trackingId** | **string** |  | [optional] [default to undefined]
+**sha256** | **string** | SHA-256 hash of submitted file | [default to undefined]
+**flowSyntax** | **string** | Flow syntax | [default to undefined]
+**flowProfile** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AFNORResult } from '@factpulse/sdk';
+
+const instance: AFNORResult = {
+    flowId,
+    trackingId,
+    sha256,
+    flowSyntax,
+    flowProfile,
+};
+```
+
+[[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/APIError.md

@@ -1,13 +1,13 @@
 # APIError
 
-Erreur API standardisée (alignée sur AFNOR Error schema).  Format unifié pour toutes les réponses d\'erreur HTTP.
+Standardized API error (aligned with AFNOR Error schema).  Unified format for all HTTP error responses.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**errorCode** | **string** | Code alphanumérique identifiant précisément l\'erreur | [default to undefined]
-**errorMessage** | **string** | Message décrivant l\'erreur (non destiné à l\'utilisateur final) | [default to undefined]
+**errorCode** | **string** | Alphanumeric code precisely identifying the error | [default to undefined]
+**errorMessage** | **string** | Message describing the error (not intended for end user) | [default to undefined]
 **details** | [**Array<ValidationErrorDetail>**](ValidationErrorDetail.md) |  | [optional] [default to undefined]
 
 ## Example

package/docs/APIProfile.md

@@ -0,0 +1,15 @@
+# APIProfile
+
+Factur-X profile for API requests.
+
+## Enum
+
+* `Minimum` (value: `'MINIMUM'`)
+
+* `Basic` (value: `'BASIC'`)
+
+* `En16931` (value: `'EN16931'`)
+
+* `Extended` (value: `'EXTENDED'`)
+
+[[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/AcknowledgmentStatus.md

@@ -0,0 +1,13 @@
+# AcknowledgmentStatus
+
+Flow acknowledgment status.
+
+## Enum
+
+* `Pending` (value: `'Pending'`)
+
+* `Ok` (value: `'Ok'`)
+
+* `Error` (value: `'Error'`)
+
+[[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/AllowanceReasonCode.md

@@ -0,0 +1,21 @@
+# AllowanceReasonCode
+
+Standardized codes for allowance or charge reasons (EN 16931 standard).  **Possible values:** - `AA`: ADVERTISING_ALLOWANCE - Advertising discount or rebate - `ABL`: PACKAGING_SURCHARGE - Packaging surcharge - `ADR`: OTHER_SERVICES - Other services - `ADT`: PICKUP_COST - Pickup cost - `FC`: FREIGHT_CHARGES - Freight/transport costs - `FI`: FINANCING_CHARGES - Financing charges - `LA`: LABELING - Labeling
+
+## Enum
+
+* `Aa` (value: `'AA'`)
+
+* `Abl` (value: `'ABL'`)
+
+* `Adr` (value: `'ADR'`)
+
+* `Adt` (value: `'ADT'`)
+
+* `Fc` (value: `'FC'`)
+
+* `Fi` (value: `'FI'`)
+
+* `La` (value: `'LA'`)
+
+[[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/AmountDue.md

@@ -0,0 +1,19 @@
+# AmountDue
+
+Amount due for payment. (Accepte number, string ou integer)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Example
+
+```typescript
+import { AmountDue } from '@factpulse/sdk';
+
+const instance: AmountDue = {
+};
+```
+
+[[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/BoundingBoxSchema.md

@@ -1,18 +1,18 @@
 # BoundingBoxSchema
 
-Coordonnées d\'une zone rectangulaire dans le PDF.  Les coordonnées sont en points PDF (1 point = 1/72 pouce). L\'origine (0,0) est en bas à gauche de la page.
+Rectangular area coordinates in PDF.  Coordinates are in PDF points (1 point = 1/72 inch). Origin (0,0) is at the bottom-left of the page.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**x0** | **number** | Coordonnée X gauche | [default to undefined]
-**y0** | **number** | Coordonnée Y bas | [default to undefined]
-**x1** | **number** | Coordonnée X droite | [default to undefined]
-**y1** | **number** | Coordonnée Y haut | [default to undefined]
-**page** | **number** | Numéro de page (0-indexed) | [optional] [default to 0]
-**width** | **number** | Largeur de la zone | [default to undefined]
-**height** | **number** | Hauteur de la zone | [default to undefined]
+**x0** | **number** | Left X coordinate | [default to undefined]
+**y0** | **number** | Bottom Y coordinate | [default to undefined]
+**x1** | **number** | Right X coordinate | [default to undefined]
+**y1** | **number** | Top Y coordinate | [default to undefined]
+**page** | **number** | Page number (0-indexed) | [optional] [default to 0]
+**width** | **number** | Area width | [default to undefined]
+**height** | **number** | Area height | [default to undefined]
 
 ## Example
 

package/docs/CeleryStatus.md

@@ -0,0 +1,17 @@
+# CeleryStatus
+
+Possible states of a Celery task during polling.  **Possible values:** - `PENDING`: Task waiting for processing - `STARTED`: Task currently executing - `SUCCESS`: Task completed successfully (check `result.status` for business result) - `FAILURE`: System error during execution (crash, unhandled exception) - `RETRY`: Retry attempt in progress (after temporary failure)
+
+## Enum
+
+* `Pending` (value: `'PENDING'`)
+
+* `Started` (value: `'STARTED'`)
+
+* `Success` (value: `'SUCCESS'`)
+
+* `Failure` (value: `'FAILURE'`)
+
+* `Retry` (value: `'RETRY'`)
+
+[[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/CertificateInfoResponse.md

@@ -1,23 +1,23 @@
 # CertificateInfoResponse
 
-Informations sur un certificat généré.
+Information about a generated certificate.
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **cn** | **string** | Common Name | [default to undefined]
-**organisation** | **string** | Organisation | [default to undefined]
-**pays** | **string** | Code pays | [default to undefined]
-**ville** | **string** | Ville | [default to undefined]
-**province** | **string** | Province | [default to undefined]
+**organization** | **string** | Organization | [default to undefined]
+**country** | **string** | Country code | [default to undefined]
+**city** | **string** | City | [default to undefined]
+**state** | **string** | State/Province | [default to undefined]
 **email** | **string** |  | [optional] [default to undefined]
-**sujet** | **string** | Sujet complet (RFC4514) | [default to undefined]
-**emetteur** | **string** | Émetteur (auto-signé = même que sujet) | [default to undefined]
-**numero_serie** | **number** | Numéro de série du certificat | [default to undefined]
-**valide_du** | **string** | Date de début de validité (ISO 8601) | [default to undefined]
-**valide_au** | **string** | Date de fin de validité (ISO 8601) | [default to undefined]
-**algorithme** | **string** | Algorithme de signature | [default to undefined]
+**subject** | **string** | Full subject (RFC4514) | [default to undefined]
+**issuer** | **string** | Issuer (self-signed = same as subject) | [default to undefined]
+**serialNumber** | **number** | Certificate serial number | [default to undefined]
+**validFrom** | **string** | Validity start date (ISO 8601) | [default to undefined]
+**validTo** | **string** | Validity end date (ISO 8601) | [default to undefined]
+**algorithm** | **string** | Signature algorithm | [default to undefined]
 
 ## Example
 
@@ -26,17 +26,17 @@ import { CertificateInfoResponse } from '@factpulse/sdk';
 
 const instance: CertificateInfoResponse = {
     cn,
-    organisation,
-    pays,
-    ville,
-    province,
+    organization,
+    country,
+    city,
+    state,
     email,
-    sujet,
-    emetteur,
-    numero_serie,
-    valide_du,
-    valide_au,
-    algorithme,
+    subject,
+    issuer,
+    serialNumber,
+    validFrom,
+    validTo,
+    algorithm,
 };
 ```