@schematichq/schematic-components 1.2.0 → 1.4.0

package/dist/schematic-components.d.ts

@@ -15,6 +15,10 @@ import { RefAttributes } from 'react';
 import { RuleSet } from 'styled-components';
 import { Substitute } from 'styled-components/dist/types';
 
+declare interface AvailablePlanOptions {
+    useSelectedPeriod?: boolean;
+}
+
 /**
  *
  * @export
@@ -1876,6 +1880,12 @@ declare interface ChangeSubscriptionRequestBody {
     skipTrial: boolean;
 }
 
+export declare const CheckoutDialog: ({ top }: CheckoutDialogProps) => JSX.Element;
+
+declare interface CheckoutDialogProps {
+    top?: number;
+}
+
 /**
  *
  * @export
@@ -1896,11 +1906,19 @@ declare interface CheckoutResponse {
     params: object;
 }
 
+export declare interface CheckoutStage {
+    id: string;
+    name: string;
+    label?: string;
+    description?: string;
+}
+
 export declare type CheckoutState = {
     period?: string;
     planId?: string | null;
     addOnId?: string | null;
     usage?: boolean;
+    addOnUsage?: boolean;
     credits?: boolean;
 };
 
@@ -2374,7 +2392,7 @@ declare interface CompanyPlanDetailResponseData {
      * @type {Array<PlanCreditGrantView>}
      * @memberof CompanyPlanDetailResponseData
      */
-    includedCreditGrants: Array<PlanCreditGrantView>;
+    includedCreditGrants: Array<PlanCreditGrantView_2>;
     /**
      *
      * @type {boolean}
@@ -2810,6 +2828,12 @@ declare interface ComponentHydrateResponseData {
      * @memberof ComponentHydrateResponseData
      */
     featureUsage?: FeatureUsageDetailResponseData;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentHydrateResponseData
+     */
+    showPeriodToggle: boolean;
     /**
      *
      * @type {StripeEmbedInfo}
@@ -2920,6 +2944,8 @@ declare interface ConfigurationParameters {
 
 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_2) => UsageBasedEntitlement[];
+
 /**
  *
  * @export
@@ -3421,6 +3447,7 @@ export declare const EmbedContext: Context<EmbedContextProps>;
 
 export declare interface EmbedContextProps extends EmbedState {
     hydratePublic: () => DebouncedApiPromise<PublicPlansResponseData>;
+    hydrate: () => DebouncedApiPromise<ComponentHydrateResponseData>;
     hydrateComponent: (id: string) => DebouncedApiPromise<ComponentHydrateResponseData>;
     hydrateExternal: (fn: () => Promise<ComponentHydrateResponseData>) => DebouncedApiPromise<ComponentHydrateResponseData>;
     getUpcomingInvoice: (id: string) => DebouncedApiPromise<HydrateUpcomingInvoiceResponse>;
@@ -3799,7 +3826,7 @@ declare interface EventSummaryResponseData {
      * @type {number}
      * @memberof EventSummaryResponseData
      */
-    companyCount?: number | null;
+    companyCount: number;
     /**
      *
      * @type {string}
@@ -3829,7 +3856,7 @@ declare interface EventSummaryResponseData {
      * @type {number}
      * @memberof EventSummaryResponseData
      */
-    userCount?: number | null;
+    userCount: number;
 }
 
 /**
@@ -3854,7 +3881,7 @@ declare interface EventSummaryResponseData_2 {
      * @type {number}
      * @memberof EventSummaryResponseData
      */
-    companyCount?: number | null;
+    companyCount: number;
     /**
      *
      * @type {string}
@@ -3884,7 +3911,7 @@ declare interface EventSummaryResponseData_2 {
      * @type {number}
      * @memberof EventSummaryResponseData
      */
-    userCount?: number | null;
+    userCount: number;
 }
 
 /**
@@ -4760,6 +4787,7 @@ export declare type IncludedFeaturesProps = DesignProps_2;
 
 export declare const initialContext: {
     hydratePublic: () => never;
+    hydrate: () => never;
     hydrateComponent: () => never;
     hydrateExternal: () => never;
     getUpcomingInvoice: () => never;
@@ -5267,6 +5295,109 @@ declare interface PlanCreditGrantView {
     updatedAt: Date;
 }
 
+/**
+ * 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 PlanCreditGrantView
+ */
+declare interface PlanCreditGrantView_2 {
+    /**
+     *
+     * @type {Date}
+     * @memberof PlanCreditGrantView
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {number}
+     * @memberof PlanCreditGrantView
+     */
+    creditAmount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    creditDescription: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    creditId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    creditName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    planId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    planName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    pluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    resetCadence: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    resetStart: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCreditGrantView
+     */
+    singularName?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PlanCreditGrantView
+     */
+    updatedAt: Date;
+}
+
 /**
  *
  * @export
@@ -5929,6 +6060,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     id: string;
+    /**
+     *
+     * @type {Array<PlanCreditGrantView>}
+     * @memberof PlanViewPublicResponseData
+     */
+    includedCreditGrants: Array<PlanCreditGrantView>;
     /**
      *
      * @type {boolean}
@@ -7034,7 +7171,7 @@ declare type SelectedPlan = Plan & {
  * Do not edit the class manually.
  */
 /**
- *
+ * The returned resource
  * @export
  * @interface SetupIntentResponseData
  */
@@ -7325,6 +7462,12 @@ declare interface UpdatePaymentMethodResponse {
     params: object;
 }
 
+declare interface UsageBasedEntitlement extends PlanEntitlementResponseData_2 {
+    allocation: number;
+    usage: number;
+    quantity: number;
+}
+
 /**
  *
  * @export
@@ -7399,7 +7542,7 @@ declare interface UsageBasedEntitlementResponseData {
     yearlyUsageBasedPrice?: BillingPriceView_2;
 }
 
-export declare function useAvailablePlans(activePeriod: string): {
+export declare function useAvailablePlans(activePeriod: string, options?: AvailablePlanOptions): {
     plans: SelectedPlan[];
     addOns: SelectedPlan[];
     periods: string[];