@schematichq/schematic-typescript-node 1.5.9 → 1.5.12

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

@@ -20,6 +20,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.updateCompanyPlans("company_id", {
@@ -37,6 +39,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.listCustomPlanBillings({
@@ -61,6 +65,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.markCustomPlanBillingPaid("custom_plan_billing_id", {
@@ -79,6 +85,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.retryCustomPlanBilling("custom_plan_billing_id", {
@@ -96,11 +104,12 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.createCustomPlan({
      *         companyId: "company_id",
-     *         description: "description",
      *         name: "name"
      *     })
      */
@@ -115,6 +124,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.listPlans({
@@ -148,10 +159,11 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.createPlan({
-     *         description: "description",
      *         name: "name",
      *         planType: "plan"
      *     })
@@ -167,6 +179,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.getPlan("plan_id", {
@@ -185,6 +199,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.updatePlan("plan_id", {
@@ -202,6 +218,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.deletePlan("plan_id")
@@ -218,6 +236,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.upsertBillingProductPlan("plan_id", {
@@ -236,11 +256,12 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.upsertPlanForBillingProduct({
      *         billingProvider: "metronome",
-     *         description: "description",
      *         externalResourceId: "external_resource_id",
      *         name: "name",
      *         planType: "plan"
@@ -257,6 +278,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.listBillingProductMatchCompanies({
@@ -277,6 +300,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.countBillingProductMatchCompanies({
@@ -297,6 +322,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.countPlans({
@@ -330,6 +357,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.listPlanIssues({
@@ -349,6 +378,8 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.deletePlanVersion("plan_version_id", {
@@ -367,11 +398,13 @@ export declare class PlansClient {
      * @throws {@link Schematic.ForbiddenError}
      * @throws {@link Schematic.NotFoundError}
      * @throws {@link Schematic.InternalServerError}
+     * @throws {@link errors.SchematicError}
+     * @throws {@link errors.SchematicTimeoutError}
      *
      * @example
      *     await client.plans.publishPlanVersion("plan_version_id", {
      *         excludedCompanyIds: ["excluded_company_ids"],
-     *         migrationStrategy: "immediate"
+     *         migrationStrategy: "end_of_billing_period"
      *     })
      */
     publishPlanVersion(plan_version_id: string, request: Schematic.PublishPlanVersionRequestBody, requestOptions?: PlansClient.RequestOptions): core.HttpResponsePromise<Schematic.PublishPlanVersionResponse>;

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

@@ -3,7 +3,6 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         billingProvider: "metronome",
- *         description: "description",
  *         externalResourceId: "external_resource_id",
  *         name: "name",
  *         planType: "plan"
@@ -11,7 +10,7 @@ import type * as Schematic from "../../../../index";
  */
 export interface CreateBillingLinkedPlanRequestBody {
     billingProvider: Schematic.BillingProviderType;
-    description: string;
+    description?: string;
     externalResourceId: string;
     externalResourceVersion?: string;
     icon?: Schematic.PlanIcon;

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

@@ -3,7 +3,6 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         companyId: "company_id",
- *         description: "description",
  *         name: "name"
  *     }
  */
@@ -11,7 +10,7 @@ export interface CreateCustomPlanRequestBody {
     companyId: string;
     copiedFromPlanId?: string;
     copiedPriceId?: string;
-    description: string;
+    description?: string;
     icon?: Schematic.PlanIcon;
     name: string;
 }

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

@@ -3,12 +3,14 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         excludedCompanyIds: ["excluded_company_ids"],
- *         migrationStrategy: "immediate"
+ *         migrationStrategy: "end_of_billing_period"
  *     }
  */
 export interface PublishPlanVersionRequestBody {
     activationStrategy?: Schematic.CustomPlanActivationStrategy;
     address?: Schematic.CustomerBillingAddress;
+    /** The date the subscription's billing period renews on. Only honored on a first publish that starts a subscription. */
+    billingCycleAnchor?: Date;
     couponExternalId?: string;
     customFieldValues?: Schematic.CheckoutFieldValue[];
     customerEmail?: string;
@@ -16,6 +18,8 @@ export interface PublishPlanVersionRequestBody {
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
     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;
     prorationBehavior?: Schematic.MigrationProrationBehavior;
     /** Refuse the publish if any company would be migrated onto the new version */
     requireNoMigration?: boolean;

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

@@ -7,8 +7,12 @@ import type * as Schematic from "../../../../index";
  */
 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;
     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. */
+    prorateFirstPeriod?: boolean;
     /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
     sendInvoice?: boolean;
 }

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

@@ -0,0 +1,5 @@
+export interface ClaimedStripeSandboxKeysResponseData {
+    publishable: string;
+    sandboxId: string;
+    secret: string;
+}

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

@@ -0,0 +1,17 @@
+import type * as Schematic from "../index";
+export interface CompanyBillingProfileResponseData {
+    accountId: string;
+    billingCustomerId?: string;
+    collectionMethod: Schematic.BillingCollectionMethod;
+    companyId: string;
+    createdAt: Date;
+    daysUntilDue?: number;
+    environmentId: string;
+    id: string;
+    isDefault: boolean;
+    name?: string;
+    paymentMethodId?: string;
+    prorationBehavior?: Schematic.ProrationBehavior;
+    providerType: Schematic.BillingProviderType;
+    updatedAt: Date;
+}

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface CompanyDetailResponseData {
     addOns: Schematic.CompanyPlanWithBillingSubView[];
     billingCreditBalances?: Record<string, number>;
+    billingProfile?: Schematic.CompanyBillingProfileResponseData;
+    billingProfiles?: Schematic.CompanyBillingProfileResponseData[];
     billingSubscription?: Schematic.BillingSubscriptionView;
     billingSubscriptions: Schematic.BillingSubscriptionView[];
     createdAt: Date;
@@ -17,6 +19,7 @@ export interface CompanyDetailResponseData {
     metrics: Schematic.CompanyEventPeriodMetricsResponseData[];
     name: string;
     paymentMethods: Schematic.PaymentMethodResponseData[];
+    pendingMigration?: Schematic.PendingMigrationResponseData;
     plan?: Schematic.CompanyPlanWithBillingSubView;
     plans: Schematic.GenericPreviewObject[];
     rules: Schematic.Rule[];

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

@@ -16,6 +16,8 @@ export interface CompanyOverrideResponseData {
     ruleIdUsageExceeded?: string;
     updatedAt: Date;
     valueBool?: boolean;
+    valueCredit?: Schematic.BillingCreditResponseData;
+    valueCreditId?: string;
     valueNumeric?: number;
     valueTrait?: Schematic.EntityTraitDefinitionResponseData;
     valueTraitId?: string;

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

@@ -6,5 +6,6 @@ export interface CreditLeaseResponseData {
     grantedAmount: number;
     id: string;
     releasedAt?: Date;
+    trackedAmount: number;
     updatedAt: Date;
 }

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

@@ -0,0 +1,12 @@
+import type * as Schematic from "../index";
+export interface CreditSpendPolicyResponseData {
+    billingCreditId: string;
+    companyId?: string;
+    createdAt: Date;
+    id: string;
+    label?: string;
+    maxPerDraw?: number;
+    scopeType: Schematic.CreditSpendPolicyScope;
+    updatedAt: Date;
+    userId?: string;
+}

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

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

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

@@ -12,6 +12,8 @@ export interface CustomPlanBillingResponseData {
     /** The flow that created this billing record: a custom plan, or a standard plan assigned by invoice through Manage Plan. */
     planBillingSource: Schematic.PlanBillingSource;
     planId: string;
+    /** Whether the shortened period the renewal date created was billed pro rata when the subscription started. False means that period is free and the first invoice is the one raised on the renewal date. */
+    prorateFirstPeriod?: boolean;
     publishedAt?: Date;
     sendInvoice: boolean;
     status: Schematic.CustomPlanBillingStatus;

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

@@ -1,5 +1,7 @@
 export interface EventBodyInference {
-    /** Number of input tokens served from cache */
+    /** Number of input tokens written to a prompt cache; a subset of input_tokens */
+    cacheCreationInputTokens?: number;
+    /** Number of input tokens served from cache; a subset of input_tokens */
     cachedInputTokens?: number;
     /** Key-value pairs to identify the company associated with the inference event */
     company: Record<string, string>;
@@ -9,7 +11,7 @@ export interface EventBodyInference {
     currency?: string;
     /** Optional track event name to fan out for usage-based billing */
     event?: string;
-    /** Number of input tokens for the inference request */
+    /** Total number of input tokens for the inference request, including those served from and written to a prompt cache */
     inputTokens: number;
     /** The inference operation; defaults to 'chat' */
     operation?: string;

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

@@ -1,9 +1,15 @@
 import type * as Schematic from "../index";
 export interface GetOnboardingStateResp {
+    agentConnectedAt?: Date;
+    country?: string;
+    dismissedAt?: Date;
     environmentId?: string;
     milestones: Schematic.OnboardingMilestoneView[];
     path?: Schematic.OnboardingPath;
+    pricingPageUrl?: string;
     requirements: Schematic.OnboardingRequirementView[];
+    stripeImport?: Schematic.OnboardingStripeImport;
     suggestedNext: Schematic.OnboardingRequirement[];
     track?: Schematic.OnboardingTrack;
+    websiteUrl?: string;
 }

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

@@ -1,4 +1,5 @@
 export declare const OnboardingRequirement: {
+    readonly ConnectAgent: "connect_agent";
     readonly ConnectBilling: "connect_billing";
     readonly CreateApiKey: "create_api_key";
     readonly FirstFlagCheck: "first_flag_check";

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

@@ -0,0 +1,6 @@
+export declare const OnboardingStripeImport: {
+    readonly Complete: "complete";
+    readonly NotStarted: "not_started";
+    readonly Running: "running";
+};
+export type OnboardingStripeImport = (typeof OnboardingStripeImport)[keyof typeof OnboardingStripeImport];

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

@@ -0,0 +1,10 @@
+export interface OtlpEnvironmentSettingsResponseData {
+    companyAttribute?: string;
+    companyKey?: string;
+    createdAt: Date;
+    environmentId: string;
+    toolEventsEnabled: boolean;
+    updatedAt: Date;
+    userAttribute?: string;
+    userKey?: string;
+}

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

@@ -0,0 +1,8 @@
+export interface PendingMigrationResponseData {
+    migrationId: string;
+    scheduledFor?: Date;
+    toPlanId: string;
+    toPlanName: string;
+    toPlanVersionId: string;
+    toPlanVersionNumber?: number;
+}

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

@@ -9,6 +9,8 @@ export interface PlanVersionCompanyMigrationResponseData {
     id: string;
     migrationId: string;
     planVersionIdFrom?: string;
+    /** When this company is expected to migrate, for a migration scheduled at the end of the billing period: the end of the company's current billing period. Only set while both the company and the migration are still pending. A value at or before the time of the request means the company has no active subscription and migrates as soon as processing runs. Null means no upcoming renewal could be determined from the company's current billing status (for example, a past-due subscription or one set to cancel); it does not mean the company will never migrate. */
+    scheduledFor?: Date;
     startedAt?: Date;
     status: Schematic.PlanVersionCompanyMigrationStatus;
     updatedAt: Date;

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

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

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

@@ -6,6 +6,7 @@ export interface PlanVersionMigrationResponseData {
     error?: string;
     failedCompanies: number;
     id: string;
+    nextDueAt?: Date;
     planId: string;
     planVersionIdFrom?: string;
     planVersionIdTo: string;