@tirdad/sdk 2.1.43 → 2.1.44

package/src/sdk/models/commitment-scope-type.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const CommitmentScopeType = {
+  Subscription: "subscription",
+  Group: "group",
+  Meter: "meter",
+  Price: "price",
+} as const;
+export type CommitmentScopeType = OpenEnum<typeof CommitmentScopeType>;
+
+/** @internal */
+export const CommitmentScopeType$inboundSchema: z.ZodMiniType<
+  CommitmentScopeType,
+  unknown
+> = openEnums.inboundSchema(CommitmentScopeType);
+/** @internal */
+export const CommitmentScopeType$outboundSchema: z.ZodMiniType<
+  string,
+  CommitmentScopeType
+> = openEnums.outboundSchema(CommitmentScopeType);

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

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const CommitmentStatus = {
+  Active: "active",
+  Ended: "ended",
+  Terminated: "terminated",
+} as const;
+export type CommitmentStatus = OpenEnum<typeof CommitmentStatus>;
+
+/** @internal */
+export const CommitmentStatus$inboundSchema: z.ZodMiniType<
+  CommitmentStatus,
+  unknown
+> = openEnums.inboundSchema(CommitmentStatus);
+/** @internal */
+export const CommitmentStatus$outboundSchema: z.ZodMiniType<
+  string,
+  CommitmentStatus
+> = openEnums.outboundSchema(CommitmentStatus);

package/src/sdk/models/commitment-usage-breakdown.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import {
+  CommitmentMeasurement,
+  CommitmentMeasurement$inboundSchema,
+} from "./commitment-measurement.js";
+import {
+  CommitmentType,
+  CommitmentType$inboundSchema,
+} from "./commitment-type.js";
+import {
+  CommitmentUsageValue,
+  CommitmentUsageValue$inboundSchema,
+} from "./commitment-usage-value.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type CommitmentUsageBreakdown = {
+  /**
+   * AppliesFrom/To is the stretch of the queried window the commitment covers; usage outside it
+   *
+   * @remarks
+   * bills as overage and is not counted here.
+   */
+  appliesFrom?: Date | undefined;
+  appliesTo?: Date | undefined;
+  /**
+   * BilledAmount is what the stretch bills for this commitment: used plus, when binding, the true-up.
+   */
+  billedAmount?: string | undefined;
+  binding?: boolean | undefined;
+  commitmentId?: string | undefined;
+  committed?: CommitmentUsageValue | undefined;
+  currency?: string | undefined;
+  invoiceLabel?: string | undefined;
+  measurement?: CommitmentMeasurement | undefined;
+  type?: CommitmentType | undefined;
+  unused?: CommitmentUsageValue | undefined;
+  used?: CommitmentUsageValue | undefined;
+};
+
+/** @internal */
+export const CommitmentUsageBreakdown$inboundSchema: z.ZodMiniType<
+  CommitmentUsageBreakdown,
+  unknown
+> = z.pipe(
+  z.object({
+    applies_from: types.optional(types.date()),
+    applies_to: types.optional(types.date()),
+    billed_amount: types.optional(types.string()),
+    binding: types.optional(types.boolean()),
+    commitment_id: types.optional(types.string()),
+    committed: types.optional(CommitmentUsageValue$inboundSchema),
+    currency: types.optional(types.string()),
+    invoice_label: types.optional(types.string()),
+    measurement: types.optional(CommitmentMeasurement$inboundSchema),
+    type: types.optional(CommitmentType$inboundSchema),
+    unused: types.optional(CommitmentUsageValue$inboundSchema),
+    used: types.optional(CommitmentUsageValue$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "applies_from": "appliesFrom",
+      "applies_to": "appliesTo",
+      "billed_amount": "billedAmount",
+      "commitment_id": "commitmentId",
+      "invoice_label": "invoiceLabel",
+    });
+  }),
+);
+
+export function commitmentUsageBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<CommitmentUsageBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommitmentUsageBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommitmentUsageBreakdown' from JSON`,
+  );
+}

package/src/sdk/models/commitment-usage-value.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type CommitmentUsageValue = {
+  amount?: string | undefined;
+  quantity?: string | undefined;
+};
+
+/** @internal */
+export const CommitmentUsageValue$inboundSchema: z.ZodMiniType<
+  CommitmentUsageValue,
+  unknown
+> = z.object({
+  amount: types.optional(types.string()),
+  quantity: types.optional(types.string()),
+});
+
+export function commitmentUsageValueFromJSON(
+  jsonString: string,
+): SafeParseResult<CommitmentUsageValue, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CommitmentUsageValue$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CommitmentUsageValue' from JSON`,
+  );
+}

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

@@ -0,0 +1,134 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  ActiveWindow,
+  ActiveWindow$Outbound,
+  ActiveWindow$outboundSchema,
+} from "./active-window.js";
+import {
+  CommitmentCollectionMethod,
+  CommitmentCollectionMethod$outboundSchema,
+} from "./commitment-collection-method.js";
+import {
+  CommitmentMeasurement,
+  CommitmentMeasurement$outboundSchema,
+} from "./commitment-measurement.js";
+import {
+  CommitmentPriceInput,
+  CommitmentPriceInput$Outbound,
+  CommitmentPriceInput$outboundSchema,
+} from "./commitment-price-input.js";
+import {
+  CommitmentScopeInput,
+  CommitmentScopeInput$Outbound,
+  CommitmentScopeInput$outboundSchema,
+} from "./commitment-scope-input.js";
+import {
+  CommitmentType,
+  CommitmentType$outboundSchema,
+} from "./commitment-type.js";
+
+export type CreateCommitmentRequest = {
+  activeWindows?: Array<ActiveWindow> | undefined;
+  /**
+   * default false
+   */
+  binding?: boolean | undefined;
+  collectionMethod?: CommitmentCollectionMethod | undefined;
+  committedPrice?: CommitmentPriceInput | undefined;
+  endDate: Date;
+  idempotencyKey?: string | undefined;
+  invoiceDescription?: string | undefined;
+  invoiceLabel?: string | undefined;
+  measurement: CommitmentMeasurement;
+  metadata?: { [k: string]: string } | undefined;
+  name: string;
+  overagePrice?: CommitmentPriceInput | undefined;
+  priority?: number | undefined;
+  scope: CommitmentScopeInput;
+  startDate: Date;
+  /**
+   * SubscriptionID is required on POST /commitments and set server-side on inline commitments.
+   */
+  subscriptionId?: string | undefined;
+  timezone?: string | undefined;
+  type: CommitmentType;
+  value?: string | undefined;
+};
+
+/** @internal */
+export type CreateCommitmentRequest$Outbound = {
+  active_windows?: Array<ActiveWindow$Outbound> | undefined;
+  binding?: boolean | undefined;
+  collection_method?: string | undefined;
+  committed_price?: CommitmentPriceInput$Outbound | undefined;
+  end_date: string;
+  idempotency_key?: string | undefined;
+  invoice_description?: string | undefined;
+  invoice_label?: string | undefined;
+  measurement: string;
+  metadata?: { [k: string]: string } | undefined;
+  name: string;
+  overage_price?: CommitmentPriceInput$Outbound | undefined;
+  priority?: number | undefined;
+  scope: CommitmentScopeInput$Outbound;
+  start_date: string;
+  subscription_id?: string | undefined;
+  timezone?: string | undefined;
+  type: string;
+  value?: string | undefined;
+};
+
+/** @internal */
+export const CreateCommitmentRequest$outboundSchema: z.ZodMiniType<
+  CreateCommitmentRequest$Outbound,
+  CreateCommitmentRequest
+> = z.pipe(
+  z.object({
+    activeWindows: z.optional(z.array(ActiveWindow$outboundSchema)),
+    binding: z.optional(z.boolean()),
+    collectionMethod: z.optional(CommitmentCollectionMethod$outboundSchema),
+    committedPrice: z.optional(CommitmentPriceInput$outboundSchema),
+    endDate: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    idempotencyKey: z.optional(z.string()),
+    invoiceDescription: z.optional(z.string()),
+    invoiceLabel: z.optional(z.string()),
+    measurement: CommitmentMeasurement$outboundSchema,
+    metadata: z.optional(z.record(z.string(), z.string())),
+    name: z.string(),
+    overagePrice: z.optional(CommitmentPriceInput$outboundSchema),
+    priority: z.optional(z.int()),
+    scope: CommitmentScopeInput$outboundSchema,
+    startDate: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    subscriptionId: z.optional(z.string()),
+    timezone: z.optional(z.string()),
+    type: CommitmentType$outboundSchema,
+    value: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      activeWindows: "active_windows",
+      collectionMethod: "collection_method",
+      committedPrice: "committed_price",
+      endDate: "end_date",
+      idempotencyKey: "idempotency_key",
+      invoiceDescription: "invoice_description",
+      invoiceLabel: "invoice_label",
+      overagePrice: "overage_price",
+      startDate: "start_date",
+      subscriptionId: "subscription_id",
+    });
+  }),
+);
+
+export function createCommitmentRequestToJSON(
+  createCommitmentRequest: CreateCommitmentRequest,
+): string {
+  return JSON.stringify(
+    CreateCommitmentRequest$outboundSchema.parse(createCommitmentRequest),
+  );
+}

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

@@ -50,6 +50,9 @@ export type CreateEntitlementRequest = {
   planId?: string | undefined;
   startDate?: Date | undefined;
   staticValue?: string | undefined;
+  /**
+   * Deprecated: use grant_quota; a metered usage_limit is converted to a grant on create.
+   */
   usageLimit?: number | undefined;
   usageResetPeriod?: EntitlementUsageResetPeriod | undefined;
 };

package/src/sdk/models/create-price-tier.ts

@@ -4,6 +4,11 @@
 
 import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  PriceTransformQuantity,
+  PriceTransformQuantity$Outbound,
+  PriceTransformQuantity$outboundSchema,
+} from "./price-transform-quantity.js";
 
 export type CreatePriceTier = {
   /**
@@ -13,6 +18,7 @@ export type CreatePriceTier = {
    * Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c"
    */
   flatAmount?: string | undefined;
+  transformQuantity?: PriceTransformQuantity | undefined;
   /**
    * unit_amount is the amount per unit for the given tier
    */
@@ -31,6 +37,7 @@ export type CreatePriceTier = {
 /** @internal */
 export type CreatePriceTier$Outbound = {
   flat_amount?: string | undefined;
+  transform_quantity?: PriceTransformQuantity$Outbound | undefined;
   unit_amount: string;
   up_to?: number | undefined;
 };
@@ -42,12 +49,14 @@ export const CreatePriceTier$outboundSchema: z.ZodMiniType<
 > = z.pipe(
   z.object({
     flatAmount: z.optional(z.string()),
+    transformQuantity: z.optional(PriceTransformQuantity$outboundSchema),
     unitAmount: z.string(),
     upTo: z.optional(z.int()),
   }),
   z.transform((v) => {
     return remap$(v, {
       flatAmount: "flat_amount",
+      transformQuantity: "transform_quantity",
       unitAmount: "unit_amount",
       upTo: "up_to",
     });

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

@@ -23,6 +23,11 @@ import {
   CollectionMethod,
   CollectionMethod$outboundSchema,
 } from "./collection-method.js";
+import {
+  CreateCommitmentRequest,
+  CreateCommitmentRequest$Outbound,
+  CreateCommitmentRequest$outboundSchema,
+} from "./create-commitment-request.js";
 import {
   CreateCreditGrantRequest,
   CreateCreditGrantRequest$Outbound,
@@ -114,6 +119,13 @@ export type CreateSubscriptionRequest = {
   collectionMethod?: CollectionMethod | undefined;
   commitmentAmount?: string | undefined;
   commitmentDuration?: BillingPeriod | undefined;
+  /**
+   * Commitments are created with the subscription. subscription_id, and entity_id on a subscription scope,
+   *
+   * @remarks
+   * are set server-side.
+   */
+  commitments?: Array<CreateCommitmentRequest> | undefined;
   /**
    * Deprecated: use SubscriptionCoupons instead.
    */
@@ -205,6 +217,7 @@ export type CreateSubscriptionRequest$Outbound = {
   collection_method?: string | undefined;
   commitment_amount?: string | undefined;
   commitment_duration?: string | undefined;
+  commitments?: Array<CreateCommitmentRequest$Outbound> | undefined;
   coupons?: Array<string> | undefined;
   credit_grants?: Array<CreateCreditGrantRequest$Outbound> | undefined;
   currency: string;
@@ -260,6 +273,7 @@ export const CreateSubscriptionRequest$outboundSchema: z.ZodMiniType<
     collectionMethod: z.optional(CollectionMethod$outboundSchema),
     commitmentAmount: z.optional(z.string()),
     commitmentDuration: z.optional(BillingPeriod$outboundSchema),
+    commitments: z.optional(z.array(CreateCommitmentRequest$outboundSchema)),
     coupons: z.optional(z.array(z.string())),
     creditGrants: z.optional(z.array(CreateCreditGrantRequest$outboundSchema)),
     currency: z.string(),

package/src/sdk/models/delete-events-op.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import {
+  DeleteEventsResponse,
+  DeleteEventsResponse$inboundSchema,
+} from "./delete-events-response.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type DeleteEventsResponseResponse = {
+  headers: { [k: string]: Array<string> };
+  result: DeleteEventsResponse;
+};
+
+/** @internal */
+export const DeleteEventsResponseResponse$inboundSchema: z.ZodMiniType<
+  DeleteEventsResponseResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    Headers: z._default(z.record(z.string(), z.array(z.string())), {}),
+    Result: DeleteEventsResponse$inboundSchema,
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  }),
+);
+
+export function deleteEventsResponseResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteEventsResponseResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteEventsResponseResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteEventsResponseResponse' from JSON`,
+  );
+}

package/src/sdk/models/delete-events-request.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type DeleteEventsRequest = {
+  /**
+   * EventIDs narrows the deletion to exact event ids. Requires exactly one
+   *
+   * @remarks
+   * customer and no feature_ids.
+   */
+  eventIds?: Array<string> | undefined;
+  externalCustomerIds: Array<string>;
+  /**
+   * FeatureIDs narrows the deletion to the meters these features resolve to.
+   */
+  featureIds?: Array<string> | undefined;
+  periodEnd: Date;
+  periodStart: Date;
+  /**
+   * SkipPayload stores the audit row's properties as '' so the deletion leaves
+   *
+   * @remarks
+   * no payload copy. Defaults to true: a deletion is usually an erasure, and
+   * keeping the payload would defeat it. Send false to retain it.
+   */
+  skipPayload?: boolean | undefined;
+};
+
+/** @internal */
+export type DeleteEventsRequest$Outbound = {
+  event_ids?: Array<string> | undefined;
+  external_customer_ids: Array<string>;
+  feature_ids?: Array<string> | undefined;
+  period_end: string;
+  period_start: string;
+  skip_payload?: boolean | undefined;
+};
+
+/** @internal */
+export const DeleteEventsRequest$outboundSchema: z.ZodMiniType<
+  DeleteEventsRequest$Outbound,
+  DeleteEventsRequest
+> = z.pipe(
+  z.object({
+    eventIds: z.optional(z.array(z.string())),
+    externalCustomerIds: z.array(z.string()),
+    featureIds: z.optional(z.array(z.string())),
+    periodEnd: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    periodStart: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    skipPayload: z.optional(z.boolean()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      eventIds: "event_ids",
+      externalCustomerIds: "external_customer_ids",
+      featureIds: "feature_ids",
+      periodEnd: "period_end",
+      periodStart: "period_start",
+      skipPayload: "skip_payload",
+    });
+  }),
+);
+
+export function deleteEventsRequestToJSON(
+  deleteEventsRequest: DeleteEventsRequest,
+): string {
+  return JSON.stringify(
+    DeleteEventsRequest$outboundSchema.parse(deleteEventsRequest),
+  );
+}

package/src/sdk/models/delete-events-response.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type DeleteEventsResponse = {
+  deletedEvents?: number | undefined;
+  deletedMeterUsageRows?: number | undefined;
+};
+
+/** @internal */
+export const DeleteEventsResponse$inboundSchema: z.ZodMiniType<
+  DeleteEventsResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    deleted_events: types.optional(types.number()),
+    deleted_meter_usage_rows: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "deleted_events": "deletedEvents",
+      "deleted_meter_usage_rows": "deletedMeterUsageRows",
+    });
+  }),
+);
+
+export function deleteEventsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DeleteEventsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DeleteEventsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DeleteEventsResponse' from JSON`,
+  );
+}

package/src/sdk/models/get-commitment-op.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type GetCommitmentRequest = {
+  /**
+   * Commitment ID
+   */
+  id: string;
+};
+
+/** @internal */
+export type GetCommitmentRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const GetCommitmentRequest$outboundSchema: z.ZodMiniType<
+  GetCommitmentRequest$Outbound,
+  GetCommitmentRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function getCommitmentRequestToJSON(
+  getCommitmentRequest: GetCommitmentRequest,
+): string {
+  return JSON.stringify(
+    GetCommitmentRequest$outboundSchema.parse(getCommitmentRequest),
+  );
+}

package/src/sdk/models/get-usage-by-subscription-response.ts

@@ -7,6 +7,10 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as types from "../../types/primitives.js";
+import {
+  CommitmentUsageBreakdown,
+  CommitmentUsageBreakdown$inboundSchema,
+} from "./commitment-usage-breakdown.js";
 import { SDKValidationError } from "./sdk-validation-error.js";
 import {
   SubscriptionUsageByMetersResponse,
@@ -21,6 +25,10 @@ export type GetUsageBySubscriptionResponse = {
    * Amount of commitment used
    */
   commitmentUtilized?: number | undefined;
+  /**
+   * Commitments is the per-commitment usage breakdown for the window; nil when commitments v2 is off or none apply.
+   */
+  commitments?: Array<CommitmentUsageBreakdown> | undefined;
   currency?: string | undefined;
   displayAmount?: string | undefined;
   endTime?: Date | undefined;
@@ -48,6 +56,9 @@ export const GetUsageBySubscriptionResponse$inboundSchema: z.ZodMiniType<
     ),
     commitment_amount: types.optional(types.number()),
     commitment_utilized: types.optional(types.number()),
+    commitments: types.optional(
+      z.array(CommitmentUsageBreakdown$inboundSchema),
+    ),
     currency: types.optional(types.string()),
     display_amount: types.optional(types.string()),
     end_time: types.optional(types.date()),