@schematichq/schematic-typescript-node 1.5.8 → 1.5.10

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,14 +3,14 @@ import type * as Schematic from "../../../../index";
  * @example
  *     {
  *         companyId: "company_id",
- *         description: "description",
  *         name: "name"
  *     }
  */
 export interface CreateCustomPlanRequestBody {
     companyId: string;
     copiedFromPlanId?: string;
-    description: string;
+    copiedPriceId?: string;
+    description?: string;
     icon?: Schematic.PlanIcon;
     name: string;
 }

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

@@ -4,6 +4,7 @@ import type * as Schematic from "../../../../index";
  *     {
  *         companyId: "company_id",
  *         planId: "plan_id",
+ *         planBillingSource: "custom_plan",
  *         status: "active",
  *         statuses: ["active"],
  *         limit: 1000000,
@@ -15,6 +16,8 @@ export interface ListCustomPlanBillingsRequest {
     companyId?: string;
     /** Filter by plan ID */
     planId?: string;
+    /** Filter by the flow that created the billing record. Defaults to custom_plan. */
+    planBillingSource?: Schematic.PlanBillingSource;
     /** Filter by billing status */
     status?: Schematic.CustomPlanBillingStatus;
     /** Filter by multiple billing statuses */

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

@@ -16,6 +16,9 @@ export interface PublishPlanVersionRequestBody {
     excludedCompanyIds: string[];
     migrationStrategy: Schematic.PlanVersionMigrationStrategy;
     phone?: string;
+    prorationBehavior?: Schematic.MigrationProrationBehavior;
+    /** Refuse the publish if any company would be migrated onto the new version */
+    requireNoMigration?: boolean;
     /** Whether Stripe emails the invoice when it is finalized. Defaults to true. */
     sendInvoice?: boolean;
     taxId?: Schematic.TaxIdInput;

package/dist/api/resources/plans/types/ListCustomPlanBillingsParams.d.ts

@@ -9,6 +9,8 @@ export interface ListCustomPlanBillingsParams {
     limit?: number;
     /** Page offset (default 0) */
     offset?: number;
+    /** Filter by the flow that created the billing record. Defaults to custom_plan. */
+    planBillingSource?: Schematic.PlanBillingSource;
     /** Filter by plan ID */
     planId?: string;
     /** Filter by billing status */

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

@@ -0,0 +1,5 @@
+export declare const BillingCollectionMethod: {
+    readonly ChargeAutomatically: "charge_automatically";
+    readonly SendInvoice: "send_invoice";
+};
+export type BillingCollectionMethod = (typeof BillingCollectionMethod)[keyof typeof BillingCollectionMethod];

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface BillingCreditBundleResponseData {
     billingInvoiceId?: string;
     bundleType: Schematic.BillingCreditBundleType;
+    /** Plans whose companies may purchase this bundle. Empty means the bundle is purchasable on every plan. */
+    compatiblePlanIds: string[];
     createdAt: Date;
     creditDescription?: string;
     creditIcon?: string;

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

@@ -1,6 +1,7 @@
 import type * as Schematic from "../index";
 export interface BillingCreditBundleView {
     bundleType: Schematic.BillingCreditBundleType;
+    compatiblePlanIds: string[];
     createdAt: Date;
     creditDescription?: string;
     creditIcon?: string;

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

@@ -1,6 +1,8 @@
 import type * as Schematic from "../index";
 export interface BillingCreditGrantResponseData {
     companyId: string;
+    /** The license instance this grant was issued for. Set only when a per-license plan grant issued it; null on a plan's own grant. */
+    companyLicenseId?: string;
     companyName: string;
     createdAt: Date;
     creditIcon?: string;
@@ -10,6 +12,8 @@ export interface BillingCreditGrantResponseData {
     expiresAt?: Date;
     grantReason: Schematic.BillingCreditGrantReason;
     id: string;
+    /** Name of the license this grant was issued for, when it came from a per-license plan grant. */
+    licenseName?: string;
     planId?: string;
     planName?: string;
     price?: Schematic.BillingPriceResponseData;

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

@@ -12,8 +12,10 @@ 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;
     createdAt: Date;
     credit?: Schematic.BillingCreditResponseData;
     creditAmount: number;

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

@@ -1,4 +1,7 @@
+import type * as Schematic from "../index";
 export interface CheckFlagRequestBody {
     company?: Record<string, string>;
+    /** Hypothetical usage to evaluate the flag against, for answering "would this action be allowed?" before performing it. Only supported when checking a single flag. Values are caller-asserted and can widen a verdict as well as narrow it, so do not forward untrusted input here when the result gates access. Only the flag value reflects the preflight; the entitlement and usage figures in the response are the company's current, unsimulated ones */
+    preflight?: Schematic.PreflightRequestBody;
     user?: Record<string, string>;
 }

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

@@ -0,0 +1,5 @@
+export declare const CheckoutBundlePurchaseBehavior: {
+    readonly Individual: "individual";
+    readonly Quantity: "quantity";
+};
+export type CheckoutBundlePurchaseBehavior = (typeof CheckoutBundlePurchaseBehavior)[keyof typeof CheckoutBundlePurchaseBehavior];

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

@@ -1,7 +1,10 @@
+import type * as Schematic from "../index";
 export interface CheckoutSettingsResponseData {
+    bundlePurchaseBehavior: Schematic.CheckoutBundlePurchaseBehavior;
     collectAddress: boolean;
     collectEmail: boolean;
     collectPhone: boolean;
+    collectTaxId: boolean;
     optInEnabled: boolean;
     optInText?: string;
     optInTitle?: string;

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

@@ -2,4 +2,5 @@ export interface CompanyBillingCheckoutSettings {
     collectAddress: boolean;
     collectEmail: boolean;
     collectPhone: boolean;
+    collectTaxId: boolean;
 }

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

@@ -4,6 +4,10 @@ export interface CompanyFeatureUsageExportMetadata {
     companyIds?: string[];
     /** Restrict the export to companies with these billing credit type IDs */
     creditTypeIds?: string[];
+    /** Company key definition IDs to include as columns, one column per definition, mirroring the companies list */
+    entityKeyDefinitionIds?: string[];
+    /** Company trait definition IDs to include as columns, one column per definition, mirroring the companies list */
+    entityTraitDefinitionIds?: string[];
     /** Schematic feature IDs (starting with 'feat_') to include as usage columns; empty means no usage columns */
     featureIds?: string[];
     /** Restrict the export to companies that do (or do not) have a scheduled downgrade */
@@ -18,6 +22,8 @@ export interface CompanyFeatureUsageExportMetadata {
     planIds?: string[];
     /** Restrict the export to companies on this plan version ID */
     planVersionId?: string;
+    /** Restrict the export to companies on a plan version that is no longer published */
+    planVersionUnpublished?: boolean;
     /** Free-text search over company name and keys */
     q?: string;
     /** Column to sort the exported rows by (e.g. name, created_at, plan); defaults to name */

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

@@ -14,6 +14,7 @@ export interface CompanyPlanCreditGrantView {
     companyAutoTopupAmount?: number;
     companyAutoTopupEnabled?: boolean;
     companyAutoTopupThresholdCredits?: number;
+    companyCreditAmount: number;
     createdAt: Date;
     credit?: Schematic.BillingCreditView;
     creditAmount: number;

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

@@ -1,8 +1,10 @@
 import type * as Schematic from "../index";
 export interface ComponentCheckoutSettings {
+    bundlePurchaseBehavior: Schematic.CheckoutBundlePurchaseBehavior;
     collectAddress: boolean;
     collectEmail: boolean;
     collectPhone: boolean;
+    collectTaxId: boolean;
     prorationBehavior: Schematic.ProrationBehavior;
     taxCollectionEnabled: boolean;
 }

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,7 +11,10 @@ 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;
     creditAmount: number;
     creditId: string;
     expiryType?: Schematic.BillingCreditExpiryType;

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

@@ -3,6 +3,7 @@ export interface CreditCompanyGrantView {
     billingCreditBundleId?: string;
     billingCreditId: string;
     companyId: string;
+    companyLicenseId?: string;
     companyName: string;
     createdAt: Date;
     creditDescription: string;
@@ -16,6 +17,7 @@ export interface CreditCompanyGrantView {
     expiryUnitCount?: number;
     grantReason: Schematic.BillingCreditGrantReason;
     id: string;
+    licenseName?: string;
     planId?: string;
     planName?: string;
     pluralName?: string;

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

@@ -1,12 +1,16 @@
 import type * as Schematic from "../index";
 export interface CustomPlanBillingResponseData {
     activationStrategy: Schematic.CustomPlanActivationStrategy;
+    /** The billing period renewal date pinned when the subscription started, when one was set. When no invoice exists yet, the first invoice is raised on this date. */
+    billingCycleAnchor?: Date;
     companyId: string;
     createdAt: Date;
     daysUntilDue: number;
     externalInvoiceId?: string;
     id: string;
     paidAt?: Date;
+    /** 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;
     publishedAt?: Date;
     sendInvoice: boolean;

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

@@ -0,0 +1,8 @@
+export interface EntityTraitDefinitionUsage {
+    checkoutFieldConfigCount: number;
+    companyOverrideCount: number;
+    featureCount: number;
+    planEntitlementCount: number;
+    planTraitCount: number;
+    ruleConditionCount: number;
+}

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

@@ -7,6 +7,8 @@ export interface EventBodyFlagCheck {
     flagId?: string;
     /** The key of the flag being checked */
     flagKey: string;
+    /** Whether the check was a preflight, asking whether an action would be allowed rather than reporting one that happened. Absent on ordinary checks */
+    preflight?: boolean;
     /** The reason why the value was returned */
     reason: string;
     /** Key-value pairs used to to identify company for which the flag was checked */

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

@@ -0,0 +1,12 @@
+export interface FeatureUsageHistoryResponseData {
+    /** Companies are identified by ID only. To report against your own identifiers, resolve them once via the companies API and cache the mapping; keys are not repeated on every row. */
+    companyId: string;
+    eventSubtype: string;
+    featureId: string;
+    /** Exclusive end of the period this usage covers */
+    periodEnd: Date;
+    /** Inclusive start of the period this usage covers */
+    periodStart: Date;
+    /** Usage recorded within this period; an incremental total, not a running one */
+    usage: number;
+}

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface GetOnboardingStateResp {
+    environmentId?: string;
+    milestones: Schematic.OnboardingMilestoneView[];
+    path?: Schematic.OnboardingPath;
+    requirements: Schematic.OnboardingRequirementView[];
+    suggestedNext: Schematic.OnboardingRequirement[];
+    track?: Schematic.OnboardingTrack;
+}

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

@@ -1,21 +1,35 @@
 import type * as Schematic from "../index";
 export interface ManagePlanRequest {
+    /** If true, the company gets the plan only once the first invoice is paid. Only applies to an invoiced subscription. Defaults to false. */
+    activateOnPayment?: boolean;
     addOnSelections: Schematic.PlanSelection[];
     basePlanId?: string;
     basePlanPriceId?: string;
     basePlanVersionId?: string;
+    /** The date the subscription's billing period renews on. Only honored when starting a new subscription; changing the anchor on an existing subscription is not supported. */
+    billingCycleAnchor?: Date;
+    /** Address the invoice is sent to. Required when collection_method is send_invoice. */
+    billingEmail?: string;
     /** The company that pays for this subscription. Must already have a Stripe customer. Only honored when starting a new subscription. */
     billingEntityId?: string;
     /** If false, subscription cancels at period end. Only applies when removing all plans. Defaults to true. */
     cancelImmediately?: boolean;
+    /** How the subscription is paid: charged to a payment method on file, or invoiced with payment terms. Invoicing is only available when starting a new subscription. Defaults to charge_automatically. */
+    collectionMethod?: Schematic.BillingCollectionMethod;
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
     customFieldValues: Schematic.CheckoutFieldValue[];
+    /** Payment terms in days for an invoiced subscription. Defaults to 30. */
+    daysUntilDue?: number;
     payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodExternalId?: string;
     promoCode?: string;
     /** If true and cancel_immediately is true, issue prorated credit. Only applies when removing all plans. Defaults to true. */
     prorate?: boolean;
+    /** 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. Only applies to an invoiced subscription. Defaults to true. */
+    sendInvoice?: boolean;
     trialEnd?: Date;
 }

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

@@ -0,0 +1,6 @@
+export declare const MigrationProrationBehavior: {
+    readonly AlwaysInvoice: "always_invoice";
+    readonly CreateProrations: "create_prorations";
+    readonly None: "none";
+};
+export type MigrationProrationBehavior = (typeof MigrationProrationBehavior)[keyof typeof MigrationProrationBehavior];

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

@@ -0,0 +1,5 @@
+export declare const OnboardingMilestone: {
+    readonly Evaluated: "evaluated";
+    readonly Implemented: "implemented";
+};
+export type OnboardingMilestone = (typeof OnboardingMilestone)[keyof typeof OnboardingMilestone];

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

@@ -0,0 +1,7 @@
+import type * as Schematic from "../index";
+export interface OnboardingMilestoneView {
+    id: Schematic.OnboardingMilestone;
+    missing: Schematic.OnboardingRequirement[];
+    progress: number;
+    reachedAt?: Date;
+}

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

@@ -0,0 +1,5 @@
+export declare const OnboardingPath: {
+    readonly Agent: "agent";
+    readonly App: "app";
+};
+export type OnboardingPath = (typeof OnboardingPath)[keyof typeof OnboardingPath];

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

@@ -0,0 +1,9 @@
+export declare const OnboardingRequirement: {
+    readonly ConnectBilling: "connect_billing";
+    readonly CreateApiKey: "create_api_key";
+    readonly FirstFlagCheck: "first_flag_check";
+    readonly ImportCompanies: "import_companies";
+    readonly ModelPackaging: "model_packaging";
+    readonly SendEvents: "send_events";
+};
+export type OnboardingRequirement = (typeof OnboardingRequirement)[keyof typeof OnboardingRequirement];

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

@@ -0,0 +1,6 @@
+export declare const OnboardingRequirementStatus: {
+    readonly Available: "available";
+    readonly Blocked: "blocked";
+    readonly Complete: "complete";
+};
+export type OnboardingRequirementStatus = (typeof OnboardingRequirementStatus)[keyof typeof OnboardingRequirementStatus];

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

@@ -0,0 +1,8 @@
+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/OnboardingTrack.d.ts

@@ -0,0 +1,5 @@
+export declare const OnboardingTrack: {
+    readonly Catalog: "catalog";
+    readonly SinglePlan: "single_plan";
+};
+export type OnboardingTrack = (typeof OnboardingTrack)[keyof typeof OnboardingTrack];

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

@@ -0,0 +1,5 @@
+export declare const PlanBillingSource: {
+    readonly CustomPlan: "custom_plan";
+    readonly ManagePlan: "manage_plan";
+};
+export type PlanBillingSource = (typeof PlanBillingSource)[keyof typeof PlanBillingSource];

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

@@ -4,4 +4,5 @@ export interface PlanBundleResponseData {
     creditGrants?: Schematic.BillingPlanCreditGrantResponseData[];
     entitlements?: Schematic.PlanEntitlementResponseData[];
     plan?: Schematic.PlanResponseData;
+    planVersion?: Schematic.PlanVersionResponseData;
 }

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

@@ -11,6 +11,7 @@ export interface PlanCreditGrantView {
     billingCreditAutoTopupThresholdCredits?: number;
     billingCreditAutoTopupThresholdPercent?: number;
     billingCreditCanBuyBundles: boolean;
+    companyCreditAmount: number;
     createdAt: Date;
     credit?: Schematic.BillingCreditView;
     creditAmount: number;

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

@@ -5,4 +5,5 @@ export interface PlanVersionMigrationPreviewCompanyResponseData {
     note?: string;
     planVersionIdFrom?: string;
     willUpdateSubscription: boolean;
+    wouldFail: boolean;
 }

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

@@ -1,4 +1,5 @@
 import type * as Schematic from "../index";
 export interface PlanVersionMigrationPreviewResponseData {
     companies: Schematic.PlanVersionMigrationPreviewCompanyResponseData[];
+    hasBillingChanges: boolean;
 }

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

@@ -10,6 +10,7 @@ export interface PlanVersionMigrationResponseData {
     planVersionIdFrom?: string;
     planVersionIdTo: string;
     planVersionIdsFrom: string[];
+    prorationBehavior?: Schematic.MigrationProrationBehavior;
     skippedCompanies: number;
     startedAt?: Date;
     status: Schematic.PlanVersionMigrationStatus;