@factpulse/sdk 4.0.1 → 4.0.3

package/dist/api/factur-xconversion-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 - 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)  ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules)  ### ✍️ 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  ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212)  ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments)  ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user  ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro  ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete  ## 🔒 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
+ * 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';
+/**
+ * FacturXConversionApi - axios parameter creator
+ */
+export declare const FacturXConversionApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Launch an asynchronous conversion via Celery.  ## Workflow  1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **400**: Invalid file
+     * @summary Convert a document to Factur-X (async mode)
+     * @param {File} file Document to convert (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Output format: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {string} [webhookMode] Content delivery mode: \\\'inline\\\' (base64 in webhook) or \\\'download_url\\\' (temporary URL, 1h TTL)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost: (file: File, output?: string, callbackUrl?: string | null, webhookMode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Download the generated Factur-X PDF or XML file.  ## Available files  - `facturx.pdf`: PDF/A-3 with embedded XML - `facturx.xml`: XML CII only (Cross Industry Invoice)  Files are available for 24 hours after generation.
+     * @summary Download a generated file
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {string} filename File to download: \&#39;facturx.pdf\&#39; or \&#39;facturx.xml\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet: (conversionId: string, filename: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the current status of an asynchronous conversion.
+     * @summary Check conversion status
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet: (conversionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors.  The OCR extraction is preserved, data is updated with corrections, then a new Schematron validation is performed.
+     * @summary Resume a conversion with corrections
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost: (conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors (async mode).  The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery.  ## Workflow  1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **404**: Conversion not found or expired
+     * @summary Resume a conversion asynchronously
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionAsyncApiV1ConvertConversionIdResumeAsyncPost: (conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * FacturXConversionApi - functional programming interface
+ */
+export declare const FacturXConversionApiFp: (configuration?: Configuration) => {
+    /**
+     * Launch an asynchronous conversion via Celery.  ## Workflow  1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **400**: Invalid file
+     * @summary Convert a document to Factur-X (async mode)
+     * @param {File} file Document to convert (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Output format: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {string} [webhookMode] Content delivery mode: \\\&#39;inline\\\&#39; (base64 in webhook) or \\\&#39;download_url\\\&#39; (temporary URL, 1h TTL)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost(file: File, output?: string, callbackUrl?: string | null, webhookMode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Download the generated Factur-X PDF or XML file.  ## Available files  - `facturx.pdf`: PDF/A-3 with embedded XML - `facturx.xml`: XML CII only (Cross Industry Invoice)  Files are available for 24 hours after generation.
+     * @summary Download a generated file
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {string} filename File to download: \&#39;facturx.pdf\&#39; or \&#39;facturx.xml\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet(conversionId: string, filename: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Returns the current status of an asynchronous conversion.
+     * @summary Check conversion status
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet(conversionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors.  The OCR extraction is preserved, data is updated with corrections, then a new Schematron validation is performed.
+     * @summary Resume a conversion with corrections
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @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>>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors (async mode).  The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery.  ## Workflow  1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **404**: Conversion not found or expired
+     * @summary Resume a conversion asynchronously
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionAsyncApiV1ConvertConversionIdResumeAsyncPost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+};
+/**
+ * FacturXConversionApi - factory interface
+ */
+export declare const FacturXConversionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Launch an asynchronous conversion via Celery.  ## Workflow  1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **400**: Invalid file
+     * @summary Convert a document to Factur-X (async mode)
+     * @param {File} file Document to convert (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Output format: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {string} [webhookMode] Content delivery mode: \\\&#39;inline\\\&#39; (base64 in webhook) or \\\&#39;download_url\\\&#39; (temporary URL, 1h TTL)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost(file: File, output?: string, callbackUrl?: string | null, webhookMode?: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Download the generated Factur-X PDF or XML file.  ## Available files  - `facturx.pdf`: PDF/A-3 with embedded XML - `facturx.xml`: XML CII only (Cross Industry Invoice)  Files are available for 24 hours after generation.
+     * @summary Download a generated file
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {string} filename File to download: \&#39;facturx.pdf\&#39; or \&#39;facturx.xml\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet(conversionId: string, filename: string, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Returns the current status of an asynchronous conversion.
+     * @summary Check conversion status
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet(conversionId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors.  The OCR extraction is preserved, data is updated with corrections, then a new Schematron validation is performed.
+     * @summary Resume a conversion with corrections
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConvertSuccessResponse>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors (async mode).  The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery.  ## Workflow  1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **404**: Conversion not found or expired
+     * @summary Resume a conversion asynchronously
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionAsyncApiV1ConvertConversionIdResumeAsyncPost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+};
+/**
+ * FacturXConversionApi - object-oriented interface
+ */
+export declare class FacturXConversionApi extends BaseAPI {
+    /**
+     * Launch an asynchronous conversion via Celery.  ## Workflow  1. **Upload**: Document is sent as multipart/form-data 2. **Celery Task**: Task is queued for processing 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **400**: Invalid file
+     * @summary Convert a document to Factur-X (async mode)
+     * @param {File} file Document to convert (PDF, DOCX, XLSX, JPG, PNG)
+     * @param {string} [output] Output format: pdf, xml, both
+     * @param {string | null} [callbackUrl]
+     * @param {string} [webhookMode] Content delivery mode: \\\&#39;inline\\\&#39; (base64 in webhook) or \\\&#39;download_url\\\&#39; (temporary URL, 1h TTL)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    convertDocumentAsyncApiV1ConvertAsyncPost(file: File, output?: string, callbackUrl?: string | null, webhookMode?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Download the generated Factur-X PDF or XML file.  ## Available files  - `facturx.pdf`: PDF/A-3 with embedded XML - `facturx.xml`: XML CII only (Cross Industry Invoice)  Files are available for 24 hours after generation.
+     * @summary Download a generated file
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {string} filename File to download: \&#39;facturx.pdf\&#39; or \&#39;facturx.xml\&#39;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    downloadFileApiV1ConvertConversionIdDownloadFilenameGet(conversionId: string, filename: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Returns the current status of an asynchronous conversion.
+     * @summary Check conversion status
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getConversionStatusApiV1ConvertConversionIdStatusGet(conversionId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors.  The OCR extraction is preserved, data is updated with corrections, then a new Schematron validation is performed.
+     * @summary Resume a conversion with corrections
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionApiV1ConvertConversionIdResumePost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConvertSuccessResponse, any, {}>>;
+    /**
+     * Resume a conversion after completing missing data or correcting errors (async mode).  The OCR extraction is preserved, data is updated with corrections, then processing is performed asynchronously via Celery.  ## Workflow  1. **Submit corrections**: Corrections are validated and task is queued 2. **Celery Task**: Task processes corrections and generates Factur-X 3. **Callback**: Webhook notification on completion  ## Possible responses  - **202**: Task accepted, processing - **404**: Conversion not found or expired
+     * @summary Resume a conversion asynchronously
+     * @param {string} conversionId Conversion ID returned by POST /convert (UUID format)
+     * @param {ConvertResumeRequest} convertResumeRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    resumeConversionAsyncApiV1ConvertConversionIdResumeAsyncPost(conversionId: string, convertResumeRequest: ConvertResumeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+}