@schematichq/schematic-typescript-node 1.4.7 → 1.4.8

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

@@ -0,0 +1,9 @@
+export interface CheckoutFieldWithValue {
+    definitionId: string;
+    helperText?: string;
+    id: string;
+    name: string;
+    required: boolean;
+    stripeMetadataKey: string;
+    value?: string;
+}

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

@@ -2,6 +2,8 @@ import type * as Schematic from "../index";
 export interface CompanyCreditBalanceResponseData {
     creditId: string;
     remaining: number;
+    reserved: number;
+    settled: number;
     source: Schematic.BillingProviderType;
     total?: number;
 }

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

@@ -34,6 +34,7 @@ export interface CompanyPlanCreditGrantView {
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;
+    rolloverPercentage: number;
     /** Deprecated field, will be removed in the future. Use Credit.SingularName instead. */
     singularName?: string;
     updatedAt: Date;

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

@@ -10,6 +10,7 @@ export interface ComponentHydrateResponseData {
     component?: Schematic.ComponentResponseData;
     creditBundles: Schematic.BillingCreditBundleView[];
     creditGrants: Schematic.CreditCompanyGrantView[];
+    customCheckoutFields: Schematic.CheckoutFieldWithValue[];
     defaultPlan?: Schematic.PlanDetailResponseData;
     displaySettings: Schematic.ComponentDisplaySettings;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;

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

@@ -10,6 +10,7 @@ export interface ComponentPreviewResponseData {
     component?: Schematic.ComponentResponseData;
     creditBundles: Schematic.BillingCreditBundleView[];
     creditGrants: Schematic.CreditCompanyGrantView[];
+    customCheckoutFields: Schematic.CheckoutFieldWithValue[];
     defaultPlan?: Schematic.PlanDetailResponseData;
     displaySettings: Schematic.ComponentDisplaySettings;
     featureUsage?: Schematic.FeatureUsageDetailResponseData;

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

@@ -20,4 +20,6 @@ export interface CreateBillingPlanCreditGrantRequestBody {
     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. Defaults to 0. */
+    rolloverPercentage?: number;
 }

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

@@ -25,7 +25,10 @@ export interface CreditCompanyGrantView {
     quantityUsed: number;
     renewalEnabled: boolean;
     renewalPeriod?: Schematic.BillingPlanCreditGrantResetCadence;
+    reserved?: number;
+    settled?: number;
     singularName?: string;
+    sourceGrantId?: string;
     sourceLabel: string;
     transfers?: Schematic.CreditTransferView[];
     updatedAt: Date;

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

@@ -30,5 +30,6 @@ export interface CreditEventLedgerResponseData {
     sourceId: number;
     toGrantId?: string;
     usageEventId?: string;
+    usageReason?: Schematic.CreditUsageReason;
     zeroedOutReason?: Schematic.BillingCreditGrantZeroedOutReason;
 }

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

@@ -0,0 +1,8 @@
+export declare const CreditUsageReason: {
+    readonly LeaseHold: "lease_hold";
+    readonly LeaseRelease: "lease_release";
+    readonly ManualAdjustment: "manual_adjustment";
+    readonly Reconciliation: "reconciliation";
+    readonly Track: "track";
+};
+export type CreditUsageReason = (typeof CreditUsageReason)[keyof typeof CreditUsageReason];

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

@@ -14,6 +14,7 @@ export interface EventDetailResponseData {
     features: Schematic.PreviewObject[];
     id: string;
     idempotencyKey?: string;
+    leaseId?: string;
     loadedAt?: Date;
     processedAt?: Date;
     quantity: number;

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

@@ -11,6 +11,7 @@ export interface EventResponseData {
     featureIds: string[];
     id: string;
     idempotencyKey?: string;
+    leaseId?: string;
     loadedAt?: Date;
     processedAt?: Date;
     quantity: number;

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

@@ -0,0 +1,9 @@
+import type * as Schematic from "../index";
+export interface InstallIntegrationRequestBody {
+    companyMatchingCriteria?: Schematic.CompanyMatchingCriteria;
+    companyMatchingField?: string;
+    config?: Record<string, unknown>;
+    isSandbox?: boolean;
+    liveMode?: boolean;
+    type: Schematic.IntegrationType;
+}

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

@@ -1,9 +1,12 @@
 import type * as Schematic from "../index";
-export type IntegrationConfig = Schematic.IntegrationConfig.Clerk | Schematic.IntegrationConfig.Orb | Schematic.IntegrationConfig.Stripe | Schematic.IntegrationConfig.Workos;
+export type IntegrationConfig = Schematic.IntegrationConfig.Clerk | Schematic.IntegrationConfig.Metronome | Schematic.IntegrationConfig.Orb | Schematic.IntegrationConfig.Stripe | Schematic.IntegrationConfig.Workos;
 export declare namespace IntegrationConfig {
     interface Clerk extends Schematic.ClerkIntegrationConfig {
         type: "clerk";
     }
+    interface Metronome extends Schematic.MetronomeIntegrationConfig {
+        type: "metronome";
+    }
     interface Orb extends Schematic.OrbIntegrationConfig {
         type: "orb";
     }

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

@@ -0,0 +1,13 @@
+import type * as Schematic from "../index";
+export interface IntegrationInstallConfig {
+    companyMatchingCriteria?: Schematic.CompanyMatchingCriteria;
+    companyMatchingField?: string;
+    config?: Schematic.IntegrationConfig;
+    createdAt: Date;
+    id: string;
+    integrationId: string;
+    isAppInstall: boolean;
+    isConnectInstall: boolean;
+    liveMode: boolean;
+    updatedAt: Date;
+}

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

@@ -0,0 +1,6 @@
+import type * as Schematic from "../index";
+export interface IntegrationInstallResponseData {
+    capabilities: Schematic.IntegrationCapabilities;
+    config: Schematic.IntegrationInstallConfig;
+    integration: Schematic.IntegrationResponseData;
+}

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

@@ -1,5 +1,6 @@
 export declare const IntegrationType: {
     readonly Clerk: "clerk";
+    readonly Metronome: "metronome";
     readonly Orb: "orb";
     readonly Stripe: "stripe";
     readonly Unknown: "unknown";

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

@@ -9,6 +9,7 @@ export interface ManagePlanRequest {
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    customFieldValues: Schematic.CheckoutFieldValue[];
     payInAdvanceEntitlements: Schematic.UpdatePayInAdvanceRequestBody[];
     paymentMethodExternalId?: string;
     promoCode?: string;

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

@@ -0,0 +1 @@
+export type MetronomeIntegrationConfig = {};

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

@@ -3,6 +3,7 @@ export declare const MigrationErrorCode: {
     readonly MultipleSubscriptions: "multiple_subscriptions";
     readonly NoPriceForInterval: "no_price_for_interval";
     readonly NotOnOriginVersion: "not_on_origin_version";
+    readonly OperationItemNotFound: "operation_item_not_found";
     readonly PermanentConfig: "permanent_config";
     readonly PermanentDecline: "permanent_decline";
     readonly TransientDecline: "transient_decline";

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

@@ -31,6 +31,7 @@ export interface PlanCreditGrantView {
     resetCadence?: Schematic.BillingPlanCreditGrantResetCadence;
     resetStart?: Schematic.BillingPlanCreditGrantResetStart;
     resetType: Schematic.BillingPlanCreditGrantResetType;
+    rolloverPercentage: number;
     /** Deprecated field, will be removed in the future. Use Credit.SingularName instead. */
     singularName?: string;
     updatedAt: Date;

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

@@ -3,6 +3,7 @@ export interface PlanGroupDetailResponseData {
     addOns: Schematic.PlanGroupPlanDetailResponseData[];
     checkoutSettings: Schematic.CheckoutSettingsResponseData;
     componentSettings: Schematic.ComponentSettingsResponseData;
+    customCheckoutFields: Schematic.CheckoutFieldResponseData[];
     customPlanConfig?: Schematic.CustomPlanViewConfigResponseData;
     customPlanId?: string;
     defaultPlan?: Schematic.PlanGroupPlanDetailResponseData;

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

@@ -17,4 +17,6 @@ export interface UpdateBillingPlanCreditGrantRequestBody {
     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;
 }

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

@@ -22,6 +22,7 @@ export * from "./BillingCreditExpiryUnit";
 export * from "./BillingCreditGrantReason";
 export * from "./BillingCreditGrantResponseData";
 export * from "./BillingCreditGrantZeroedOutReason";
+export * from "./BillingCreditLedgerAuthority";
 export * from "./BillingCreditLedgerResponseData";
 export * from "./BillingCreditResponseData";
 export * from "./BillingCreditRolloverPolicy";
@@ -65,6 +66,10 @@ export * from "./CheckFlagResponseData";
 export * from "./CheckFlagsBulkResponseData";
 export * from "./CheckFlagsResponseData";
 export * from "./CheckoutDataResponseData";
+export * from "./CheckoutFieldInput";
+export * from "./CheckoutFieldResponseData";
+export * from "./CheckoutFieldValue";
+export * from "./CheckoutFieldWithValue";
 export * from "./CheckoutSettingsResponseData";
 export * from "./CheckoutSubscription";
 export * from "./ClerkIntegrationConfig";
@@ -143,6 +148,7 @@ export * from "./CreditTransferView";
 export * from "./CreditTriggerConfig";
 export * from "./CreditUsage";
 export * from "./CreditUsageAggregation";
+export * from "./CreditUsageReason";
 export * from "./CurrencyPriceRequestBody";
 export * from "./CustomPlanActivationStrategy";
 export * from "./CustomPlanBillingResponseData";
@@ -209,8 +215,11 @@ export * from "./FlagType";
 export * from "./FlagView";
 export * from "./GenericPreviewObject";
 export * from "./InsightsSummaryResponseData";
+export * from "./InstallIntegrationRequestBody";
 export * from "./IntegrationCapabilities";
 export * from "./IntegrationConfig";
+export * from "./IntegrationInstallConfig";
+export * from "./IntegrationInstallResponseData";
 export * from "./IntegrationResponseData";
 export * from "./IntegrationState";
 export * from "./IntegrationsDataSetResponseData";
@@ -231,6 +240,7 @@ export * from "./MarkCustomPlanBillingPaidRequestBody";
 export * from "./MeterRequestBody";
 export * from "./MetricPeriod";
 export * from "./MetricPeriodMonthReset";
+export * from "./MetronomeIntegrationConfig";
 export * from "./MigrationErrorCode";
 export * from "./MrrResponseData";
 export * from "./OrbIntegrationConfig";

package/dist/datastream/merge.d.ts

@@ -1,11 +1,5 @@
 import type * as Schematic from "../api/types";
-/**
- * Creates a complete deep copy of a Company object.
- */
 export declare function deepCopyCompany(c: Schematic.RulesengineCompany): Schematic.RulesengineCompany;
-/**
- * Creates a complete deep copy of a User object.
- */
 export declare function deepCopyUser(u: Schematic.RulesengineUser): Schematic.RulesengineUser;
 /**
  * Merges a partial update into an existing Company.
@@ -17,13 +11,13 @@ export declare function deepCopyUser(u: Schematic.RulesengineUser): Schematic.Ru
  * Partials don't carry refreshed entitlements, so when their derived fields
  * change in another part of the company we sync them here to match server
  * behavior:
- *   - credit_remaining ← credit_balances[credit_id]
- *   - usage ← metric value matching (event_name, metric_period, month_reset)
+ *   - creditRemaining ← credit_balances[credit_id]
+ *   - usage ← metric value matching (eventName, metricPeriod, monthReset)
  * Both are skipped when the partial also sends entitlements wholesale.
  *
- * Wire format uses snake_case keys. The existing company from cache
- * may have either camelCase or snake_case keys depending on how it
- * was stored.
+ * Partial updates arrive as raw wire payloads (snake_case keys) and are merged
+ * into an existing camelCase-canonicalized entity; each case writes the
+ * corresponding camelCase field so the cached entity stays in a single shape.
  */
 export declare function partialCompany(existing: Schematic.RulesengineCompany, partial: Record<string, unknown>): Schematic.RulesengineCompany;
 /**