@schematichq/schematic-components 2.20.0 → 2.21.0

package/dist/schematic-components.d.ts

@@ -321,6 +321,7 @@ declare const BillingCreditGrantZeroedOutReason: {
     readonly CustomerArchived: "customer_archived";
     readonly Expired: "expired";
     readonly IntegrationUninstalled: "integration_uninstalled";
+    readonly LicenseRetired: "license_retired";
     readonly Manual: "manual";
     readonly PlanChange: "plan_change";
     readonly PlanPeriodReset: "plan_period_reset";
@@ -4232,6 +4233,12 @@ declare interface CompanyPlanDetailResponseData {
      * @memberof CompanyPlanDetailResponseData
      */
     billingStrategy: BillingStrategy;
+    /**
+     *
+     * @type {Array<PlanCatalogMembershipResponseData>}
+     * @memberof CompanyPlanDetailResponseData
+     */
+    catalogs?: Array<PlanCatalogMembershipResponseData>;
     /**
      *
      * @type {ChargeType}
@@ -5167,6 +5174,12 @@ declare interface ComponentResponseData {
     ast?: {
         [key: string]: number;
     };
+    /**
+     *
+     * @type {string}
+     * @memberof ComponentResponseData
+     */
+    catalogId?: string | null;
     /**
      *
      * @type {Date}
@@ -6480,7 +6493,7 @@ export declare interface EmbedProps {
     accessToken?: string;
 }
 
-export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, checkoutPrefill, ...options }: EmbedProviderProps) => JSX.Element;
+export declare const EmbedProvider: ({ children, apiKey, apiConfig, currencyFilter, warningThresholdConfig, checkoutPrefill, ...options }: EmbedProviderProps) => JSX.Element;
 
 export declare interface EmbedProviderProps {
     children: React.ReactNode;
@@ -6494,6 +6507,12 @@ export declare interface EmbedProviderProps {
      * ISO-4217 codes; case-insensitive. Omit to disable filtering.
      */
     currencyFilter?: string[];
+    /**
+     * Controls how entitlement warning thresholds are displayed across components.
+     * Set `{ showAsLimit: true }` to display the configured warning threshold in
+     * place of an entitlement's hard limit. Omit to keep the default behavior.
+     */
+    warningThresholdConfig?: WarningThresholdConfig;
     checkoutPrefill?: CheckoutPrefill;
 }
 
@@ -6516,6 +6535,7 @@ export declare interface EmbedState {
     layout: EmbedLayout;
     checkoutState?: CheckoutState;
     currencyFilter?: string[];
+    warningThresholdConfig?: WarningThresholdConfig;
     checkoutPrefill?: CheckoutPrefill;
 }
 
@@ -7173,6 +7193,12 @@ declare interface FeatureEntitlement {
      * @memberof FeatureEntitlement
      */
     valueType: EntitlementValueType;
+    /**
+     * Customer-defined usage warning thresholds configured on this entitlement
+     * @type {Array<WarningTier>}
+     * @memberof FeatureEntitlement
+     */
+    warningTiers?: Array<WarningTier>;
 }
 
 /**
@@ -7235,6 +7261,12 @@ declare interface FeatureInPlanResponseData {
      * @memberof FeatureInPlanResponseData
      */
     id: string;
+    /**
+     * The license sold through this feature. Set only on features of type license, and created automatically with them.
+     * @type {string}
+     * @memberof FeatureInPlanResponseData
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {FeatureLifecyclePhase}
@@ -7289,6 +7321,12 @@ declare interface FeatureInPlanResponseData {
      * @memberof FeatureInPlanResponseData
      */
     updatedAt: Date;
+    /**
+     * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
+     * @type {string}
+     * @memberof FeatureInPlanResponseData
+     */
+    usageLimitTraitId?: string | null;
 }
 
 /**
@@ -7351,6 +7389,12 @@ declare interface FeatureInPlanResponseData_2 {
      * @memberof FeatureInPlanResponseData
      */
     id: string;
+    /**
+     * The license sold through this feature. Set only on features of type license, and created automatically with them.
+     * @type {string}
+     * @memberof FeatureInPlanResponseData
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {FeatureLifecyclePhase}
@@ -7405,6 +7449,12 @@ declare interface FeatureInPlanResponseData_2 {
      * @memberof FeatureInPlanResponseData
      */
     updatedAt: Date;
+    /**
+     * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
+     * @type {string}
+     * @memberof FeatureInPlanResponseData
+     */
+    usageLimitTraitId?: string | null;
 }
 
 /**
@@ -7485,6 +7535,12 @@ declare interface FeatureResponseData {
      * @memberof FeatureResponseData
      */
     id: string;
+    /**
+     * The license sold through this feature. Set only on features of type license, and created automatically with them.
+     * @type {string}
+     * @memberof FeatureResponseData
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {FeatureLifecyclePhase}
@@ -7527,6 +7583,12 @@ declare interface FeatureResponseData {
      * @memberof FeatureResponseData
      */
     updatedAt: Date;
+    /**
+     * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
+     * @type {string}
+     * @memberof FeatureResponseData
+     */
+    usageLimitTraitId?: string | null;
 }
 
 /**
@@ -7571,6 +7633,12 @@ declare interface FeatureResponseData_2 {
      * @memberof FeatureResponseData
      */
     id: string;
+    /**
+     * The license sold through this feature. Set only on features of type license, and created automatically with them.
+     * @type {string}
+     * @memberof FeatureResponseData
+     */
+    licenseId?: string | null;
     /**
      *
      * @type {FeatureLifecyclePhase}
@@ -7613,6 +7681,12 @@ declare interface FeatureResponseData_2 {
      * @memberof FeatureResponseData
      */
     updatedAt: Date;
+    /**
+     * Set when the feature carries a pay-in-advance quantity. Provisioned lazily for other feature types, and at creation for license features.
+     * @type {string}
+     * @memberof FeatureResponseData
+     */
+    usageLimitTraitId?: string | null;
 }
 
 /**
@@ -7622,6 +7696,7 @@ declare interface FeatureResponseData_2 {
 declare const FeatureType: {
     readonly Boolean: "boolean";
     readonly Event: "event";
+    readonly License: "license";
     readonly Trait: "trait";
 };
 
@@ -7634,6 +7709,7 @@ declare type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
 declare const FeatureType_2: {
     readonly Boolean: "boolean";
     readonly Event: "event";
+    readonly License: "license";
     readonly Trait: "trait";
 };
 
@@ -8432,6 +8508,7 @@ export declare const initialContext: {
     layout: EmbedLayout;
     checkoutState?: CheckoutState;
     currencyFilter?: string[];
+    warningThresholdConfig?: WarningThresholdConfig;
     checkoutPrefill?: CheckoutPrefill;
 };
 
@@ -9016,6 +9093,68 @@ export declare const Plan: ({ portal, isLoading, plans, selectedPlan, period, se
 
 declare type Plan_2 = CompanyPlanDetailResponseData;
 
+/**
+ * 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 PlanCatalogMembershipResponseData
+ */
+declare interface PlanCatalogMembershipResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCatalogMembershipResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCatalogMembershipResponseData
+     */
+    name: 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 PlanCatalogMembershipResponseData
+ */
+declare interface PlanCatalogMembershipResponseData_2 {
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCatalogMembershipResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PlanCatalogMembershipResponseData
+     */
+    name: string;
+}
+
 /**
  *
  * @export
@@ -9539,6 +9678,12 @@ declare interface PlanDetailResponseData {
      * @memberof PlanDetailResponseData
      */
     billingStrategy: BillingStrategy;
+    /**
+     *
+     * @type {Array<PlanCatalogMembershipResponseData>}
+     * @memberof PlanDetailResponseData
+     */
+    catalogs?: Array<PlanCatalogMembershipResponseData>;
     /**
      *
      * @type {ChargeType}
@@ -10581,6 +10726,12 @@ declare interface PlanViewPublicResponseData {
      * @memberof PlanViewPublicResponseData
      */
     billingStrategy: BillingStrategy_2;
+    /**
+     *
+     * @type {Array<PlanCatalogMembershipResponseData>}
+     * @memberof PlanViewPublicResponseData
+     */
+    catalogs?: Array<PlanCatalogMembershipResponseData_2>;
     /**
      *
      * @type {ChargeType}
@@ -11089,6 +11240,91 @@ declare interface PreviewSubscriptionChangeResponseData {
     usageViolations: Array<FeatureUsageResponseData>;
 }
 
+/**
+ * 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 PreviewSubscriptionDiscountResponseData
+ */
+declare interface PreviewSubscriptionDiscountResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    amountOff?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    couponName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    currency?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    customerFacingCode?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    duration: string;
+    /**
+     *
+     * @type {number}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    durationInMonths?: number | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    endedAt?: Date | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    isActive: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    percentOff?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    promoCodeExternalId?: string | null;
+    /**
+     *
+     * @type {Date}
+     * @memberof PreviewSubscriptionDiscountResponseData
+     */
+    startedAt: Date;
+}
+
 /**
  *
  * @export
@@ -11101,6 +11337,12 @@ declare interface PreviewSubscriptionFinanceResponseData {
      * @memberof PreviewSubscriptionFinanceResponseData
      */
     amountOff: number;
+    /**
+     *
+     * @type {Array<PreviewSubscriptionDiscountResponseData>}
+     * @memberof PreviewSubscriptionFinanceResponseData
+     */
+    discounts: Array<PreviewSubscriptionDiscountResponseData>;
     /**
      *
      * @type {number}
@@ -12709,6 +12951,52 @@ export declare interface ViewportProps extends React.HTMLProps<HTMLDivElement> {
     portal?: HTMLElement | null;
 }
 
+/**
+ * Consumer-level configuration for how entitlement warning thresholds are
+ * displayed. Set once at the EmbedProvider (`<EmbedProvider
+ * warningThresholdConfig={{ showAsLimit: true }} />`) and read by any element
+ * that renders an entitlement limit.
+ */
+export declare interface WarningThresholdConfig {
+    /**
+     * When true, display an entitlement's configured warning threshold in place of
+     * its hard limit (the advertised number in a fair-use setup). Falls back to the
+     * hard limit for entitlements without a threshold. Defaults to false.
+     */
+    showAsLimit?: 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 WarningTier
+ */
+declare interface WarningTier {
+    /**
+     * A customer-defined identifier for the warning tier
+     * @type {string}
+     * @memberof WarningTier
+     */
+    key: string;
+    /**
+     * The warning threshold, in the entitlement's usage units
+     * @type {number}
+     * @memberof WarningTier
+     */
+    value: number;
+}
+
 /**
  * Schematic API
  * Schematic API