@schematichq/schematic-typescript-node 1.5.9 → 1.5.10

package/dist/api/resources/scheduledcheckout/client/Client.d.ts

@@ -19,6 +19,8 @@ export declare class ScheduledcheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.scheduledcheckout.listScheduledCheckouts({
@@ -39,6 +41,8 @@ export declare class ScheduledcheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.scheduledcheckout.createScheduledCheckout({
@@ -58,6 +62,8 @@ export declare class ScheduledcheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.scheduledcheckout.getScheduledCheckout("scheduled_checkout_id")
@@ -74,6 +80,8 @@ export declare class ScheduledcheckoutClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.scheduledcheckout.updateScheduledCheckout("scheduled_checkout_id")

package/dist/api/resources/webhooks/client/Client.d.ts

@@ -19,6 +19,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.listWebhookEvents({
@@ -39,6 +41,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.getWebhookEvent("webhook_event_id")
@@ -54,6 +58,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.countWebhookEvents({
@@ -75,6 +81,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.listWebhooks({
@@ -94,6 +102,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.createWebhook({
@@ -112,6 +122,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.getWebhook("webhook_id")
@@ -128,6 +140,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.updateWebhook("webhook_id")
@@ -143,6 +157,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.deleteWebhook("webhook_id")
@@ -159,6 +175,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.sendTestWebhookAction("webhook_id", {
@@ -176,6 +194,8 @@ export declare class WebhooksClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.webhooks.countWebhooks({

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

@@ -1,5 +1,6 @@
 import type * as Schematic from "../index";
 export interface AuditLogResponseData {
+    accountMemberId?: string;
     actorType: Schematic.ActorType;
     apiKey?: Schematic.ApiKeyResponseData;
     apiKeyId?: string;

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

@@ -12,7 +12,7 @@ export interface BillingPlanCreditGrantResponseData {
     autoTopupSelfService: boolean;
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
-    /** Whether buyers can purchase one-time credit bundles on this grant, independent of auto top-up availability. */
+    /** Deprecated: bundle availability is a per-bundle plan compatibility set now; use compatible_plan_ids on credit bundles instead. */
     canBuyBundles: boolean;
     /** Credits granted once per company on top of the per-license amount. Always 0 when scaling is fixed. */
     companyCreditAmount: number;

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

@@ -26,5 +26,5 @@ export interface ComponentHydrateResponseData {
     stripeEmbed?: Schematic.StripeEmbedInfo;
     subscription?: Schematic.CompanySubscriptionResponseData;
     trialPaymentMethodRequired?: boolean;
-    upcomingInvoice?: Schematic.InvoiceResponseData;
+    upcomingInvoice?: Schematic.UpcomingInvoiceResponseData;
 }

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

@@ -27,5 +27,5 @@ export interface ComponentPreviewResponseData {
     stripeEmbed?: Schematic.StripeEmbedInfo;
     subscription?: Schematic.CompanySubscriptionResponseData;
     trialPaymentMethodRequired?: boolean;
-    upcomingInvoice?: Schematic.InvoiceResponseData;
+    upcomingInvoice?: Schematic.UpcomingInvoiceResponseData;
 }

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

@@ -11,6 +11,7 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     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 scaling is per_license. Defaults to 0. */
     companyCreditAmount?: number;

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

@@ -1,7 +1,7 @@
 import type * as Schematic from "../index";
 export interface CreateCustomPlanBundlePlanRequestBody {
     companyId: string;
-    description: string;
+    description?: string;
     icon?: Schematic.PlanIcon;
     name: string;
 }

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

@@ -1,6 +1,6 @@
 import type * as Schematic from "../index";
 export interface CreatePlanRequestBody {
-    description: string;
+    description?: string;
     icon?: Schematic.PlanIcon;
     name: string;
     planType: Schematic.PlanType;

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

@@ -2,6 +2,7 @@ import type * as Schematic from "../index";
 export interface OnboardingRequirementView {
     blockedBy?: Schematic.OnboardingRequirement[];
     id: Schematic.OnboardingRequirement;
+    reachedAt?: Date;
     satisfiedBy?: string;
     status: Schematic.OnboardingRequirementStatus;
 }

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

@@ -28,6 +28,12 @@ export interface PlanChangeResponseData {
     subscriptionChangeAction?: Schematic.PlanChangeSubscriptionAction;
     /** Any traits were updated as part of this plan change (via pay-in-advance entitlements). */
     traitsUpdated: Schematic.SubscriptionTraitUpdate[];
+    /** When the company's trial had converted to a paid subscription as of this change. Null when the trial had not converted, or for changes recorded before trial status was tracked. */
+    trialConvertedAt?: Date;
+    /** When the company's trial was set to end as of this change. Null when the company had never trialed, or for changes recorded before trial status was tracked. */
+    trialExpiresAt?: Date;
+    /** The company's trial status. Null when the company had never trialed, or for changes recorded before trial status was tracked. */
+    trialStatus?: Schematic.TrialStatus;
     updatedAt: Date;
     userId?: string;
     userName?: string;

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/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,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

@@ -407,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;