@schematichq/schematic-typescript-node 1.5.8 → 1.5.10

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

@@ -0,0 +1,6 @@
+export interface PreflightEventUsageRequestBody {
+    /** The event subtype the usage would be recorded under */
+    eventSubtype: string;
+    /** How many units of the event subtype the action would record. Zero has no effect */
+    quantity: number;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface PreflightRequestBody {
+    /** Cost in credits of the action, keyed by credit ID, for callers that have already computed it. Takes precedence over usage and event_usage on credit balance conditions for the same credit. A cost of zero means the action is free, not that the input is absent */
+    creditCost?: Record<string, number>;
+    /** Usage of a specific event subtype. Preferred over usage when the subtype is known, since it only affects conditions measuring that subtype */
+    eventUsage?: Schematic.PreflightEventUsageRequestBody;
+    /** Quantity of usage to simulate against any numeric condition encountered while evaluating the flag. Zero has no effect */
+    usage?: number;
+}

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface PreviewSubscriptionFinanceResponseData {
     amountOff: number;
+    discountAmount: number;
     discounts: Schematic.PreviewSubscriptionDiscountResponseData[];
     dueNow: number;
     newCharges: number;
@@ -9,6 +10,7 @@ export interface PreviewSubscriptionFinanceResponseData {
     periodStart: Date;
     promoCodeApplied: boolean;
     proration: number;
+    prorationBilledAt?: Date;
     taxAmount?: number;
     taxDisplayName?: string;
     taxRequireBillingDetails: boolean;

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

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

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

@@ -11,4 +11,6 @@ export interface StripeIntegrationConfig {
     liveMode: boolean;
     /** Onboarding URL returned during the v2 (Connect) install flow before activation */
     onboardUrl?: string;
+    /** App location that started the connect flow; the OAuth callback redirects back there on success */
+    returnTo?: string;
 }

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

@@ -0,0 +1,23 @@
+import type * as Schematic from "../index";
+export interface UpcomingInvoiceResponseData {
+    amountDue: number;
+    amountPaid: number;
+    amountRemaining: number;
+    collectionMethod: string;
+    companyId?: string;
+    createdAt: Date;
+    currency: string;
+    customerExternalId: string;
+    dueDate?: Date;
+    endingBalance: number;
+    environmentId: string;
+    externalId?: string;
+    paymentMethodExternalId?: string;
+    providerType: Schematic.BillingProviderType;
+    startingBalance: number;
+    status?: Schematic.InvoiceStatus;
+    subscriptionExternalId?: string;
+    subtotal: number;
+    updatedAt: Date;
+    url?: string;
+}

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

@@ -11,18 +11,21 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     autoTopupSelfService?: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
+    /** Deprecated: use compatible_plan_ids on credit bundles instead. Still accepted; writes through to the credit's bundle compatibility. */
     canBuyBundles?: boolean;
+    /** Credits granted once per company on top of the per-license amount. Only valid when the grant scales per license. */
+    companyCreditAmount?: number;
     creditAmount?: number;
     expiryType?: Schematic.BillingCreditExpiryType;
     expiryUnit?: Schematic.BillingCreditExpiryUnit;
     expiryUnitCount?: number;
-    /** The license whose quantity scales this grant. Cannot be changed after creation. */
+    /** The license whose quantity scales this grant. Cleared when the grant moves off per-license scaling. */
     licenseId?: string;
     resetCadence: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart: Schematic.BillingPlanCreditGrantResetStart;
     resetType?: Schematic.BillingPlanCreditGrantResetType;
     /** Percentage of unused credits that carry over when this grant resets. Only applies when reset_type is plan_period. Rolled-over credits expire at the next reset and are not rolled again. */
     rolloverPercentage?: number;
-    /** Whether the grant is a fixed amount per company, or issued once per license the company holds. Cannot be changed after creation. */
+    /** Whether the grant is a fixed amount per company, or issued once per license the company holds. Changing this re-issues the credits companies already hold for this grant. */
     scaling?: Schematic.PlanCreditGrantScaling;
 }

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

@@ -10,6 +10,8 @@ export interface UpsertCompanyRequestBody {
     lastSeenAt?: Date;
     name?: string;
     preventKeyRemap?: boolean;
+    /** Names of keys to remove from the company. Removing a key the company does not have does nothing, and a company must keep at least one key. */
+    removeKeys?: string[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updateOnly?: boolean;

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

@@ -13,6 +13,8 @@ export interface UpsertUserRequestBody {
     keys: Record<string, string>;
     lastSeenAt?: Date;
     name?: string;
+    /** Names of keys to remove from the user. Removing a key the user does not have does nothing, and a user must keep at least one key. */
+    removeKeys?: string[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updateOnly?: boolean;

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

@@ -9,6 +9,8 @@ export interface UpsertUserSubRequestBody {
     keys: Record<string, string>;
     lastSeenAt?: Date;
     name?: string;
+    /** Names of keys to remove from the user. Removing a key the user does not have does nothing, and a user must keep at least one key. */
+    removeKeys?: string[];
     /** A map of trait names to trait values */
     traits?: Record<string, unknown>;
     updateOnly?: boolean;

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

@@ -6,6 +6,7 @@ export interface WhoAmIResponseData {
     apiKeyId?: string;
     environmentId?: string;
     environments: Schematic.EnvironmentResponseData[];
+    onboardingComplete: boolean;
     stripeUserId?: string;
     userId?: string;
     userName?: string;

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

@@ -12,6 +12,7 @@ export * from "./ApiKeyScope";
 export * from "./AuditLogExportMetadata";
 export * from "./AuditLogListResponseData";
 export * from "./AuditLogResponseData";
+export * from "./BillingCollectionMethod";
 export * from "./BillingCouponResponseData";
 export * from "./BillingCreditAutoTopupAvailability";
 export * from "./BillingCreditBundleResponseData";
@@ -80,6 +81,7 @@ export * from "./CheckFlagRequestBody";
 export * from "./CheckFlagResponseData";
 export * from "./CheckFlagsBulkResponseData";
 export * from "./CheckFlagsResponseData";
+export * from "./CheckoutBundlePurchaseBehavior";
 export * from "./CheckoutDataResponseData";
 export * from "./CheckoutFieldInput";
 export * from "./CheckoutFieldResponseData";
@@ -204,6 +206,7 @@ export * from "./EntityKeyDefinitionResponseData";
 export * from "./EntityKeyDetailResponseData";
 export * from "./EntityKeyResponseData";
 export * from "./EntityTraitDefinitionResponseData";
+export * from "./EntityTraitDefinitionUsage";
 export * from "./EntityTraitDetailResponseData";
 export * from "./EntityTraitResponseData";
 export * from "./EntityTraitValue";
@@ -237,6 +240,7 @@ export * from "./FeatureLifecyclePhase";
 export * from "./FeatureResponseData";
 export * from "./FeatureType";
 export * from "./FeatureUsageDetailResponseData";
+export * from "./FeatureUsageHistoryResponseData";
 export * from "./FeatureUsageLegacyResponseData";
 export * from "./FeatureUsageResponseData";
 export * from "./FeatureUsageTimeSeriesResponseData";
@@ -247,6 +251,7 @@ export * from "./FlagResponseData";
 export * from "./FlagType";
 export * from "./FlagView";
 export * from "./GenericPreviewObject";
+export * from "./GetOnboardingStateResp";
 export * from "./InsightsSummaryResponseData";
 export * from "./InstallIntegrationRequestBody";
 export * from "./IntegrationCapabilities";
@@ -276,11 +281,20 @@ export * from "./MetricPeriod";
 export * from "./MetricPeriodMonthReset";
 export * from "./MetronomeIntegrationConfig";
 export * from "./MigrationErrorCode";
+export * from "./MigrationProrationBehavior";
 export * from "./MrrResponseData";
+export * from "./OnboardingMilestone";
+export * from "./OnboardingMilestoneView";
+export * from "./OnboardingPath";
+export * from "./OnboardingRequirement";
+export * from "./OnboardingRequirementStatus";
+export * from "./OnboardingRequirementView";
+export * from "./OnboardingTrack";
 export * from "./OrbIntegrationConfig";
 export * from "./OrderedPlansInGroup";
 export * from "./PaymentMethodRequestBody";
 export * from "./PaymentMethodResponseData";
+export * from "./PlanBillingSource";
 export * from "./PlanBundleAction";
 export * from "./PlanBundleCreditGrantRequestBody";
 export * from "./PlanBundleEntitlementRequestBody";
@@ -323,6 +337,8 @@ export * from "./PlanVersionResponseData";
 export * from "./PlanVersionSnapshotView";
 export * from "./PlanVersionStatus";
 export * from "./PlanViewPublicResponseData";
+export * from "./PreflightEventUsageRequestBody";
+export * from "./PreflightRequestBody";
 export * from "./PreviewObject";
 export * from "./PreviewObjectResponseData";
 export * from "./PreviewSubscriptionChangeResponseData";
@@ -391,6 +407,7 @@ export * from "./TraitDefinition";
 export * from "./TraitDefinitionComparableType";
 export * from "./TraitType";
 export * from "./TrialStatus";
+export * from "./UpcomingInvoiceResponseData";
 export * from "./UpdateAddOnRequestBody";
 export * from "./UpdateAutoTopupOverrideRequestBody";
 export * from "./UpdateBillingPlanCreditGrantRequestBody";

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

@@ -0,0 +1,2 @@
+export declare const SENSITIVE_QUERY_PARAMS: Set<string>;
+export declare function redactUrl(url: string): string;

package/dist/core/requestBody.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
+ * additional body parameters are provided, the original body is returned unchanged so serialization
+ * is unaffected.
+ *
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
+ * SDK, which only merges additional body parameters into mapping bodies.
+ */
+export declare function mergeAdditionalBodyParameters(body: unknown, additionalBodyParameters: Record<string, unknown> | undefined): unknown;

package/dist/core/runtime/index.d.ts

@@ -1 +1 @@
-export { RUNTIME } from "./runtime";
+export { getUserAgent, RUNTIME } from "./runtime";

package/dist/core/runtime/runtime.d.ts

@@ -6,4 +6,23 @@ export interface Runtime {
     type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd" | "edge-runtime";
     version?: string;
     parsedVersion?: number;
+    /**
+     * The operating system the SDK is running on, when it can be determined
+     * (e.g. "linux", "darwin", "win32" on server runtimes). Undefined in
+     * environments where the OS is not observable (e.g. browsers).
+     */
+    os?: string;
+    /**
+     * The CPU architecture the SDK is running on, when it can be determined
+     * (e.g. "x64", "arm64" on server runtimes). Undefined in environments where
+     * the architecture is not observable (e.g. browsers).
+     */
+    arch?: string;
 }
+/**
+ * Builds a structured User-Agent string of the form
+ *   `{sdkName}/{sdkVersion} ({os}; {arch}) {runtime}/{runtimeVersion}`
+ * where the platform group and runtime segment are omitted gracefully when the
+ * underlying values cannot be determined (e.g. in a browser).
+ */
+export declare function getUserAgent(sdkName: string, sdkVersion: string): string;

package/dist/errors/SchematicError.d.ts

@@ -11,4 +11,5 @@ export declare class SchematicError extends Error {
         rawResponse?: core.RawResponse;
         cause?: unknown;
     });
+    get requestId(): string | undefined;
 }

package/dist/errors/SchematicTimeoutError.d.ts

@@ -1,5 +1,5 @@
-export declare class SchematicTimeoutError extends Error {
-    readonly cause?: unknown;
+import * as errors from "./index";
+export declare class SchematicTimeoutError extends errors.SchematicError {
     constructor(message: string, opts?: {
         cause?: unknown;
     });

package/dist/events.d.ts

@@ -24,6 +24,12 @@ declare class EventBuffer {
     private flushing;
     constructor(captureClient: EventCaptureClient, opts?: EventBufferOptions);
     flush(): Promise<void>;
+    /**
+     * Sends a single request's worth of events, retrying with exponential
+     * backoff. Failures are logged and the chunk is dropped, matching the
+     * buffer's contract that tracking never throws to the caller.
+     */
+    private sendChunk;
     push(event: CreateEventRequestBody): Promise<void>;
     stop(): Promise<void>;
     private startPeriodicFlush;