@vulog/aima-billing 1.1.94 → 1.1.96

package/dist/index.d.mts

@@ -72,15 +72,65 @@ type Credit = {
     usage: 'TRIP' | 'REGISTRATION' | 'PRODUCTS' | 'ALL';
     [key: string]: any;
 };
+type Receipt = {
+    id: string;
+    pspName: string;
+    pspReference: string;
+    pspPublishableKey: string;
+    amount: number;
+    currency: string;
+    date: string;
+    status: string;
+    paymentMethodType: string;
+    paymentMethodPspReference: string;
+    paymentIntentPspReference: string;
+    number: number;
+    code: string;
+    declineCode: string;
+    pspClientSecret: string;
+    reason: string;
+    note: string;
+    nextAction: {
+        nextActionRedirectUrl: {
+            url: string;
+            method: string;
+            data: {
+                [key: string]: unknown;
+            };
+        };
+        type: string;
+    };
+    metadatas: {
+        [key: string]: unknown;
+    };
+};
+type RefundableAmount = {
+    invoiceId: string;
+    fleetId: string;
+    refundableAmount: number;
+    currency: string;
+    refundablePaymentReceipts: Receipt[];
+    refundedPaymentReceipts: Receipt[];
+};
 
 declare const chargeProduct: (client: Client, info: ChargeProductInfo) => Promise<Invoice>;
 
 declare const getUserCreditsByEntityId: (client: Client, id: string) => Promise<Credit>;
 
-interface Payload extends Omit<Credit, 'id' | 'availableAmount' | 'usedAmount' | 'originId' | 'creditAlreadyUsed' | 'updateDate'> {
+interface Payload$1 extends Omit<Credit, 'id' | 'availableAmount' | 'usedAmount' | 'originId' | 'creditAlreadyUsed' | 'updateDate'> {
 }
-declare const addCredits: (client: Client, payload: Payload) => Promise<Credit>;
+declare const addCredits: (client: Client, payload: Payload$1) => Promise<Credit>;
 
 declare const getInvoiceById: (client: Client, id: string) => Promise<Invoice>;
 
-export { type ChargeProductInfo, type Credit, type Invoice, addCredits, chargeProduct, getInvoiceById, getUserCreditsByEntityId };
+declare const getRefundableAmount: (client: Client, invoiceId: string) => Promise<RefundableAmount>;
+
+interface Payload {
+    invoiceId: string;
+    amount?: number;
+    notes?: 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 };

package/dist/index.d.ts

@@ -72,15 +72,65 @@ type Credit = {
     usage: 'TRIP' | 'REGISTRATION' | 'PRODUCTS' | 'ALL';
     [key: string]: any;
 };
+type Receipt = {
+    id: string;
+    pspName: string;
+    pspReference: string;
+    pspPublishableKey: string;
+    amount: number;
+    currency: string;
+    date: string;
+    status: string;
+    paymentMethodType: string;
+    paymentMethodPspReference: string;
+    paymentIntentPspReference: string;
+    number: number;
+    code: string;
+    declineCode: string;
+    pspClientSecret: string;
+    reason: string;
+    note: string;
+    nextAction: {
+        nextActionRedirectUrl: {
+            url: string;
+            method: string;
+            data: {
+                [key: string]: unknown;
+            };
+        };
+        type: string;
+    };
+    metadatas: {
+        [key: string]: unknown;
+    };
+};
+type RefundableAmount = {
+    invoiceId: string;
+    fleetId: string;
+    refundableAmount: number;
+    currency: string;
+    refundablePaymentReceipts: Receipt[];
+    refundedPaymentReceipts: Receipt[];
+};
 
 declare const chargeProduct: (client: Client, info: ChargeProductInfo) => Promise<Invoice>;
 
 declare const getUserCreditsByEntityId: (client: Client, id: string) => Promise<Credit>;
 
-interface Payload extends Omit<Credit, 'id' | 'availableAmount' | 'usedAmount' | 'originId' | 'creditAlreadyUsed' | 'updateDate'> {
+interface Payload$1 extends Omit<Credit, 'id' | 'availableAmount' | 'usedAmount' | 'originId' | 'creditAlreadyUsed' | 'updateDate'> {
 }
-declare const addCredits: (client: Client, payload: Payload) => Promise<Credit>;
+declare const addCredits: (client: Client, payload: Payload$1) => Promise<Credit>;
 
 declare const getInvoiceById: (client: Client, id: string) => Promise<Invoice>;
 
-export { type ChargeProductInfo, type Credit, type Invoice, addCredits, chargeProduct, getInvoiceById, getUserCreditsByEntityId };
+declare const getRefundableAmount: (client: Client, invoiceId: string) => Promise<RefundableAmount>;
+
+interface Payload {
+    invoiceId: string;
+    amount?: number;
+    notes?: 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 };

package/dist/index.js

@@ -33,7 +33,9 @@ __export(index_exports, {
   addCredits: () => addCredits,
   chargeProduct: () => chargeProduct,
   getInvoiceById: () => getInvoiceById,
-  getUserCreditsByEntityId: () => getUserCreditsByEntityId
+  getRefundableAmount: () => getRefundableAmount,
+  getUserCreditsByEntityId: () => getUserCreditsByEntityId,
+  refund: () => refund
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -107,10 +109,47 @@ var getInvoiceById = async (client, id) => {
   }
   return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${id}`).then(({ data }) => data);
 };
+
+// src/getRefundableAmount.ts
+var import_zod5 = __toESM(require("zod"));
+var schema3 = import_zod5.default.string().trim().min(1);
+var getRefundableAmount = async (client, invoiceId) => {
+  const result = schema3.safeParse(invoiceId);
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(
+    `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${invoiceId}/refundableAmount`
+  ).then(({ data }) => data);
+};
+
+// src/refund.ts
+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(),
+  paymentIntentPspReference: import_zod6.default.string().trim().min(1).optional()
+});
+var refund = async (client, payload) => {
+  const result = schema4.safeParse(payload);
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.post(
+    `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
+    result.data
+  ).then(({ data }) => data);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addCredits,
   chargeProduct,
   getInvoiceById,
-  getUserCreditsByEntityId
+  getRefundableAmount,
+  getUserCreditsByEntityId,
+  refund
 });

package/dist/index.mjs

@@ -68,9 +68,46 @@ var getInvoiceById = async (client, id) => {
   }
   return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${id}`).then(({ data }) => data);
 };
+
+// src/getRefundableAmount.ts
+import z5 from "zod";
+var schema3 = z5.string().trim().min(1);
+var getRefundableAmount = async (client, invoiceId) => {
+  const result = schema3.safeParse(invoiceId);
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.get(
+    `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${invoiceId}/refundableAmount`
+  ).then(({ data }) => data);
+};
+
+// src/refund.ts
+import z6 from "zod";
+var schema4 = z6.object({
+  amount: z6.number().min(0).optional(),
+  notes: z6.string().trim().nullable().optional(),
+  paymentIntentPspReference: z6.string().trim().min(1).optional()
+});
+var refund = async (client, payload) => {
+  const result = schema4.safeParse(payload);
+  if (!result.success) {
+    throw new TypeError("Invalid args", {
+      cause: result.error.issues
+    });
+  }
+  return client.post(
+    `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
+    result.data
+  ).then(({ data }) => data);
+};
 export {
   addCredits,
   chargeProduct,
   getInvoiceById,
-  getUserCreditsByEntityId
+  getRefundableAmount,
+  getUserCreditsByEntityId,
+  refund
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-billing",
-    "version": "1.1.94",
+    "version": "1.1.96",
     "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.94",
-        "@vulog/aima-core": "1.1.94"
+        "@vulog/aima-client": "1.1.96",
+        "@vulog/aima-core": "1.1.96"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getRefundableAmount.ts

@@ -0,0 +1,22 @@
+import { Client } from '@vulog/aima-client';
+
+import z from 'zod';
+
+import { RefundableAmount } from './types';
+
+const schema = z.string().trim().min(1);
+
+export const getRefundableAmount = async (client: Client, invoiceId: string): Promise<RefundableAmount> => {
+    const result = schema.safeParse(invoiceId);
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    return client
+        .get<RefundableAmount>(
+            `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${invoiceId}/refundableAmount`
+        )
+        .then(({ data }) => data);
+};

package/src/index.ts

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

package/src/refund.ts

@@ -0,0 +1,32 @@
+import { Client } from '@vulog/aima-client';
+
+import z from 'zod';
+
+interface Payload {
+    invoiceId: string;
+    amount?: number;
+    notes?: string | null;
+    paymentIntentPspReference?: string;
+}
+
+const schema = z.object({
+    amount: z.number().min(0).optional(),
+    notes: z.string().trim().nullable().optional(),
+    paymentIntentPspReference: z.string().trim().min(1).optional(),
+});
+
+export const refund = async (client: Client, payload: Payload): Promise<void> => {
+    const result = schema.safeParse(payload);
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    return client
+        .post<void>(
+            `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${payload.invoiceId}/refund`,
+            result.data
+        )
+        .then(({ data }) => data);
+};

package/src/types.ts

@@ -83,3 +83,45 @@ export type Credit = {
     usage: 'TRIP' | 'REGISTRATION' | 'PRODUCTS' | 'ALL';
     [key: string]: any;
 };
+
+export type Receipt = {
+    id: string;
+    pspName: string;
+    pspReference: string;
+    pspPublishableKey: string;
+    amount: number;
+    currency: string;
+    date: string;
+    status: string;
+    paymentMethodType: string;
+    paymentMethodPspReference: string;
+    paymentIntentPspReference: string;
+    number: number;
+    code: string;
+    declineCode: string;
+    pspClientSecret: string;
+    reason: string;
+    note: string;
+    nextAction: {
+        nextActionRedirectUrl: {
+            url: string;
+            method: string;
+            data: {
+                [key: string]: unknown;
+            };
+        };
+        type: string;
+    };
+    metadatas: {
+        [key: string]: unknown;
+    };
+};
+
+export type RefundableAmount = {
+    invoiceId: string;
+    fleetId: string;
+    refundableAmount: number;
+    currency: string;
+    refundablePaymentReceipts: Receipt[];
+    refundedPaymentReceipts: Receipt[];
+};