@schematichq/schematic-components 2.17.1 → 2.19.0

package/dist/schematic-components.d.ts

@@ -49,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
@@ -294,7 +318,9 @@ declare type BillingCreditGrantReason = (typeof BillingCreditGrantReason)[keyof
  * @export
  */
 declare const BillingCreditGrantZeroedOutReason: {
+    readonly CustomerArchived: "customer_archived";
     readonly Expired: "expired";
+    readonly IntegrationUninstalled: "integration_uninstalled";
     readonly Manual: "manual";
     readonly PlanChange: "plan_change";
     readonly PlanPeriodReset: "plan_period_reset";
@@ -885,7 +911,9 @@ declare interface BillingLinkedResourceResponseData_2 {
  */
 declare const BillingPlanCreditGrantResetCadence: {
     readonly Daily: "daily";
+    readonly Every6Months: "every_6_months";
     readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
     readonly Weekly: "weekly";
     readonly Yearly: "yearly";
 };
@@ -898,7 +926,9 @@ declare type BillingPlanCreditGrantResetCadence = (typeof BillingPlanCreditGrant
  */
 declare const BillingPlanCreditGrantResetCadence_2: {
     readonly Daily: "daily";
+    readonly Every6Months: "every_6_months";
     readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
     readonly Weekly: "weekly";
     readonly Yearly: "yearly";
 };
@@ -969,8 +999,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;
     /**
@@ -992,9 +1029,10 @@ declare interface BillingPlanCreditGrantResponseData {
      */
     autoTopupExpiryUnitCount?: number | null;
     /**
-     *
+     * Derived from auto_topup_availability; use that instead.
      * @type {boolean}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     autoTopupSelfService: boolean;
     /**
@@ -1009,6 +1047,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}
@@ -2916,6 +2960,19 @@ export declare interface BypassConfig {
      * { planId: "plan_abc", payInAdvanceQuantities: { feat_seats: 3 } }
      */
     payInAdvanceQuantities?: Record<string, number>;
+    /**
+     * Promotion code to pre-apply to the checkout (a Stripe promotion code such
+     * as "SUMMER20" — the customer-facing code, not the underlying coupon id).
+     *
+     * The discount is applied on load: the previewed charges reflect it and it is
+     * sent with the final checkout request. The customer can still change or
+     * clear it via the discount field in the checkout form. Invalid codes are
+     * rejected by the backend the same way a manually entered code would be.
+     *
+     * @example
+     * { planId: "plan_abc", promoCode: "SUMMER20" }
+     */
+    promoCode?: string;
 }
 
 export declare const Card: ForwardRefExoticComponent<CardProps & RefAttributes<HTMLDivElement | null>>;
@@ -2945,6 +3002,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     autoTopupOverrides: Array<UpdateAutoTopupOverrideRequestBody>;
+    /**
+     *
+     * @type {string}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    billingEntityId?: string | null;
     /**
      *
      * @type {string}
@@ -3035,7 +3098,7 @@ declare type ChargeType_2 = (typeof ChargeType_2)[keyof typeof ChargeType_2];
 
 export declare const Checkbox: IStyledComponentBase<"web", FastOmit<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type"> & Partial<Pick<FastOmit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, keyof ClassAttributes<HTMLInputElement> | keyof InputHTMLAttributes<HTMLInputElement>> & ClassAttributes<HTMLInputElement> & InputHTMLAttributes<HTMLInputElement>, "type">>> & string;
 
-export declare const Checkout: ({ customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
+export declare const Checkout: ({ customCheckoutFields, customFieldValues, isPaymentMethodRequired, onCustomFieldChange, optInRequired, optInTitle, optInText, optInAccepted, setOptInAccepted, setPaymentMethodId, promoCode, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
 
 /**
  * Host-provided initial values used to pre-populate the checkout payment form.
@@ -3172,6 +3235,7 @@ declare interface CheckoutProps {
     optInAccepted: boolean;
     setOptInAccepted: (accepted: boolean) => void;
     setPaymentMethodId: (id: string) => void;
+    promoCode?: string | null;
     updatePromoCode: (code: string) => void;
     confirmPaymentIntentProps?: ConfirmPaymentIntentProps_2 | null | undefined;
     financeData?: PreviewSubscriptionFinanceResponseData | null;
@@ -3448,6 +3512,7 @@ export declare type CheckoutState = {
     showCurrencySelector?: boolean;
     startTrialIfAvailable?: boolean;
     payInAdvanceQuantities?: Record<string, number>;
+    promoCode?: string;
 };
 
 /**
@@ -3919,6 +3984,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupAvailability?: BillingCreditAutoTopupAvailability | null;
     /**
      *
      * @type {boolean}
@@ -3961,6 +4032,12 @@ declare interface CompanyPlanCreditGrantView {
      * @memberof CompanyPlanCreditGrantView
      */
     billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditCanBuyBundles: boolean;
     /**
      *
      * @type {number}
@@ -4179,6 +4256,12 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    companyLogoUrl?: string | null;
     /**
      *
      * @type {string}
@@ -4209,6 +4292,12 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<BillingCreditResponseData>}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    credits: Array<BillingCreditResponseData>;
     /**
      *
      * @type {Array<PlanCurrencyPricesResponseData>}
@@ -6374,6 +6463,7 @@ export declare interface EmbedContextProps extends EmbedState {
     setCheckoutState: (state: CheckoutState) => void;
     clearCheckoutState: () => void;
     initializeWithPlan: (config: string | BypassConfig) => void;
+    requestUnsubscribe: () => void;
     setData: (data: HydrateDataWithCompanyContext) => void;
     updateSettings: (settings: DeepPartial<EmbedSettings>, options?: {
         update?: boolean;
@@ -8328,6 +8418,7 @@ export declare const initialContext: {
     setCheckoutState: () => never;
     clearCheckoutState: () => never;
     initializeWithPlan: () => never;
+    requestUnsubscribe: () => never;
     setData: () => never;
     updateSettings: () => never;
     debug: () => never;
@@ -8931,6 +9022,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupAvailability?: BillingCreditAutoTopupAvailability | null;
     /**
      *
      * @type {boolean}
@@ -8973,6 +9070,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditCanBuyBundles: boolean;
     /**
      *
      * @type {Date}
@@ -9124,6 +9227,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {BillingCreditAutoTopupAvailability}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupAvailability?: BillingCreditAutoTopupAvailability_2 | null;
     /**
      *
      * @type {boolean}
@@ -9166,6 +9275,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditCanBuyBundles: boolean;
     /**
      *
      * @type {Date}
@@ -9430,6 +9545,12 @@ declare interface PlanDetailResponseData {
      * @memberof PlanDetailResponseData
      */
     companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanDetailResponseData
+     */
+    companyLogoUrl?: string | null;
     /**
      *
      * @type {string}
@@ -9454,6 +9575,12 @@ declare interface PlanDetailResponseData {
      * @memberof PlanDetailResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<BillingCreditResponseData>}
+     * @memberof PlanDetailResponseData
+     */
+    credits: Array<BillingCreditResponseData>;
     /**
      *
      * @type {Array<PlanCurrencyPricesResponseData>}
@@ -9758,6 +9885,12 @@ declare interface PlanEntitlementResponseData {
      * @memberof PlanEntitlementResponseData
      */
     valueType: EntitlementValueType;
+    /**
+     *
+     * @type {Array<WarningTierResponseData>}
+     * @memberof PlanEntitlementResponseData
+     */
+    warningTiers: Array<WarningTierResponseData>;
 }
 
 /**
@@ -9940,6 +10073,12 @@ declare interface PlanEntitlementResponseData_2 {
      * @memberof PlanEntitlementResponseData
      */
     valueType: EntitlementValueType_2;
+    /**
+     *
+     * @type {Array<WarningTierResponseData>}
+     * @memberof PlanEntitlementResponseData
+     */
+    warningTiers: Array<WarningTierResponseData_2>;
 }
 
 /**
@@ -10448,6 +10587,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     companyId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanViewPublicResponseData
+     */
+    companyLogoUrl?: string | null;
     /**
      *
      * @type {string}
@@ -10478,6 +10623,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<BillingCreditResponseData>}
+     * @memberof PlanViewPublicResponseData
+     */
+    credits: Array<BillingCreditResponseData_2>;
     /**
      *
      * @type {Array<PlanCurrencyPricesResponseData>}
@@ -12540,4 +12691,78 @@ export declare interface ViewportProps extends React.HTMLProps<HTMLDivElement> {
     portal?: HTMLElement | null;
 }
 
+/**
+ * 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 WarningTierResponseData
+ */
+declare interface WarningTierResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof WarningTierResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WarningTierResponseData
+     */
+    key: string;
+    /**
+     *
+     * @type {number}
+     * @memberof WarningTierResponseData
+     */
+    value: 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 WarningTierResponseData
+ */
+declare interface WarningTierResponseData_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof WarningTierResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WarningTierResponseData
+     */
+    key: string;
+    /**
+     *
+     * @type {number}
+     * @memberof WarningTierResponseData
+     */
+    value: number;
+}
+
 export { }