@stigg/node-server-sdk 4.36.0 → 4.38.0

package/dist/models.d.ts

@@ -1,946 +0,0 @@
-import { PackageEntitlementFragment, PaymentCollection, PaywallConfigurationFragment, SubscriptionQueryFragment, PaywallCurrencyFragment, PageInfoFragment, SubscriptionCancellationAction, SubscriptionFutureUpdateDataFragment, SubscriptionInvoiceFragment, SubscriptionMigrationTime, SubscriptionScheduleStatus, BillingPeriod, SubscriptionCancellationTime, PromotionalEntitlementStatus, SubscriptionStatus, TrialPeriodUnits, BillingModel, PricingType, SubscriptionDecisionStrategy, ExperimentGroupType, Currency, DiscountType, DiscountDurationType, UsageUpdateBehavior, EntitlementResetPeriod, AccessDeniedReason, FeatureType, MeterType, ProvisionSubscriptionStatus, TiersMode, PriceTierFragment, TotalPriceFragment, BillingAddress, MonthlyAccordingTo, WeeklyAccordingTo, CustomerStatisticsFragment, TrialOverrideConfigurationInput, ScheduleStrategy, BillingCadence, ImportSubscriptionInput, PaymentCollectionMethod, BudgetConfigurationInput, SubscriptionCouponInput, PriceOverrideInput, SubscriptionProrationBehavior, SubscriptionBillingCycleAnchor, CreditGrantFragment, CreditLedgerFragment, ChargeInput, PackageEntitlementUnionFragment, CreditCadence } from '@stigg/api-client-js';
-export * from '@stigg/api-client-js';
-export interface Metadata {
-    [key: string]: string;
-}
-import { EntitlementFeature as CacheEntitlementFeature, UnitTransformation } from '@stigg/cache-core';
-export { UnitTransformation };
-export type EntitlementFeature = CacheEntitlementFeature & {
-    isMetered?: boolean;
-};
-export type FullEntitlementFeature = {
-    id: string;
-    featureType: FeatureType;
-    displayName: string;
-    description?: string;
-    units?: string;
-    unitsPlural?: string;
-    meterType?: MeterType.Fluctuating | MeterType.Incremental | MeterType.None;
-    isMetered?: boolean;
-    metadata?: Record<string, string>;
-};
-export type BaseEntitlement = {
-    hasAccess: boolean;
-    isFallback: boolean;
-    accessDeniedReason?: AccessDeniedReason;
-    feature?: EntitlementFeature;
-};
-export interface BooleanEntitlement extends BaseEntitlement {
-    type: 'BOOLEAN';
-}
-export interface EnumEntitlement extends BaseEntitlement {
-    type: 'ENUM';
-    enumValues: string[];
-    requestedValues?: string[];
-}
-export interface NumericEntitlement extends BaseEntitlement {
-    type: 'NUMERIC';
-    value?: number;
-    isUnlimited: boolean;
-}
-export interface MeteredEntitlement extends BaseEntitlement {
-    type: 'METERED';
-    usageLimit?: number;
-    isUnlimited: boolean;
-    hasSoftLimit: boolean;
-    currentUsage: number;
-    requestedUsage: number;
-    resetPeriod?: EntitlementResetPeriod;
-    /** The anchor for calculating the usage period for metered entitlements with a reset period configured */
-    usagePeriodAnchor?: Date;
-    /** The start date of the usage period for metered entitlements with a reset period configured */
-    usagePeriodStart?: Date;
-    /** The end date of the usage period for metered entitlements with a reset period configured */
-    usagePeriodEnd?: Date;
-    /** @deprecated renamed to {@link usagePeriodEnd} */
-    nextResetDate?: Date;
-}
-export interface CreditEntitlement {
-    hasAccess: boolean;
-    isFallback: boolean;
-    accessDeniedReason?: AccessDeniedReason;
-    currency: {
-        currencyId: string;
-        displayName?: string;
-        description?: string;
-        unitSingular?: string;
-        unitPlural?: string;
-        additionalMetaData?: Record<string, unknown>;
-    };
-    usageLimit: number;
-    currentUsage: number;
-    remaining: number;
-    usagePeriodEnd?: Date;
-}
-/** Feature-only entitlement (excludes CreditEntitlement). Use Entitlement for polymorphic APIs. */
-export type Entitlement = BooleanEntitlement | NumericEntitlement | MeteredEntitlement | EnumEntitlement;
-export type EntitlementV2 = Entitlement | CreditEntitlement;
-export type CustomerEntitlementsResult = {
-    entitlements: Entitlement[];
-    accessDeniedReason: AccessDeniedReason | null;
-};
-export type CustomerEntitlementsResultV2 = {
-    entitlements: EntitlementV2[];
-    accessDeniedReason: AccessDeniedReason | null;
-};
-/** @internal */
-export declare const BOOLEAN_DEFAULT_FALLBACK_ENTITLEMENT: BooleanEntitlement;
-/** @internal */
-export declare const NUMERIC_DEFAULT_FALLBACK_ENTITLEMENT: NumericEntitlement;
-/** @internal */
-export declare const METERED_DEFAULT_FALLBACK_ENTITLEMENT: MeteredEntitlement;
-/** @internal */
-export declare const ENUM_DEFAULT_FALLBACK_ENTITLEMENT: EnumEntitlement;
-/** @internal */
-export declare const CREDIT_DEFAULT_FALLBACK_ENTITLEMENT: CreditEntitlement;
-export type DependencyAddon = {
-    refId: string;
-    displayName: string;
-    description?: string;
-};
-export type Addon = {
-    id: string;
-    displayName: string;
-    billingId?: string | null;
-    description: string;
-    /** @deprecated Use {@link packageEntitlements} instead to retrieve both feature and credit entitlements. */
-    entitlements: PackageEntitlement[];
-    packageEntitlements: PackageEntitlementUnionFragment[];
-    pricePoints: Price[];
-    pricingType?: PricingType | null;
-    metadata?: Metadata | null;
-    maxQuantity?: number;
-    dependencies?: DependencyAddon[];
-};
-export type FullSubscriptionAddon = {
-    quantity: number;
-    addon: Addon;
-};
-export type FullSubscription = {
-    id: string;
-    resource: CustomerResource | null;
-    payingCustomer: SlimCustomer | null;
-    status: SubscriptionStatus;
-    plan: Plan;
-    /** @deprecated use {@link prices} instead with {@link totalPrice} */
-    price: SubscriptionPrice | null;
-    prices: Price[];
-    totalPrice: TotalPriceFragment | null | undefined;
-    pricingType: PricingType;
-    addons: FullSubscriptionAddon[];
-    billingId?: string;
-    billingLinkUrl?: string;
-    crmId?: string;
-    startDate: Date;
-    endDate?: Date;
-    trialEndDate?: Date;
-    /**
-     * The calculated end date after which the subscription will be canceled, which takes trial expiration and scheduled cancellations into consideration
-     */
-    effectiveEndDate?: Date;
-    cancellationDate?: Date;
-    currentBillingPeriodEnd?: Date;
-    metadata?: Metadata | null;
-    experimentInfo?: ExperimentInfo | null;
-    latestInvoice?: SubscriptionInvoiceFragment;
-    paymentCollection: PaymentCollection;
-    paymentCollectionMethod?: PaymentCollectionMethod;
-    billingSyncError?: string;
-    /** Future updates can be of 2 types {@link SubscriptionScheduleStatus.Scheduled} or {@link SubscriptionScheduleStatus.PendingPayment}  */
-    futureUpdates: SubscriptionFutureUpdateDataFragment[];
-};
-export type Subscription = {
-    id: string;
-    resource: CustomerResource | null;
-    status: SubscriptionStatus;
-    customerId: string;
-    planId: string;
-    addonIds: string[];
-    addons: SubscriptionAddon[];
-    metadata?: Metadata | null;
-    billingId?: string;
-    billingLinkUrl?: string;
-    pricingType: PricingType;
-    effectiveEndDate?: Date;
-    /** @deprecated use {@link prices} instead with {@link totalPrice} */
-    price: SubscriptionPrice | null;
-    prices: Price[];
-    totalPrice: TotalPriceFragment | null | undefined;
-    experimentInfo?: ExperimentInfo | null;
-    latestInvoice?: SubscriptionInvoiceFragment;
-    paymentCollection: PaymentCollection;
-    billingSyncError?: string;
-};
-export type SubscriptionAddon = {
-    addonId: string;
-    quantity?: number;
-};
-export type UpdateSubscription = {
-    subscriptionId: string;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    charges?: ChargeInput[];
-    metadata?: Metadata | null;
-    addons?: SubscriptionAddon[];
-    billingPeriod?: BillingPeriod;
-    awaitPaymentConfirmation?: boolean;
-    billingInformation?: SubscriptionBillingInfo;
-    /** @deprecated Use {@link entitlements} instead to support both feature and credit entitlements. */
-    subscriptionEntitlements?: SubscriptionEntitlement[];
-    entitlements?: SubscriptionEntitlementV2[];
-    trialEndDate?: Date;
-    scheduleStrategy?: ScheduleStrategy;
-    appliedCoupon?: SubscriptionCouponInput;
-    priceOverrides?: PriceOverrideInput[];
-    billingCycleAnchor?: SubscriptionBillingCycleAnchor;
-};
-export type CreateSubscription = CreateSubscriptionParams & {
-    customerId: string;
-};
-export type CreateSubscriptionParams = {
-    resourceId?: string;
-    planId: string;
-    addons?: SubscriptionAddon[];
-    startDate?: Date;
-    id?: string;
-    billingPeriod?: BillingPeriod;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    skipTrial?: boolean;
-    metadata?: Metadata | null;
-    awaitPaymentConfirmation?: boolean;
-    billingInformation?: SubscriptionBillingInfo;
-    promotionCode?: string;
-    appliedCoupon?: SubscriptionCouponInput;
-    trialOverrideConfiguration?: TrialOverrideConfigurationInput;
-    priceOverrides?: PriceOverrideInput[];
-    entitlements?: SubscriptionEntitlementV2[];
-};
-export type Money = {
-    amount: number;
-    currency: string;
-};
-export type DateRange = {
-    start?: Date;
-    end?: Date;
-};
-export type SubscriptionPreviewProration = {
-    prorationDate: Date;
-    credit: Money;
-    debit: Money;
-    netAmount: Money;
-    hasProrations?: boolean;
-};
-export type SubscriptionPreviewInvoice = {
-    total: Money;
-    subTotal: Money;
-    totalExcludingTax: Money;
-    tax?: Money;
-    discount?: Money;
-    taxDetails?: SubscriptionPreviewTaxDetails;
-    discountDetails?: SubscriptionPreviewDiscount;
-};
-export type ImmediateSubscriptionPreviewInvoice = SubscriptionPreviewInvoice & {
-    proration?: SubscriptionPreviewProration;
-    credits?: SubscriptionPreviewCredits;
-};
-export type SubscriptionPreviewCredits = {
-    initial: Money;
-    used: Money;
-    remaining: Money;
-};
-export type SubscriptionPricePreview = {
-    subTotal: Money;
-    totalExcludingTax: Money;
-    total: Money;
-    tax: Money;
-};
-export type SubscriptionPreviewDiscount = {
-    type: DiscountType;
-    value: number;
-    durationType: DiscountDurationType;
-    durationInMonths?: number;
-};
-export type SubscriptionPreviewTaxDetails = {
-    displayName: string;
-    percentage: number;
-    inclusive: boolean;
-};
-export interface SubscriptionPreview {
-    subTotal: Money;
-    totalExcludingTax: Money;
-    total: Money;
-    tax?: Money;
-    taxDetails?: SubscriptionPreviewTaxDetails;
-    discount?: SubscriptionPreviewDiscount;
-    billingPeriodRange: DateRange;
-    proration?: SubscriptionPreviewProration;
-    subscription?: SubscriptionPricePreview;
-}
-export interface SubscriptionPreviewV2 {
-    /**
-     * The immediate invoice prices that will be generated for the subscription
-     * for the previewed subscription \ changes
-     */
-    immediateInvoice: ImmediateSubscriptionPreviewInvoice;
-    /**
-     * The recurring invoice prices that will be generated for the subscription
-     * for the previewed subscription \ changes, starting from the next billing period
-     */
-    recurringInvoice?: SubscriptionPreviewInvoice;
-    billingPeriodRange: DateRange;
-    isPlanDowngrade?: boolean;
-    hasScheduledUpdates?: boolean;
-}
-export type EstimateSubscription = {
-    customerId: string;
-    payingCustomerId?: string;
-    resourceId?: string;
-    planId: string;
-    billingCountryCode?: string;
-    addons?: SubscriptionAddon[];
-    startDate?: Date;
-    billingPeriod?: BillingPeriod;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    charges?: ChargeInput[];
-    billingInformation?: SubscriptionBillingInfo;
-    promotionCode?: string;
-    appliedCoupon?: SubscriptionCouponInput;
-    skipTrial?: boolean;
-};
-export type EstimateSubscriptionUpdate = {
-    subscriptionId: string;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    charges?: ChargeInput[];
-    addons?: SubscriptionAddon[];
-    promotionCode?: string;
-    appliedCoupon?: SubscriptionCouponInput;
-};
-export type PreviewSubscription = {
-    customerId: string;
-    payingCustomerId?: string;
-    planId: string;
-    resourceId?: string;
-    addons?: SubscriptionAddon[];
-    startDate?: Date;
-    billingPeriod?: BillingPeriod;
-    billingCountryCode?: string;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    charges?: ChargeInput[];
-    billingInformation?: SubscriptionBillingInfo;
-    promotionCode?: string;
-    appliedCoupon?: SubscriptionCouponInput;
-    scheduleStrategy?: ScheduleStrategy;
-    billingCycleAnchor?: SubscriptionBillingCycleAnchor;
-};
-export type PreviewNextInvoice = {
-    subscriptionId: string;
-};
-export type CancelSubscriptionScheduledUpdates = {
-    subscriptionId: string;
-    status?: SubscriptionScheduleStatus.Scheduled | SubscriptionScheduleStatus.PendingPayment;
-};
-export type MigrateSubscriptionToLatest = {
-    subscriptionId: string;
-    subscriptionMigrationTime?: SubscriptionMigrationTime;
-};
-export type ProvisionedCustomer = {
-    customer: Customer;
-    subscriptionDecisionStrategy: SubscriptionDecisionStrategy;
-    subscription?: Subscription;
-};
-export type ProvisionCustomer = CreateCustomer & {
-    subscriptionParams: CreateSubscriptionParams | null;
-};
-export type ProvisionSubscriptionResult = {
-    provisionStatus: ProvisionSubscriptionStatus;
-    subscription?: Subscription;
-    checkoutUrl?: string | null;
-};
-export type CheckoutOptions = {
-    successUrl: string;
-    cancelUrl: string;
-    allowPromoCodes?: boolean;
-    allowTaxIdCollection?: boolean;
-    collectBillingAddress?: boolean;
-    referenceId?: string;
-    collectPhoneNumber?: boolean;
-};
-export type ApplySubscription = {
-    customerId: string;
-    planId: string;
-    paymentMethodId?: string;
-    payingCustomerId?: string;
-    resourceId?: string;
-    addons?: SubscriptionAddon[];
-    startDate?: Date;
-    billingId?: string;
-    billingPeriod?: BillingPeriod;
-    skipTrial?: boolean;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    metadata?: Metadata | null;
-    billingInformation?: SubscriptionBillingInfo;
-    promotionCode?: string;
-    appliedCoupon?: SubscriptionCouponInput;
-    billingCountryCode?: string;
-    trialOverrideConfiguration?: TrialOverrideConfigurationInput;
-    scheduleStrategy?: ScheduleStrategy;
-    paymentCollectionMethod?: PaymentCollectionMethod;
-    priceOverrides?: PriceOverrideInput[];
-    charges?: ChargeInput[];
-    billingCycleAnchor?: SubscriptionBillingCycleAnchor;
-    entitlements?: SubscriptionEntitlementV2[];
-};
-export type ApplySubscriptionResults = {
-    subscription?: Subscription;
-};
-export type ImportSubscriptionBulk = {
-    subscriptions: ImportSubscription[];
-    integrationId?: string;
-};
-export type ImportSubscription = Omit<ImportSubscriptionInput, 'additionalMetaData'> & {
-    metadata?: Metadata;
-};
-export type BillableFeature = {
-    featureId: string;
-    quantity: number;
-};
-export type SubscriptionEntitlement = {
-    featureId: string;
-    hasUnlimitedUsage?: boolean;
-    hasSoftLimit?: boolean;
-    usageLimit?: number;
-    resetPeriod?: EntitlementResetPeriod;
-    monthlyResetPeriodConfiguration?: {
-        accordingTo: MonthlyAccordingTo;
-    };
-    weeklyResetPeriodConfiguration?: {
-        accordingTo: WeeklyAccordingTo;
-    };
-};
-export type SubscriptionFeatureEntitlement = SubscriptionEntitlement;
-export type SubscriptionCreditEntitlement = {
-    customCurrencyId: string;
-    amount: number;
-    cadence: CreditCadence;
-};
-export type SubscriptionEntitlementV2 = {
-    feature?: SubscriptionFeatureEntitlement;
-    credit?: SubscriptionCreditEntitlement;
-};
-export type ProvisionSubscription = {
-    customerId: string;
-    payingCustomerId?: string;
-    resourceId?: string;
-    planId: string;
-    addons?: SubscriptionAddon[];
-    startDate?: Date;
-    id?: string;
-    billingId?: string;
-    salesforceId?: string;
-    billingPeriod?: BillingPeriod;
-    skipTrial?: boolean;
-    unitQuantity?: number;
-    billableFeatures?: BillableFeature[];
-    charges?: ChargeInput[];
-    metadata?: Metadata | null;
-    awaitPaymentConfirmation?: boolean;
-    billingInformation?: SubscriptionBillingInfo;
-    checkoutOptions?: CheckoutOptions;
-    promotionCode?: string;
-    appliedCoupon?: SubscriptionCouponInput;
-    billingCountryCode?: string;
-    /** @deprecated Use {@link entitlements} instead to support both feature and credit entitlements. */
-    subscriptionEntitlements?: SubscriptionEntitlement[];
-    entitlements?: SubscriptionEntitlementV2[];
-    trialOverrideConfiguration?: TrialOverrideConfigurationInput;
-    scheduleStrategy?: ScheduleStrategy;
-    paymentCollectionMethod?: PaymentCollectionMethod;
-    priceOverrides?: PriceOverrideInput[];
-    billingCycleAnchor?: SubscriptionBillingCycleAnchor;
-};
-export type SubscriptionBillingInfo = {
-    taxRateIds?: string[];
-    taxPercentage?: number;
-    billingAddress?: BillingAddress;
-    metadata?: Metadata | null;
-    chargeOnBehalfOfAccount?: string;
-    couponId?: string;
-    isInvoicePaid?: boolean;
-    isBackdated?: boolean;
-    invoiceDaysUntilDue?: number;
-    integrationId?: string;
-    prorationBehavior?: SubscriptionProrationBehavior;
-};
-export type CancelSubscription = {
-    subscriptionId: string;
-    endDate?: Date;
-    subscriptionCancellationTime?: SubscriptionCancellationTime;
-    subscriptionCancellationAction?: SubscriptionCancellationAction;
-    prorate?: boolean;
-    awaitSubscriptionCancellation?: boolean;
-};
-export type GetBooleanEntitlement = {
-    customerId: string;
-    featureId: string;
-    resourceId?: string;
-    options?: BooleanEntitlementOptions;
-};
-export type GetNumericEntitlement = {
-    customerId: string;
-    featureId: string;
-    resourceId?: string;
-    options?: NumericEntitlementOptions;
-};
-export type GetMeteredEntitlement = {
-    customerId: string;
-    featureId: string;
-    resourceId?: string;
-    options?: MeteredEntitlementOptions;
-};
-export type GetEnumEntitlement = {
-    customerId: string;
-    featureId: string;
-    resourceId?: string;
-    options?: EnumEntitlementOptions;
-};
-export type GetCreditEntitlement = {
-    customerId: string;
-    currencyId: string;
-    resourceId?: string;
-    options?: CreditEntitlementOptions;
-};
-export type GetEntitlement = {
-    customerId: string;
-    featureId: string;
-    resourceId?: string;
-    options?: EntitlementOptions;
-};
-type GetEntitlementV2CommonParams = {
-    customerId: string;
-    resourceId?: string;
-    options?: EntitlementOptionsV2;
-};
-/** For feature entitlements. */
-type GetEntitlementV2FeatureParams = GetEntitlementV2CommonParams & {
-    featureId: string;
-    currencyId?: never;
-};
-/** For credit entitlements (custom currency id). */
-type GetEntitlementV2CreditParams = GetEntitlementV2CommonParams & {
-    currencyId: string;
-    featureId?: never;
-};
-/** Exactly one of featureId or currencyId must be set. */
-export type GetEntitlementV2Params = GetEntitlementV2FeatureParams | GetEntitlementV2CreditParams;
-export type EntitlementOptions = BooleanEntitlementOptions | NumericEntitlementOptions | MeteredEntitlementOptions | EnumEntitlementOptions;
-export type EntitlementOptionsV2 = EntitlementOptions | CreditEntitlementOptions;
-export type ReportUsage = {
-    customerId: string;
-    resourceId?: string;
-    featureId: string;
-    value: number;
-    updateBehavior?: UsageUpdateBehavior;
-    createdAt?: Date;
-    dimensions?: Record<string, EventDimensionValue>;
-};
-export type ReportUsageBulk = {
-    usages: ReportUsage[];
-};
-export type EventDimensionValue = string | number | boolean;
-export type ReportEvent = {
-    eventName: string;
-    customerId: string;
-    idempotencyKey: string;
-    resourceId?: string;
-    dimensions?: Record<string, EventDimensionValue>;
-    timestamp?: Date;
-};
-export type ReportUsageAck = {
-    measurementId: string;
-    featureId: string;
-    customerId: string;
-    resourceId?: string;
-    currentUsage?: number;
-    usagePeriodStart?: Date;
-    usagePeriodEnd?: Date;
-    /** @deprecated renamed to {@link usagePeriodEnd} */
-    nextResetDate?: Date;
-};
-export type ImportCustomerBulk = {
-    customers: ImportCustomer[];
-    integrationId?: string;
-};
-export type ImportCustomer = {
-    billingId?: string;
-    customerId?: string;
-    name?: string;
-    email?: string;
-    paymentMethodId?: string;
-    metadata?: Metadata | null;
-    updatedAt?: Date;
-};
-export type CreateCustomer = {
-    customerId?: string;
-    name?: string;
-    email?: string;
-    billingId?: string;
-    salesforceId?: string;
-    billingInfo?: BillingInfo;
-    couponId?: string;
-    metadata?: Metadata | null;
-    /** @deprecated not in use anymore - will be removed in future release */
-    shouldSyncFree?: boolean;
-    excludeFromExperiment?: boolean;
-    awsMarketplaceCustomerId?: string;
-};
-export type GetSubscription = {
-    subscriptionId: string;
-};
-export type GetActiveSubscriptions = {
-    customerId: string;
-    resourceId?: string | string[];
-};
-export type PaginatedResult<T> = {
-    data: T[];
-    pageInfo: PageInfoFragment;
-    totalCount?: number;
-};
-export type GetSubscriptionsResult = PaginatedResult<SubscriptionQueryFragment>;
-export type GetCreditGrantsResult = PaginatedResult<CreditGrantFragment>;
-export type GetCreditLedgerResult = PaginatedResult<CreditLedgerFragment>;
-export type GetSubscriptionsParams = {
-    customerId?: string;
-    resourceId?: string | string[];
-    status?: SubscriptionStatus | SubscriptionStatus[];
-    productId?: string | string[];
-    pagination?: {
-        limit?: number;
-        startingAfter?: string;
-        endingBefore?: string;
-    };
-};
-export type UpdateCustomer = {
-    customerId: string;
-    name?: string;
-    email?: string;
-    couponId?: string | null;
-    billingId?: string;
-    salesforceId?: string;
-    billingInfo?: BillingInfo;
-    metadata?: Metadata | null;
-    shouldWaitSync?: boolean;
-    integrationId?: string;
-    awsMarketplaceCustomerId?: string;
-};
-export type BillingInfo = {
-    billingAddress?: Address;
-    shippingAddress?: Address;
-    currency?: Currency;
-    timezone?: string;
-    language?: string;
-    taxIds?: TaxExempt[];
-    invoiceCustomFields?: Record<string, string>;
-    paymentMethodId?: string;
-    customerName?: string;
-    metadata?: Metadata | null;
-    integrationId?: string;
-};
-/**
- * @param country - optional country of the address - in a valid ISO 3166-1 alpha-2 format
- */
-export type Address = {
-    country?: string;
-    state?: string;
-    addressLine1?: string;
-    addressLine2?: string;
-    city?: string;
-    postalCode?: string;
-    phoneNumber?: string;
-};
-export type TaxExempt = {
-    type: string;
-    value: string;
-};
-export type EntitlementsFallback = {
-    [featureId: string]: BooleanEntitlementFallback | NumericEntitlementFallback | MeteredEntitlementFallback | EnumEntitlementFallback;
-};
-export type CreditEntitlementsFallback = {
-    [currencyId: string]: CreditEntitlementFallback;
-};
-export type BooleanEntitlementFallback = {
-    hasAccess: boolean;
-};
-export type BooleanEntitlementOptions = {
-    /** @deprecated not in use anymore */
-    shouldTrack?: boolean;
-    fallback?: BooleanEntitlementFallback;
-};
-export type NumericEntitlementFallback = {
-    hasAccess: boolean;
-    value?: number;
-    isUnlimited?: boolean;
-};
-export type NumericEntitlementOptions = {
-    /** @deprecated not in use anymore */
-    shouldTrack?: boolean;
-    fallback?: NumericEntitlementFallback;
-};
-export type MeteredEntitlementFallback = {
-    hasAccess: boolean;
-    usageLimit?: number;
-    isUnlimited?: boolean;
-};
-export type MeteredEntitlementOptions = {
-    requestedUsage?: number;
-    /** @deprecated not in use anymore */
-    shouldTrack?: boolean;
-    fallback?: MeteredEntitlementFallback;
-};
-export type EnumEntitlementFallback = {
-    hasAccess: boolean;
-    enumValues?: string[];
-};
-export type EnumEntitlementOptions = {
-    requestedValues?: string[];
-    shouldTrack?: boolean;
-    fallback?: EnumEntitlementFallback;
-};
-export type CreditEntitlementFallback = {
-    hasAccess: boolean;
-    usageLimit?: number;
-    currentUsage?: number;
-};
-export type CreditEntitlementOptions = {
-    fallback?: CreditEntitlementFallback;
-};
-export type CreateUsageMeasurement = {
-    customerId: string;
-    resourceId?: string;
-    featureId: string;
-    value: number;
-    updateBehavior?: UsageUpdateBehavior;
-    createdAt?: Date;
-    dimensions?: Record<string, EventDimensionValue>;
-};
-export type FullPromotionalEntitlement = {
-    usageLimit: number;
-    feature: EntitlementFeature;
-    hasUnlimitedUsage?: boolean | null;
-    hasSoftLimit?: boolean | null;
-    status: PromotionalEntitlementStatus;
-    expiresAt?: Date;
-    hasExpirationDate: boolean;
-    isVisible: boolean;
-};
-export type PaymentMethodDetails = {
-    expirationMonth?: number | null;
-    expirationYear?: number | null;
-    last4Digits?: string | null;
-};
-export type CustomerResource = {
-    id: string;
-};
-export type SlimCustomer = {
-    id: string;
-    name?: string;
-    email?: string;
-    createdAt: Date;
-    updatedAt: Date;
-    billingId?: string;
-    metadata?: Metadata | null;
-    awsMarketplaceCustomerId?: string | null;
-};
-export type Customer = SlimCustomer;
-export type FullCustomer = SlimCustomer & {
-    hasPaymentMethod: boolean;
-    paymentMethodDetails?: PaymentMethodDetails;
-    subscriptions: FullSubscription[];
-    promotionalEntitlements: PromotionalEntitlement[];
-    coupon?: Coupon;
-    experimentInfo?: ExperimentInfo | null;
-    alreadyTrialPlans: TrialedPlan[];
-    getActivePromotionalEntitlements(): FullPromotionalEntitlement[];
-    /** @deprecated use {@link StiggManagementAPI.getActiveSubscriptions} instead with filter for {@link SubscriptionStatus.Active} */
-    getActiveSubscriptions(): FullSubscription[];
-    /** @deprecated use {@link StiggManagementAPI.getActiveSubscriptions} instead with filter for {@link SubscriptionStatus.InTrial} */
-    getActiveTrials(): FullSubscription[];
-};
-export type CustomerState = Omit<FullCustomer, 'getActiveSubscriptions' | 'getActivePromotionalEntitlements' | 'getActiveTrials'>;
-export type CustomerStatisticsModel = {
-    statistics: CustomerStatisticsFragment['statistics'];
-};
-export type PackageEntitlement = {
-    usageLimit: number;
-    feature: FullEntitlementFeature;
-    hasUnlimitedUsage?: boolean | null;
-    hasSoftLimit?: boolean | null;
-    resetPeriod?: EntitlementResetPeriod | null;
-    hiddenFromWidgets?: PackageEntitlementFragment['hiddenFromWidgets'];
-    displayNameOverride?: PackageEntitlementFragment['displayNameOverride'];
-    isGranted: PackageEntitlementFragment['isGranted'];
-};
-export type PromotionalEntitlement = {
-    usageLimit: number;
-    feature: FullEntitlementFeature;
-    hasUnlimitedUsage?: boolean | null;
-    hasSoftLimit?: boolean | null;
-    status: PromotionalEntitlementStatus;
-    expiresAt?: Date;
-    hasExpirationDate: boolean;
-    isVisible: boolean;
-};
-export type Price = {
-    pricingModel: BillingModel;
-    billingPeriod: BillingPeriod;
-    billingCadence?: BillingCadence;
-    billingId?: string | null;
-    amount?: number | null;
-    tiers?: PriceTierFragment[] | null | undefined;
-    tiersMode: TiersMode | null | undefined;
-    currency: Currency;
-    minUnitQuantity?: number | null | undefined;
-    maxUnitQuantity?: number | null | undefined;
-    billingCountryCode?: string | null | undefined;
-    creditRate?: {
-        amount: number;
-    } | null;
-    feature?: {
-        featureId: string;
-        units?: string | null | undefined;
-        unitsPlural?: string | null | undefined;
-        unitQuantity?: number | null;
-        displayName: string;
-        description?: string | null;
-    } | null;
-    blockSize?: number | null;
-    topUpCustomCurrencyId?: string | null;
-    customCurrency?: {
-        displayName: string;
-        units?: {
-            singular?: string | null;
-            plural?: string | null;
-        } | null;
-    } | null;
-};
-export type SubscriptionPrice = Price & {
-    grossAmount: number;
-};
-export type BasePlan = {
-    displayName: string;
-    id: string;
-};
-export type CompatiblePackageGroupOptions = {
-    minItems?: number;
-    freeItems?: number;
-};
-export type CompatiblePackageGroup = {
-    packageGroupId: string;
-    displayName: string;
-    addons: Addon[];
-    options?: CompatiblePackageGroupOptions;
-};
-export type Plan = {
-    id: string;
-    displayName: string;
-    billingId?: string | null;
-    description?: string | null;
-    order: number;
-    basePlan?: BasePlan;
-    /** @deprecated Use {@link packageEntitlements} instead to retrieve both feature and credit entitlements. */
-    entitlements: PackageEntitlement[];
-    /** @deprecated Use {@link inheritedPackageEntitlements} instead to retrieve both feature and credit entitlements. */
-    inheritedEntitlements: PackageEntitlement[];
-    packageEntitlements: PackageEntitlementUnionFragment[];
-    inheritedPackageEntitlements: PackageEntitlementUnionFragment[];
-    pricePoints: Price[];
-    pricingType?: PricingType | null;
-    defaultTrialConfig?: DefaultTrialConfig | null;
-    compatibleAddons: Addon[];
-    compatiblePackageGroups: CompatiblePackageGroup[];
-    product: Product;
-    metadata?: Metadata | null;
-    awsMarketplacePlanDimension?: string | null;
-};
-export type Coupon = {
-    id: string;
-    name: string;
-    description?: string | null;
-    discountValue: number;
-    percentOff?: number | null;
-    amountsOff?: Money[] | null;
-    metadata?: Metadata | null;
-};
-export type Product = {
-    id: string;
-    displayName?: string | null;
-    description?: string | null;
-    metadata?: Metadata | null;
-    awsMarketplaceProductId?: string | null;
-    downgradePlan?: Pick<Plan, 'id' | 'displayName'>;
-};
-export type DefaultTrialConfig = {
-    duration: number;
-    units: TrialPeriodUnits;
-    budget?: {
-        limit: BudgetConfigurationInput['limit'];
-    };
-};
-export type GetPaywall = {
-    productId?: string;
-    customerId?: string;
-    resourceId?: string;
-    billingCountryCode?: string;
-    fetchAllCountriesPrices?: boolean;
-    includeHiddenPlans?: boolean;
-};
-export type PaywallConfiguration = Omit<PaywallConfigurationFragment, '__typename'>;
-export type PaywallCurrency = Omit<PaywallCurrencyFragment, '__typename'>;
-export type Paywall = {
-    plans: Plan[];
-    configuration?: PaywallConfiguration | null;
-    customer: Customer | null;
-    resource: CustomerResource | null;
-    activeSubscriptions: FullSubscription[] | null;
-    currency: PaywallCurrency;
-};
-export type ExperimentInfo = {
-    id: string;
-    name: string;
-    groupName: string;
-    groupType?: ExperimentGroupType | null;
-};
-export type TrialedPlan = {
-    planId: string;
-    productId: string;
-};
-export type FetchUsageHistory = {
-    customerId: string;
-    resourceId?: string;
-    featureId: string;
-    startDate: Date;
-    endDate?: Date;
-};
-export type UsageHistoryPoint = {
-    date: Date;
-    value: number;
-    isResetPoint: boolean;
-};
-/** @hidden */
-export declare class CustomerModel implements FullCustomer {
-    id: string;
-    createdAt: Date;
-    updatedAt: Date;
-    subscriptions: FullSubscription[];
-    promotionalEntitlements: PromotionalEntitlement[];
-    hasPaymentMethod: boolean;
-    alreadyTrialPlans: TrialedPlan[];
-    constructor(state: CustomerState);
-    getActiveSubscriptions(): FullSubscription[];
-    getActiveTrials(): FullSubscription[];
-    getActivePromotionalEntitlements(): PromotionalEntitlement[];
-}