@schematichq/schematic-typescript-node 1.3.2 → 1.4.1

package/dist/api/resources/scheduledcheckout/client/requests/CreateScheduledCheckoutRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         executeAfter: new Date("2024-01-15T09:30:00.000Z"),
+ *         fromPlanId: "from_plan_id",
+ *         toPlanId: "to_plan_id"
+ *     }
+ */
+export interface CreateScheduledCheckoutRequest {
+    companyId: string;
+    executeAfter: Date;
+    fromPlanId: string;
+    toPlanId: string;
+}

package/dist/api/resources/scheduledcheckout/client/requests/ListScheduledCheckoutsRequest.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {
+ *         companyId: "company_id",
+ *         status: "cancelled",
+ *         limit: 1,
+ *         offset: 1
+ *     }
+ */
+export interface ListScheduledCheckoutsRequest {
+    companyId?: string;
+    status?: Schematic.ScheduledCheckoutStatus;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+}

package/dist/api/resources/scheduledcheckout/client/requests/UpdateScheduledCheckoutRequest.d.ts

@@ -0,0 +1,9 @@
+import type * as Schematic from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateScheduledCheckoutRequest {
+    executeAfter?: Date;
+    status?: Schematic.ScheduledCheckoutStatus;
+}

package/dist/api/resources/scheduledcheckout/client/requests/index.d.ts

@@ -0,0 +1,3 @@
+export type { CreateScheduledCheckoutRequest } from "./CreateScheduledCheckoutRequest";
+export type { ListScheduledCheckoutsRequest } from "./ListScheduledCheckoutsRequest";
+export type { UpdateScheduledCheckoutRequest } from "./UpdateScheduledCheckoutRequest";

package/dist/api/resources/scheduledcheckout/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./types";

package/dist/api/resources/scheduledcheckout/types/CreateScheduledCheckoutResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface CreateScheduledCheckoutResponse {
+    data: Schematic.ScheduledCheckoutResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/scheduledcheckout/types/GetScheduledCheckoutResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface GetScheduledCheckoutResponse {
+    data: Schematic.ScheduledCheckoutResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/scheduledcheckout/types/ListScheduledCheckoutsParams.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../../../index";
+/**
+ * Input parameters
+ */
+export interface ListScheduledCheckoutsParams {
+    companyId?: string;
+    /** Page limit (default 100) */
+    limit?: number;
+    /** Page offset (default 0) */
+    offset?: number;
+    status?: Schematic.ScheduledCheckoutStatus;
+}

package/dist/api/resources/scheduledcheckout/types/ListScheduledCheckoutsResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface ListScheduledCheckoutsResponse {
+    data: Schematic.ScheduledCheckoutResponseData[];
+    /** Input parameters */
+    params: Schematic.ListScheduledCheckoutsParams;
+}

package/dist/api/resources/scheduledcheckout/types/UpdateScheduledCheckoutResponse.d.ts

@@ -0,0 +1,6 @@
+import type * as Schematic from "../../../index";
+export interface UpdateScheduledCheckoutResponse {
+    data: Schematic.ScheduledCheckoutResponseData;
+    /** Input parameters */
+    params: Record<string, unknown>;
+}

package/dist/api/resources/scheduledcheckout/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./CreateScheduledCheckoutResponse";
+export * from "./GetScheduledCheckoutResponse";
+export * from "./ListScheduledCheckoutsParams";
+export * from "./ListScheduledCheckoutsResponse";
+export * from "./UpdateScheduledCheckoutResponse";

package/dist/api/types/ActorType.d.ts

@@ -0,0 +1,8 @@
+export declare const ActorType: {
+    readonly ApiKey: "api_key";
+    readonly AppUser: "app_user";
+    readonly StripeApp: "stripe_app";
+    readonly System: "system";
+    readonly TemporaryAccessToken: "temporary_access_token";
+};
+export type ActorType = (typeof ActorType)[keyof typeof ActorType];

package/dist/api/types/ApiKeyCreateResponseData.d.ts

@@ -6,6 +6,7 @@ export interface ApiKeyCreateResponseData {
     id: string;
     lastUsedAt?: Date;
     name: string;
+    readonly: boolean;
     scopes: Schematic.ApiKeyScope[];
     secret: string;
     updatedAt: Date;

package/dist/api/types/ApiKeyResponseData.d.ts

@@ -6,6 +6,7 @@ export interface ApiKeyResponseData {
     id: string;
     lastUsedAt?: Date;
     name: string;
+    readonly: boolean;
     scopes: Schematic.ApiKeyScope[];
     updatedAt: Date;
 }

package/dist/api/types/AuditLogListResponseData.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../index";
+export interface AuditLogListResponseData {
+    actorType: Schematic.ActorType;
+    apiKeyId?: string;
+    endedAt?: Date;
+    environmentId?: string;
+    id: string;
+    method: string;
+    resourceId?: number;
+    resourceIdString?: string;
+    resourceName?: string;
+    resourceType?: string;
+    respCode?: number;
+    secondaryResource?: string;
+    startedAt: Date;
+    url: string;
+    userName?: string;
+}

package/dist/api/types/AuditLogResponseData.d.ts

@@ -0,0 +1,21 @@
+import type * as Schematic from "../index";
+export interface AuditLogResponseData {
+    actorType: Schematic.ActorType;
+    apiKeyId?: string;
+    endedAt?: Date;
+    environmentId?: string;
+    id: string;
+    method: string;
+    reqBody?: string;
+    resourceId?: number;
+    resourceIdString?: string;
+    resourceName?: string;
+    resourceType?: string;
+    respBody?: string;
+    respCode?: number;
+    secondaryResource?: string;
+    startedAt: Date;
+    url: string;
+    userId?: string;
+    userName?: string;
+}

package/dist/api/types/BillingCreditResponseData.d.ts

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface BillingCreditResponseData {
     burnStrategy: Schematic.BillingCreditBurnStrategy;
+    costEditable: boolean;
     createdAt: Date;
     defaultExpiryUnit: Schematic.BillingCreditExpiryUnit;
     defaultExpiryUnitCount?: number;

package/dist/api/types/BillingCreditView.d.ts

@@ -0,0 +1,22 @@
+import type * as Schematic from "../index";
+export interface BillingCreditView {
+    accountId: string;
+    burnStrategy: Schematic.BillingCreditBurnStrategy;
+    costEditable: boolean;
+    createdAt: Date;
+    defaultExpiryUnit: Schematic.BillingCreditExpiryUnit;
+    defaultExpiryUnitCount?: number;
+    defaultRolloverPolicy: Schematic.BillingCreditRolloverPolicy;
+    description: string;
+    environmentId: string;
+    icon?: string;
+    id: string;
+    name: string;
+    pluralName?: string;
+    price?: Schematic.BillingPriceView;
+    pricePerUnit?: number;
+    pricePerUnitDecimal?: string;
+    product?: Schematic.BillingProductResponseData;
+    singularName?: string;
+    updatedAt: Date;
+}

package/dist/api/types/BillingPlanCreditGrantResponseData.d.ts

@@ -8,19 +8,26 @@ export interface BillingPlanCreditGrantResponseData {
     autoTopupExpiryUnitCount?: number;
     autoTopupThresholdPercent?: number;
     createdAt: Date;
+    credit?: Schematic.BillingCreditResponseData;
     creditAmount: number;
     creditId: string;
+    /** Use credit.name from the nested credit object instead */
     creditName: string;
+    /** Use plural_name from the nested credit object instead */
     creditPluralName?: string;
+    /** Use singular_name from the nested credit object instead */
     creditSingularName?: string;
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     id: string;
+    plan?: Schematic.PreviewObjectResponseData;
     planId: string;
+    /** Use plan.name from the nested plan object instead */
     planName: string;
-    resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
-    resetStart: Schematic.BillingPlanCreditGrantResetStart;
+    planVersionId?: string;
+    resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
+    resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;
     updatedAt: Date;
 }

package/dist/api/types/CheckFlagResponseData.d.ts

@@ -1,17 +1,20 @@
+import type * as Schematic from "../index";
 export interface CheckFlagResponseData {
     /** If company keys were provided and matched a company, its ID */
     companyId?: string;
+    /** If a feature entitlement rule was matched, its entitlement details */
+    entitlement?: Schematic.FeatureEntitlement;
     /** If an error occurred while checking the flag, the error message */
     error?: string;
-    /** If a numeric feature entitlement rule was matched, its allocation */
+    /** Deprecated: Use Entitlement.Allocation instead. */
     featureAllocation?: number;
-    /** If a numeric feature entitlement rule was matched, the company's usage */
+    /** Deprecated: Use Entitlement.Usage instead. */
     featureUsage?: number;
-    /** If an event-based numeric feature entitlement rule was matched, the event used to track its usage */
+    /** Deprecated: Use Entitlement.EventName instead. */
     featureUsageEvent?: string;
-    /** For event-based feature entitlement rules, the period over which usage is tracked (current_month, current_day, current_week, all_time) */
+    /** Deprecated: Use Entitlement.MetricPeriod instead. */
     featureUsagePeriod?: string;
-    /** For event-based feature entitlement rules, when the usage period will reset */
+    /** Deprecated: Use Entitlement.MetricResetAt instead. */
     featureUsageResetAt?: Date;
     /** The key used to check the flag */
     flag: string;

package/dist/api/types/CompanyDetailResponseData.d.ts

@@ -6,6 +6,7 @@ export interface CompanyDetailResponseData {
     billingSubscriptions: Schematic.BillingSubscriptionView[];
     createdAt: Date;
     defaultPaymentMethod?: Schematic.PaymentMethodResponseData;
+    entitlements: Schematic.FeatureEntitlement[];
     entityTraits: Schematic.EntityTraitDetailResponseData[];
     environmentId: string;
     id: string;
@@ -18,6 +19,7 @@ export interface CompanyDetailResponseData {
     plan?: Schematic.CompanyPlanWithBillingSubView;
     plans: Schematic.GenericPreviewObject[];
     rules: Schematic.Rule[];
+    scheduledDowngrade?: Schematic.ScheduledDowngradeResponseData;
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updatedAt: Date;

package/dist/api/types/CompanyPlanDetailResponseData.d.ts

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface CompanyPlanDetailResponseData {
+    activeVersion?: Schematic.PlanVersionResponseData;
     audienceType?: string;
     billingProduct?: Schematic.BillingProductDetailResponseData;
     chargeType: Schematic.ChargeType;
@@ -12,6 +13,7 @@ export interface CompanyPlanDetailResponseData {
     custom: boolean;
     customPlanConfig?: Schematic.CustomPlanConfig;
     description: string;
+    draftVersion?: Schematic.PlanVersionResponseData;
     entitlements: Schematic.PlanEntitlementResponseData[];
     features: Schematic.FeatureDetailResponseData[];
     icon: string;

package/dist/api/types/ComponentDisplaySettings.d.ts

@@ -1,6 +1,8 @@
 export interface ComponentDisplaySettings {
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showFeatureDescription: boolean;
+    showHardLimit: boolean;
     showPeriodToggle: boolean;
     showZeroPriceAsFree: boolean;
 }

package/dist/api/types/ComponentHydrateResponseData.d.ts

@@ -17,6 +17,7 @@ export interface ComponentHydrateResponseData {
     preventSelfServiceDowngrade: boolean;
     preventSelfServiceDowngradeButtonText?: string;
     preventSelfServiceDowngradeUrl?: string;
+    scheduledDowngrade?: Schematic.ScheduledDowngradeResponseData;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
     showPeriodToggle: boolean;

package/dist/api/types/ComponentPreviewResponseData.d.ts

@@ -18,6 +18,7 @@ export interface ComponentPreviewResponseData {
     preventSelfServiceDowngrade: boolean;
     preventSelfServiceDowngradeButtonText?: string;
     preventSelfServiceDowngradeUrl?: string;
+    scheduledDowngrade?: Schematic.ScheduledDowngradeResponseData;
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
     showPeriodToggle: boolean;

package/dist/api/types/ComponentSettingsResponseData.d.ts

@@ -1,6 +1,8 @@
 export interface ComponentSettingsResponseData {
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showFeatureDescription: boolean;
+    showHardLimit: boolean;
     showPeriodToggle: boolean;
     showZeroPriceAsFree: boolean;
 }

package/dist/api/types/ConditionConditionType.d.ts

@@ -3,9 +3,9 @@ export declare const ConditionConditionType: {
     readonly BillingProduct: "billing_product";
     readonly Company: "company";
     readonly Credit: "credit";
-    readonly CrmProduct: "crm_product";
     readonly Metric: "metric";
     readonly Plan: "plan";
+    readonly PlanVersion: "plan_version";
     readonly Trait: "trait";
     readonly User: "user";
 };

package/dist/api/types/ConditionGroupResponseData.d.ts

@@ -0,0 +1,10 @@
+export interface ConditionGroupResponseData {
+    accountId: string;
+    createdAt: Date;
+    environmentId: string;
+    flagId?: string;
+    id: string;
+    planVersionId?: string;
+    ruleId: string;
+    updatedAt: Date;
+}

package/dist/api/types/ConditionGroupView.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../index";
+export interface ConditionGroupView {
+    accountId: string;
+    conditions: Schematic.ConditionView[];
+    createdAt: Date;
+    environmentId: string;
+    flagId?: string;
+    id: string;
+    planVersionId?: string;
+    ruleId: string;
+    updatedAt: Date;
+}

package/dist/api/types/ConditionResponseData.d.ts

@@ -0,0 +1,28 @@
+import type * as Schematic from "../index";
+export interface ConditionResponseData {
+    accountId: string;
+    comparisonTraitId?: string;
+    conditionGroupId?: string;
+    conditionType: string;
+    consumptionRate?: number;
+    createdAt: Date;
+    creditId?: string;
+    environmentId: string;
+    eventSubtype?: string;
+    flagId?: string;
+    id: string;
+    metricPeriod?: string;
+    metricPeriodMonthReset?: string;
+    metricValue?: number;
+    operator: string;
+    planVersionId?: string;
+    resourceUnspecifiedIds: string[];
+    ruleId: string;
+    traitEntityType?: Schematic.EntityType;
+    traitId?: string;
+    traitValue: string;
+    traitValueBool: boolean;
+    traitValueDate?: Date;
+    traitValueInt: number;
+    updatedAt: Date;
+}

package/dist/api/types/ConditionView.d.ts

@@ -0,0 +1,35 @@
+import type * as Schematic from "../index";
+export interface ConditionView {
+    accountId: string;
+    billingProducts: Schematic.GenericPreviewObject[];
+    companies: Schematic.GenericPreviewObject[];
+    comparisonTrait?: Schematic.EntityTraitDefinitionResponseData;
+    comparisonTraitId?: string;
+    conditionGroupId?: string;
+    conditionType: string;
+    consumptionRate?: number;
+    createdAt: Date;
+    creditId?: string;
+    environmentId: string;
+    eventSubtype?: string;
+    flagId?: string;
+    id: string;
+    metricPeriod?: string;
+    metricPeriodMonthReset?: string;
+    metricValue?: number;
+    operator: string;
+    planVersionId?: string;
+    planVersions: Schematic.GenericPreviewObject[];
+    plans: Schematic.GenericPreviewObject[];
+    resourceUnspecifiedIds: string[];
+    ruleId: string;
+    trait?: Schematic.EntityTraitDefinitionResponseData;
+    traitEntityType?: Schematic.EntityType;
+    traitId?: string;
+    traitValue: string;
+    traitValueBool: boolean;
+    traitValueDate?: Date;
+    traitValueInt: number;
+    updatedAt: Date;
+    users: Schematic.GenericPreviewObject[];
+}

package/dist/api/types/CreateBillingPlanCreditGrantRequestBody.d.ts

@@ -14,6 +14,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     planId: string;
+    planVersionId?: string;
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;

package/dist/api/types/CreateEntitlementInBundleRequestBody.d.ts

@@ -12,6 +12,8 @@ export interface CreateEntitlementInBundleRequestBody {
     monthlyUnitPrice?: number;
     monthlyUnitPriceDecimal?: string;
     overageBillingProductId?: string;
+    planId: string;
+    planVersionId?: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** Use MonthlyPriceTiers or YearlyPriceTiers instead */
     priceTiers?: Schematic.CreatePriceTierRequestBody[];

package/dist/api/types/CreateEventRequestBody.d.ts

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface CreateEventRequestBody {
     body?: Schematic.EventBody;
+    /** Either 'identify' or 'track' */
     eventType: Schematic.EventType;
     /** Optionally provide a timestamp at which the event was sent to Schematic */
     sentAt?: Date;

package/dist/api/types/CreditEventLedgerResponseData.d.ts

@@ -0,0 +1,34 @@
+import type * as Schematic from "../index";
+export interface CreditEventLedgerResponseData {
+    amount: number;
+    autoTopupLogId?: string;
+    billingCreditBundleId?: string;
+    billingCreditId: string;
+    company?: Schematic.CompanyLedgerResponseData;
+    companyId: string;
+    credit?: Schematic.BillingCreditLedgerResponseData;
+    creditName: string;
+    environmentId: string;
+    eventAt: Date;
+    eventId: string;
+    eventType: Schematic.CreditEventType;
+    expiryType?: Schematic.BillingCreditExpiryType;
+    expiryUnit?: Schematic.BillingCreditExpiryUnit;
+    expiryUnitCount?: number;
+    feature?: Schematic.FeatureLedgerResponseData;
+    featureId?: string;
+    fromGrantId?: string;
+    grantExpiresAt?: Date;
+    grantId?: string;
+    grantQuantity?: number;
+    grantQuantityRemaining?: number;
+    grantReason?: Schematic.BillingCreditGrantReason;
+    grantValidFrom?: Date;
+    planId?: string;
+    quantityConsumed?: number;
+    quantityRemainingAtZeroOut?: number;
+    sourceId: number;
+    toGrantId?: string;
+    usageEventId?: string;
+    zeroedOutReason?: Schematic.BillingCreditGrantZeroedOutReason;
+}

package/dist/api/types/CreditEventType.d.ts

@@ -0,0 +1,7 @@
+export declare const CreditEventType: {
+    readonly Grant: "grant";
+    readonly Transfer: "transfer";
+    readonly Usage: "usage";
+    readonly ZeroOut: "zero_out";
+};
+export type CreditEventType = (typeof CreditEventType)[keyof typeof CreditEventType];

package/dist/api/types/CreditsAutoTopupCompanySummary.d.ts

@@ -0,0 +1,4 @@
+export interface CreditsAutoTopupCompanySummary {
+    id: string;
+    name: string;
+}

package/dist/api/types/CreditsAutoTopupCreditSummary.d.ts

@@ -0,0 +1,4 @@
+export interface CreditsAutoTopupCreditSummary {
+    id: string;
+    name: string;
+}

package/dist/api/types/CreditsAutoTopupHardFailure.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface CreditsAutoTopupHardFailure {
+    company?: Schematic.CreditsAutoTopupCompanySummary;
+    credit?: Schematic.CreditsAutoTopupCreditSummary;
+    errorMessage?: string;
+    stripeErrorCode?: string;
+}

package/dist/api/types/CreditsAutoTopupRetryFailure.d.ts

@@ -0,0 +1,8 @@
+import type * as Schematic from "../index";
+export interface CreditsAutoTopupRetryFailure {
+    company?: Schematic.CreditsAutoTopupCompanySummary;
+    consecutiveFailures: number;
+    credit?: Schematic.CreditsAutoTopupCreditSummary;
+    lastErrorMessage?: string;
+    stripeErrorCode?: string;
+}

package/dist/api/types/FeatureCompanyResponseData.d.ts

@@ -4,6 +4,7 @@ export interface FeatureCompanyResponseData {
     access: boolean;
     /** The maximum amount of usage that is permitted; a null value indicates that unlimited usage is permitted or that this is a credit-based entitlement (use credit_remaining instead). */
     allocation?: number;
+    /** The type of allocation that is being used. */
     allocationType: Schematic.EntitlementValueType;
     company?: Schematic.CompanyDetailResponseData;
     companyOverride?: Schematic.CompanyOverrideResponseData;
@@ -11,6 +12,7 @@ export interface FeatureCompanyResponseData {
     creditConsumptionRate?: number;
     creditGrantCounts?: Record<string, number>;
     creditGrantDetails?: Schematic.CreditGrantDetail[];
+    /** Reason for the credit grant */
     creditGrantReason?: Schematic.BillingCreditGrantReason;
     creditRemaining?: number;
     /** Deprecated: Use credit_remaining instead. */
@@ -18,6 +20,7 @@ export interface FeatureCompanyResponseData {
     /** Icon identifier for the credit type */
     creditTypeIcon?: string;
     creditUsage?: Schematic.CreditUsage;
+    /** Aggregated credit usage by time period (day, week, month, billing period) */
     creditUsageAggregation?: Schematic.CreditUsageAggregation;
     creditUsed?: number;
     /** Effective limit for usage calculations. For overage pricing, this is the soft limit where overage charges begin. For tiered pricing, this is the first tier boundary. For other pricing models, this is the base allocation. Used to calculate usage percentages and determine access thresholds. */

package/dist/api/types/FeatureCompanyUserResponseData.d.ts

@@ -4,6 +4,7 @@ export interface FeatureCompanyUserResponseData {
     access: boolean;
     /** The maximum amount of usage that is permitted; a null value indicates that unlimited usage is permitted. */
     allocation?: number;
+    /** The type of allocation that is being used. */
     allocationType: Schematic.EntitlementValueType;
     company?: Schematic.CompanyDetailResponseData;
     entitlementId: string;

package/dist/api/types/FeatureEntitlement.d.ts

@@ -0,0 +1,31 @@
+import type * as Schematic from "../index";
+export interface FeatureEntitlement {
+    /** If the company has a numeric entitlement for this feature, the allocated amount */
+    allocation?: number;
+    /** If the company has a credit-based entitlement for this feature, the ID of the credit */
+    creditId?: string;
+    /** If the company has a credit-based entitlement for this feature, the remaining credit amount */
+    creditRemaining?: number;
+    /** If the company has a credit-based entitlement for this feature, the total credit amount */
+    creditTotal?: number;
+    /** If the company has a credit-based entitlement for this feature, the amount of credit used */
+    creditUsed?: number;
+    /** If the feature is event-based, the name of the event tracked for usage */
+    eventName?: string;
+    /** The ID of the feature */
+    featureId: string;
+    /** The key of the flag associated with the feature */
+    featureKey: string;
+    /** For event-based feature entitlements, the period over which usage is tracked */
+    metricPeriod?: Schematic.FeatureEntitlementMetricPeriod;
+    /** For event-based feature entitlements, when the usage period will reset */
+    metricResetAt?: Date;
+    /** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
+    monthReset?: Schematic.FeatureEntitlementMonthReset;
+    /** For usage-based pricing, the soft limit for overage charges or the next tier boundary */
+    softLimit?: number;
+    /** If the company has a numeric entitlement for this feature, the current usage amount */
+    usage?: number;
+    /** The type of the entitlement value */
+    valueType: Schematic.EntitlementValueType;
+}

package/dist/api/types/FeatureEntitlementMetricPeriod.d.ts

@@ -0,0 +1,8 @@
+/** For event-based feature entitlements, the period over which usage is tracked */
+export declare const FeatureEntitlementMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};
+export type FeatureEntitlementMetricPeriod = (typeof FeatureEntitlementMetricPeriod)[keyof typeof FeatureEntitlementMetricPeriod];

package/dist/api/types/FeatureEntitlementMonthReset.d.ts

@@ -0,0 +1,6 @@
+/** For event-based feature entitlements that have a monthly period, whether that monthly reset is based on the calendar month or a billing cycle */
+export declare const FeatureEntitlementMonthReset: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};
+export type FeatureEntitlementMonthReset = (typeof FeatureEntitlementMonthReset)[keyof typeof FeatureEntitlementMonthReset];

package/dist/api/types/FeatureUsageLegacyResponseData.d.ts

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface FeatureUsageLegacyResponseData {
+    allocation?: number;
+    creditUsage?: Schematic.CreditUsage;
+    entitlement: string;
+    feature?: Schematic.FeatureView;
+    metricResetAt?: Date;
+    usage?: number;
+}