@schematichq/schematic-components 2.16.3 → 2.18.0

package/dist/schematic-components.d.ts

@@ -26,6 +26,8 @@ declare interface AddOnsProps {
     currency?: string;
 }
 
+export declare const applyPrefilledQuantities: (entitlements: UsageBasedEntitlement[], prefill?: Record<string, number>) => UsageBasedEntitlement[];
+
 export declare const AutoTopup: ({ planCreditGrants, autoTopupConfigs, updateAutoTopupConfig, }: AutoTopupProps) => JSX.Element;
 
 declare type AutoTopupConfig = Pick<CompanyPlanCreditGrantView, "companyAutoTopupEnabled" | "companyAutoTopupThresholdCredits" | "companyAutoTopupAmount">;
@@ -47,6 +49,30 @@ declare interface AvailablePlanOptions {
     useSelectedPeriod?: boolean;
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingCreditAutoTopupAvailability: {
+    readonly Off: "off";
+    readonly Automatic: "automatic";
+    readonly UserControlled: "user_controlled";
+};
+
+declare type BillingCreditAutoTopupAvailability = (typeof BillingCreditAutoTopupAvailability)[keyof typeof BillingCreditAutoTopupAvailability];
+
+/**
+ *
+ * @export
+ */
+declare const BillingCreditAutoTopupAvailability_2: {
+    readonly Off: "off";
+    readonly Automatic: "automatic";
+    readonly UserControlled: "user_controlled";
+};
+
+declare type BillingCreditAutoTopupAvailability_2 = (typeof BillingCreditAutoTopupAvailability_2)[keyof typeof BillingCreditAutoTopupAvailability_2];
+
 /**
  *
  * @export
@@ -967,8 +993,15 @@ declare interface BillingPlanCreditGrantResponseData {
     autoTopupAmountType?: string | null;
     /**
      *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    autoTopupAvailability: BillingCreditAutoTopupAvailability;
+    /**
+     * Derived from auto_topup_availability; use that instead.
      * @type {boolean}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     autoTopupEnabled: boolean;
     /**
@@ -990,9 +1023,10 @@ declare interface BillingPlanCreditGrantResponseData {
      */
     autoTopupExpiryUnitCount?: number | null;
     /**
-     *
+     * Derived from auto_topup_availability; use that instead.
      * @type {boolean}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     autoTopupSelfService: boolean;
     /**
@@ -1007,6 +1041,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     autoTopupThresholdPercent?: number | null;
+    /**
+     * Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability.
+     * @type {boolean}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    canBuyBundles: boolean;
     /**
      *
      * @type {Date}
@@ -2901,6 +2941,19 @@ export declare interface BypassConfig {
      * currency is locked (the selector is already hidden in those cases).
      */
     showCurrencySelector?: boolean;
+    /**
+     * Pre-fill pay-in-advance quantities, keyed by feature id.
+     *
+     * Only applies to entitlements whose price behavior is pay-in-advance; entries
+     * for other features (or unknown feature ids) are ignored. Values are clamped
+     * to whole numbers >= 0. Combine with `skipped.usageStage` /
+     * `skipped.addOnUsageStage` to land the customer directly on the checkout step
+     * with the quantities already set.
+     *
+     * @example
+     * { planId: "plan_abc", payInAdvanceQuantities: { feat_seats: 3 } }
+     */
+    payInAdvanceQuantities?: Record<string, number>;
 }
 
 export declare const Card: ForwardRefExoticComponent<CardProps & RefAttributes<HTMLDivElement | null>>;
@@ -2930,6 +2983,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     autoTopupOverrides: Array<UpdateAutoTopupOverrideRequestBody>;
+    /**
+     *
+     * @type {string}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    billingEntityId?: string | null;
     /**
      *
      * @type {string}
@@ -3399,6 +3458,20 @@ export declare interface CheckoutStageSkipConfig {
      * - undefined: Defaults to false (show stage)
      */
     creditStage?: boolean;
+    /**
+     * Skip the pay-in-advance quantity stage for the plan.
+     * - true: Skip directly to next stage (uses prefilled or current quantities)
+     * - false: Show quantity stage (user can review/change quantities)
+     * - undefined: Defaults to false (show stage)
+     */
+    usageStage?: boolean;
+    /**
+     * Skip the pay-in-advance quantity stage for add-ons.
+     * - true: Skip directly to next stage (uses prefilled or current quantities)
+     * - false: Show add-on quantity stage (user can review/change quantities)
+     * - undefined: Defaults to false (show stage)
+     */
+    addOnUsageStage?: boolean;
 }
 
 export declare type CheckoutState = {
@@ -3411,11 +3484,14 @@ export declare type CheckoutState = {
     bypassPlanSelection?: boolean;
     bypassAddOnSelection?: boolean;
     bypassCreditsSelection?: boolean;
+    bypassUsageSelection?: boolean;
+    bypassAddOnUsageSelection?: boolean;
     addOnIds?: string[];
     hideSkippedStages?: boolean;
     selectedCurrency?: string;
     showCurrencySelector?: boolean;
     startTrialIfAvailable?: boolean;
+    payInAdvanceQuantities?: Record<string, number>;
 };
 
 /**
@@ -3887,6 +3963,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupAvailability?: BillingCreditAutoTopupAvailability | null;
     /**
      *
      * @type {boolean}
@@ -3929,6 +4011,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditCanBuyBundles: boolean;
     /**
      *
      * @type {number}
@@ -4147,6 +4235,12 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    companyLogoUrl?: string | null;
     /**
      *
      * @type {string}
@@ -4177,6 +4271,12 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<BillingCreditResponseData>}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    credits: Array<BillingCreditResponseData>;
     /**
      *
      * @type {Array<PlanCurrencyPricesResponseData>}
@@ -8899,6 +8999,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupAvailability?: BillingCreditAutoTopupAvailability | null;
     /**
      *
      * @type {boolean}
@@ -8941,6 +9047,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditCanBuyBundles: boolean;
     /**
      *
      * @type {Date}
@@ -9092,6 +9204,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupAvailability?: BillingCreditAutoTopupAvailability_2 | null;
     /**
      *
      * @type {boolean}
@@ -9134,6 +9252,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditCanBuyBundles: boolean;
     /**
      *
      * @type {Date}
@@ -9398,6 +9522,12 @@ declare interface PlanDetailResponseData {
      * @memberof PlanDetailResponseData
      */
     companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanDetailResponseData
+     */
+    companyLogoUrl?: string | null;
     /**
      *
      * @type {string}
@@ -9422,6 +9552,12 @@ declare interface PlanDetailResponseData {
      * @memberof PlanDetailResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<BillingCreditResponseData>}
+     * @memberof PlanDetailResponseData
+     */
+    credits: Array<BillingCreditResponseData>;
     /**
      *
      * @type {Array<PlanCurrencyPricesResponseData>}
@@ -10416,6 +10552,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanViewPublicResponseData
+     */
+    companyLogoUrl?: string | null;
     /**
      *
      * @type {string}
@@ -10446,6 +10588,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<BillingCreditResponseData>}
+     * @memberof PlanViewPublicResponseData
+     */
+    credits: Array<BillingCreditResponseData_2>;
     /**
      *
      * @type {Array<PlanCurrencyPricesResponseData>}