pi-spi-sdk 0.1.3 → 0.2.0

package/dist/services/alias.d.ts

@@ -1,76 +0,0 @@
-/**
- * Aliases service wrapper
- *
- * Provides methods for managing account aliases.
- *
- * @example
- * ```typescript
- * // Create a SHID alias (available for all client types)
- * const alias = await sdk.alias.create({
- *   compte: 'CIC2344256727788288822',
- *   type: AliasType.SHID
- * });
- * // Returns: { cle: '8b1b2499-3e50-435b-b757-ac7a83d8aa7f', type: 'SHID', ... }
- *
- * // Create an MCOD alias (business clients only)
- * const merchantAlias = await sdk.alias.create({
- *   compte: 'SNC2344256727788288822',
- *   type: AliasType.MCOD
- * });
- * // Returns: { cle: 'SNF00_2E4TY', type: 'MCOD', ... }
- * ```
- */
-import { BaseService } from './base';
-import type { QueryParams } from '../query-builder';
-import type { AliasType } from '../types/alias';
-export declare class AliasService extends BaseService {
-    /**
-     * Create an account alias
-     *
-     * **Alias Types:**
-     * - `SHID`: System-generated unique payment address (UUID format, 36 chars). Available for all client types (P, C, B, G)
-     * - `MCOD`: Merchant code for USSD payments. Available for business clients only (C, B, G)
-     * - `MBNO`: Mobile phone number. Available for individuals only (P)
-     *
-     * **Limits:**
-     * - Default: 20 aliases per account
-     * - Limit can be increased based on client needs
-     *
-     * @param alias - Alias creation data
-     * @param alias.compte - Account number (e.g., 'CIC2344256727788288822')
-     * @param alias.type - Alias type: 'SHID', 'MCOD', or 'MBNO'
-     * @returns Created alias with generated `cle` (key) value
-     * @throws {PiSpiError} If account not found or limit exceeded
-     *
-     * @example
-     * ```typescript
-     * // For business clients (C, B, G)
-     * await sdk.alias.create({
-     *   compte: 'SNC2344256727788288822',
-     *   type: AliasType.SHID
-     * });
-     * ```
-     */
-    create(alias: {
-        compte: string;
-        type: AliasType;
-    }): Promise<{
-        cle?: string;
-        type?: string;
-        compte?: string;
-    }>;
-    /**
-     * List aliases for an account
-     *
-     * @param compte - Account number
-     * @param params - Query parameters for pagination
-     * @returns Paginated list of aliases
-     */
-    list(compte: string, params?: QueryParams): Promise<unknown>;
-    /**
-     * Delete an alias
-     *
-     * @param alias - Alias identifier
-     */
-    delete(alias: string, compte?: string): Promise<unknown>;
-}

package/dist/services/alias.js

@@ -1,80 +0,0 @@
-"use strict";
-/**
- * Aliases service wrapper
- *
- * Provides methods for managing account aliases.
- *
- * @example
- * ```typescript
- * // Create a SHID alias (available for all client types)
- * const alias = await sdk.alias.create({
- *   compte: 'CIC2344256727788288822',
- *   type: AliasType.SHID
- * });
- * // Returns: { cle: '8b1b2499-3e50-435b-b757-ac7a83d8aa7f', type: 'SHID', ... }
- *
- * // Create an MCOD alias (business clients only)
- * const merchantAlias = await sdk.alias.create({
- *   compte: 'SNC2344256727788288822',
- *   type: AliasType.MCOD
- * });
- * // Returns: { cle: 'SNF00_2E4TY', type: 'MCOD', ... }
- * ```
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AliasService = void 0;
-const base_1 = require("./base");
-class AliasService extends base_1.BaseService {
-    /**
-     * Create an account alias
-     *
-     * **Alias Types:**
-     * - `SHID`: System-generated unique payment address (UUID format, 36 chars). Available for all client types (P, C, B, G)
-     * - `MCOD`: Merchant code for USSD payments. Available for business clients only (C, B, G)
-     * - `MBNO`: Mobile phone number. Available for individuals only (P)
-     *
-     * **Limits:**
-     * - Default: 20 aliases per account
-     * - Limit can be increased based on client needs
-     *
-     * @param alias - Alias creation data
-     * @param alias.compte - Account number (e.g., 'CIC2344256727788288822')
-     * @param alias.type - Alias type: 'SHID', 'MCOD', or 'MBNO'
-     * @returns Created alias with generated `cle` (key) value
-     * @throws {PiSpiError} If account not found or limit exceeded
-     *
-     * @example
-     * ```typescript
-     * // For business clients (C, B, G)
-     * await sdk.alias.create({
-     *   compte: 'SNC2344256727788288822',
-     *   type: AliasType.SHID
-     * });
-     * ```
-     */
-    async create(alias) {
-        return this.request('POST', `/comptes/${encodeURIComponent(alias.compte)}/alias`, { type: alias.type });
-    }
-    /**
-     * List aliases for an account
-     *
-     * @param compte - Account number
-     * @param params - Query parameters for pagination
-     * @returns Paginated list of aliases
-     */
-    async list(compte, params) {
-        return this.request('GET', `/comptes/${encodeURIComponent(compte)}/alias`, undefined, params);
-    }
-    /**
-     * Delete an alias
-     *
-     * @param alias - Alias identifier
-     */
-    async delete(alias, compte) {
-        if (!compte) {
-            throw new Error('Account number (compte) is required to delete an alias.');
-        }
-        return this.request('DELETE', `/comptes/${encodeURIComponent(compte)}/alias/${encodeURIComponent(alias)}`);
-    }
-}
-exports.AliasService = AliasService;

package/dist/services/base.d.ts

@@ -1,20 +0,0 @@
-/**
- * Base service class with common error handling and HTTP request capability
- */
-export interface ApiConfig {
-    BASE: string;
-    TOKEN?: string;
-    HEADERS?: Record<string, string>;
-}
-export declare abstract class BaseService {
-    protected config: ApiConfig;
-    constructor(config: ApiConfig);
-    /**
-     * Wrap an async operation with error handling
-     */
-    protected execute<T>(operation: () => Promise<T>): Promise<T>;
-    /**
-     * Make an HTTP request
-     */
-    protected request<T>(method: string, path: string, body?: any, params?: Record<string, any>): Promise<T>;
-}

package/dist/services/base.js

@@ -1,67 +0,0 @@
-"use strict";
-/**
- * Base service class with common error handling and HTTP request capability
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseService = void 0;
-const error_handler_1 = require("../error-handler");
-class BaseService {
-    constructor(config) {
-        this.config = config;
-    }
-    /**
-     * Wrap an async operation with error handling
-     */
-    async execute(operation) {
-        try {
-            return await operation();
-        }
-        catch (error) {
-            throw (0, error_handler_1.handleApiError)(error);
-        }
-    }
-    /**
-     * Make an HTTP request
-     */
-    async request(method, path, body, params) {
-        return this.execute(async () => {
-            const url = new URL(`${this.config.BASE}${path}`);
-            if (params) {
-                Object.entries(params).forEach(([key, value]) => {
-                    if (value !== undefined && value !== null) {
-                        url.searchParams.append(key, String(value));
-                    }
-                });
-            }
-            const headers = {
-                'Content-Type': 'application/json',
-                'Accept': 'application/json',
-                ...this.config.HEADERS,
-            };
-            if (this.config.TOKEN) {
-                headers['Authorization'] = `Bearer ${this.config.TOKEN}`;
-            }
-            const response = await fetch(url.toString(), {
-                method,
-                headers,
-                body: body ? JSON.stringify(body) : undefined,
-            });
-            if (!response.ok) {
-                // Try to parse error body
-                let errorBody;
-                try {
-                    errorBody = await response.json();
-                }
-                catch {
-                    errorBody = { status: response.status, statusText: response.statusText };
-                }
-                throw errorBody; // Will be caught by execute/handleApiError
-            }
-            if (response.status === 204) {
-                return {};
-            }
-            return (await response.json());
-        });
-    }
-}
-exports.BaseService = BaseService;

package/dist/services/comptes.d.ts

@@ -1,149 +0,0 @@
-/**
- * Accounts (Comptes) service wrapper
- *
- * Provides methods for managing accounts, viewing balances,
- * listing operations, and performing intra-account transfers.
- *
- * @example
- * ```typescript
- * // Get account balance and details
- * const account = await sdk.comptes.getAccount('CIC2344256727788288822');
- * console.log('Balance:', account.solde); // Amount in centimes
- * console.log('Status:', account.statut); // 'OUVERT', 'BLOQUE', or 'CLOTURE'
- *
- * // List operations with pagination
- * const operations = await sdk.comptes.listOperations({
- *   comptePayeur: 'CIC2344256727788288822',
- *   page: 1,
- *   size: 20
- * });
- * ```
- */
-import { BaseService } from './base';
-import type { QueryParams } from '../query-builder';
-export declare class ComptesService extends BaseService {
-    /**
-     * Get account details and balance
-     *
-     * **Returns:**
-     * - Account type (CACC, SVGS, etc.)
-     * - Account number
-     * - Current balance (`solde` in centimes)
-     * - Account status (OUVERT, BLOQUE, CLOTURE)
-     * - Opening date
-     * - Pre-confirmation indicator
-     *
-     * @param numero - Account number (e.g., 'CIC2344256727788288822')
-     * @returns Account details including balance
-     * @throws {PiSpiNotFoundError} If account not found
-     * @throws {PiSpiAuthError} If authentication fails
-     *
-     * @example
-     * ```typescript
-     * const account = await sdk.comptes.getAccount('CIC2344256727788288822');
-     * // Returns: {
-     * //   type: 'CACC',
-     * //   numero: 'CIC2344256727788288822',
-     * //   solde: 150000000, // 1,500,000 XOF in centimes
-     * //   statut: 'OUVERT',
-     * //   dateOuverture: '2023-02-21T15:30:01.250Z'
-     * // }
-     * ```
-     */
-    getAccount(numero: string): Promise<never>;
-    /**
-     * List account operations (transactions)
-     *
-     * **Filtering Options:**
-     * - Filter by account number (`comptePayeur`, `comptePaye`)
-     * - Filter by status (`statut`: INITIE, ENVOYE, IRREVOCABLE, REJETE)
-     * - Filter by dates (`dateEnvoi`, `dateIrrevocabilite`)
-     * - Use QueryBuilder for advanced filtering
-     *
-     * @param params - Query parameters for filtering and pagination
-     * @param params.comptePayeur - Filter by payer account number
-     * @param params.comptePaye - Filter by payee account number
-     * @param params.statut - Filter by transaction status
-     * @param params.dateEnvoi - Filter by send date
-     * @param params.dateIrrevocabilite - Filter by irrevocability date
-     * @param params.page - Page number (default: 1)
-     * @param params.size - Page size (default: 20, max: 100)
-     * @returns Paginated list of operations
-     *
-     * @example
-     * ```typescript
-     * // List all operations for an account
-     * const operations = await sdk.comptes.listOperations({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   page: 1,
-     *   size: 20
-     * });
-     *
-     * // Filter by status
-     * const completed = await sdk.comptes.listOperations({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   statut: 'IRREVOCABLE'
-     * });
-     * ```
-     */
-    listOperations(params?: QueryParams & {
-        comptePayeur?: string;
-        comptePaye?: string;
-        statut?: string;
-        dateEnvoi?: string;
-        dateIrrevocabilite?: string;
-    }): Promise<never>;
-    /**
-     * Transfer funds between accounts owned by the same client
-     *
-     * **Intra-Account Transfer:**
-     * - Transfers between accounts owned by the same legal entity
-     * - Accounts must be at the same financial institution
-     * - Can use account numbers or aliases
-     *
-     * **Transfer Methods:**
-     * - Using account numbers: `comptePayeur` and `comptePaye`
-     * - Using aliases: `payeurAlias` and `payeAlias`
-     *
-     * @param transfer - Transfer request details
-     * @param transfer.comptePayeur - Payer account number (if using account numbers)
-     * @param transfer.comptePaye - Payee account number (if using account numbers)
-     * @param transfer.payeurAlias - Payer alias (if using aliases)
-     * @param transfer.payeAlias - Payee alias (if using aliases)
-     * @param transfer.montant - Amount in centimes (e.g., 150000 = 1,500 XOF)
-     * @param transfer.motif - Transfer reason/description
-     * @param transfer.txId - Unique transaction ID (optional, auto-generated if not provided)
-     * @returns Transfer response with status
-     * @throws {PiSpiValidationError} If transfer fails validation
-     * @throws {PiSpiError} If account blocked or insufficient funds
-     *
-     * @example
-     * ```typescript
-     * // Transfer using account numbers
-     * await sdk.comptes.transfer({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   comptePaye: 'SNC2344256727788288822',
-     *   montant: 150000, // 1,500 XOF
-     *   motif: 'Transfert de fonds',
-     *   txId: '23511722'
-     * });
-     *
-     * // Transfer using aliases
-     * await sdk.comptes.transfer({
-     *   payeurAlias: '8b1b2499-3e50-435b-b757-ac7a83d8aa7f',
-     *   payeAlias: '4r5ty499-3e50-435b-b757-ac7a83d67juio',
-     *   montant: 150000,
-     *   motif: 'Transfert entre comptes'
-     * });
-     * ```
-     */
-    transfer(transfer: {
-        comptePayeur?: string;
-        comptePaye?: string;
-        payeurAlias?: string;
-        payeAlias?: string;
-        montant: number;
-        motif?: string;
-        txId?: string;
-    }): Promise<never>;
-}

package/dist/services/comptes.js

@@ -1,162 +0,0 @@
-"use strict";
-/**
- * Accounts (Comptes) service wrapper
- *
- * Provides methods for managing accounts, viewing balances,
- * listing operations, and performing intra-account transfers.
- *
- * @example
- * ```typescript
- * // Get account balance and details
- * const account = await sdk.comptes.getAccount('CIC2344256727788288822');
- * console.log('Balance:', account.solde); // Amount in centimes
- * console.log('Status:', account.statut); // 'OUVERT', 'BLOQUE', or 'CLOTURE'
- *
- * // List operations with pagination
- * const operations = await sdk.comptes.listOperations({
- *   comptePayeur: 'CIC2344256727788288822',
- *   page: 1,
- *   size: 20
- * });
- * ```
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ComptesService = void 0;
-const base_1 = require("./base");
-// Import generated types and services
-// These will be available after running the generate script
-// import { CompteSolde, CompteTransfertIntraRequest, CompteTransfertIntraReponse } from '../generated';
-// import { DefaultService } from '../generated/services/DefaultService';
-class ComptesService extends base_1.BaseService {
-    /**
-     * Get account details and balance
-     *
-     * **Returns:**
-     * - Account type (CACC, SVGS, etc.)
-     * - Account number
-     * - Current balance (`solde` in centimes)
-     * - Account status (OUVERT, BLOQUE, CLOTURE)
-     * - Opening date
-     * - Pre-confirmation indicator
-     *
-     * @param numero - Account number (e.g., 'CIC2344256727788288822')
-     * @returns Account details including balance
-     * @throws {PiSpiNotFoundError} If account not found
-     * @throws {PiSpiAuthError} If authentication fails
-     *
-     * @example
-     * ```typescript
-     * const account = await sdk.comptes.getAccount('CIC2344256727788288822');
-     * // Returns: {
-     * //   type: 'CACC',
-     * //   numero: 'CIC2344256727788288822',
-     * //   solde: 150000000, // 1,500,000 XOF in centimes
-     * //   statut: 'OUVERT',
-     * //   dateOuverture: '2023-02-21T15:30:01.250Z'
-     * // }
-     * ```
-     */
-    async getAccount(numero) {
-        return this.execute(async () => {
-            // This will call the generated service after codegen
-            // return await DefaultService.compteSoldeConsulter({ numero });
-            throw new Error('Service not yet generated. Run "pnpm run generate" first.');
-        });
-    }
-    /**
-     * List account operations (transactions)
-     *
-     * **Filtering Options:**
-     * - Filter by account number (`comptePayeur`, `comptePaye`)
-     * - Filter by status (`statut`: INITIE, ENVOYE, IRREVOCABLE, REJETE)
-     * - Filter by dates (`dateEnvoi`, `dateIrrevocabilite`)
-     * - Use QueryBuilder for advanced filtering
-     *
-     * @param params - Query parameters for filtering and pagination
-     * @param params.comptePayeur - Filter by payer account number
-     * @param params.comptePaye - Filter by payee account number
-     * @param params.statut - Filter by transaction status
-     * @param params.dateEnvoi - Filter by send date
-     * @param params.dateIrrevocabilite - Filter by irrevocability date
-     * @param params.page - Page number (default: 1)
-     * @param params.size - Page size (default: 20, max: 100)
-     * @returns Paginated list of operations
-     *
-     * @example
-     * ```typescript
-     * // List all operations for an account
-     * const operations = await sdk.comptes.listOperations({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   page: 1,
-     *   size: 20
-     * });
-     *
-     * // Filter by status
-     * const completed = await sdk.comptes.listOperations({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   statut: 'IRREVOCABLE'
-     * });
-     * ```
-     */
-    async listOperations(params) {
-        return this.execute(async () => {
-            // This will call the generated service after codegen
-            // return await DefaultService.compteTransfertIntraLister(params);
-            throw new Error('Service not yet generated. Run "pnpm run generate" first.');
-        });
-    }
-    /**
-     * Transfer funds between accounts owned by the same client
-     *
-     * **Intra-Account Transfer:**
-     * - Transfers between accounts owned by the same legal entity
-     * - Accounts must be at the same financial institution
-     * - Can use account numbers or aliases
-     *
-     * **Transfer Methods:**
-     * - Using account numbers: `comptePayeur` and `comptePaye`
-     * - Using aliases: `payeurAlias` and `payeAlias`
-     *
-     * @param transfer - Transfer request details
-     * @param transfer.comptePayeur - Payer account number (if using account numbers)
-     * @param transfer.comptePaye - Payee account number (if using account numbers)
-     * @param transfer.payeurAlias - Payer alias (if using aliases)
-     * @param transfer.payeAlias - Payee alias (if using aliases)
-     * @param transfer.montant - Amount in centimes (e.g., 150000 = 1,500 XOF)
-     * @param transfer.motif - Transfer reason/description
-     * @param transfer.txId - Unique transaction ID (optional, auto-generated if not provided)
-     * @returns Transfer response with status
-     * @throws {PiSpiValidationError} If transfer fails validation
-     * @throws {PiSpiError} If account blocked or insufficient funds
-     *
-     * @example
-     * ```typescript
-     * // Transfer using account numbers
-     * await sdk.comptes.transfer({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   comptePaye: 'SNC2344256727788288822',
-     *   montant: 150000, // 1,500 XOF
-     *   motif: 'Transfert de fonds',
-     *   txId: '23511722'
-     * });
-     *
-     * // Transfer using aliases
-     * await sdk.comptes.transfer({
-     *   payeurAlias: '8b1b2499-3e50-435b-b757-ac7a83d8aa7f',
-     *   payeAlias: '4r5ty499-3e50-435b-b757-ac7a83d67juio',
-     *   montant: 150000,
-     *   motif: 'Transfert entre comptes'
-     * });
-     * ```
-     */
-    async transfer(transfer) {
-        return this.execute(async () => {
-            // This will call the generated service after codegen
-            // return await DefaultService.compteTransfertIntraCreer({
-            //   requestBody: transfer
-            // });
-            throw new Error('Service not yet generated. Run "pnpm run generate" first.');
-        });
-    }
-}
-exports.ComptesService = ComptesService;

package/dist/services/demandes-annulation.d.ts

@@ -1,97 +0,0 @@
-/**
- * Cancellation Requests (Demandes d'Annulation) service wrapper
- *
- * Provides methods for requesting cancellation of sent payments.
- *
- * **Cancellation Rules:**
- * - Can only request cancellation of payments sent by the business
- * - Must be requested within 90 days of original payment
- * - Payee must accept the cancellation for funds to be returned
- * - Payee can reject the cancellation request
- * - Multiple cancellation requests can be sent for the same payment
- *
- * **Cancellation Flow:**
- * 1. Business requests cancellation of a sent payment
- * 2. Payee receives cancellation request
- * 3. Payee can accept (triggers fund return) or reject
- * 4. Business receives notification of payee's decision
- *
- * **Use Cases:**
- * - Payment sent to wrong recipient
- * - Duplicate payment
- * - Service cancellation
- * - Agreement cancellation
- *
- * @example
- * ```typescript
- * // Request cancellation of a sent payment
- * const cancellation = await sdk.demandesAnnulation.create({
- *   comptePayeur: 'CIC2344256727788288822',
- *   txId: '23552722', // Original payment transaction ID
- *   motif: 'CUST' // Cancellation reason code
- * });
- * ```
- */
-import { BaseService } from './base';
-import type { QueryParams } from '../query-builder';
-export declare class DemandesAnnulationService extends BaseService {
-    /**
-     * Create a cancellation request
-     *
-     * **Cancellation Process:**
-     * 1. Business identifies payment to cancel
-     * 2. Creates cancellation request (must be within 90 days)
-     * 3. Payee receives cancellation request
-     * 4. Payee accepts or rejects
-     * 5. If accepted, funds are returned via fund return mechanism
-     *
-     * **Status Values:**
-     * - `INITIE`: Cancellation request sent, awaiting payee response
-     * - `ACCEPTE`: Payee accepted cancellation (funds returned)
-     * - `REJETE`: Payee rejected cancellation request
-     *
-     * **Rejection Reasons:**
-     * - `CUST`: Customer rejection (payee refuses cancellation)
-     * - `AM09`: Wrong amount
-     * - `AC06`: Blocked account
-     * - `FR01`: Fraud suspicion
-     *
-     * @param request - Cancellation request data
-     * @param request.comptePayeur - Business account number (original payer)
-     * @param request.txId - Original payment transaction ID to cancel
-     * @param request.motif - Cancellation reason code (e.g., 'CUST' for customer request)
-     * @returns Cancellation request response
-     * @throws {PiSpiValidationError} If cancellation fails validation (e.g., > 90 days, invalid txId)
-     * @throws {PiSpiNotFoundError} If payment not found
-     *
-     * @example
-     * ```typescript
-     * // Request cancellation
-     * await sdk.demandesAnnulation.create({
-     *   comptePayeur: 'CIC2344256727788288822',
-     *   txId: '23552722', // Payment to cancel
-     *   motif: 'CUST' // Customer request
-     * });
-     * ```
-     */
-    create(request: {
-        comptePayeur: string;
-        txId: string;
-        motif: string;
-    }): Promise<never>;
-    /**
-     * Get cancellation request details by transaction ID
-     *
-     * @param id - Cancellation request transaction ID
-     * @returns Cancellation request details
-     * @throws {PiSpiNotFoundError} If cancellation request not found
-     */
-    get(id: string): Promise<never>;
-    /**
-     * List cancellation requests with filtering and pagination
-     *
-     * @param params - Query parameters for filtering and pagination
-     * @returns Paginated list of cancellation requests
-     */
-    list(params?: QueryParams): Promise<never>;
-}