@schematichq/schematic-components 1.0.6 → 1.1.1

package/dist/schematic-components.d.ts

@@ -14,6 +14,86 @@ import { RefAttributes } from 'react';
 import { RuleSet } from 'styled-components';
 import { Substitute } from 'styled-components/dist/types';
 
+/**
+ *
+ * @export
+ * @interface BillingCreditBundleView
+ */
+declare interface BillingCreditBundleView {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    bundleType: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingCreditBundleView
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    creditId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    expiryType: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    expiryUnit: string;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingCreditBundleView
+     */
+    expiryUnitCount?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    name: string;
+    /**
+     *
+     * @type {BillingProductPriceResponseData}
+     * @memberof BillingCreditBundleView
+     */
+    price?: BillingProductPriceResponseData;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingCreditBundleView
+     */
+    quantity?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditBundleView
+     */
+    status: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingCreditBundleView
+     */
+    updatedAt: Date;
+}
+
 /**
  *
  * @export
@@ -70,22 +150,22 @@ declare interface BillingCreditResponseData {
     id: string;
     /**
      *
-     * @type {BillingPriceResponseData}
+     * @type {string}
      * @memberof BillingCreditResponseData
      */
-    monthlyPrice?: BillingPriceResponseData;
+    name: string;
     /**
      *
      * @type {string}
      * @memberof BillingCreditResponseData
      */
-    name: string;
+    pluralName?: string | null;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceResponseData}
      * @memberof BillingCreditResponseData
      */
-    pluralName?: string | null;
+    price?: BillingPriceResponseData;
     /**
      *
      * @type {BillingProductResponseData}
@@ -104,12 +184,6 @@ declare interface BillingCreditResponseData {
      * @memberof BillingCreditResponseData
      */
     updatedAt: Date;
-    /**
-     *
-     * @type {BillingPriceResponseData}
-     * @memberof BillingCreditResponseData
-     */
-    yearlyPrice?: BillingPriceResponseData;
 }
 
 /**
@@ -168,22 +242,22 @@ declare interface BillingCreditResponseData_2 {
     id: string;
     /**
      *
-     * @type {BillingPriceResponseData}
+     * @type {string}
      * @memberof BillingCreditResponseData
      */
-    monthlyPrice?: BillingPriceResponseData_2;
+    name: string;
     /**
      *
      * @type {string}
      * @memberof BillingCreditResponseData
      */
-    name: string;
+    pluralName?: string | null;
     /**
      *
-     * @type {string}
+     * @type {BillingPriceResponseData}
      * @memberof BillingCreditResponseData
      */
-    pluralName?: string | null;
+    price?: BillingPriceResponseData_2;
     /**
      *
      * @type {BillingProductResponseData}
@@ -202,12 +276,6 @@ declare interface BillingCreditResponseData_2 {
      * @memberof BillingCreditResponseData
      */
     updatedAt: Date;
-    /**
-     *
-     * @type {BillingPriceResponseData}
-     * @memberof BillingCreditResponseData
-     */
-    yearlyPrice?: BillingPriceResponseData_2;
 }
 
 /**
@@ -906,6 +974,115 @@ declare interface BillingProductForSubscriptionResponseData {
     usageType: 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 BillingProductPriceResponseData
+ */
+declare interface BillingProductPriceResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    billingScheme: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingProductPriceResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    currency: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    interval: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingProductPriceResponseData
+     */
+    isActive: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    meterId?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingProductPriceResponseData
+     */
+    packageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingProductPriceResponseData
+     */
+    price: number;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    priceDecimal?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    priceExternalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    productExternalId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    tiersMode?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingProductPriceResponseData
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingProductPriceResponseData
+     */
+    usageType: string;
+}
+
 /**
  * Schematic API
  * Schematic API
@@ -1289,7 +1466,7 @@ declare interface BillingSubscriptionDiscountView {
  * Do not edit the class manually.
  */
 /**
- * The created resource
+ *
  * @export
  * @interface BillingSubscriptionResponseData
  */
@@ -1563,11 +1740,11 @@ export declare type ButtonAlignment = "start" | "center" | "end";
 
 export declare type ButtonColor = "primary" | "secondary" | "danger";
 
-export declare const ButtonElement: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps_2> & HTMLAttributes<HTMLDivElement> & {
+export declare const ButtonElement: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps> & HTMLAttributes<HTMLDivElement> & {
 portal?: HTMLElement | null;
 } & RefAttributes<HTMLDivElement | null>>;
 
-export declare type ButtonElementProps = DesignProps_2;
+export declare type ButtonElementProps = DesignProps;
 
 export declare interface ButtonProps {
     $color?: ButtonColor;
@@ -1721,6 +1898,14 @@ declare interface CompanyDetailResponseData {
      * @memberof CompanyDetailResponseData
      */
     addOns: Array<CompanyPlanWithBillingSubView>;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof CompanyDetailResponseData
+     */
+    billingCreditBalances?: {
+        [key: string]: number;
+    } | null;
     /**
      *
      * @type {BillingSubscriptionView}
@@ -1916,6 +2101,128 @@ declare interface CompanyEventPeriodMetricsResponseData {
     value: number;
 }
 
+/**
+ *
+ * @export
+ * @interface CompanyOverrideResponseData
+ */
+declare interface CompanyOverrideResponseData {
+    /**
+     *
+     * @type {CompanyDetailResponseData}
+     * @memberof CompanyOverrideResponseData
+     */
+    company?: CompanyDetailResponseData;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    companyId: string;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyOverrideResponseData
+     */
+    consumptionRate?: number | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyOverrideResponseData
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyOverrideResponseData
+     */
+    expirationDate?: Date | null;
+    /**
+     *
+     * @type {FeatureResponseData}
+     * @memberof CompanyOverrideResponseData
+     */
+    feature?: FeatureResponseData_2;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    featureId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    metricPeriod?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    metricPeriodMonthReset?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    ruleId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    ruleIdUsageExceeded?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof CompanyOverrideResponseData
+     */
+    updatedAt: Date;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueBool?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueNumeric?: number | null;
+    /**
+     *
+     * @type {EntityTraitDefinitionResponseData}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueTrait?: EntityTraitDefinitionResponseData_2;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueTraitId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyOverrideResponseData
+     */
+    valueType: string;
+}
+
 /**
  *
  * @export
@@ -2429,6 +2736,12 @@ declare interface ComponentHydrateResponseData {
      * @memberof ComponentHydrateResponseData
      */
     component?: ComponentResponseData;
+    /**
+     *
+     * @type {Array<BillingCreditBundleView>}
+     * @memberof ComponentHydrateResponseData
+     */
+    creditBundles: Array<BillingCreditBundleView>;
     /**
      *
      * @type {PlanDetailResponseData}
@@ -2680,60 +2993,60 @@ declare interface DeleteResponse {
     deleted?: boolean;
 }
 
-export declare interface DesignProps {
+declare interface DesignProps {
+    button: {
+        link: string;
+        openInNewTab: boolean;
+        text: string;
+        style: ComponentStyle;
+        size: ButtonSize;
+        fullWidth: boolean;
+        alignment: ButtonAlignment;
+        selfAlignment: ButtonSelfAlignment;
+    };
+}
+
+declare interface DesignProps_10 {
     header: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        text: string;
+        prefix: string;
     };
-    icons: {
+    price: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        style: "light" | "dark";
     };
-    entitlement: {
+    contractEndDate: {
         isVisible: boolean;
         fontStyle: FontStyle;
+        prefix: string;
     };
-    entitlementExpiration: {
+}
+
+declare interface DesignProps_2 {
+    header: {
         isVisible: boolean;
         fontStyle: FontStyle;
+        text: string;
     };
-    usage: {
+    icons: {
         isVisible: boolean;
         fontStyle: FontStyle;
+        style: "light" | "dark";
     };
-    visibleFeatures?: string[];
-}
-
-declare interface DesignProps_10 {
-    header: {
+    entitlement: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        prefix: string;
     };
-    price: {
+    entitlementExpiration: {
         isVisible: boolean;
         fontStyle: FontStyle;
     };
-    contractEndDate: {
+    usage: {
         isVisible: boolean;
         fontStyle: FontStyle;
-        prefix: string;
-    };
-}
-
-declare interface DesignProps_2 {
-    button: {
-        link: string;
-        openInNewTab: boolean;
-        text: string;
-        style: ComponentStyle;
-        size: ButtonSize;
-        fullWidth: boolean;
-        alignment: ButtonAlignment;
-        selfAlignment: ButtonSelfAlignment;
     };
+    visibleFeatures?: string[];
 }
 
 declare interface DesignProps_3 {
@@ -2950,7 +3263,7 @@ export declare interface EmbedState {
     isPending: boolean;
     stale: boolean;
     accessToken?: string;
-    data?: PublicPlansResponseData | ComponentHydrateResponseData;
+    data?: HydrateData;
     error?: Error;
     settings: EmbedSettings;
     layout: EmbedLayout;
@@ -3816,6 +4129,12 @@ declare interface FeatureUsageResponseData {
      * @memberof FeatureUsageResponseData
      */
     allocationType: FeatureUsageResponseDataAllocationTypeEnum;
+    /**
+     *
+     * @type {CompanyOverrideResponseData}
+     * @memberof FeatureUsageResponseData
+     */
+    companyOverride?: CompanyOverrideResponseData;
     /**
      *
      * @type {Date}
@@ -3870,6 +4189,12 @@ declare interface FeatureUsageResponseData {
      * @memberof FeatureUsageResponseData
      */
     plan?: PlanResponseData_2;
+    /**
+     *
+     * @type {PlanEntitlementResponseData}
+     * @memberof FeatureUsageResponseData
+     */
+    planEntitlement?: PlanEntitlementResponseData_2;
     /**
      *
      * @type {string}
@@ -4182,6 +4507,8 @@ declare type HTTPQuery = {
     [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
 };
 
+declare type HydrateData = PublicPlansResponseData | ComponentHydrateResponseData;
+
 /**
  *
  * @export
@@ -4217,9 +4544,9 @@ export declare interface IconProps extends Omit<IconProps_2, "name"> {
 
 export { iconsList }
 
-export declare const IncludedFeatures: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
+export declare const IncludedFeatures: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps_2> & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
 
-export declare type IncludedFeaturesProps = DesignProps;
+export declare type IncludedFeaturesProps = DesignProps_2;
 
 export declare const initialContext: {
     hydratePublic: () => never;
@@ -4242,7 +4569,7 @@ export declare const initialContext: {
     isPending: boolean;
     stale: boolean;
     accessToken?: string;
-    data?: PublicPlansResponseData | ComponentHydrateResponseData;
+    data?: HydrateData;
     error?: Error;
     settings: EmbedSettings;
     layout: EmbedLayout;
@@ -4269,7 +4596,7 @@ $variant?: "filled" | "outline" | "ghost" | "text";
  * Do not edit the class manually.
  */
 /**
- * The returned resource
+ *
  * @export
  * @interface InvoiceResponseData
  */
@@ -5559,12 +5886,14 @@ declare interface PreviewSubscriptionChangeResponseData {
      *
      * @type {number}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     amountOff: number;
     /**
      *
      * @type {number}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     dueNow: number;
     /**
@@ -5577,6 +5906,7 @@ declare interface PreviewSubscriptionChangeResponseData {
      *
      * @type {number}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     newCharges: number;
     /**
@@ -5589,30 +5919,35 @@ declare interface PreviewSubscriptionChangeResponseData {
      *
      * @type {number}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     percentOff: number;
     /**
      *
      * @type {Date}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     periodStart: Date;
     /**
      *
      * @type {boolean}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     promoCodeApplied: boolean;
     /**
      *
      * @type {number}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     proration: number;
     /**
      *
      * @type {Date}
      * @memberof PreviewSubscriptionChangeResponseData
+     * @deprecated
      */
     trialEnd?: Date | null;
     /**
@@ -5736,7 +6071,7 @@ declare interface PreviewSubscriptionUpcomingInvoiceLineItems {
 
 export declare const PricingTable: ForwardRefExoticComponent<ElementProps & DeepPartial<DesignProps_7> & PricingTableOptions & HTMLAttributes<HTMLDivElement> & RefAttributes<HTMLDivElement | null>>;
 
-declare type PricingTableOptions = {
+export declare type PricingTableOptions = {
     callToActionUrl?: string;
     onCallToAction?: (plan: PlanViewPublicResponseData | CompanyPlanDetailResponseData) => unknown;
 };
@@ -6736,7 +7071,10 @@ export declare function useRequest<TData>(fn: () => Promise<{
     data: TData;
 }> | undefined): [RequestState<TData>, () => Promise<void>];
 
-export declare function useTrialEnd(): number | undefined;
+export declare function useTrialEnd(): {
+    endDate: Date | undefined;
+    formatted: string | undefined;
+};
 
 export declare function useWrapChildren(elements: HTMLElement[]): boolean;