@schematichq/schematic-components 2.14.0 → 2.15.0

package/dist/schematic-components.d.ts

@@ -11,7 +11,7 @@ import { IconProps as IconProps_2 } from '@schematichq/schematic-icons';
 import { iconsList } from '@schematichq/schematic-icons';
 import { InputHTMLAttributes } from 'react';
 import { IStyledComponentBase } from 'styled-components/dist/types';
-import { JSX } from 'react/jsx-runtime';
+import { JSX } from 'react';
 import { RefAttributes } from 'react';
 import { RuleSet } from 'styled-components';
 import type { Stripe } from '@stripe/stripe-js';
@@ -283,6 +283,7 @@ declare const BillingCreditGrantReason: {
     readonly Free: "free";
     readonly Plan: "plan";
     readonly Purchased: "purchased";
+    readonly Rollover: "rollover";
 };
 
 declare type BillingCreditGrantReason = (typeof BillingCreditGrantReason)[keyof typeof BillingCreditGrantReason];
@@ -300,6 +301,30 @@ declare const BillingCreditGrantZeroedOutReason: {
 
 declare type BillingCreditGrantZeroedOutReason = (typeof BillingCreditGrantZeroedOutReason)[keyof typeof BillingCreditGrantZeroedOutReason];
 
+/**
+ *
+ * @export
+ */
+declare const BillingCreditLedgerAuthority: {
+    readonly SchematicAuthoritative: "schematic_authoritative";
+    readonly ExternalMirror: "external_mirror";
+    readonly ExternalRated: "external_rated";
+};
+
+declare type BillingCreditLedgerAuthority = (typeof BillingCreditLedgerAuthority)[keyof typeof BillingCreditLedgerAuthority];
+
+/**
+ *
+ * @export
+ */
+declare const BillingCreditLedgerAuthority_2: {
+    readonly SchematicAuthoritative: "schematic_authoritative";
+    readonly ExternalMirror: "external_mirror";
+    readonly ExternalRated: "external_rated";
+};
+
+declare type BillingCreditLedgerAuthority_2 = (typeof BillingCreditLedgerAuthority_2)[keyof typeof BillingCreditLedgerAuthority_2];
+
 /**
  *
  * @export
@@ -610,6 +635,12 @@ declare interface BillingCreditView {
      * @memberof BillingCreditView
      */
     id: string;
+    /**
+     *
+     * @type {BillingCreditLedgerAuthority}
+     * @memberof BillingCreditView
+     */
+    ledgerAuthority: BillingCreditLedgerAuthority;
     /**
      *
      * @type {string}
@@ -738,6 +769,12 @@ declare interface BillingCreditView_2 {
      * @memberof BillingCreditView
      */
     id: string;
+    /**
+     *
+     * @type {BillingCreditLedgerAuthority}
+     * @memberof BillingCreditView
+     */
+    ledgerAuthority: BillingCreditLedgerAuthority_2;
     /**
      *
      * @type {string}
@@ -1082,6 +1119,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     resetType?: BillingPlanCreditGrantResetType | null;
+    /**
+     * Percentage of unused credits that carry over when this grant resets. Only meaningful when reset_type is plan_period.
+     * @type {number}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    rolloverPercentage: number;
     /**
      *
      * @type {Date}
@@ -2325,6 +2368,7 @@ declare interface BillingProductResponseData_2 {
  * @export
  */
 declare const BillingProviderType: {
+    readonly Metronome: "metronome";
     readonly Orb: "orb";
     readonly Schematic: "schematic";
     readonly Stripe: "stripe";
@@ -2337,6 +2381,7 @@ declare type BillingProviderType = (typeof BillingProviderType)[keyof typeof Bil
  * @export
  */
 declare const BillingProviderType_2: {
+    readonly Metronome: "metronome";
     readonly Orb: "orb";
     readonly Schematic: "schematic";
     readonly Stripe: "stripe";
@@ -2837,6 +2882,25 @@ export declare interface BypassConfig {
      * is not eligible for a trial.
      */
     startTrialIfAvailable?: boolean;
+    /**
+     * Currency to pre-select (e.g. "EUR"). Case-insensitive.
+     *
+     * Useful for flows that skip the plan stage: the host can pin the checkout
+     * to a currency the customer never had a chance to choose. Ignored when the
+     * company already has an active subscription (its currency is locked), or
+     * when the value is not among the available currencies — in which case the
+     * checkout falls back to the first available currency.
+     */
+    currency?: string;
+    /**
+     * Whether to show the currency selector dropdown in checkout. Default: true.
+     *
+     * Set to false to hide the dropdown entirely — combine with `currency` to
+     * pin checkout to a single currency the customer cannot change. Has no
+     * effect when there is only one available currency or the subscription
+     * currency is locked (the selector is already hidden in those cases).
+     */
+    showCurrencySelector?: boolean;
 }
 
 export declare const Card: ForwardRefExoticComponent<CardProps & RefAttributes<HTMLDivElement | null>>;
@@ -2878,6 +2942,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     creditBundles: Array<UpdateCreditBundleRequestBody>;
+    /**
+     *
+     * @type {Array<CheckoutFieldValue>}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    customFieldValues: Array<CheckoutFieldValue>;
     /**
      *
      * @type {string}
@@ -2890,6 +2960,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     newPriceId: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    optInAccepted?: boolean | null;
     /**
      *
      * @type {Array<UpdatePayInAdvanceRequestBody>}
@@ -2963,6 +3039,98 @@ declare interface CheckoutDialogProps {
     top?: number;
 }
 
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CheckoutFieldValue
+ */
+declare interface CheckoutFieldValue {
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldValue
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldValue
+     */
+    value: string;
+}
+
+/**
+ * Schematic API
+ * Schematic API
+ *
+ * The version of the OpenAPI document: 0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CheckoutFieldWithValue
+ */
+declare interface CheckoutFieldWithValue {
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldWithValue
+     */
+    definitionId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldWithValue
+     */
+    helperText?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldWithValue
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldWithValue
+     */
+    name: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CheckoutFieldWithValue
+     */
+    required: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldWithValue
+     */
+    stripeMetadataKey: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CheckoutFieldWithValue
+     */
+    value?: string | null;
+}
+
 /**
  * Configuration for pre-populating the checkout flow with host-provided values.
  *
@@ -3236,6 +3404,7 @@ export declare type CheckoutState = {
     addOnIds?: string[];
     hideSkippedStages?: boolean;
     selectedCurrency?: string;
+    showCurrencySelector?: boolean;
     startTrialIfAvailable?: boolean;
 };
 
@@ -3880,6 +4049,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     resetType: BillingPlanCreditGrantResetType;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    rolloverPercentage: number;
     /**
      * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
@@ -4729,6 +4904,12 @@ declare interface ComponentHydrateResponseData {
      * @memberof ComponentHydrateResponseData
      */
     creditGrants: Array<CreditCompanyGrantView>;
+    /**
+     *
+     * @type {Array<CheckoutFieldWithValue>}
+     * @memberof ComponentHydrateResponseData
+     */
+    customCheckoutFields: Array<CheckoutFieldWithValue>;
     /**
      *
      * @type {PlanDetailResponseData}
@@ -5261,12 +5442,30 @@ declare interface CreditCompanyGrantView {
      * @memberof CreditCompanyGrantView
      */
     renewalPeriod?: BillingPlanCreditGrantResetCadence | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreditCompanyGrantView
+     */
+    reserved?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreditCompanyGrantView
+     */
+    settled?: number | null;
     /**
      *
      * @type {string}
      * @memberof CreditCompanyGrantView
      */
     singularName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreditCompanyGrantView
+     */
+    sourceGrantId?: string | null;
     /**
      *
      * @type {string}
@@ -6740,11 +6939,23 @@ declare interface FeatureEntitlement {
      */
     creditId?: string | null;
     /**
-     * If the company has a credit-based entitlement for this feature, the remaining credit amount
+     * If the company has a credit-based entitlement for this feature, the credit available to fund new consumption or a new lease hold — open lease holds are excluded. Clients that hold a lease should gate on this plus their own unspent hold; clients with no lease awareness should use credit_settled instead
      * @type {number}
      * @memberof FeatureEntitlement
      */
     creditRemaining?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the unspent amount held by an open credit lease. Returns to credit_remaining when the lease is released
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditReserved?: number | null;
+    /**
+     * If the company has a credit-based entitlement for this feature, the balance net of actual consumption, unaffected by open lease holds (credit_remaining plus credit_reserved). The number to display to end users
+     * @type {number}
+     * @memberof FeatureEntitlement
+     */
+    creditSettled?: number | null;
     /**
      * If the company has a credit-based entitlement for this feature, the total credit amount
      * @type {number}
@@ -8812,6 +9023,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     resetType: BillingPlanCreditGrantResetType;
+    /**
+     *
+     * @type {number}
+     * @memberof PlanCreditGrantView
+     */
+    rolloverPercentage: number;
     /**
      * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
@@ -8999,6 +9216,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     resetType: BillingPlanCreditGrantResetType_2;
+    /**
+     *
+     * @type {number}
+     * @memberof PlanCreditGrantView
+     */
+    rolloverPercentage: number;
     /**
      * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
@@ -10568,6 +10791,24 @@ declare interface PreviewSubscriptionChangeResponseData {
      * @deprecated
      */
     newCharges: number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PreviewSubscriptionChangeResponseData
+     */
+    optInRequired: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionChangeResponseData
+     */
+    optInText?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionChangeResponseData
+     */
+    optInTitle?: string | null;
     /**
      *
      * @type {boolean}