@schematichq/schematic-components 2.3.1 → 2.4.0

package/dist/schematic-components.d.ts

@@ -17,6 +17,15 @@ import { RuleSet } from 'styled-components';
 import type { Stripe } from '@stripe/stripe-js';
 import { Substitute } from 'styled-components/dist/types';
 
+export declare const AddOns: ({ addOns, toggle, isLoading, period }: AddOnsProps) => JSX.Element;
+
+declare interface AddOnsProps {
+    addOns: SelectedPlan[];
+    toggle: (id: string) => void;
+    isLoading: boolean;
+    period: string;
+}
+
 declare interface AvailablePlanOptions {
     useSelectedPeriod?: boolean;
 }
@@ -740,10 +749,10 @@ declare interface BillingPriceResponseData {
     priceDecimal?: string | null;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceScheme}
      * @memberof BillingPriceResponseData
      */
-    scheme: string;
+    scheme: BillingPriceScheme;
 }
 
 /**
@@ -790,12 +799,34 @@ declare interface BillingPriceResponseData_2 {
     priceDecimal?: string | null;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceScheme}
      * @memberof BillingPriceResponseData
      */
-    scheme: string;
+    scheme: BillingPriceScheme_2;
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingPriceScheme: {
+    readonly PerUnit: "per_unit";
+    readonly Tiered: "tiered";
+};
+
+declare type BillingPriceScheme = (typeof BillingPriceScheme)[keyof typeof BillingPriceScheme];
+
+/**
+ *
+ * @export
+ */
+declare const BillingPriceScheme_2: {
+    readonly PerUnit: "per_unit";
+    readonly Tiered: "tiered";
+};
+
+declare type BillingPriceScheme_2 = (typeof BillingPriceScheme_2)[keyof typeof BillingPriceScheme_2];
+
 /**
  *
  * @export
@@ -807,6 +838,17 @@ declare const BillingPriceUsageType: {
 
 declare type BillingPriceUsageType = (typeof BillingPriceUsageType)[keyof typeof BillingPriceUsageType];
 
+/**
+ *
+ * @export
+ */
+declare const BillingPriceUsageType_2: {
+    readonly Licensed: "licensed";
+    readonly Metered: "metered";
+};
+
+declare type BillingPriceUsageType_2 = (typeof BillingPriceUsageType_2)[keyof typeof BillingPriceUsageType_2];
+
 /**
  *
  * @export
@@ -815,10 +857,10 @@ declare type BillingPriceUsageType = (typeof BillingPriceUsageType)[keyof typeof
 declare interface BillingPriceView {
     /**
      *
-     * @type {string}
+     * @type {BillingPriceScheme}
      * @memberof BillingPriceView
      */
-    billingScheme: string;
+    billingScheme: BillingPriceScheme;
     /**
      *
      * @type {Date}
@@ -935,10 +977,10 @@ declare interface BillingPriceView {
     updatedAt: Date;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceUsageType}
      * @memberof BillingPriceView
      */
-    usageType: string;
+    usageType: BillingPriceUsageType;
 }
 
 /**
@@ -949,10 +991,10 @@ declare interface BillingPriceView {
 declare interface BillingPriceView_2 {
     /**
      *
-     * @type {string}
+     * @type {BillingPriceScheme}
      * @memberof BillingPriceView
      */
-    billingScheme: string;
+    billingScheme: BillingPriceScheme_2;
     /**
      *
      * @type {Date}
@@ -1069,10 +1111,10 @@ declare interface BillingPriceView_2 {
     updatedAt: Date;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceUsageType}
      * @memberof BillingPriceView
      */
-    usageType: string;
+    usageType: BillingPriceUsageType_2;
 }
 
 /**
@@ -1269,10 +1311,10 @@ declare interface BillingProductDetailResponseData_2 {
 declare interface BillingProductForSubscriptionResponseData {
     /**
      *
-     * @type {string}
+     * @type {BillingPriceScheme}
      * @memberof BillingProductForSubscriptionResponseData
      */
-    billingScheme: string;
+    billingScheme: BillingPriceScheme;
     /**
      *
      * @type {number}
@@ -1429,10 +1471,10 @@ declare type BillingProductPriceInterval_2 = (typeof BillingProductPriceInterval
 declare interface BillingProductPriceResponseData {
     /**
      *
-     * @type {string}
+     * @type {BillingPriceScheme}
      * @memberof BillingProductPriceResponseData
      */
-    billingScheme: string;
+    billingScheme: BillingPriceScheme;
     /**
      *
      * @type {Date}
@@ -1513,10 +1555,10 @@ declare interface BillingProductPriceResponseData {
     updatedAt: Date;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceUsageType}
      * @memberof BillingProductPriceResponseData
      */
-    usageType: string;
+    usageType: BillingPriceUsageType;
 }
 
 /**
@@ -2290,12 +2332,32 @@ declare const ChargeType_2: {
 
 declare type ChargeType_2 = (typeof ChargeType_2)[keyof typeof ChargeType_2];
 
+export declare const Checkout: ({ isPaymentMethodRequired, setPaymentMethodId, updatePromoCode, confirmPaymentIntentProps, financeData, onPaymentMethodSaved, }: CheckoutProps) => JSX.Element | null;
+
 export declare const CheckoutDialog: ({ top }: CheckoutDialogProps) => JSX.Element;
 
 declare interface CheckoutDialogProps {
     top?: number;
 }
 
+declare interface CheckoutProps {
+    isPaymentMethodRequired: boolean;
+    setPaymentMethodId: (id: string) => void;
+    updatePromoCode: (code: string) => void;
+    confirmPaymentIntentProps?: ConfirmPaymentIntentProps_2 | null | undefined;
+    financeData?: PreviewSubscriptionFinanceResponseData | null;
+    onPaymentMethodSaved?: (updates: {
+        period?: string;
+        plan?: SelectedPlan;
+        shouldTrial?: boolean;
+        addOns?: SelectedPlan[];
+        payInAdvanceEntitlements?: UsageBasedEntitlement[];
+        addOnPayInAdvanceEntitlements?: UsageBasedEntitlement[];
+        creditBundles?: CreditBundle[];
+        promoCode?: string | null;
+    }) => void;
+}
+
 /**
  *
  * @export
@@ -3068,10 +3130,10 @@ declare interface CompanyPlanDetailResponseData {
     includedCreditGrants: Array<PlanCreditGrantView>;
     /**
      *
-     * @type {string}
+     * @type {CompanyPlanInvalidReason}
      * @memberof CompanyPlanDetailResponseData
      */
-    invalidReason?: CompanyPlanDetailResponseDataInvalidReasonEnum | null;
+    invalidReason?: CompanyPlanInvalidReason | null;
     /**
      *
      * @type {boolean}
@@ -3154,14 +3216,15 @@ declare interface CompanyPlanDetailResponseData {
 }
 
 /**
+ *
  * @export
  */
-declare const CompanyPlanDetailResponseDataInvalidReasonEnum: {
-    readonly FeatureUsageExceeded: "feature_usage_exceeded";
+declare const CompanyPlanInvalidReason: {
     readonly DowngradeNotPermitted: "downgrade_not_permitted";
+    readonly FeatureUsageExceeded: "feature_usage_exceeded";
 };
 
-declare type CompanyPlanDetailResponseDataInvalidReasonEnum = (typeof CompanyPlanDetailResponseDataInvalidReasonEnum)[keyof typeof CompanyPlanDetailResponseDataInvalidReasonEnum];
+declare type CompanyPlanInvalidReason = (typeof CompanyPlanInvalidReason)[keyof typeof CompanyPlanInvalidReason];
 
 /**
  *
@@ -3490,6 +3553,92 @@ declare interface ComponentCheckoutSettings {
     taxCollectionEnabled: boolean;
 }
 
+/**
+ * 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 ComponentDisplaySettings
+ */
+declare interface ComponentDisplaySettings {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showAsMonthlyPrices: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showCredits: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showPeriodToggle: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showZeroPriceAsFree: boolean;
+}
+
+/**
+ * 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 ComponentDisplaySettings
+ */
+declare interface ComponentDisplaySettings_2 {
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showAsMonthlyPrices: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showCredits: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showPeriodToggle: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showZeroPriceAsFree: boolean;
+}
+
 /**
  *
  * @export
@@ -3573,6 +3722,12 @@ declare interface ComponentHydrateResponseData {
      * @memberof ComponentHydrateResponseData
      */
     defaultPlan?: PlanDetailResponseData;
+    /**
+     *
+     * @type {ComponentDisplaySettings}
+     * @memberof ComponentHydrateResponseData
+     */
+    displaySettings: ComponentDisplaySettings;
     /**
      *
      * @type {FeatureUsageDetailResponseData}
@@ -3607,18 +3762,28 @@ declare interface ComponentHydrateResponseData {
      *
      * @type {boolean}
      * @memberof ComponentHydrateResponseData
+     * @deprecated
+     */
+    showAsMonthlyPrices: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentHydrateResponseData
+     * @deprecated
      */
     showCredits: boolean;
     /**
      *
      * @type {boolean}
      * @memberof ComponentHydrateResponseData
+     * @deprecated
      */
     showPeriodToggle: boolean;
     /**
      *
      * @type {boolean}
      * @memberof ComponentHydrateResponseData
+     * @deprecated
      */
     showZeroPriceAsFree: boolean;
     /**
@@ -3901,6 +4066,11 @@ declare interface ConfirmPaymentIntentProps {
     callback: (confirmed: boolean) => void;
 }
 
+declare interface ConfirmPaymentIntentProps_2 {
+    clientSecret: string;
+    callback: (confirmed: boolean) => void;
+}
+
 export declare const Container: IStyledComponentBase<"web", FastOmit<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
 
 export declare const createActiveUsageBasedEntitlementsReducer: (entitlements: FeatureUsageResponseData[], period: string) => (acc: UsageBasedEntitlement[], entitlement: PlanEntitlementResponseData) => UsageBasedEntitlement[];
@@ -3963,6 +4133,12 @@ declare interface CreditCompanyGrantView {
      * @memberof CreditCompanyGrantView
      */
     creditName: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CreditCompanyGrantView
+     */
+    exhaustedAt?: Date | null;
     /**
      *
      * @type {Date}
@@ -4111,6 +4287,14 @@ declare interface CreditGrantDetail {
     quantity: number;
 }
 
+export declare const Credits: ({ bundles, updateCount }: CreditsProps) => JSX.Element;
+
+declare interface CreditsProps {
+    isLoading: boolean;
+    bundles: CreditBundle[];
+    updateCount: (id: string, count: number) => void;
+}
+
 /**
  * Schematic API
  * Schematic API
@@ -4508,6 +4692,7 @@ export declare interface EmbedContextProps extends EmbedState {
     setError: (error: Error) => void;
     setLayout: (layout: EmbedLayout) => void;
     setCheckoutState: (state: CheckoutState) => void;
+    clearCheckoutState: () => void;
     initializeWithPlan: (config: string | BypassConfig) => void;
     setData: (data: HydrateDataWithCompanyContext) => void;
     updateSettings: (settings: DeepPartial<EmbedSettings>, options?: {
@@ -6068,6 +6253,7 @@ export declare const initialContext: {
     setAccessToken: () => never;
     setLayout: () => never;
     setCheckoutState: () => never;
+    clearCheckoutState: () => never;
     initializeWithPlan: () => never;
     setData: () => never;
     updateSettings: () => never;
@@ -6473,7 +6659,9 @@ declare interface PaymentMethodResponseData {
     updatedAt: Date;
 }
 
-declare type Plan = CompanyPlanDetailResponseData;
+export declare const Plan: ({ isLoading, plans, selectedPlan, period, selectPlan, shouldTrial, }: PlanProps) => JSX.Element;
+
+declare type Plan_2 = CompanyPlanDetailResponseData;
 
 /**
  *
@@ -7271,6 +7459,19 @@ portal?: HTMLElement | null;
 
 export declare type PlanManagerProps = DesignProps_6;
 
+declare interface PlanProps {
+    isLoading: boolean;
+    plans: SelectedPlan[];
+    selectedPlan?: SelectedPlan;
+    period: string;
+    selectPlan: (updates: {
+        plan: SelectedPlan;
+        period?: string;
+        shouldTrial?: boolean;
+    }) => void;
+    shouldTrial: boolean;
+}
+
 /**
  *
  * @export
@@ -7915,6 +8116,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
      * @memberof PreviewSubscriptionFinanceResponseData
      */
     taxRequireBillingDetails: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PreviewSubscriptionFinanceResponseData
+     */
+    totalPerBillingPeriod: number;
     /**
      *
      * @type {Date}
@@ -8030,22 +8237,38 @@ declare interface PublicPlansResponseData {
      * @memberof PublicPlansResponseData
      */
     capabilities?: ComponentCapabilities_2;
+    /**
+     *
+     * @type {ComponentDisplaySettings}
+     * @memberof PublicPlansResponseData
+     */
+    displaySettings: ComponentDisplaySettings_2;
     /**
      *
      * @type {boolean}
      * @memberof PublicPlansResponseData
+     * @deprecated
+     */
+    showAsMonthlyPrices: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PublicPlansResponseData
+     * @deprecated
      */
     showCredits: boolean;
     /**
      *
      * @type {boolean}
      * @memberof PublicPlansResponseData
+     * @deprecated
      */
     showPeriodToggle: boolean;
     /**
      *
      * @type {boolean}
      * @memberof PublicPlansResponseData
+     * @deprecated
      */
     showZeroPriceAsFree: boolean;
 }
@@ -8677,7 +8900,7 @@ declare type RuleRuleTypeEnum = (typeof RuleRuleTypeEnum)[keyof typeof RuleRuleT
 
 export declare const SchematicEmbed: ({ id, accessToken }: EmbedProps) => JSX.Element;
 
-declare type SelectedPlan = Plan & {
+declare type SelectedPlan = Plan_2 & {
     isSelected: boolean;
 };
 
@@ -9053,6 +9276,8 @@ declare interface UpdatePaymentMethodResponse {
     params: object;
 }
 
+export declare const Usage: ({ entitlements, updateQuantity, period }: UsageProps) => JSX.Element;
+
 declare interface UsageBasedEntitlement extends PlanEntitlementResponseData {
     allocation: number;
     usage: number;
@@ -9139,6 +9364,14 @@ declare interface UsageBasedEntitlementResponseData {
     yearlyUsageBasedPrice?: BillingPriceView;
 }
 
+declare interface UsageProps {
+    isLoading: boolean;
+    period: string;
+    selectedPlan?: SelectedPlan;
+    entitlements: UsageBasedEntitlement[];
+    updateQuantity: (id: string, quantity: number) => void;
+}
+
 export declare function useAvailablePlans(activePeriod: string, options?: AvailablePlanOptions): {
     plans: SelectedPlan[];
     addOns: SelectedPlan[];
@@ -9173,7 +9406,8 @@ export declare function useRequest<TData>(fn: () => Promise<{
 
 export declare function useTrialEnd(): {
     endDate: Date | undefined;
-    formatted: string | undefined;
+    amount: number | undefined;
+    units: string | undefined;
 };
 
 export declare function useWrapChildren(ref: React.RefObject<HTMLElement[]>): boolean;