@metrifox/angular-sdk 1.0.0

package/lib/types/interface.d.ts

@@ -0,0 +1,739 @@
+import { Type } from '@angular/core';
+import { FeatureType, FeatureStatus, SubscriptionStatus, InvoiceStatusType, PriceTypes, ResetIntervals, EnforcementType, AggregationMethods, BillingTimingTypes, FeatureModel, OneOffType, PoolType } from './enum';
+/**
+ * Main theme configuration
+ */
+export interface Theme {
+    pricingTable?: PricingTableTheme;
+    customerPortal?: CustomerPortalTheme;
+}
+/**
+ * Customer Portal theme configuration
+ */
+export interface CustomerPortalTheme {
+    tabs?: {
+        background?: string;
+        borderColor?: string;
+        activeBackground?: string;
+        activeTextColor?: string;
+        inactiveTextColor?: string;
+    };
+    section?: {
+        background?: string;
+        titleTextColor?: string;
+        contentBackground?: string;
+        iconBackground?: string;
+        iconColor?: string;
+        emptyTextColor?: string;
+    };
+    card?: {
+        titleBackground?: string;
+        contentBackground?: string;
+        titleColor?: string;
+        details?: {
+            labelColor?: string;
+            valueColor?: string;
+        };
+    };
+    subscription?: {
+        items?: {
+            background?: string;
+            borderColor?: string;
+            textColor?: string;
+        };
+    };
+    table?: {
+        headerTextColor?: string;
+        textColor?: string;
+    };
+    button?: {
+        background?: string;
+        textColor?: string;
+    };
+    filter?: {
+        border?: string;
+        activeBackground?: string;
+        inactiveBackground?: string;
+        activeTextColor?: string;
+        inactiveTextColor?: string;
+        countBackground?: string;
+        countTextColor?: string;
+    };
+    linkColor?: string;
+    plan?: PricingTableTheme;
+}
+/**
+ * Pricing Table theme configuration
+ */
+export interface PricingTableTheme {
+    card?: CardTheme;
+    button?: ButtonTheme;
+    featureList?: FeatureListTheme;
+    tabs?: TabsTheme;
+    intervalToggle?: IntervalToggleTheme;
+    currentSubscriptionCard?: CurrentSubscriptionCardTheme;
+    freeTrialTag?: FreeTrialTheme;
+    checkoutBar?: CheckoutBarTheme;
+}
+export interface CardTheme {
+    background?: string;
+    borderColor?: string;
+    descriptionColor?: string;
+    header?: CardHeaderTheme;
+    description?: CardDescriptionTheme;
+    price?: CardPriceTheme;
+}
+export interface CardHeaderTheme {
+    background?: string;
+    textColor?: string;
+}
+export interface CardDescriptionTheme {
+    textColor?: string;
+    textButtonColor?: string;
+}
+export interface CardPriceTheme {
+    amountColor?: string;
+    primaryTextColor?: string;
+    secondaryTextColor?: string;
+    textButtonColor?: string;
+    background?: string;
+    borderColor?: string;
+}
+export interface ButtonTheme {
+    background?: string;
+    textColor?: string;
+    secondaryBackground?: string;
+    secondaryTextColor?: string;
+    textButtonColor?: string;
+}
+export interface FeatureListTheme {
+    textColor?: string;
+    iconColor?: string;
+}
+export interface TabsTheme {
+    inactiveText?: string;
+    activeText?: string;
+    indicator?: string;
+    borderColor?: string;
+}
+export interface IntervalToggleTheme {
+    background?: string;
+    activeBackground?: string;
+    activeText?: string;
+    inactiveText?: string;
+}
+export interface CurrentSubscriptionCardTheme {
+    header?: CardHeaderTheme;
+    gradientColor?: string;
+}
+export interface FreeTrialTheme {
+    background?: string;
+    textColor?: string;
+}
+export interface CheckoutBarTheme {
+    background?: string;
+    borderColor?: string;
+    textColor?: string;
+    buttonBackground?: string;
+    buttonTextColor?: string;
+}
+/**
+ * Metrifox SDK initialization configuration
+ */
+export interface MetrifoxConfig {
+    /** Client API key */
+    clientKey: string;
+    /** Optional base URL for API calls */
+    baseUrl?: string;
+    /** Optional web app URL for checkout redirects */
+    webAppUrl?: string;
+    /** Theme configuration */
+    theme?: Theme;
+}
+/**
+ * Section key types for Customer Portal
+ */
+export type SectionKey = 'upcomingInvoice' | 'subscription' | 'creditBalance' | 'entitlementUsage' | 'paymentOverview' | 'billingHistory' | 'plan';
+/**
+ * Customer Portal component props
+ */
+export interface CustomerPortalProps {
+    customerKey: string;
+    sectionsConfig?: SectionConfig[];
+}
+/**
+ * Section configuration for Customer Portal
+ */
+export interface SectionConfig {
+    key: SectionKey;
+    label?: string;
+    hidden?: boolean;
+    component?: Type<unknown>;
+    props?: Record<string, unknown>;
+}
+/**
+ * Customer details response
+ */
+export interface CustomerDetails {
+    customer_key: string;
+    metrifox_id: string;
+    billing_address: BillingAddress | null;
+    billing_email: string;
+    currency: string;
+    customer_type: string;
+    display_name: string;
+    full_name: string;
+    language: string;
+    primary_email: string;
+    primary_phone?: string;
+    phone_numbers?: {
+        phone_number: string;
+    }[];
+    timezone: string;
+    subscriptions: Subscription[];
+    tenant_checkout_username: string;
+}
+export interface BillingAddress {
+    address_line_one?: string;
+    address_line_two?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    zip_code?: string;
+}
+/**
+ * Subscription data
+ */
+export interface Subscription {
+    product_key: string;
+    product_name: string;
+    entitlements: Entitlement[];
+    subscription: SubscriptionDetails;
+    payment_method: PaymentMethod | null;
+}
+export interface SubscriptionDetails {
+    id: string;
+    created_at: string;
+    currency_code: string;
+    current_billing_period_start: string | null;
+    current_billing_period_end: string | null;
+    ends_at: string | null;
+    starts_at: string | null;
+    trial_end_date: string | null;
+    next_billing_amount: number;
+    next_billing_date: string;
+    plan_name: string;
+    offering_key: string;
+    plan_version: number;
+    product_name: string;
+    status: SubscriptionStatus;
+    renews_at: string;
+    subscription_items: SubscriptionItem[];
+    upcoming_invoice: UpcomingInvoice | null;
+    can_update_quantities: boolean;
+}
+export interface SubscriptionItem {
+    price_option_id: string;
+    name: string;
+    currency_code: string;
+    quantity: number;
+    unit_price: number;
+    total_amount: number;
+    billing_period_start: string | null;
+    billing_period_end: string | null;
+    line_source_type: string;
+    is_addon?: boolean;
+}
+export interface UpcomingInvoice {
+    invoice_id: string;
+    invoice_number: string;
+    amount: string;
+    currency: Currency;
+    due_date: string;
+    status: InvoiceStatus;
+}
+export type InvoiceStatus = 'draft' | 'pending' | 'open' | 'voided' | 'paid' | 'written_off' | 'refunded' | 'overdue' | 'due';
+export interface Currency {
+    id: string;
+    code: string;
+    name: string;
+    country: string;
+    decimal_places: number;
+    symbol: string;
+    is_active: boolean;
+    base_unit_name: string;
+    base_unit_per_standard: number;
+    created_at: string;
+    updated_at: string;
+    country_code: string;
+}
+export interface PaymentMethod {
+    type: string;
+    brand: string;
+    last4: number;
+    exp_month: number;
+    exp_year: number;
+    display_name: string;
+}
+export interface Entitlement {
+    id: string;
+    carryover_quantity?: number;
+    included_usage: number;
+    name?: string;
+    next_reset_at?: string;
+    quota: string | number;
+    reset_interval: ResetIntervals | null;
+    used_quantity?: number;
+    feature_type: FeatureType;
+    enforcement_type?: EnforcementType;
+    reset_anchor?: string;
+    display_text?: string;
+    price_display_text?: string;
+    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;
+    carryover_enabled?: boolean;
+}
+export 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;
+}
+export interface EntitlementUsage {
+    id: string;
+    feature_name: string;
+    feature_key: string;
+    type: string;
+    included_pool: Pool | null;
+    purchased_pool: Pool | null;
+    pay_as_you_go_pool: Pool | null;
+    rollover_quantity_pool: Pool | null;
+}
+export interface Pool {
+    balance: string;
+    used: string;
+    amount: string | null;
+    next_reset_at?: string;
+}
+export interface ProcessedPool {
+    pool: PoolType;
+    balance: number;
+    used: number;
+    amount: number;
+    color: string;
+    percent: number;
+    isUnlimited: boolean;
+    order: number;
+    nextResetAt?: string;
+}
+export interface EntitlementSummary {
+    id: string;
+    subscription_id: string;
+    customer_id: string;
+    tenant_id: string;
+    customer_key: string;
+    active: boolean;
+    subscription_item_id: string | null;
+    purchased_qty: number | null;
+    billing_interval: ResetIntervals | null;
+    feature_name: string;
+    feature_key: string;
+    soft_limit_enabled: boolean;
+    included_allowance: number | null;
+    included_allowance_reset_interval: ResetIntervals;
+    included_allowance_reset_anchor: string;
+    usage_limit: string | number | null;
+    usage_limit_reset_interval: ResetIntervals;
+    usage_limit_reset_anchor: string;
+    max_carryover_amount: string | number | null;
+    carryover_action: string;
+    carryover_enabled: boolean;
+    event_names: string[];
+    aggregation_method: AggregationMethods;
+    feature_type: FeatureType;
+    price_type: BillingTimingTypes;
+    entitlement_id: string;
+    prepaid: boolean;
+    prepaid_credit_system_id: string;
+    usage_model: FeatureModel;
+    credit_cost: number | null;
+    created_at: string;
+    updated_at: string;
+    billing_interval_value: number | null;
+}
+export interface Wallet {
+    id: string;
+    balance: number;
+    name: string;
+    allocations: WalletAllocation[];
+    credit_key: string;
+    credit_system_id: string;
+    credit_unit_plural: string;
+    credit_unit_singular: string;
+}
+export interface WalletAllocation {
+    amount: number;
+    consumed: number;
+    balance_remaining: number;
+    source: string;
+    credited_date: string;
+    valid_until: string | null;
+}
+export interface CreditAllocation {
+    allocation_type: string;
+    amount: number;
+    consumed: number;
+    created_at: string;
+    id: string;
+    invoice_id: string;
+    order_id: string | null;
+    order_number: string | null;
+    transactions: CreditTransaction[];
+    valid_until: string | null;
+}
+export interface CreditTransaction {
+    id: string;
+    amount: number;
+    type: string;
+    created_at: string;
+    description?: string;
+}
+export interface WalletSetting {
+    id: string;
+    auto_top_up_enabled: boolean;
+    notification_enabled: boolean;
+    threshold_amount: number;
+    target_balance: number;
+    monthly_top_up_count_limit: number;
+    monthly_top_up_count: number;
+    last_top_up_at: string | null;
+    credit_system_id: string;
+    credit_system_name: string;
+    credit_system_key: string;
+    wallet_id: string;
+    monthly_top_up_count_reset_at: string;
+}
+export interface CreateWalletSettings {
+    customer_key: string;
+    auto_top_up_enabled: boolean;
+    notification_enabled: boolean;
+    threshold_amount: number;
+    credit_system_id: string;
+    wallet_id: string;
+    target_balance?: number;
+    monthly_top_up_count_limit?: number;
+}
+/**
+ * Pricing Table component props
+ */
+export interface PricingTableProps {
+    checkoutUsername: string;
+    productKey: string;
+    plansOnly?: boolean;
+    singlePurchasesOnly?: boolean;
+    showTabHeader?: boolean;
+}
+export interface Offering {
+    created_at: string;
+    description: string;
+    display_text: string;
+    id: string;
+    metadata: Record<string, string> | 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: CreditSystem[];
+    base_entitlements_plan_name: string;
+    version_id: string;
+    is_invoiceable: boolean;
+}
+export interface ParentOffering {
+    archived_versions: Offering[];
+    draft_version: Offering;
+    id: string;
+    is_visible: boolean;
+    offering_key: string;
+    published_version: Offering;
+}
+export 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;
+}
+export 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;
+}
+export 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;
+}
+export 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;
+    total_unit_quantity: number | null;
+}
+export 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[];
+}
+export interface CreditSystem {
+    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[];
+}
+export interface Product {
+    plans: ParentOffering[];
+    single_purchases: ParentOffering[];
+    currency_code: string;
+}
+/**
+ * Response from /sdk/product_catalogues/products/published-plans endpoint
+ * Note: This returns Offering[] directly, not ParentOffering[]
+ */
+export interface ProductPlans {
+    plans: Offering[];
+}
+export interface SinglePurchase {
+    id: string;
+    name: string;
+    description: string;
+    price: number;
+    currency_code: string;
+    offering_key: string;
+}
+export interface Invoice {
+    id: string;
+    invoice_number: string;
+    title: string;
+    currency_code?: string;
+    customer: CustomerDetails;
+    tenant?: Tenant;
+    due_at: string;
+    issued_at: string | null;
+    status?: InvoiceStatusType;
+    comment: string;
+    is_partially_paid?: boolean;
+    is_overdue?: boolean;
+    overdue_by?: number | null;
+    line_items: InvoiceLineItem[];
+    charge_items: InvoiceLineItem[];
+    usage_items: InvoiceLineItem[];
+    credit_items: InvoiceLineItem[];
+    summary: Partial<InvoiceSummary>;
+    currency: Partial<Currency>;
+    payment_intent?: unknown | null;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface InvoiceLineItem {
+    id: string;
+    price_option_id: string | null;
+    tax_id: string | null;
+    name: string;
+    description: string;
+    quantity: number;
+    unit_price: string;
+    tax_rate: string;
+    discount_amount: string;
+    amount: string;
+    total_amount: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface InvoiceSummary {
+    id: string;
+    items_subtotal: string;
+    total_discounts: string;
+    total_extra_fees: string;
+    total_before_tax: string;
+    total_amount: string;
+    total_tax_amount: string;
+    total_after_tax: string;
+    total_amount_paid: string;
+    total_adjustment_amount: string;
+    total_outstanding_amount: string;
+    created_at: string;
+    updated_at: string;
+}
+export interface Tenant {
+    business_name: string;
+    default_address: TenantAddress;
+    logo_url: string | null;
+}
+export interface TenantAddress {
+    id: string;
+    tenant_id: string;
+    line_1: string;
+    line_2: string;
+    city: string;
+    state: string;
+    postal_code: string;
+    country: string;
+    is_default: boolean;
+    created_at: string;
+    updated_at: string;
+}
+export interface BillingHistory {
+    invoice_id: string;
+    invoice_number: string;
+    issued_date: string;
+    due_date: string;
+    currency: string;
+    total_amount: number;
+    amount_paid: number;
+    balance_due: number;
+    status: string;
+    payment_method: PaymentMethod | null;
+    source_type: string;
+    created_at: string;
+}
+/**
+ * Events emitted by SDK components
+ */
+export interface CustomerDataLoadedEvent {
+    customerDetails: CustomerDetails;
+}
+export interface PlanSelectedEvent {
+    plan: Offering;
+    interval: string;
+    checkoutUrl: string;
+}
+export interface PurchaseSelectedEvent {
+    purchase: Offering;
+    checkoutUrl: string;
+}
+export interface ErrorEvent {
+    message: string;
+    code?: string;
+    details?: unknown;
+}
+export type CssVarMap = Record<string, string>;
+import { LocalizationSelection } from './enum';
+/**
+ * Localization data for a country/currency
+ */
+export interface Localization {
+    country_code: string;
+    currency_code: string;
+}
+/**
+ * Localization settings for pricing table
+ */
+export interface LocalizationSettings {
+    selection: LocalizationSelection;
+}