@schematichq/schematic-typescript-node 1.6.2 → 1.6.3

package/dist/api/resources/billing/client/requests/CreateInvoiceRequestBody.d.ts

@@ -26,5 +26,6 @@ export interface CreateInvoiceRequestBody {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    total?: number;
     url?: string;
 }

package/dist/api/resources/entitlements/client/requests/CreateBillingLinkedPlanEntitlementRequestBody.d.ts

@@ -40,7 +40,7 @@ export interface CreateBillingLinkedPlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/CreatePlanEntitlementRequestBody.d.ts

@@ -36,7 +36,7 @@ export interface CreatePlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

package/dist/api/resources/entitlements/client/requests/UpdatePlanEntitlementRequestBody.d.ts

@@ -31,7 +31,7 @@ export interface UpdatePlanEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

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

@@ -6,6 +6,8 @@ export interface ChangeSubscriptionInternalRequestBody {
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    /** ISO 4217 currency this cart is being built in. Prices are still selected by id; this records the intent, and a cart that prices in another currency is reported as a problem. */
+    currency?: string;
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;

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

@@ -5,6 +5,8 @@ export interface ChangeSubscriptionRequestBody {
     billingEntityId?: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    /** ISO 4217 currency this cart is being built in. Prices are still selected by id; this records the intent, and a cart that prices in another currency is reported as a problem. */
+    currency?: string;
     customFieldValues: Schematic.CheckoutFieldValue[];
     newPlanId: string;
     newPriceId: string;

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

@@ -3,5 +3,6 @@ export declare const CompanyFeatureUsageExportMetadataVisibleColumnsItem: {
     readonly Subscription: "subscription";
     readonly Users: "users";
     readonly LastSeenAt: "last_seen_at";
+    readonly CreatedAt: "created_at";
 };
 export type CompanyFeatureUsageExportMetadataVisibleColumnsItem = (typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem)[keyof typeof CompanyFeatureUsageExportMetadataVisibleColumnsItem];

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

@@ -28,7 +28,7 @@ export interface CreateEntitlementInBundleRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCreditId?: string;

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

@@ -32,5 +32,6 @@ export interface CreditEventLedgerResponseData {
     transferReason?: Schematic.CreditTransferReason;
     usageEventId?: string;
     usageReason?: Schematic.CreditUsageReason;
+    userId?: string;
     zeroedOutReason?: Schematic.BillingCreditGrantZeroedOutReason;
 }

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

@@ -13,5 +13,6 @@ export interface InvoiceRequestBody {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    total?: number;
     url?: string;
 }

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

@@ -19,6 +19,8 @@ export interface InvoiceResponseData {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    /** Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it: rows synced before the column existed, or pushed without one. */
+    total?: number;
     updatedAt: Date;
     url?: string;
 }

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

@@ -19,6 +19,8 @@ export interface ManagePlanRequest {
     companyId: string;
     couponExternalId?: string;
     creditBundles: Schematic.UpdateCreditBundleRequestBody[];
+    /** ISO 4217 currency this change is being built in. Prices are still selected by id; this records the intent. */
+    currency?: string;
     customFieldValues: Schematic.CheckoutFieldValue[];
     /** Payment terms in days for an invoiced subscription. Defaults to 30. */
     daysUntilDue?: number;

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

@@ -26,7 +26,7 @@ export interface PlanEntitlementResponseData {
     softLimit?: number;
     updatedAt: Date;
     usageBasedProduct?: Schematic.BillingProductResponseData;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueCredit?: Schematic.BillingCreditResponseData;

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

@@ -1,6 +1,8 @@
 import type * as Schematic from "../index";
 export interface PreviewSubscriptionFinanceResponseData {
     amountOff: number;
+    /** ISO 4217 currency every amount in this block is denominated in. */
+    currency: string;
     discountAmount: number;
     discounts: Schematic.PreviewSubscriptionDiscountResponseData[];
     dueNow: number;

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

@@ -0,0 +1,11 @@
+export declare const RulesengineComparableOperator: {
+    readonly Eq: "eq";
+    readonly Gt: "gt";
+    readonly Gte: "gte";
+    readonly IsEmpty: "is_empty";
+    readonly Lt: "lt";
+    readonly Lte: "lte";
+    readonly NotEmpty: "not_empty";
+    readonly Ne: "ne";
+};
+export type RulesengineComparableOperator = (typeof RulesengineComparableOperator)[keyof typeof RulesengineComparableOperator];

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

@@ -11,7 +11,7 @@ export interface RulesengineCondition {
     metricPeriod?: Schematic.RulesengineMetricPeriod;
     metricPeriodMonthReset?: Schematic.RulesengineMetricPeriodMonthReset;
     metricValue?: number;
-    operator: Schematic.ComparableOperator;
+    operator: Schematic.RulesengineComparableOperator;
     resourceIds: string[];
     traitDefinition?: Schematic.RulesengineTraitDefinition;
     traitValue: string;

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

@@ -18,6 +18,8 @@ export interface UpcomingInvoiceResponseData {
     status?: Schematic.InvoiceStatus;
     subscriptionExternalId?: string;
     subtotal: number;
+    /** Amount after discounts and tax, before applying the customer balance. Null when the provider has not reported it. */
+    total?: number;
     updatedAt: Date;
     url?: string;
 }

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

@@ -22,7 +22,7 @@ export interface UsageBasedEntitlementRequestBody {
     quarterlyUnitPriceDecimal?: string;
     softLimit?: number;
     tierMode?: Schematic.BillingTiersMode;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     yearlyMeteredPriceId?: string;
     yearlyPriceTiers?: Schematic.CreatePriceTierRequestBody[];

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

@@ -9,7 +9,7 @@ export interface UsageBasedEntitlementResponseData {
     monthlyUsageBasedPrice?: Schematic.BillingPriceView;
     priceBehavior?: Schematic.EntitlementPriceBehavior;
     quarterlyUsageBasedPrice?: Schematic.BillingPriceView;
-    /** The committed unit quantity for this entitlement. For custom plans this is the quantity the company is contractually committed to; for standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. Note: this is not yet enforced/auto-provisioned as a true default — it is currently stored for downstream billing use. */
+    /** The committed unit quantity for this entitlement. For custom plans this is the minimum the company is contractually committed to: the company can buy more, and finalizing a new plan version sets the subscription quantity to the larger of this value and what the subscription already holds. For standard plans it is the quantity pre-filled when subscribing. Only applies to pay-in-advance entitlements. */
     usageQuantity?: number;
     valueBool?: boolean;
     valueNumeric?: number;

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

@@ -380,6 +380,7 @@ export * from "./RulesEngineSchemaVersion";
 export * from "./RulesengineCheckFlagResult";
 export * from "./RulesengineCompany";
 export * from "./RulesengineCompanyMetric";
+export * from "./RulesengineComparableOperator";
 export * from "./RulesengineCondition";
 export * from "./RulesengineConditionGroup";
 export * from "./RulesengineConditionType";