@schematichq/schematic-typescript-node 1.6.3 → 1.6.5

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

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

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

@@ -0,0 +1,19 @@
+import type * as Schematic from "../index";
+export interface PlanVersionDiffResponseData {
+    /** Set when the version's billing product changed; null when it is the same on both versions. */
+    billingProduct?: Schematic.PlanVersionBillingProductChangeResponseData;
+    /** Credit grants added, removed, or changed, keyed by credit. */
+    creditGrants: Schematic.PlanVersionCreditGrantChangeResponseData[];
+    /** Entitlements added, removed, or changed, keyed by feature. */
+    entitlements: Schematic.PlanVersionEntitlementChangeResponseData[];
+    /** The version compared against, or null when the plan has no published version. */
+    from?: Schematic.PlanVersionResponseData;
+    /** Whether moving a subscription from the compared version to this one changes its billing. */
+    hasBillingChanges: boolean;
+    /** Plan-level fields that changed: name, description, icon, and charge_type. */
+    planFields: Schematic.PlanVersionFieldChangeResponseData[];
+    /** Base prices that changed, one entry per currency and cadence. */
+    prices: Schematic.PlanVersionPriceChangeResponseData[];
+    /** The version being compared. */
+    to?: Schematic.PlanVersionResponseData;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface PlanVersionEntitlementChangeResponseData {
+    changeType: Schematic.PlanVersionDiffChangeType;
+    /** For a changed entitlement, the fields that differ. usage_quantity is the committed quantity of a pay-in-advance entitlement. */
+    changedFields: string[];
+    featureId: string;
+    "new"?: Schematic.PlanEntitlementResponseData;
+    old?: Schematic.PlanEntitlementResponseData;
+}

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

@@ -0,0 +1,5 @@
+export interface PlanVersionFieldChangeResponseData {
+    field: string;
+    "new": string;
+    old: 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/PlanVersionPriceChangeResponseData.d.ts

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface PlanVersionPriceChangeResponseData {
+    cadence: Schematic.PlanVersionDiffPriceCadence;
+    currency: Schematic.Currency;
+    "new"?: Schematic.BillingPriceResponseData;
+    old?: Schematic.BillingPriceResponseData;
+}

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

@@ -16,6 +16,7 @@ export interface PlanViewPublicResponseData {
     controlledBy: Schematic.BillingProviderType;
     copiedFromPlanId?: string;
     createdAt: Date;
+    creditVisibility?: Schematic.PlanCreditVisibility[];
     credits: Schematic.BillingCreditResponseData[];
     currencyPrices: Schematic.PlanCurrencyPricesResponseData[];
     custom: boolean;

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

@@ -11,6 +11,7 @@ export interface PreviewSubscriptionChangeResponseData {
     paymentMethodRequired: boolean;
     percentOff: number;
     periodStart: Date;
+    problems: Schematic.CheckoutProblemResponseData[];
     promoCodeApplied: boolean;
     proration: number;
     scheduledChangeTime?: Date;

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

@@ -1,7 +1,8 @@
+import type * as Schematic from "../index";
 export interface PreviewSubscriptionDiscountResponseData {
     amountOff?: number;
     couponName: string;
-    currency?: string;
+    currency?: Schematic.Currency;
     customerFacingCode?: string;
     duration: string;
     durationInMonths?: number;

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface PreviewSubscriptionFinanceResponseData {
     amountOff: number;
     /** ISO 4217 currency every amount in this block is denominated in. */
-    currency: string;
+    currency: Schematic.Currency;
     discountAmount: number;
     discounts: Schematic.PreviewSubscriptionDiscountResponseData[];
     dueNow: number;

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/RulesengineCondition.d.ts

@@ -12,6 +12,7 @@ export interface RulesengineCondition {
     metricPeriodMonthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     metricValue?: number;
     operator: Schematic.RulesengineComparableOperator;
+    quantityRates?: Record<string, number>;
     resourceIds: string[];
     traitDefinition?: Schematic.RulesengineTraitDefinition;
     traitValue: 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/RulesengineFeatureEntitlement.d.ts

@@ -30,6 +30,8 @@ export interface RulesengineFeatureEntitlement {
     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.RulesengineMetricPeriodMonthReset;
+    /** If the company has a credit-based entitlement for this feature, the credit cost per unit of each quantity an event carries, keyed by quantity key (per token for inference features). Absent when the entitlement prices requests only */
+    quantityRates?: Record<string, number>;
     /** 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/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/ScheduledDowngradeResponseData.d.ts

@@ -1,5 +1,6 @@
+import type * as Schematic from "../index";
 export interface ScheduledDowngradeResponseData {
-    currency: string;
+    currency: Schematic.Currency;
     effectiveAfter: Date;
     fromPlanId: string;
     fromPlanName: string;

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

@@ -6,7 +6,7 @@ export interface UpcomingInvoiceResponseData {
     collectionMethod: string;
     companyId?: string;
     createdAt: Date;
-    currency: string;
+    currency: Schematic.Currency;
     customerExternalId: string;
     dueDate?: Date;
     endingBalance: number;

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

@@ -3,6 +3,8 @@ export interface UpdateEntitlementReqCommon {
     creditConsumptionRate?: number;
     metricPeriod?: Schematic.MetricPeriod;
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
+    /** Credits per unit of the quantity (per token for inference features), keyed by quantity key. Inference features may price input_tokens, output_tokens, cached_input_tokens, cache_creation_input_tokens and reasoning_tokens; reasoning_tokens is priced on top of output_tokens, so leave its rate at zero for providers that count reasoning inside output. Omit to leave the schedule as it is; send null to clear it. */
+    quantityRates?: Record<string, number>;
     valueBool?: boolean;
     valueCreditId?: string;
     valueNumeric?: number;

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

@@ -3,7 +3,7 @@ export interface UpsertBillingProductRequestBody {
     billingProductId?: string;
     billingStrategy?: Schematic.BillingStrategy;
     chargeType: Schematic.ChargeType;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.PlanCurrencyPriceRequestBody[];
     isTrialable: boolean;
     monthlyPrice?: number;

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

@@ -2,7 +2,7 @@ import type * as Schematic from "../index";
 export interface UsageBasedEntitlementRequestBody {
     billingProductId?: string;
     billingThreshold?: number;
-    currency?: string;
+    currency?: Schematic.Currency;
     currencyPrices?: Schematic.CurrencyPriceRequestBody[];
     monthlyMeteredPriceId?: string;
     monthlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];

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

@@ -57,6 +57,7 @@ export * from "./BillingProductPricing";
 export * from "./BillingProductRecordResponseData";
 export * from "./BillingProductResponseData";
 export * from "./BillingProviderType";
+export * from "./BillingSettingsResponseData";
 export * from "./BillingStrategy";
 export * from "./BillingSubscriptionDiscount";
 export * from "./BillingSubscriptionDiscountView";
@@ -72,6 +73,8 @@ export * from "./CatalogConfigOrderedEntitlement";
 export * from "./CatalogConfigOrderedEntitlementResponseData";
 export * from "./CatalogConfigOrderedPlan";
 export * from "./CatalogConfigOrderedPlanResponseData";
+export * from "./CatalogConfigPlanCredit";
+export * from "./CatalogConfigPlanCreditResponseData";
 export * from "./CatalogConfigurationResponseData";
 export * from "./CatalogCreditBundleIDsResponseData";
 export * from "./CatalogDerivedFeatureResponseData";
@@ -92,6 +95,9 @@ export * from "./CheckoutFieldInput";
 export * from "./CheckoutFieldResponseData";
 export * from "./CheckoutFieldValue";
 export * from "./CheckoutFieldWithValue";
+export * from "./CheckoutProblemCode";
+export * from "./CheckoutProblemResponseData";
+export * from "./CheckoutProblemSource";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClaimedStripeSandboxKeysResponseData";
@@ -123,6 +129,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";
@@ -158,10 +167,15 @@ export * from "./CreateOrUpdateRuleRequestBody";
 export * from "./CreatePlanRequestBody";
 export * from "./CreatePriceTierRequestBody";
 export * from "./CreditAutoTopupAmountType";
+export * from "./CreditBalanceEventResponseData";
+export * from "./CreditBalanceFeatureConsumptionResponseData";
+export * from "./CreditBalancePointResponseData";
+export * from "./CreditBalanceTimeSeriesResponseData";
 export * from "./CreditBundleCurrencyPrice";
 export * from "./CreditBundleCurrencyPriceRequestBody";
 export * from "./CreditBundleCurrencyPriceResponseData";
 export * from "./CreditBundlePurchaseResponseData";
+export * from "./CreditBurnBreakdownLine";
 export * from "./CreditCompanyGrantView";
 export * from "./CreditCurrencyPrice";
 export * from "./CreditCurrencyPriceRequestBody";
@@ -173,15 +187,20 @@ 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";
 export * from "./CreditsAutoTopupRetryFailure";
 export * from "./CreditsAutoTopupSuccess";
 export * from "./CreditsCreditPurchaseSuccess";
+export * from "./CreditsInPlan";
 export * from "./CreditsWebhookCompanySummary";
 export * from "./CreditsWebhookCreditSummary";
 export * from "./CreditTransferReason";
@@ -191,6 +210,7 @@ export * from "./CreditTriggerConfig";
 export * from "./CreditUsage";
 export * from "./CreditUsageAggregation";
 export * from "./CreditUsageReason";
+export * from "./Currency";
 export * from "./CurrencyPriceRequestBody";
 export * from "./CustomerBillingAddress";
 export * from "./CustomPlanActivationStrategy";
@@ -229,6 +249,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";
@@ -246,6 +267,7 @@ export * from "./FeatureCompanyResponseData";
 export * from "./FeatureCompanyUserResponseData";
 export * from "./FeatureDetailResponseData";
 export * from "./FeatureEntitlement";
+export * from "./FeatureEventSource";
 export * from "./FeatureInPlanResponseData";
 export * from "./FeatureLedgerResponseData";
 export * from "./FeatureLifecyclePhase";
@@ -318,11 +340,14 @@ export * from "./PlanBundleEntitlementRequestBody";
 export * from "./PlanBundleResponseData";
 export * from "./PlanCatalogMembershipResponseData";
 export * from "./PlanChangeAction";
+export * from "./PlanChangeAmendmentStatus";
 export * from "./PlanChangeBasePlanAction";
 export * from "./PlanChangeResponseData";
 export * from "./PlanChangeSubscriptionAction";
 export * from "./PlanCreditGrantScaling";
 export * from "./PlanCreditGrantView";
+export * from "./PlanCreditOrder";
+export * from "./PlanCreditVisibility";
 export * from "./PlanCurrencyPriceRequestBody";
 export * from "./PlanCurrencyPricesResponseData";
 export * from "./PlanDetailResponseData";
@@ -343,13 +368,21 @@ export * from "./PlanSelection";
 export * from "./PlanSnapshotView";
 export * from "./PlanTraitResponseData";
 export * from "./PlanType";
+export * from "./PlanVersionBillingProductChangeResponseData";
 export * from "./PlanVersionCompanyMigrationResponseData";
 export * from "./PlanVersionCompanyMigrationStatus";
+export * from "./PlanVersionCreditGrantChangeResponseData";
+export * from "./PlanVersionDiffChangeType";
+export * from "./PlanVersionDiffPriceCadence";
+export * from "./PlanVersionDiffResponseData";
+export * from "./PlanVersionEntitlementChangeResponseData";
+export * from "./PlanVersionFieldChangeResponseData";
 export * from "./PlanVersionMigrationPreviewCompanyResponseData";
 export * from "./PlanVersionMigrationPreviewResponseData";
 export * from "./PlanVersionMigrationResponseData";
 export * from "./PlanVersionMigrationStatus";
 export * from "./PlanVersionMigrationStrategy";
+export * from "./PlanVersionPriceChangeResponseData";
 export * from "./PlanVersionResponseData";
 export * from "./PlanVersionSnapshotView";
 export * from "./PlanVersionStatus";
@@ -385,6 +418,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 +495,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/core/fetcher/getResponseBody.d.ts

@@ -1 +1,17 @@
+export type ResponseBodyError = {
+    ok: false;
+    error: {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    } | {
+        reason: "body-is-null";
+        statusCode: number;
+    };
+};
+/**
+ * Returns true when `value` is a failure record created by `getResponseBody` (for example malformed JSON),
+ * as opposed to a parsed JSON body that happens to have the same shape.
+ */
+export declare function isResponseBodyError(value: unknown): value is ResponseBodyError;
 export declare function getResponseBody(response: Response, responseType?: string): Promise<unknown>;

package/dist/core/fetcher/makeRequest.d.ts

@@ -3,4 +3,9 @@ export declare function isCacheNoStoreSupported(): boolean;
  * Reset the cached result of `isCacheNoStoreSupported`. Exposed for testing only.
  */
 export declare function resetCacheNoStoreSupported(): void;
-export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean) => Promise<Response>;
+/**
+ * Clears the timeout that `makeRequest` kept running (with `keepTimeoutUntilBodyRead`) so that it also
+ * covered reading the response body.
+ */
+export declare function clearResponseTimeout(response: Response): void;
+export declare const makeRequest: (fetchFn: (url: string, init: RequestInit) => Promise<Response>, url: string, method: string, headers: Headers | Record<string, string>, requestBody: BodyInit | undefined, timeoutMs?: number, abortSignal?: AbortSignal, withCredentials?: boolean, duplex?: "half", disableCache?: boolean, keepTimeoutUntilBodyRead?: boolean) => Promise<Response>;

package/dist/core/fetcher/requestWithRetries.d.ts

@@ -1 +1 @@
-export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number): Promise<Response>;
+export declare function requestWithRetries(requestFn: () => Promise<Response>, maxRetries?: number, abortSignal?: AbortSignal): Promise<Response>;

package/dist/core/fetcher/signals.d.ts

@@ -1,3 +1,4 @@
+export declare const TIMEOUT = "timeout";
 export declare function getTimeoutSignal(timeoutMs: number): {
     signal: AbortSignal;
     abortId: ReturnType<typeof setTimeout>;

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;
 }
 /**