@vulog/aima-billing 1.1.96 → 1.1.98

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { Client } from '@vulog/aima-client';
 import { UUID } from 'crypto';
+import { PatchAction } from '@vulog/aima-core';
 
 type ChargeProductInfo = {
     productId: string;
@@ -112,6 +113,23 @@ type RefundableAmount = {
     refundablePaymentReceipts: Receipt[];
     refundedPaymentReceipts: Receipt[];
 };
+type Wallet = {
+    initialAmount: number;
+    validityStartDate: string;
+    validityEndDate: string;
+    notes: string;
+    discountCategory: string;
+    oneTimeUsage: boolean;
+    id: string;
+    availableAmount: number;
+    usedAmount: number;
+    originId: string;
+    entityId: string;
+    creditAlreadyUsed: boolean;
+    updateDate: string;
+    type: string;
+    usage: string;
+};
 
 declare const chargeProduct: (client: Client, info: ChargeProductInfo) => Promise<Invoice>;
 
@@ -128,9 +146,15 @@ declare const getRefundableAmount: (client: Client, invoiceId: string) => Promis
 interface Payload {
     invoiceId: string;
     amount?: number;
-    notes?: string | null;
+    note?: string | null;
     paymentIntentPspReference?: string;
 }
 declare const refund: (client: Client, payload: Payload) => Promise<void>;
 
-export { type ChargeProductInfo, type Credit, type Invoice, type Receipt, type RefundableAmount, addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, refund };
+declare const getWalletsByEntity: (client: Client, entityId: string) => Promise<Wallet[]>;
+
+declare const paths: readonly ["/availableAmount", "/percentage"];
+type Paths = (typeof paths)[number];
+declare const updateWallet: (client: Client, walletId: string, actions: PatchAction<Paths>[]) => Promise<void>;
+
+export { type ChargeProductInfo, type Credit, type Invoice, type Paths, type Receipt, type RefundableAmount, type Wallet, addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, refund, updateWallet };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { Client } from '@vulog/aima-client';
 import { UUID } from 'crypto';
+import { PatchAction } from '@vulog/aima-core';
 
 type ChargeProductInfo = {
     productId: string;
@@ -112,6 +113,23 @@ type RefundableAmount = {
     refundablePaymentReceipts: Receipt[];
     refundedPaymentReceipts: Receipt[];
 };
+type Wallet = {
+    initialAmount: number;
+    validityStartDate: string;
+    validityEndDate: string;
+    notes: string;
+    discountCategory: string;
+    oneTimeUsage: boolean;
+    id: string;
+    availableAmount: number;
+    usedAmount: number;
+    originId: string;
+    entityId: string;
+    creditAlreadyUsed: boolean;
+    updateDate: string;
+    type: string;
+    usage: string;
+};
 
 declare const chargeProduct: (client: Client, info: ChargeProductInfo) => Promise<Invoice>;
 
@@ -128,9 +146,15 @@ declare const getRefundableAmount: (client: Client, invoiceId: string) => Promis
 interface Payload {
     invoiceId: string;
     amount?: number;
-    notes?: string | null;
+    note?: string | null;
     paymentIntentPspReference?: string;
 }
 declare const refund: (client: Client, payload: Payload) => Promise<void>;
 
-export { type ChargeProductInfo, type Credit, type Invoice, type Receipt, type RefundableAmount, addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, refund };
+declare const getWalletsByEntity: (client: Client, entityId: string) => Promise<Wallet[]>;
+
+declare const paths: readonly ["/availableAmount", "/percentage"];
+type Paths = (typeof paths)[number];
+declare const updateWallet: (client: Client, walletId: string, actions: PatchAction<Paths>[]) => Promise<void>;
+
+export { type ChargeProductInfo, type Credit, type Invoice, type Paths, type Receipt, type RefundableAmount, type Wallet, addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, refund, updateWallet };

package/dist/index.js

@@ -35,7 +35,9 @@ __export(index_exports, {
   getInvoiceById: () => getInvoiceById,
   getRefundableAmount: () => getRefundableAmount,
   getUserCreditsByEntityId: () => getUserCreditsByEntityId,
-  refund: () => refund
+  getWalletsByEntity: () => getWalletsByEntity,
+  refund: () => refund,
+  updateWallet: () => updateWallet
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -129,7 +131,7 @@ var getRefundableAmount = async (client, invoiceId) => {
 var import_zod6 = __toESM(require("zod"));
 var schema4 = import_zod6.default.object({
   amount: import_zod6.default.number().min(0).optional(),
-  notes: import_zod6.default.string().trim().nullable().optional(),
+  note: import_zod6.default.string().trim().nullable().optional(),
   paymentIntentPspReference: import_zod6.default.string().trim().min(1).optional()
 });
 var refund = async (client, payload) => {
@@ -139,11 +141,55 @@ var refund = async (client, payload) => {
       cause: result.error.issues
     });
   }
+  const filteredData = Object.fromEntries(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    Object.entries(result.data).filter(([_, value]) => value !== void 0 && value !== null)
+  );
   return client.post(
     `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
-    result.data
+    // filter boolean fields
+    filteredData
   ).then(({ data }) => data);
 };
+
+// src/getWalletsByEntity.ts
+var import_zod7 = require("zod");
+var getWalletsByEntity = async (client, entityId) => {
+  const result = import_zod7.z.string().trim().min(1).uuid().safeParse(entityId);
+  if (!result.success) {
+    throw new TypeError("Invalid entityId", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/wallet/entity/${entityId}`).then(({ data }) => data);
+};
+
+// src/updateWallet.ts
+var import_zod8 = require("zod");
+var paths = ["/availableAmount", "/percentage"];
+var schema5 = import_zod8.z.object({
+  walletId: import_zod8.z.string().trim().min(1).uuid(),
+  actions: import_zod8.z.array(
+    import_zod8.z.object({
+      op: import_zod8.z.enum(["replace"]),
+      path: import_zod8.z.enum(paths),
+      value: import_zod8.z.string().min(1)
+    })
+  ).min(1).max(1)
+});
+var updateWallet = async (client, walletId, actions) => {
+  const result = schema5.safeParse({ walletId, actions });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  await client.patch(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/wallets/${walletId}`, actions, {
+    headers: {
+      "Content-Type": "application/json-patch+json"
+    }
+  });
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addCredits,
@@ -151,5 +197,7 @@ var refund = async (client, payload) => {
   getInvoiceById,
   getRefundableAmount,
   getUserCreditsByEntityId,
-  refund
+  getWalletsByEntity,
+  refund,
+  updateWallet
 });

package/dist/index.mjs

@@ -88,7 +88,7 @@ var getRefundableAmount = async (client, invoiceId) => {
 import z6 from "zod";
 var schema4 = z6.object({
   amount: z6.number().min(0).optional(),
-  notes: z6.string().trim().nullable().optional(),
+  note: z6.string().trim().nullable().optional(),
   paymentIntentPspReference: z6.string().trim().min(1).optional()
 });
 var refund = async (client, payload) => {
@@ -98,16 +98,62 @@ var refund = async (client, payload) => {
       cause: result.error.issues
     });
   }
+  const filteredData = Object.fromEntries(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    Object.entries(result.data).filter(([_, value]) => value !== void 0 && value !== null)
+  );
   return client.post(
     `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
-    result.data
+    // filter boolean fields
+    filteredData
   ).then(({ data }) => data);
 };
+
+// src/getWalletsByEntity.ts
+import { z as z7 } from "zod";
+var getWalletsByEntity = async (client, entityId) => {
+  const result = z7.string().trim().min(1).uuid().safeParse(entityId);
+  if (!result.success) {
+    throw new TypeError("Invalid entityId", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/wallet/entity/${entityId}`).then(({ data }) => data);
+};
+
+// src/updateWallet.ts
+import { z as z8 } from "zod";
+var paths = ["/availableAmount", "/percentage"];
+var schema5 = z8.object({
+  walletId: z8.string().trim().min(1).uuid(),
+  actions: z8.array(
+    z8.object({
+      op: z8.enum(["replace"]),
+      path: z8.enum(paths),
+      value: z8.string().min(1)
+    })
+  ).min(1).max(1)
+});
+var updateWallet = async (client, walletId, actions) => {
+  const result = schema5.safeParse({ walletId, actions });
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  await client.patch(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/wallets/${walletId}`, actions, {
+    headers: {
+      "Content-Type": "application/json-patch+json"
+    }
+  });
+};
 export {
   addCredits,
   chargeProduct,
   getInvoiceById,
   getRefundableAmount,
   getUserCreditsByEntityId,
-  refund
+  getWalletsByEntity,
+  refund,
+  updateWallet
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-billing",
-    "version": "1.1.96",
+    "version": "1.1.98",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.1.96",
-        "@vulog/aima-core": "1.1.96"
+        "@vulog/aima-client": "1.1.98",
+        "@vulog/aima-core": "1.1.98"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getWalletsByEntity.ts

@@ -0,0 +1,16 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { Wallet } from './types';
+
+export const getWalletsByEntity = async (client: Client, entityId: string): Promise<Wallet[]> => {
+    const result = z.string().trim().min(1).uuid().safeParse(entityId);
+    if (!result.success) {
+        throw new TypeError('Invalid entityId', {
+            cause: result.error.issues,
+        });
+    }
+    return client
+        .get<Wallet[]>(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/wallet/entity/${entityId}`)
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -5,3 +5,5 @@ export * from './addCredits';
 export * from './getInvoiceById';
 export * from './getRefundableAmount';
 export * from './refund';
+export * from './getWalletsByEntity';
+export * from './updateWallet';

package/src/refund.test.ts

@@ -0,0 +1,50 @@
+import { describe, test, expect, vi, beforeEach, afterEach } from 'vitest';
+import { refund } from './refund';
+import { Client } from '@vulog/aima-client';
+
+describe('refund', () => {
+    const postMock = vi.fn();
+    const client = {
+        post: postMock,
+        clientOptions: {
+            fleetId: 'FLEET_ID',
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    test('should return invalid args', async () => {
+        const payload = {
+            invoiceId: 'INVOICE_ID',
+            amount: -10, // Invalid amount
+        };
+
+        // expect to throw error if invalid args are provided
+        await expect(refund(client, payload)).rejects.toThrow('Invalid args');
+    });
+
+    test('should process refund successfully', async () => {
+        const payload = {
+            invoiceId: 'INVOICE_ID',
+            amount: 50,
+            note: 'Customer requested refund',
+            paymentIntentPspReference: undefined,
+        };
+
+        postMock.mockResolvedValueOnce({
+            data: undefined,
+        });
+
+        const result = await refund(client, payload);
+        expect(result).toBeUndefined();
+        expect(postMock).toHaveBeenCalledWith(
+            `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
+            {
+                amount: 50,
+                note: 'Customer requested refund',
+            }
+        );
+    });
+});

package/src/refund.ts

@@ -5,13 +5,13 @@ import z from 'zod';
 interface Payload {
     invoiceId: string;
     amount?: number;
-    notes?: string | null;
+    note?: string | null;
     paymentIntentPspReference?: string;
 }
 
 const schema = z.object({
     amount: z.number().min(0).optional(),
-    notes: z.string().trim().nullable().optional(),
+    note: z.string().trim().nullable().optional(),
     paymentIntentPspReference: z.string().trim().min(1).optional(),
 });
 
@@ -23,10 +23,16 @@ export const refund = async (client: Client, payload: Payload): Promise<void> =>
         });
     }
 
+    const filteredData = Object.fromEntries(
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        Object.entries(result.data).filter(([_, value]) => value !== undefined && value !== null)
+    );
+
     return client
         .post<void>(
             `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
-            result.data
+            // filter boolean fields
+            filteredData
         )
         .then(({ data }) => data);
 };

package/src/types.ts

@@ -125,3 +125,21 @@ export type RefundableAmount = {
     refundablePaymentReceipts: Receipt[];
     refundedPaymentReceipts: Receipt[];
 };
+
+export type Wallet = {
+    initialAmount: number;
+    validityStartDate: string;
+    validityEndDate: string;
+    notes: string;
+    discountCategory: string;
+    oneTimeUsage: boolean;
+    id: string;
+    availableAmount: number;
+    usedAmount: number;
+    originId: string;
+    entityId: string;
+    creditAlreadyUsed: boolean;
+    updateDate: string;
+    type: string;
+    usage: string;
+};

package/src/updateWallet.test.ts

@@ -0,0 +1,62 @@
+import { describe, test, expect, vi, beforeEach, afterEach } from 'vitest';
+import { PatchAction } from '@vulog/aima-core';
+import { updateWallet, Paths } from './updateWallet';
+
+import { Client } from '@vulog/aima-client';
+
+describe('updateWallet', () => {
+    const patchMock = vi.fn();
+    const client = {
+        patch: patchMock,
+        clientOptions: {
+            fleetId: 'FLEET_ID',
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    test('should return invalid args', async () => {
+        const walletId = 'WALLET_ID';
+        const actions = [
+            {
+                op: 'invalid-op',
+                path: '/availableAmount',
+                value: '100',
+            },
+        ];
+
+        await expect(updateWallet(client, walletId, actions as PatchAction<Paths>[])).rejects.toThrowError();
+    });
+
+    test('should return invalid args with too much entries in the array', async () => {
+        const walletId = 'WALLET_ID';
+        const actions = [
+            {
+                op: 'replace',
+                path: '/availableAmount',
+                value: '100',
+            },
+            {
+                op: 'replace',
+                path: '/percentage',
+                value: '20.50',
+            },
+        ];
+
+        await expect(updateWallet(client, walletId, actions as PatchAction<Paths>[])).rejects.toThrowError();
+    });
+    test('should update wallet successfully', async () => {
+        const walletId = '550e8400-e29b-41d4-a716-446655440000';
+        const actions = [
+            {
+                op: 'replace' as const,
+                path: '/availableAmount' as const,
+                value: '100',
+            },
+        ];
+
+        await expect(updateWallet(client, walletId, actions)).resolves.toBeUndefined();
+    });
+});

package/src/updateWallet.ts

@@ -0,0 +1,35 @@
+import { Client } from '@vulog/aima-client';
+import { PatchAction } from '@vulog/aima-core';
+import { z } from 'zod';
+
+const paths = ['/availableAmount', '/percentage'] as const;
+export type Paths = (typeof paths)[number];
+
+const schema = z.object({
+    walletId: z.string().trim().min(1).uuid(),
+    actions: z
+        .array(
+            z.object({
+                op: z.enum(['replace']),
+                path: z.enum(paths),
+                value: z.string().min(1),
+            })
+        )
+        .min(1)
+        .max(1),
+});
+
+export const updateWallet = async (client: Client, walletId: string, actions: PatchAction<Paths>[]): Promise<void> => {
+    const result = schema.safeParse({ walletId, actions });
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    await client.patch(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/wallets/${walletId}`, actions, {
+        headers: {
+            'Content-Type': 'application/json-patch+json',
+        },
+    });
+};