@factpulse/sdk 3.0.37 → 4.0.0

package/dist/models/scheme-id.js

@@ -15,21 +15,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchemeID = void 0;
 /**
- * Identification scheme codes (Electronic Address Scheme - EAS), mainly for electronic invoice addressing.  **Possible values:** - `0225`: FR_SIREN - French SIREN (most common for France) - `0009`: FR_SIRET - French SIRET - `0002`: FR_SIREN_OLD - French SIREN (old code, for legal organization ID) - `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 - `0231`: DT_DIRECTORY_ID - Directory ID for tax administration - `EM`: EMAIL - Email-based electronic address (BT-34/BT-49)
+ * Identification scheme codes (Electronic Address Scheme - EAS).  **Electronic Address (routing for PDP/Chorus Pro):** - `0225`: FR_ELECTRONIC_ADDRESS - French electronic billing address (BT-34/BT-49)             Format: SIREN or SIREN_SUFFIX (e.g., \"920195229_92019522900017\")  **Legal Identifiers (entity identification):** - `0002`: FR_SIREN - French SIREN (9 digits) for BT-30/BT-47 - `0009`: FR_SIRET - French SIRET (14 digits) for BT-29/BT-46  **Other schemes:** - `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 - `0231`: DT_DIRECTORY_ID - Directory ID for tax administration - `EM`: EMAIL - Email-based electronic address
  */
 exports.SchemeID = {
     /**
-    * FR_SIREN - French SIREN (most common for France)
+    * FR_ELECTRONIC_ADDRESS - French electronic billing address (BT-34/BT-49)
     */
-    FR_SIREN: '0225',
+    FR_ELECTRONIC_ADDRESS: '0225',
     /**
-    * FR_SIRET - French SIRET
+    * FR_SIREN - French SIREN (9 digits) - Legal organization ID
     */
-    FR_SIRET: '0009',
+    FR_SIREN: '0002',
     /**
-    * FR_SIREN_OLD - French SIREN (old code, for legal organization ID)
+    * FR_SIRET - French SIRET (14 digits) - Establishment ID
     */
-    FR_SIREN_OLD: '0002',
+    FR_SIRET: '0009',
     /**
     * GLN - Global Location Number (GLN)
     */

package/dist/models/search-structure-request.d.ts

@@ -9,12 +9,12 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } from './facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials';
+import type { ChorusProCredentials } from './chorus-pro-credentials';
 /**
  * Search structures by criteria.
  */
 export interface SearchStructureRequest {
-    'credentials'?: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials | null;
+    'credentials'?: ChorusProCredentials | null;
     'structureIdentifier'?: string | null;
     'structureIdentifierType'?: string | null;
     'companyName'?: string | null;

package/dist/models/simplified-invoice-data.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { InvoiceTypeCode } from './invoice-type-code';
+import type { FactureElectroniqueModelsInvoiceTypeCode } from './facture-electronique-models-invoice-type-code';
 import type { InvoicingFrameworkCode } from './invoicing-framework-code';
 import type { OperationNature } from './operation-nature';
 /**
@@ -49,7 +49,7 @@ export interface SimplifiedInvoiceData {
     /**
      * Document type (UNTDID 1001). Default: 380 (Invoice).
      */
-    'invoiceType'?: InvoiceTypeCode;
+    'invoiceType'?: FactureElectroniqueModelsInvoiceTypeCode;
     'precedingInvoiceReference'?: string | null;
     'operationNature'?: OperationNature | null;
     'invoicingFramework'?: InvoicingFrameworkCode | null;

package/dist/models/submit-complete-invoice-response.d.ts

@@ -40,7 +40,7 @@ export interface SubmitCompleteInvoiceResponse {
     /**
      * Generated Factur-X PDF (and signed if requested) base64-encoded
      */
-    'pdfBase64': string;
+    'contentB64': string;
     /**
      * Return message
      */

package/dist/models/submit-invoice-request.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { FactureElectroniqueRestApiSchemasChorusProChorusProCredentials } from './facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials';
+import type { ChorusProCredentials } from './chorus-pro-credentials';
 import type { SubmitGrossAmount } from './submit-gross-amount';
 import type { SubmitNetAmount } from './submit-net-amount';
 import type { SubmitVatAmount } from './submit-vat-amount';
@@ -17,7 +17,7 @@ import type { SubmitVatAmount } from './submit-vat-amount';
  * Submit an invoice to Chorus Pro.
  */
 export interface SubmitInvoiceRequest {
-    'credentials'?: FactureElectroniqueRestApiSchemasChorusProChorusProCredentials | null;
+    'credentials'?: ChorusProCredentials | null;
     /**
      * Invoice number
      */

package/dist/models/supplier.d.ts

@@ -16,7 +16,7 @@ import type { PostalAddress } from './postal-address';
  * Information about the supplier / seller (BG-4).
  */
 export interface Supplier {
-    'electronic_address': ElectronicAddress | null;
+    'electronic_address'?: ElectronicAddress | null;
     'supplier_id': number;
     'private_id'?: string | null;
     'supplier_bank_account_code'?: number | null;

package/dist/models/validate-cdarresponse.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { ValidationErrorResponse } from './validation-error-response';
+import type { FactureElectroniqueRestApiSchemasCdarValidationErrorResponse } from './facture-electronique-rest-api-schemas-cdar-validation-error-response';
 /**
  * Réponse de validation CDAR.
  */
@@ -21,9 +21,9 @@ export interface ValidateCDARResponse {
     /**
      * Liste des erreurs
      */
-    'errors'?: Array<ValidationErrorResponse>;
+    'errors'?: Array<FactureElectroniqueRestApiSchemasCdarValidationErrorResponse>;
     /**
      * Liste des avertissements
      */
-    'warnings'?: Array<ValidationErrorResponse>;
+    'warnings'?: Array<FactureElectroniqueRestApiSchemasCdarValidationErrorResponse>;
 }

package/dist/models/validation-error-response.d.ts

@@ -10,20 +10,11 @@
  * Do not edit the class manually.
  */
 /**
- * Erreur de validation.
+ * Response for validation errors.
  */
 export interface ValidationErrorResponse {
     /**
-     * Champ concerné
+     * List of detected validation errors.
      */
-    'field': string;
-    /**
-     * Message d\'erreur
-     */
-    'message': string;
-    'rule'?: string | null;
-    /**
-     * Sévérité (error/warning)
-     */
-    'severity'?: string;
+    'detail': Array<string>;
 }

package/dist/src/helpers/client.d.ts

@@ -1,278 +1,56 @@
-/** Chorus Pro credentials for Zero-Trust mode. */
-export interface ChorusProCredentials {
-    pisteClientId: string;
-    pisteClientSecret: string;
-    chorusProLogin: string;
-    chorusProPassword: string;
-    sandbox?: boolean;
-}
-/** AFNOR PDP credentials for Zero-Trust mode. The FactPulse API uses these credentials to authenticate with the AFNOR PDP. */
-export interface AFNORCredentials {
-    flowServiceUrl: string;
-    tokenUrl: string;
-    clientId: string;
-    clientSecret: string;
-    directoryServiceUrl?: string;
+export declare class FactPulseError extends Error {
+    statusCode?: number;
+    details?: unknown[];
+    constructor(message: string, statusCode?: number, details?: unknown[]);
 }
 export interface FactPulseClientConfig {
     email: string;
     password: string;
+    clientUid: string;
     apiUrl?: string;
-    clientUid?: string;
-    chorusCredentials?: ChorusProCredentials;
-    afnorCredentials?: AFNORCredentials;
-    pollingInterval?: number;
+    timeout?: number;
     pollingTimeout?: number;
     maxRetries?: number;
 }
-type AmountValue = string | number | null | undefined;
-/** Converts a value to an amount string for the API. */
-export declare function amount(value: AmountValue): string;
-/** Creates a simplified InvoiceTotals object. */
-export declare function invoiceTotals(exclTax: AmountValue, vat: AmountValue, inclTax: AmountValue, amountDue: AmountValue, options?: {
-    globalAllowanceAmount?: AmountValue;
-    globalAllowanceReason?: string;
-    prepayment?: AmountValue;
-}): Record<string, unknown>;
-/** Creates an invoice line (aligned with InvoiceLine in models.py).
- * For VAT rate: either vatRate (code e.g.: "VAT20") or manualVatRate (value e.g.: 20.00) */
-export declare function invoiceLine(lineNumber: number, itemName: string, quantity: AmountValue, unitNetPrice: AmountValue, lineNetAmount: AmountValue, options?: {
-    vatRate?: string;
-    manualVatRate?: AmountValue;
-    vatCategory?: string;
-    unit?: string;
-    reference?: string;
-    lineAllowanceAmount?: AmountValue;
-    allowanceReasonCode?: string;
-    allowanceReason?: string;
-    periodStartDate?: string;
-    periodEndDate?: string;
-}): Record<string, unknown>;
-/** Creates a VAT line (aligned with VATLine in models.py).
- * For rate: either rate (code e.g.: "VAT20") or manualRate (value e.g.: 20.00) */
-export declare function vatLine(taxableAmount: AmountValue, vatAmount: AmountValue, options?: {
-    rate?: string;
-    manualRate?: AmountValue;
-    category?: string;
-}): Record<string, unknown>;
-/** Creates a postal address for the FactPulse API. */
-export declare function postalAddress(lineOne: string, postalCode: string, city: string, options?: {
-    countryCode?: string;
-    lineTwo?: string;
-    lineThree?: string;
-}): Record<string, unknown>;
-/** Creates an electronic address for the FactPulse API. schemeId: "0009"=SIREN, "0225"=SIRET */
-export declare function electronicAddress(identifier: string, schemeId?: string): Record<string, unknown>;
-/** Creates a supplier (issuer) with auto-computed SIREN, intra-EU VAT number and addresses. */
-export declare function supplier(name: string, siret: string, addressLine1: string, postalCode: string, city: string, options?: {
-    supplierId?: number;
-    siren?: string;
-    vatNumber?: string;
-    iban?: string;
-    countryCode?: string;
-    addressLine2?: string;
-    supplierServiceId?: number;
-    supplierBankDetailsCode?: number;
-}): Record<string, unknown>;
-/** Creates a recipient (customer) with auto-computed SIREN and addresses. */
-export declare function recipient(name: string, siret: string, addressLine1: string, postalCode: string, city: string, options?: {
-    siren?: string;
-    countryCode?: string;
-    addressLine2?: string;
-    executingServiceCode?: string;
-}): Record<string, unknown>;
-/**
- * Creates a beneficiary (factor) for factoring.
- *
- * The beneficiary (BG-10 / PayeeTradeParty) is used when payment
- * must be made to a third party different from the supplier, typically
- * a factor (factoring company).
- *
- * For factored invoices, you also need to:
- * - Use a factored document type (393, 396, 501, 502, 472, 473)
- * - Add an ACC note with the subrogation mention
- * - The beneficiary's IBAN will be used for payment
- *
- * @param name Factor's business name (BT-59)
- * @param options Options: siret (BT-60), siren (BT-61), iban, bic
- * @returns Dict ready to be used in a factored invoice
- *
- * @example
- * const factor = beneficiary('FACTOR SAS', {
- *   siret: '30000000700033',
- *   iban: 'FR76 3000 4000 0500 0012 3456 789',
- * });
- */
-export declare function beneficiary(name: string, options?: {
-    siret?: string;
-    siren?: string;
-    iban?: string;
-    bic?: string;
-}): Record<string, unknown>;
 export declare class FactPulseClient {
-    private config;
-    private httpClient;
-    private accessToken;
-    private refreshToken;
+    private readonly apiUrl;
+    private readonly email;
+    private readonly password;
+    private readonly clientUid;
+    private readonly timeout;
+    private readonly pollingTimeout;
+    private readonly httpClient;
+    private token;
     private tokenExpiresAt;
-    readonly chorusCredentials?: ChorusProCredentials;
-    readonly afnorCredentials?: AFNORCredentials;
     constructor(config: FactPulseClientConfig);
-    getChorusCredentialsForApi(): Record<string, unknown> | undefined;
-    getAfnorCredentialsForApi(): Record<string, unknown> | undefined;
-    getChorusProCredentials(): Record<string, unknown> | undefined;
-    getAfnorCredentials(): Record<string, unknown> | undefined;
-    private obtainToken;
-    ensureAuthenticated(forceRefresh?: boolean): Promise<void>;
-    resetAuth(): void;
-    pollTask(taskId: string, timeout?: number, interval?: number): Promise<Record<string, unknown>>;
-    generateFacturx(invoiceData: Record<string, unknown> | string, pdfPath: string, profile?: string, outputFormat?: string, sync?: boolean, timeout?: number): Promise<Buffer | string>;
-    static formatAmount(m: unknown): string;
-    /**
-     * Retrieves AFNOR credentials (stored or zero-trust mode).
-     * Zero-trust mode: Returns the afnorCredentials provided to the constructor.
-     * Stored mode: Retrieves credentials via GET /api/v1/afnor/credentials.
-     */
-    private getAfnorCredentialsInternal;
-    /**
-     * Obtains the AFNOR OAuth2 token and the PDP URL.
-     * This method:
-     * 1. Retrieves AFNOR credentials (stored or zero-trust mode)
-     * 2. Performs AFNOR OAuth to obtain a token
-     * 3. Returns the token and the PDP URL
-     */
-    private getAfnorTokenAndUrl;
-    /**
-     * Performs a request to the AFNOR API with auth and error handling.
-     * IMPORTANT: This method uses the AFNOR OAuth token, NOT the FactPulse JWT!
-     */
-    private makeAfnorRequest;
-    /** Gets a facility by SIRET in the AFNOR directory. */
-    getSiretAfnor(siret: string): Promise<Record<string, unknown>>;
-    /** Gets a legal unit by SIREN in the AFNOR directory. */
-    getSirenAfnor(siren: string): Promise<Record<string, unknown>>;
-    /** Searches for legal units (SIREN) in the AFNOR directory. */
-    searchSirenAfnor(options?: {
-        filters?: Record<string, unknown>;
-        limit?: number;
-    }): Promise<Record<string, unknown>>;
-    /** Searches for routing codes in the AFNOR directory. */
-    searchRoutingCodesAfnor(options?: {
-        filters?: Record<string, unknown>;
-        limit?: number;
-    }): Promise<Record<string, unknown>>;
-    /** Gets a routing code by SIRET and routing identifier. */
-    getRoutingCodeAfnor(siret: string, routingIdentifier: string): Promise<Record<string, unknown>>;
-    /**
-     * Submits an invoice to a PDP via the AFNOR API.
-     * Authentication uses the AFNOR OAuth token (obtained automatically),
-     * either via stored credentials (stored mode), or via the afnorCredentials
-     * provided to the constructor (zero-trust mode).
-     *
-     * @param pdfBuffer Buffer of the Factur-X PDF to submit
-     * @param flowName Flow name (e.g.: "Invoice INV-2025-001")
-     * @param options Options: trackingId, flowSyntax (CII/UBL), flowProfile
-     */
-    submitInvoiceAfnor(pdfBuffer: Buffer, flowName: string, options?: {
-        trackingId?: string;
-        flowSyntax?: string;
-        flowProfile?: string;
-    }): Promise<Record<string, unknown>>;
-    searchFlowsAfnor(criteria?: {
-        trackingId?: string;
-        status?: string;
-        offset?: number;
-        limit?: number;
-    }): Promise<Record<string, unknown>>;
-    downloadFlowAfnor(flowId: string): Promise<Buffer>;
-    /**
-     * Retrieves JSON metadata of an incoming flow (supplier invoice).
-     * Downloads an incoming flow from the AFNOR PDP and extracts invoice
-     * metadata into a unified JSON format. Supports Factur-X, CII and UBL.
-     *
-     * Note: This endpoint uses FactPulse JWT authentication (not AFNOR OAuth).
-     * The FactPulse server handles calling the PDP with stored credentials.
-     *
-     * @param flowId Flow identifier (UUID)
-     * @param includeDocument If true, includes the original document encoded in base64
-     * @returns Invoice metadata (supplier, amounts, dates, etc.)
-     *
-     * @example
-     * const invoice = await client.getIncomingInvoiceAfnor("550e8400-...");
-     * console.log(`Supplier: ${invoice.supplier.name}`);
-     * console.log(`Total incl. tax: ${invoice.total_incl_tax} ${invoice.currency}`);
-     */
-    getIncomingInvoiceAfnor(flowId: string, includeDocument?: boolean): Promise<Record<string, unknown>>;
-    healthcheckAfnor(): Promise<Record<string, unknown>>;
-    rechercherStructureChorus(criteria: Record<string, unknown>): Promise<unknown[]>;
-    consulterStructureChorus(idStructureCpp: number): Promise<Record<string, unknown>>;
-    /**
-     * Lists the services of a Chorus Pro structure.
-     * @param idStructureCpp Chorus Pro ID of the structure
-     * @returns Object with listeServices, total, codeRetour, libelle
-     */
-    listerServicesStructureChorus(idStructureCpp: number): Promise<Record<string, unknown>>;
-    obtenirIdChorusDepuisSiret(siret: string): Promise<number | null>;
-    submitInvoiceChorus(invoiceData: Record<string, unknown>): Promise<Record<string, unknown>>;
-    lookupInvoiceChorus(invoiceIdCpp: number): Promise<Record<string, unknown>>;
-    /**
-     * Validates a Factur-X PDF.
-     * @param pdfBuffer - PDF content as Buffer
-     * @param options - Validation options
-     * @param options.profile - Factur-X profile (MINIMUM, BASIC, EN16931, EXTENDED). If not specified, auto-detected.
-     * @param options.useVerapdf - Enable strict PDF/A validation with VeraPDF (default: false)
-     */
-    validateFacturxPdf(pdfBuffer: Buffer, options?: {
-        profile?: string;
-        useVerapdf?: boolean;
-    }): Promise<Record<string, unknown>>;
-    validateFacturxXml(xmlContent: string, profile?: string): Promise<Record<string, unknown>>;
-    validatePdfSignature(pdfBuffer: Buffer): Promise<Record<string, unknown>>;
-    /**
-     * Signs a PDF with the server-configured certificate (via JWT client_uid).
-     * The certificate must be previously configured in Django Admin.
-     */
-    signPdf(pdfBuffer: Buffer, options?: {
-        reason?: string;
-        location?: string;
-        contact?: string;
-        usePadesLt?: boolean;
-        useTimestamp?: boolean;
-    }): Promise<Buffer>;
-    /**
-     * Generates a test certificate (NOT FOR PRODUCTION).
-     * The certificate must then be configured in Django Admin.
-     */
-    generateTestCertificate(options?: {
-        cn?: string;
-        organisation?: string;
-        email?: string;
-        validityDays?: number;
-        keySize?: number;
-    }): Promise<Record<string, unknown>>;
-    /**
-     * Complete workflow: generation + validation + signature + AFNOR submission.
-     * Note: Signature uses the server-configured certificate (via JWT client_uid).
-     * @param invoiceData Invoice data
-     * @param pdfPath Path to the source PDF
-     * @param options Workflow options
-     * @returns Result with pdfBytes, validation, signature and afnor
-     */
-    generateCompleteFacturx(invoiceData: Record<string, unknown>, pdfPath: string, options?: {
-        profile?: string;
-        validate?: boolean;
-        sign?: boolean;
-        submitAfnor?: boolean;
-        afnorFlowName?: string;
-        afnorTrackingId?: string;
-        timeout?: number;
-    }): Promise<{
-        pdfBytes: Buffer;
-        validation?: Record<string, unknown>;
-        signature?: {
-            signed: boolean;
-        };
-        afnor?: Record<string, unknown>;
-    }>;
+    /** POST request to /api/v1/{path} */
+    post(path: string, data?: Record<string, unknown>): Promise<unknown>;
+    /** GET request to /api/v1/{path} */
+    get(path: string, params?: Record<string, unknown>): Promise<unknown>;
+    get processing(): Endpoint;
+    get chorus_pro(): Endpoint;
+    get afnor(): Endpoint;
+    private _endpoint;
+    _request(method: 'GET' | 'POST', path: string, data?: Record<string, unknown>): Promise<unknown>;
+    private _doRequest;
+    private _parseResponse;
+    private _poll;
+    private _ensureAuth;
+    private _refreshToken;
+    private _invalidateToken;
+}
+declare class Endpoint {
+    private client;
+    private path;
+    constructor(client: FactPulseClient, path: string);
+    private _child;
+    get invoices(): Endpoint;
+    get structures(): Endpoint;
+    get tasks(): Endpoint;
+    get validate_facturx_pdf(): Endpoint;
+    get submit_complete_async(): Endpoint;
+    [key: string]: unknown;
+    call(data?: Record<string, unknown>): Promise<unknown>;
+    get(params?: Record<string, unknown>): Promise<unknown>;
 }
 export {};