@schematichq/schematic-typescript-node 1.5.9 → 1.5.12

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

@@ -1,4 +1,5 @@
 export declare const PlanVersionMigrationStatus: {
+    readonly Cancelled: "cancelled";
     readonly Completed: "completed";
     readonly Failed: "failed";
     readonly InProgress: "in_progress";

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

@@ -1,4 +1,5 @@
 export declare const PlanVersionMigrationStrategy: {
+    readonly EndOfBillingPeriod: "end_of_billing_period";
     readonly Immediate: "immediate";
     readonly Leave: "leave";
 };

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

@@ -10,6 +10,7 @@ export interface PreviewSubscriptionFinanceResponseData {
     periodStart: Date;
     promoCodeApplied: boolean;
     proration: number;
+    prorationBilledAt?: Date;
     taxAmount?: number;
     taxDisplayName?: string;
     taxRequireBillingDetails: boolean;

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

@@ -13,6 +13,7 @@ export interface RuleConditionDetailResponseData {
     metricPeriodMonthReset?: Schematic.MetricPeriodMonthReset;
     metricValue?: number;
     operator: Schematic.ComparableOperator;
+    planVersions?: Schematic.RuleConditionPlanVersionResponseData[];
     resourceIds: string[];
     resources: Schematic.PreviewObjectResponseData[];
     ruleId: string;

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface RuleConditionPlanVersionResponseData {
+    id: string;
+    name: string;
+    status: Schematic.PlanVersionStatus;
+    version: number;
+}

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

@@ -3,6 +3,12 @@ export interface StripeIntegrationConfig {
     accountId?: string;
     /** Display name of the connected Stripe account */
     accountName?: string;
+    /** When Stripe deletes the sandbox if nobody claims it, 60 days from creation; absent on sandboxes created before it was recorded */
+    claimableSandboxExpiresAt?: Date;
+    /** Stripe claimable sandbox this connection was provisioned from; absent for an OAuth connect */
+    claimableSandboxId?: string;
+    /** Stripe's claim status for the sandbox: unclaimed, claimed, or live */
+    claimableSandboxStatus?: string;
     /** When importing Stripe customers, only update existing companies, do not create new companies */
     companyUpdateOnly?: boolean;
     /** Whether the integration is connected to a Stripe sandbox account */
@@ -11,4 +17,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/StripeSandboxClaimLink.d.ts

@@ -0,0 +1,6 @@
+export interface StripeSandboxClaimLink {
+    claimUrl: string;
+    expiresAt?: Date;
+    sandboxId: string;
+    status: string;
+}

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

@@ -0,0 +1,3 @@
+export interface StripeSandboxCountriesResponseData {
+    countries: string[];
+}

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

@@ -0,0 +1,10 @@
+import type * as Schematic from "../index";
+export interface StripeSandboxInstallResponseData {
+    apiKeys?: Schematic.StripeSandboxKeysResponseData;
+    claimUrl: string;
+    claimUrlExpiresAt?: Date;
+    expiresAt?: Date;
+    install: Schematic.IntegrationInstallResponseData;
+    sandboxId: string;
+    stripeAccountId: string;
+}

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

@@ -0,0 +1,5 @@
+export interface StripeSandboxKeysResponseData {
+    mcp: string;
+    publishable: string;
+    secret: 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,6 +11,7 @@ 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;

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

@@ -89,6 +89,7 @@ export * from "./CheckoutFieldValue";
 export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
+export * from "./ClaimedStripeSandboxKeysResponseData";
 export * from "./ClerkIntegrationConfig";
 export * from "./CompanyBillingAddressView";
 export * from "./CompanyBillingCheckoutSettings";
@@ -96,6 +97,7 @@ export * from "./CompanyBillingDetailsResponseData";
 export * from "./CompanyBillingDetailsView";
 export * from "./CompanyBillingEntityResponseData";
 export * from "./CompanyBillingEntitySubscriptionResponseData";
+export * from "./CompanyBillingProfileResponseData";
 export * from "./CompanyCreditBalance";
 export * from "./CompanyCreditBalanceResponseData";
 export * from "./CompanyDetailResponseData";
@@ -165,6 +167,8 @@ export * from "./CreditGrantDetail";
 export * from "./CreditGrantExpiryRequestBody";
 export * from "./CreditGrantSortOrder";
 export * from "./CreditLeaseResponseData";
+export * from "./CreditSpendPolicyResponseData";
+export * from "./CreditSpendPolicyScope";
 export * from "./CreditsAutoTopupCompanySummary";
 export * from "./CreditsAutoTopupCreditSummary";
 export * from "./CreditsAutoTopupHardFailure";
@@ -289,11 +293,14 @@ export * from "./OnboardingPath";
 export * from "./OnboardingRequirement";
 export * from "./OnboardingRequirementStatus";
 export * from "./OnboardingRequirementView";
+export * from "./OnboardingStripeImport";
 export * from "./OnboardingTrack";
 export * from "./OrbIntegrationConfig";
 export * from "./OrderedPlansInGroup";
+export * from "./OtlpEnvironmentSettingsResponseData";
 export * from "./PaymentMethodRequestBody";
 export * from "./PaymentMethodResponseData";
+export * from "./PendingMigrationResponseData";
 export * from "./PlanBillingSource";
 export * from "./PlanBundleAction";
 export * from "./PlanBundleCreditGrantRequestBody";
@@ -355,6 +362,7 @@ export * from "./Rule";
 export * from "./RuleConditionDetailResponseData";
 export * from "./RuleConditionGroupDetailResponseData";
 export * from "./RuleConditionGroupResponseData";
+export * from "./RuleConditionPlanVersionResponseData";
 export * from "./RuleConditionResponseData";
 export * from "./RuleDetailResponseData";
 export * from "./RuleResponseData";
@@ -392,6 +400,10 @@ export * from "./SkippedEntitlementResponseData";
 export * from "./SortDirection";
 export * from "./StripeEmbedInfo";
 export * from "./StripeIntegrationConfig";
+export * from "./StripeSandboxClaimLink";
+export * from "./StripeSandboxCountriesResponseData";
+export * from "./StripeSandboxInstallResponseData";
+export * from "./StripeSandboxKeysResponseData";
 export * from "./SubscriptionStatus";
 export * from "./SubscriptionTraitUpdate";
 export * from "./SubscriptionType";
@@ -407,6 +419,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/credits/lease-store.d.ts

@@ -30,11 +30,18 @@ export interface ILeaseStore {
      * sharing the backend: if a live (unexpired) lease is already present —
      * even one with a different `leaseId`, e.g. acquired by a sibling pod that
      * raced this one — leave it untouched so its already-debited
-     * `localRemainingCredits` wins. Returns `true` if it wrote a fresh row,
-     * `false` if it kept an existing live lease (the caller should release the
-     * lease it acquired ONLY if its ID differs from the installed one — the
-     * server hands a racing acquire the same active lease back, and releasing
-     * that would pull the shared lease out from under every sibling).
+     * `localRemainingCredits` wins. If the slot holds an *expired* row with
+     * the SAME `leaseId`, implementations must NOT rewrite it either:
+     * rewriting resets `localRemainingCredits` to the full grant, erasing
+     * debits whose reservations are still open (the idempotent server hands a
+     * racing acquire the same active lease back, and a stale response can
+     * land after the local row's expiry — especially when a concurrent extend
+     * pushed the server-side expiry forward). Instead, reconcile it like an
+     * extend: granted-to-total, expiry only forward, balance untouched.
+     * Returns `true` if it wrote a fresh row, `false` if it kept (or
+     * reconciled) an existing lease (the caller should release the lease it
+     * acquired ONLY if its ID differs from the installed one — releasing the
+     * shared lease would pull it out from under every sibling).
      */
     replace(entry: Omit<LeaseEntry, "localRemainingCredits">): Promise<boolean>;
     /**
@@ -98,9 +105,11 @@ export declare class LeaseStore implements ILeaseStore {
      * Replace (or insert) the lease for the given (company, creditType).
      * Resets `localRemainingCredits` to `grantedAmount` for a new lease.
      * If a live lease already occupies the slot — regardless of `leaseId` — it
-     * is left alone so any already-debited `localRemainingCredits` wins.
-     * Returns `true` if a fresh row was written, `false` if an existing live
-     * lease was kept.
+     * is left alone so any already-debited `localRemainingCredits` wins. If
+     * the slot holds an expired row with the SAME `leaseId`, the entry is
+     * reconciled (granted-to-total, expiry forward) instead of rewritten —
+     * see `ILeaseStore.replace`. Returns `true` if a fresh row was written,
+     * `false` if an existing lease was kept.
      */
     replace(entry: Omit<LeaseEntry, "localRemainingCredits">): Promise<boolean>;
     /**

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;