monime-package 1.0.8 → 1.1.0

package/README.md

@@ -70,6 +70,7 @@ Recommended to store credentials in `.env`:
 ```bash
 MONIME_SPACE_ID=space_XXXXXXXX
 MONIME_ACCESS_TOKEN=sk_live_xxx
+MONIME_VERSION=caph.2025-08-23 # Optional, defaults to latest
 ```
 
 You can also pass credentials directly when creating the client.
@@ -86,6 +87,7 @@ import { createClient } from "monime-package";
 const client = createClient({
   monimeSpaceId: process.env.MONIME_SPACE_ID!,
   accessToken: process.env.MONIME_ACCESS_TOKEN!,
+  monimeVersion: "caph.2025-08-23", // Optional
 });
 ```
 
@@ -117,6 +119,72 @@ type Result<T> = {
 
 The client exposes namespaced APIs under `client.<module>`. Below is the complete API reference:
 
+### Payments (New)
+
+Manage all incoming payments (payins).
+
+```ts
+// Get payment details
+client.payment.get(paymentId: string): Promise<Result<GetPayment>>
+
+// List payments
+client.payment.getAll(params?: any): Promise<Result<ListPayments>>
+
+// Patch payment
+client.payment.patch(paymentId: string, body: any): Promise<Result<PatchPayment>>
+```
+
+### Webhooks (New)
+
+Manage webhooks for real-time notifications.
+
+```ts
+// Create webhook
+client.webhook.create(body: CreateWebhookRequest): Promise<Result<CreateWebhookResponse>>
+
+// Get webhook
+client.webhook.get(webhookId: string): Promise<Result<GetWebhookResponse>>
+
+// List webhooks
+client.webhook.getAll(): Promise<Result<ListWebhooksResponse>>
+
+// Update webhook
+client.webhook.update(webhookId: string, body: UpdateWebhookRequest): Promise<Result<UpdateWebhookResponse>>
+
+// Delete webhook
+client.webhook.delete(webhookId: string): Promise<{ success: boolean; error?: Error }>
+```
+
+### Receipts (New)
+
+Manage payment receipts.
+
+```ts
+// Get receipt
+client.receipt.get(orderNumber: string): Promise<Result<GetReceiptResponse>>
+
+// Redeem receipt
+client.receipt.redeem(orderNumber: string, body: any): Promise<Result<RedeemReceiptResponse>>
+```
+
+### USSD OTPs (New)
+
+Generate USSD OTPs.
+
+```ts
+// Create USSD OTP
+client.ussdOtp.create(body: CreateUssdOtpRequest): Promise<Result<CreateUssdOtpResponse>>
+```
+
+### Provider KYC (New)
+
+Get provider KYC details.
+
+```ts
+// Get provider KYC
+client.providerKyc.get(providerId: string): Promise<Result<GetProviderKycResponse>>
+```
+
 ### Financial Accounts
 
 Manage digital wallets and financial accounts.
@@ -387,6 +455,7 @@ The client accepts the following options (see `src/client.ts`):
 type ClientOptions = {
   monimeSpaceId: string; // Your Monime Space ID
   accessToken: string;   // Your Monime API token
+  monimeVersion?: "caph.2025-08-23" | "caph.2025-06-20"; // API Version
 };
 ```
 

package/dist/index.d.mts

@@ -1,3 +1,9 @@
+interface ClientConfig {
+    monimeSpaceId: string;
+    accessToken: string;
+    monimeVersion?: string | undefined;
+}
+
 interface AllCheckout {
     success: boolean;
     messages: string[];
@@ -166,7 +172,7 @@ interface Price {
     value: number;
 }
 
-declare function CheckoutSessionAPI(client: MonimeClient): {
+declare function CheckoutSessionAPI(config: ClientConfig): {
     create: (name: string, amount: number, quantity: number, successUrl: string, cancelUrl: string, description?: string, financialAccountId?: string, primaryColor?: string, images?: string[]) => Promise<{
         success: boolean;
         error?: Error;
@@ -753,9 +759,166 @@ interface Amount$1 {
     value: number;
 }
 
+interface Payment {
+    id: string;
+    status: "pending" | "processing" | "completed" | "failed";
+    amount: {
+        currency: string;
+        value: number;
+    };
+    channel: {
+        type: "bank" | "card" | "momo" | "wallet";
+    };
+    name: string | null;
+    reference: string | null;
+    orderNumber: string | null;
+    financialAccountId: string | null;
+    financialTransactionReference: string | null;
+    fees: Array<{
+        code: string;
+        amount: {
+            currency: string;
+            value: number;
+        };
+    }>;
+    createTime: string;
+    updateTime: string;
+    ownershipGraph: {
+        owner: {
+            id: string;
+            type: string;
+            metadata: Record<string, any> | null;
+        };
+    };
+    metadata: Record<string, any> | null;
+}
+interface GetPayment {
+    success: boolean;
+    messages: string[];
+    result: Payment;
+}
+interface ListPayments {
+    success: boolean;
+    messages: string[];
+    result: Payment[];
+    pagination: {
+        next: string | null;
+    };
+}
+interface PatchPayment {
+    success: boolean;
+    messages: string[];
+    result: Payment;
+}
+
+interface WebhookVerificationMethod {
+    type: "HS256" | "ES256";
+    secret: string;
+}
+interface Webhook {
+    id: string;
+    name: string;
+    url: string;
+    enabled: boolean;
+    events: string[];
+    apiRelease: string;
+    verificationMethod: WebhookVerificationMethod;
+    headers: Record<string, string>;
+    alertEmails: string[];
+    createTime: string;
+    updateTime: string;
+    metadata: Record<string, any>;
+}
+interface CreateWebhookRequest {
+    name: string;
+    url: string;
+    events: string[];
+    enabled?: boolean;
+    apiRelease?: string;
+    headers?: Record<string, string>;
+    alertEmails?: string[];
+    verificationMethod?: WebhookVerificationMethod;
+    metadata?: Record<string, any>;
+}
+interface CreateWebhookResponse {
+    success: boolean;
+    messages: string[];
+    result: Webhook;
+}
+interface GetWebhookResponse {
+    success: boolean;
+    messages: string[];
+    result: Webhook;
+}
+interface ListWebhooksResponse {
+    success: boolean;
+    messages: string[];
+    result: Webhook[];
+    pagination?: {
+        next: string | null;
+    };
+}
+interface UpdateWebhookRequest {
+    name?: string;
+    url?: string;
+    events?: string[];
+    enabled?: boolean;
+    headers?: Record<string, string>;
+    alertEmails?: string[];
+    verificationMethod?: WebhookVerificationMethod;
+    metadata?: Record<string, any>;
+}
+interface UpdateWebhookResponse {
+    success: boolean;
+    messages: string[];
+    result: Webhook;
+}
+
+interface Receipt {
+    orderNumber: string;
+    [key: string]: any;
+}
+interface GetReceiptResponse {
+    success: boolean;
+    messages: string[];
+    result: Receipt;
+}
+interface RedeemReceiptResponse {
+    success: boolean;
+    messages: string[];
+    result: Receipt;
+}
+
+interface UssdOtp {
+    id: string;
+    phoneNumber: string;
+    otp: string;
+    expiresAt: string;
+    [key: string]: any;
+}
+interface CreateUssdOtpRequest {
+    phoneNumber: string;
+    [key: string]: any;
+}
+interface CreateUssdOtpResponse {
+    success: boolean;
+    messages: string[];
+    result: UssdOtp;
+}
+
+interface ProviderKyc {
+    providerId: string;
+    [key: string]: any;
+}
+interface GetProviderKycResponse {
+    success: boolean;
+    messages: string[];
+    result: ProviderKyc;
+}
+
 type Currency = "USD" | "SLE";
 
-declare function FinancialAccountAPI(client: MonimeClient): {
+declare function FinancialAccountAPI(config: ClientConfig): {
     create: (name: string, currency: Currency) => Promise<{
         success: boolean;
         data?: CreateFinancialAccount;
@@ -871,7 +1034,7 @@ interface Amount {
     value: number;
 }
 
-declare function FinancialTransactionAPI(client: MonimeClient): {
+declare function FinancialTransactionAPI(config: ClientConfig): {
     get: (transactionId: string) => Promise<{
         success: boolean;
         error?: Error;
@@ -884,7 +1047,7 @@ declare function FinancialTransactionAPI(client: MonimeClient): {
     }>;
 };
 
-declare function InternalTransferAPI(client: MonimeClient): {
+declare function InternalTransferAPI(config: ClientConfig): {
     create: (sourceAccount: string, destinationAccount: string, amount: number) => Promise<{
         success: boolean;
         data?: CreateInternalTransfer;
@@ -906,7 +1069,25 @@ declare function InternalTransferAPI(client: MonimeClient): {
     }>;
 };
 
-declare function PaymentCodeAPI(client: MonimeClient): {
+declare function PaymentAPI(config: ClientConfig): {
+    get: (paymentId: string) => Promise<{
+        success: boolean;
+        data?: GetPayment;
+        error?: Error;
+    }>;
+    getAll: (params?: Record<string, any>) => Promise<{
+        success: boolean;
+        data?: ListPayments;
+        error?: Error;
+    }>;
+    patch: (paymentId: string, body: Record<string, any>) => Promise<{
+        success: boolean;
+        data?: PatchPayment;
+        error?: Error;
+    }>;
+};
+
+declare function PaymentCodeAPI(config: ClientConfig): {
     create: (paymentName: string, amount: number, financialAccount: string, username: string, phoneNumber: string) => Promise<{
         success: boolean;
         data?: CreatePaymentCode;
@@ -928,7 +1109,7 @@ declare function PaymentCodeAPI(client: MonimeClient): {
     }>;
 };
 
-declare function PayoutAPI(client: MonimeClient): {
+declare function PayoutAPI(config: ClientConfig): {
     create: (amount: number, destination: DestinationOption, sourceAccount: string) => Promise<{
         success: boolean;
         data?: CreatePayout;
@@ -950,26 +1131,85 @@ declare function PayoutAPI(client: MonimeClient): {
     }>;
 };
 
+declare function ProviderKycAPI(config: ClientConfig): {
+    get: (providerId: string) => Promise<{
+        success: boolean;
+        data?: GetProviderKycResponse;
+        error?: Error;
+    }>;
+};
+
+declare function ReceiptAPI(config: ClientConfig): {
+    get: (orderNumber: string) => Promise<{
+        success: boolean;
+        data?: GetReceiptResponse;
+        error?: Error;
+    }>;
+    redeem: (orderNumber: string, body?: Record<string, any>) => Promise<{
+        success: boolean;
+        data?: RedeemReceiptResponse;
+        error?: Error;
+    }>;
+};
+
+declare function UssdOtpAPI(config: ClientConfig): {
+    create: (body: CreateUssdOtpRequest) => Promise<{
+        success: boolean;
+        data?: CreateUssdOtpResponse;
+        error?: Error;
+    }>;
+};
+
+declare function WebhookAPI(config: ClientConfig): {
+    create: (body: CreateWebhookRequest) => Promise<{
+        success: boolean;
+        data?: CreateWebhookResponse;
+        error?: Error;
+    }>;
+    get: (webhookId: string) => Promise<{
+        success: boolean;
+        data?: GetWebhookResponse;
+        error?: Error;
+    }>;
+    getAll: () => Promise<{
+        success: boolean;
+        data?: ListWebhooksResponse;
+        error?: Error;
+    }>;
+    update: (webhookId: string, body: UpdateWebhookRequest) => Promise<{
+        success: boolean;
+        data?: UpdateWebhookResponse;
+        error?: Error;
+    }>;
+    delete: (webhookId: string) => Promise<{
+        success: boolean;
+        error?: Error;
+    }>;
+};
+
 interface ClientOptions {
     monimeSpaceId: string;
     accessToken: string;
+    monimeVersion?: "caph.2025-08-23" | "caph.2025-06-20";
 }
 declare class MonimeClient {
     private monimeSpaceId;
     private accessToken;
+    private monimeVersion?;
     financialAccount: ReturnType<typeof FinancialAccountAPI>;
     internalTransfer: ReturnType<typeof InternalTransferAPI>;
     paymentCode: ReturnType<typeof PaymentCodeAPI>;
+    payment: ReturnType<typeof PaymentAPI>;
     payout: ReturnType<typeof PayoutAPI>;
+    providerKyc: ReturnType<typeof ProviderKycAPI>;
+    receipt: ReturnType<typeof ReceiptAPI>;
+    ussdOtp: ReturnType<typeof UssdOtpAPI>;
+    webhook: ReturnType<typeof WebhookAPI>;
     financialTransaction: ReturnType<typeof FinancialTransactionAPI>;
     checkoutSession: ReturnType<typeof CheckoutSessionAPI>;
     constructor(options: ClientOptions);
-    _getConfig(): {
-        monimeSpaceId: string;
-        accessToken: string;
-    };
 }
 
 declare function createClient(options: ClientOptions): MonimeClient;
 
-export { type AllFinancialAccount, type AllInternalTransfers, type ClientOptions, type CreateFinancialAccount, type CreateInternalTransfer, type CreatePaymentCode, type CreatePayout, type DestinationOption, type GetAll, type GetAllPaymentCode, type GetFinancialAccount, type GetOne, type GetOnePayout, type InternalTransfer, MonimeClient, createClient };
+export { type AllFinancialAccount, type AllInternalTransfers, type ClientOptions, type CreateFinancialAccount, type CreateInternalTransfer, type CreatePaymentCode, type CreatePayout, type CreateUssdOtpRequest, type CreateUssdOtpResponse, type CreateWebhookRequest, type CreateWebhookResponse, type DestinationOption, type GetAll, type GetAllPaymentCode, type GetFinancialAccount, type GetOne, type GetOnePayout, type GetPayment, type GetProviderKycResponse, type GetReceiptResponse, type GetWebhookResponse, type InternalTransfer, type ListPayments, type ListWebhooksResponse, MonimeClient, type PatchPayment, type Payment, type ProviderKyc, type Receipt, type RedeemReceiptResponse, type UpdateWebhookRequest, type UpdateWebhookResponse, type UssdOtp, type Webhook, type WebhookVerificationMethod, createClient };