monime-package 1.0.9 → 1.1.1

package/dist/index.d.ts

@@ -1,24 +1,18 @@
-interface AllCheckout {
-    success: boolean;
-    messages: string[];
-    result: Result$5[];
-    pagination: Pagination$5;
-}
-interface Pagination$5 {
-    count: number;
-    next: string;
+interface ClientConfig {
+    monimeSpaceId: string;
+    accessToken: string;
+    monimeVersion?: string | undefined;
 }
-interface OneCheckout {
-    success: boolean;
-    messages: string[];
-    result: Result$5;
+interface Pagination {
+    count?: number;
+    next: string | null;
 }
-interface CreateCheckout {
-    success: boolean;
-    messages: string[];
-    result: Result$5;
+
+interface AllCheckout {
+    result: CheckoutSession[];
+    pagination: Pagination;
 }
-interface Result$5 {
+interface CheckoutSession {
     id: string;
     status: string;
     name: string;
@@ -35,7 +29,7 @@ interface Result$5 {
     createTime: string;
     ownershipGraph: OwnershipGraph$4;
 }
-interface Result$5 {
+interface OneCheckout {
     id: string;
     status: string;
     name: string;
@@ -52,7 +46,7 @@ interface Result$5 {
     createTime: string;
     ownershipGraph: OwnershipGraph$4;
 }
-interface Result$5 {
+interface CreateCheckout {
     id: string;
     status: string;
     name: string;
@@ -166,7 +160,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;
@@ -189,26 +183,6 @@ declare function CheckoutSessionAPI(client: MonimeClient): {
 };
 
 interface CreateFinancialAccount {
-    success: boolean;
-    messages: string[];
-    result: Result$4;
-}
-interface GetFinancialAccount {
-    success: boolean;
-    messages: string[];
-    result: Result$4;
-}
-interface AllFinancialAccount {
-    success: boolean;
-    messages: string[];
-    result: Result$4[];
-    pagination: Pagination$4;
-}
-interface Pagination$4 {
-    count: number;
-    next: string;
-}
-interface Result$4 {
     id: string;
     uvan: string;
     name: string;
@@ -219,7 +193,7 @@ interface Result$4 {
     createTime: string;
     updateTime: string;
 }
-interface Result$4 {
+interface GetFinancialAccount {
     id: string;
     uvan: string;
     name: string;
@@ -230,7 +204,11 @@ interface Result$4 {
     createTime: string;
     updateTime: string;
 }
-interface Result$4 {
+interface AllFinancialAccount {
+    result: FinancialAccount$1[];
+    pagination: Pagination;
+}
+interface FinancialAccount$1 {
     id: string;
     uvan: string;
     name: string;
@@ -264,26 +242,6 @@ interface Available {
 }
 
 interface CreateInternalTransfer {
-    success: boolean;
-    messages: string[];
-    result: Result$3;
-}
-interface AllInternalTransfers {
-    success: boolean;
-    messages: string[];
-    result: Result$3[];
-    pagination: Pagination$3;
-}
-interface Pagination$3 {
-    count: number;
-    next: string;
-}
-interface InternalTransfer {
-    success: boolean;
-    messages: string[];
-    result: Result$3;
-}
-interface Result$3 {
     id: string;
     status: string;
     amount: Amount$3;
@@ -296,7 +254,11 @@ interface Result$3 {
     createTime: string;
     updateTime: string;
 }
-interface Result$3 {
+interface AllInternalTransfers {
+    result: Transfer[];
+    pagination: Pagination;
+}
+interface Transfer {
     id: string;
     status: string;
     amount: Amount$3;
@@ -309,7 +271,7 @@ interface Result$3 {
     createTime: string;
     updateTime: string;
 }
-interface Result$3 {
+interface InternalTransfer {
     id: string;
     status: string;
     amount: Amount$3;
@@ -392,27 +354,49 @@ interface Amount$3 {
     value: number;
 }
 
-interface CreatePaymentCode {
-    success: boolean;
-    messages: string[];
-    result: Result$2;
+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, unknown> | null;
+        };
+    };
+    metadata: Record<string, unknown> | null;
 }
-interface GetAllPaymentCode {
-    success: boolean;
-    messages: string[];
-    result: Result$2[];
-    pagination: Pagination$2;
+interface GetPayment extends Payment {
 }
-interface Pagination$2 {
-    count: number;
-    next: string;
+interface ListPayments {
+    result: Payment[];
+    pagination: Pagination;
 }
-interface GetOne {
-    success: boolean;
-    messages: string[];
-    result: Result$2;
+interface PatchPayment extends Payment {
 }
-interface Result$2 {
+
+interface CreatePaymentCode {
     id: string;
     mode: string;
     status: string;
@@ -443,7 +427,11 @@ interface Result$2 {
     updateTime: string;
     ownershipGraph: OwnershipGraph$2;
 }
-interface Result$2 {
+interface GetAllPaymentCode {
+    result: PaymentCode[];
+    pagination: Pagination;
+}
+interface PaymentCode {
     id: string;
     mode: string;
     status: string;
@@ -463,7 +451,7 @@ interface Result$2 {
     updateTime: string;
     ownershipGraph: OwnershipGraph$2;
 }
-interface Result$2 {
+interface GetOne {
     id: string;
     mode: string;
     status: string;
@@ -595,26 +583,6 @@ type DestinationOption = {
     walletId: string;
 };
 interface CreatePayout {
-    success: boolean;
-    messages: string[];
-    result: Result$1;
-}
-interface GetAll {
-    success: boolean;
-    messages: string[];
-    result: Result$1[];
-    pagination: Pagination$1;
-}
-interface Pagination$1 {
-    count: number;
-    next: string;
-}
-interface GetOnePayout {
-    success: boolean;
-    messages: string[];
-    result: Result$1;
-}
-interface Result$1 {
     id: string;
     status: string;
     amount: Amount$1;
@@ -626,7 +594,11 @@ interface Result$1 {
     updateTime: string;
     ownershipGraph: OwnershipGraph$1;
 }
-interface Result$1 {
+interface GetAll {
+    result: Payout[];
+    pagination: Pagination;
+}
+interface Payout {
     id: string;
     status: string;
     amount: Amount$1;
@@ -638,7 +610,7 @@ interface Result$1 {
     updateTime: string;
     ownershipGraph: OwnershipGraph$1;
 }
-interface Result$1 {
+interface GetOnePayout {
     id: string;
     status: string;
     amount: Amount$1;
@@ -753,56 +725,34 @@ 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 ProviderKyc {
+    providerId: string;
+    [key: string]: unknown;
 }
-interface GetPayment {
-    success: boolean;
-    messages: string[];
-    result: Payment;
+interface GetProviderKycResponse extends ProviderKyc {
 }
-interface ListPayments {
-    success: boolean;
-    messages: string[];
-    result: Payment[];
-    pagination: {
-        next: string | null;
-    };
+
+interface Receipt {
+    orderNumber: string;
+    [key: string]: unknown;
+}
+interface GetReceiptResponse extends Receipt {
 }
-interface PatchPayment {
-    success: boolean;
-    messages: string[];
-    result: Payment;
+interface RedeemReceiptResponse extends Receipt {
+}
+
+interface UssdOtp {
+    id: string;
+    phoneNumber: string;
+    otp: string;
+    expiresAt: string;
+    [key: string]: unknown;
+}
+interface CreateUssdOtpRequest {
+    phoneNumber: string;
+    [key: string]: unknown;
+}
+interface CreateUssdOtpResponse extends UssdOtp {
 }
 
 interface WebhookVerificationMethod {
@@ -821,7 +771,7 @@ interface Webhook {
     alertEmails: string[];
     createTime: string;
     updateTime: string;
-    metadata: Record<string, any>;
+    metadata: Record<string, unknown>;
 }
 interface CreateWebhookRequest {
     name: string;
@@ -832,25 +782,15 @@ interface CreateWebhookRequest {
     headers?: Record<string, string>;
     alertEmails?: string[];
     verificationMethod?: WebhookVerificationMethod;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 }
-interface CreateWebhookResponse {
-    success: boolean;
-    messages: string[];
-    result: Webhook;
+interface CreateWebhookResponse extends Webhook {
 }
-interface GetWebhookResponse {
-    success: boolean;
-    messages: string[];
-    result: Webhook;
+interface GetWebhookResponse extends Webhook {
 }
 interface ListWebhooksResponse {
-    success: boolean;
-    messages: string[];
     result: Webhook[];
-    pagination?: {
-        next: string | null;
-    };
+    pagination?: Pagination;
 }
 interface UpdateWebhookRequest {
     name?: string;
@@ -860,59 +800,14 @@ interface UpdateWebhookRequest {
     headers?: Record<string, string>;
     alertEmails?: string[];
     verificationMethod?: WebhookVerificationMethod;
-    metadata?: Record<string, any>;
+    metadata?: Record<string, unknown>;
 }
-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;
+interface UpdateWebhookResponse extends Webhook {
 }
 
 type Currency = "USD" | "SLE";
 
-declare function FinancialAccountAPI(client: MonimeClient): {
+declare function FinancialAccountAPI(config: ClientConfig): {
     create: (name: string, currency: Currency) => Promise<{
         success: boolean;
         data?: CreateFinancialAccount;
@@ -931,21 +826,6 @@ declare function FinancialAccountAPI(client: MonimeClient): {
 };
 
 interface GetTransaction {
-    success: boolean;
-    messages: string[];
-    result: Result;
-}
-interface AllTransaction {
-    success: boolean;
-    messages: string[];
-    result: Result[];
-    pagination: Pagination;
-}
-interface Pagination {
-    count: number;
-    next: string;
-}
-interface Result {
     id: string;
     type: string;
     amount: Amount;
@@ -956,7 +836,11 @@ interface Result {
     originatingFee: OriginatingFee;
     ownershipGraph: OwnershipGraph;
 }
-interface Result {
+interface AllTransaction {
+    result: Transaction[];
+    pagination: Pagination;
+}
+interface Transaction {
     id: string;
     type: string;
     amount: Amount;
@@ -1028,7 +912,7 @@ interface Amount {
     value: number;
 }
 
-declare function FinancialTransactionAPI(client: MonimeClient): {
+declare function FinancialTransactionAPI(config: ClientConfig): {
     get: (transactionId: string) => Promise<{
         success: boolean;
         error?: Error;
@@ -1041,7 +925,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;
@@ -1063,25 +947,25 @@ declare function InternalTransferAPI(client: MonimeClient): {
     }>;
 };
 
-declare function PaymentAPI(client: MonimeClient): {
+declare function PaymentAPI(config: ClientConfig): {
     get: (paymentId: string) => Promise<{
         success: boolean;
         data?: GetPayment;
         error?: Error;
     }>;
-    getAll: (params?: Record<string, any>) => Promise<{
+    getAll: (params?: Record<string, unknown>) => Promise<{
         success: boolean;
         data?: ListPayments;
         error?: Error;
     }>;
-    patch: (paymentId: string, body: Record<string, any>) => Promise<{
+    patch: (paymentId: string, body: Record<string, unknown>) => Promise<{
         success: boolean;
         data?: PatchPayment;
         error?: Error;
     }>;
 };
 
-declare function PaymentCodeAPI(client: MonimeClient): {
+declare function PaymentCodeAPI(config: ClientConfig): {
     create: (paymentName: string, amount: number, financialAccount: string, username: string, phoneNumber: string) => Promise<{
         success: boolean;
         data?: CreatePaymentCode;
@@ -1103,7 +987,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;
@@ -1125,7 +1009,7 @@ declare function PayoutAPI(client: MonimeClient): {
     }>;
 };
 
-declare function ProviderKycAPI(client: MonimeClient): {
+declare function ProviderKycAPI(config: ClientConfig): {
     get: (providerId: string) => Promise<{
         success: boolean;
         data?: GetProviderKycResponse;
@@ -1133,20 +1017,20 @@ declare function ProviderKycAPI(client: MonimeClient): {
     }>;
 };
 
-declare function ReceiptAPI(client: MonimeClient): {
+declare function ReceiptAPI(config: ClientConfig): {
     get: (orderNumber: string) => Promise<{
         success: boolean;
         data?: GetReceiptResponse;
         error?: Error;
     }>;
-    redeem: (orderNumber: string, body?: Record<string, any>) => Promise<{
+    redeem: (orderNumber: string, body?: Record<string, unknown>) => Promise<{
         success: boolean;
         data?: RedeemReceiptResponse;
         error?: Error;
     }>;
 };
 
-declare function UssdOtpAPI(client: MonimeClient): {
+declare function UssdOtpAPI(config: ClientConfig): {
     create: (body: CreateUssdOtpRequest) => Promise<{
         success: boolean;
         data?: CreateUssdOtpResponse;
@@ -1154,7 +1038,7 @@ declare function UssdOtpAPI(client: MonimeClient): {
     }>;
 };
 
-declare function WebhookAPI(client: MonimeClient): {
+declare function WebhookAPI(config: ClientConfig): {
     create: (body: CreateWebhookRequest) => Promise<{
         success: boolean;
         data?: CreateWebhookResponse;
@@ -1202,11 +1086,6 @@ declare class MonimeClient {
     financialTransaction: ReturnType<typeof FinancialTransactionAPI>;
     checkoutSession: ReturnType<typeof CheckoutSessionAPI>;
     constructor(options: ClientOptions);
-    _getConfig(): {
-        monimeSpaceId: string;
-        accessToken: string;
-        monimeVersion: string | undefined;
-    };
 }
 
 declare function createClient(options: ClientOptions): MonimeClient;