pi-spi-sdk 0.1.2 → 0.2.0

package/dist/generated/services/PaiementImmediatService.js

@@ -1,176 +0,0 @@
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class PaiementImmediatService {
-    /**
-     * Envoyer un paiement
-     * Ce point de terminaison permet au business d'effectuer des paiements.
-     *
-     * Le destinataire du paiement est identifié par son alias de compte.
-     *
-     * Le business peut définir le champ `confirmation` à `true` pour demander une validation en deux étapes : le PSP retournera d'abord le résultat de la recherche d'alias (avec le nom et le pays du bénéficiaire), puis attendra une confirmation explicite avant d'exécuter le paiement via l'endpoint `PUT /paiements/{txId}/confirmations`.
-     *
-     * **Timeout de confirmation** : Si le business demande une confirmation, il dispose de **24 heures** pour confirmer. Passé ce délai, la demande expire automatiquement.
-     *
-     * @returns PaiementImmediatReponse Paiement traité. Le champ `statut` indique le résultat :
-     * - `INITIE` : En attente de confirmation (si `confirmation: true`)
-     * - `ENVOYE` : Paiement envoyé avec succès (si `confirmation: false`)
-     * - `REJETE` : Paiement rejeté. Le champ `statutRaison` contient le code d'erreur :
-     * - `DU03` : txId dupliqué (déjà utilisé)
-     * - `BE23` : Alias bénéficiaire invalide
-     * - Autres codes ISO 20022
-     *
-     * @throws ApiError
-     */
-    static paiementCreer({ requestBody, }) {
-        return __request(OpenAPI, {
-            method: 'POST',
-            url: '/paiements',
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                400: `La requête est malformée`,
-                401: `Autorisations manquantes`,
-                403: `Interdiction d'effectuer le paiement (erreurs métier non-retriables)`,
-                429: `Erreur inattendue`,
-                503: `Erreur inattendue du serveur`,
-            },
-        });
-    }
-    /**
-     * Lister les paiements
-     * Ce point de terminaison permet de lister les paiements effectués par le client.
-     * @returns PaiementListe Succès de l'opération
-     * @throws ApiError
-     */
-    static paiementLister({ payeAlias, payeCompte, payeurAlias, payeurCompte, dateEnvoi, dateIrrevocabilite, statut, categorie, montantAchat, montantRetrait, motif, refDocType, instructionId, txId, annulationStatut, annulationMotif, retourStatut, page, size, sort, fields, }) {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/paiements',
-            query: {
-                'payeAlias': payeAlias,
-                'payeCompte': payeCompte,
-                'payeurAlias': payeurAlias,
-                'payeurCompte': payeurCompte,
-                'dateEnvoi': dateEnvoi,
-                'dateIrrevocabilite': dateIrrevocabilite,
-                'statut': statut,
-                'categorie': categorie,
-                'montantAchat': montantAchat,
-                'montantRetrait': montantRetrait,
-                'motif': motif,
-                'refDocType': refDocType,
-                'instructionId': instructionId,
-                'txId': txId,
-                'annulationStatut': annulationStatut,
-                'annulationMotif': annulationMotif,
-                'retourStatut': retourStatut,
-                'page': page,
-                'size': size,
-                'sort': sort,
-                'fields': fields,
-            },
-            errors: {
-                401: `Autorisations manquantes`,
-                429: `Erreur inattendue`,
-                503: `Erreur inattendue du serveur`,
-            },
-        });
-    }
-    /**
-     * Détails d'un paiement
-     * Cet point de terminaison permet de consulter les details d'un paiement.
-     *
-     * @returns Paiement Opération effectuée avec succès
-     * @throws ApiError
-     */
-    static paiementRecuperer({ txId, }) {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/paiements/{txId}',
-            path: {
-                'txId': txId,
-            },
-            errors: {
-                401: `Autorisations manquantes`,
-                404: `La ressource n'existe pas dans le système`,
-                429: `Erreur inattendue`,
-                503: `Erreur inattendue du serveur`,
-            },
-        });
-    }
-    /**
-     * Confirmer le paiement
-     * Ce point de terminaison permet d'envoyer la confirmation de l'envoi d'un paiement immédiat
-     * après vérification du nom et du pays du bénéficiaire.
-     *
-     * **Idempotence** : Cet endpoint est idempotent.
-     * - Premier appel avec `decision: true` → Lance le paiement, retourne `200 OK {statut: "ENVOYE"}`
-     * - Appels suivants avec `decision: true` → Retourne `200 OK` avec l'état actuel (ENVOYE, IRREVOCABLE, ou REJETE) - idempotent
-     * - Premier appel avec `decision: false` → Annule, retourne `200 OK {statut: "ANNULE"}`
-     * - Appels suivants avec `decision: false` → Retourne `200 OK {statut: "ANNULE"}` (idempotent)
-     * - `decision: true` après `decision: false` → Retourne `403 Forbidden` (déjà annulé)
-     * - `decision: false` après `decision: true` → Retourne `403 Forbidden` (déjà confirmé)
-     *
-     * **Timeout** : La confirmation doit être envoyée dans les **24 heures** suivant la création de la demande. Passé ce délai, la demande expire automatiquement et ne peut plus être confirmée.
-     *
-     * **Changement de décision** : Une fois une décision prise, elle est définitive. Impossible de confirmer après avoir annulé, et vice-versa.
-     *
-     * @returns PaiementImmediatConfirmationReponse Paiement en cours d'envoi
-     * @throws ApiError
-     */
-    static paiementConfirmer({ txId, requestBody, }) {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/paiements/{txId}/confirmations',
-            path: {
-                'txId': txId,
-            },
-            body: requestBody,
-            mediaType: 'application/json',
-            errors: {
-                401: `Autorisations manquantes`,
-                403: `Opération interdite`,
-                404: `La ressource n'existe pas dans le système`,
-                429: `Erreur inattendue`,
-                503: `Erreur inattendue du serveur`,
-            },
-        });
-    }
-    /**
-     * Vérifier un paiement
-     * Ce point de terminaison permet de vérifier la réception d’un paiement à partir de l’`end2endId`.
-     *
-     * Dans certains cas, le **client business** peut ne pas avoir reçu la notification de paiement.
-     * Le **client payeur** peut alors lui communiquer l’`end2endId` afin qu’il puisse vérifier manuellement le statut du paiement.
-     *
-     * Le **participant** doit, dans ce cas, vérifier dans sa base de données et s'il ne trouve pas le paiement, il doit interroger l’endpoint de PI-SPI permettant de **récupérer le statut d’un paiement**,  puis **retourner ce statut** dans sa réponse.
-     *
-     * Le statut retourné doit être soit :
-     * - `IRREVOCABLE` (paiement irrévocable), ou
-     * - `REJETE` (paiement rejeté).
-     *
-     * Un transfert **ne peut pas** être signalé comme « en cours de traitement » dans ce contexte.
-     *
-     * ⚠️ **Remarques :**
-     * - La vérification ne doit concerner que les paiements réalisés depuis **moins de 3 mois (90 jours)** afin de garantir la disponibilité de la réponse.
-     * - La garantie de réponse n’est assurée qu’à partir de **20 secondes après l’envoi du transfert**.
-     *
-     * @returns Paiement Opération effectuée avec succès
-     * @throws ApiError
-     */
-    static paiementVerifier({ end2EndId, }) {
-        return __request(OpenAPI, {
-            method: 'GET',
-            url: '/paiements/{end2endId}/statuts',
-            path: {
-                'end2endId': end2EndId,
-            },
-            errors: {
-                401: `Autorisations manquantes`,
-                404: `Ce paiement n'a pas été trouvé`,
-                429: `Erreur inattendue`,
-                503: `Erreur inattendue du serveur`,
-            },
-        });
-    }
-}

package/dist/generated/services/RetoursdeFondsService.d.ts

@@ -1,28 +0,0 @@
-import type { Paiement } from '../models/Paiement';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class RetoursdeFondsService {
-    /**
-     * Retourner les fonds
-     * Ce point de terminaison permet au business de retourner les fonds d'un paiement reçu.
-     *
-     * **Idempotence** : Cet endpoint est idempotent. Plusieurs appels avec le même `end2endId` produiront le même résultat.
-     * Si le retour de fonds a déjà été envoyé et irrévocable, le champ `retourStatut` de la réponse sera `IRREVOCABLE`.
-     * Si le retour de fonds a été envoyé et rejeté, le retour de fonds sera envoyé à nouveau.
-     * Si le retour de fonds est en cours d'envoi, le champ `retourStatut` de la réponse sera `INITIE`.
-     *
-     * **Notifications webhook** : Après envoi du retour de fonds, si le business a souscrit au service de webhook, il recevra :
-     * - Une notification `RETOUR_ENVOYE` en cas de succès du retour de fonds
-     * - Une notification `RETOUR_REJETE` en cas de rejet de la demande
-     *
-     * **Vérification du statut** : Pour obtenir le statut d'un retour de fonds envoyé, vous pouvez invoquer l'endpoint `GET /paiements/{end2endId}` et le champ `retourStatut` de la réponse indiquera l'état du retour de fonds.
-     *
-     * @returns Paiement Retour de fonds enregistré avec succès
-     * @throws ApiError
-     */
-    static retourFondsEnvoyer({ end2EndId, }: {
-        /**
-         * L'identifiant unique de bout en bout de la transaction
-         */
-        end2EndId: string;
-    }): CancelablePromise<Paiement>;
-}

package/dist/generated/services/RetoursdeFondsService.js

@@ -1,37 +0,0 @@
-import { OpenAPI } from '../core/OpenAPI';
-import { request as __request } from '../core/request';
-export class RetoursdeFondsService {
-    /**
-     * Retourner les fonds
-     * Ce point de terminaison permet au business de retourner les fonds d'un paiement reçu.
-     *
-     * **Idempotence** : Cet endpoint est idempotent. Plusieurs appels avec le même `end2endId` produiront le même résultat.
-     * Si le retour de fonds a déjà été envoyé et irrévocable, le champ `retourStatut` de la réponse sera `IRREVOCABLE`.
-     * Si le retour de fonds a été envoyé et rejeté, le retour de fonds sera envoyé à nouveau.
-     * Si le retour de fonds est en cours d'envoi, le champ `retourStatut` de la réponse sera `INITIE`.
-     *
-     * **Notifications webhook** : Après envoi du retour de fonds, si le business a souscrit au service de webhook, il recevra :
-     * - Une notification `RETOUR_ENVOYE` en cas de succès du retour de fonds
-     * - Une notification `RETOUR_REJETE` en cas de rejet de la demande
-     *
-     * **Vérification du statut** : Pour obtenir le statut d'un retour de fonds envoyé, vous pouvez invoquer l'endpoint `GET /paiements/{end2endId}` et le champ `retourStatut` de la réponse indiquera l'état du retour de fonds.
-     *
-     * @returns Paiement Retour de fonds enregistré avec succès
-     * @throws ApiError
-     */
-    static retourFondsEnvoyer({ end2EndId, }) {
-        return __request(OpenAPI, {
-            method: 'PUT',
-            url: '/paiements/{end2endId}/retours',
-            path: {
-                'end2endId': end2EndId,
-            },
-            errors: {
-                401: `Autorisations manquantes`,
-                403: `Interdiction d'effectuer le retour de fonds`,
-                429: `Erreur inattendue`,
-                503: `Erreur inattendue du serveur`,
-            },
-        });
-    }
-}

package/dist/index.js

@@ -1,23 +0,0 @@
-/**
- * Main entry point for PI-SPI SDK
- *
- * @module pi-spi-sdk
- */
-// Export main SDK class
-export { PiSpiSDK } from './sdk';
-// Export error classes
-export { PiSpiError, PiSpiValidationError, PiSpiAuthError, PiSpiNotFoundError, PiSpiRateLimitError, } from './errors';
-// Export query builder
-export { QueryBuilder } from './query-builder';
-// Export error handler for advanced use cases
-export { handleApiError } from './error-handler';
-// Export alias types and utilities
-export { AliasType, ALIAS_TYPES, isValidAliasType, getAvailableAliasTypes, } from './types/alias';
-// Export utility functions
-export { formatAmount, xofToCentimes, centimesToXof, isValidAccountNumber, isValidShidAlias, isValidPhoneNumber, getCountryFromAccount, sleep, retryWithBackoff, } from './utils';
-// Export constants
-export { PI_SPI_ENDPOINTS, PAYMENT_STATUS, ACCOUNT_STATUS, ACCOUNT_TYPE, CLIENT_TYPE, UEMOA_COUNTRIES, CURRENCY, DEFAULT_LIMITS, WEBHOOK_EVENTS, } from './utils/constants';
-// Note: ALIAS_TYPES is exported from './types/alias' above
-// Re-export generated types and services (available after running generate)
-// These will be available once the OpenAPI codegen is run
-export * from './generated';

package/dist/query-builder.d.ts

@@ -1,91 +0,0 @@
-/**
- * Query builder utility for constructing filter, pagination, and sorting parameters
- */
-export type FilterOperator = 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'contains' | 'notContains' | 'beginsWith' | 'endsWith' | 'exists';
-export interface FilterOptions {
-    operator?: FilterOperator;
-    value: string | number | boolean | string[];
-}
-export interface QueryParams {
-    [key: string]: string | number | undefined;
-}
-export declare class QueryBuilder {
-    private params;
-    private filters;
-    private sortField?;
-    private sortOrder;
-    /**
-     * Add a filter condition
-     * @param field - Field name to filter on
-     * @param operator - Filter operator (default: 'eq')
-     * @param value - Filter value
-     */
-    filter(field: string, operatorOrValue: FilterOperator | string | number | boolean, value?: string | number | boolean | string[]): this;
-    /**
-     * Add an equality filter (shorthand)
-     */
-    eq(field: string, value: string | number | boolean): this;
-    /**
-     * Add a "not equal" filter (shorthand)
-     */
-    ne(field: string, value: string | number | boolean): this;
-    /**
-     * Add a "greater than" filter (shorthand)
-     */
-    gt(field: string, value: string | number): this;
-    /**
-     * Add a "greater than or equal" filter (shorthand)
-     */
-    gte(field: string, value: string | number): this;
-    /**
-     * Add a "less than" filter (shorthand)
-     */
-    lt(field: string, value: string | number): this;
-    /**
-     * Add a "less than or equal" filter (shorthand)
-     */
-    lte(field: string, value: string | number): this;
-    /**
-     * Add an "in" filter (shorthand)
-     */
-    in(field: string, values: string[]): this;
-    /**
-     * Add a "contains" filter (shorthand)
-     */
-    contains(field: string, value: string): this;
-    /**
-     * Set sort field and order
-     * @param field - Field to sort by
-     * @param order - Sort order ('asc' or 'desc', default: 'asc')
-     */
-    sort(field: string, order?: 'asc' | 'desc'): this;
-    /**
-     * Sort in descending order (shorthand)
-     */
-    sortDesc(field: string): this;
-    /**
-     * Set page number
-     */
-    page(page: number | string): this;
-    /**
-     * Set page size
-     */
-    size(size: number): this;
-    /**
-     * Add a custom parameter
-     */
-    param(key: string, value: string | number): this;
-    /**
-     * Build the query parameters object
-     */
-    build(): QueryParams;
-    /**
-     * Build query string
-     */
-    buildQueryString(): string;
-    /**
-     * Reset the builder
-     */
-    reset(): this;
-    private isOperator;
-}

package/dist/query-builder.js

@@ -1,187 +0,0 @@
-/**
- * Query builder utility for constructing filter, pagination, and sorting parameters
- */
-export class QueryBuilder {
-    constructor() {
-        this.params = {};
-        this.filters = new Map();
-        this.sortOrder = 'asc';
-    }
-    /**
-     * Add a filter condition
-     * @param field - Field name to filter on
-     * @param operator - Filter operator (default: 'eq')
-     * @param value - Filter value
-     */
-    filter(field, operatorOrValue, value) {
-        let operator;
-        let filterValue;
-        if (value === undefined) {
-            // If only two arguments, treat first as operator/value
-            if (typeof operatorOrValue === 'string' && this.isOperator(operatorOrValue)) {
-                throw new Error('Filter operator requires a value');
-            }
-            operator = 'eq';
-            filterValue = operatorOrValue;
-        }
-        else {
-            operator = operatorOrValue;
-            filterValue = value;
-        }
-        this.filters.set(field, { operator, value: filterValue });
-        return this;
-    }
-    /**
-     * Add an equality filter (shorthand)
-     */
-    eq(field, value) {
-        return this.filter(field, 'eq', value);
-    }
-    /**
-     * Add a "not equal" filter (shorthand)
-     */
-    ne(field, value) {
-        return this.filter(field, 'ne', value);
-    }
-    /**
-     * Add a "greater than" filter (shorthand)
-     */
-    gt(field, value) {
-        return this.filter(field, 'gt', value);
-    }
-    /**
-     * Add a "greater than or equal" filter (shorthand)
-     */
-    gte(field, value) {
-        return this.filter(field, 'gte', value);
-    }
-    /**
-     * Add a "less than" filter (shorthand)
-     */
-    lt(field, value) {
-        return this.filter(field, 'lt', value);
-    }
-    /**
-     * Add a "less than or equal" filter (shorthand)
-     */
-    lte(field, value) {
-        return this.filter(field, 'lte', value);
-    }
-    /**
-     * Add an "in" filter (shorthand)
-     */
-    in(field, values) {
-        return this.filter(field, 'in', values);
-    }
-    /**
-     * Add a "contains" filter (shorthand)
-     */
-    contains(field, value) {
-        return this.filter(field, 'contains', value);
-    }
-    /**
-     * Set sort field and order
-     * @param field - Field to sort by
-     * @param order - Sort order ('asc' or 'desc', default: 'asc')
-     */
-    sort(field, order = 'asc') {
-        this.sortField = field;
-        this.sortOrder = order;
-        return this;
-    }
-    /**
-     * Sort in descending order (shorthand)
-     */
-    sortDesc(field) {
-        return this.sort(field, 'desc');
-    }
-    /**
-     * Set page number
-     */
-    page(page) {
-        this.params.page = typeof page === 'string' ? page : page.toString();
-        return this;
-    }
-    /**
-     * Set page size
-     */
-    size(size) {
-        if (size < 1) {
-            throw new Error('Page size must be at least 1');
-        }
-        if (size > 100) {
-            throw new Error('Page size cannot exceed 100');
-        }
-        this.params.size = size;
-        return this;
-    }
-    /**
-     * Add a custom parameter
-     */
-    param(key, value) {
-        this.params[key] = value;
-        return this;
-    }
-    /**
-     * Build the query parameters object
-     */
-    build() {
-        const result = { ...this.params };
-        // Add filters
-        for (const [field, { operator, value }] of this.filters.entries()) {
-            if (operator === 'eq') {
-                // Simple equality filters don't need operator notation
-                result[field] = String(value);
-            }
-            else if (operator === 'exists') {
-                // Exists operator uses special syntax
-                result[`${field}[exists]`] = String(value);
-            }
-            else {
-                // Other operators use bracket notation
-                result[`${field}[${operator}]`] = Array.isArray(value) ? value.join(',') : String(value);
-            }
-        }
-        // Add sort
-        if (this.sortField) {
-            result.sort = this.sortOrder === 'desc' ? `-${this.sortField}` : this.sortField;
-        }
-        return result;
-    }
-    /**
-     * Build query string
-     */
-    buildQueryString() {
-        const params = this.build();
-        const pairs = Object.entries(params)
-            .filter(([_, value]) => value !== undefined)
-            .map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(String(value))}`);
-        return pairs.length > 0 ? `?${pairs.join('&')}` : '';
-    }
-    /**
-     * Reset the builder
-     */
-    reset() {
-        this.params = {};
-        this.filters.clear();
-        this.sortField = undefined;
-        this.sortOrder = 'asc';
-        return this;
-    }
-    isOperator(value) {
-        return [
-            'eq',
-            'ne',
-            'gt',
-            'gte',
-            'lt',
-            'lte',
-            'in',
-            'contains',
-            'notContains',
-            'beginsWith',
-            'endsWith',
-            'exists',
-        ].includes(value);
-    }
-}

package/dist/sdk.d.ts

@@ -1,88 +0,0 @@
-/**
- * Main PI-SPI SDK class
- *
- * This is the entry point for interacting with the PI-SPI API.
- * Provides organized access to all API services.
- */
-import { handleApiError } from './error-handler';
-import type { PiSpiConfig } from './config';
-import { ComptesService } from './services/comptes';
-import { AliasService } from './services/alias';
-import { WebhooksService } from './services/webhooks';
-import { DemandesPaiementService } from './services/demandes-paiement';
-import { DemandesPaiementEnMasseService } from './services/demandes-paiement-en-masse';
-import { PaiementsService } from './services/paiements';
-import { PaiementsEnMasseService } from './services/paiements-en-masse';
-import { RetoursFondsService } from './services/retours-fonds';
-import { DemandesAnnulationService } from './services/demandes-annulation';
-export declare class PiSpiSDK {
-    /**
-     * Accounts service
-     * Handles account-related operations: balance, operations, transfers
-     */
-    readonly comptes: ComptesService;
-    /**
-     * Aliases service
-     * Handles account alias management
-     */
-    readonly alias: AliasService;
-    /**
-     * Webhooks service
-     * Handles webhook configuration and management
-     */
-    readonly webhooks: WebhooksService;
-    /**
-     * Payment requests service
-     * Handles payment request creation and management
-     */
-    readonly demandesPaiement: DemandesPaiementService;
-    /**
-     * Bulk payment requests service
-     * Handles bulk payment request operations
-     */
-    readonly demandesPaiementEnMasse: DemandesPaiementEnMasseService;
-    /**
-     * Payments service
-     * Handles immediate payment operations
-     */
-    readonly paiements: PaiementsService;
-    /**
-     * Bulk payments service
-     * Handles bulk payment operations
-     */
-    readonly paiementsEnMasse: PaiementsEnMasseService;
-    /**
-     * Fund returns service
-     * Handles fund return operations
-     */
-    readonly retoursFonds: RetoursFondsService;
-    /**
-     * Cancellation requests service
-     * Handles payment cancellation requests
-     */
-    readonly demandesAnnulation: DemandesAnnulationService;
-    /**
-     * Initialize the PI-SPI SDK
-     *
-     * @param config - SDK configuration
-     *
-     * @example
-     * ```typescript
-     * const sdk = new PiSpiSDK({
-     *   baseUrl: 'https://sandbox.api.pi-bceao.com/piz/v1',
-     *   accessToken: 'your-oauth2-token',
-     * });
-     * ```
-     */
-    constructor(config: PiSpiConfig);
-    /**
-     * Update the access token
-     * Useful when tokens are refreshed
-     */
-    setAccessToken(token: string): void;
-    /**
-     * Get the current base URL
-     */
-    getBaseUrl(): string;
-}
-export { handleApiError };