@zeniai/client-epic-state 5.1.34 → 5.1.35-betaAK0

package/lib/entity/invoicing/invoice/invoiceReducer.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.clearAllInvoices = exports.removeInvoice = exports.updateInvoices = exports.initialState = void 0;
+const toolkit_1 = require("@reduxjs/toolkit");
+const assignWith_1 = __importDefault(require("lodash/assignWith"));
+const invoicePayload_1 = require("./invoicePayload");
+exports.initialState = {
+    invoiceByID: {},
+};
+const invoice = (0, toolkit_1.createSlice)({
+    name: 'invoicingInvoice',
+    initialState: exports.initialState,
+    reducers: {
+        updateInvoices: {
+            reducer(draft, action) {
+                doUpdateInvoices(draft.invoiceByID, action.payload, action.meta.updateType);
+            },
+            prepare(payload, updateType = 'replace') {
+                return { payload, meta: { updateType } };
+            },
+        },
+        removeInvoice(draft, action) {
+            delete draft.invoiceByID[action.payload];
+        },
+        clearAllInvoices(draft) {
+            Object.assign(draft, exports.initialState);
+        },
+    },
+});
+_a = invoice.actions, exports.updateInvoices = _a.updateInvoices, exports.removeInvoice = _a.removeInvoice, exports.clearAllInvoices = _a.clearAllInvoices;
+exports.default = invoice.reducer;
+/**
+ * Helper functions.
+ */
+function doUpdateInvoices(draft, payload, updateType) {
+    payload.forEach((invoicePayload) => {
+        const latestInvoice = (0, invoicePayload_1.mapInvoicingInvoicePayloadToState)(invoicePayload);
+        if (latestInvoice.id in draft && updateType === 'merge') {
+            (0, assignWith_1.default)(draft[latestInvoice.id], latestInvoice, (objValue, srcValue) => (srcValue == null ? objValue : srcValue));
+        }
+        else {
+            draft[latestInvoice.id] = latestInvoice;
+        }
+    });
+}

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

@@ -0,0 +1,5 @@
+import { ID } from '../../../commonStateTypes/common';
+import { RootState } from '../../../reducer';
+import { InvoicingInvoice } from './invoiceState';
+export declare const getInvoiceById: (state: RootState, invoiceId: ID) => InvoicingInvoice | undefined;
+export declare const getInvoicesByIds: (state: RootState, invoiceIds: ID[]) => InvoicingInvoice[];

package/lib/entity/invoicing/invoice/invoiceSelector.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInvoicesByIds = exports.getInvoiceById = void 0;
+const getInvoiceById = (state, invoiceId) => state.invoicingInvoiceState.invoiceByID[invoiceId];
+exports.getInvoiceById = getInvoiceById;
+const getInvoicesByIds = (state, invoiceIds) => invoiceIds
+    .map((id) => state.invoicingInvoiceState.invoiceByID[id])
+    .filter((invoice) => invoice != null);
+exports.getInvoicesByIds = getInvoicesByIds;

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

@@ -0,0 +1,99 @@
+import { Amount } from '../../../commonStateTypes/amount';
+import { ID } from '../../../commonStateTypes/common';
+import { ZeniDate } from '../../../zeniDayJS';
+import { InvoicingBillingAddressPayload, InvoicingPriceType } from '../invoicingCommonPayload';
+import { InvoicingInvoiceStatus } from './invoicePayload';
+export interface InvoicingLineItem {
+    amount: Amount;
+    description: string;
+    quantity: number;
+    unitAmount: Amount;
+    dateFrom?: ZeniDate;
+    dateTo?: ZeniDate;
+    discountAmount?: Amount;
+    entityDescription?: string;
+    entityType?: string;
+    id?: ID;
+    isTaxed?: boolean;
+    itemLevelDiscountAmount?: Amount;
+    subscriptionID?: ID;
+    taxAmount?: Amount;
+    taxExemptReason?: string;
+    taxRate?: number;
+    usagePercentage?: number;
+}
+export interface InvoicingLinkedPayment {
+    appliedAmount: Amount;
+    txnID: ID;
+    appliedAt?: ZeniDate;
+    txnAmount?: Amount;
+    txnDate?: ZeniDate;
+    txnStatus?: string;
+}
+export interface InvoicingIssuedCreditNote {
+    cnID: ID;
+    cnStatus: string;
+    cnTotal: Amount;
+}
+export interface InvoicingDunningAttempt {
+    attempt: number;
+    createdAt?: ZeniDate;
+    dunningType?: string;
+    transactionID?: ID;
+}
+export interface InvoicingInvoiceNote {
+    note: string;
+    entityID?: ID;
+    entityType?: string;
+}
+export interface InvoicingInvoice {
+    customerID: ID;
+    date: ZeniDate;
+    id: ID;
+    status: InvoicingInvoiceStatus;
+    total: Amount;
+    adjustmentCreditNotes?: ID[];
+    amountAdjusted?: Amount;
+    amountDue?: Amount;
+    amountPaid?: Amount;
+    amountToCollect?: Amount;
+    billingAddress?: InvoicingBillingAddressPayload;
+    createdAt?: ZeniDate;
+    creditsApplied?: Amount;
+    currencyCode?: string;
+    customerEmail?: string;
+    customerName?: string;
+    dueDate?: ZeniDate;
+    dunningAttempts?: InvoicingDunningAttempt[];
+    dunningStatus?: string;
+    firstInvoice?: boolean;
+    generatedAt?: ZeniDate;
+    hasAdvanceCharges?: boolean;
+    issuedCreditNotes?: InvoicingIssuedCreditNote[];
+    lineItems?: InvoicingLineItem[];
+    linkedPayments?: InvoicingLinkedPayment[];
+    netTermDays?: number;
+    nextRetryAt?: ZeniDate;
+    notes?: InvoicingInvoiceNote[];
+    paidAt?: ZeniDate;
+    poNumber?: string;
+    priceType?: InvoicingPriceType;
+    recurring?: boolean;
+    roundOffAmount?: Amount;
+    shippingAddress?: InvoicingBillingAddressPayload;
+    subscriptionID?: ID;
+    subscriptionName?: string;
+    subTotal?: Amount;
+    tax?: Amount;
+    updatedAt?: ZeniDate;
+    writeOffAmount?: Amount;
+}
+export interface InvoicingInvoiceKPIs {
+    dueTotal: Amount;
+    paidTotal: Amount;
+    pendingTotal: Amount;
+    totalInvoiced: Amount;
+}
+export interface InvoiceState {
+    invoiceByID: Record<ID, InvoicingInvoice>;
+}

package/lib/entity/invoicing/invoice/invoiceState.js

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

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

@@ -0,0 +1,65 @@
+export interface InvoicingBillingAddressPayload {
+    city?: string;
+    company?: string;
+    country?: string;
+    email?: string;
+    first_name?: string;
+    last_name?: string;
+    line1?: string;
+    line2?: string;
+    phone?: string;
+    state_code?: string;
+    validation_status?: 'not_validated' | 'valid' | 'partially_valid' | 'invalid';
+    zip?: string;
+}
+export type InvoicingPriceType = 'tax_exclusive' | 'tax_inclusive';
+/**
+ * A single select-field option (label + typed value) owned by CES so the value
+ * sets that back string-union domain fields live next to those unions and are
+ * passed to the form views, rather than being hardcoded in web-components.
+ */
+export interface InvoicingFormOption<T extends string = string> {
+    label: string;
+    value: T;
+}
+/** Status -> count map for list tab badges; always includes an `all` total. */
+export type InvoicingListCounts = Record<string, number> & {
+    all: number;
+};
+/** Cursor-paginated list envelope returned by Invoicing list endpoints. */
+export interface InvoicingPaginatedList<T> {
+    items: T[];
+    next_cursor: string | null;
+}
+export interface InvoicingSettingsPayload {
+    accent_color?: string;
+    address?: string;
+    address_enabled?: boolean;
+    auto_collection?: 'on' | 'off';
+    chargebee_connected?: boolean;
+    chargebee_site?: string;
+    company_name?: string;
+    currency?: string;
+    currency_code?: string;
+    date_format?: string;
+    default_memo?: string;
+    dunning_max_attempts?: number;
+    dunning_retry_interval?: number;
+    email?: string;
+    id?: string;
+    invoice_prefix?: string;
+    logo_url?: string;
+    net_term_days?: number;
+    payment_terms?: string;
+    phone?: string;
+    phone_enabled?: boolean;
+    show_service_periods?: boolean;
+    show_tax_id?: boolean;
+    stripe_connected_account_id?: string;
+    stripe_publishable_key?: string;
+    tax_enabled?: boolean;
+    tax_id?: string;
+    tax_rate?: number;
+    timezone?: string;
+    [key: string]: unknown;
+}

package/lib/entity/invoicing/invoicingCommonPayload.js

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

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/invoicingCommonState.js

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

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

@@ -0,0 +1,54 @@
+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?: InvoicingBillingAddressPayload;
+    card_status?: 'no_card' | 'valid' | 'expiring' | 'expired';
+    company?: string;
+    consolidated_invoicing?: boolean;
+    created_at?: string;
+    customer_type?: 'residential' | 'business';
+    default_payment_method_id?: string;
+    email?: string;
+    excess_payments?: number;
+    first_name?: string;
+    fraud_flag?: 'safe' | 'suspicious' | 'fraudulent';
+    initials?: string;
+    invoice_notes?: string;
+    is_at_risk?: boolean;
+    last_name?: string;
+    lifetime_value?: number;
+    locale?: string;
+    mrr?: number;
+    net_term_days?: number;
+    payment_method?: string;
+    payment_method_last4?: string;
+    payment_method_type?: 'ach' | 'card' | 'none';
+    phone?: string;
+    plan?: string;
+    plan_name?: string;
+    preferred_currency_code?: string;
+    promotional_credits?: number;
+    refundable_credits?: number;
+    status?: string;
+    stripe_customer_id?: string;
+    subscriptions?: InvoicingSubscriptionPayload[];
+    taxability?: 'taxable' | 'exempt';
+    total_receivable?: number;
+    unbilled_charges?: number;
+    updated_at?: string;
+    vat_number?: string;
+}
+export interface InvoicingCustomerCounts extends InvoicingListCounts {
+    active: number;
+    at_risk: number;
+    churned: number;
+    not_churned: number;
+    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/invoicingCustomer/invoicingCustomerState.js

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

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

@@ -0,0 +1,75 @@
+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 InvoicingSubscriptionItemPayload {
+    amount?: number;
+    billing_cycles?: number;
+    catalog_item_id?: string;
+    item_name?: string;
+    item_price_id?: string;
+    item_type?: 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;
+    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;
+    remaining_billing_cycles?: number;
+    resume_date?: string;
+    setup_fee?: number;
+    shipping_address?: InvoicingBillingAddressPayload;
+    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;
+export declare const mapInvoicingSubscriptionPayloadToState: (payload: InvoicingSubscriptionPayload) => InvoicingSubscription;