@schematichq/schematic-typescript-node 1.5.8 → 1.5.9

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,7 @@
+import type * as Schematic from "../index";
+export interface OnboardingRequirementView {
+    blockedBy?: Schematic.OnboardingRequirement[];
+    id: Schematic.OnboardingRequirement;
+    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/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;

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;

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

@@ -12,17 +12,19 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     autoTopupThresholdCredits?: number;
     autoTopupThresholdPercent?: number;
     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";