@schematichq/schematic-typescript-node 1.4.6 → 1.4.8

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

@@ -0,0 +1,6 @@
+export declare const IntegrationState: {
+    readonly Active: "active";
+    readonly Created: "created";
+    readonly Pending: "pending";
+};
+export type IntegrationState = (typeof IntegrationState)[keyof typeof IntegrationState];

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

@@ -1,7 +1,9 @@
 export declare const IntegrationType: {
     readonly Clerk: "clerk";
+    readonly Metronome: "metronome";
     readonly Orb: "orb";
     readonly Stripe: "stripe";
     readonly Unknown: "unknown";
+    readonly Workos: "workos";
 };
 export type IntegrationType = (typeof IntegrationType)[keyof typeof IntegrationType];

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

@@ -0,0 +1,3 @@
+export interface IntegrationsDataSetResponseData {
+    keys: string[];
+}

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../index";
+export interface IntegrationsListResponseData {
+    capabilities: Schematic.IntegrationCapabilities;
+    config?: Schematic.IntegrationConfig;
+    id: string;
+    isAppInstall: boolean;
+    isConnectInstall: boolean;
+    state: Schematic.IntegrationState;
+    type: Schematic.IntegrationType;
+}

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

@@ -0,0 +1,8 @@
+import type * as Schematic from "../index";
+export interface IntegrationsResponseData {
+    createdAt: Date;
+    id: string;
+    state: Schematic.IntegrationState;
+    type: Schematic.IntegrationType;
+    updatedAt: Date;
+}

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

@@ -9,6 +9,7 @@ export interface ManagePlanRequest {
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    customFieldValues: Schematic.CheckoutFieldValue[];
     payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodExternalId?: string;
     promoCode?: string;

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

@@ -0,0 +1 @@
+export type MarkCustomPlanBillingPaidRequestBody = Record<string, unknown>;

package/dist/api/types/{ConditionMetricPeriod.d.ts → MetricPeriod.d.ts}

@@ -1,7 +1,7 @@
-export declare const ConditionMetricPeriod: {
+export declare const MetricPeriod: {
     readonly AllTime: "all_time";
     readonly CurrentDay: "current_day";
     readonly CurrentMonth: "current_month";
     readonly CurrentWeek: "current_week";
 };
-export type ConditionMetricPeriod = (typeof ConditionMetricPeriod)[keyof typeof ConditionMetricPeriod];
+export type MetricPeriod = (typeof MetricPeriod)[keyof typeof MetricPeriod];

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

@@ -0,0 +1,5 @@
+export declare const MetricPeriodMonthReset: {
+    readonly BillingCycle: "billing_cycle";
+    readonly FirstOfMonth: "first_of_month";
+};
+export type MetricPeriodMonthReset = (typeof MetricPeriodMonthReset)[keyof typeof MetricPeriodMonthReset];

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

@@ -0,0 +1 @@
+export type MetronomeIntegrationConfig = {};

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

@@ -0,0 +1,15 @@
+export declare const MigrationErrorCode: {
+    readonly AmbiguousSubscriptionItem: "ambiguous_subscription_item";
+    readonly MultipleSubscriptions: "multiple_subscriptions";
+    readonly NoPriceForInterval: "no_price_for_interval";
+    readonly NotOnOriginVersion: "not_on_origin_version";
+    readonly OperationItemNotFound: "operation_item_not_found";
+    readonly PermanentConfig: "permanent_config";
+    readonly PermanentDecline: "permanent_decline";
+    readonly TransientDecline: "transient_decline";
+    readonly TransientInfra: "transient_infra";
+    readonly TransientStripe: "transient_stripe";
+    readonly Unknown: "unknown";
+    readonly WouldLeaveEmptySubscription: "would_leave_empty_subscription";
+};
+export type MigrationErrorCode = (typeof MigrationErrorCode)[keyof typeof MigrationErrorCode];

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

@@ -0,0 +1,4 @@
+export interface MrrResponseData {
+    amount: number;
+    currency: string;
+}

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

@@ -0,0 +1,4 @@
+export interface OrbIntegrationConfig {
+    /** Schematic company key used to store Orb's external_customer_id; when unset, defaults to orb_external_customer_id */
+    externalCustomerIdKey?: string;
+}

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

@@ -6,6 +6,7 @@ export interface PlanCreditGrantView {
     billingCreditAutoTopupExpiryType?: Schematic.BillingCreditExpiryType;
     billingCreditAutoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
     billingCreditAutoTopupExpiryUnitCount?: number;
+    billingCreditAutoTopupSelfService: boolean;
     billingCreditAutoTopupThresholdCredits?: number;
     billingCreditAutoTopupThresholdPercent?: number;
     createdAt: Date;
@@ -30,6 +31,7 @@ export interface PlanCreditGrantView {
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;
+    rolloverPercentage: number;
     /** Deprecated field, will be removed in the future. Use Credit.SingularName instead. */
     singularName?: string;
     updatedAt: Date;

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

@@ -2,5 +2,6 @@ export interface PlanCurrencyPriceRequestBody {
     currency: string;
     monthlyPrice?: number;
     oneTimePrice?: number;
+    quarterlyPrice?: number;
     yearlyPrice?: number;
 }

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

@@ -3,5 +3,6 @@ export interface PlanCurrencyPricesResponseData {
     currency: string;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     oneTimePrice?: Schematic.BillingPriceResponseData;
+    quarterlyPrice?: Schematic.BillingPriceResponseData;
     yearlyPrice?: Schematic.BillingPriceResponseData;
 }

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

@@ -4,27 +4,31 @@ export interface PlanDetailResponseData {
     audienceType?: string;
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
+    billingStrategy: Schematic.BillingStrategy;
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;
     companyName?: string;
-    controlledBy: string;
+    controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     description: string;
     draftVersion?: Schematic.PlanVersionResponseData;
-    features: Schematic.FeatureDetailResponseData[];
+    entitlements?: Schematic.PlanEntitlementResponseData[];
+    features: Schematic.FeatureInPlanResponseData[];
     icon: Schematic.PlanIcon;
     id: string;
     includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     isDefault: boolean;
+    /** Deprecated: Use BillingStrategy instead */
     isFree: boolean;
     isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     oneTimePrice?: Schematic.BillingPriceResponseData;
     planType: Schematic.PlanType;
+    quarterlyPrice?: Schematic.BillingPriceResponseData;
     trialDays?: number;
     updatedAt: Date;
     versions: Schematic.PlanVersionResponseData[];

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

@@ -10,9 +10,10 @@ export interface PlanEntitlementResponseData {
     featureId: string;
     id: string;
     meteredMonthlyPrice?: Schematic.BillingPriceView;
+    meteredQuarterlyPrice?: Schematic.BillingPriceView;
     meteredYearlyPrice?: Schematic.BillingPriceView;
-    metricPeriod?: string;
-    metricPeriodMonthReset?: string;
+    metricPeriod?: Schematic.MetricPeriod;
+    metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     plan?: Schematic.PlanResponseData;
     planId: string;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
@@ -21,6 +22,8 @@ export interface PlanEntitlementResponseData {
     softLimit?: number;
     updatedAt: Date;
     usageBasedProduct?: Schematic.BillingProductResponseData;
+    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    usageQuantity?: number;
     valueBool?: boolean;
     valueCredit?: Schematic.BillingCreditResponseData;
     valueNumeric?: number;

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

@@ -3,6 +3,7 @@ export interface PlanGroupDetailResponseData {
     addOns: Schematic.PlanGroupPlanDetailResponseData[];
     checkoutSettings: Schematic.CheckoutSettingsResponseData;
     componentSettings: Schematic.ComponentSettingsResponseData;
+    customCheckoutFields: Schematic.CheckoutFieldResponseData[];
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     customPlanId?: string;
     defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;

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

@@ -2,33 +2,37 @@ import type * as Schematic from "../index";
 export interface PlanGroupPlanDetailResponseData {
     activeVersion?: Schematic.PlanVersionResponseData;
     audienceType?: string;
+    availablePeriods: Schematic.PlanPriceCadence[];
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
+    billingStrategy: Schematic.BillingStrategy;
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;
     companyName?: string;
     compatiblePlanIds: string[];
-    controlledBy: string;
+    controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     description: string;
     draftVersion?: Schematic.PlanVersionResponseData;
-    entitlements: Schematic.PlanEntitlementResponseData[];
-    features: Schematic.FeatureDetailResponseData[];
+    entitlements?: Schematic.PlanEntitlementResponseData[];
+    features: Schematic.FeatureInPlanResponseData[];
     icon: Schematic.PlanIcon;
     id: string;
     includedCreditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     isCustom: boolean;
     isDefault: boolean;
+    /** Deprecated: Use BillingStrategy instead */
     isFree: boolean;
     isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     oneTimePrice?: Schematic.BillingPriceResponseData;
     planType: Schematic.PlanType;
+    quarterlyPrice?: Schematic.BillingPriceResponseData;
     trialDays?: number;
     updatedAt: Date;
     versions: Schematic.PlanVersionResponseData[];

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

@@ -0,0 +1,6 @@
+export interface PlanGrowthPointResponseData {
+    month: Date;
+    planId: string;
+    planName: string;
+    subscribers: number;
+}

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

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface PlanGrowthResponseData {
+    points: Schematic.PlanGrowthPointResponseData[];
+}

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

@@ -0,0 +1,6 @@
+export declare const PlanPriceCadence: {
+    readonly Monthly: "monthly";
+    readonly Quarterly: "quarterly";
+    readonly Yearly: "yearly";
+};
+export type PlanPriceCadence = (typeof PlanPriceCadence)[keyof typeof PlanPriceCadence];

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

@@ -5,6 +5,7 @@ export interface PlanVersionCompanyMigrationResponseData {
     completedAt?: Date;
     createdAt: Date;
     error?: string;
+    errorCode?: Schematic.MigrationErrorCode;
     id: string;
     migrationId: string;
     planVersionIdFrom?: string;

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

@@ -9,6 +9,7 @@ export interface PlanVersionMigrationResponseData {
     planId: string;
     planVersionIdFrom?: string;
     planVersionIdTo: string;
+    planVersionIdsFrom: string[];
     skippedCompanies: number;
     startedAt?: Date;
     status: Schematic.PlanVersionMigrationStatus;

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

@@ -2,14 +2,16 @@ import type * as Schematic from "../index";
 export interface PlanViewPublicResponseData {
     activeVersion?: Schematic.PlanVersionResponseData;
     audienceType?: string;
+    availablePeriods: Schematic.PlanPriceCadence[];
     billingLinkedResource?: Schematic.BillingLinkedResourceResponseData;
     billingProduct?: Schematic.BillingProductDetailResponseData;
+    billingStrategy: Schematic.BillingStrategy;
     chargeType: Schematic.ChargeType;
     companyCount: number;
     companyId?: string;
     companyName?: string;
     compatiblePlanIds: string[];
-    controlledBy: string;
+    controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
@@ -17,19 +19,21 @@ export interface PlanViewPublicResponseData {
     customPlanConfig?: Schematic.CustomPlanConfig;
     description: string;
     draftVersion?: Schematic.PlanVersionResponseData;
-    entitlements: Schematic.PlanEntitlementResponseData[];
-    features: Schematic.FeatureDetailResponseData[];
+    entitlements?: Schematic.PlanEntitlementResponseData[];
+    features: Schematic.FeatureInPlanResponseData[];
     icon: Schematic.PlanIcon;
     id: string;
     includedCreditGrants: Schematic.PlanCreditGrantView[];
     isCustom: boolean;
     isDefault: boolean;
+    /** Deprecated: Use BillingStrategy instead */
     isFree: boolean;
     isTrialable: boolean;
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     oneTimePrice?: Schematic.BillingPriceResponseData;
     planType: Schematic.PlanType;
+    quarterlyPrice?: Schematic.BillingPriceResponseData;
     trialDays?: number;
     updatedAt: Date;
     versions: Schematic.PlanVersionResponseData[];

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

@@ -0,0 +1 @@
+export type ReleaseCreditLeaseRequestBody = Record<string, unknown>;

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

@@ -8,6 +8,6 @@ export interface Rule {
     id: string;
     name: string;
     priority: number;
-    ruleType: Schematic.RuleRuleType;
+    ruleType: Schematic.RuleType;
     value: boolean;
 }

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

@@ -3,16 +3,16 @@ export interface RuleConditionDetailResponseData {
     comparisonTrait?: Schematic.EntityTraitDefinitionResponseData;
     comparisonTraitId?: string;
     conditionGroupId?: string;
-    conditionType: string;
+    conditionType: Schematic.ConditionType;
     createdAt: Date;
     environmentId: string;
     eventSubtype?: string;
     flagId?: string;
     id: string;
-    metricPeriod?: string;
-    metricPeriodMonthReset?: string;
+    metricPeriod?: Schematic.MetricPeriod;
+    metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     metricValue?: number;
-    operator: string;
+    operator: Schematic.ComparableOperator;
     resourceIds: string[];
     resources: Schematic.PreviewObjectResponseData[];
     ruleId: string;

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

@@ -2,16 +2,16 @@ import type * as Schematic from "../index";
 export interface RuleConditionResponseData {
     comparisonTraitId?: string;
     conditionGroupId?: string;
-    conditionType: string;
+    conditionType: Schematic.ConditionType;
     createdAt: Date;
     environmentId: string;
     eventSubtype?: string;
     flagId?: string;
     id: string;
-    metricPeriod?: string;
-    metricPeriodMonthReset?: string;
+    metricPeriod?: Schematic.MetricPeriod;
+    metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     metricValue?: number;
-    operator: string;
+    operator: Schematic.ComparableOperator;
     resourceIds: string[];
     ruleId: string;
     traitEntityType?: Schematic.EntityType;

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

@@ -8,7 +8,7 @@ export interface RuleDetailResponseData {
     id: string;
     name: string;
     priority: number;
-    ruleType: string;
+    ruleType: Schematic.RuleType;
     updatedAt: Date;
     value: boolean;
 }

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

@@ -1,3 +1,4 @@
+import type * as Schematic from "../index";
 export interface RuleResponseData {
     createdAt: Date;
     environmentId: string;
@@ -5,7 +6,7 @@ export interface RuleResponseData {
     id: string;
     name: string;
     priority: number;
-    ruleType: string;
+    ruleType: Schematic.RuleType;
     updatedAt: Date;
     value: boolean;
 }

package/dist/api/types/{RuleRuleType.d.ts → RuleType.d.ts}

@@ -1,10 +1,10 @@
-export declare const RuleRuleType: {
-    readonly Default: "default";
-    readonly GlobalOverride: "global_override";
+export declare const RuleType: {
     readonly CompanyOverride: "company_override";
     readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
+    readonly Default: "default";
+    readonly GlobalOverride: "global_override";
     readonly PlanEntitlement: "plan_entitlement";
     readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
     readonly Standard: "standard";
 };
-export type RuleRuleType = (typeof RuleRuleType)[keyof typeof RuleRuleType];
+export type RuleType = (typeof RuleType)[keyof typeof RuleType];

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

@@ -9,7 +9,7 @@ export interface RuleView {
     id: string;
     name: string;
     priority: number;
-    ruleType: string;
+    ruleType: Schematic.RuleType;
     updatedAt: Date;
     value: boolean;
 }

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

@@ -1,6 +1,6 @@
 /** The current schema version hash for rules engine types. The first enum value is always the current version. */
 export declare const RulesEngineSchemaVersion: {
-    readonly V313Fa646: "v313fa646";
+    readonly V97288F60: "v97288f60";
     readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
 };
 export type RulesEngineSchemaVersion = (typeof RulesEngineSchemaVersion)[keyof typeof RulesEngineSchemaVersion];

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

@@ -6,13 +6,13 @@ export interface RulesengineCheckFlagResult {
     featureAllocation?: number;
     featureUsage?: number;
     featureUsageEvent?: string;
-    featureUsagePeriod?: Schematic.RulesengineCheckFlagResultFeatureUsagePeriod;
+    featureUsagePeriod?: Schematic.RulesengineMetricPeriod;
     featureUsageResetAt?: Date;
     flagId?: string;
     flagKey: string;
     reason: string;
     ruleId?: string;
-    ruleType?: Schematic.RulesengineCheckFlagResultRuleType;
+    ruleType?: Schematic.RulesengineRuleType;
     userId?: string;
     value: boolean;
 }

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

@@ -5,8 +5,8 @@ export interface RulesengineCompanyMetric {
     createdAt: Date;
     environmentId: string;
     eventSubtype: string;
-    monthReset: Schematic.RulesengineCompanyMetricMonthReset;
-    period: Schematic.RulesengineCompanyMetricPeriod;
+    monthReset: Schematic.RulesengineMetricPeriodMonthReset;
+    period: Schematic.RulesengineMetricPeriod;
     validUntil?: Date;
     value: number;
 }

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

@@ -2,16 +2,16 @@ import type * as Schematic from "../index";
 export interface RulesengineCondition {
     accountId: string;
     comparisonTraitDefinition?: Schematic.RulesengineTraitDefinition;
-    conditionType: Schematic.RulesengineConditionConditionType;
+    conditionType: Schematic.RulesengineConditionType;
     consumptionRate?: number;
     creditId?: string;
     environmentId: string;
     eventSubtype?: string;
     id: string;
-    metricPeriod?: Schematic.RulesengineConditionMetricPeriod;
-    metricPeriodMonthReset?: Schematic.RulesengineConditionMetricPeriodMonthReset;
+    metricPeriod?: Schematic.RulesengineMetricPeriod;
+    metricPeriodMonthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     metricValue?: number;
-    operator: Schematic.RulesengineConditionOperator;
+    operator: Schematic.ComparableOperator;
     resourceIds: string[];
     traitDefinition?: Schematic.RulesengineTraitDefinition;
     traitValue: string;

package/dist/api/types/{RulesengineConditionConditionType.d.ts → RulesengineConditionType.d.ts}

@@ -1,4 +1,4 @@
-export declare const RulesengineConditionConditionType: {
+export declare const RulesengineConditionType: {
     readonly BasePlan: "base_plan";
     readonly BillingProduct: "billing_product";
     readonly Company: "company";
@@ -9,4 +9,4 @@ export declare const RulesengineConditionConditionType: {
     readonly Trait: "trait";
     readonly User: "user";
 };
-export type RulesengineConditionConditionType = (typeof RulesengineConditionConditionType)[keyof typeof RulesengineConditionConditionType];
+export type RulesengineConditionType = (typeof RulesengineConditionType)[keyof typeof RulesengineConditionType];

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

@@ -17,11 +17,11 @@ export interface RulesengineFeatureEntitlement {
     /** 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.RulesengineFeatureEntitlementMetricPeriod;
+    metricPeriod?: Schematic.RulesengineMetricPeriod;
     /** 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.RulesengineFeatureEntitlementMonthReset;
+    monthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     /** 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 */

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

@@ -0,0 +1,7 @@
+export declare const RulesengineMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};
+export type RulesengineMetricPeriod = (typeof RulesengineMetricPeriod)[keyof typeof RulesengineMetricPeriod];

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

@@ -0,0 +1,5 @@
+export declare const RulesengineMetricPeriodMonthReset: {
+    readonly BillingCycle: "billing_cycle";
+    readonly FirstOfMonth: "first_of_month";
+};
+export type RulesengineMetricPeriodMonthReset = (typeof RulesengineMetricPeriodMonthReset)[keyof typeof RulesengineMetricPeriodMonthReset];

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

@@ -8,6 +8,6 @@ export interface RulesengineRule {
     id: string;
     name: string;
     priority: number;
-    ruleType: Schematic.RulesengineRuleRuleType;
+    ruleType: Schematic.RulesengineRuleType;
     value: boolean;
 }

package/dist/api/types/{RulesengineRuleRuleType.d.ts → RulesengineRuleType.d.ts}

@@ -1,10 +1,10 @@
-export declare const RulesengineRuleRuleType: {
-    readonly Default: "default";
-    readonly GlobalOverride: "global_override";
+export declare const RulesengineRuleType: {
     readonly CompanyOverride: "company_override";
     readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
+    readonly Default: "default";
+    readonly GlobalOverride: "global_override";
     readonly PlanEntitlement: "plan_entitlement";
     readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
     readonly Standard: "standard";
 };
-export type RulesengineRuleRuleType = (typeof RulesengineRuleRuleType)[keyof typeof RulesengineRuleRuleType];
+export type RulesengineRuleType = (typeof RulesengineRuleType)[keyof typeof RulesengineRuleType];

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

@@ -0,0 +1,14 @@
+export interface StripeIntegrationConfig {
+    /** Connected Stripe account ID (acct_*) */
+    accountId?: string;
+    /** Display name of the connected Stripe account */
+    accountName?: string;
+    /** When importing Stripe customers, only update existing companies, do not create new companies */
+    companyUpdateOnly?: boolean;
+    /** Whether the integration is connected to a Stripe sandbox account */
+    isSandbox: boolean;
+    /** Whether the integration is connected to a live Stripe account */
+    liveMode: boolean;
+    /** Onboarding URL returned during the v2 (Connect) install flow before activation */
+    onboardUrl?: string;
+}

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

@@ -0,0 +1,8 @@
+export interface TopFeatureByUsageResponseData {
+    changePct?: number;
+    featureId: string;
+    featureName: string;
+    pluralName?: string;
+    priorUsage: number;
+    usage: number;
+}

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

@@ -0,0 +1,4 @@
+import type * as Schematic from "../index";
+export interface TopFeaturesByUsageResponseData {
+    features: Schematic.TopFeatureByUsageResponseData[];
+}

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

@@ -0,0 +1,6 @@
+export interface UpdateAutoTopupOverrideRequestBody {
+    autoTopupAmount?: number;
+    autoTopupEnabled?: boolean;
+    autoTopupThresholdCredits?: number;
+    planCreditGrantId: string;
+}

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

@@ -7,6 +7,7 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     autoTopupExpiryType?: Schematic.BillingCreditExpiryType;
     autoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
     autoTopupExpiryUnitCount?: number;
+    autoTopupSelfService?: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
     creditAmount?: number;
@@ -16,4 +17,6 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;
+    /** Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. */
+    rolloverPercentage?: number;
 }