@schematichq/schematic-components 2.7.0 → 2.8.0

package/dist/schematic-components.d.ts

@@ -501,6 +501,250 @@ declare const BillingCreditRolloverPolicy_2: {
 
 declare type BillingCreditRolloverPolicy_2 = (typeof BillingCreditRolloverPolicy_2)[keyof typeof BillingCreditRolloverPolicy_2];
 
+/**
+ *
+ * @export
+ * @interface BillingCreditView
+ */
+declare interface BillingCreditView {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    accountId: string;
+    /**
+     *
+     * @type {BillingCreditBurnStrategy}
+     * @memberof BillingCreditView
+     */
+    burnStrategy: BillingCreditBurnStrategy;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingCreditView
+     */
+    costEditable: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingCreditView
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {BillingCreditExpiryUnit}
+     * @memberof BillingCreditView
+     */
+    defaultExpiryUnit: BillingCreditExpiryUnit;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingCreditView
+     */
+    defaultExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {BillingCreditRolloverPolicy}
+     * @memberof BillingCreditView
+     */
+    defaultRolloverPolicy: BillingCreditRolloverPolicy;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    icon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    pluralName?: string | null;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof BillingCreditView
+     */
+    price?: BillingPriceView;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingCreditView
+     */
+    pricePerUnit?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    pricePerUnitDecimal?: string | null;
+    /**
+     *
+     * @type {BillingProductResponseData}
+     * @memberof BillingCreditView
+     */
+    product?: BillingProductResponseData;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    singularName?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingCreditView
+     */
+    updatedAt: Date;
+}
+
+/**
+ *
+ * @export
+ * @interface BillingCreditView
+ */
+declare interface BillingCreditView_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    accountId: string;
+    /**
+     *
+     * @type {BillingCreditBurnStrategy}
+     * @memberof BillingCreditView
+     */
+    burnStrategy: BillingCreditBurnStrategy_2;
+    /**
+     *
+     * @type {boolean}
+     * @memberof BillingCreditView
+     */
+    costEditable: boolean;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingCreditView
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {BillingCreditExpiryUnit}
+     * @memberof BillingCreditView
+     */
+    defaultExpiryUnit: BillingCreditExpiryUnit_2;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingCreditView
+     */
+    defaultExpiryUnitCount?: number | null;
+    /**
+     *
+     * @type {BillingCreditRolloverPolicy}
+     * @memberof BillingCreditView
+     */
+    defaultRolloverPolicy: BillingCreditRolloverPolicy_2;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    description: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    environmentId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    icon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    pluralName?: string | null;
+    /**
+     *
+     * @type {BillingPriceView}
+     * @memberof BillingCreditView
+     */
+    price?: BillingPriceView_2;
+    /**
+     *
+     * @type {number}
+     * @memberof BillingCreditView
+     */
+    pricePerUnit?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    pricePerUnitDecimal?: string | null;
+    /**
+     *
+     * @type {BillingProductResponseData}
+     * @memberof BillingCreditView
+     */
+    product?: BillingProductResponseData_2;
+    /**
+     *
+     * @type {string}
+     * @memberof BillingCreditView
+     */
+    singularName?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof BillingCreditView
+     */
+    updatedAt: Date;
+}
+
 /**
  *
  * @export
@@ -625,6 +869,12 @@ declare interface BillingPlanCreditGrantResponseData {
      * @memberof BillingPlanCreditGrantResponseData
      */
     createdAt: Date;
+    /**
+     *
+     * @type {BillingCreditResponseData}
+     * @memberof BillingPlanCreditGrantResponseData
+     */
+    credit?: BillingCreditResponseData;
     /**
      *
      * @type {number}
@@ -638,21 +888,24 @@ declare interface BillingPlanCreditGrantResponseData {
      */
     creditId: string;
     /**
-     *
+     * Use credit.name from the nested credit object instead
      * @type {string}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     creditName: string;
     /**
-     *
+     * Use plural_name from the nested credit object instead
      * @type {string}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     creditPluralName?: string | null;
     /**
-     *
+     * Use singular_name from the nested credit object instead
      * @type {string}
      * @memberof BillingPlanCreditGrantResponseData
+     * @deprecated
      */
     creditSingularName?: string | null;
     /**
@@ -709,13 +962,13 @@ declare interface BillingPlanCreditGrantResponseData {
      * @type {BillingPlanCreditGrantResetCadence}
      * @memberof BillingPlanCreditGrantResponseData
      */
-    resetCadence: BillingPlanCreditGrantResetCadence;
+    resetCadence?: BillingPlanCreditGrantResetCadence | null;
     /**
      *
      * @type {BillingPlanCreditGrantResetStart}
      * @memberof BillingPlanCreditGrantResponseData
      */
-    resetStart: BillingPlanCreditGrantResetStart;
+    resetStart?: BillingPlanCreditGrantResetStart | null;
     /**
      *
      * @type {BillingPlanCreditGrantResetType}
@@ -3760,6 +4013,12 @@ declare interface ComponentDisplaySettings {
      * @memberof ComponentDisplaySettings
      */
     showFeatureDescription: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showHardLimit: boolean;
     /**
      *
      * @type {boolean}
@@ -3809,6 +4068,12 @@ declare interface ComponentDisplaySettings_2 {
      * @memberof ComponentDisplaySettings
      */
     showFeatureDescription: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ComponentDisplaySettings
+     */
+    showHardLimit: boolean;
     /**
      *
      * @type {boolean}
@@ -4564,6 +4829,49 @@ declare interface CreditTransferView {
     relatedGrantId: 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 CreditUsageAggregation
+ */
+declare interface CreditUsageAggregation {
+    /**
+     * Credit usage within the current billing period
+     * @type {number}
+     * @memberof CreditUsageAggregation
+     */
+    usageThisBillingPeriod?: number | null;
+    /**
+     * Credit usage within the current calendar month
+     * @type {number}
+     * @memberof CreditUsageAggregation
+     */
+    usageThisCalendarMonth?: number | null;
+    /**
+     * Credit usage within the current calendar week (Monday to Sunday)
+     * @type {number}
+     * @memberof CreditUsageAggregation
+     */
+    usageThisWeek?: number | null;
+    /**
+     * Credit usage for the current day
+     * @type {number}
+     * @memberof CreditUsageAggregation
+     */
+    usageToday?: number | null;
+}
+
 declare interface CreditWithCompanyContext {
     id: CreditCompanyGrantView["billingCreditId"];
     name: CreditCompanyGrantView["creditName"];
@@ -5840,7 +6148,7 @@ declare interface FeatureEntitlement {
      */
     usage?: number | null;
     /**
-     *
+     * The type of the entitlement value
      * @type {EntitlementValueType}
      * @memberof FeatureEntitlement
      */
@@ -6134,7 +6442,7 @@ declare interface FeatureUsageResponseData {
      */
     allocation?: number | null;
     /**
-     *
+     * The type of allocation that is being used.
      * @type {EntitlementValueType}
      * @memberof FeatureUsageResponseData
      */
@@ -6166,7 +6474,7 @@ declare interface FeatureUsageResponseData {
      */
     creditGrantDetails?: Array<CreditGrantDetail>;
     /**
-     *
+     * Reason for the credit grant
      * @type {BillingCreditGrantReason}
      * @memberof FeatureUsageResponseData
      */
@@ -6191,11 +6499,11 @@ declare interface FeatureUsageResponseData {
      */
     creditTypeIcon?: string | null;
     /**
-     *
-     * @type {FeatureUsageResponseDataCreditUsageAggregation}
+     * Aggregated credit usage by time period (day, week, month, billing period)
+     * @type {CreditUsageAggregation}
      * @memberof FeatureUsageResponseData
      */
-    creditUsageAggregation?: FeatureUsageResponseDataCreditUsageAggregation;
+    creditUsageAggregation?: CreditUsageAggregation;
     /**
      *
      * @type {number}
@@ -6330,49 +6638,6 @@ declare interface FeatureUsageResponseData {
     yearlyUsageBasedPrice?: BillingPriceView;
 }
 
-/**
- * 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 FeatureUsageResponseDataCreditUsageAggregation
- */
-declare interface FeatureUsageResponseDataCreditUsageAggregation {
-    /**
-     * Credit usage within the current billing period
-     * @type {number}
-     * @memberof FeatureUsageResponseDataCreditUsageAggregation
-     */
-    usageThisBillingPeriod?: number | null;
-    /**
-     * Credit usage within the current calendar month
-     * @type {number}
-     * @memberof FeatureUsageResponseDataCreditUsageAggregation
-     */
-    usageThisCalendarMonth?: number | null;
-    /**
-     * Credit usage within the current calendar week (Monday to Sunday)
-     * @type {number}
-     * @memberof FeatureUsageResponseDataCreditUsageAggregation
-     */
-    usageThisWeek?: number | null;
-    /**
-     * Credit usage for the current day
-     * @type {number}
-     * @memberof FeatureUsageResponseDataCreditUsageAggregation
-     */
-    usageToday?: number | null;
-}
-
 declare type FetchAPI = WindowOrWorkerGlobalScope["fetch"];
 
 /**
@@ -6605,6 +6870,17 @@ $viewport?: {
 
 export declare type FontStyle = keyof ThemeSettings["typography"];
 
+declare interface FormatInvoiceOptions {
+    hideUpcoming?: boolean;
+}
+
+export declare function formatInvoices(invoices?: InvoiceResponseData[], options?: FormatInvoiceOptions): {
+    amount: string;
+    amountDue: number;
+    date: string;
+    url: string | undefined;
+}[];
+
 export declare const FussyChild: IStyledComponentBase<"web", FastOmit<FastOmit<FastOmit<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>, keyof ComponentProps | "$viewport"> & ComponentProps & {
 $viewport?: {
 "sm"?: TransientCSSProperties;
@@ -6903,6 +7179,12 @@ declare interface InvoiceResponseData {
      * @memberof InvoiceResponseData
      */
     providerType: BillingProviderType;
+    /**
+     *
+     * @type {InvoiceStatus}
+     * @memberof InvoiceResponseData
+     */
+    status?: InvoiceStatus | null;
     /**
      *
      * @type {string}
@@ -6937,6 +7219,20 @@ export declare type InvoicesProps = DesignProps_3 & {
     data?: InvoiceResponseData[];
 };
 
+/**
+ *
+ * @export
+ */
+declare const InvoiceStatus: {
+    readonly Draft: "draft";
+    readonly Open: "open";
+    readonly Paid: "paid";
+    readonly Uncollectible: "uncollectible";
+    readonly Void: "void";
+};
+
+declare type InvoiceStatus = (typeof InvoiceStatus)[keyof typeof InvoiceStatus];
+
 export declare const LeadingLineHeightMap: Record<LeadingNameType, number>;
 
 export declare enum LeadingName {
@@ -7264,6 +7560,12 @@ declare interface PlanCreditGrantView {
      * @memberof PlanCreditGrantView
      */
     createdAt: Date;
+    /**
+     *
+     * @type {BillingCreditView}
+     * @memberof PlanCreditGrantView
+     */
+    credit?: BillingCreditView;
     /**
      *
      * @type {number}
@@ -7271,15 +7573,17 @@ declare interface PlanCreditGrantView {
      */
     creditAmount: number;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.Description instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     creditDescription: string;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.Icon instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     creditIcon?: string | null;
     /**
@@ -7289,9 +7593,10 @@ declare interface PlanCreditGrantView {
      */
     creditId: string;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.Name instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     creditName: string;
     /**
@@ -7337,9 +7642,10 @@ declare interface PlanCreditGrantView {
      */
     planVersionId?: string | null;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.PluralName instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     pluralName?: string | null;
     /**
@@ -7347,13 +7653,13 @@ declare interface PlanCreditGrantView {
      * @type {BillingPlanCreditGrantResetCadence}
      * @memberof PlanCreditGrantView
      */
-    resetCadence: BillingPlanCreditGrantResetCadence;
+    resetCadence?: BillingPlanCreditGrantResetCadence | null;
     /**
      *
      * @type {BillingPlanCreditGrantResetStart}
      * @memberof PlanCreditGrantView
      */
-    resetStart: BillingPlanCreditGrantResetStart;
+    resetStart?: BillingPlanCreditGrantResetStart | null;
     /**
      *
      * @type {BillingPlanCreditGrantResetType}
@@ -7361,9 +7667,10 @@ declare interface PlanCreditGrantView {
      */
     resetType: BillingPlanCreditGrantResetType;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     singularName?: string | null;
     /**
@@ -7428,6 +7735,12 @@ declare interface PlanCreditGrantView_2 {
      * @memberof PlanCreditGrantView
      */
     createdAt: Date;
+    /**
+     *
+     * @type {BillingCreditView}
+     * @memberof PlanCreditGrantView
+     */
+    credit?: BillingCreditView_2;
     /**
      *
      * @type {number}
@@ -7435,15 +7748,17 @@ declare interface PlanCreditGrantView_2 {
      */
     creditAmount: number;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.Description instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     creditDescription: string;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.Icon instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     creditIcon?: string | null;
     /**
@@ -7453,9 +7768,10 @@ declare interface PlanCreditGrantView_2 {
      */
     creditId: string;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.Name instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     creditName: string;
     /**
@@ -7501,9 +7817,10 @@ declare interface PlanCreditGrantView_2 {
      */
     planVersionId?: string | null;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.PluralName instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     pluralName?: string | null;
     /**
@@ -7511,13 +7828,13 @@ declare interface PlanCreditGrantView_2 {
      * @type {BillingPlanCreditGrantResetCadence}
      * @memberof PlanCreditGrantView
      */
-    resetCadence: BillingPlanCreditGrantResetCadence_2;
+    resetCadence?: BillingPlanCreditGrantResetCadence_2 | null;
     /**
      *
      * @type {BillingPlanCreditGrantResetStart}
      * @memberof PlanCreditGrantView
      */
-    resetStart: BillingPlanCreditGrantResetStart_2;
+    resetStart?: BillingPlanCreditGrantResetStart_2 | null;
     /**
      *
      * @type {BillingPlanCreditGrantResetType}
@@ -7525,9 +7842,10 @@ declare interface PlanCreditGrantView_2 {
      */
     resetType: BillingPlanCreditGrantResetType_2;
     /**
-     *
+     * Deprecated field, will be removed in the future. Use Credit.SingularName instead.
      * @type {string}
      * @memberof PlanCreditGrantView
+     * @deprecated
      */
     singularName?: string | null;
     /**
@@ -8955,11 +9273,13 @@ export declare type PricingTableProps = DesignProps_7;
 
 export declare const ProgressBar: ForwardRefExoticComponent<ProgressBarProps & RefAttributes<HTMLDivElement>>;
 
+export declare type ProgressBarColor = "gray" | "blue" | "yellow" | "orange" | "red";
+
 export declare interface ProgressBarProps extends React.ComponentPropsWithoutRef<typeof Flex> {
     progress: number;
     value: number;
     total?: number;
-    color?: "gray" | "blue" | "yellow" | "orange" | "red";
+    color?: ProgressBarColor;
     bgColor?: string;
 }
 
@@ -9930,14 +10250,13 @@ export declare interface ThemeSettings {
     };
 }
 
-export declare const Tooltip: ({ trigger, content, portal, position, fullWidth, ...rest }: TooltipProps) => JSX.Element;
+export declare const Tooltip: ({ children, trigger, content, portal, position, ...rest }: TooltipProps) => JSX.Element;
 
 export declare interface TooltipProps extends BoxProps {
-    trigger: React.ReactNode;
+    trigger: React.ReactElement;
     content: React.ReactNode;
     portal?: HTMLElement | null;
     position?: Position;
-    fullWidth?: boolean;
 }
 
 /**