monime-package 1.1.3 → 1.1.4

package/dist/index.d.mts

@@ -1,3 +1,16 @@
+declare class MonimeError extends Error {
+    readonly status?: number;
+    readonly requestId?: string;
+    readonly details?: unknown;
+    constructor(message: string, status?: number, requestId?: string, details?: unknown);
+}
+declare class MonimeAuthenticationError extends MonimeError {
+    constructor(message?: string);
+}
+declare class MonimeValidationError extends MonimeError {
+    constructor(message: string, details?: unknown);
+}
+
 interface ClientConfig {
     monimeSpaceId: string;
     accessToken: string;
@@ -10,10 +23,10 @@ interface Pagination {
 interface Result<T> {
     data?: T;
     success: boolean;
-    error?: Error;
+    error?: Error | MonimeError;
 }
 
-interface AllCheckout {
+interface ListCheckoutsResponse {
     result: CheckoutSession[];
     Pagination: Pagination;
 }
@@ -34,7 +47,7 @@ interface CheckoutSession {
     createTime: string;
     ownershipGraph: OwnershipGraph$4;
 }
-interface OneCheckout {
+interface RetrieveCheckoutResponse {
     id: string;
     status: string;
     name: string;
@@ -51,7 +64,7 @@ interface OneCheckout {
     createTime: string;
     ownershipGraph: OwnershipGraph$4;
 }
-interface CreateCheckout {
+interface CreateCheckoutResponse {
     id: string;
     status: string;
     name: string;
@@ -165,14 +178,7 @@ interface Price {
     value: number;
 }
 
-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<Result<CreateCheckout>>;
-    get: () => Promise<Result<AllCheckout>>;
-    getOne: (checkoutId: string) => Promise<Result<OneCheckout>>;
-    delete: (checkoutId: string) => Promise<Result<OneCheckout>>;
-};
-
-interface CreateFinancialAccount {
+interface CreateFinancialAccountResponse {
     id: string;
     uvan: string;
     name: string;
@@ -183,7 +189,7 @@ interface CreateFinancialAccount {
     createTime: string;
     updateTime: string;
 }
-interface GetFinancialAccount {
+interface RetrieveFinancialAccountResponse {
     id: string;
     uvan: string;
     name: string;
@@ -194,7 +200,7 @@ interface GetFinancialAccount {
     createTime: string;
     updateTime: string;
 }
-interface AllFinancialAccount {
+interface ListFinancialAccountsResponse {
     result: FinancialAccount$1[];
     pagination: Pagination;
 }
@@ -231,67 +237,7 @@ interface Available {
     value: number;
 }
 
-interface BankFeature {
-    canPayTo?: boolean;
-    canPayFrom?: boolean;
-    canVerifyAccount?: boolean;
-    schemes?: string[];
-    metadata: Record<string, unknown>;
-}
-interface BankFeatureSet {
-    payout: BankFeature;
-    payment: BankFeature;
-    kycVerification: BankFeature;
-}
-interface Bank {
-    providerId: string;
-    name: string;
-    country: string;
-    status: {
-        active: boolean;
-    };
-    featureSet: BankFeatureSet;
-    createTime: string;
-    updateTime: string;
-}
-interface ListBanksResponse {
-    result: Bank[];
-    pagination: Pagination;
-}
-interface GetBankResponse extends Bank {
-}
-
-interface MomoFeature {
-    canPayTo?: boolean;
-    canPayFrom?: boolean;
-    canVerifyAccount?: boolean;
-    schemes?: string[];
-    metadata: Record<string, unknown>;
-}
-interface MomoFeatureSet {
-    payout: MomoFeature;
-    payment: MomoFeature;
-    kycVerification: MomoFeature;
-}
-interface Momo {
-    providerId: string;
-    name: string;
-    country: string;
-    status: {
-        active: boolean;
-    };
-    featureSet: MomoFeatureSet;
-    createTime: string;
-    updateTime: string;
-}
-interface ListMomosResponse {
-    result: Momo[];
-    pagination: Pagination;
-}
-interface GetMomoResponse extends Momo {
-}
-
-interface GetTransaction {
+interface RetrieveTransactionResponse {
     id: string;
     type: string;
     amount: Amount$3;
@@ -302,7 +248,7 @@ interface GetTransaction {
     originatingFee: OriginatingFee;
     ownershipGraph: OwnershipGraph$3;
 }
-interface AllTransaction {
+interface ListTransactionsResponse {
     result: Transaction[];
     pagination: Pagination;
 }
@@ -378,7 +324,7 @@ interface Amount$3 {
     value: number;
 }
 
-interface CreateInternalTransfer {
+interface CreateInternalTransferResponse {
     id: string;
     status: string;
     amount: Amount$2;
@@ -391,7 +337,7 @@ interface CreateInternalTransfer {
     createTime: string;
     updateTime: string;
 }
-interface AllInternalTransfers {
+interface ListInternalTransfersResponse {
     result: Transfer[];
     pagination: Pagination;
 }
@@ -408,7 +354,7 @@ interface Transfer {
     createTime: string;
     updateTime: string;
 }
-interface InternalTransfer {
+interface RetrieveInternalTransferResponse {
     id: string;
     status: string;
     amount: Amount$2;
@@ -524,16 +470,16 @@ interface Payment {
     };
     metadata: Record<string, unknown> | null;
 }
-interface GetPayment extends Payment {
+interface RetrievePaymentResponse extends Payment {
 }
-interface ListPayments {
+interface ListPaymentsResponse {
     result: Payment[];
     pagination: Pagination;
 }
-interface PatchPayment extends Payment {
+interface UpdatePaymentResponse extends Payment {
 }
 
-interface CreatePaymentCode {
+interface CreatePaymentCodeResponse {
     id: string;
     mode: string;
     status: string;
@@ -564,7 +510,7 @@ interface CreatePaymentCode {
     updateTime: string;
     ownershipGraph: OwnershipGraph$1;
 }
-interface GetAllPaymentCode {
+interface ListPaymentCodesResponse {
     result: PaymentCode[];
     pagination: Pagination;
 }
@@ -588,7 +534,7 @@ interface PaymentCode {
     updateTime: string;
     ownershipGraph: OwnershipGraph$1;
 }
-interface GetOne {
+interface RetrievePaymentCodeResponse {
     id: string;
     mode: string;
     status: string;
@@ -719,7 +665,7 @@ type DestinationOption = {
     providerId: "w01" | "w02";
     walletId: string;
 };
-interface CreatePayout {
+interface CreatePayoutResponse {
     id: string;
     status: string;
     amount: Amount;
@@ -731,7 +677,7 @@ interface CreatePayout {
     updateTime: string;
     ownershipGraph: OwnershipGraph;
 }
-interface GetAll {
+interface ListPayoutsResponse {
     result: Payout[];
     pagination: Pagination;
 }
@@ -747,7 +693,7 @@ interface Payout {
     updateTime: string;
     ownershipGraph: OwnershipGraph;
 }
-interface GetOnePayout {
+interface RetrievePayoutResponse {
     id: string;
     status: string;
     amount: Amount;
@@ -942,104 +888,199 @@ interface UpdateWebhookRequest {
 interface UpdateWebhookResponse extends Webhook {
 }
 
-type Currency = "USD" | "SLE";
+interface BankFeature {
+    canPayTo?: boolean;
+    canPayFrom?: boolean;
+    canVerifyAccount?: boolean;
+    schemes?: string[];
+    metadata: Record<string, unknown>;
+}
+interface BankFeatureSet {
+    payout: BankFeature;
+    payment: BankFeature;
+    kycVerification: BankFeature;
+}
+interface Bank {
+    providerId: string;
+    name: string;
+    country: string;
+    status: {
+        active: boolean;
+    };
+    featureSet: BankFeatureSet;
+    createTime: string;
+    updateTime: string;
+}
+interface ListBanksResponse {
+    result: Bank[];
+    pagination: Pagination;
+}
+interface RetrieveBankResponse extends Bank {
+}
 
-declare function FinancialAccountAPI(config: ClientConfig): {
-    create: (name: string, currency: Currency) => Promise<Result<CreateFinancialAccount>>;
-    get: (financialAccountId: string) => Promise<Result<GetFinancialAccount>>;
-    getAll: () => Promise<Result<AllFinancialAccount>>;
-};
+interface MomoFeature {
+    canPayTo?: boolean;
+    canPayFrom?: boolean;
+    canVerifyAccount?: boolean;
+    schemes?: string[];
+    metadata: Record<string, unknown>;
+}
+interface MomoFeatureSet {
+    payout: MomoFeature;
+    payment: MomoFeature;
+    kycVerification: MomoFeature;
+}
+interface Momo {
+    providerId: string;
+    name: string;
+    country: string;
+    status: {
+        active: boolean;
+    };
+    featureSet: MomoFeatureSet;
+    createTime: string;
+    updateTime: string;
+}
+interface ListMomosResponse {
+    result: Momo[];
+    pagination: Pagination;
+}
+interface RetrieveMomoResponse extends Momo {
+}
 
-declare function BankAPI(config: ClientConfig): {
-    get: (providerId: string) => Promise<Result<GetBankResponse>>;
-    getAll: (params?: Record<string, unknown>) => Promise<Result<ListBanksResponse>>;
-};
+interface RequestOptions {
+    path: string;
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    body?: unknown;
+    idempotencyKey?: string;
+}
+declare class HttpClient {
+    private readonly baseUrl;
+    protected readonly config: ClientConfig;
+    constructor(config: ClientConfig);
+    private getHeaders;
+    protected request<T>(options: RequestOptions): Promise<Result<T>>;
+}
 
-declare function MomoAPI(config: ClientConfig): {
-    get: (providerId: string) => Promise<Result<GetMomoResponse>>;
-    getAll: (params?: Record<string, unknown>) => Promise<Result<ListMomosResponse>>;
-};
+declare class CheckoutSessionAPI extends HttpClient {
+    private readonly path;
+    create(name: string, amount: number, quantity: number, successUrl: string, cancelUrl: string, options?: {
+        description?: string;
+        financialAccountId?: string;
+        primaryColor?: string;
+        images?: string[];
+    }): Promise<Result<CreateCheckoutResponse>>;
+    list(): Promise<Result<ListCheckoutsResponse>>;
+    retrieve(checkoutId: string): Promise<Result<RetrieveCheckoutResponse>>;
+    delete(checkoutId: string): Promise<Result<void>>;
+}
 
-declare function FinancialTransactionAPI(config: ClientConfig): {
-    get: (transactionId: string) => Promise<Result<GetTransaction>>;
-    getAll: () => Promise<Result<AllTransaction>>;
-};
+type Currency = "USD" | "SLE";
+declare class FinancialAccountAPI extends HttpClient {
+    private readonly path;
+    create(accountName: string, currency: Currency): Promise<Result<CreateFinancialAccountResponse>>;
+    retrieve(financialAccountId: string): Promise<Result<RetrieveFinancialAccountResponse>>;
+    list(): Promise<Result<ListFinancialAccountsResponse>>;
+}
 
-declare function InternalTransferAPI(config: ClientConfig): {
-    create: (sourceAccount: string, destinationAccount: string, amount: number) => Promise<Result<CreateInternalTransfer>>;
-    get: (internalTransferId: string) => Promise<Result<InternalTransfer>>;
-    getAll: () => Promise<Result<AllInternalTransfers>>;
-    delete: (internalTransferId: string) => Promise<Result<void>>;
-};
+declare class BankAPI extends HttpClient {
+    private readonly path;
+    retrieve(providerId: string): Promise<Result<RetrieveBankResponse>>;
+    list(): Promise<Result<ListBanksResponse>>;
+}
 
-declare function PaymentAPI(config: ClientConfig): {
-    get: (paymentId: string) => Promise<Result<GetPayment>>;
-    getAll: (params?: Record<string, unknown>) => Promise<Result<ListPayments>>;
-    patch: (paymentId: string, body: Record<string, unknown>) => Promise<Result<PatchPayment>>;
-};
+declare class MomoAPI extends HttpClient {
+    private readonly path;
+    retrieve(providerId: string): Promise<Result<RetrieveMomoResponse>>;
+    list(): Promise<Result<ListMomosResponse>>;
+}
 
-declare function PaymentCodeAPI(config: ClientConfig): {
-    create: (paymentName: string, amount: number, financialAccount: string, username: string, phoneNumber: string) => Promise<Result<CreatePaymentCode>>;
-    delete: (paymentCodeId: string) => Promise<Result<void>>;
-    getAll: () => Promise<Result<GetAllPaymentCode>>;
-    get: (paymentCodeId: string) => Promise<Result<GetOne>>;
-};
+declare class FinancialTransactionAPI extends HttpClient {
+    private readonly path;
+    list(): Promise<Result<ListTransactionsResponse>>;
+    retrieve(transactionId: string): Promise<Result<RetrieveTransactionResponse>>;
+}
 
-declare function PayoutAPI(config: ClientConfig): {
-    create: (amount: number, destination: DestinationOption, sourceAccount: string) => Promise<Result<CreatePayout>>;
-    get: () => Promise<Result<GetAll>>;
-    getOne: (payoutId: string) => Promise<Result<GetOnePayout>>;
-    delete: (payoutId: string) => Promise<Result<void>>;
-};
+declare class InternalTransferAPI extends HttpClient {
+    private readonly path;
+    create(sourceAccount: string, destinationAccount: string, amount: number): Promise<Result<CreateInternalTransferResponse>>;
+    list(): Promise<Result<ListInternalTransfersResponse>>;
+    retrieve(internalTransferId: string): Promise<Result<RetrieveInternalTransferResponse>>;
+    delete(internalTransferId: string): Promise<Result<void>>;
+}
 
-declare function ProviderKycAPI(config: ClientConfig): {
-    get: (providerId: string) => Promise<Result<GetProviderKycResponse>>;
-};
+declare class PaymentAPI extends HttpClient {
+    private readonly path;
+    retrieve(paymentId: string): Promise<Result<RetrievePaymentResponse>>;
+    list(): Promise<Result<ListPaymentsResponse>>;
+    update(paymentId: string, body: Record<string, unknown>): Promise<Result<UpdatePaymentResponse>>;
+}
 
-declare function ReceiptAPI(config: ClientConfig): {
-    get: (orderNumber: string) => Promise<Result<GetReceiptResponse>>;
-    redeem: (orderNumber: string, body?: Record<string, unknown>) => Promise<Result<RedeemReceiptResponse>>;
-};
+declare class PaymentCodeAPI extends HttpClient {
+    private readonly path;
+    create(paymentName: string, amount: number, financialAccountId: string | null, name: string, phoneNumber: string): Promise<Result<CreatePaymentCodeResponse>>;
+    retrieve(paymentCodeId: string): Promise<Result<RetrievePaymentCodeResponse>>;
+    list(): Promise<Result<ListPaymentCodesResponse>>;
+    delete(paymentCodeId: string): Promise<Result<void>>;
+}
 
-declare function UssdOtpAPI(config: ClientConfig): {
-    create: (body: CreateUssdOtpRequest) => Promise<Result<CreateUssdOtpResponse>>;
-};
+declare class PayoutAPI extends HttpClient {
+    private readonly path;
+    create(amount: number, sourceAccount: string, destination: DestinationOption): Promise<Result<CreatePayoutResponse>>;
+    list(): Promise<Result<ListPayoutsResponse>>;
+    retrieve(payoutId: string): Promise<Result<RetrievePayoutResponse>>;
+    delete(payoutId: string): Promise<Result<void>>;
+}
 
-declare function WebhookAPI(config: ClientConfig): {
-    create: (body: CreateWebhookRequest) => Promise<Result<CreateWebhookResponse>>;
-    get: (webhookId: string) => Promise<Result<GetWebhookResponse>>;
-    getAll: () => Promise<Result<ListWebhooksResponse>>;
-    update: (webhookId: string, body: UpdateWebhookRequest) => Promise<Result<UpdateWebhookResponse>>;
-    delete: (webhookId: string) => Promise<Result<void>>;
-};
+declare class ProviderKycAPI extends HttpClient {
+    private readonly path;
+    retrieve(providerId: string): Promise<Result<GetProviderKycResponse>>;
+}
+
+declare class ReceiptAPI extends HttpClient {
+    private readonly path;
+    retrieve(orderNumber: string): Promise<Result<GetReceiptResponse>>;
+    redeem(orderNumber: string, body: Record<string, unknown>): Promise<Result<RedeemReceiptResponse>>;
+}
+
+declare class UssdOtpAPI extends HttpClient {
+    private readonly path;
+    create(body: CreateUssdOtpRequest): Promise<Result<CreateUssdOtpResponse>>;
+}
+
+declare class WebhookAPI extends HttpClient {
+    private readonly path;
+    create(body: CreateWebhookRequest): Promise<Result<CreateWebhookResponse>>;
+    retrieve(webhookId: string): Promise<Result<GetWebhookResponse>>;
+    list(): Promise<Result<ListWebhooksResponse>>;
+    update(webhookId: string, body: UpdateWebhookRequest): Promise<Result<UpdateWebhookResponse>>;
+    delete(webhookId: string): Promise<Result<void>>;
+}
 
 interface ClientOptions {
-    monimeSpaceId: string;
-    accessToken: string;
+    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>;
+    financialAccount: FinancialAccountAPI;
+    internalTransfer: InternalTransferAPI;
+    paymentCode: PaymentCodeAPI;
+    payment: PaymentAPI;
+    payout: PayoutAPI;
+    providerKyc: ProviderKycAPI;
+    receipt: ReceiptAPI;
+    ussdOtp: UssdOtpAPI;
+    webhook: WebhookAPI;
+    financialTransaction: FinancialTransactionAPI;
+    checkoutSession: CheckoutSessionAPI;
     financialProvider: {
-        bank: ReturnType<typeof BankAPI>;
-        momo: ReturnType<typeof MomoAPI>;
+        bank: BankAPI;
+        momo: MomoAPI;
     };
-    constructor(options: ClientOptions);
+    constructor(options?: ClientOptions);
 }
 
 declare function createClient(options: ClientOptions): MonimeClient;
 
-export { type AllCheckout, type AllFinancialAccount, type AllInternalTransfers, type AllTransaction, type Bank, type BankFeature, type BankFeatureSet, type ClientOptions, type CreateCheckout, type CreateFinancialAccount, type CreateInternalTransfer, type CreatePaymentCode, type CreatePayout, type CreateUssdOtpRequest, type CreateUssdOtpResponse, type CreateWebhookRequest, type CreateWebhookResponse, type DestinationOption, type GetAll, type GetAllPaymentCode, type GetBankResponse, type GetFinancialAccount, type GetMomoResponse, type GetOne, type GetOnePayout, type GetPayment, type GetProviderKycResponse, type GetReceiptResponse, type GetTransaction, type GetWebhookResponse, type InternalTransfer, type ListBanksResponse, type ListMomosResponse, type ListPayments, type ListWebhooksResponse, type Momo, type MomoFeature, type MomoFeatureSet, MonimeClient, type OneCheckout, type PatchPayment, type Payment, type ProviderKyc, type Receipt, type RedeemReceiptResponse, type UpdateWebhookRequest, type UpdateWebhookResponse, type UssdOtp, type Webhook, type WebhookVerificationMethod, createClient };
+export { type Bank, type BankFeature, type BankFeatureSet, type ClientConfig, type ClientOptions, type CreateCheckoutResponse, type CreateFinancialAccountResponse, type CreateInternalTransferResponse, type CreatePaymentCodeResponse, type CreatePayoutResponse, type CreateUssdOtpRequest, type CreateUssdOtpResponse, type CreateWebhookRequest, type CreateWebhookResponse, type DestinationOption, type GetProviderKycResponse, type GetReceiptResponse, type GetWebhookResponse, type ListBanksResponse, type ListCheckoutsResponse, type ListFinancialAccountsResponse, type ListInternalTransfersResponse, type ListMomosResponse, type ListPaymentCodesResponse, type ListPaymentsResponse, type ListPayoutsResponse, type ListTransactionsResponse, type ListWebhooksResponse, type Momo, type MomoFeature, type MomoFeatureSet, MonimeAuthenticationError, MonimeClient, MonimeError, MonimeValidationError, type Pagination, type Payment, type ProviderKyc, type Receipt, type RedeemReceiptResponse, type Result, type RetrieveBankResponse, type RetrieveCheckoutResponse, type RetrieveFinancialAccountResponse, type RetrieveInternalTransferResponse, type RetrieveMomoResponse, type RetrievePaymentCodeResponse, type RetrievePaymentResponse, type RetrievePayoutResponse, type RetrieveTransactionResponse, type UpdatePaymentResponse, type UpdateWebhookRequest, type UpdateWebhookResponse, type UssdOtp, type Webhook, type WebhookVerificationMethod, createClient };