@zeniai/client-epic-state 5.1.60 → 5.1.61

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload.d.ts

@@ -0,0 +1,85 @@
+import { AddressPayload } from '../../address/addressPayload';
+import { InvoicingContractTerm, InvoicingSubscription, InvoicingSubscriptionCoupon, InvoicingSubscriptionItem } from './invoicingSubscriptionState';
+export type InvoicingSubscriptionStatus = 'active' | 'in_trial' | 'future' | 'non_renewing' | 'paused' | 'cancelled';
+export type InvoicingBillingPeriodUnit = 'day' | 'week' | 'month' | 'year';
+export interface InvoicingSubscriptionItemPayload {
+    amount?: number;
+    billing_cycles?: number;
+    catalog_item_id?: string;
+    item_name?: string;
+    item_price_code?: string;
+    item_price_id?: string;
+    item_type?: string;
+    product_code?: string;
+    quantity?: number;
+    unit_price?: number;
+}
+export interface InvoicingSubscriptionCouponPayload {
+    coupon_id: string;
+    applied_count?: number;
+    apply_till?: string;
+    coupon_code?: string;
+}
+export interface InvoicingContractTermPayload {
+    id: string;
+    action_at_term_end?: string;
+    auto_renew?: boolean;
+    billing_cycle?: number;
+    cancellation_notice_days?: number;
+    contract_end?: string;
+    contract_start?: string;
+    status?: string;
+    total_contract_value?: number;
+}
+export interface InvoicingSubscriptionPayload {
+    customer_id: string;
+    id: string;
+    status: InvoicingSubscriptionStatus;
+    activated_at?: string;
+    auto_collection?: 'on' | 'off';
+    auto_collection_count?: number;
+    billing_period?: number;
+    billing_period_unit?: InvoicingBillingPeriodUnit;
+    cancel_reason?: string;
+    cancelled_at?: string;
+    catalog_item_id?: string;
+    contract_term?: InvoicingContractTermPayload;
+    coupons?: InvoicingSubscriptionCouponPayload[];
+    created_at?: string;
+    currency_code?: string;
+    currency_symbol?: string;
+    current_term_end?: string;
+    current_term_start?: string;
+    customer_name?: string;
+    due_invoices_count?: number;
+    due_since?: string;
+    has_scheduled_changes?: boolean;
+    mrr?: number;
+    next_billing_at?: string;
+    pause_date?: string;
+    plan_amount?: number;
+    plan_id?: string;
+    plan_name?: string;
+    po_number?: string;
+    product_code?: string;
+    remaining_billing_cycles?: number;
+    resume_date?: string;
+    setup_fee?: number;
+    shipping_address?: AddressPayload | null;
+    started_at?: string;
+    subscription_items?: InvoicingSubscriptionItemPayload[];
+    total_dues?: number;
+    trial_end?: string;
+    trial_start?: string;
+    updated_at?: string;
+}
+export declare const mapInvoicingSubscriptionItemPayloadToState: (payload: InvoicingSubscriptionItemPayload, currencyCode: string, currencySymbol: string) => InvoicingSubscriptionItem;
+export declare const mapInvoicingSubscriptionCouponPayloadToState: (payload: InvoicingSubscriptionCouponPayload) => InvoicingSubscriptionCoupon;
+export declare const mapInvoicingContractTermPayloadToState: (payload: InvoicingContractTermPayload, currencyCode: string, currencySymbol: string) => InvoicingContractTerm;
+/**
+ * Collect the embedded shipping addresses from subscription payloads so they can
+ * be pushed into the shared address store (via `updateAddresses`), while the
+ * subscription entity keeps only `shippingAddressId` — mirrors the vendor flow.
+ */
+export declare const extractInvoicingSubscriptionAddresses: (payloads: InvoicingSubscriptionPayload[]) => AddressPayload[];
+export declare const mapInvoicingSubscriptionPayloadToState: (payload: InvoicingSubscriptionPayload) => InvoicingSubscription;

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionPayload.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingSubscriptionPayloadToState = exports.extractInvoicingSubscriptionAddresses = exports.mapInvoicingContractTermPayloadToState = exports.mapInvoicingSubscriptionCouponPayloadToState = exports.mapInvoicingSubscriptionItemPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const currencyHelper_1 = require("../../../commonStateTypes/currencyHelper");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const mapInvoicingSubscriptionItemPayloadToState = (payload, currencyCode, currencySymbol) => ({
+    amount: payload.amount != null
+        ? (0, amount_1.toAmount)(payload.amount, currencyCode, currencySymbol)
+        : undefined,
+    billingCycles: payload.billing_cycles,
+    catalogItemID: payload.catalog_item_id,
+    itemName: payload.item_name,
+    itemPriceCode: payload.item_price_code,
+    itemPriceID: payload.item_price_id,
+    itemType: payload.item_type,
+    productCode: payload.product_code,
+    quantity: payload.quantity,
+    unitPrice: payload.unit_price != null
+        ? (0, amount_1.toAmount)(payload.unit_price, currencyCode, currencySymbol)
+        : undefined,
+});
+exports.mapInvoicingSubscriptionItemPayloadToState = mapInvoicingSubscriptionItemPayloadToState;
+const mapInvoicingSubscriptionCouponPayloadToState = (payload) => ({
+    couponID: payload.coupon_id,
+    appliedCount: payload.applied_count,
+    applyTill: payload.apply_till != null ? (0, zeniDayJS_1.date)(payload.apply_till) : undefined,
+    couponCode: payload.coupon_code,
+});
+exports.mapInvoicingSubscriptionCouponPayloadToState = mapInvoicingSubscriptionCouponPayloadToState;
+const mapInvoicingContractTermPayloadToState = (payload, currencyCode, currencySymbol) => ({
+    id: payload.id,
+    actionAtTermEnd: payload.action_at_term_end,
+    autoRenew: payload.auto_renew,
+    billingCycle: payload.billing_cycle,
+    cancellationNoticeDays: payload.cancellation_notice_days,
+    contractEnd: payload.contract_end != null ? (0, zeniDayJS_1.date)(payload.contract_end) : undefined,
+    contractStart: payload.contract_start != null ? (0, zeniDayJS_1.date)(payload.contract_start) : undefined,
+    status: payload.status,
+    totalContractValue: payload.total_contract_value != null
+        ? (0, amount_1.toAmount)(payload.total_contract_value, currencyCode, currencySymbol)
+        : undefined,
+});
+exports.mapInvoicingContractTermPayloadToState = mapInvoicingContractTermPayloadToState;
+/**
+ * Collect the embedded shipping addresses from subscription payloads so they can
+ * be pushed into the shared address store (via `updateAddresses`), while the
+ * subscription entity keeps only `shippingAddressId` — mirrors the vendor flow.
+ */
+const extractInvoicingSubscriptionAddresses = (payloads) => payloads
+    .map((payload) => payload.shipping_address)
+    .filter((address) => address != null);
+exports.extractInvoicingSubscriptionAddresses = extractInvoicingSubscriptionAddresses;
+const mapInvoicingSubscriptionPayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? currencyHelper_1.defaultCustomerCurrency.currencyCode;
+    const currencySymbol = payload.currency_symbol ?? currencyHelper_1.defaultCustomerCurrency.currencySymbol;
+    return {
+        customerID: payload.customer_id,
+        id: payload.id,
+        status: payload.status,
+        activatedAt: payload.activated_at != null ? (0, zeniDayJS_1.date)(payload.activated_at) : undefined,
+        autoCollection: payload.auto_collection,
+        autoCollectionCount: payload.auto_collection_count,
+        billingPeriod: payload.billing_period,
+        billingPeriodUnit: payload.billing_period_unit,
+        cancelReason: payload.cancel_reason,
+        cancelledAt: payload.cancelled_at != null ? (0, zeniDayJS_1.date)(payload.cancelled_at) : undefined,
+        catalogItemID: payload.catalog_item_id,
+        contractTerm: payload.contract_term != null
+            ? (0, exports.mapInvoicingContractTermPayloadToState)(payload.contract_term, currencyCode, currencySymbol)
+            : undefined,
+        coupons: payload.coupons?.map(exports.mapInvoicingSubscriptionCouponPayloadToState),
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        currencyCode: payload.currency_code,
+        currentTermEnd: payload.current_term_end != null
+            ? (0, zeniDayJS_1.date)(payload.current_term_end)
+            : undefined,
+        currentTermStart: payload.current_term_start != null
+            ? (0, zeniDayJS_1.date)(payload.current_term_start)
+            : undefined,
+        customerName: payload.customer_name,
+        dueInvoicesCount: payload.due_invoices_count,
+        dueSince: payload.due_since != null ? (0, zeniDayJS_1.date)(payload.due_since) : undefined,
+        hasScheduledChanges: payload.has_scheduled_changes,
+        mrr: payload.mrr != null
+            ? (0, amount_1.toAmount)(payload.mrr, currencyCode, currencySymbol)
+            : undefined,
+        nextBillingAt: payload.next_billing_at != null
+            ? (0, zeniDayJS_1.date)(payload.next_billing_at)
+            : undefined,
+        pauseDate: payload.pause_date != null ? (0, zeniDayJS_1.date)(payload.pause_date) : undefined,
+        planAmount: payload.plan_amount != null
+            ? (0, amount_1.toAmount)(payload.plan_amount, currencyCode, currencySymbol)
+            : undefined,
+        planID: payload.plan_id,
+        planName: payload.plan_name,
+        productCode: payload.product_code,
+        poNumber: payload.po_number,
+        remainingBillingCycles: payload.remaining_billing_cycles,
+        resumeDate: payload.resume_date != null ? (0, zeniDayJS_1.date)(payload.resume_date) : undefined,
+        setupFee: payload.setup_fee != null
+            ? (0, amount_1.toAmount)(payload.setup_fee, currencyCode, currencySymbol)
+            : undefined,
+        shippingAddressId: payload.shipping_address != null
+            ? payload.shipping_address.address_id
+            : undefined,
+        startedAt: payload.started_at != null ? (0, zeniDayJS_1.date)(payload.started_at) : undefined,
+        subscriptionItems: payload.subscription_items?.map((item) => (0, exports.mapInvoicingSubscriptionItemPayloadToState)(item, currencyCode, currencySymbol)),
+        totalDues: payload.total_dues != null
+            ? (0, amount_1.toAmount)(payload.total_dues, currencyCode, currencySymbol)
+            : undefined,
+        trialEnd: payload.trial_end != null ? (0, zeniDayJS_1.date)(payload.trial_end) : undefined,
+        trialStart: payload.trial_start != null ? (0, zeniDayJS_1.date)(payload.trial_start) : undefined,
+        updatedAt: payload.updated_at != null ? (0, zeniDayJS_1.date)(payload.updated_at) : undefined,
+    };
+};
+exports.mapInvoicingSubscriptionPayloadToState = mapInvoicingSubscriptionPayloadToState;

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer.d.ts

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingSubscriptionPayload } from './invoicingSubscriptionPayload';
+import { InvoicingSubscriptionState } from './invoicingSubscriptionState';
+export declare const initialState: InvoicingSubscriptionState;
+export declare const updateInvoicingSubscriptions: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingSubscriptionPayload[], updateType?: UpdateType | undefined], InvoicingSubscriptionPayload[], "invoicingSubscription/updateInvoicingSubscriptions", never, {
+    updateType: UpdateType;
+}>, removeInvoicingSubscription: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingSubscription/removeInvoicingSubscription">, clearAllInvoicingSubscriptions: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingSubscription/clearAllInvoicingSubscriptions">;
+declare const _default: import("redux").Reducer<InvoicingSubscriptionState>;
+export default _default;

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionReducer.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoicingSubscriptions = exports.removeInvoicingSubscription = exports.updateInvoicingSubscriptions = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const invoicingSubscriptionPayload_1 = require("./invoicingSubscriptionPayload");
+exports.initialState = {
+    invoicingSubscriptionByID: {},
+};
+const invoicingSubscription = (0, toolkit_1.createSlice)({
+    name: 'invoicingSubscription',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoicingSubscriptions: {
+            reducer(draft, action) {
+                doUpdateInvoicingSubscriptions(draft.invoicingSubscriptionByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoicingSubscription(draft, action) {
+            delete draft.invoicingSubscriptionByID[action.payload];
+        },
+        clearAllInvoicingSubscriptions(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoicingSubscription.actions, exports.updateInvoicingSubscriptions = _a.updateInvoicingSubscriptions, exports.removeInvoicingSubscription = _a.removeInvoicingSubscription, exports.clearAllInvoicingSubscriptions = _a.clearAllInvoicingSubscriptions;
+exports.default = invoicingSubscription.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoicingSubscriptions(draft, payload, updateType) {
+    payload.forEach((subscriptionPayload) => {
+        const latestSubscription = (0, invoicingSubscriptionPayload_1.mapInvoicingSubscriptionPayloadToState)(subscriptionPayload);
+        if (latestSubscription.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestSubscription.id], latestSubscription, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestSubscription.id] = latestSubscription;
+        }
+    });
+}

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector.d.ts

@@ -0,0 +1,5 @@
+import { ID } from '../../../commonStateTypes/common';
+import { InvoicingSubscription } from './invoicingSubscriptionState';
+import { InvoicingSubscriptionState } from './invoicingSubscriptionState';
+export declare function getInvoicingSubscriptionsByIds(invoicingSubscriptionState: InvoicingSubscriptionState, ids: ID[]): InvoicingSubscription[];
+export declare function getInvoicingSubscriptionById(invoicingSubscriptionState: InvoicingSubscriptionState, id: ID): InvoicingSubscription | undefined;

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingSubscriptionsByIds = getInvoicingSubscriptionsByIds;
+exports.getInvoicingSubscriptionById = getInvoicingSubscriptionById;
+const get_1 = __importDefault(require("lodash/get"));
+function getInvoicingSubscriptionsByIds(invoicingSubscriptionState, ids) {
+    const invoicingSubscriptions = ids
+        .map((id) => getInvoicingSubscriptionById(invoicingSubscriptionState, id))
+        .filter((value) => value != null);
+    return invoicingSubscriptions;
+}
+function getInvoicingSubscriptionById(invoicingSubscriptionState, id) {
+    return (0, get_1.default)(invoicingSubscriptionState.invoicingSubscriptionByID, id);
+}

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionState.d.ts

@@ -0,0 +1,77 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingBillingPeriodUnit, InvoicingSubscriptionStatus } from './invoicingSubscriptionPayload';
+export interface InvoicingSubscriptionItem {
+    amount?: Amount;
+    billingCycles?: number;
+    catalogItemID?: ID;
+    itemName?: string;
+    itemPriceCode?: string;
+    itemPriceID?: ID;
+    itemType?: string;
+    productCode?: string;
+    quantity?: number;
+    unitPrice?: Amount;
+}
+export interface InvoicingSubscriptionCoupon {
+    couponID: ID;
+    appliedCount?: number;
+    applyTill?: ZeniDate;
+    couponCode?: string;
+}
+export interface InvoicingContractTerm {
+    id: ID;
+    actionAtTermEnd?: string;
+    autoRenew?: boolean;
+    billingCycle?: number;
+    cancellationNoticeDays?: number;
+    contractEnd?: ZeniDate;
+    contractStart?: ZeniDate;
+    status?: string;
+    totalContractValue?: Amount;
+}
+export interface InvoicingSubscription {
+    customerID: ID;
+    id: ID;
+    status: InvoicingSubscriptionStatus;
+    activatedAt?: ZeniDate;
+    autoCollection?: 'on' | 'off';
+    autoCollectionCount?: number;
+    billingPeriod?: number;
+    billingPeriodUnit?: InvoicingBillingPeriodUnit;
+    cancelledAt?: ZeniDate;
+    cancelReason?: string;
+    catalogItemID?: ID;
+    contractTerm?: InvoicingContractTerm;
+    coupons?: InvoicingSubscriptionCoupon[];
+    createdAt?: ZeniDate;
+    currencyCode?: string;
+    currentTermEnd?: ZeniDate;
+    currentTermStart?: ZeniDate;
+    customerName?: string;
+    dueInvoicesCount?: number;
+    dueSince?: ZeniDate;
+    hasScheduledChanges?: boolean;
+    mrr?: Amount;
+    nextBillingAt?: ZeniDate;
+    pauseDate?: ZeniDate;
+    planAmount?: Amount;
+    planID?: ID;
+    planName?: string;
+    poNumber?: string;
+    productCode?: string;
+    remainingBillingCycles?: number;
+    resumeDate?: ZeniDate;
+    setupFee?: Amount;
+    shippingAddressId?: ID;
+    startedAt?: ZeniDate;
+    subscriptionItems?: InvoicingSubscriptionItem[];
+    totalDues?: Amount;
+    trialEnd?: ZeniDate;
+    trialStart?: ZeniDate;
+    updatedAt?: ZeniDate;
+}
+export interface InvoicingSubscriptionState {
+    invoicingSubscriptionByID: Record<ID, InvoicingSubscription>;
+}

package/lib/entity/invoicing/invoicingSubscription/invoicingSubscriptionState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionPayload.d.ts

@@ -0,0 +1,52 @@
+import { InvoicingTransaction } from './invoicingTransactionState';
+export type InvoicingTransactionType = 'payment' | 'refund' | 'authorization' | 'payment_reversal';
+export type InvoicingTransactionStatus = 'in_progress' | 'success' | 'voided' | 'failure' | 'timeout' | 'needs_attention' | 'late_failure' | 'failed';
+export interface InvoicingLinkedInvoiceRefPayload {
+    applied_amount: number;
+    invoice_id: string;
+    invoice_number: string;
+    invoice_status?: string;
+}
+export interface InvoicingLinkedRefundPayload {
+    txn_amount: number;
+    txn_id: string;
+    txn_status: string;
+}
+export interface InvoicingLinkedCreditNoteRefPayload {
+    applied_amount: number;
+    cn_id: string;
+}
+export interface InvoicingTransactionPayload {
+    amount: number;
+    id: string;
+    amount_capturable?: number;
+    amount_unused?: number;
+    currency_code?: string;
+    currency_symbol?: string;
+    customer?: string;
+    customer_id?: string;
+    customer_name?: string;
+    date?: string;
+    error_code?: string;
+    error_text?: string;
+    fraud_flag?: string;
+    fraud_reason?: string;
+    gateway?: string;
+    gateway_account_id?: string;
+    id_at_gateway?: string;
+    invoice_id?: string;
+    linked_credit_notes?: InvoicingLinkedCreditNoteRefPayload[];
+    linked_invoices?: InvoicingLinkedInvoiceRefPayload[];
+    linked_refunds?: InvoicingLinkedRefundPayload[];
+    masked_card_number?: string;
+    payment_method?: string;
+    payment_source_id?: string;
+    reference_number?: string;
+    refunded_txn_id?: string;
+    settled_at?: string;
+    status?: InvoicingTransactionStatus;
+    subscription_id?: string;
+    three_d_secure?: boolean;
+    type?: InvoicingTransactionType;
+}
+export declare const mapInvoicingTransactionPayloadToState: (payload: InvoicingTransactionPayload) => InvoicingTransaction;

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionPayload.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingTransactionPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const currencyHelper_1 = require("../../../commonStateTypes/currencyHelper");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const mapLinkedInvoiceRef = (payload, currencyCode, currencySymbol) => ({
+    appliedAmount: (0, amount_1.toAmount)(payload.applied_amount, currencyCode, currencySymbol),
+    invoiceID: payload.invoice_id,
+    invoiceNumber: payload.invoice_number,
+    invoiceStatus: payload.invoice_status,
+});
+const mapLinkedRefund = (payload, currencyCode, currencySymbol) => ({
+    txnAmount: (0, amount_1.toAmount)(payload.txn_amount, currencyCode, currencySymbol),
+    txnID: payload.txn_id,
+    txnStatus: payload.txn_status,
+});
+const mapLinkedCreditNoteRef = (payload, currencyCode, currencySymbol) => ({
+    appliedAmount: (0, amount_1.toAmount)(payload.applied_amount, currencyCode, currencySymbol),
+    cnID: payload.cn_id,
+});
+const mapInvoicingTransactionPayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? currencyHelper_1.defaultCustomerCurrency.currencyCode;
+    const currencySymbol = payload.currency_symbol ?? currencyHelper_1.defaultCustomerCurrency.currencySymbol;
+    const toAmt = (value) => (0, amount_1.toAmount)(value, currencyCode, currencySymbol);
+    return {
+        amount: toAmt(payload.amount),
+        id: payload.id,
+        amountCapturable: payload.amount_capturable != null
+            ? toAmt(payload.amount_capturable)
+            : undefined,
+        amountUnused: payload.amount_unused != null ? toAmt(payload.amount_unused) : undefined,
+        currencyCode: payload.currency_code,
+        customer: payload.customer,
+        customerID: payload.customer_id,
+        customerName: payload.customer_name,
+        date: payload.date != null ? (0, zeniDayJS_1.date)(payload.date) : undefined,
+        errorCode: payload.error_code,
+        errorText: payload.error_text,
+        fraudFlag: payload.fraud_flag,
+        fraudReason: payload.fraud_reason,
+        gateway: payload.gateway,
+        gatewayAccountID: payload.gateway_account_id,
+        idAtGateway: payload.id_at_gateway,
+        invoiceID: payload.invoice_id,
+        linkedCreditNotes: payload.linked_credit_notes?.map((ref) => mapLinkedCreditNoteRef(ref, currencyCode, currencySymbol)),
+        linkedInvoices: payload.linked_invoices?.map((ref) => mapLinkedInvoiceRef(ref, currencyCode, currencySymbol)),
+        linkedRefunds: payload.linked_refunds?.map((ref) => mapLinkedRefund(ref, currencyCode, currencySymbol)),
+        maskedCardNumber: payload.masked_card_number,
+        paymentMethod: payload.payment_method,
+        paymentSourceID: payload.payment_source_id,
+        referenceNumber: payload.reference_number,
+        refundedTxnID: payload.refunded_txn_id,
+        settledAt: payload.settled_at != null ? (0, zeniDayJS_1.date)(payload.settled_at) : undefined,
+        status: payload.status,
+        subscriptionID: payload.subscription_id,
+        threeDSecure: payload.three_d_secure,
+        type: payload.type,
+    };
+};
+exports.mapInvoicingTransactionPayloadToState = mapInvoicingTransactionPayloadToState;

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionReducer.d.ts

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingTransactionPayload } from './invoicingTransactionPayload';
+import { InvoicingTransactionState } from './invoicingTransactionState';
+export declare const initialState: InvoicingTransactionState;
+export declare const updateInvoicingTransactions: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingTransactionPayload[], updateType?: UpdateType | undefined], InvoicingTransactionPayload[], "invoicingTransaction/updateInvoicingTransactions", never, {
+    updateType: UpdateType;
+}>, removeInvoicingTransaction: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingTransaction/removeInvoicingTransaction">, clearAllInvoicingTransactions: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingTransaction/clearAllInvoicingTransactions">;
+declare const _default: import("redux").Reducer<InvoicingTransactionState>;
+export default _default;

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionReducer.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearAllInvoicingTransactions = exports.removeInvoicingTransaction = exports.updateInvoicingTransactions = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const invoicingTransactionPayload_1 = require("./invoicingTransactionPayload");
+exports.initialState = {
+    invoicingTransactionByID: {},
+};
+const invoicingTransaction = (0, toolkit_1.createSlice)({
+    name: 'invoicingTransaction',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoicingTransactions: {
+            reducer(draft, action) {
+                doUpdateInvoicingTransactions(draft.invoicingTransactionByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoicingTransaction(draft, action) {
+            delete draft.invoicingTransactionByID[action.payload];
+        },
+        clearAllInvoicingTransactions(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoicingTransaction.actions, exports.updateInvoicingTransactions = _a.updateInvoicingTransactions, exports.removeInvoicingTransaction = _a.removeInvoicingTransaction, exports.clearAllInvoicingTransactions = _a.clearAllInvoicingTransactions;
+exports.default = invoicingTransaction.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoicingTransactions(draft, payload, updateType) {
+    payload.forEach((invoicingTransactionPayload) => {
+        const latestInvoicingTransaction = (0, invoicingTransactionPayload_1.mapInvoicingTransactionPayloadToState)(invoicingTransactionPayload);
+        if (latestInvoicingTransaction.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestInvoicingTransaction.id], latestInvoicingTransaction, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestInvoicingTransaction.id] = latestInvoicingTransaction;
+        }
+    });
+}

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionSelector.d.ts

@@ -0,0 +1,4 @@
+import { ID } from '../../../commonStateTypes/common';
+import { InvoicingTransaction, InvoicingTransactionState } from './invoicingTransactionState';
+export declare function getInvoicingTransactionsByIds(invoicingTransactionState: InvoicingTransactionState, ids: ID[]): InvoicingTransaction[];
+export declare function getInvoicingTransactionById(invoicingTransactionState: InvoicingTransactionState, id: ID): InvoicingTransaction | undefined;

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionSelector.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicingTransactionsByIds = getInvoicingTransactionsByIds;
+exports.getInvoicingTransactionById = getInvoicingTransactionById;
+const get_1 = __importDefault(require("lodash/get"));
+function getInvoicingTransactionsByIds(invoicingTransactionState, ids) {
+    const invoicingTransactions = ids
+        .map((id) => getInvoicingTransactionById(invoicingTransactionState, id))
+        .filter((value) => value != null);
+    return invoicingTransactions;
+}
+function getInvoicingTransactionById(invoicingTransactionState, id) {
+    return (0, get_1.default)(invoicingTransactionState.invoicingTransactionByID, id);
+}

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionState.d.ts

@@ -0,0 +1,54 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingTransactionStatus, InvoicingTransactionType } from './invoicingTransactionPayload';
+export interface InvoicingLinkedInvoiceRef {
+    appliedAmount: Amount;
+    invoiceID: ID;
+    invoiceNumber: string;
+    invoiceStatus?: string;
+}
+export interface InvoicingLinkedRefund {
+    txnAmount: Amount;
+    txnID: ID;
+    txnStatus: string;
+}
+export interface InvoicingLinkedCreditNoteRef {
+    appliedAmount: Amount;
+    cnID: ID;
+}
+export interface InvoicingTransaction {
+    amount: Amount;
+    id: ID;
+    amountCapturable?: Amount;
+    amountUnused?: Amount;
+    currencyCode?: string;
+    customer?: string;
+    customerID?: ID;
+    customerName?: string;
+    date?: ZeniDate;
+    errorCode?: string;
+    errorText?: string;
+    fraudFlag?: string;
+    fraudReason?: string;
+    gateway?: string;
+    gatewayAccountID?: string;
+    idAtGateway?: string;
+    invoiceID?: ID;
+    linkedCreditNotes?: InvoicingLinkedCreditNoteRef[];
+    linkedInvoices?: InvoicingLinkedInvoiceRef[];
+    linkedRefunds?: InvoicingLinkedRefund[];
+    maskedCardNumber?: string;
+    paymentMethod?: string;
+    paymentSourceID?: string;
+    referenceNumber?: string;
+    refundedTxnID?: ID;
+    settledAt?: ZeniDate;
+    status?: InvoicingTransactionStatus;
+    subscriptionID?: ID;
+    threeDSecure?: boolean;
+    type?: InvoicingTransactionType;
+}
+export interface InvoicingTransactionState {
+    invoicingTransactionByID: Record<ID, InvoicingTransaction>;
+}

package/lib/entity/invoicing/invoicingTransaction/invoicingTransactionState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });