@zeniai/client-epic-state 5.1.30-betaAK0 → 5.1.30-betaAK1

package/lib/entity/invoicing/invoice/invoicePayload.d.ts

@@ -1,4 +1,4 @@
-import { InvoicingBillingAddress, InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingBillingAddressPayload, InvoicingPriceType } from '../invoicingCommonPayload';
 export type InvoicingInvoiceStatus = 'paid' | 'partially_paid' | 'posted' | 'payment_due' | 'not_paid' | 'voided' | 'pending' | 'draft';
 export interface InvoicingLineItem {
     amount: number;
@@ -54,7 +54,7 @@ export interface InvoicingInvoice {
     amount_due?: number;
     amount_paid?: number;
     amount_to_collect?: number;
-    billing_address?: InvoicingBillingAddress;
+    billing_address?: InvoicingBillingAddressPayload;
     created_at?: string;
     credits_applied?: number;
     currency_code?: string;
@@ -77,7 +77,7 @@ export interface InvoicingInvoice {
     price_type?: InvoicingPriceType;
     recurring?: boolean;
     round_off_amount?: number;
-    shipping_address?: InvoicingBillingAddress;
+    shipping_address?: InvoicingBillingAddressPayload;
     sub_total?: number;
     subscription_id?: string;
     subscription_name?: string;

package/lib/entity/invoicing/invoicingCommonPayload.d.ts

@@ -1,4 +1,4 @@
-export interface InvoicingBillingAddress {
+export interface InvoicingBillingAddressPayload {
     city?: string;
     company?: string;
     country?: string;
@@ -22,7 +22,7 @@ export interface InvoicingPaginatedList<T> {
     items: T[];
     next_cursor: string | null;
 }
-export interface InvoicingSettings {
+export interface InvoicingSettingsPayload {
     accent_color?: string;
     address?: string;
     address_enabled?: boolean;

package/lib/entity/invoicing/invoicingCommonState.d.ts

@@ -0,0 +1,45 @@
+import { ID } from "../../commonStateTypes/common";
+import { ZeniUrl } from '../../zeniUrl';
+export interface InvoicingBillingAddress {
+    city?: string;
+    company?: string;
+    country?: string;
+    email?: string;
+    firstName?: string;
+    lastName?: string;
+    line1?: string;
+    line2?: string;
+    phone?: string;
+    stateCode?: string;
+    validation_status?: 'not_validated' | 'valid' | 'partially_valid' | 'invalid';
+    zip?: string;
+}
+export interface InvoicingSettings {
+    addressEnabled: boolean;
+    autoCollection: 'on' | 'off';
+    chargebeeConnected: boolean;
+    chargebeeSite: string;
+    companyName: string;
+    dateFormat: string;
+    defaultMemo: string;
+    phoneEnabled: boolean;
+    showServicePeriods: boolean;
+    showTaxId: boolean;
+    taxEnabled: boolean;
+    accentColor?: string;
+    address?: InvoicingBillingAddress;
+    dunningMaxAttempts?: number;
+    dunningRetryInterval?: number;
+    email?: string;
+    id?: ID;
+    invoicePrefix?: string;
+    logoUrl?: ZeniUrl;
+    netTermDays?: number;
+    paymentTerms?: string;
+    phone?: string;
+    stripeConnectedAccountId?: ID;
+    stripePublishableKey?: ID;
+    taxId?: ID;
+    taxRate?: number;
+    timezone?: string;
+}

package/lib/entity/invoicing/{customer/customerPayload.d.ts → invoicingCustomer/invoicingCustomerPayload.d.ts}

@@ -1,11 +1,12 @@
-import { InvoicingBillingAddress, InvoicingListCounts } from '../invoicingCommonPayload';
-import { InvoicingSubscription } from '../subscription/subscriptionPayload';
-export interface InvoicingCustomer {
+import { InvoicingBillingAddressPayload, InvoicingListCounts } from '../invoicingCommonPayload';
+import { InvoicingSubscriptionPayload } from '../invoicingSubscription/invoicingSubscriptionPayload';
+import { InvoicingCustomer } from './invoicingCustomerState';
+export interface InvoicingCustomerPayload {
     id: string;
     allow_direct_debit?: boolean;
     arr?: number;
     auto_collection?: 'on' | 'off';
-    billing_address?: InvoicingBillingAddress;
+    billing_address?: InvoicingBillingAddressPayload;
     card_status?: 'no_card' | 'valid' | 'expiring' | 'expired';
     company?: string;
     consolidated_invoicing?: boolean;
@@ -35,7 +36,7 @@ export interface InvoicingCustomer {
     refundable_credits?: number;
     status?: string;
     stripe_customer_id?: string;
-    subscriptions?: InvoicingSubscription[];
+    subscriptions?: InvoicingSubscriptionPayload[];
     taxability?: 'taxable' | 'exempt';
     total_receivable?: number;
     unbilled_charges?: number;
@@ -50,3 +51,4 @@ export interface InvoicingCustomerCounts extends InvoicingListCounts {
     total: number;
     trial: number;
 }
+export declare const mapInvoicingCustomerPayloadToState: (payload: InvoicingCustomerPayload) => InvoicingCustomer;

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerPayload.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingCustomerPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+const invoicingSubscriptionPayload_1 = require("../invoicingSubscription/invoicingSubscriptionPayload");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const DEFAULT_CURRENCY_CODE = 'USD';
+const DEFAULT_CURRENCY_SYMBOL = '$';
+const mapInvoicingCustomerPayloadToState = (payload) => {
+    const currencyCode = payload.preferred_currency_code ?? DEFAULT_CURRENCY_CODE;
+    const currencySymbol = DEFAULT_CURRENCY_SYMBOL;
+    return {
+        id: payload.id,
+        allowDirectDebit: payload.allow_direct_debit,
+        arr: payload.arr != null
+            ? (0, amount_1.toAmount)(payload.arr, currencyCode, currencySymbol)
+            : undefined,
+        autoCollection: payload.auto_collection,
+        billingAddress: payload.billing_address,
+        cardStatus: payload.card_status,
+        company: payload.company,
+        consolidatedInvoicing: payload.consolidated_invoicing,
+        createdAt: payload.created_at != null ? (0, zeniDayJS_1.date)(payload.created_at) : undefined,
+        customerType: payload.customer_type,
+        defaultPaymentMethodID: payload.default_payment_method_id,
+        email: payload.email,
+        excessPayments: payload.excess_payments != null
+            ? (0, amount_1.toAmount)(payload.excess_payments, currencyCode, currencySymbol)
+            : undefined,
+        firstName: payload.first_name,
+        fraudFlag: payload.fraud_flag,
+        initials: payload.initials,
+        invoiceNotes: payload.invoice_notes,
+        isAtRisk: payload.is_at_risk,
+        lastName: payload.last_name,
+        lifetimeValue: payload.lifetime_value != null
+            ? (0, amount_1.toAmount)(payload.lifetime_value, currencyCode, currencySymbol)
+            : undefined,
+        locale: payload.locale,
+        mrr: payload.mrr != null
+            ? (0, amount_1.toAmount)(payload.mrr, currencyCode, currencySymbol)
+            : undefined,
+        netTermDays: payload.net_term_days,
+        paymentMethod: payload.payment_method,
+        paymentMethodLast4: payload.payment_method_last4,
+        paymentMethodType: payload.payment_method_type,
+        phone: payload.phone,
+        plan: payload.plan,
+        planName: payload.plan_name,
+        preferredCurrencyCode: payload.preferred_currency_code,
+        promotionalCredits: payload.promotional_credits != null
+            ? (0, amount_1.toAmount)(payload.promotional_credits, currencyCode, currencySymbol)
+            : undefined,
+        refundableCredits: payload.refundable_credits != null
+            ? (0, amount_1.toAmount)(payload.refundable_credits, currencyCode, currencySymbol)
+            : undefined,
+        status: payload.status,
+        stripeCustomerID: payload.stripe_customer_id,
+        subscriptions: payload.subscriptions?.map(invoicingSubscriptionPayload_1.mapInvoicingSubscriptionPayloadToState),
+        taxability: payload.taxability,
+        totalReceivable: payload.total_receivable != null
+            ? (0, amount_1.toAmount)(payload.total_receivable, currencyCode, currencySymbol)
+            : undefined,
+        unbilledCharges: payload.unbilled_charges != null
+            ? (0, amount_1.toAmount)(payload.unbilled_charges, currencyCode, currencySymbol)
+            : undefined,
+        updatedAt: payload.updated_at != null ? (0, zeniDayJS_1.date)(payload.updated_at) : undefined,
+        vatNumber: payload.vat_number,
+    };
+};
+exports.mapInvoicingCustomerPayloadToState = mapInvoicingCustomerPayloadToState;

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerReducer.d.ts

@@ -0,0 +1,9 @@
+import { UpdateType } from '../../../commonStateTypes/common';
+import { InvoicingCustomerPayload } from './invoicingCustomerPayload';
+import { InvoicingCustomerState } from './invoicingCustomerState';
+export declare const initialState: InvoicingCustomerState;
+export declare const updateInvoicingCustomers: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: InvoicingCustomerPayload[], updateType?: UpdateType | undefined], InvoicingCustomerPayload[], "invoicingCustomer/updateInvoicingCustomers", never, {
+    updateType: UpdateType;
+}>, removeInvoicingCustomer: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, "invoicingCustomer/removeInvoicingCustomer">, clearAllInvoicingCustomers: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"invoicingCustomer/clearAllInvoicingCustomers">;
+declare const _default: import("redux").Reducer<InvoicingCustomerState>;
+export default _default;

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerReducer.js

@@ -0,0 +1,47 @@
+"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.clearAllInvoicingCustomers = exports.removeInvoicingCustomer = exports.updateInvoicingCustomers = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const invoicingCustomerPayload_1 = require("./invoicingCustomerPayload");
+exports.initialState = { customerByID: {} };
+const customer = (0, toolkit_1.createSlice)({
+    name: 'invoicingCustomer',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoicingCustomers: {
+            reducer(draft, action) {
+                doUpdateInvoicingCustomers(draft.customerByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoicingCustomer(draft, action) {
+            delete draft.customerByID[action.payload];
+        },
+        clearAllInvoicingCustomers(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = customer.actions, exports.updateInvoicingCustomers = _a.updateInvoicingCustomers, exports.removeInvoicingCustomer = _a.removeInvoicingCustomer, exports.clearAllInvoicingCustomers = _a.clearAllInvoicingCustomers;
+exports.default = customer.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoicingCustomers(draft, payload, updateType) {
+    payload.forEach((customerPayload) => {
+        const latestCustomer = (0, invoicingCustomerPayload_1.mapInvoicingCustomerPayloadToState)(customerPayload);
+        if (latestCustomer.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestCustomer.id], latestCustomer, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestCustomer.id] = latestCustomer;
+        }
+    });
+}

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerSelector.d.ts

@@ -0,0 +1,4 @@
+import { ID } from '../../../commonStateTypes/common';
+import { InvoicingCustomer, InvoicingCustomerState } from './invoicingCustomerState';
+export declare function getInvoicingCustomersByIds(invoicingCustomerState: InvoicingCustomerState, ids: ID[]): InvoicingCustomer[];
+export declare function getInvoicingCustomerById(invoicingCustomerState: InvoicingCustomerState, id: ID): InvoicingCustomer | undefined;

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerSelector.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.getInvoicingCustomersByIds = getInvoicingCustomersByIds;
+exports.getInvoicingCustomerById = getInvoicingCustomerById;
+const get_1 = __importDefault(require("lodash/get"));
+function getInvoicingCustomersByIds(invoicingCustomerState, ids) {
+    const invoicingCustomers = ids
+        .map((id) => getInvoicingCustomerById(invoicingCustomerState, id))
+        .filter((value) => value != null);
+    return invoicingCustomers;
+}
+function getInvoicingCustomerById(invoicingCustomerState, id) {
+    return (0, get_1.default)(invoicingCustomerState.customerByID, id);
+}

package/lib/entity/invoicing/invoicingCustomer/invoicingCustomerState.d.ts

@@ -0,0 +1,50 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingBillingAddressPayload } from '../invoicingCommonPayload';
+import { InvoicingSubscription } from '../invoicingSubscription/invoicingSubscriptionState';
+export interface InvoicingCustomer {
+    id: ID;
+    allowDirectDebit?: boolean;
+    arr?: Amount;
+    autoCollection?: 'on' | 'off';
+    billingAddress?: InvoicingBillingAddressPayload;
+    cardStatus?: 'no_card' | 'valid' | 'expiring' | 'expired';
+    company?: string;
+    consolidatedInvoicing?: boolean;
+    createdAt?: ZeniDate;
+    customerType?: 'residential' | 'business';
+    defaultPaymentMethodID?: ID;
+    email?: string;
+    excessPayments?: Amount;
+    firstName?: string;
+    fraudFlag?: 'safe' | 'suspicious' | 'fraudulent';
+    initials?: string;
+    invoiceNotes?: string;
+    isAtRisk?: boolean;
+    lastName?: string;
+    lifetimeValue?: Amount;
+    locale?: string;
+    mrr?: Amount;
+    netTermDays?: number;
+    paymentMethod?: string;
+    paymentMethodLast4?: string;
+    paymentMethodType?: 'ach' | 'card' | 'none';
+    phone?: string;
+    plan?: string;
+    planName?: string;
+    preferredCurrencyCode?: string;
+    promotionalCredits?: Amount;
+    refundableCredits?: Amount;
+    status?: string;
+    stripeCustomerID?: ID;
+    subscriptions?: InvoicingSubscription[];
+    taxability?: 'taxable' | 'exempt';
+    totalReceivable?: Amount;
+    unbilledCharges?: Amount;
+    updatedAt?: ZeniDate;
+    vatNumber?: string;
+}
+export interface InvoicingCustomerState {
+    customerByID: Record<ID, InvoicingCustomer>;
+}

package/lib/entity/invoicing/{subscription/subscriptionPayload.d.ts → invoicingSubscription/invoicingSubscriptionPayload.d.ts}

@@ -1,7 +1,8 @@
-import { InvoicingBillingAddress } from '../invoicingCommonPayload';
+import { InvoicingBillingAddressPayload } from '../invoicingCommonPayload';
+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 InvoicingSubscriptionItem {
+export interface InvoicingSubscriptionItemPayload {
     amount?: number;
     billing_cycles?: number;
     catalog_item_id?: string;
@@ -11,13 +12,13 @@ export interface InvoicingSubscriptionItem {
     quantity?: number;
     unit_price?: number;
 }
-export interface InvoicingSubscriptionCoupon {
+export interface InvoicingSubscriptionCouponPayload {
     coupon_id: string;
     applied_count?: number;
     apply_till?: string;
     coupon_code?: string;
 }
-export interface InvoicingContractTerm {
+export interface InvoicingContractTermPayload {
     id: string;
     action_at_term_end?: string;
     auto_renew?: boolean;
@@ -28,7 +29,7 @@ export interface InvoicingContractTerm {
     status?: string;
     total_contract_value?: number;
 }
-export interface InvoicingSubscription {
+export interface InvoicingSubscriptionPayload {
     customer_id: string;
     id: string;
     status: InvoicingSubscriptionStatus;
@@ -40,8 +41,8 @@ export interface InvoicingSubscription {
     cancel_reason?: string;
     cancelled_at?: string;
     catalog_item_id?: string;
-    contract_term?: InvoicingContractTerm;
-    coupons?: InvoicingSubscriptionCoupon[];
+    contract_term?: InvoicingContractTermPayload;
+    coupons?: InvoicingSubscriptionCouponPayload[];
     created_at?: string;
     currency_code?: string;
     current_term_end?: string;
@@ -60,11 +61,15 @@ export interface InvoicingSubscription {
     remaining_billing_cycles?: number;
     resume_date?: string;
     setup_fee?: number;
-    shipping_address?: InvoicingBillingAddress;
+    shipping_address?: InvoicingBillingAddressPayload;
     started_at?: string;
-    subscription_items?: InvoicingSubscriptionItem[];
+    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;
+export declare const mapInvoicingSubscriptionPayloadToState: (payload: InvoicingSubscriptionPayload) => InvoicingSubscription;

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

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapInvoicingSubscriptionPayloadToState = exports.mapInvoicingContractTermPayloadToState = exports.mapInvoicingSubscriptionCouponPayloadToState = exports.mapInvoicingSubscriptionItemPayloadToState = void 0;
+const amount_1 = require("../../../commonStateTypes/amount");
+const zeniDayJS_1 = require("../../../zeniDayJS");
+// ── Payload → State mappers (snake_case wire shape → camelCase domain shape) ──
+const DEFAULT_CURRENCY_CODE = 'USD';
+const DEFAULT_CURRENCY_SYMBOL = '$';
+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,
+    itemPriceID: payload.item_price_id,
+    itemType: payload.item_type,
+    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;
+const mapInvoicingSubscriptionPayloadToState = (payload) => {
+    const currencyCode = payload.currency_code ?? DEFAULT_CURRENCY_CODE;
+    const currencySymbol = DEFAULT_CURRENCY_SYMBOL;
+    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,
+        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,
+        shippingAddress: payload.shipping_address,
+        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,75 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingBillingAddressPayload } from '../invoicingCommonPayload';
+import { InvoicingBillingPeriodUnit, InvoicingSubscriptionStatus } from './invoicingSubscriptionPayload';
+export interface InvoicingSubscriptionItem {
+    amount?: Amount;
+    billingCycles?: number;
+    catalogItemID?: ID;
+    itemName?: string;
+    itemPriceID?: ID;
+    itemType?: 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;
+    remainingBillingCycles?: number;
+    resumeDate?: ZeniDate;
+    setupFee?: Amount;
+    shippingAddress?: InvoicingBillingAddressPayload;
+    startedAt?: ZeniDate;
+    subscriptionItems?: InvoicingSubscriptionItem[];
+    totalDues?: Amount;
+    trialEnd?: ZeniDate;
+    trialStart?: ZeniDate;
+    updatedAt?: ZeniDate;
+}
+export interface InvoicingSubscriptionState {
+    invoicingSubscriptionByID: Record<ID, InvoicingSubscription>;
+}