@schematichq/schematic-typescript-node 1.6.3 → 1.6.4

package/dist/api/resources/plans/client/requests/PublishPlanVersionRequestBody.d.ts

@@ -11,6 +11,8 @@ export interface PublishPlanVersionRequestBody {
     address?: Schematic.CustomerBillingAddress;
     /** The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription. */
     billingCycleAnchor?: Date;
+    /** The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. Only honored on a first publish that starts a subscription. */
+    billingStartDate?: Date;
     couponExternalId?: string;
     customFieldValues?: Schematic.CheckoutFieldValue[];
     customerEmail?: string;
@@ -20,9 +22,12 @@ export interface PublishPlanVersionRequestBody {
     phone?: string;
     /** When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true. */
     prorateFirstPeriod?: boolean;
+    /** How Stripe handles the price difference when companies are migrated. With migration_strategy immediate, omitted means create_prorations. With end_of_billing_period only none is accepted and means the same as omitting it: the change lands on the renewal boundary, so there is nothing to prorate. With scheduled any value is accepted and omitted means none. Not accepted with leave. */
     prorationBehavior?: Schematic.MigrationProrationBehavior;
     /** Refuse the publish if any company would be migrated onto the new version */
     requireNoMigration?: boolean;
+    /** When every company moves, for migration_strategy scheduled. Must be in the future; the migration runs within about a minute of this time. Not accepted with other strategies. */
+    scheduledAt?: Date;
     /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
     sendInvoice?: boolean;
     taxId?: Schematic.TaxIdInput;

package/dist/api/resources/plans/client/requests/RetryCustomPlanBillingRequestBody.d.ts

@@ -9,6 +9,8 @@ export interface RetryCustomPlanBillingRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     /** The date the subscription's billing period renews on. Only honored when the retry creates a subscription. */
     billingCycleAnchor?: Date;
+    /** The date the contract term starts. A past date backdates the subscription so the first invoice covers the term from this date to the renewal date. Requires billing_cycle_anchor. When both are omitted, the term pinned at finalize is reissued. Only honored when the retry creates a subscription. */
+    billingStartDate?: Date;
     customerEmail: string;
     daysUntilDue?: number;
     /** When true, the partial period between the subscription starting and its renewal date is billed pro rata straight away. When false that period is free and no invoice is raised until the renewal date. Only applies alongside billing_cycle_anchor. Defaults to true. */

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

@@ -1,5 +1,7 @@
 export interface CaptureRawEvent {
     capturedAt: Date;
+    contextSignature?: string;
+    contextSignatureChecked?: boolean;
     eventId?: string;
     rawBytes: string;
     remoteIp: string;

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface CheckFlagsResponseData {
     /** Lease-aware credit balances keyed by credit ID, covering every credit type the company holds a balance in */
     creditBalances?: Record<string, Schematic.CompanyCreditBalance>;
+    /** Credit spend policies binding the evaluated company and user; empty when none bind. Each response carries the whole set, so replace any previously received set with it. Advisory: the flag values do not reflect them, since a check names no draw amount */
+    creditSpendPolicies: Schematic.CreditSpendPolicy[];
     flags: Schematic.CheckFlagResponseData[];
     plan?: Schematic.DatastreamCompanyPlan;
 }

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

@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
 export interface CompanyDetailResponseData {
     addOns: Schematic.CompanyPlanWithBillingSubView[];
     billingCreditBalances?: Record<string, number>;
+    billingEmail?: string;
     billingProfile?: Schematic.CompanyBillingProfileResponseData;
     billingProfiles?: Schematic.CompanyBillingProfileResponseData[];
     billingSubscription?: Schematic.BillingSubscriptionView;

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

@@ -25,6 +25,7 @@ export interface CompanyPlanDetailResponseData {
     description: string;
     draftVersion?: Schematic.PlanVersionResponseData;
     entitlements?: Schematic.PlanEntitlementResponseData[];
+    estimatedTotals?: Schematic.EstimatedPlanTotal[];
     features: Schematic.FeatureInPlanResponseData[];
     icon: Schematic.PlanIcon;
     id: string;

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

@@ -0,0 +1,11 @@
+import type * as Schematic from "../index";
+export interface CompanyUserUsageMetricsResponseData {
+    /** End of the usage window (exclusive) */
+    endTime: Date;
+    /** Event-based features the company has user-attributed usage for in the window; a feature with usage but no entitlement is still listed */
+    features: Schematic.FeatureResponseData[];
+    /** Whether the company consumed any credits in the window */
+    hasCredits: boolean;
+    /** Start of the usage window */
+    startTime: Date;
+}

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

@@ -0,0 +1,15 @@
+import type * as Schematic from "../index";
+export interface CompanyUserUsageResponseData {
+    /** End of the usage window (exclusive) */
+    endTime: Date;
+    /** This page of per-user consumption within the window, heaviest first */
+    rows: Schematic.CompanyUserUsageRowResponseData[];
+    /** Start of the usage window */
+    startTime: Date;
+    /** The heaviest user's fraction (0-1) of consumption, measured across every user in the window and not just this page */
+    topUserShare: number;
+    /** Consumption across every user in the window including unattributed, not just this page */
+    total: number;
+    /** Consumption from events sent without a user; not a user, so it is excluded from rows and from the count, and returned on every page. Null when the window has none */
+    unattributed?: Schematic.CompanyUserUsageRowResponseData;
+}

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

@@ -0,0 +1,13 @@
+import type * as Schematic from "../index";
+export interface CompanyUserUsageRowResponseData {
+    /** When the user last used the feature within the window; null for the credits metric, which aggregates balances rather than timestamped events */
+    lastSeen?: Date;
+    /** This row's fraction (0-1) of consumption within the window, including unattributed consumption */
+    share: number;
+    /** The user the consumption is attributed to; null for consumption from events sent without a user */
+    user?: Schematic.UserResponseData;
+    /** The user the consumption is attributed to; null for unattributed consumption */
+    userId?: string;
+    /** The user's consumption of the metric within the window */
+    value: number;
+}

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

@@ -1,6 +1,7 @@
 export interface ComponentDisplaySettings {
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

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

@@ -1,6 +1,7 @@
 export interface ComponentSettingsResponseData {
     showAsMonthlyPrices: boolean;
     showCredits: boolean;
+    showEstimatedTotal: boolean;
     showFeatureDescription: boolean;
     showHardLimit: boolean;
     showPeriodToggle: boolean;

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

@@ -3,11 +3,12 @@ export interface CreditEventLedgerResponseData {
     amount: number;
     autoTopupLogId?: string;
     billingCreditBundleId?: string;
-    billingCreditId: string;
+    billingCreditId?: string;
     company?: Schematic.CompanyLedgerResponseData;
     companyId: string;
     credit?: Schematic.BillingCreditLedgerResponseData;
     creditName: string;
+    currency?: string;
     environmentId: string;
     eventAt: Date;
     eventId: string;
@@ -24,6 +25,7 @@ export interface CreditEventLedgerResponseData {
     grantQuantityRemaining?: number;
     grantReason?: Schematic.BillingCreditGrantReason;
     grantValidFrom?: Date;
+    kind: Schematic.CreditLedgerEntryKind;
     planId?: string;
     quantityConsumed?: number;
     quantityRemainingAtZeroOut?: number;

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

@@ -1,5 +1,8 @@
 export declare const CreditEventType: {
+    readonly Adjustment: "adjustment";
+    readonly Charge: "charge";
     readonly Grant: "grant";
+    readonly Settlement: "settlement";
     readonly Transfer: "transfer";
     readonly Usage: "usage";
     readonly ZeroOut: "zero_out";

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

@@ -0,0 +1,10 @@
+export declare const CreditLedgerEntryKind: {
+    readonly Adjustment: "adjustment";
+    readonly Charge: "charge";
+    readonly Drawdown: "drawdown";
+    readonly Grant: "grant";
+    readonly Settlement: "settlement";
+    readonly Transfer: "transfer";
+    readonly ZeroOut: "zero_out";
+};
+export type CreditLedgerEntryKind = (typeof CreditLedgerEntryKind)[keyof typeof CreditLedgerEntryKind];

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

@@ -0,0 +1,21 @@
+import type * as Schematic from "../index";
+export interface CreditSpendPolicy {
+    /** How much of the limit is already spent in the current period */
+    consumed?: number;
+    /** The credit the policy limits */
+    creditId: string;
+    /** The ID of the policy */
+    id: string;
+    /** How the limit is applied */
+    kind: string;
+    /** The name the account gave the policy */
+    label?: string;
+    /** The ceiling, in credits */
+    limit: number;
+    /** For a windowed limit, when the current period ends and consumed no longer applies */
+    resetsAt?: Date;
+    /** Whether the policy limits the company or one user */
+    scope: Schematic.CreditSpendPolicyScope;
+    /** For a windowed limit, the period it accumulates over */
+    window?: Schematic.CreditSpendWindow;
+}

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

@@ -2,11 +2,20 @@ import type * as Schematic from "../index";
 export interface CreditSpendPolicyResponseData {
     billingCreditId: string;
     companyId?: string;
+    /** Credits spent in the current window. Set only by the usage route, and only for a window cap. */
+    consumed?: number;
     createdAt: Date;
+    /** Credits left in the current window. Set only by the usage route, and only for a window cap. */
+    headroom?: number;
     id: string;
     label?: string;
     maxPerDraw?: number;
+    /** When the current window ends. Set only by the usage route, and only for a window cap. */
+    resetsAt?: Date;
     scopeType: Schematic.CreditSpendPolicyScope;
     updatedAt: Date;
     userId?: string;
+    windowAmount?: number;
+    windowCount: number;
+    windowUnit?: Schematic.CreditSpendWindowUnit;
 }

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

@@ -0,0 +1,6 @@
+export interface CreditSpendWindow {
+    /** How many units make up one period */
+    count: number;
+    /** The period the limit accumulates over */
+    unit: string;
+}

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

@@ -0,0 +1,6 @@
+export declare const CreditSpendWindowUnit: {
+    readonly Hour: "hour";
+    readonly Day: "day";
+    readonly BillingPeriod: "billing_period";
+};
+export type CreditSpendWindowUnit = (typeof CreditSpendWindowUnit)[keyof typeof CreditSpendWindowUnit];

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

@@ -3,6 +3,8 @@ export interface CustomPlanBillingResponseData {
     activationStrategy: Schematic.CustomPlanActivationStrategy;
     /** The billing period renewal date pinned when the subscription started, when one was set. When no invoice exists yet, the first invoice is raised on this date. */
     billingCycleAnchor?: Date;
+    /** The date the contract term starts, when the operator pinned one. A past date was backdated onto the subscription so the first period runs from the contract date rather than from finalization. */
+    billingStartDate?: Date;
     companyId: string;
     createdAt: Date;
     daysUntilDue: number;

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

@@ -5,5 +5,6 @@ export interface EnvironmentDetailResponseData {
     environmentType: Schematic.EnvironmentType;
     id: string;
     name: string;
+    requireContextSignature: boolean;
     updatedAt: Date;
 }

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

@@ -4,5 +4,6 @@ export interface EnvironmentResponseData {
     environmentType: Schematic.EnvironmentType;
     id: string;
     name: string;
+    requireContextSignature: boolean;
     updatedAt: Date;
 }

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../index";
+export interface EstimatedPlanTotal {
+    amount: number;
+    currency: string;
+    period: Schematic.PlanPriceCadence;
+}

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

@@ -1,6 +1,14 @@
+import type * as Schematic from "../index";
 export interface PendingMigrationResponseData {
+    /** When the company moves to the new version: the migration's date for a scheduled migration, or the end of the company's current billing period. Null when no date can be named yet, for example when the company's only subscription is past due or set to cancel; the company then moves at the next opportunity. */
+    effectiveAt?: Date;
     migrationId: string;
+    /** How the price difference is billed when the company moves. Always none for an end-of-billing-period migration. */
+    prorationBehavior?: Schematic.MigrationProrationBehavior;
+    /** Deprecated; use effective_at, which carries the same value. */
     scheduledFor?: Date;
+    /** Whether the company moves at the end of its billing period (end_of_billing_period) or on a specific date (scheduled). The type is shared with plan version migrations, but only those two values appear here: an immediate migration never pends. */
+    strategy: Schematic.PlanVersionMigrationStrategy;
     toPlanId: string;
     toPlanName: string;
     toPlanVersionId: string;

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

@@ -14,6 +14,7 @@ export interface PlanVersionMigrationResponseData {
     planVersionIdTo: string;
     planVersionIdsFrom: string[];
     prorationBehavior?: Schematic.MigrationProrationBehavior;
+    scheduledAt?: Date;
     skippedCompanies: number;
     startedAt?: Date;
     status: Schematic.PlanVersionMigrationStatus;

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

@@ -2,5 +2,6 @@ export declare const PlanVersionMigrationStrategy: {
     readonly EndOfBillingPeriod: "end_of_billing_period";
     readonly Immediate: "immediate";
     readonly Leave: "leave";
+    readonly Scheduled: "scheduled";
 };
 export type PlanVersionMigrationStrategy = (typeof PlanVersionMigrationStrategy)[keyof typeof PlanVersionMigrationStrategy];

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 V94B8F7A7: "v94b8f7a7";
+    readonly Vf4A06160: "vf4a06160";
     readonly PlaceholderForFernCompatibility: "placeholder-for-fern-compatibility";
 };
 export type RulesEngineSchemaVersion = (typeof RulesEngineSchemaVersion)[keyof typeof RulesEngineSchemaVersion];

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

@@ -5,6 +5,7 @@ export interface RulesengineCompany {
     billingProductIds: string[];
     creditBalances: Record<string, number>;
     creditPostpaid?: Record<string, Schematic.RulesengineCreditPostpaidConfig>;
+    creditSpendPolicies?: Schematic.RulesengineCreditSpendPolicy[];
     entitlements?: Schematic.RulesengineFeatureEntitlement[];
     environmentId: string;
     id: string;

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

@@ -0,0 +1,21 @@
+import type * as Schematic from "../index";
+export interface RulesengineCreditSpendPolicy {
+    /** How much of the limit is already spent in the current period */
+    consumed?: number;
+    /** The credit the policy limits */
+    creditId: string;
+    /** The ID of the policy */
+    id: string;
+    /** How the limit is applied */
+    kind: string;
+    /** The name the account gave the policy */
+    label?: string;
+    /** The ceiling, in credits */
+    limit: number;
+    /** For a windowed limit, when the current period ends and consumed no longer applies */
+    resetsAt?: Date;
+    /** Whether the policy limits the company or one user */
+    scope: Schematic.RulesengineCreditSpendPolicyScope;
+    /** For a windowed limit, the period it accumulates over */
+    window?: Schematic.RulesengineCreditSpendWindow;
+}

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

@@ -0,0 +1,6 @@
+export declare const RulesengineCreditSpendPolicyScope: {
+    readonly Company: "company";
+    readonly User: "user";
+    readonly Group: "group";
+};
+export type RulesengineCreditSpendPolicyScope = (typeof RulesengineCreditSpendPolicyScope)[keyof typeof RulesengineCreditSpendPolicyScope];

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

@@ -0,0 +1,6 @@
+export interface RulesengineCreditSpendWindow {
+    /** How many units make up one period */
+    count: number;
+    /** The period the limit accumulates over */
+    unit: string;
+}

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface RulesengineUser {
     accountId: string;
+    creditSpendPolicies?: Schematic.RulesengineCreditSpendPolicy[];
     environmentId: string;
     id: string;
     keys: Record<string, string>;

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

@@ -0,0 +1,5 @@
+export declare const UserUsageMetric: {
+    readonly Credits: "credits";
+    readonly Feature: "feature";
+};
+export type UserUsageMetric = (typeof UserUsageMetric)[keyof typeof UserUsageMetric];

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

@@ -123,6 +123,9 @@ export * from "./CompanyPlanWithBillingSubView";
 export * from "./CompanyResponseData";
 export * from "./CompanySubscriptionResponseData";
 export * from "./CompanyTaxIdView";
+export * from "./CompanyUserUsageMetricsResponseData";
+export * from "./CompanyUserUsageResponseData";
+export * from "./CompanyUserUsageRowResponseData";
 export * from "./ComparableOperator";
 export * from "./CompatiblePlans";
 export * from "./CompatiblePlansResponseData";
@@ -173,9 +176,13 @@ export * from "./CreditGrantExpiryRequestBody";
 export * from "./CreditGrantPriceTierRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLeaseResponseData";
+export * from "./CreditLedgerEntryKind";
 export * from "./CreditReservationResponseData";
+export * from "./CreditSpendPolicy";
 export * from "./CreditSpendPolicyResponseData";
 export * from "./CreditSpendPolicyScope";
+export * from "./CreditSpendWindow";
+export * from "./CreditSpendWindowUnit";
 export * from "./CreditsAutoTopupCompanySummary";
 export * from "./CreditsAutoTopupCreditSummary";
 export * from "./CreditsAutoTopupHardFailure";
@@ -229,6 +236,7 @@ export * from "./EnvironmentResponseData";
 export * from "./EnvironmentTraitUsageTimeSeriesResponseData";
 export * from "./EnvironmentType";
 export * from "./EnvironmentUsagePointResponseData";
+export * from "./EstimatedPlanTotal";
 export * from "./EventBody";
 export * from "./EventBodyFlagCheck";
 export * from "./EventBodyIdentify";
@@ -385,6 +393,9 @@ export * from "./RulesengineCondition";
 export * from "./RulesengineConditionGroup";
 export * from "./RulesengineConditionType";
 export * from "./RulesengineCreditPostpaidConfig";
+export * from "./RulesengineCreditSpendPolicy";
+export * from "./RulesengineCreditSpendPolicyScope";
+export * from "./RulesengineCreditSpendWindow";
 export * from "./RulesengineEntitlementValueType";
 export * from "./RulesengineEntityType";
 export * from "./RulesengineFeatureEntitlement";
@@ -459,6 +470,7 @@ export * from "./UserFeatureUsageResponseData";
 export * from "./UserResponseData";
 export * from "./UserUsageByCompanyResponseData";
 export * from "./UserUsageDetailResponseData";
+export * from "./UserUsageMetric";
 export * from "./WarningTier";
 export * from "./WarningTierRequestBody";
 export * from "./WarningTierResponseData";

package/dist/datastream/datastream-client.d.ts

@@ -33,9 +33,9 @@ export interface DataStreamClientOptions {
     flagCache?: CacheProvider<Schematic.RulesengineFlag>;
     /** Enable replicator mode for external data synchronization */
     replicatorMode?: boolean;
-    /** Health check URL for replicator mode */
+    /** Health check URL for replicator mode (default: http://localhost:8090/ready) */
     replicatorHealthURL?: string;
-    /** Health check interval for replicator mode in milliseconds */
+    /** Health check interval for replicator mode in milliseconds (default: 30 seconds) */
     replicatorHealthCheck?: number;
 }
 /**