@schematichq/schematic-components 2.10.3 → 2.12.0

package/dist/schematic-components.d.ts

@@ -27,6 +27,18 @@ declare interface AddOnsProps {
     currency?: string;
 }
 
+export declare const AutoTopup: ({ planCreditGrants, autoTopupConfigs, updateAutoTopupConfig, }: AutoTopupProps) => JSX.Element;
+
+declare type AutoTopupConfig = Pick<CompanyPlanCreditGrantView, "companyAutoTopupEnabled" | "companyAutoTopupThresholdCredits" | "companyAutoTopupAmount">;
+
+declare interface AutoTopupProps {
+    isLoading: boolean;
+    planCreditGrants: PlanCreditGrantView[];
+    autoTopupConfigs: Map<string, AutoTopupConfig>;
+    updateAutoTopupConfig: (id: string, config: Partial<AutoTopupConfig>) => void;
+    currency?: string;
+}
+
 export declare interface AvailableCurrenciesResult {
     currencies: string[];
     invalidFilterEntries: string[];
@@ -940,6 +952,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     autoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    autoTopupSelfService: boolean;
     /**
      *
      * @type {number}
@@ -1102,6 +1120,12 @@ declare interface BillingPriceResponseData {
      * @memberof BillingPriceResponseData
      */
     interval: BillingProductPriceInterval;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingPriceResponseData
+     */
+    intervalCount: number;
     /**
      *
      * @type {string}
@@ -1164,6 +1188,12 @@ declare interface BillingPriceResponseData_2 {
      * @memberof BillingPriceResponseData
      */
     interval: BillingProductPriceInterval_2;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingPriceResponseData
+     */
+    intervalCount: number;
     /**
      *
      * @type {string}
@@ -1276,6 +1306,12 @@ declare interface BillingPriceView {
      * @memberof BillingPriceView
      */
     interval: BillingProductPriceInterval;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingPriceView
+     */
+    intervalCount: number;
     /**
      *
      * @type {boolean}
@@ -1422,6 +1458,12 @@ declare interface BillingPriceView_2 {
      * @memberof BillingPriceView
      */
     interval: BillingProductPriceInterval_2;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingPriceView
+     */
+    intervalCount: number;
     /**
      *
      * @type {boolean}
@@ -1784,6 +1826,12 @@ declare interface BillingProductForSubscriptionResponseData {
      * @memberof BillingProductForSubscriptionResponseData
      */
     interval: string;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingProductForSubscriptionResponseData
+     */
+    intervalCount?: number | null;
     /**
      *
      * @type {string}
@@ -1932,6 +1980,12 @@ declare interface BillingProductPriceResponseData {
      * @memberof BillingProductPriceResponseData
      */
     interval: BillingProductPriceInterval;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingProductPriceResponseData
+     */
+    intervalCount: number;
     /**
      *
      * @type {boolean}
@@ -2760,6 +2814,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     addOnIds: Array<UpdateAddOnRequestBody>;
+    /**
+     *
+     * @type {Array<UpdateAutoTopupOverrideRequestBody>}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    autoTopupOverrides: Array<UpdateAutoTopupOverrideRequestBody>;
     /**
      *
      * @type {string}
@@ -3555,6 +3615,211 @@ declare interface CompanyOverrideResponseData {
     valueType: EntitlementValueType;
 }
 
+/**
+ *
+ * @export
+ * @interface CompanyPlanCreditGrantView
+ */
+declare interface CompanyPlanCreditGrantView {
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupAmount?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupAmountType?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupEnabled: boolean;
+    /**
+     *
+     * @type {BillingCreditExpiryType}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupExpiryType?: BillingCreditExpiryType | null;
+    /**
+     *
+     * @type {BillingCreditExpiryUnit}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupExpiryUnit?: BillingCreditExpiryUnit | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupSelfService: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupThresholdCredits?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    billingCreditAutoTopupThresholdPercent?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    companyAutoTopupAmount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    companyAutoTopupEnabled?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    companyAutoTopupThresholdCredits?: number | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {BillingCreditView}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    credit?: BillingCreditView;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    creditAmount: number;
+    /**
+     * Deprecated field, will be removed in the future. Use Credit.Description instead.
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     * @deprecated
+     */
+    creditDescription: string;
+    /**
+     * Deprecated field, will be removed in the future. Use Credit.Icon instead.
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     * @deprecated
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    creditId: string;
+    /**
+     * Deprecated field, will be removed in the future. Use Credit.Name instead.
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     * @deprecated
+     */
+    creditName: string;
+    /**
+     *
+     * @type {BillingCreditExpiryType}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    expiryType?: BillingCreditExpiryType | null;
+    /**
+     *
+     * @type {BillingCreditExpiryUnit}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    expiryUnit?: BillingCreditExpiryUnit | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    expiryUnitCount?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    id: string;
+    /**
+     *
+     * @type {GenericPreviewObject}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    plan?: GenericPreviewObject;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    planId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    planVersionId?: string | null;
+    /**
+     * Deprecated field, will be removed in the future. Use Credit.PluralName instead.
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     * @deprecated
+     */
+    pluralName?: string | null;
+    /**
+     *
+     * @type {BillingPlanCreditGrantResetCadence}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    resetCadence?: BillingPlanCreditGrantResetCadence | null;
+    /**
+     *
+     * @type {BillingPlanCreditGrantResetStart}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    resetStart?: BillingPlanCreditGrantResetStart | null;
+    /**
+     *
+     * @type {BillingPlanCreditGrantResetType}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    resetType: BillingPlanCreditGrantResetType;
+    /**
+     * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
+     * @type {string}
+     * @memberof CompanyPlanCreditGrantView
+     * @deprecated
+     */
+    singularName?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyPlanCreditGrantView
+     */
+    updatedAt: Date;
+}
+
 /**
  *
  * @export
@@ -3761,6 +4026,12 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     planType: PlanType;
+    /**
+     *
+     * @type {BillingPriceResponseData}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    quarterlyPrice?: BillingPriceResponseData;
     /**
      *
      * @type {number}
@@ -3854,10 +4125,10 @@ declare interface CompanyPlanWithBillingSubView {
     imageUrl?: string | null;
     /**
      *
-     * @type {Array<PlanCreditGrantView>}
+     * @type {Array<CompanyPlanCreditGrantView>}
      * @memberof CompanyPlanWithBillingSubView
      */
-    includedCreditGrants: Array<PlanCreditGrantView>;
+    includedCreditGrants: Array<CompanyPlanCreditGrantView>;
     /**
      *
      * @type {string}
@@ -5303,6 +5574,14 @@ declare interface CustomPlanBillingResponseData {
     updatedAt: Date;
 }
 
+export declare interface CustomPlanBillingState {
+    billing: CustomPlanBillingResponseData;
+    planName?: string;
+    deadline: Date;
+    isAwaitingActivation: boolean;
+    isAwaitingPayment: boolean;
+}
+
 /**
  *
  * @export
@@ -5806,7 +6085,7 @@ export declare interface EmbedState {
     currencyFilter?: string[];
 }
 
-export declare const Entitlement: ({ entitlement, period, credits, tooltipPortal, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
+export declare const Entitlement: ({ portal, entitlement, period, credits, currency: selectedCurrency, }: EntitlementProps) => JSX.Element;
 
 /**
  *
@@ -5826,6 +6105,12 @@ declare interface EntitlementCurrencyPricesResponseData {
      * @memberof EntitlementCurrencyPricesResponseData
      */
     monthlyPrice?: BillingPriceView;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof EntitlementCurrencyPricesResponseData
+     */
+    quarterlyPrice?: BillingPriceView;
     /**
      *
      * @type {BillingPriceView}
@@ -5852,6 +6137,12 @@ declare interface EntitlementCurrencyPricesResponseData_2 {
      * @memberof EntitlementCurrencyPricesResponseData
      */
     monthlyPrice?: BillingPriceView_2;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof EntitlementCurrencyPricesResponseData
+     */
+    quarterlyPrice?: BillingPriceView_2;
     /**
      *
      * @type {BillingPriceView}
@@ -5889,10 +6180,10 @@ declare const EntitlementPriceBehavior_2: {
 declare type EntitlementPriceBehavior_2 = (typeof EntitlementPriceBehavior_2)[keyof typeof EntitlementPriceBehavior_2];
 
 export declare interface EntitlementProps {
+    portal?: HTMLElement | null;
     entitlement: PlanEntitlementResponseData;
     period: string;
     credits: Credit[];
-    tooltipPortal?: HTMLElement | null;
     currency?: string;
 }
 
@@ -7099,6 +7390,12 @@ declare interface FeatureUsageResponseData {
      * @memberof FeatureUsageResponseData
      */
     priceBehavior?: EntitlementPriceBehavior | null;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof FeatureUsageResponseData
+     */
+    quarterlyUsageBasedPrice?: BillingPriceView;
     /**
      * The soft limit for the feature usage. Available only for overage price behavior
      * @type {number}
@@ -8242,7 +8539,7 @@ declare interface PaymentMethodResponseData {
     updatedAt: Date;
 }
 
-export declare const Plan: ({ isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, tooltipPortal, currency, }: PlanProps) => JSX.Element;
+export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, currency, }: PlanProps) => JSX.Element;
 
 declare type Plan_2 = CompanyPlanDetailResponseData;
 
@@ -8288,6 +8585,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupSelfService: boolean;
     /**
      *
      * @type {number}
@@ -8469,6 +8772,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupSelfService: boolean;
     /**
      *
      * @type {number}
@@ -8632,6 +8941,12 @@ declare interface PlanCurrencyPricesResponseData {
      * @memberof PlanCurrencyPricesResponseData
      */
     oneTimePrice?: BillingPriceResponseData;
+    /**
+     *
+     * @type {BillingPriceResponseData}
+     * @memberof PlanCurrencyPricesResponseData
+     */
+    quarterlyPrice?: BillingPriceResponseData;
     /**
      *
      * @type {BillingPriceResponseData}
@@ -8664,6 +8979,12 @@ declare interface PlanCurrencyPricesResponseData_2 {
      * @memberof PlanCurrencyPricesResponseData
      */
     oneTimePrice?: BillingPriceResponseData_2;
+    /**
+     *
+     * @type {BillingPriceResponseData}
+     * @memberof PlanCurrencyPricesResponseData
+     */
+    quarterlyPrice?: BillingPriceResponseData_2;
     /**
      *
      * @type {BillingPriceResponseData}
@@ -8830,6 +9151,12 @@ declare interface PlanDetailResponseData {
      * @memberof PlanDetailResponseData
      */
     planType: PlanType;
+    /**
+     *
+     * @type {BillingPriceResponseData}
+     * @memberof PlanDetailResponseData
+     */
+    quarterlyPrice?: BillingPriceResponseData;
     /**
      *
      * @type {number}
@@ -8922,6 +9249,12 @@ declare interface PlanEntitlementResponseData {
      * @memberof PlanEntitlementResponseData
      */
     meteredMonthlyPrice?: BillingPriceView;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof PlanEntitlementResponseData
+     */
+    meteredQuarterlyPrice?: BillingPriceView;
     /**
      *
      * @type {BillingPriceView}
@@ -9092,6 +9425,12 @@ declare interface PlanEntitlementResponseData_2 {
      * @memberof PlanEntitlementResponseData
      */
     meteredMonthlyPrice?: BillingPriceView_2;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof PlanEntitlementResponseData
+     */
+    meteredQuarterlyPrice?: BillingPriceView_2;
     /**
      *
      * @type {BillingPriceView}
@@ -9271,6 +9610,7 @@ portal?: HTMLElement | null;
 export declare type PlanManagerProps = DesignProps_6;
 
 declare interface PlanProps {
+    portal?: HTMLElement | null;
     isLoading: boolean;
     plans: SelectedPlan[];
     selectedPlan?: SelectedPlan;
@@ -9281,7 +9621,6 @@ declare interface PlanProps {
         shouldTrial?: boolean;
     }) => void;
     shouldTrial: boolean;
-    tooltipPortal?: HTMLElement | null;
     currency?: string;
 }
 
@@ -9805,6 +10144,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     planType: PlanType_2;
+    /**
+     *
+     * @type {BillingPriceResponseData}
+     * @memberof PlanViewPublicResponseData
+     */
+    quarterlyPrice?: BillingPriceResponseData_2;
     /**
      *
      * @type {number}
@@ -10344,15 +10689,15 @@ declare interface PublicPlansResponseData {
     showZeroPriceAsFree: boolean;
 }
 
-export declare const Quantity: ({ entitlements, updateQuantity, period, tooltipPortal, currency: selectedCurrency, }: QuantityProps) => JSX.Element;
+export declare const Quantity: ({ portal, entitlements, updateQuantity, period, currency: selectedCurrency, }: QuantityProps) => JSX.Element;
 
 declare interface QuantityProps {
+    portal?: HTMLElement | null;
     isLoading: boolean;
     period: string;
     selectedPlan?: SelectedPlan;
     entitlements: UsageBasedEntitlement[];
     updateQuantity: (id: string, quantity: number) => void;
-    tooltipPortal?: HTMLElement | null;
     currency?: string;
 }
 
@@ -11158,6 +11503,8 @@ declare type SharedEntitlementUsageProps = {
     quantity: number;
 };
 
+declare type Status = "idle" | "confirming" | "succeeded" | "failed";
+
 /**
  * Schematic API
  * Schematic API
@@ -11261,12 +11608,14 @@ export declare interface ThemeSettings {
     };
 }
 
-export declare const Tooltip: ({ children, trigger, content, portal, position, ...rest }: TooltipProps) => JSX.Element;
+export declare const Toggle: 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 Tooltip: ({ children, portal, trigger, content, position, ...rest }: TooltipProps) => JSX.Element;
 
 export declare interface TooltipProps extends BoxProps {
-    trigger: React.ReactElement;
-    content: React.ReactNode;
     portal?: HTMLElement | null;
+    trigger: React.ReactElement<BoxProps & React.HTMLAttributes<HTMLElement> & React.RefAttributes<HTMLElement>>;
+    content: React.ReactNode;
     position?: Position;
 }
 
@@ -11438,6 +11787,49 @@ declare interface UpdateAddOnRequestBody {
     priceId: 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 UpdateAutoTopupOverrideRequestBody
+ */
+declare interface UpdateAutoTopupOverrideRequestBody {
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateAutoTopupOverrideRequestBody
+     */
+    autoTopupAmount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof UpdateAutoTopupOverrideRequestBody
+     */
+    autoTopupEnabled?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof UpdateAutoTopupOverrideRequestBody
+     */
+    autoTopupThresholdCredits?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateAutoTopupOverrideRequestBody
+     */
+    planCreditGrantId: string;
+}
+
 /**
  * Schematic API
  * Schematic API
@@ -11576,6 +11968,12 @@ declare interface UsageBasedEntitlementResponseData {
      * @memberof UsageBasedEntitlementResponseData
      */
     priceBehavior?: EntitlementPriceBehavior | null;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof UsageBasedEntitlementResponseData
+     */
+    quarterlyUsageBasedPrice?: BillingPriceView;
     /**
      *
      * @type {boolean}
@@ -11623,6 +12021,8 @@ export declare function useAvailablePlans(activePeriod: string, options?: Availa
     periods: string[];
 };
 
+export declare function useCustomPlanBilling(): CustomPlanBillingState | undefined;
+
 export declare const useEmbed: () => EmbedContextProps;
 
 export declare function useIsLightBackground(): boolean;
@@ -11641,7 +12041,7 @@ declare interface UsePaymentConfirmationReturn {
     confirmPayment: () => Promise<void>;
     isConfirming: boolean;
     error: Error | null;
-    status: "idle" | "confirming" | "succeeded" | "failed";
+    status: Status;
     reset: () => void;
 }