@flexprice/sdk 2.1.49-dev.26 → 2.1.49-dev.28

package/src/lib/config.ts

@@ -77,8 +77,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0",
-  sdkVersion: "2.1.49-dev.26",
+  sdkVersion: "2.1.49-dev.28",
   genVersion: "2.948.4",
   userAgent:
-    "speakeasy-sdk/typescript 2.1.49-dev.26 2.948.4 1.0 @flexprice/sdk",
+    "speakeasy-sdk/typescript 2.1.49-dev.28 2.948.4 1.0 @flexprice/sdk",
 } as const;

package/src/sdk/models/add-addon-request.ts

@@ -41,7 +41,7 @@ export type AddAddonRequest = {
    */
   coupons?: Array<SubscriptionCouponInput> | undefined;
   /**
-   * LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)
+   * Deprecated: use POST /commitments instead.
    */
   lineItemCommitments?: { [k: string]: LineItemCommitmentConfig } | undefined;
   metadata?: { [k: string]: any } | undefined;

package/src/sdk/models/add-addon-to-subscription-request.ts

@@ -35,7 +35,7 @@ export type AddAddonToSubscriptionRequest = {
    */
   coupons?: Array<SubscriptionCouponInput> | undefined;
   /**
-   * LineItemCommitments allows setting commitment configuration per addon line item (keyed by price_id)
+   * Deprecated: use POST /commitments instead.
    */
   lineItemCommitments?: { [k: string]: LineItemCommitmentConfig } | undefined;
   metadata?: { [k: string]: any } | undefined;

package/src/sdk/models/commitment-info.ts

@@ -20,13 +20,25 @@ import {
 import { SDKValidationError } from "./sdk-validation-error.js";
 
 export type CommitmentInfo = {
+  /**
+   * Amount is the commitment amount (v1), or computed_commitment_utilized_amount + computed_true_up_amount (v2).
+   */
   amount?: string | undefined;
   computedCommitmentUtilizedAmount?: string | undefined;
+  /**
+   * Usage units behind the computed amounts: usage a billing-terms commitment covers counts as utilized at no
+   *
+   * @remarks
+   * charge, and a quantity commitment's true-up counts its unused units.
+   */
+  computedCommitmentUtilizedQuantity?: string | undefined;
   computedOverageAmount?: string | undefined;
+  computedOverageQuantity?: string | undefined;
   /**
    * total_cost = computed_commitment_utilized_amount + computed_overage_amount + computed_true_up_amount
    */
   computedTrueUpAmount?: string | undefined;
+  computedTrueUpQuantity?: string | undefined;
   duration?: BillingPeriod | undefined;
   isWindowed?: boolean | undefined;
   overageFactor?: string | undefined;
@@ -46,8 +58,11 @@ export const CommitmentInfo$inboundSchema: z.ZodMiniType<
   z.object({
     amount: types.optional(types.string()),
     computed_commitment_utilized_amount: types.optional(types.string()),
+    computed_commitment_utilized_quantity: types.optional(types.string()),
     computed_overage_amount: types.optional(types.string()),
+    computed_overage_quantity: types.optional(types.string()),
     computed_true_up_amount: types.optional(types.string()),
+    computed_true_up_quantity: types.optional(types.string()),
     duration: types.optional(BillingPeriod$inboundSchema),
     is_windowed: types.optional(types.boolean()),
     overage_factor: types.optional(types.string()),
@@ -58,8 +73,12 @@ export const CommitmentInfo$inboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       "computed_commitment_utilized_amount": "computedCommitmentUtilizedAmount",
+      "computed_commitment_utilized_quantity":
+        "computedCommitmentUtilizedQuantity",
       "computed_overage_amount": "computedOverageAmount",
+      "computed_overage_quantity": "computedOverageQuantity",
       "computed_true_up_amount": "computedTrueUpAmount",
+      "computed_true_up_quantity": "computedTrueUpQuantity",
       "is_windowed": "isWindowed",
       "overage_factor": "overageFactor",
       "true_up_enabled": "trueUpEnabled",
@@ -70,8 +89,11 @@ export const CommitmentInfo$inboundSchema: z.ZodMiniType<
 export type CommitmentInfo$Outbound = {
   amount?: string | undefined;
   computed_commitment_utilized_amount?: string | undefined;
+  computed_commitment_utilized_quantity?: string | undefined;
   computed_overage_amount?: string | undefined;
+  computed_overage_quantity?: string | undefined;
   computed_true_up_amount?: string | undefined;
+  computed_true_up_quantity?: string | undefined;
   duration?: string | undefined;
   is_windowed?: boolean | undefined;
   overage_factor?: string | undefined;
@@ -88,8 +110,11 @@ export const CommitmentInfo$outboundSchema: z.ZodMiniType<
   z.object({
     amount: z.optional(z.string()),
     computedCommitmentUtilizedAmount: z.optional(z.string()),
+    computedCommitmentUtilizedQuantity: z.optional(z.string()),
     computedOverageAmount: z.optional(z.string()),
+    computedOverageQuantity: z.optional(z.string()),
     computedTrueUpAmount: z.optional(z.string()),
+    computedTrueUpQuantity: z.optional(z.string()),
     duration: z.optional(BillingPeriod$outboundSchema),
     isWindowed: z.optional(z.boolean()),
     overageFactor: z.optional(z.string()),
@@ -100,8 +125,12 @@ export const CommitmentInfo$outboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       computedCommitmentUtilizedAmount: "computed_commitment_utilized_amount",
+      computedCommitmentUtilizedQuantity:
+        "computed_commitment_utilized_quantity",
       computedOverageAmount: "computed_overage_amount",
+      computedOverageQuantity: "computed_overage_quantity",
       computedTrueUpAmount: "computed_true_up_amount",
+      computedTrueUpQuantity: "computed_true_up_quantity",
       isWindowed: "is_windowed",
       overageFactor: "overage_factor",
       trueUpEnabled: "true_up_enabled",

package/src/sdk/models/create-subscription-line-item-request.ts

@@ -29,15 +29,30 @@ import {
 
 export type CreateSubscriptionLineItemRequest = {
   /**
-   * Commitment fields
+   * Deprecated: use POST /commitments instead.
    */
   commitmentAmount?: number | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentOverageFactor?: number | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentQuantity?: number | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentTimeBuckets?: Array<CommitmentBucketRequest> | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentTrueUpEnabled?: boolean | undefined;
   commitmentType?: CommitmentType | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentWindowed?: boolean | undefined;
   displayName?: string | undefined;
   endDate?: Date | undefined;

package/src/sdk/models/create-subscription-request.ts

@@ -122,6 +122,9 @@ export type CreateSubscriptionRequest = {
   billingPeriodCount?: number | undefined;
   checkout?: CheckoutParams | undefined;
   collectionMethod?: CollectionMethod | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
   /**
@@ -141,6 +144,9 @@ export type CreateSubscriptionRequest = {
    * CustomerID takes priority over ExternalCustomerID when both are provided.
    */
   customerId?: string | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   enableTrueUp?: boolean | undefined;
   endDate?: Date | undefined;
   externalCustomerId?: string | undefined;
@@ -168,7 +174,7 @@ export type CreateSubscriptionRequest = {
   includePriceIds?: Array<string> | undefined;
   inheritance?: SubscriptionInheritanceConfig | undefined;
   /**
-   * LineItemCommitments sets per-line-item commitment config, keyed by price_id.
+   * Deprecated: use POST /commitments instead.
    */
   lineItemCommitments?: { [k: string]: LineItemCommitmentConfig } | undefined;
   /**
@@ -182,6 +188,9 @@ export type CreateSubscriptionRequest = {
   lineItems?: Array<CreateSubscriptionLineItemRequest> | undefined;
   lookupKey?: string | undefined;
   metadata?: { [k: string]: string } | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   overageFactor?: string | undefined;
   overrideEntitlements?: Array<OverrideEntitlementRequest> | undefined;
   /**

package/src/sdk/models/grouped-invoicing-child-request.ts

@@ -65,6 +65,9 @@ import {
 
 export type GroupedInvoicingChildRequest = {
   addons?: Array<AddAddonToSubscriptionRequest> | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
   /**
@@ -72,10 +75,13 @@ export type GroupedInvoicingChildRequest = {
    */
   coupons?: Array<string> | undefined;
   creditGrants?: Array<CreateCreditGrantRequest> | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   enableTrueUp?: boolean | undefined;
   externalCustomerId: string;
   /**
-   * LineItemCommitments sets per-line-item commitment config, keyed by price_id.
+   * Deprecated: use POST /commitments instead.
    */
   lineItemCommitments?: { [k: string]: LineItemCommitmentConfig } | undefined;
   /**
@@ -86,6 +92,9 @@ export type GroupedInvoicingChildRequest = {
    * LineItems are extra (non-plan) line items added at creation.
    */
   lineItems?: Array<CreateSubscriptionLineItemRequest> | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   overageFactor?: string | undefined;
   overrideEntitlements?: Array<OverrideEntitlementRequest> | undefined;
   /**

package/src/sdk/models/update-subscription-line-item-request.ts

@@ -39,18 +39,34 @@ export type UpdateSubscriptionLineItemRequest = {
   billingModel?: BillingModel | undefined;
   bucketSize?: WindowSize | undefined;
   /**
-   * Commitment fields
+   * Deprecated: use POST /commitments instead.
    */
   commitmentAmount?: number | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentOverageFactor?: number | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentQuantity?: number | undefined;
   /**
    * Pointer so an explicit empty array can clear existing buckets (omission keeps them).
+   *
+   * @remarks
+   *
+   * Deprecated: use POST /commitments instead.
    */
   commitmentTimeBuckets?: Array<CommitmentBucketRequest> | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentTrueUpEnabled?: boolean | undefined;
   commitmentType?: CommitmentType | undefined;
+  /**
+   * Deprecated: use POST /commitments instead.
+   */
   commitmentWindowed?: boolean | undefined;
   /**
    * EffectiveFrom for the existing line item (if not provided, defaults to now)

package/src/sdk/models/usage-analytic-point.ts

@@ -27,8 +27,14 @@ export type UsageAnalyticPoint = {
    * Commitment breakdown (only populated for windowed commitments)
    */
   computedCommitmentUtilizedAmount?: string | undefined;
+  /**
+   * Usage units behind the commitment breakdown, for v2 commitments
+   */
+  computedCommitmentUtilizedQuantity?: string | undefined;
   computedOverageAmount?: string | undefined;
+  computedOverageQuantity?: string | undefined;
   computedTrueUpAmount?: string | undefined;
+  computedTrueUpQuantity?: string | undefined;
   /**
    * Cost is the final cost after discount (Subtotal - Discount)
    */
@@ -51,8 +57,11 @@ export const UsageAnalyticPoint$inboundSchema: z.ZodMiniType<
   z.object({
     buckets: types.optional(z.array(PointBucket$inboundSchema)),
     computed_commitment_utilized_amount: types.optional(types.string()),
+    computed_commitment_utilized_quantity: types.optional(types.string()),
     computed_overage_amount: types.optional(types.string()),
+    computed_overage_quantity: types.optional(types.string()),
     computed_true_up_amount: types.optional(types.string()),
+    computed_true_up_quantity: types.optional(types.string()),
     cost: types.optional(types.string()),
     discount: types.optional(types.string()),
     event_count: types.optional(types.number()),
@@ -63,8 +72,12 @@ export const UsageAnalyticPoint$inboundSchema: z.ZodMiniType<
   z.transform((v) => {
     return remap$(v, {
       "computed_commitment_utilized_amount": "computedCommitmentUtilizedAmount",
+      "computed_commitment_utilized_quantity":
+        "computedCommitmentUtilizedQuantity",
       "computed_overage_amount": "computedOverageAmount",
+      "computed_overage_quantity": "computedOverageQuantity",
       "computed_true_up_amount": "computedTrueUpAmount",
+      "computed_true_up_quantity": "computedTrueUpQuantity",
       "event_count": "eventCount",
     });
   }),