@schematichq/schematic-typescript-node 1.2.6 → 1.2.7

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

@@ -1,14 +1,15 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface FeatureResponseData {
     createdAt: Date;
     description: string;
     eventSubtype?: string;
-    featureType: string;
+    featureType: Schematic.FeatureType;
     icon: string;
     id: string;
-    lifecyclePhase?: string;
+    lifecyclePhase?: Schematic.FeatureLifecyclePhase;
     maintainerId?: string;
     name: string;
     pluralName?: string;

package/dist/api/{resources/features/types/CreateFeatureRequestBodyFeatureType.d.ts → types/FeatureType.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreateFeatureRequestBodyFeatureType = "boolean" | "event" | "trait";
-export declare const CreateFeatureRequestBodyFeatureType: {
+export type FeatureType = "boolean" | "event" | "trait";
+export declare const FeatureType: {
     readonly Boolean: "boolean";
     readonly Event: "event";
     readonly Trait: "trait";

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

@@ -9,7 +9,7 @@ export interface FeatureUsageDataResponseData {
     entitlementValueType: string;
     featureId: string;
     featureName: string;
-    featureType: string;
+    featureType: Schematic.FeatureType;
     hardLimit: string;
     hasAccess: boolean;
     metricResetAt?: Date;

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

@@ -7,15 +7,13 @@ export interface FeatureUsageResponseData {
     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.FeatureUsageResponseDataAllocationType;
+    allocationType: Schematic.EntitlementValueType;
     companyOverride?: Schematic.CompanyOverrideResponseData;
     /** The rate at which credits are consumed per unit of usage */
     creditConsumptionRate?: number;
     creditGrantCounts?: Record<string, number>;
     creditGrantDetails?: Schematic.CreditGrantDetail[];
-    /** Reason for the credit grant */
-    creditGrantReason?: Schematic.FeatureUsageResponseDataCreditGrantReason;
+    creditGrantReason?: Schematic.BillingCreditGrantReason;
     creditRemaining?: number;
     creditTotal?: number;
     /** Icon identifier for the credit type */
@@ -29,7 +27,7 @@ export interface FeatureUsageResponseData {
     entitlementId: string;
     /** Source of the entitlement (plan or company_override) */
     entitlementSource?: string;
-    entitlementType: string;
+    entitlementType: Schematic.EntitlementType;
     feature?: Schematic.FeatureDetailResponseData;
     /** Whether a valid allocation exists */
     hasValidAllocation?: boolean;
@@ -48,7 +46,7 @@ export interface FeatureUsageResponseData {
     period?: string;
     plan?: Schematic.PlanResponseData;
     planEntitlement?: Schematic.PlanEntitlementResponseData;
-    priceBehavior?: string;
+    priceBehavior?: Schematic.EntitlementPriceBehavior;
     /** The soft limit for the feature usage. Available only for overage price behavior */
     softLimit?: number;
     /** The amount of usage that has been consumed; a null value indicates that usage is not being measured. */

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

@@ -8,7 +8,7 @@ export interface FlagDetailResponseData {
     description: string;
     feature?: Schematic.FeatureResponseData;
     featureId?: string;
-    flagType: string;
+    flagType: Schematic.FlagType;
     id: string;
     key: string;
     lastCheckedAt?: Date;

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

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface FlagResponseData {
     createdAt: Date;
     defaultValue: boolean;
     description: string;
     featureId?: string;
-    flagType: string;
+    flagType: Schematic.FlagType;
     id: string;
     key: string;
     maintainerId?: string;

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

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type FlagType = "boolean";

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

@@ -1,13 +1,14 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface IssueTemporaryAccessTokenResponseData {
     apiKeyId: string;
     createdAt: Date;
     environmentId: string;
     expiredAt: Date;
     id: string;
-    resourceType: string;
+    resourceType: Schematic.TemporaryAccessTokenResourceType;
     token: string;
     updatedAt: Date;
 }

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

@@ -6,10 +6,15 @@ export interface ManagePlanRequest {
     addOnSelections: Schematic.PlanSelection[];
     basePlanId?: string;
     basePlanPriceId?: string;
+    /** If false, subscription cancels at period end. Only applies when removing all plans. Defaults to true. */
+    cancelImmediately?: boolean;
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
     payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodExternalId?: string;
     promoCode?: string;
+    /** If true and cancel_immediately is true, issue prorated credit. Only applies when removing all plans. Defaults to true. */
+    prorate?: boolean;
+    trialEnd?: Date;
 }

package/dist/api/types/{PlanChangeResponseDataAction.d.ts → PlanChangeAction.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type PlanChangeResponseDataAction = "checkout" | "company_upsert" | "fallback_plan" | "manage_plan" | "migration" | "plan_billing_product_changed" | "plan_deleted" | "quickstart" | "subscription_change";
-export declare const PlanChangeResponseDataAction: {
+export type PlanChangeAction = "checkout" | "company_upsert" | "fallback_plan" | "manage_plan" | "migration" | "plan_billing_product_changed" | "plan_deleted" | "plan_trait_change" | "quickstart" | "subscription_change";
+export declare const PlanChangeAction: {
     readonly Checkout: "checkout";
     readonly CompanyUpsert: "company_upsert";
     readonly FallbackPlan: "fallback_plan";
@@ -10,6 +10,7 @@ export declare const PlanChangeResponseDataAction: {
     readonly Migration: "migration";
     readonly PlanBillingProductChanged: "plan_billing_product_changed";
     readonly PlanDeleted: "plan_deleted";
+    readonly PlanTraitChange: "plan_trait_change";
     readonly Quickstart: "quickstart";
     readonly SubscriptionChange: "subscription_change";
 };

package/dist/api/types/{PlanChangeResponseDataActorType.d.ts → PlanChangeActorType.d.ts}

@@ -1,10 +1,10 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type PlanChangeResponseDataActorType = "app_user" | "api_key" | "system" | "temporary_access_token";
-export declare const PlanChangeResponseDataActorType: {
-    readonly AppUser: "app_user";
+export type PlanChangeActorType = "api_key" | "app_user" | "system" | "temporary_access_token";
+export declare const PlanChangeActorType: {
     readonly ApiKey: "api_key";
+    readonly AppUser: "app_user";
     readonly System: "system";
     readonly TemporaryAccessToken: "temporary_access_token";
 };

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type PlanChangeBasePlanAction = "fallback" | "initial" | "trait" | "trial_expiry";
+export declare const PlanChangeBasePlanAction: {
+    readonly Fallback: "fallback";
+    readonly Initial: "initial";
+    readonly Trait: "trait";
+    readonly TrialExpiry: "trial_expiry";
+};

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

@@ -3,15 +3,14 @@
  */
 import * as Schematic from "../index";
 export interface PlanChangeResponseData {
-    action: Schematic.PlanChangeResponseDataAction;
-    actorType: Schematic.PlanChangeResponseDataActorType;
+    action: Schematic.PlanChangeAction;
+    actorType: Schematic.PlanChangeActorType;
     addOnsAdded: Schematic.PlanSnapshotView[];
     addOnsRemoved: Schematic.PlanSnapshotView[];
     apiKey?: Schematic.ApiKeyResponseData;
     apiKeyRequest?: Schematic.ApiKeyRequestListResponseData;
     basePlan?: Schematic.PlanSnapshotView;
-    /** Any special behavior that affected the assignment of the base plan during this change. */
-    basePlanAction?: Schematic.PlanChangeResponseDataBasePlanAction;
+    basePlanAction?: Schematic.PlanChangeBasePlanAction;
     company?: Schematic.CompanyResponseData;
     companyId: string;
     createdAt: Date;
@@ -19,8 +18,7 @@ export interface PlanChangeResponseData {
     id: string;
     previousBasePlan?: Schematic.PlanSnapshotView;
     requestId?: string;
-    /** If a subscription was changed as a part of this plan change, indicates the type of change that was made. */
-    subscriptionChangeAction?: Schematic.PlanChangeResponseDataSubscriptionChangeAction;
+    subscriptionChangeAction?: Schematic.PlanChangeSubscriptionAction;
     /** Any traits were updated as part of this plan change (via pay-in-advance entitlements). */
     traitsUpdated: Schematic.SubscriptionTraitUpdate[];
     updatedAt: Date;

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type PlanChangeSubscriptionAction = "downgrade" | "invalid" | "subscribe" | "unsubscribe" | "upgrade" | "upgrade_trial";
+export declare const PlanChangeSubscriptionAction: {
+    readonly Downgrade: "downgrade";
+    readonly Invalid: "invalid";
+    readonly Subscribe: "subscribe";
+    readonly Unsubscribe: "unsubscribe";
+    readonly Upgrade: "upgrade";
+    readonly UpgradeTrial: "upgrade_trial";
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type PlanControlledByType = "schematic" | "stripe";
+export declare const PlanControlledByType: {
+    readonly Schematic: "schematic";
+    readonly Stripe: "stripe";
+};

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

@@ -1,12 +1,13 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface PlanCreditGrantView {
     billingCreditAutoTopupAmount?: number;
     billingCreditAutoTopupAmountType?: string;
     billingCreditAutoTopupEnabled: boolean;
-    billingCreditAutoTopupExpiryType?: string;
-    billingCreditAutoTopupExpiryUnit?: string;
+    billingCreditAutoTopupExpiryType?: Schematic.BillingCreditExpiryType;
+    billingCreditAutoTopupExpiryUnit?: Schematic.BillingCreditExpiryUnit;
     billingCreditAutoTopupExpiryUnitCount?: number;
     billingCreditAutoTopupThresholdPercent?: number;
     createdAt: Date;
@@ -15,16 +16,16 @@ export interface PlanCreditGrantView {
     creditIcon?: string;
     creditId: string;
     creditName: string;
-    expiryType?: string;
-    expiryUnit?: string;
+    expiryType?: Schematic.BillingCreditExpiryType;
+    expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
     id: string;
     planId: string;
     planName: string;
     pluralName?: string;
-    resetCadence: string;
-    resetStart: string;
-    resetType: string;
+    resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
+    resetStart: Schematic.BillingPlanCreditGrantResetStart;
+    resetType: Schematic.BillingPlanCreditGrantResetType;
     singularName?: string;
     updatedAt: Date;
 }

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

@@ -5,9 +5,9 @@ import * as Schematic from "../index";
 export interface PlanDetailResponseData {
     audienceType?: string;
     billingProduct?: Schematic.BillingProductDetailResponseData;
-    chargeType: string;
+    chargeType: Schematic.ChargeType;
     companyCount: number;
-    controlledBy: string;
+    controlledBy: Schematic.PlanControlledByType;
     createdAt: Date;
     description: string;
     features: Schematic.FeatureDetailResponseData[];
@@ -20,7 +20,7 @@ export interface PlanDetailResponseData {
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     oneTimePrice?: Schematic.BillingPriceResponseData;
-    planType: string;
+    planType: Schematic.PlanType;
     trialDays?: number;
     updatedAt: Date;
     yearlyPrice?: Schematic.BillingPriceResponseData;

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

@@ -16,7 +16,7 @@ export interface PlanEntitlementResponseData {
     metricPeriodMonthReset?: string;
     plan?: Schematic.PlanResponseData;
     planId: string;
-    priceBehavior?: string;
+    priceBehavior?: Schematic.EntitlementPriceBehavior;
     ruleId: string;
     ruleIdUsageExceeded?: string;
     softLimit?: number;
@@ -27,5 +27,5 @@ export interface PlanEntitlementResponseData {
     valueNumeric?: number;
     valueTrait?: Schematic.EntityTraitDefinitionResponseData;
     valueTraitId?: string;
-    valueType: string;
+    valueType: Schematic.EntitlementValueType;
 }

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

@@ -5,6 +5,7 @@ import * as Schematic from "../index";
 export interface PlanGroupDetailResponseData {
     addOns: Schematic.PlanGroupPlanDetailResponseData[];
     checkoutSettings: Schematic.CheckoutSettingsResponseData;
+    componentSettings: Schematic.ComponentSettingsResponseData;
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     customPlanId?: string;
     defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;
@@ -14,22 +15,27 @@ export interface PlanGroupDetailResponseData {
     id: string;
     initialPlan?: Schematic.PlanGroupPlanDetailResponseData;
     initialPlanId?: string;
-    initialPlanPrice?: Schematic.BillingPriceResponseData;
+    initialPlanPrice?: Schematic.BillingPriceView;
     initialPlanPriceId?: string;
     orderedAddOnList: Schematic.PlanGroupPlanEntitlementsOrder[];
     orderedBundleList: Schematic.PlanGroupBundleOrder[];
     orderedPlanList: Schematic.PlanGroupPlanEntitlementsOrder[];
     plans: Schematic.PlanGroupPlanDetailResponseData[];
     preventDowngradesWhenOverLimit: boolean;
+    preventSelfServiceDowngrade: boolean;
+    preventSelfServiceDowngradeButtonText?: string;
+    preventSelfServiceDowngradeUrl?: string;
+    prorationBehavior: string;
+    showAsMonthlyPrices: boolean;
     showCredits: boolean;
     showPeriodToggle: boolean;
     showZeroPriceAsFree: boolean;
-    syncCustomerBillingDetailsForTax: boolean;
+    syncCustomerBillingDetails: boolean;
     taxCollectionEnabled: boolean;
     trialDays?: number;
     trialExpiryPlan?: Schematic.PlanGroupPlanDetailResponseData;
     trialExpiryPlanId?: string;
-    trialExpiryPlanPrice?: Schematic.BillingPriceResponseData;
+    trialExpiryPlanPrice?: Schematic.BillingPriceView;
     trialExpiryPlanPriceId?: string;
     trialPaymentMethodRequired?: boolean;
 }

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

@@ -5,10 +5,10 @@ import * as Schematic from "../index";
 export interface PlanGroupPlanDetailResponseData {
     audienceType?: string;
     billingProduct?: Schematic.BillingProductDetailResponseData;
-    chargeType: string;
+    chargeType: Schematic.ChargeType;
     companyCount: number;
     compatiblePlanIds: string[];
-    controlledBy: string;
+    controlledBy: Schematic.PlanControlledByType;
     createdAt: Date;
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     description: string;
@@ -24,7 +24,7 @@ export interface PlanGroupPlanDetailResponseData {
     monthlyPrice?: Schematic.BillingPriceResponseData;
     name: string;
     oneTimePrice?: Schematic.BillingPriceResponseData;
-    planType: string;
+    planType: Schematic.PlanType;
     trialDays?: number;
     updatedAt: Date;
     yearlyPrice?: Schematic.BillingPriceResponseData;

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

@@ -6,6 +6,7 @@ export interface PlanGroupResponseData {
     addOnCompatibilities: Schematic.CompatiblePlansResponseData[];
     addOnIds: string[];
     checkoutSettings: Schematic.CheckoutSettingsResponseData;
+    componentSettings: Schematic.ComponentSettingsResponseData;
     defaultPlanId?: string;
     fallbackPlanId?: string;
     id: string;
@@ -14,10 +15,15 @@ export interface PlanGroupResponseData {
     orderedAddOnIds: Schematic.OrderedPlansInGroup[];
     planIds: Schematic.OrderedPlansInGroup[];
     preventDowngradesWhenOverLimit: boolean;
+    preventSelfServiceDowngrade: boolean;
+    preventSelfServiceDowngradeButtonText?: string;
+    preventSelfServiceDowngradeUrl?: string;
+    prorationBehavior: string;
+    showAsMonthlyPrices: boolean;
     showCredits: boolean;
     showPeriodToggle: boolean;
     showZeroPriceAsFree: boolean;
-    syncCustomerBillingDetailsForTax: boolean;
+    syncCustomerBillingDetails: boolean;
     taxCollectionEnabled: boolean;
     trialDays?: number;
     trialExpiryPlanId?: string;

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

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface PlanResponseData {
     audienceType?: string;
     createdAt: Date;
@@ -8,6 +9,6 @@ export interface PlanResponseData {
     icon: string;
     id: string;
     name: string;
-    planType: string;
+    planType: Schematic.PlanType;
     updatedAt: Date;
 }

package/dist/api/{resources/plans/types/CreatePlanRequestBodyPlanType.d.ts → types/PlanType.d.ts}

@@ -1,8 +1,8 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type CreatePlanRequestBodyPlanType = "plan" | "add_on";
-export declare const CreatePlanRequestBodyPlanType: {
+export type PlanType = "plan" | "add_on";
+export declare const PlanType: {
     readonly Plan: "plan";
     readonly AddOn: "add_on";
 };

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

@@ -13,6 +13,7 @@ export interface PreviewSubscriptionFinanceResponseData {
     taxAmount?: number;
     taxDisplayName?: string;
     taxRequireBillingDetails: boolean;
+    totalPerBillingPeriod: number;
     trialEnd?: Date;
     upcomingInvoiceLineItems: Schematic.PreviewSubscriptionUpcomingInvoiceLineItems[];
 }

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ProrationBehavior = "create_prorations" | "invoice_immediately";
+export declare const ProrationBehavior: {
+    readonly CreateProrations: "create_prorations";
+    readonly InvoiceImmediately: "invoice_immediately";
+};

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

@@ -20,7 +20,7 @@ export interface RuleConditionDetailResponseData {
     resources: Schematic.PreviewObjectResponseData[];
     ruleId: string;
     trait?: Schematic.EntityTraitDefinitionResponseData;
-    traitEntityType?: string;
+    traitEntityType?: Schematic.EntityType;
     traitId?: string;
     traitValue: string;
     updatedAt: Date;

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

@@ -1,6 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+import * as Schematic from "../index";
 export interface RuleConditionResponseData {
     comparisonTraitId?: string;
     conditionGroupId?: string;
@@ -16,7 +17,7 @@ export interface RuleConditionResponseData {
     operator: string;
     resourceIds: string[];
     ruleId: string;
-    traitEntityType?: string;
+    traitEntityType?: Schematic.EntityType;
     traitId?: string;
     traitValue: string;
     updatedAt: Date;

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The current schema version hash for rules engine types. The first enum value is always the current version.
+ */
+export type RulesEngineSchemaVersion = "549e6fea" | "placeholder-for-fern-compatibility";
+export declare const RulesEngineSchemaVersion: {
+    readonly FiveHundredFortyNineE6Fea: "549e6fea";
+    readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
+};

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCheckFlagResult {
+    companyId?: string;
+    err?: string;
+    featureAllocation?: number;
+    featureUsage?: number;
+    featureUsageEvent?: string;
+    featureUsagePeriod?: Schematic.RulesengineCheckFlagResultFeatureUsagePeriod;
+    featureUsageResetAt?: Date;
+    flagId?: string;
+    flagKey: string;
+    reason: string;
+    ruleId?: string;
+    ruleType?: Schematic.RulesengineCheckFlagResultRuleType;
+    userId?: string;
+    value: boolean;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCheckFlagResultFeatureUsagePeriod = "all_time" | "current_day" | "current_month" | "current_week";
+export declare const RulesengineCheckFlagResultFeatureUsagePeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};

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

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCheckFlagResultRuleType = "default" | "global_override" | "company_override" | "company_override_usage_exceeded" | "plan_entitlement" | "plan_entitlement_usage_exceeded" | "standard";
+export declare const RulesengineCheckFlagResultRuleType: {
+    readonly Default: "default";
+    readonly GlobalOverride: "global_override";
+    readonly CompanyOverride: "company_override";
+    readonly CompanyOverrideUsageExceeded: "company_override_usage_exceeded";
+    readonly PlanEntitlement: "plan_entitlement";
+    readonly PlanEntitlementUsageExceeded: "plan_entitlement_usage_exceeded";
+    readonly Standard: "standard";
+};

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

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCompany {
+    accountId: string;
+    basePlanId?: string;
+    billingProductIds: string[];
+    creditBalances: Record<string, number>;
+    crmProductIds: string[];
+    environmentId: string;
+    id: string;
+    keys: Record<string, string>;
+    metrics: Schematic.RulesengineCompanyMetric[];
+    planIds: string[];
+    rules: Schematic.RulesengineRule[];
+    subscription?: Schematic.RulesengineSubscription;
+    traits: Schematic.RulesengineTrait[];
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCompanyMetric {
+    accountId: string;
+    companyId: string;
+    createdAt: Date;
+    environmentId: string;
+    eventSubtype: string;
+    monthReset: Schematic.RulesengineCompanyMetricMonthReset;
+    period: Schematic.RulesengineCompanyMetricPeriod;
+    validUntil?: Date;
+    value: number;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCompanyMetricMonthReset = "first_of_month" | "billing_cycle";
+export declare const RulesengineCompanyMetricMonthReset: {
+    readonly FirstOfMonth: "first_of_month";
+    readonly BillingCycle: "billing_cycle";
+};

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineCompanyMetricPeriod = "all_time" | "current_day" | "current_month" | "current_week";
+export declare const RulesengineCompanyMetricPeriod: {
+    readonly AllTime: "all_time";
+    readonly CurrentDay: "current_day";
+    readonly CurrentMonth: "current_month";
+    readonly CurrentWeek: "current_week";
+};

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Schematic from "../index";
+export interface RulesengineCondition {
+    accountId: string;
+    comparisonTraitDefinition?: Schematic.RulesengineTraitDefinition;
+    conditionType: Schematic.RulesengineConditionConditionType;
+    consumptionRate?: number;
+    creditId?: string;
+    environmentId: string;
+    eventSubtype?: string;
+    id: string;
+    metricPeriod?: Schematic.RulesengineConditionMetricPeriod;
+    metricPeriodMonthReset?: Schematic.RulesengineConditionMetricPeriodMonthReset;
+    metricValue?: number;
+    operator: Schematic.RulesengineConditionOperator;
+    resourceIds: string[];
+    traitDefinition?: Schematic.RulesengineTraitDefinition;
+    traitValue: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RulesengineConditionConditionType = "base_plan" | "billing_product" | "company" | "credit" | "crm_product" | "metric" | "plan" | "trait" | "user";
+export declare const RulesengineConditionConditionType: {
+    readonly BasePlan: "base_plan";
+    readonly BillingProduct: "billing_product";
+    readonly Company: "company";
+    readonly Credit: "credit";
+    readonly CrmProduct: "crm_product";
+    readonly Metric: "metric";
+    readonly Plan: "plan";
+    readonly Trait: "trait";
+    readonly User: "user";
+};