monime-package 1.0.3 → 1.0.5

package/dist/index.d.mts

@@ -1,45 +1,63 @@
 interface CreateFinancialAccount {
     success: boolean;
     messages: string[];
-    result: Result$3;
+    result: Result$4;
 }
 interface GetFinancialAccount {
     success: boolean;
     messages: string[];
-    result: Result$3;
+    result: Result$4;
 }
-interface Result$3 {
+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;
     currency: string;
     reference: string;
     description: string;
-    balance: Balance;
+    balance: Balance$1;
     createTime: string;
     updateTime: string;
-    metadata: Metadata$2;
 }
-interface Result$3 {
+interface Result$4 {
     id: string;
     uvan: string;
     name: string;
     currency: string;
     reference: string;
     description: string;
-    balance: Balance;
+    balance: Balance$1;
     createTime: string;
     updateTime: string;
-    metadata: Metadata$2;
 }
-interface Metadata$2 {
+interface Result$4 {
+    id: string;
+    uvan: string;
+    name: string;
+    currency: string;
+    reference: string;
+    description: string;
+    balance: Balance$1;
+    createTime: string;
+    updateTime: string;
 }
-interface Metadata$2 {
+interface Balance$1 {
+    available: Available;
 }
-interface Balance {
+interface Balance$1 {
     available: Available;
 }
-interface Balance {
+interface Balance$1 {
     available: Available;
 }
 interface Available {
@@ -50,42 +68,113 @@ interface Available {
     currency: string;
     value: number;
 }
+interface Available {
+    currency: string;
+    value: number;
+}
 
 interface CreateInternalTransfer {
     success: boolean;
     messages: string[];
-    result: Result$2;
+    result: Result$3;
 }
-interface Result$2 {
+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$1;
+    amount: Amount$3;
     sourceFinancialAccount: SourceFinancialAccount;
     destinationFinancialAccount: SourceFinancialAccount;
     financialTransactionReference: string;
     description: string;
     failureDetail: FailureDetail$1;
-    ownershipGraph: OwnershipGraph$2;
+    ownershipGraph: OwnershipGraph$3;
     createTime: string;
     updateTime: string;
-    metadata: Metadata$1;
 }
-interface OwnershipGraph$2 {
-    owner: Owner2$1;
+interface Result$3 {
+    id: string;
+    status: string;
+    amount: Amount$3;
+    sourceFinancialAccount: SourceFinancialAccount;
+    destinationFinancialAccount: SourceFinancialAccount;
+    financialTransactionReference: string;
+    description: string;
+    failureDetail: FailureDetail$1;
+    ownershipGraph: OwnershipGraph$3;
+    createTime: string;
+    updateTime: string;
 }
-interface Owner2$1 {
+interface Result$3 {
+    id: string;
+    status: string;
+    amount: Amount$3;
+    sourceFinancialAccount: SourceFinancialAccount;
+    destinationFinancialAccount: SourceFinancialAccount;
+    financialTransactionReference: string;
+    description: string;
+    failureDetail: FailureDetail$1;
+    ownershipGraph: OwnershipGraph$3;
+    createTime: string;
+    updateTime: string;
+}
+interface OwnershipGraph$3 {
+    owner: Owner2$3;
+}
+interface OwnershipGraph$3 {
+    owner: Owner2$3;
+}
+interface OwnershipGraph$3 {
+    owner: Owner2$3;
+}
+interface Owner2$3 {
     id: string;
     type: string;
-    metadata: Metadata$1;
-    owner: Owner$1;
+    owner: Owner$3;
 }
-interface Owner$1 {
+interface Owner2$3 {
+    id: string;
+    type: string;
+    owner: Owner$3;
+}
+interface Owner2$3 {
+    id: string;
+    type: string;
+    owner: Owner$3;
+}
+interface Owner$3 {
+    id: string;
+    type: string;
+}
+interface Owner$3 {
+    id: string;
+    type: string;
+}
+interface Owner$3 {
     id: string;
     type: string;
-    metadata: Metadata$1;
-    owner: Metadata$1;
 }
-interface Metadata$1 {
+interface FailureDetail$1 {
+    code: string;
+    message: string;
+}
+interface FailureDetail$1 {
+    code: string;
+    message: string;
 }
 interface FailureDetail$1 {
     code: string;
@@ -94,7 +183,21 @@ interface FailureDetail$1 {
 interface SourceFinancialAccount {
     id: string;
 }
-interface Amount$1 {
+interface SourceFinancialAccount {
+    id: string;
+}
+interface SourceFinancialAccount {
+    id: string;
+}
+interface Amount$3 {
+    currency: string;
+    value: number;
+}
+interface Amount$3 {
+    currency: string;
+    value: number;
+}
+interface Amount$3 {
     currency: string;
     value: number;
 }
@@ -102,9 +205,24 @@ interface Amount$1 {
 interface CreatePaymentCode {
     success: boolean;
     messages: string[];
-    result: Result$1;
+    result: Result$2;
 }
-interface Result$1 {
+interface GetAllPaymentCode {
+    success: boolean;
+    messages: string[];
+    result: Result$2[];
+    pagination: Pagination$2;
+}
+interface Pagination$2 {
+    count: number;
+    next: string;
+}
+interface GetOne {
+    success: boolean;
+    messages: string[];
+    result: Result$2;
+}
+interface Result$2 {
     id: string;
     mode: string;
     status: string;
@@ -133,22 +251,82 @@ interface Result$1 {
     processedPaymentData: ProcessedPaymentData;
     createTime: string;
     updateTime: string;
-    ownershipGraph: OwnershipGraph$1;
-    metadata: {};
+    ownershipGraph: OwnershipGraph$2;
 }
-interface OwnershipGraph$1 {
+interface Result$2 {
+    id: string;
+    mode: string;
+    status: string;
+    name: string;
+    amount: Amount$2;
+    enable: boolean;
+    expireTime: string;
+    customer: Customer;
+    ussdCode: string;
+    reference: string;
+    authorizedProviders: string[];
+    authorizedPhoneNumber: string;
+    recurrentPaymentTarget: RecurrentPaymentTarget;
+    financialAccountId: string;
+    processedPaymentData: ProcessedPaymentData;
+    createTime: string;
+    updateTime: string;
+    ownershipGraph: OwnershipGraph$2;
+}
+interface Result$2 {
+    id: string;
+    mode: string;
+    status: string;
+    name: string;
+    amount: Amount$2;
+    enable: boolean;
+    expireTime: string;
+    customer: Customer;
+    ussdCode: string;
+    reference: string;
+    authorizedProviders: string[];
+    authorizedPhoneNumber: string;
+    recurrentPaymentTarget: RecurrentPaymentTarget;
+    financialAccountId: string;
+    processedPaymentData: ProcessedPaymentData;
+    createTime: string;
+    updateTime: string;
+    ownershipGraph: OwnershipGraph$2;
+}
+interface OwnershipGraph$2 {
     owner: {
         id: string;
         type: string;
-        metadata: {};
         owner: {
             id: string;
             type: string;
-            metadata: {};
-            owner: {};
         };
     };
 }
+interface OwnershipGraph$2 {
+    owner: Owner2$2;
+}
+interface OwnershipGraph$2 {
+    owner: Owner2$2;
+}
+interface Owner2$2 {
+    id: string;
+    type: string;
+    owner: Owner$2;
+}
+interface Owner2$2 {
+    id: string;
+    type: string;
+    owner: Owner$2;
+}
+interface Owner$2 {
+    id: string;
+    type: string;
+}
+interface Owner$2 {
+    id: string;
+    type: string;
+}
 interface ProcessedPaymentData {
     amount: {
         currency: string;
@@ -163,41 +341,168 @@ interface ProcessedPaymentData {
         reference: string;
     };
     financialTransactionReference: string;
-    metadata: {};
+}
+interface ProcessedPaymentData {
+    amount: Amount$2;
+    orderId: string;
+    paymentId: string;
+    orderNumber: string;
+    channelData: ChannelData;
+    financialTransactionReference: string;
+}
+interface ProcessedPaymentData {
+    amount: Amount$2;
+    orderId: string;
+    paymentId: string;
+    orderNumber: string;
+    channelData: ChannelData;
+    financialTransactionReference: string;
+}
+interface ChannelData {
+    providerId: string;
+    accountId: string;
+    reference: string;
+}
+interface ChannelData {
+    providerId: string;
+    accountId: string;
+    reference: string;
+}
+interface RecurrentPaymentTarget {
+    expectedPaymentCount: number;
+    expectedPaymentTotal: Amount$2;
+}
+interface RecurrentPaymentTarget {
+    expectedPaymentCount: number;
+    expectedPaymentTotal: Amount$2;
+}
+interface Customer {
+    name: string;
+}
+interface Customer {
+    name: string;
+}
+interface Amount$2 {
+    currency: string;
+    value: number;
+}
+interface Amount$2 {
+    currency: string;
+    value: number;
 }
 
+type DestinationOption = {
+    type: "momo";
+    providerId: "m17" | "m18";
+    phoneNumber: string;
+} | {
+    type: "bank";
+    providerId: "b01" | "b02" | "b03";
+    accountNumber: string;
+} | {
+    type: "wallet";
+    providerId: "w01" | "w02";
+    walletId: string;
+};
 interface CreatePayout {
     success: boolean;
     messages: string[];
-    result: Result;
+    result: Result$1;
 }
-interface Result {
+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;
+    amount: Amount$1;
     source: Source;
     destination: Destination;
     fees: Fee[];
     failureDetail: FailureDetail;
     createTime: string;
     updateTime: string;
-    ownershipGraph: OwnershipGraph;
-    metadata: Metadata;
+    ownershipGraph: OwnershipGraph$1;
 }
-interface OwnershipGraph {
-    owner: Owner2;
+interface Result$1 {
+    id: string;
+    status: string;
+    amount: Amount$1;
+    source: Source;
+    destination: Destination;
+    fees: Fee[];
+    failureDetail: FailureDetail;
+    createTime: string;
+    updateTime: string;
+    ownershipGraph: OwnershipGraph$1;
 }
-interface Owner2 {
+interface Result$1 {
+    id: string;
+    status: string;
+    amount: Amount$1;
+    source: Source;
+    destination: Destination;
+    fees: Fee[];
+    failureDetail: FailureDetail;
+    createTime: string;
+    updateTime: string;
+    ownershipGraph: OwnershipGraph$1;
+}
+interface OwnershipGraph$1 {
+    owner: Owner2$1;
+}
+interface OwnershipGraph$1 {
+    owner: Owner2$1;
+}
+interface OwnershipGraph$1 {
+    owner: Owner2$1;
+}
+interface Owner2$1 {
     id: string;
     type: string;
-    metadata: Metadata;
-    owner: Owner;
+    owner: Owner$1;
 }
-interface Owner {
+interface Owner2$1 {
+    id: string;
+    type: string;
+    owner: Owner$1;
+}
+interface Owner2$1 {
     id: string;
     type: string;
-    metadata: Metadata;
-    owner: Metadata;
+    owner: Owner$1;
+}
+interface Owner$1 {
+    id: string;
+    type: string;
+}
+interface Owner$1 {
+    id: string;
+    type: string;
+}
+interface Owner$1 {
+    id: string;
+    type: string;
+}
+interface FailureDetail {
+    code: string;
+    message: string;
+}
+interface FailureDetail {
+    code: string;
+    message: string;
 }
 interface FailureDetail {
     code: string;
@@ -205,10 +510,27 @@ interface FailureDetail {
 }
 interface Fee {
     code: string;
-    amount: Amount;
-    metadata: Metadata;
+    amount: Amount$1;
+}
+interface Fee {
+    code: string;
+    amount: Amount$1;
+}
+interface Fee {
+    code: string;
+    amount: Amount$1;
 }
-interface Metadata {
+interface Destination {
+    type: string;
+    providerId: string;
+    accountNumber: string;
+    transactionReference: string;
+}
+interface Destination {
+    type: string;
+    providerId: string;
+    accountNumber: string;
+    transactionReference: string;
 }
 interface Destination {
     type: string;
@@ -220,48 +542,234 @@ interface Source {
     financialAccountId: string;
     transactionReference: string;
 }
-interface Amount {
+interface Source {
+    financialAccountId: string;
+    transactionReference: string;
+}
+interface Source {
+    financialAccountId: string;
+    transactionReference: string;
+}
+interface Amount$1 {
     currency: string;
     value: number;
 }
-
-interface ClientOptions {
-    monimeSpaceeId: string;
-    accessToken: string;
+interface Amount$1 {
+    currency: string;
+    value: number;
 }
-declare class MonimeClient {
-    private monimeSpaceId;
-    private accessToken;
-    createFinancialAccount: (name: string) => Promise<{
+interface Amount$1 {
+    currency: string;
+    value: number;
+}
+
+declare function FinancialAccountAPI(client: MonimeClient): {
+    create: (name: string) => Promise<{
         success: boolean;
         data?: CreateFinancialAccount;
         error?: Error;
     }>;
-    getFinancialAccount: (financialAccountId: string) => Promise<{
+    get: (financialAccountId: string) => Promise<{
         success: boolean;
         data?: GetFinancialAccount;
         error?: Error;
     }>;
-    createInternalTransfer: (sourceAccount: string, destinationAccount: string, amount: number) => Promise<{
+    getAll: () => Promise<{
+        success: boolean;
+        data?: AllFinancialAccount;
+        error?: Error;
+    }>;
+};
+
+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;
+    timestamp: string;
+    reference: string;
+    financialAccount: FinancialAccount;
+    originatingReversal: OriginatingReversal;
+    originatingFee: OriginatingFee;
+    ownershipGraph: OwnershipGraph;
+}
+interface Result {
+    id: string;
+    type: string;
+    amount: Amount;
+    timestamp: string;
+    reference: string;
+    financialAccount: FinancialAccount;
+    originatingReversal: OriginatingReversal;
+    originatingFee: OriginatingFee;
+    ownershipGraph: OwnershipGraph;
+}
+interface OwnershipGraph {
+    owner: Owner2;
+}
+interface OwnershipGraph {
+    owner: Owner2;
+}
+interface Owner2 {
+    id: string;
+    type: string;
+    owner: Owner;
+}
+interface Owner2 {
+    id: string;
+    type: string;
+    owner: Owner;
+}
+interface Owner {
+    id: string;
+    type: string;
+}
+interface Owner {
+    id: string;
+    type: string;
+}
+interface OriginatingFee {
+    code: string;
+}
+interface OriginatingFee {
+    code: string;
+}
+interface OriginatingReversal {
+    originTxnId: string;
+    originTxnRef: string;
+}
+interface OriginatingReversal {
+    originTxnId: string;
+    originTxnRef: string;
+}
+interface FinancialAccount {
+    id: string;
+    balance: Balance;
+}
+interface FinancialAccount {
+    id: string;
+    balance: Balance;
+}
+interface Balance {
+    after: Amount;
+}
+interface Balance {
+    after: Amount;
+}
+interface Amount {
+    currency: string;
+    value: number;
+}
+interface Amount {
+    currency: string;
+    value: number;
+}
+
+declare function FinancialTransactionAPI(client: MonimeClient): {
+    get: (transactionId: string) => Promise<{
+        success: boolean;
+        error?: Error;
+        data?: GetTransaction;
+    }>;
+    getAll: () => Promise<{
+        success: boolean;
+        error?: Error;
+        data?: AllTransaction;
+    }>;
+};
+
+declare function InternalTransferAPI(client: MonimeClient): {
+    create: (sourceAccount: string, destinationAccount: string, amount: number) => Promise<{
         success: boolean;
         data?: CreateInternalTransfer;
         error?: Error;
     }>;
-    createPaymentCode: (paymentName: string, amount: number, financialAccount: string, username: string, phoneNumber: string) => Promise<{
+    get: (internalTransferId: string) => Promise<{
         success: boolean;
+        data?: InternalTransfer;
         error?: Error;
-        data?: CreatePaymentCode;
     }>;
-    deletePaymentCode: (paymentCodeId: string) => Promise<{
+    getAll: () => Promise<{
+        success: boolean;
+        error?: Error;
+        data?: AllInternalTransfers;
+    }>;
+    delete: (internalTransferId: string) => Promise<{
         success: boolean;
         error?: Error;
+    }>;
+};
+
+declare function PaymentCodeAPI(client: MonimeClient): {
+    create: (paymentName: string, amount: number, financialAccount: string, username: string, phoneNumber: string) => Promise<{
+        success: boolean;
         data?: CreatePaymentCode;
+        error?: Error;
+    }>;
+    delete: (paymentCodeId: string) => Promise<{
+        success: boolean;
+        error?: Error;
+    }>;
+    getAll: () => Promise<{
+        success: boolean;
+        data?: GetAllPaymentCode;
+        error?: Error;
     }>;
-    createPayout: (amount: number, phoneNumber: string, sourceAccount: string) => Promise<{
+    get: (paymentCodeId: string) => Promise<{
         success: boolean;
+        data?: GetOne;
         error?: Error;
+    }>;
+};
+
+declare function PayoutAPI(client: MonimeClient): {
+    create: (amount: number, destination: DestinationOption, sourceAccount: string) => Promise<{
+        success: boolean;
         data?: CreatePayout;
+        error?: Error;
+    }>;
+    get: () => Promise<{
+        success: boolean;
+        data?: GetAll;
+        error?: Error;
     }>;
+    getOne: (payoutId: string) => Promise<{
+        success: boolean;
+        data?: GetOnePayout;
+        error?: Error;
+    }>;
+    delete: (payoutId: string) => Promise<{
+        success: boolean;
+        error?: Error;
+    }>;
+};
+
+interface ClientOptions {
+    monimeSpaceId: string;
+    accessToken: string;
+}
+declare class MonimeClient {
+    private monimeSpaceId;
+    private accessToken;
+    financialAccount: ReturnType<typeof FinancialAccountAPI>;
+    internalTransfer: ReturnType<typeof InternalTransferAPI>;
+    paymentCode: ReturnType<typeof PaymentCodeAPI>;
+    payout: ReturnType<typeof PayoutAPI>;
+    financialTransaction: ReturnType<typeof FinancialTransactionAPI>;
     constructor(options: ClientOptions);
     _getConfig(): {
         monimeSpaceId: string;
@@ -271,4 +779,4 @@ declare class MonimeClient {
 
 declare function createClient(options: ClientOptions): MonimeClient;
 
-export { type ClientOptions, MonimeClient, createClient };
+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 };