@schematichq/schematic-typescript-node 1.3.1 → 1.4.0

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

@@ -0,0 +1,47 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { BillingPriceResponseData } from "./BillingPriceResponseData";
+import { BillingProductDetailResponseData } from "./BillingProductDetailResponseData";
+import { ChargeType } from "./ChargeType";
+import { CustomPlanConfig } from "./CustomPlanConfig";
+import { FeatureDetailResponseData } from "./FeatureDetailResponseData";
+import { PlanControlledByType } from "./PlanControlledByType";
+import { PlanCreditGrantView } from "./PlanCreditGrantView";
+import { PlanEntitlementResponseData } from "./PlanEntitlementResponseData";
+import { PlanType } from "./PlanType";
+import { PlanVersionResponseData } from "./PlanVersionResponseData";
+export declare const PlanViewPublicResponseData: core.serialization.ObjectSchema<serializers.PlanViewPublicResponseData.Raw, Schematic.PlanViewPublicResponseData>;
+export declare namespace PlanViewPublicResponseData {
+    interface Raw {
+        active_version?: PlanVersionResponseData.Raw | null;
+        audience_type?: string | null;
+        billing_product?: BillingProductDetailResponseData.Raw | null;
+        charge_type: ChargeType.Raw;
+        company_count: number;
+        compatible_plan_ids: string[];
+        controlled_by: PlanControlledByType.Raw;
+        created_at: string;
+        custom: boolean;
+        custom_plan_config?: CustomPlanConfig.Raw | null;
+        description: string;
+        draft_version?: PlanVersionResponseData.Raw | null;
+        entitlements: PlanEntitlementResponseData.Raw[];
+        features: FeatureDetailResponseData.Raw[];
+        icon: string;
+        id: string;
+        included_credit_grants: PlanCreditGrantView.Raw[];
+        is_custom: boolean;
+        is_default: boolean;
+        is_free: boolean;
+        is_trialable: boolean;
+        monthly_price?: BillingPriceResponseData.Raw | null;
+        name: string;
+        one_time_price?: BillingPriceResponseData.Raw | null;
+        plan_type: PlanType.Raw;
+        trial_days?: number | null;
+        updated_at: string;
+        versions: PlanVersionResponseData.Raw[];
+        yearly_price?: BillingPriceResponseData.Raw | null;
+    }
+}

package/dist/serialization/types/PreviewSubscriptionChangeResponseData.d.ts

@@ -9,12 +9,14 @@ export declare namespace PreviewSubscriptionChangeResponseData {
         amount_off: number;
         due_now: number;
         finance?: PreviewSubscriptionFinanceResponseData.Raw | null;
+        is_scheduled_downgrade: boolean;
         new_charges: number;
         payment_method_required: boolean;
         percent_off: number;
         period_start: string;
         promo_code_applied: boolean;
         proration: number;
+        scheduled_change_time?: string | null;
         trial_end?: string | null;
         usage_violations: FeatureUsageResponseData.Raw[];
     }

package/dist/serialization/types/PublicPlansResponseData.d.ts

@@ -0,0 +1,21 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { CompatiblePlans } from "./CompatiblePlans";
+import { ComponentCapabilities } from "./ComponentCapabilities";
+import { ComponentDisplaySettings } from "./ComponentDisplaySettings";
+import { PlanViewPublicResponseData } from "./PlanViewPublicResponseData";
+export declare const PublicPlansResponseData: core.serialization.ObjectSchema<serializers.PublicPlansResponseData.Raw, Schematic.PublicPlansResponseData>;
+export declare namespace PublicPlansResponseData {
+    interface Raw {
+        active_add_ons: PlanViewPublicResponseData.Raw[];
+        active_plans: PlanViewPublicResponseData.Raw[];
+        add_on_compatibilities: CompatiblePlans.Raw[];
+        capabilities?: ComponentCapabilities.Raw | null;
+        display_settings: ComponentDisplaySettings.Raw;
+        show_as_monthly_prices: boolean;
+        show_credits: boolean;
+        show_period_toggle: boolean;
+        show_zero_price_as_free: boolean;
+    }
+}

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

@@ -0,0 +1,23 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { ConditionGroupView } from "./ConditionGroupView";
+import { ConditionView } from "./ConditionView";
+export declare const RuleView: core.serialization.ObjectSchema<serializers.RuleView.Raw, Schematic.RuleView>;
+export declare namespace RuleView {
+    interface Raw {
+        account_id: string;
+        condition_groups: ConditionGroupView.Raw[];
+        conditions: ConditionView.Raw[];
+        created_at: string;
+        environment_id: string;
+        flag_id?: string | null;
+        id: string;
+        name: string;
+        plan_version_id?: string | null;
+        priority: number;
+        rule_type: string;
+        updated_at: string;
+        value: boolean;
+    }
+}

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

@@ -3,5 +3,5 @@ import * as core from "../../core";
 import type * as serializers from "../index";
 export declare const RulesEngineSchemaVersion: core.serialization.Schema<serializers.RulesEngineSchemaVersion.Raw, Schematic.RulesEngineSchemaVersion>;
 export declare namespace RulesEngineSchemaVersion {
-    type Raw = "549e6fea" | "placeholder-for-fern-compatibility";
+    type Raw = "v0f048dd3" | "placeholder-for-fern-compatibility";
 }

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

@@ -3,10 +3,12 @@ import * as core from "../../core";
 import type * as serializers from "../index";
 import { RulesengineCheckFlagResultFeatureUsagePeriod } from "./RulesengineCheckFlagResultFeatureUsagePeriod";
 import { RulesengineCheckFlagResultRuleType } from "./RulesengineCheckFlagResultRuleType";
+import { RulesengineFeatureEntitlement } from "./RulesengineFeatureEntitlement";
 export declare const RulesengineCheckFlagResult: core.serialization.ObjectSchema<serializers.RulesengineCheckFlagResult.Raw, Schematic.RulesengineCheckFlagResult>;
 export declare namespace RulesengineCheckFlagResult {
     interface Raw {
         company_id?: string | null;
+        entitlement?: RulesengineFeatureEntitlement.Raw | null;
         err?: string | null;
         feature_allocation?: number | null;
         feature_usage?: number | null;

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

@@ -2,6 +2,7 @@ import type * as Schematic from "../../api/index";
 import * as core from "../../core";
 import type * as serializers from "../index";
 import { RulesengineCompanyMetric } from "./RulesengineCompanyMetric";
+import { RulesengineFeatureEntitlement } from "./RulesengineFeatureEntitlement";
 import { RulesengineRule } from "./RulesengineRule";
 import { RulesengineSubscription } from "./RulesengineSubscription";
 import { RulesengineTrait } from "./RulesengineTrait";
@@ -12,12 +13,13 @@ export declare namespace RulesengineCompany {
         base_plan_id?: string | null;
         billing_product_ids: string[];
         credit_balances: Record<string, number>;
-        crm_product_ids: string[];
+        entitlements?: RulesengineFeatureEntitlement.Raw[] | null;
         environment_id: string;
         id: string;
         keys: Record<string, string>;
         metrics: RulesengineCompanyMetric.Raw[];
         plan_ids: string[];
+        plan_version_ids: string[];
         rules: RulesengineRule.Raw[];
         subscription?: RulesengineSubscription.Raw | null;
         traits: RulesengineTrait.Raw[];

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

@@ -3,5 +3,5 @@ import * as core from "../../core";
 import type * as serializers from "../index";
 export declare const RulesengineConditionConditionType: core.serialization.Schema<serializers.RulesengineConditionConditionType.Raw, Schematic.RulesengineConditionConditionType>;
 export declare namespace RulesengineConditionConditionType {
-    type Raw = "base_plan" | "billing_product" | "company" | "credit" | "crm_product" | "metric" | "plan" | "trait" | "user";
+    type Raw = "base_plan" | "billing_product" | "company" | "credit" | "metric" | "plan" | "plan_version" | "trait" | "user";
 }

package/dist/serialization/types/RulesengineEntitlementValueType.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const RulesengineEntitlementValueType: core.serialization.Schema<serializers.RulesengineEntitlementValueType.Raw, Schematic.RulesengineEntitlementValueType>;
+export declare namespace RulesengineEntitlementValueType {
+    type Raw = "boolean" | "credit" | "numeric" | "trait" | "unknown" | "unlimited";
+}

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

@@ -0,0 +1,25 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { RulesengineEntitlementValueType } from "./RulesengineEntitlementValueType";
+import { RulesengineFeatureEntitlementMetricPeriod } from "./RulesengineFeatureEntitlementMetricPeriod";
+import { RulesengineFeatureEntitlementMonthReset } from "./RulesengineFeatureEntitlementMonthReset";
+export declare const RulesengineFeatureEntitlement: core.serialization.ObjectSchema<serializers.RulesengineFeatureEntitlement.Raw, Schematic.RulesengineFeatureEntitlement>;
+export declare namespace RulesengineFeatureEntitlement {
+    interface Raw {
+        allocation?: number | null;
+        credit_id?: string | null;
+        credit_remaining?: number | null;
+        credit_total?: number | null;
+        credit_used?: number | null;
+        event_name?: string | null;
+        feature_id: string;
+        feature_key: string;
+        metric_period?: RulesengineFeatureEntitlementMetricPeriod.Raw | null;
+        metric_reset_at?: string | null;
+        month_reset?: RulesengineFeatureEntitlementMonthReset.Raw | null;
+        soft_limit?: number | null;
+        usage?: number | null;
+        value_type: RulesengineEntitlementValueType.Raw;
+    }
+}

package/dist/serialization/types/RulesengineFeatureEntitlementMetricPeriod.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const RulesengineFeatureEntitlementMetricPeriod: core.serialization.Schema<serializers.RulesengineFeatureEntitlementMetricPeriod.Raw, Schematic.RulesengineFeatureEntitlementMetricPeriod>;
+export declare namespace RulesengineFeatureEntitlementMetricPeriod {
+    type Raw = "all_time" | "current_day" | "current_month" | "current_week";
+}

package/dist/serialization/types/RulesengineFeatureEntitlementMonthReset.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const RulesengineFeatureEntitlementMonthReset: core.serialization.Schema<serializers.RulesengineFeatureEntitlementMonthReset.Raw, Schematic.RulesengineFeatureEntitlementMonthReset>;
+export declare namespace RulesengineFeatureEntitlementMonthReset {
+    type Raw = "first_of_month" | "billing_cycle";
+}

package/dist/serialization/types/ScheduledCheckoutResponseData.d.ts

@@ -0,0 +1,23 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { ScheduledCheckoutStatus } from "./ScheduledCheckoutStatus";
+export declare const ScheduledCheckoutResponseData: core.serialization.ObjectSchema<serializers.ScheduledCheckoutResponseData.Raw, Schematic.ScheduledCheckoutResponseData>;
+export declare namespace ScheduledCheckoutResponseData {
+    interface Raw {
+        actor_type: string;
+        company_id: string;
+        completed_at?: string | null;
+        created_at: string;
+        error_message?: string | null;
+        execute_after: string;
+        from_plan_id: string;
+        id: string;
+        scheduled_interval?: string | null;
+        scheduled_price?: number | null;
+        started_at?: string | null;
+        status: ScheduledCheckoutStatus.Raw;
+        to_plan_id: string;
+        updated_at: string;
+    }
+}

package/dist/serialization/types/ScheduledCheckoutStatus.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const ScheduledCheckoutStatus: core.serialization.Schema<serializers.ScheduledCheckoutStatus.Raw, Schematic.ScheduledCheckoutStatus>;
+export declare namespace ScheduledCheckoutStatus {
+    type Raw = "cancelled" | "error" | "executing" | "pending" | "success";
+}

package/dist/serialization/types/ScheduledDowngradeConfigBehavior.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const ScheduledDowngradeConfigBehavior: core.serialization.Schema<serializers.ScheduledDowngradeConfigBehavior.Raw, Schematic.ScheduledDowngradeConfigBehavior>;
+export declare namespace ScheduledDowngradeConfigBehavior {
+    type Raw = "end_of_billing_period" | "none";
+}

package/dist/serialization/types/ScheduledDowngradeResponseData.d.ts

@@ -0,0 +1,19 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const ScheduledDowngradeResponseData: core.serialization.ObjectSchema<serializers.ScheduledDowngradeResponseData.Raw, Schematic.ScheduledDowngradeResponseData>;
+export declare namespace ScheduledDowngradeResponseData {
+    interface Raw {
+        currency: string;
+        effective_after: string;
+        from_plan_id: string;
+        from_plan_name: string;
+        from_subscription_price: number;
+        id: string;
+        interval: string;
+        scheduled_interval?: string | null;
+        scheduled_price?: number | null;
+        to_plan_id: string;
+        to_plan_name: string;
+    }
+}

package/dist/serialization/types/TimeSeriesGranularity.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const TimeSeriesGranularity: core.serialization.Schema<serializers.TimeSeriesGranularity.Raw, Schematic.TimeSeriesGranularity>;
+export declare namespace TimeSeriesGranularity {
+    type Raw = "daily" | "hourly" | "monthly" | "weekly";
+}

package/dist/serialization/types/UpsertCompanyRequestBody.d.ts

@@ -8,6 +8,7 @@ export declare namespace UpsertCompanyRequestBody {
         keys: Record<string, string>;
         last_seen_at?: string | null;
         name?: string | null;
+        prevent_key_remap?: boolean | null;
         traits?: Record<string, unknown> | null;
         update_only?: boolean | null;
     }

package/dist/serialization/types/UsageTimeSeriesPointResponseData.d.ts

@@ -0,0 +1,12 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+export declare const UsageTimeSeriesPointResponseData: core.serialization.ObjectSchema<serializers.UsageTimeSeriesPointResponseData.Raw, Schematic.UsageTimeSeriesPointResponseData>;
+export declare namespace UsageTimeSeriesPointResponseData {
+    interface Raw {
+        period_end?: string | null;
+        period_start?: string | null;
+        timestamp: string;
+        usage: number;
+    }
+}

package/dist/serialization/types/WebFeatureUsageWebhookOutput.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { CompanyDetailResponseData } from "./CompanyDetailResponseData";
+import { CreditUsage } from "./CreditUsage";
+import { FeatureView } from "./FeatureView";
+export declare const WebFeatureUsageWebhookOutput: core.serialization.ObjectSchema<serializers.WebFeatureUsageWebhookOutput.Raw, Schematic.WebFeatureUsageWebhookOutput>;
+export declare namespace WebFeatureUsageWebhookOutput {
+    interface Raw {
+        Allocation?: number | null;
+        CreditUsage?: CreditUsage.Raw | null;
+        Entitlement: string;
+        Feature?: FeatureView.Raw | null;
+        MetricResetAt?: string | null;
+        Usage?: number | null;
+        company?: CompanyDetailResponseData.Raw | null;
+    }
+}

package/dist/serialization/types/WebhookRequestType.d.ts

@@ -3,5 +3,5 @@ import * as core from "../../core";
 import type * as serializers from "../index";
 export declare const WebhookRequestType: core.serialization.Schema<serializers.WebhookRequestType.Raw, Schematic.WebhookRequestType>;
 export declare namespace WebhookRequestType {
-    type Raw = "subscription.trial.ended" | "company.created" | "company.deleted" | "company.override.created" | "company.override.deleted" | "company.override.expired" | "company.override.updated" | "company.plan_changed" | "company.updated" | "credit.limit.reached" | "credit.limit.warning" | "entitlement.limit.reached" | "entitlement.limit.warning" | "entitlement.soft_limit.reached" | "entitlement.soft_limit.warning" | "entitlement.tier_limit.reached" | "entitlement.tier_limit.warning" | "feature.created" | "feature.deleted" | "feature.updated" | "flag.created" | "flag.deleted" | "flag_rules.updated" | "flag.updated" | "plan.created" | "plan.deleted" | "plan.entitlement.created" | "plan.entitlement.deleted" | "plan.entitlement.updated" | "plan.updated" | "rule.deleted" | "test.send" | "user.created" | "user.deleted" | "user.updated" | "auto.topup.hard.failure" | "auto.topup.retry.exceeded";
+    type Raw = "subscription.trial.ended" | "company.created" | "company.deleted" | "company.override.created" | "company.override.deleted" | "company.override.expired" | "company.override.updated" | "company.plan_changed" | "company.updated" | "credit.limit.reached" | "credit.limit.warning" | "entitlement.limit.reached" | "entitlement.limit.warning" | "entitlement.soft_limit.reached" | "entitlement.soft_limit.warning" | "entitlement.tier_limit.reached" | "entitlement.tier_limit.warning" | "feature.created" | "feature.deleted" | "feature.updated" | "flag.created" | "flag.deleted" | "flag_rules.updated" | "flag.updated" | "plan.created" | "plan.deleted" | "plan.entitlement.created" | "plan.entitlement.deleted" | "plan.entitlement.updated" | "plan.updated" | "plan_version.deleted" | "rule.deleted" | "test.send" | "user.created" | "user.deleted" | "user.updated" | "auto.topup.hard.failure" | "auto.topup.retry.exceeded";
 }

package/dist/serialization/types/WhoAmIResponseData.d.ts

@@ -0,0 +1,18 @@
+import type * as Schematic from "../../api/index";
+import * as core from "../../core";
+import type * as serializers from "../index";
+import { EnvironmentResponseData } from "./EnvironmentResponseData";
+export declare const WhoAmIResponseData: core.serialization.ObjectSchema<serializers.WhoAmIResponseData.Raw, Schematic.WhoAmIResponseData>;
+export declare namespace WhoAmIResponseData {
+    interface Raw {
+        account_id: string;
+        account_name: string;
+        actor_type: string;
+        api_key_id?: string | null;
+        environment_id?: string | null;
+        environments: EnvironmentResponseData.Raw[];
+        stripe_user_id?: string | null;
+        user_id?: string | null;
+        user_name?: string | null;
+    }
+}

package/dist/serialization/types/index.d.ts

@@ -1,9 +1,10 @@
+export * from "./ActorType";
 export * from "./ApiError";
 export * from "./ApiKeyCreateResponseData";
-export * from "./ApiKeyRequestListResponseData";
-export * from "./ApiKeyRequestResponseData";
 export * from "./ApiKeyResponseData";
 export * from "./ApiKeyScope";
+export * from "./AuditLogListResponseData";
+export * from "./AuditLogResponseData";
 export * from "./BillingCouponResponseData";
 export * from "./BillingCreditBundleResponseData";
 export * from "./BillingCreditBundleStatus";
@@ -18,6 +19,7 @@ export * from "./BillingCreditGrantZeroedOutReason";
 export * from "./BillingCreditLedgerResponseData";
 export * from "./BillingCreditResponseData";
 export * from "./BillingCreditRolloverPolicy";
+export * from "./BillingCreditView";
 export * from "./BillingCustomerResponseData";
 export * from "./BillingCustomerSubscription";
 export * from "./BillingCustomerWithSubscriptionsResponseData";
@@ -67,7 +69,6 @@ export * from "./CompanyPlanInvalidReason";
 export * from "./CompanyPlanWithBillingSubView";
 export * from "./CompanyResponseData";
 export * from "./CompanySubscriptionResponseData";
-export * from "./CompanyViewWithFeatureUsageResponseData";
 export * from "./CompatiblePlans";
 export * from "./CompatiblePlansResponseData";
 export * from "./ComponentCapabilities";
@@ -82,9 +83,13 @@ export * from "./ComponentState";
 export * from "./Condition";
 export * from "./ConditionConditionType";
 export * from "./ConditionGroup";
+export * from "./ConditionGroupResponseData";
+export * from "./ConditionGroupView";
 export * from "./ConditionMetricPeriod";
 export * from "./ConditionMetricPeriodMonthReset";
 export * from "./ConditionOperator";
+export * from "./ConditionResponseData";
+export * from "./ConditionView";
 export * from "./CountResponse";
 export * from "./CouponRequestBody";
 export * from "./CreateBillingPlanCreditGrantRequestBody";
@@ -111,17 +116,22 @@ export * from "./CreatePriceTierRequestBody";
 export * from "./CreditAutoTopupAmountType";
 export * from "./CreditBundlePurchaseResponseData";
 export * from "./CreditCompanyGrantView";
+export * from "./CreditEventLedgerResponseData";
+export * from "./CreditEventType";
 export * from "./CreditGrantDetail";
 export * from "./CreditGrantExpiryRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLedgerEnrichedEntryResponseData";
 export * from "./CreditLedgerPeriod";
+export * from "./CreditsAutoTopupCompanySummary";
+export * from "./CreditsAutoTopupCreditSummary";
+export * from "./CreditsAutoTopupHardFailure";
+export * from "./CreditsAutoTopupRetryFailure";
 export * from "./CreditTransferResponseData";
 export * from "./CreditTransferView";
 export * from "./CreditTriggerConfig";
 export * from "./CreditUsage";
 export * from "./CreditUsageAggregation";
-export * from "./CreditUsageResponseData";
 export * from "./CustomPlanConfig";
 export * from "./CustomPlanViewConfigResponseData";
 export * from "./DataExportOutputFileType";
@@ -160,21 +170,29 @@ export * from "./EventType";
 export * from "./FeatureCompanyResponseData";
 export * from "./FeatureCompanyUserResponseData";
 export * from "./FeatureDetailResponseData";
+export * from "./FeatureEntitlement";
+export * from "./FeatureEntitlementMetricPeriod";
+export * from "./FeatureEntitlementMonthReset";
 export * from "./FeatureLedgerResponseData";
 export * from "./FeatureLifecyclePhase";
 export * from "./FeatureResponseData";
 export * from "./FeatureType";
-export * from "./FeatureUsageDataResponseData";
 export * from "./FeatureUsageDetailResponseData";
+export * from "./FeatureUsageLegacyResponseData";
 export * from "./FeatureUsageResponseData";
+export * from "./FeatureUsageTimeSeriesResponseData";
+export * from "./FeatureView";
 export * from "./FlagDetailResponseData";
 export * from "./FlagResponseData";
 export * from "./FlagType";
+export * from "./FlagView";
 export * from "./GenericPreviewObject";
 export * from "./InvoiceRequestBody";
 export * from "./InvoiceResponseData";
+export * from "./InvoiceStatus";
 export * from "./IssueTemporaryAccessTokenResponseData";
 export * from "./KeysRequestBody";
+export * from "./LimitTimeSeriesPointResponseData";
 export * from "./ManagePlanPreviewResponseResponseData";
 export * from "./ManagePlanRequest";
 export * from "./ManagePlanResponseResponseData";
@@ -187,7 +205,6 @@ export * from "./PlanBundleCreditGrantRequestBody";
 export * from "./PlanBundleEntitlementRequestBody";
 export * from "./PlanBundleResponseData";
 export * from "./PlanChangeAction";
-export * from "./PlanChangeActorType";
 export * from "./PlanChangeBasePlanAction";
 export * from "./PlanChangeResponseData";
 export * from "./PlanChangeSubscriptionAction";
@@ -207,14 +224,21 @@ export * from "./PlanSelection";
 export * from "./PlanSnapshotView";
 export * from "./PlanTraitResponseData";
 export * from "./PlanType";
+export * from "./PlanVersionCompanyMigrationResponseData";
+export * from "./PlanVersionCompanyMigrationStatus";
+export * from "./PlanVersionMigrationResponseData";
+export * from "./PlanVersionMigrationStatus";
+export * from "./PlanVersionMigrationStrategy";
 export * from "./PlanVersionResponseData";
 export * from "./PlanVersionStatus";
+export * from "./PlanViewPublicResponseData";
 export * from "./PreviewObject";
 export * from "./PreviewObjectResponseData";
 export * from "./PreviewSubscriptionChangeResponseData";
 export * from "./PreviewSubscriptionFinanceResponseData";
 export * from "./PreviewSubscriptionUpcomingInvoiceLineItems";
 export * from "./ProrationBehavior";
+export * from "./PublicPlansResponseData";
 export * from "./QuickstartResp";
 export * from "./RawEventBatchResponseData";
 export * from "./RawEventResponseData";
@@ -241,7 +265,11 @@ export * from "./RulesengineConditionGroup";
 export * from "./RulesengineConditionMetricPeriod";
 export * from "./RulesengineConditionMetricPeriodMonthReset";
 export * from "./RulesengineConditionOperator";
+export * from "./RulesengineEntitlementValueType";
 export * from "./RulesengineEntityType";
+export * from "./RulesengineFeatureEntitlement";
+export * from "./RulesengineFeatureEntitlementMetricPeriod";
+export * from "./RulesengineFeatureEntitlementMonthReset";
 export * from "./RulesengineFlag";
 export * from "./RulesengineRule";
 export * from "./RulesengineRuleRuleType";
@@ -250,6 +278,11 @@ export * from "./RulesengineTrait";
 export * from "./RulesengineTraitDefinition";
 export * from "./RulesengineTraitDefinitionComparableType";
 export * from "./RulesengineUser";
+export * from "./RuleView";
+export * from "./ScheduledCheckoutResponseData";
+export * from "./ScheduledCheckoutStatus";
+export * from "./ScheduledDowngradeConfigBehavior";
+export * from "./ScheduledDowngradeResponseData";
 export * from "./SegmentStatusResp";
 export * from "./SkippedEntitlementErrorResponseData";
 export * from "./SkippedEntitlementResponseData";
@@ -260,6 +293,7 @@ export * from "./SubscriptionTraitUpdate";
 export * from "./SubscriptionType";
 export * from "./TemporaryAccessTokenResourceType";
 export * from "./TemporaryAccessTokenResponseData";
+export * from "./TimeSeriesGranularity";
 export * from "./TraitDefinition";
 export * from "./TraitDefinitionComparableType";
 export * from "./TraitType";
@@ -280,11 +314,14 @@ export * from "./UpsertUserRequestBody";
 export * from "./UpsertUserSubRequestBody";
 export * from "./UsageBasedEntitlementRequestBody";
 export * from "./UsageBasedEntitlementResponseData";
+export * from "./UsageTimeSeriesPointResponseData";
 export * from "./UserDetailResponseData";
 export * from "./UserResponseData";
+export * from "./WebFeatureUsageWebhookOutput";
 export * from "./WebhookEventDetailResponseData";
 export * from "./WebhookEventResponseData";
 export * from "./WebhookEventStatus";
 export * from "./WebhookRequestType";
 export * from "./WebhookResponseData";
 export * from "./WebhookStatus";
+export * from "./WhoAmIResponseData";

package/dist/wrapper.d.ts

@@ -1,7 +1,8 @@
 import * as api from "./api";
 import { SchematicClient as BaseClient } from "./Client";
-import { CacheProvider } from "./cache";
+import { type CacheProvider } from "./cache";
 import { Logger } from "./logger";
+import type { RedisClient } from "./cache/redis";
 /**
  * Configuration options for the SchematicClient
  */
@@ -13,7 +14,24 @@ export interface SchematicOptions {
     /** Cache provider configuration */
     cacheProviders?: {
         /** Providers for caching flag check results */
-        flagChecks?: CacheProvider<boolean>[];
+        flagChecks?: CacheProvider<CheckFlagWithEntitlementResponse>[];
+    };
+    /** Enable DataStream for real-time updates */
+    useDataStream?: boolean;
+    /** DataStream configuration options */
+    dataStream?: {
+        /** Cache TTL in milliseconds (default: 5 minutes) */
+        cacheTTL?: number;
+        /** Pre-created, connected redis client for DataStream caching */
+        redisClient?: RedisClient;
+        /** Redis key prefix for all cache keys (default: 'schematic:') */
+        redisKeyPrefix?: string;
+        /** Enable replicator mode for external data synchronization */
+        replicatorMode?: boolean;
+        /** Health check URL for replicator mode */
+        replicatorHealthURL?: string;
+        /** Health check interval for replicator mode in milliseconds */
+        replicatorHealthCheck?: number;
     };
     /** If using an API key that is not environment-specific, use this option to specify the environment */
     environmentId?: string;
@@ -38,7 +56,20 @@ export interface CheckFlagOptions {
     /** The maximum time to wait for a response in milliseconds */
     timeoutMs?: number;
 }
+export interface CheckFlagWithEntitlementResponse {
+    companyId?: string;
+    entitlement?: api.RulesengineFeatureEntitlement;
+    err?: string;
+    flagKey: string;
+    flagId?: string;
+    reason: string;
+    ruleId?: string;
+    ruleType?: api.RulesengineCheckFlagResultRuleType;
+    userId?: string;
+    value: boolean;
+}
 export declare class SchematicClient extends BaseClient {
+    private datastreamClient?;
     private eventBuffer;
     private flagCheckCacheProviders;
     private flagDefaults;
@@ -49,6 +80,10 @@ export declare class SchematicClient extends BaseClient {
      * @param opts - Configuration options for the client
      */
     constructor(opts?: SchematicOptions);
+    /**
+     * Returns whether DataStream is enabled and available
+     */
+    private useDataStream;
     /**
      * Checks the value of a feature flag for the given evaluation context
      * @param evalCtx - The context (company and/or user) for evaluating the feature flag
@@ -58,6 +93,15 @@ export declare class SchematicClient extends BaseClient {
      * @throws Will log error and return flag default if check fails
      */
     checkFlag(evalCtx: api.CheckFlagRequestBody, key: string, options?: CheckFlagOptions): Promise<boolean>;
+    /**
+     * Checks the value of a feature flag and returns entitlement details for the given evaluation context
+     * @param evalCtx - The context (company and/or user) for evaluating the feature flag
+     * @param key - The unique identifier of the feature flag
+     * @param options - Optional configuration for the flag check
+     * @returns Promise resolving to the flag check response including entitlement details
+     */
+    checkFlagWithEntitlement(evalCtx: api.CheckFlagRequestBody, key: string, options?: CheckFlagOptions): Promise<CheckFlagWithEntitlementResponse>;
+    private checkFlagViaAPI;
     /**
      * Checks multiple feature flags with caching optimization
      * @param evalCtx - The context (company and/or user) for evaluating the feature flags
@@ -67,8 +111,8 @@ export declare class SchematicClient extends BaseClient {
      */
     checkFlags(evalCtx: api.CheckFlagRequestBody, keys?: string[]): Promise<api.CheckFlagResponseData[]>;
     /**
-     * Gracefully shuts down the client by stopping the event buffer
-     * @returns Promise that resolves when the event buffer has been stopped
+     * Gracefully shuts down the client by stopping the event buffer and DataStream client
+     * @returns Promise that resolves when everything has been stopped
      */
     close(): Promise<void>;
     /**