@factpulse/sdk 3.0.5 → 3.0.7

package/dist/api/document-conversion-api.d.ts

@@ -0,0 +1,226 @@
+/**
+ * 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/
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { ConvertResumeRequest } from '../models';
+import type { ConvertSuccessResponse } from '../models';
+/**
+ * DocumentConversionApi - axios parameter creator
+ */
+export declare const DocumentConversionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Convertit un document (PDF, DOCX, XLSX, image) en Factur-X conforme.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Extraction OCR + Classification** : Mistral OCR extrait les données et classifie le document en un seul appel 3. **Enrichissement** : Les données sont enrichies via SIRENE (SIRET → raison sociale) 4. **Validation** : Les règles Schematron sont appliquées 5. **Génération** : Le Factur-X PDF/A-3 est généré  ## Réponses possibles  - **200** : Conversion réussie, fichiers disponibles - **202** : Données manquantes, complétion requise - **422** : Validation échouée, corrections nécessaires - **400** : Fichier invalide - **429** : Quota dépassé
+     * @summary Convertir un document en Factur-X
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentApiV1ConvertPost: (file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lance une conversion asynchrone via Celery.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Task Celery** : La tâche est mise en file d\'attente 3. **Callback** : Notification par webhook à la fin  ## Réponses possibles  - **202** : Tâche acceptée, en cours de traitement - **400** : Fichier invalide
+     * @summary Convertir un document en Factur-X (mode asynchrone)
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost: (file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Télécharge le fichier Factur-X PDF ou XML généré.  ## Fichiers disponibles  - `facturx.pdf` : PDF/A-3 avec XML embarqué - `facturx.xml` : XML CII seul (Cross Industry Invoice)  Les fichiers sont disponibles pendant 24 heures après génération.
+     * @summary Télécharger un fichier généré
+     * @param {string} conversionId
+     * @param {string} filename
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet: (conversionId: string, filename: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retourne le statut actuel d\'une conversion asynchrone.
+     * @summary Vérifier le statut d\'une conversion
+     * @param {string} conversionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet: (conversionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Reprend une conversion après complétion des données manquantes ou correction des erreurs.  L\'extraction OCR est conservée, les données sont mises à jour avec les corrections, puis une nouvelle validation Schematron est effectuée.
+     * @summary Reprendre une conversion avec corrections
+     * @param {string} conversionId
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost: (conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DocumentConversionApi - functional programming interface
+ */
+export declare const DocumentConversionApiFp: (configuration?: Configuration) => {
+    /**
+     * Convertit un document (PDF, DOCX, XLSX, image) en Factur-X conforme.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Extraction OCR + Classification** : Mistral OCR extrait les données et classifie le document en un seul appel 3. **Enrichissement** : Les données sont enrichies via SIRENE (SIRET → raison sociale) 4. **Validation** : Les règles Schematron sont appliquées 5. **Génération** : Le Factur-X PDF/A-3 est généré  ## Réponses possibles  - **200** : Conversion réussie, fichiers disponibles - **202** : Données manquantes, complétion requise - **422** : Validation échouée, corrections nécessaires - **400** : Fichier invalide - **429** : Quota dépassé
+     * @summary Convertir un document en Factur-X
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentApiV1ConvertPost(file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConvertSuccessResponse>>;
+    /**
+     * Lance une conversion asynchrone via Celery.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Task Celery** : La tâche est mise en file d\'attente 3. **Callback** : Notification par webhook à la fin  ## Réponses possibles  - **202** : Tâche acceptée, en cours de traitement - **400** : Fichier invalide
+     * @summary Convertir un document en Factur-X (mode asynchrone)
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost(file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Télécharge le fichier Factur-X PDF ou XML généré.  ## Fichiers disponibles  - `facturx.pdf` : PDF/A-3 avec XML embarqué - `facturx.xml` : XML CII seul (Cross Industry Invoice)  Les fichiers sont disponibles pendant 24 heures après génération.
+     * @summary Télécharger un fichier généré
+     * @param {string} conversionId
+     * @param {string} filename
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet(conversionId: string, filename: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Retourne le statut actuel d\'une conversion asynchrone.
+     * @summary Vérifier le statut d\'une conversion
+     * @param {string} conversionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet(conversionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Reprend une conversion après complétion des données manquantes ou correction des erreurs.  L\'extraction OCR est conservée, les données sont mises à jour avec les corrections, puis une nouvelle validation Schematron est effectuée.
+     * @summary Reprendre une conversion avec corrections
+     * @param {string} conversionId
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConvertSuccessResponse>>;
+};
+/**
+ * DocumentConversionApi - factory interface
+ */
+export declare const DocumentConversionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Convertit un document (PDF, DOCX, XLSX, image) en Factur-X conforme.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Extraction OCR + Classification** : Mistral OCR extrait les données et classifie le document en un seul appel 3. **Enrichissement** : Les données sont enrichies via SIRENE (SIRET → raison sociale) 4. **Validation** : Les règles Schematron sont appliquées 5. **Génération** : Le Factur-X PDF/A-3 est généré  ## Réponses possibles  - **200** : Conversion réussie, fichiers disponibles - **202** : Données manquantes, complétion requise - **422** : Validation échouée, corrections nécessaires - **400** : Fichier invalide - **429** : Quota dépassé
+     * @summary Convertir un document en Factur-X
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentApiV1ConvertPost(file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<ConvertSuccessResponse>;
+    /**
+     * Lance une conversion asynchrone via Celery.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Task Celery** : La tâche est mise en file d\'attente 3. **Callback** : Notification par webhook à la fin  ## Réponses possibles  - **202** : Tâche acceptée, en cours de traitement - **400** : Fichier invalide
+     * @summary Convertir un document en Factur-X (mode asynchrone)
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost(file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Télécharge le fichier Factur-X PDF ou XML généré.  ## Fichiers disponibles  - `facturx.pdf` : PDF/A-3 avec XML embarqué - `facturx.xml` : XML CII seul (Cross Industry Invoice)  Les fichiers sont disponibles pendant 24 heures après génération.
+     * @summary Télécharger un fichier généré
+     * @param {string} conversionId
+     * @param {string} filename
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet(conversionId: string, filename: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Retourne le statut actuel d\'une conversion asynchrone.
+     * @summary Vérifier le statut d\'une conversion
+     * @param {string} conversionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet(conversionId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Reprend une conversion après complétion des données manquantes ou correction des erreurs.  L\'extraction OCR est conservée, les données sont mises à jour avec les corrections, puis une nouvelle validation Schematron est effectuée.
+     * @summary Reprendre une conversion avec corrections
+     * @param {string} conversionId
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConvertSuccessResponse>;
+};
+/**
+ * DocumentConversionApi - object-oriented interface
+ */
+export declare class DocumentConversionApi extends BaseAPI {
+    /**
+     * Convertit un document (PDF, DOCX, XLSX, image) en Factur-X conforme.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Extraction OCR + Classification** : Mistral OCR extrait les données et classifie le document en un seul appel 3. **Enrichissement** : Les données sont enrichies via SIRENE (SIRET → raison sociale) 4. **Validation** : Les règles Schematron sont appliquées 5. **Génération** : Le Factur-X PDF/A-3 est généré  ## Réponses possibles  - **200** : Conversion réussie, fichiers disponibles - **202** : Données manquantes, complétion requise - **422** : Validation échouée, corrections nécessaires - **400** : Fichier invalide - **429** : Quota dépassé
+     * @summary Convertir un document en Factur-X
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentApiV1ConvertPost(file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConvertSuccessResponse, any, {}>>;
+    /**
+     * Lance une conversion asynchrone via Celery.  ## Workflow  1. **Upload** : Le document est envoyé en multipart/form-data 2. **Task Celery** : La tâche est mise en file d\'attente 3. **Callback** : Notification par webhook à la fin  ## Réponses possibles  - **202** : Tâche acceptée, en cours de traitement - **400** : Fichier invalide
+     * @summary Convertir un document en Factur-X (mode asynchrone)
+     * @param {File} file Document à convertir (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Format de sortie: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost(file: File, output?: string, callbackUrl?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Télécharge le fichier Factur-X PDF ou XML généré.  ## Fichiers disponibles  - `facturx.pdf` : PDF/A-3 avec XML embarqué - `facturx.xml` : XML CII seul (Cross Industry Invoice)  Les fichiers sont disponibles pendant 24 heures après génération.
+     * @summary Télécharger un fichier généré
+     * @param {string} conversionId
+     * @param {string} filename
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet(conversionId: string, filename: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Retourne le statut actuel d\'une conversion asynchrone.
+     * @summary Vérifier le statut d\'une conversion
+     * @param {string} conversionId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet(conversionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Reprend une conversion après complétion des données manquantes ou correction des erreurs.  L\'extraction OCR est conservée, les données sont mises à jour avec les corrections, puis une nouvelle validation Schematron est effectuée.
+     * @summary Reprendre une conversion avec corrections
+     * @param {string} conversionId
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConvertSuccessResponse, any, {}>>;
+}