@metrifox/react-sdk 0.0.6 → 0.0.8

package/dist/index.d.ts

@@ -7,10 +7,28 @@ interface MetrifoxInitConfig {
 }
 declare const metrifoxInit: (config: MetrifoxInitConfig) => void;
 
+declare enum ResetIntervals {
+    NONE = "none",
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly",
+    QUARTERLY = "quarterly",
+    YEARLY = "yearly",
+    BI_ANNUALLY = "biannually"
+}
 declare enum FeatureType {
     BOOLEAN = "boolean",
     METERED = "metered"
 }
+declare enum FeatureStatus {
+    ARCHIVED = "archived",
+    ACTIVE = "active",
+    ALL = "all"
+}
+declare enum EnforcementType {
+    SOFT = "soft",
+    HARD = "hard"
+}
 declare enum SubscriptionStatus {
     ACTIVE = "active",
     IN_TRIAL = "in_trial",
@@ -19,6 +37,17 @@ declare enum SubscriptionStatus {
     DEACTIVATED = "deactivated",
     PAUSED = "paused"
 }
+declare enum PriceTypes {
+    ONE_OFF = "OneOff",
+    FIXED_RECURRING = "RecurringFixed",
+    USAGE_BASED = "UsageBased"
+}
+declare enum OneOffType {
+    PER_UNIT = "per_unit",
+    PER_PACKAGE = "per_package",
+    FLAT = "flat",
+    PERCENTAGE = "percentage"
+}
 
 type SectionKey = "upcomingInvoice" | "subscription" | "creditBalance" | "entitlementUsage" | "paymentOverview" | "billingHistory" | "plan";
 interface CustomerPortalProps {
@@ -132,7 +161,197 @@ interface ICustomerDetails {
     tenant_checkout_username: string;
 }
 type InvoiceStatus = "draft" | "pending" | "open" | "voided" | "paid" | "written_off" | "refunded" | "overdue" | "due";
+interface Offering {
+    created_at: string;
+    description: string;
+    display_text: string;
+    id: string;
+    metadata: null;
+    name: string;
+    offering_id: string;
+    offering_type: string;
+    offering_key: string;
+    status: string;
+    updated_at: string;
+    version_number: number;
+    checkout_url: string | null;
+    is_visible: boolean;
+    is_free: boolean;
+    is_custom: boolean;
+    is_current_plan: boolean;
+    custom_cta_text: string | null;
+    custom_cta_url: string | null;
+    base_entitlement_plan_name: string | null;
+    trial_duration_unit: string | null;
+    trial_duration_value: number | null;
+    price_options: PriceOption[];
+    entitlements: Entitlement[];
+    base_entitlements: Entitlement[];
+    entitlement_price_options: PriceOption[];
+    credit_attachment_price_options: PriceOption[];
+    credit_attachments: CreditSystemProps[];
+    base_entitlements_plan_name: string;
+    version_id: string;
+    is_invoiceable: boolean;
+}
+interface PriceOption {
+    metadata: Record<string, string>;
+    id: string;
+    owner_type: "OfferingVersion" | string;
+    price_type: PriceTypes;
+    price_owner: PriceOwner;
+    price: Price;
+    created_at: string;
+    updated_at: string;
+}
+interface PriceOwner {
+    id: string;
+    name: string;
+    offering_id: string;
+    display_text: string;
+    description: string;
+    charge_key: string;
+    charge_model: string;
+    metadata: Record<string, string> | null;
+    created_by: string;
+    updated_by: string | null;
+    deleted_by: string | null;
+    created_at: string;
+    updated_at: string;
+    deleted_at: string | null;
+    tenant_id: string;
+    price_option_id: string;
+}
+interface CreditOwner {
+    id: string;
+    name: string;
+    key: string;
+    description: string;
+    status: string;
+    credit_system_id: string;
+    credit_unit_singular: string;
+    credit_unit_plural: string;
+    unit_singular: string;
+    unit_plural: string;
+    price_options: PriceOption[];
+}
+interface CreditSystemProps {
+    status: FeatureStatus;
+    id: string;
+    name?: string;
+    credit_name: string;
+    credit_key: string;
+    credit_system_id: string;
+    credit_unit_singular: string;
+    credit_unit_plural: string;
+    source_type: string;
+    source_id: string;
+    use_default_price: boolean;
+    topup_enabled: boolean;
+    reset_interval: string;
+    included_usage: number;
+    carryover_enabled: boolean;
+    carryover_action: string;
+    expiry_value: number | null;
+    expiry_interval: number | null;
+    can_expire: boolean;
+    is_mandatory: boolean;
+    low_balance_threshold: number | null;
+    display_text: string | null;
+    included_usage_text: string;
+    price_options: PriceOption[];
+    tiers: Tier[];
+}
+interface Price {
+    id: string;
+    name: string;
+    currency: string;
+    price: number;
+    price_type: string;
+    tax_inclusion: "inclusive" | "exclusive" | string;
+    tax_type: string | null;
+    tax_rate: number | null;
+    billing_interval: "monthly" | "yearly" | string;
+    billing_interval_value: number;
+    trial_period: string | null;
+    trial_period_value: number;
+    invoice_timing: "in_advance" | "in_arrears" | string;
+    unit_label: string;
+    unit_per_package: number;
+    created_at: string;
+    type: PriceTypes;
+    updated_at: string;
+    package_name: string;
+    is_custom: boolean;
+    entitlement: Entitlement;
+    tiers?: Tier[];
+    tier_type: string;
+    owner: Entitlement | CreditOwner;
+}
+interface Tier {
+    pricing_model: OneOffType;
+    first_unit: number;
+    last_unit: number;
+    unit_price: number;
+    package_price: number;
+    package_size: number | null;
+    percentage: number;
+    min_price: number | null;
+    max_price: number | null;
+    flat_fee: number | null;
+}
+interface Entitlement {
+    carryover_enabled: boolean;
+    id: string;
+    name?: string;
+    enforcement_type: EnforcementType;
+    reset_interval: ResetIntervals;
+    reset_anchor: string;
+    display_text: string;
+    price_display_text: string;
+    quota: number;
+    included_usage: number;
+    carryover_action: string;
+    override_quota: number | null;
+    feature: Feature;
+    is_visible: boolean;
+    offering_version_id: string;
+    credit_key?: string;
+    credit_cost?: number | null;
+    pre_paid_credit_system_id?: string;
+    min_purchase_quantity?: number;
+}
+interface Feature {
+    id: string;
+    key: string;
+    name: string;
+    description: string;
+    feature_type: FeatureType;
+    usage_model: string;
+    event_names: string;
+    aggregation_method: string;
+    unit_singular: string;
+    unit_plural: string;
+    status: FeatureStatus;
+    created_at: string;
+}
 
 declare const CustomerPortal: ({ customerKey, sectionsConfig }: CustomerPortalProps) => react_jsx_runtime.JSX.Element;
 
-export { CustomerPortal, metrifoxInit };
+declare const PriceCard: ({ plan, interval, featureOrderMap, isPricePage, isCustomerPortal, statusTag, addPriceButton, buttonText, isCurrentPlan, planActions, cardAction, buttonAction, }: {
+    plan: Offering;
+    interval: string;
+    featureOrderMap: Map<string, number>;
+    isPricePage?: boolean;
+    isCustomerPortal?: boolean;
+    statusTag?: React.ReactNode;
+    addPriceButton?: React.ReactNode;
+    buttonText?: string;
+    isCurrentPlan?: boolean;
+    planActions?: React.ReactNode;
+    cardAction?: () => void;
+    buttonAction?: () => void;
+}) => react_jsx_runtime.JSX.Element | null;
+
+export { CustomerPortal, PriceCard, metrifoxInit };
+export type { Offering as ProductOffering };