@schematichq/schematic-components 2.10.2 → 2.11.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[];
@@ -104,7 +116,7 @@ declare interface BillingCreditBundleView {
      * @type {Array<CreditBundleCurrencyPrice>}
      * @memberof BillingCreditBundleView
      */
-    currencyPrices?: Array<CreditBundleCurrencyPrice>;
+    currencyPrices: Array<CreditBundleCurrencyPrice>;
     /**
      *
      * @type {BillingCreditExpiryType}
@@ -550,6 +562,12 @@ declare interface BillingCreditView {
      * @memberof BillingCreditView
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<CreditCurrencyPrice>}
+     * @memberof BillingCreditView
+     */
+    currencyPrices: Array<CreditCurrencyPrice>;
     /**
      *
      * @type {BillingCreditExpiryUnit}
@@ -672,6 +690,12 @@ declare interface BillingCreditView_2 {
      * @memberof BillingCreditView
      */
     createdAt: Date;
+    /**
+     *
+     * @type {Array<CreditCurrencyPrice>}
+     * @memberof BillingCreditView
+     */
+    currencyPrices: Array<CreditCurrencyPrice_2>;
     /**
      *
      * @type {BillingCreditExpiryUnit}
@@ -928,6 +952,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     autoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    autoTopupSelfService: boolean;
     /**
      *
      * @type {number}
@@ -2748,6 +2778,12 @@ declare interface ChangeSubscriptionRequestBody {
      * @memberof ChangeSubscriptionRequestBody
      */
     addOnIds: Array<UpdateAddOnRequestBody>;
+    /**
+     *
+     * @type {Array<UpdateAutoTopupOverrideRequestBody>}
+     * @memberof ChangeSubscriptionRequestBody
+     */
+    autoTopupOverrides: Array<UpdateAutoTopupOverrideRequestBody>;
     /**
      *
      * @type {string}
@@ -3543,6 +3579,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
@@ -3842,10 +4083,10 @@ declare interface CompanyPlanWithBillingSubView {
     imageUrl?: string | null;
     /**
      *
-     * @type {Array<PlanCreditGrantView>}
+     * @type {Array<CompanyPlanCreditGrantView>}
      * @memberof CompanyPlanWithBillingSubView
      */
-    includedCreditGrants: Array<PlanCreditGrantView>;
+    includedCreditGrants: Array<CompanyPlanCreditGrantView>;
     /**
      *
      * @type {string}
@@ -4934,6 +5175,46 @@ declare interface CreditCompanyGrantView {
     zeroedOutReason?: BillingCreditGrantZeroedOutReason | null;
 }
 
+/**
+ *
+ * @export
+ * @interface CreditCurrencyPrice
+ */
+declare interface CreditCurrencyPrice {
+    /**
+     *
+     * @type {string}
+     * @memberof CreditCurrencyPrice
+     */
+    currency: string;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof CreditCurrencyPrice
+     */
+    price?: BillingPriceView;
+}
+
+/**
+ *
+ * @export
+ * @interface CreditCurrencyPrice
+ */
+declare interface CreditCurrencyPrice_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof CreditCurrencyPrice
+     */
+    currency: string;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof CreditCurrencyPrice
+     */
+    price?: BillingPriceView_2;
+}
+
 /**
  *
  * @export
@@ -5251,6 +5532,14 @@ declare interface CustomPlanBillingResponseData {
     updatedAt: Date;
 }
 
+export declare interface CustomPlanBillingState {
+    billing: CustomPlanBillingResponseData;
+    planName?: string;
+    deadline: Date;
+    isAwaitingActivation: boolean;
+    isAwaitingPayment: boolean;
+}
+
 /**
  *
  * @export
@@ -5754,7 +6043,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;
 
 /**
  *
@@ -5837,10 +6126,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;
 }
 
@@ -8190,7 +8479,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;
 
@@ -8236,6 +8525,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupSelfService: boolean;
     /**
      *
      * @type {number}
@@ -8417,6 +8712,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     billingCreditAutoTopupExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PlanCreditGrantView
+     */
+    billingCreditAutoTopupSelfService: boolean;
     /**
      *
      * @type {number}
@@ -9219,6 +9520,7 @@ portal?: HTMLElement | null;
 export declare type PlanManagerProps = DesignProps_6;
 
 declare interface PlanProps {
+    portal?: HTMLElement | null;
     isLoading: boolean;
     plans: SelectedPlan[];
     selectedPlan?: SelectedPlan;
@@ -9229,7 +9531,6 @@ declare interface PlanProps {
         shouldTrial?: boolean;
     }) => void;
     shouldTrial: boolean;
-    tooltipPortal?: HTMLElement | null;
     currency?: string;
 }
 
@@ -10292,15 +10593,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;
 }
 
@@ -11106,6 +11407,8 @@ declare type SharedEntitlementUsageProps = {
     quantity: number;
 };
 
+declare type Status = "idle" | "confirming" | "succeeded" | "failed";
+
 /**
  * Schematic API
  * Schematic API
@@ -11209,12 +11512,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;
 }
 
@@ -11386,6 +11691,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
@@ -11571,6 +11919,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;
@@ -11589,7 +11939,7 @@ declare interface UsePaymentConfirmationReturn {
     confirmPayment: () => Promise<void>;
     isConfirming: boolean;
     error: Error | null;
-    status: "idle" | "confirming" | "succeeded" | "failed";
+    status: Status;
     reset: () => void;
 }