@schematichq/schematic-components 2.24.0 → 2.25.0

package/dist/schematic-components.d.ts

@@ -51,6 +51,17 @@ declare interface AvailablePlanOptions {
     useSelectedPeriod?: boolean;
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingCollectionMethod: {
+    readonly ChargeAutomatically: "charge_automatically";
+    readonly SendInvoice: "send_invoice";
+};
+
+declare type BillingCollectionMethod = (typeof BillingCollectionMethod)[keyof typeof BillingCollectionMethod];
+
 /**
  *
  * @export
@@ -3710,6 +3721,98 @@ export declare interface ColumnProps extends React.HTMLProps<HTMLDivElement> {
     basis?: string;
 }
 
+/**
+ *
+ * @export
+ * @interface CompanyBillingProfileResponseData
+ */
+declare interface CompanyBillingProfileResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    accountId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    billingCustomerId?: string | null;
+    /**
+     *
+     * @type {BillingCollectionMethod}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    collectionMethod: BillingCollectionMethod;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    companyId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    daysUntilDue?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    isDefault: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    name?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    paymentMethodId?: string | null;
+    /**
+     *
+     * @type {ProrationBehavior}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    prorationBehavior?: ProrationBehavior | null;
+    /**
+     *
+     * @type {BillingProviderType}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    providerType: BillingProviderType;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyBillingProfileResponseData
+     */
+    updatedAt: Date;
+}
+
 /**
  *
  * @export
@@ -3744,6 +3847,18 @@ declare interface CompanyDetailResponseData {
     billingCreditBalances?: {
         [key: string]: number;
     } | null;
+    /**
+     *
+     * @type {CompanyBillingProfileResponseData}
+     * @memberof CompanyDetailResponseData
+     */
+    billingProfile?: CompanyBillingProfileResponseData;
+    /**
+     *
+     * @type {Array<CompanyBillingProfileResponseData>}
+     * @memberof CompanyDetailResponseData
+     */
+    billingProfiles?: Array<CompanyBillingProfileResponseData> | null;
     /**
      *
      * @type {BillingSubscriptionView}
@@ -3834,6 +3949,12 @@ declare interface CompanyDetailResponseData {
      * @memberof CompanyDetailResponseData
      */
     paymentMethods: Array<PaymentMethodResponseData>;
+    /**
+     *
+     * @type {PendingMigrationResponseData}
+     * @memberof CompanyDetailResponseData
+     */
+    pendingMigration?: PendingMigrationResponseData;
     /**
      *
      * @type {CompanyPlanWithBillingSubView}
@@ -4109,6 +4230,18 @@ declare interface CompanyOverrideResponseData {
      * @memberof CompanyOverrideResponseData
      */
     valueBool?: boolean | null;
+    /**
+     *
+     * @type {BillingCreditResponseData}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueCredit?: BillingCreditResponseData;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueCreditId?: string | null;
     /**
      *
      * @type {number}
@@ -5392,10 +5525,10 @@ declare interface ComponentHydrateResponseData {
     trialPaymentMethodRequired?: boolean | null;
     /**
      *
-     * @type {InvoiceResponseData}
+     * @type {UpcomingInvoiceResponseData}
      * @memberof ComponentHydrateResponseData
      */
-    upcomingInvoice?: InvoiceResponseData;
+    upcomingInvoice?: UpcomingInvoiceResponseData;
 }
 
 declare interface ComponentProps extends TransientCSSProperties {
@@ -6265,6 +6398,12 @@ declare interface CustomPlanBillingResponseData {
      * @memberof CustomPlanBillingResponseData
      */
     planId: string;
+    /**
+     * Whether the shortened period the renewal date created was billed pro rata when the subscription started. False means that period is free and the first invoice is the one raised on the renewal date.
+     * @type {boolean}
+     * @memberof CustomPlanBillingResponseData
+     */
+    prorateFirstPeriod?: boolean | null;
     /**
      *
      * @type {Date}
@@ -6701,7 +6840,7 @@ declare interface ElementProps {
 
 export declare const EmbedContext: Context<EmbedContextProps>;
 
-export declare interface EmbedContextProps extends EmbedState {
+export declare interface EmbedContextProps extends Omit<EmbedState, SettingsLayer> {
     hydratePublic: () => DebouncedApiPromise<PublicPlansResponseData>;
     hydrate: () => DebouncedApiPromise<HydrateDataWithCompanyContext>;
     hydrateComponent: (id: string) => DebouncedApiPromise<HydrateDataWithCompanyContext>;
@@ -6727,9 +6866,22 @@ export declare interface EmbedContextProps extends EmbedState {
     initializeWithPlan: (config: string | BypassConfig) => void;
     requestUnsubscribe: () => void;
     setData: (data: HydrateDataWithCompanyContext) => void;
+    /**
+     * Apply settings from the consuming app. These take precedence over the design
+     * stored in the dashboard regardless of which arrives first, and survive the
+     * re-hydration that follows a checkout or unsubscribe. Pass `{ update: true }`
+     * to merge into the current values rather than replace them.
+     */
     updateSettings: (settings: DeepPartial<EmbedSettings>, options?: {
         update?: boolean;
     }) => void;
+    /**
+     * Apply the design authored in the dashboard. Internal: `SchematicEmbed` calls
+     * this with the settings inflated from the component AST. Anything supplied via
+     * {@link EmbedContextProps.updateSettings} or the provider's `settings` prop
+     * wins over it.
+     */
+    setBuilderSettings: (settings: DeepPartial<EmbedSettings>) => void;
     debug: (message: string, ...args: unknown[]) => void;
 }
 
@@ -6780,7 +6932,17 @@ export declare interface EmbedState {
     accessToken?: string;
     data?: HydrateDataWithCompanyContext;
     error?: Error;
+    /**
+     * The effective settings, derived from the layers below. Read this; write to
+     * the layers via an `UPDATE_SETTINGS` action.
+     */
     settings: EmbedSettings;
+    /** Lowest-precedence layer: settings applied without an explicit source. */
+    baseSettings: DeepPartial<EmbedSettings>;
+    /** The design stored in the dashboard, applied once the component hydrates. */
+    builderSettings: DeepPartial<EmbedSettings>;
+    /** Runtime settings from the consuming app; these win over the stored design. */
+    settingsOverrides: DeepPartial<EmbedSettings>;
     layout: EmbedLayout;
     checkoutState?: CheckoutState;
     currencyFilter?: string[];
@@ -8604,10 +8766,10 @@ declare type HydrateDataWithCompanyContext = ComponentHydrateResponseData;
 declare interface HydrateUpcomingInvoiceResponse {
     /**
      *
-     * @type {InvoiceResponseData}
+     * @type {UpcomingInvoiceResponseData}
      * @memberof HydrateUpcomingInvoiceResponse
      */
-    data: InvoiceResponseData;
+    data: UpcomingInvoiceResponseData;
     /**
      * Input parameters
      * @type {object}
@@ -8661,6 +8823,7 @@ export declare const initialContext: {
     requestUnsubscribe: () => never;
     setData: () => never;
     updateSettings: () => never;
+    setBuilderSettings: () => never;
     debug: () => never;
     finishCheckout: () => never;
     isPending: boolean;
@@ -8669,6 +8832,9 @@ export declare const initialContext: {
     data?: HydrateDataWithCompanyContext;
     error?: Error;
     settings: EmbedSettings;
+    baseSettings: DeepPartial<EmbedSettings>;
+    builderSettings: DeepPartial<EmbedSettings>;
+    settingsOverrides: DeepPartial<EmbedSettings>;
     layout: EmbedLayout;
     checkoutState?: CheckoutState;
     currencyFilter?: string[];
@@ -9146,11 +9312,70 @@ declare interface PaymentMethodResponseData {
     updatedAt: Date;
 }
 
+/**
+ * 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 PendingMigrationResponseData
+ */
+declare interface PendingMigrationResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof PendingMigrationResponseData
+     */
+    migrationId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof PendingMigrationResponseData
+     */
+    scheduledFor?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PendingMigrationResponseData
+     */
+    toPlanId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PendingMigrationResponseData
+     */
+    toPlanName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PendingMigrationResponseData
+     */
+    toPlanVersionId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PendingMigrationResponseData
+     */
+    toPlanVersionNumber?: number | null;
+}
+
 declare interface PerLicenseCreditGrant {
     /** credits granted per unit of the license */
     amount: number;
-    /** the license whose quantity scales the grant */
-    licenseId: string;
+    /**
+     * The license whose quantity scales the grant. Undefined when the grant
+     * declares per-license scaling without naming a license: the per-unit copy
+     * still holds, but no effective total can be resolved from it.
+     */
+    licenseId?: string;
 }
 
 export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, currency, }: PlanProps) => JSX.Element;
@@ -11524,6 +11749,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
      * @memberof PreviewSubscriptionFinanceResponseData
      */
     proration: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof PreviewSubscriptionFinanceResponseData
+     */
+    prorationBilledAt?: Date | null;
     /**
      *
      * @type {number}
@@ -11738,6 +11969,9 @@ declare type RequestState<TData> = {
 
 export declare const ResetStyle: RuleSet<object>;
 
+/** Collapse the settings layers into the effective settings. */
+export declare const resolveSettings: (layers: Pick<EmbedState, SettingsLayer>) => EmbedSettings;
+
 declare interface ResponseContext {
     fetch: FetchAPI;
     url: string;
@@ -11904,6 +12138,12 @@ declare interface RuleConditionDetailResponseData {
      * @memberof RuleConditionDetailResponseData
      */
     operator: ComparableOperator;
+    /**
+     *
+     * @type {Array<RuleConditionPlanVersionResponseData>}
+     * @memberof RuleConditionDetailResponseData
+     */
+    planVersions?: Array<RuleConditionPlanVersionResponseData>;
     /**
      *
      * @type {Array<string>}
@@ -12038,6 +12278,12 @@ declare interface RuleConditionDetailResponseData_2 {
      * @memberof RuleConditionDetailResponseData
      */
     operator: ComparableOperator_2;
+    /**
+     *
+     * @type {Array<RuleConditionPlanVersionResponseData>}
+     * @memberof RuleConditionDetailResponseData
+     */
+    planVersions?: Array<RuleConditionPlanVersionResponseData_2>;
     /**
      *
      * @type {Array<string>}
@@ -12188,6 +12434,70 @@ declare interface RuleConditionGroupDetailResponseData_2 {
     updatedAt: Date;
 }
 
+/**
+ *
+ * @export
+ * @interface RuleConditionPlanVersionResponseData
+ */
+declare interface RuleConditionPlanVersionResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    name: string;
+    /**
+     *
+     * @type {PlanVersionStatus}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    status: PlanVersionStatus;
+    /**
+     *
+     * @type {number}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    version: number;
+}
+
+/**
+ *
+ * @export
+ * @interface RuleConditionPlanVersionResponseData
+ */
+declare interface RuleConditionPlanVersionResponseData_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    name: string;
+    /**
+     *
+     * @type {PlanVersionStatus}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    status: PlanVersionStatus_2;
+    /**
+     *
+     * @type {number}
+     * @memberof RuleConditionPlanVersionResponseData
+     */
+    version: number;
+}
+
 /**
  *
  * @export
@@ -12477,6 +12787,34 @@ export declare interface SelectedProps {
     isTrial?: boolean;
 }
 
+export declare const SETTINGS_LAYER_BY_SOURCE: Record<SettingsSource, SettingsLayer>;
+
+/**
+ * The settings layers in ascending order of precedence. `settings` is derived
+ * from these by {@link resolveSettings}; nothing should assign to it directly.
+ */
+export declare const SETTINGS_LAYERS: readonly ["baseSettings", "builderSettings", "settingsOverrides"];
+
+export declare type SettingsLayer = (typeof SETTINGS_LAYERS)[number];
+
+/**
+ * Where a settings update came from. Settings are layered rather than
+ * last-writer-wins, because the two producers arrive in a fixed and unhelpful
+ * order: the consuming app supplies its theme on mount, while the design stored
+ * in the dashboard is only known once the component has hydrated. Layering lets
+ * a runtime theme survive hydration (and every re-hydration after a checkout).
+ *
+ * - `builder`: the design authored in the Schematic dashboard, inflated from the
+ *   component AST.
+ * - `consumer`: the `settings` prop on `EmbedProvider` and `updateSettings()`
+ *   calls made by the consuming app. Wins over the stored design.
+ *
+ * An update with no source lands in the lowest layer; it is how the provider's
+ * `prefers-color-scheme` listener contributes a default without overriding
+ * either of the above.
+ */
+export declare type SettingsSource = "builder" | "consumer";
+
 /**
  * Schematic API
  * Schematic API
@@ -12849,6 +13187,134 @@ export declare const UpcomingBill: ForwardRefExoticComponent<ElementProps & Deep
 
 export declare type UpcomingBillProps = DesignProps_10;
 
+/**
+ *
+ * @export
+ * @interface UpcomingInvoiceResponseData
+ */
+declare interface UpcomingInvoiceResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    amountDue: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    amountPaid: number;
+    /**
+     *
+     * @type {number}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    amountRemaining: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    collectionMethod: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    companyId?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    currency: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    customerExternalId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    dueDate?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    endingBalance: number;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    externalId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    paymentMethodExternalId?: string | null;
+    /**
+     *
+     * @type {BillingProviderType}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    providerType: BillingProviderType;
+    /**
+     *
+     * @type {number}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    startingBalance: number;
+    /**
+     *
+     * @type {InvoiceStatus}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    status?: InvoiceStatus | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    subscriptionExternalId?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    subtotal: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof UpcomingInvoiceResponseData
+     */
+    url?: string | null;
+}
+
 /**
  * Schematic API
  * Schematic API