@schematichq/schematic-components 2.18.0 → 2.20.0

package/dist/schematic-components.d.ts

@@ -318,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";
@@ -909,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";
 };
@@ -922,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";
 };
@@ -2954,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>>;
@@ -3079,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.
@@ -3216,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;
@@ -3492,6 +3512,7 @@ export declare type CheckoutState = {
     showCurrencySelector?: boolean;
     startTrialIfAvailable?: boolean;
     payInAdvanceQuantities?: Record<string, number>;
+    promoCode?: string;
 };
 
 /**
@@ -6442,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;
@@ -8396,6 +8418,7 @@ export declare const initialContext: {
     setCheckoutState: () => never;
     clearCheckoutState: () => never;
     initializeWithPlan: () => never;
+    requestUnsubscribe: () => never;
     setData: () => never;
     updateSettings: () => never;
     debug: () => never;
@@ -8484,6 +8507,12 @@ declare interface InvoiceResponseData {
      * @memberof InvoiceResponseData
      */
     dueDate?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof InvoiceResponseData
+     */
+    endingBalance: number;
     /**
      *
      * @type {string}
@@ -8514,6 +8543,12 @@ declare interface InvoiceResponseData {
      * @memberof InvoiceResponseData
      */
     providerType: BillingProviderType;
+    /**
+     *
+     * @type {number}
+     * @memberof InvoiceResponseData
+     */
+    startingBalance: number;
     /**
      *
      * @type {InvoiceStatus}
@@ -9862,6 +9897,12 @@ declare interface PlanEntitlementResponseData {
      * @memberof PlanEntitlementResponseData
      */
     valueType: EntitlementValueType;
+    /**
+     *
+     * @type {Array<WarningTierResponseData>}
+     * @memberof PlanEntitlementResponseData
+     */
+    warningTiers: Array<WarningTierResponseData>;
 }
 
 /**
@@ -10044,6 +10085,12 @@ declare interface PlanEntitlementResponseData_2 {
      * @memberof PlanEntitlementResponseData
      */
     valueType: EntitlementValueType_2;
+    /**
+     *
+     * @type {Array<WarningTierResponseData>}
+     * @memberof PlanEntitlementResponseData
+     */
+    warningTiers: Array<WarningTierResponseData_2>;
 }
 
 /**
@@ -11072,6 +11119,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
      * @memberof PreviewSubscriptionFinanceResponseData
      */
     percentOff: number;
+    /**
+     *
+     * @type {Date}
+     * @memberof PreviewSubscriptionFinanceResponseData
+     */
+    periodEnd: Date;
     /**
      *
      * @type {Date}
@@ -12656,4 +12709,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 { }