@schematichq/schematic-react 1.10.0 → 1.11.0

package/dist/schematic-react.d.ts

@@ -67,18 +67,78 @@ declare namespace billingApi {
         ApiErrorToJSON,
         ApiErrorToJSONTyped,
         ApiError,
+        instanceOfBillingPlanCreditGrantResetCadence,
+        BillingPlanCreditGrantResetCadenceFromJSON,
+        BillingPlanCreditGrantResetCadenceFromJSONTyped,
+        BillingPlanCreditGrantResetCadenceToJSON,
+        BillingPlanCreditGrantResetCadenceToJSONTyped,
+        BillingPlanCreditGrantResetCadence,
+        instanceOfBillingPriceScheme,
+        BillingPriceSchemeFromJSON,
+        BillingPriceSchemeFromJSONTyped,
+        BillingPriceSchemeToJSON,
+        BillingPriceSchemeToJSONTyped,
+        BillingPriceScheme,
+        instanceOfBillingProductPriceInterval,
+        BillingProductPriceIntervalFromJSON,
+        BillingProductPriceIntervalFromJSONTyped,
+        BillingProductPriceIntervalToJSON,
+        BillingProductPriceIntervalToJSONTyped,
+        BillingProductPriceInterval,
         instanceOfBillingProviderType,
         BillingProviderTypeFromJSON,
         BillingProviderTypeFromJSONTyped,
         BillingProviderTypeToJSON,
         BillingProviderTypeToJSONTyped,
         BillingProviderType,
+        instanceOfBillingTiersMode,
+        BillingTiersModeFromJSON,
+        BillingTiersModeFromJSONTyped,
+        BillingTiersModeToJSON,
+        BillingTiersModeToJSONTyped,
+        BillingTiersMode,
+        instanceOfCatalogCreditGrantResponseData,
+        CatalogCreditGrantResponseDataFromJSON,
+        CatalogCreditGrantResponseDataFromJSONTyped,
+        CatalogCreditGrantResponseDataToJSON,
+        CatalogCreditGrantResponseDataToJSONTyped,
+        CatalogCreditGrantResponseData,
+        instanceOfCatalogPriceResponseData,
+        CatalogPriceResponseDataFromJSON,
+        CatalogPriceResponseDataFromJSONTyped,
+        CatalogPriceResponseDataToJSON,
+        CatalogPriceResponseDataToJSONTyped,
+        CatalogPriceResponseData,
+        instanceOfCatalogPriceTierResponseData,
+        CatalogPriceTierResponseDataFromJSON,
+        CatalogPriceTierResponseDataFromJSONTyped,
+        CatalogPriceTierResponseDataToJSON,
+        CatalogPriceTierResponseDataToJSONTyped,
+        CatalogPriceTierResponseData,
         instanceOfCompanyDiscountResponseData,
         CompanyDiscountResponseDataFromJSON,
         CompanyDiscountResponseDataFromJSONTyped,
         CompanyDiscountResponseDataToJSON,
         CompanyDiscountResponseDataToJSONTyped,
         CompanyDiscountResponseData,
+        instanceOfCompanyFeatureUsageListResponseData,
+        CompanyFeatureUsageListResponseDataFromJSON,
+        CompanyFeatureUsageListResponseDataFromJSONTyped,
+        CompanyFeatureUsageListResponseDataToJSON,
+        CompanyFeatureUsageListResponseDataToJSONTyped,
+        CompanyFeatureUsageListResponseData,
+        instanceOfCompanyFeatureUsageResponseData,
+        CompanyFeatureUsageResponseDataFromJSON,
+        CompanyFeatureUsageResponseDataFromJSONTyped,
+        CompanyFeatureUsageResponseDataToJSON,
+        CompanyFeatureUsageResponseDataToJSONTyped,
+        CompanyFeatureUsageResponseData,
+        instanceOfCompanyFeatureUserUsageResponseData,
+        CompanyFeatureUserUsageResponseDataFromJSON,
+        CompanyFeatureUserUsageResponseDataFromJSONTyped,
+        CompanyFeatureUserUsageResponseDataToJSON,
+        CompanyFeatureUserUsageResponseDataToJSONTyped,
+        CompanyFeatureUserUsageResponseData,
         instanceOfCompanyInvoiceResponseData,
         CompanyInvoiceResponseDataFromJSON,
         CompanyInvoiceResponseDataFromJSONTyped,
@@ -109,6 +169,12 @@ declare namespace billingApi {
         CompanyUpcomingInvoiceResponseDataToJSON,
         CompanyUpcomingInvoiceResponseDataToJSONTyped,
         CompanyUpcomingInvoiceResponseData,
+        instanceOfCompanyUserUsageResponseData,
+        CompanyUserUsageResponseDataFromJSON,
+        CompanyUserUsageResponseDataFromJSONTyped,
+        CompanyUserUsageResponseDataToJSON,
+        CompanyUserUsageResponseDataToJSONTyped,
+        CompanyUserUsageResponseData,
         instanceOfCreateSetupIntentResponse,
         CreateSetupIntentResponseFromJSON,
         CreateSetupIntentResponseFromJSONTyped,
@@ -127,6 +193,48 @@ declare namespace billingApi {
         DeleteResponseToJSON,
         DeleteResponseToJSONTyped,
         DeleteResponse,
+        instanceOfEntitlementPriceBehavior,
+        EntitlementPriceBehaviorFromJSON,
+        EntitlementPriceBehaviorFromJSONTyped,
+        EntitlementPriceBehaviorToJSON,
+        EntitlementPriceBehaviorToJSONTyped,
+        EntitlementPriceBehavior,
+        instanceOfEntitlementType,
+        EntitlementTypeFromJSON,
+        EntitlementTypeFromJSONTyped,
+        EntitlementTypeToJSON,
+        EntitlementTypeToJSONTyped,
+        EntitlementType,
+        instanceOfEntitlementValueType,
+        EntitlementValueTypeFromJSON,
+        EntitlementValueTypeFromJSONTyped,
+        EntitlementValueTypeToJSON,
+        EntitlementValueTypeToJSONTyped,
+        EntitlementValueType_2 as EntitlementValueType,
+        instanceOfFeatureType,
+        FeatureTypeFromJSON,
+        FeatureTypeFromJSONTyped,
+        FeatureTypeToJSON,
+        FeatureTypeToJSONTyped,
+        FeatureType,
+        instanceOfGetCompanyFeatureUsageResponse,
+        GetCompanyFeatureUsageResponseFromJSON,
+        GetCompanyFeatureUsageResponseFromJSONTyped,
+        GetCompanyFeatureUsageResponseToJSON,
+        GetCompanyFeatureUsageResponseToJSONTyped,
+        GetCompanyFeatureUsageResponse,
+        instanceOfGetCompanyFeatureUserUsageParams,
+        GetCompanyFeatureUserUsageParamsFromJSON,
+        GetCompanyFeatureUserUsageParamsFromJSONTyped,
+        GetCompanyFeatureUserUsageParamsToJSON,
+        GetCompanyFeatureUserUsageParamsToJSONTyped,
+        GetCompanyFeatureUserUsageParams,
+        instanceOfGetCompanyFeatureUserUsageResponse,
+        GetCompanyFeatureUserUsageResponseFromJSON,
+        GetCompanyFeatureUserUsageResponseFromJSONTyped,
+        GetCompanyFeatureUserUsageResponseToJSON,
+        GetCompanyFeatureUserUsageResponseToJSONTyped,
+        GetCompanyFeatureUserUsageResponse,
         instanceOfGetCompanyInvoicesParams,
         GetCompanyInvoicesParamsFromJSON,
         GetCompanyInvoicesParamsFromJSONTyped,
@@ -157,12 +265,30 @@ declare namespace billingApi {
         InvoiceStatusToJSON,
         InvoiceStatusToJSONTyped,
         InvoiceStatus,
+        instanceOfMetricPeriod,
+        MetricPeriodFromJSON,
+        MetricPeriodFromJSONTyped,
+        MetricPeriodToJSON,
+        MetricPeriodToJSONTyped,
+        MetricPeriod_2 as MetricPeriod,
+        instanceOfMetricPeriodMonthReset,
+        MetricPeriodMonthResetFromJSON,
+        MetricPeriodMonthResetFromJSONTyped,
+        MetricPeriodMonthResetToJSON,
+        MetricPeriodMonthResetToJSONTyped,
+        MetricPeriodMonthReset_2 as MetricPeriodMonthReset,
         instanceOfPaymentMethodResponseData,
         PaymentMethodResponseDataFromJSON,
         PaymentMethodResponseDataFromJSONTyped,
         PaymentMethodResponseDataToJSON,
         PaymentMethodResponseDataToJSONTyped,
         PaymentMethodResponseData,
+        instanceOfPlanCreditGrantScaling,
+        PlanCreditGrantScalingFromJSON,
+        PlanCreditGrantScalingFromJSONTyped,
+        PlanCreditGrantScalingToJSON,
+        PlanCreditGrantScalingToJSONTyped,
+        PlanCreditGrantScaling,
         instanceOfSetupIntentResponseData,
         SetupIntentResponseDataFromJSON,
         SetupIntentResponseDataFromJSONTyped,
@@ -202,6 +328,10 @@ declare interface BillingClient {
     updatePaymentMethod(externalId: string): Promise<void>;
     /** Removes the method, by Schematic's id (`id`). */
     deletePaymentMethod(id: string): Promise<void>;
+    /** Empty when the company is entitled to nothing. */
+    fetchFeatureUsage(): Promise<FeatureUsage[]>;
+    /** One event-based feature's usage by user over its metric period. */
+    fetchFeatureUserUsage(params: FeatureUserUsageRequest): Promise<FeatureUserUsage>;
     readonly sessionStatus: SessionStatus;
     readonly sessionKey: string | undefined;
     setSession(session: SessionInput): void;
@@ -227,11 +357,13 @@ export declare type BillingData = {
     sessionKey?: string;
 };
 
-export declare function BillingDataProvider({ actions, children, data, locale, onLoadMoreInvoices, onMissingString, onRefetch, status, strings, translate, }: BillingDataProviderProps): React_2.JSX.Element;
+export declare function BillingDataProvider({ actions, children, data, featureUserUsage, locale, onLoadMoreInvoices, onMissingString, onRefetch, status, strings, translate, }: BillingDataProviderProps): React_2.JSX.Element;
 
 declare interface BillingDataProviderDataProps {
     /** A missing key reports as pending. */
     data: BillingData;
+    /** Usage by user, by feature id; a feature left out reports as pending. */
+    featureUserUsage?: Record<string, FeatureUserUsage>;
     /** Simulated loading / failure per resource; wins over `data`. */
     status?: BillingDataStatus;
     onRefetch?: (name: BillingResourceName) => void;
@@ -264,6 +396,13 @@ export declare interface BillingDataSource {
      */
     subscribe<K extends BillingResourceName>(name: K, params: BillingResourceParams[K], listener: () => void): () => void;
     handle<K extends BillingResourceName>(name: K, params: BillingResourceParams[K]): ResourceHandle<BillingResources[K]>;
+    /**
+     * One feature's usage by user. Keyed by feature, so it sits beside the
+     * named resources rather than among them: a source that holds one value
+     * per name has no slot for it.
+     */
+    subscribeFeatureUserUsage(featureId: string, listener: () => void): () => void;
+    featureUserUsage(featureId: string): ResourceHandle<FeatureUserUsage>;
     /** Never rejects: a failure lands on the resource's `error`. */
     loadMoreInvoices: (query: InvoiceQuery) => Promise<void>;
     invalidateAll: () => void;
@@ -279,6 +418,21 @@ export declare type BillingDataStatus = {
     };
 };
 
+/**
+ *
+ * @export
+ */
+declare const BillingPlanCreditGrantResetCadence: {
+    readonly Daily: "daily";
+    readonly Every6Months: "every_6_months";
+    readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
+    readonly Weekly: "weekly";
+    readonly Yearly: "yearly";
+};
+
+declare type BillingPlanCreditGrantResetCadence = (typeof BillingPlanCreditGrantResetCadence)[keyof typeof BillingPlanCreditGrantResetCadence];
+
 declare interface BillingPrefetchOptions {
     /**
      * The resources the page renders, and no default: each one is a request
@@ -291,6 +445,30 @@ declare interface BillingPrefetchOptions {
     invoices?: InvoiceQuery;
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingPriceScheme: {
+    readonly PerUnit: "per_unit";
+    readonly Tiered: "tiered";
+};
+
+declare type BillingPriceScheme = (typeof BillingPriceScheme)[keyof typeof BillingPriceScheme];
+
+/**
+ *
+ * @export
+ */
+declare const BillingProductPriceInterval: {
+    readonly Day: "day";
+    readonly Month: "month";
+    readonly OneTime: "one-time";
+    readonly Year: "year";
+};
+
+declare type BillingProductPriceInterval = (typeof BillingProductPriceInterval)[keyof typeof BillingProductPriceInterval];
+
 /**
  * Provides the billing hooks from a `BillingStore` over a `BillingProviderClient`.
  * Rendered by `SchematicProvider`; usable on its own with a client.
@@ -305,7 +483,7 @@ export declare function BillingProvider({ billingClient, children, initialData,
  * much. Named apart from schematic-js's `BillingClient`, which is the whole
  * interface; this is the part the hooks here call.
  */
-export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod">;
+export declare type BillingProviderClient = Pick<BillingClient, "sessionStatus" | "sessionKey" | "setSession" | "onSessionChange" | "fetchInvoices" | "fetchUpcomingInvoice" | "fetchPaymentMethods" | "createSetupIntent" | "updatePaymentMethod" | "deletePaymentMethod" | "fetchFeatureUsage" | "fetchFeatureUserUsage">;
 
 declare interface BillingProviderDataProps {
     /**
@@ -345,7 +523,7 @@ declare interface BillingProviderDataProps {
 export declare type BillingProviderProps = BillingProviderDataProps & SchematicI18nConfig;
 
 /** The resources this package serves; a key of schematic-js's contract. */
-export declare type BillingResourceName = "invoices" | "upcomingInvoice" | "paymentMethods";
+export declare type BillingResourceName = "invoices" | "upcomingInvoice" | "paymentMethods" | "featureUsage";
 
 declare type BillingResourceName_2 = keyof BillingResources_2;
 
@@ -356,6 +534,7 @@ declare interface BillingResourceParams_2 {
     invoices: InvoiceQuery;
     upcomingInvoice: Record<string, never>;
     paymentMethods: Record<string, never>;
+    featureUsage: Record<string, never>;
 }
 
 export declare type BillingResources = Pick<BillingResources_2, BillingResourceName>;
@@ -381,10 +560,223 @@ declare interface BillingResources_2 {
      * has no method on file — so only `undefined` means not loaded.
      */
     paymentMethods: PaymentMethod[];
+    /**
+     * `GET /company/usage`. Empty is a loaded value — the company is entitled
+     * to nothing — so only `undefined` means not loaded.
+     */
+    featureUsage: FeatureUsage[];
 }
 
+/**
+ *
+ * @export
+ */
+declare const BillingTiersMode: {
+    readonly Graduated: "graduated";
+    readonly Volume: "volume";
+};
+
+declare type BillingTiersMode = (typeof BillingTiersMode)[keyof typeof BillingTiersMode];
+
 declare type BooleanListenerFn = (value: boolean) => void;
 
+/**
+ *
+ * @export
+ * @interface CatalogCreditGrantResponseData
+ */
+declare interface CatalogCreditGrantResponseData {
+    /**
+     * Flat credit amount granted to the company regardless of scaling.
+     * @type {number}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    companyCreditAmount: number;
+    /**
+     * Credits granted; for per_license scaling this is the amount per license unit.
+     * @type {number}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditAmount: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditPluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    creditSingularName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    licenseId?: string | null;
+    /**
+     *
+     * @type {BillingPlanCreditGrantResetCadence}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    resetCadence?: BillingPlanCreditGrantResetCadence | null;
+    /**
+     *
+     * @type {PlanCreditGrantScaling}
+     * @memberof CatalogCreditGrantResponseData
+     */
+    scaling: PlanCreditGrantScaling;
+}
+
+/**
+ *
+ * @export
+ * @interface CatalogPriceResponseData
+ */
+declare interface CatalogPriceResponseData {
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    currency: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    id: string;
+    /**
+     *
+     * @type {BillingProductPriceInterval}
+     * @memberof CatalogPriceResponseData
+     */
+    interval: BillingProductPriceInterval;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceResponseData
+     */
+    intervalCount: number;
+    /**
+     * Per-unit price of the final tier, precomputed for overage display.
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    overageUnitPriceDecimal?: string | null;
+    /**
+     * Units covered per priced package; a price of $10 with package_size 1000 charges $10 per 1000 units.
+     * @type {number}
+     * @memberof CatalogPriceResponseData
+     */
+    packageSize: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceResponseData
+     */
+    price: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceResponseData
+     */
+    priceDecimal?: string | null;
+    /**
+     *
+     * @type {Array<CatalogPriceTierResponseData>}
+     * @memberof CatalogPriceResponseData
+     */
+    priceTiers: Array<CatalogPriceTierResponseData>;
+    /**
+     *
+     * @type {BillingPriceScheme}
+     * @memberof CatalogPriceResponseData
+     */
+    scheme: BillingPriceScheme;
+    /**
+     *
+     * @type {BillingTiersMode}
+     * @memberof CatalogPriceResponseData
+     */
+    tiersMode?: BillingTiersMode | null;
+}
+
+/**
+ * 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 CatalogPriceTierResponseData
+ */
+declare interface CatalogPriceTierResponseData {
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    flatPrice?: number | null;
+    /**
+     * Lower bound of the tier (inclusive).
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    from: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    perUnitPrice?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CatalogPriceTierResponseData
+     */
+    perUnitPriceDecimal?: string | null;
+    /**
+     * Upper bound of the tier (inclusive); null means unbounded.
+     * @type {number}
+     * @memberof CatalogPriceTierResponseData
+     */
+    to?: number | null;
+}
+
 /**
  *
  * @export
@@ -730,6 +1122,256 @@ declare interface CompanyDiscountResponseData {
     percentOff?: number | null;
 }
 
+/**
+ *
+ * @export
+ * @interface CompanyFeatureUsageResponseData
+ */
+declare interface CompanyFeatureUsageResponseData {
+    /**
+     * Whether the company may use the feature right now.
+     * @type {boolean}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    access: boolean;
+    /**
+     * The entitlement's own limit before any price behavior applies: the numeric value, or the trait's value for a trait-based entitlement. For a credit entitlement, the credits granted in the current billing period (all time without a subscription). Null for unlimited and boolean entitlements.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    allocation?: number | null;
+    /**
+     * Set when entitlement_type is company_override.
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    companyOverrideId?: string | null;
+    /**
+     * Credits consumed per unit of usage, for entitlements that burn credits.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    consumptionRate?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditIcon?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditId?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditPluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    creditSingularName?: string | null;
+    /**
+     * What the feature costs at price, in its minor units: the allocation for pay_in_advance, usage for tier and pay_as_you_go, and usage above soft_limit for overage. Null when there is no price, the price behavior bills nothing, or there is nothing yet to bill it on (no allocation for pay_in_advance, unknown usage for tier, no usage for pay_as_you_go and overage); tier at zero usage, and overage within soft_limit, cost 0.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    currentCost?: number | null;
+    /**
+     *
+     * @type {EntitlementType}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    entitlementType: EntitlementType;
+    /**
+     * When a company override ends; plan entitlements do not expire.
+     * @type {Date}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    expiresAt?: Date | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureDescription: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureIcon: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featurePluralName?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureSingularName?: string | null;
+    /**
+     *
+     * @type {FeatureType}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    featureType: FeatureType;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    licenseId?: string | null;
+    /**
+     *
+     * @type {MetricPeriod}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    metricPeriod?: MetricPeriod_2 | null;
+    /**
+     *
+     * @type {MetricPeriodMonthReset}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    metricPeriodMonthReset?: MetricPeriodMonthReset_2 | null;
+    /**
+     * The plan's credit grants that scale with the license this feature counts.
+     * @type {Array<CatalogCreditGrantResponseData>}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    perLicenseCreditGrants: Array<CatalogCreditGrantResponseData>;
+    /**
+     * Set when entitlement_type is plan_entitlement.
+     * @type {string}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    planEntitlementId?: string | null;
+    /**
+     * The metered price the company is billed at: the slot for its billing period, in the subscription's currency, or in none when the price predates multi-currency (any currency without a subscription). Null when the feature has no such price for that period.
+     * @type {CatalogPriceResponseData}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    price?: CatalogPriceResponseData;
+    /**
+     *
+     * @type {EntitlementPriceBehavior}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    priceBehavior?: EntitlementPriceBehavior | null;
+    /**
+     * When the usage metric next resets.
+     * @type {Date}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    resetsAt?: Date | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    softLimit?: number | null;
+    /**
+     * Usage in the current metric period; null for features that are not metered.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    usage?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    valueBool?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    valueNumeric?: number | null;
+    /**
+     *
+     * @type {EntitlementValueType}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    valueType: EntitlementValueType_2;
+    /**
+     * The default warning-tier value, when configured.
+     * @type {number}
+     * @memberof CompanyFeatureUsageResponseData
+     */
+    warningThreshold?: number | null;
+}
+
+/**
+ *
+ * @export
+ * @interface CompanyFeatureUserUsageResponseData
+ */
+declare interface CompanyFeatureUserUsageResponseData {
+    /**
+     * How many of the company's users the breakdown lists across every page, including those without usage in the period; unattributed usage is not a user and is not counted.
+     * @type {number}
+     * @memberof CompanyFeatureUserUsageResponseData
+     */
+    count: number;
+    /**
+     * End of the feature's current metric period (exclusive).
+     * @type {Date}
+     * @memberof CompanyFeatureUserUsageResponseData
+     */
+    endTime: Date;
+    /**
+     * Start of the feature's current metric period.
+     * @type {Date}
+     * @memberof CompanyFeatureUserUsageResponseData
+     */
+    startTime: Date;
+    /**
+     * Usage across every user in the period, not just this page.
+     * @type {number}
+     * @memberof CompanyFeatureUserUsageResponseData
+     */
+    total: number;
+    /**
+     * Usage from events sent without a user; null when the period has none.
+     * @type {number}
+     * @memberof CompanyFeatureUserUsageResponseData
+     */
+    unattributed?: number | null;
+    /**
+     * This page of users, highest usage first.
+     * @type {Array<CompanyUserUsageResponseData>}
+     * @memberof CompanyFeatureUserUsageResponseData
+     */
+    users: Array<CompanyUserUsageResponseData>;
+}
+
 /**
  *
  * @export
@@ -933,6 +1575,85 @@ declare interface CompanyUpcomingInvoiceResponseData {
     subtotal: number;
 }
 
+/**
+ * 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 CompanyUserUsageResponseData
+ */
+declare interface CompanyUserUsageResponseData {
+    /**
+     * When the user last used the feature in the period.
+     * @type {Date}
+     * @memberof CompanyUserUsageResponseData
+     */
+    lastSeen: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyUserUsageResponseData
+     */
+    name?: string | null;
+    /**
+     * This user's fraction (0-1) of all usage in the period, unattributed usage included.
+     * @type {number}
+     * @memberof CompanyUserUsageResponseData
+     */
+    share: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CompanyUserUsageResponseData
+     */
+    usage: number;
+    /**
+     *
+     * @type {string}
+     * @memberof CompanyUserUsageResponseData
+     */
+    userId: string;
+}
+
+/**
+ * Function supplied by the integrating application that returns an HMAC context
+ * signature (`iat.exp.sig`) for the given context.
+ *
+ * Because a publishable key is public, the signature must be produced by the
+ * customer's backend, which holds the matching secret API key. A typical
+ * implementation forwards the context to that backend and returns the
+ * `X-Schematic-Context-Sig` value it computes:
+ *
+ * ```ts
+ * const schematic = new Schematic(pubKey, {
+ *   getContextSignature: async (context) => {
+ *     const res = await fetch("/api/schematic/sign", {
+ *       method: "POST",
+ *       credentials: "include",
+ *       headers: { "Content-Type": "application/json" },
+ *       body: JSON.stringify(context),
+ *     });
+ *     const { signature } = await res.json();
+ *     return signature; // "iat.exp.sig"
+ *   },
+ * });
+ * ```
+ *
+ * The SDK derives the expiry from the returned string (its middle segment) and
+ * caches it per context, so the function is only invoked when no fresh
+ * signature is available.
+ */
+declare type ContextSignatureProvider = (context: SchematicContext) => string | Promise<string>;
+
 /** A company's lease-aware balance for a single credit type */
 export declare type CreditBalance = {
     /** Spendable balance including any open lease hold (remaining + reserved); the number to display to end users */
@@ -1139,6 +1860,32 @@ export declare type Discount = CompanyDiscountResponseData;
 
 declare type EmptyListenerFn = () => void;
 
+/**
+ *
+ * @export
+ */
+declare const EntitlementPriceBehavior: {
+    readonly CreditBurndown: "credit_burndown";
+    readonly Overage: "overage";
+    readonly PayAsYouGo: "pay_as_you_go";
+    readonly PayInAdvance: "pay_in_advance";
+    readonly Tier: "tier";
+};
+
+declare type EntitlementPriceBehavior = (typeof EntitlementPriceBehavior)[keyof typeof EntitlementPriceBehavior];
+
+/**
+ *
+ * @export
+ */
+declare const EntitlementType: {
+    readonly CompanyOverride: "company_override";
+    readonly PlanEntitlement: "plan_entitlement";
+    readonly Unknown: "unknown";
+};
+
+declare type EntitlementType = (typeof EntitlementType)[keyof typeof EntitlementType];
+
 /**
  *
  * @export
@@ -1154,6 +1901,21 @@ declare const EntitlementValueType: {
 
 declare type EntitlementValueType = (typeof EntitlementValueType)[keyof typeof EntitlementValueType];
 
+/**
+ *
+ * @export
+ */
+declare const EntitlementValueType_2: {
+    readonly Boolean: "boolean";
+    readonly Credit: "credit";
+    readonly Numeric: "numeric";
+    readonly Trait: "trait";
+    readonly Unknown: "unknown";
+    readonly Unlimited: "unlimited";
+};
+
+declare type EntitlementValueType_2 = (typeof EntitlementValueType_2)[keyof typeof EntitlementValueType_2];
+
 declare type Event_2 = {
     api_key: string;
     body: EventBody;
@@ -1278,6 +2040,12 @@ export declare type EventBodyTrack = SchematicContext & {
 
 export declare type EventType = "identify" | "track" | "flag_check";
 
+/**
+ * Users fetched for one feature's breakdown. The breakdown is read once, not
+ * paged: it lists the heaviest users and says how many more there are.
+ */
+export declare const FEATURE_USER_USAGE_LIMIT = 20;
+
 /**
  *
  * @export
@@ -1400,6 +2168,48 @@ declare interface FeatureEntitlement {
     warningTiers?: Array<WarningTier>;
 }
 
+/**
+ *
+ * @export
+ */
+declare const FeatureType: {
+    readonly Boolean: "boolean";
+    readonly Event: "event";
+    readonly License: "license";
+    readonly Trait: "trait";
+};
+
+declare type FeatureType = (typeof FeatureType)[keyof typeof FeatureType];
+
+/**
+ * One feature the company is entitled to, and its usage. What the server has
+ * already decided, so a consumer never re-derives it:
+ *
+ * * `price` — the one metered price the company is billed at: its billing
+ *   period's slot, in the subscription's currency when the feature is priced
+ *   in it. Absent when the period has none; another cadence's price is never
+ *   substituted.
+ * * `currentCost` — what the feature costs at `price`, in its minor units.
+ * * `perLicenseCreditGrants` — the plan's credit grants that scale with the
+ *   license this feature counts.
+ */
+export declare type FeatureUsage = CompanyFeatureUsageResponseData;
+
+/**
+ * One event-based feature's usage by user over its current metric period:
+ * a page of `users`, highest usage first; `count` users in all; the period's
+ * `total`; and `unattributed` usage from events sent without a user, which is
+ * not a user and never on the page.
+ */
+export declare type FeatureUserUsage = CompanyFeatureUserUsageResponseData;
+
+declare interface FeatureUserUsageRequest {
+    featureId: string;
+    /** Users per page; the server's default when omitted. */
+    limit?: number;
+    offset?: number;
+}
+
 /**
  * Server prefetch for a provider's `initialData`. A resource that fails is
  * left out rather than thrown, so one of them cannot block a page.
@@ -1468,6 +2278,9 @@ export declare type InvoiceStatus = (typeof InvoiceStatus)[keyof typeof InvoiceS
 /** A record of unique key-value pairs used for identifying a company or user */
 export declare type Keys = Record<string, string>;
 
+/** A metered price, tiers included. */
+export declare type MeteredPrice = CatalogPriceResponseData;
+
 /**
  *
  * @export
@@ -1481,6 +2294,19 @@ declare const MetricPeriod: {
 
 declare type MetricPeriod = (typeof MetricPeriod)[keyof typeof MetricPeriod];
 
+/**
+ *
+ * @export
+ */
+declare const MetricPeriod_2: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};
+
+declare type MetricPeriod_2 = (typeof MetricPeriod_2)[keyof typeof MetricPeriod_2];
+
 /**
  *
  * @export
@@ -1492,6 +2318,17 @@ declare const MetricPeriodMonthReset: {
 
 declare type MetricPeriodMonthReset = (typeof MetricPeriodMonthReset)[keyof typeof MetricPeriodMonthReset];
 
+/**
+ *
+ * @export
+ */
+declare const MetricPeriodMonthReset_2: {
+    readonly BillingCycle: "billing_cycle";
+    readonly FirstOfMonth: "first_of_month";
+};
+
+declare type MetricPeriodMonthReset_2 = (typeof MetricPeriodMonthReset_2)[keyof typeof MetricPeriodMonthReset_2];
+
 /**
  * Keeps only the fields the request reads. The store keys a row set by the
  * query's shape, so a field the API never sees would key a row set of its
@@ -1538,6 +2375,20 @@ export declare interface PaymentMethodsHandle extends ResourceHandle<PaymentMeth
 
 declare type PendingListenerFn = BooleanListenerFn | EmptyListenerFn;
 
+/** A plan credit grant that scales per license. */
+export declare type PerLicenseCreditGrant = CatalogCreditGrantResponseData;
+
+/**
+ *
+ * @export
+ */
+declare const PlanCreditGrantScaling: {
+    readonly Fixed: "fixed";
+    readonly PerLicense: "per_license";
+};
+
+declare type PlanCreditGrantScaling = (typeof PlanCreditGrantScaling)[keyof typeof PlanCreditGrantScaling];
+
 declare type PlanListenerFn = CheckPlanReturnListenerFn | EmptyListenerFn;
 
 declare interface RequestOptions {
@@ -1602,6 +2453,7 @@ declare type RuleType_2 = (typeof RuleType_2)[keyof typeof RuleType_2];
 export declare class Schematic {
     private _additionalHeaders;
     private apiKey;
+    private contextSignatureManager?;
     private _apiUrl;
     private conn;
     private context;
@@ -1680,6 +2532,22 @@ export declare class Schematic {
      * Only logs if debug mode is enabled
      */
     debug(message: string, ...args: unknown[]): void;
+    /**
+     * Resolve the HMAC context-signature value for a context, if a signature
+     * provider is configured. Returns undefined when no provider is set, when
+     * offline, or when the signature could not be obtained.
+     */
+    private contextSignature;
+    /**
+     * Build the `X-Schematic-Context-Sig` header for a context, or an empty
+     * object when no signature is available. Spread into request headers.
+     *
+     * Returns synchronously (not a Promise) when no signature provider is
+     * configured, so callers that dispatch on the same tick (e.g. fire-and-forget
+     * event sends) keep their existing timing; only a configured provider, which
+     * must fetch a signature, yields a Promise.
+     */
+    private contextSignatureHeaders;
     /**
      * Create a persistent message handler for websocket flag updates
      */
@@ -1894,6 +2762,8 @@ declare class SchematicBillingClient implements BillingClient {
     createSetupIntent(): Promise<SetupIntent>;
     updatePaymentMethod(externalId: string): Promise<void>;
     deletePaymentMethod(id: string): Promise<void>;
+    fetchFeatureUsage(): Promise<FeatureUsage[]>;
+    fetchFeatureUserUsage(params: FeatureUserUsageRequest): Promise<FeatureUserUsage>;
 }
 
 /** Context for checking flags and sending events */
@@ -1974,6 +2844,9 @@ declare namespace SchematicJS {
         BillingResourceParams_2 as BillingResourceParams,
         BillingResources_2 as BillingResources,
         BooleanListenerFn,
+        CatalogCreditGrantResponseData,
+        CatalogPriceResponseData,
+        CatalogPriceTierResponseData,
         CheckFlagResponseData,
         CheckFlagReturn,
         CheckFlagReturnFromJSON,
@@ -1984,9 +2857,13 @@ declare namespace SchematicJS {
         CheckPlanReturnListenerFn,
         CompanyCreditBalance,
         CompanyDiscountResponseData,
+        CompanyFeatureUsageResponseData,
+        CompanyFeatureUserUsageResponseData,
         CompanyInvoiceResponseData,
         CompanyPaymentMethodResponseData,
         CompanyUpcomingInvoiceResponseData,
+        CompanyUserUsageResponseData,
+        ContextSignatureProvider,
         CreditBalance,
         CreditBalanceListenerFn,
         CreditBalances,
@@ -2010,6 +2887,8 @@ declare namespace SchematicJS {
         EventBodyIdentify,
         EventBodyTrack,
         EventType,
+        FeatureUsage,
+        FeatureUserUsage,
         FlagCheckListenerFn,
         FlagValueListenerFn,
         Invoice,
@@ -2021,8 +2900,10 @@ declare namespace SchematicJS {
         InvoicesResult,
         InvoiceStatus,
         Keys,
+        MeteredPrice,
         PaymentMethod,
         PendingListenerFn,
+        PerLicenseCreditGrant,
         PlanListenerFn,
         RequestOptions,
         ResourceState,
@@ -2047,6 +2928,7 @@ declare namespace SchematicJS {
         TrialStatus,
         UpcomingInvoice,
         UsagePeriod,
+        UserUsage,
         WarningTier
     }
 }
@@ -2061,6 +2943,16 @@ export declare type SchematicOptions = {
     debug?: boolean;
     /** Optionally provide a custom event URL */
     eventUrl?: string;
+    /** Optionally provide a function that returns an HMAC context signature
+     * (`iat.exp.sig`) for a given context. Required only when the Schematic
+     * environment has context-signature verification enabled. Because a
+     * publishable key is public, the signature must be produced by your backend
+     * (which holds the matching secret API key); this function typically forwards
+     * the context to that backend and returns the value it computes. The SDK
+     * caches the signature per context, derives its expiry from the returned
+     * string, and attaches it as the `X-Schematic-Context-Sig` header on flag
+     * checks, the WebSocket bootstrap, and events. */
+    getContextSignature?: ContextSignatureProvider;
     /** Enable offline mode to prevent all network requests.
      * When enabled, events are only logged not sent, and flag checks return fallback values.
      * Can also be enabled at runtime via URL query parameter "schematic_offline=true" */
@@ -2342,6 +3234,19 @@ export declare enum UsagePeriod {
 
 export declare function useBillingDataSource(): BillingDataSource;
 
+/**
+ * Every feature the company is entitled to, with its usage. `data` is empty
+ * when it is entitled to nothing; `undefined` is what means not loaded yet.
+ */
+export declare function useFeatureUsage(): ResourceHandle<FeatureUsage[]>;
+
+/**
+ * One event-based feature's usage by user over its metric period: the
+ * heaviest users, how many there are in all, and usage sent without a user.
+ * A feature the company has no event-based entitlement to fails with a 404.
+ */
+export declare function useFeatureUserUsage(featureId: string): ResourceHandle<FeatureUserUsage>;
+
 /** Reloads every loaded billing resource (after a plan change, for instance). */
 export declare function useInvalidateBillingData(): () => void;
 
@@ -2364,6 +3269,8 @@ export declare function useInvoices(query?: InvoiceQuery): InvoicesHandle;
  */
 export declare function usePaymentMethods(): PaymentMethodsHandle;
 
+export declare type UserUsage = CompanyUserUsageResponseData;
+
 export declare const useSchematic: () => SchematicContextProps;
 
 export declare const useSchematicContext: (opts?: SchematicHookOpts) => {