@tirdad/sdk 2.1.43 → 2.1.45

package/src/sdk/models/contract-association-response.ts

@@ -0,0 +1,51 @@
+/*
+ * 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 {
+  RevRecEntityType,
+  RevRecEntityType$inboundSchema,
+} from "./rev-rec-entity-type.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type ContractAssociationResponse = {
+  createdAt?: Date | undefined;
+  entityId?: string | undefined;
+  entityType?: RevRecEntityType | undefined;
+  id?: string | undefined;
+};
+
+/** @internal */
+export const ContractAssociationResponse$inboundSchema: z.ZodMiniType<
+  ContractAssociationResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: types.optional(types.date()),
+    entity_id: types.optional(types.string()),
+    entity_type: types.optional(RevRecEntityType$inboundSchema),
+    id: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "entity_id": "entityId",
+      "entity_type": "entityType",
+    });
+  }),
+);
+
+export function contractAssociationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ContractAssociationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ContractAssociationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ContractAssociationResponse' from JSON`,
+  );
+}

package/src/sdk/models/contract-filter.ts

@@ -0,0 +1,106 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import {
+  ContractStatus,
+  ContractStatus$outboundSchema,
+} from "./contract-status.js";
+import {
+  FilterCondition,
+  FilterCondition$Outbound,
+  FilterCondition$outboundSchema,
+} from "./filter-condition.js";
+import {
+  SortCondition,
+  SortCondition$Outbound,
+  SortCondition$outboundSchema,
+} from "./sort-condition.js";
+import { Status, Status$outboundSchema } from "./status.js";
+
+export const ContractFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type ContractFilterOrder = ClosedEnum<typeof ContractFilterOrder>;
+
+export type ContractFilter = {
+  contractIds?: Array<string> | undefined;
+  contractStatuses?: Array<ContractStatus> | undefined;
+  customerIds?: Array<string> | undefined;
+  endTime?: Date | undefined;
+  endedAtGte?: Date | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: ContractFilterOrder | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+  subscriptionIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ContractFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof ContractFilterOrder
+> = z.enum(ContractFilterOrder);
+
+/** @internal */
+export type ContractFilter$Outbound = {
+  contract_ids?: Array<string> | undefined;
+  contract_statuses?: Array<string> | undefined;
+  customer_ids?: Array<string> | undefined;
+  end_time?: string | undefined;
+  ended_at_gte?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+  subscription_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ContractFilter$outboundSchema: z.ZodMiniType<
+  ContractFilter$Outbound,
+  ContractFilter
+> = z.pipe(
+  z.object({
+    contractIds: z.optional(z.array(z.string())),
+    contractStatuses: z.optional(z.array(ContractStatus$outboundSchema)),
+    customerIds: z.optional(z.array(z.string())),
+    endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    endedAtGte: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    expand: z.optional(z.string()),
+    filters: z.optional(z.array(FilterCondition$outboundSchema)),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    order: z.optional(ContractFilterOrder$outboundSchema),
+    sort: z.optional(z.array(SortCondition$outboundSchema)),
+    startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    status: z.optional(Status$outboundSchema),
+    subscriptionIds: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      contractIds: "contract_ids",
+      contractStatuses: "contract_statuses",
+      customerIds: "customer_ids",
+      endTime: "end_time",
+      endedAtGte: "ended_at_gte",
+      startTime: "start_time",
+      subscriptionIds: "subscription_ids",
+    });
+  }),
+);
+
+export function contractFilterToJSON(contractFilter: ContractFilter): string {
+  return JSON.stringify(ContractFilter$outboundSchema.parse(contractFilter));
+}

package/src/sdk/models/contract-response.ts

@@ -0,0 +1,76 @@
+/*
+ * 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 {
+  ContractAssociationResponse,
+  ContractAssociationResponse$inboundSchema,
+} from "./contract-association-response.js";
+import {
+  ContractStatus,
+  ContractStatus$inboundSchema,
+} from "./contract-status.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+export type ContractResponse = {
+  associations?: Array<ContractAssociationResponse> | undefined;
+  contractStatus?: ContractStatus | undefined;
+  createdAt?: Date | undefined;
+  currency?: string | undefined;
+  customerId?: string | undefined;
+  endedAt?: Date | undefined;
+  id?: string | undefined;
+  status?: Status | undefined;
+  termEnd?: Date | undefined;
+  termStart?: Date | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const ContractResponse$inboundSchema: z.ZodMiniType<
+  ContractResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    associations: types.optional(
+      z.array(ContractAssociationResponse$inboundSchema),
+    ),
+    contract_status: types.optional(ContractStatus$inboundSchema),
+    created_at: types.optional(types.date()),
+    currency: types.optional(types.string()),
+    customer_id: types.optional(types.string()),
+    ended_at: types.optional(types.date()),
+    id: types.optional(types.string()),
+    status: types.optional(Status$inboundSchema),
+    term_end: types.optional(types.date()),
+    term_start: types.optional(types.date()),
+    updated_at: types.optional(types.date()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "contract_status": "contractStatus",
+      "created_at": "createdAt",
+      "customer_id": "customerId",
+      "ended_at": "endedAt",
+      "term_end": "termEnd",
+      "term_start": "termStart",
+      "updated_at": "updatedAt",
+    });
+  }),
+);
+
+export function contractResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ContractResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ContractResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ContractResponse' from JSON`,
+  );
+}

package/src/sdk/models/contract-status.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 ContractStatus = {
+  Draft: "draft",
+  Active: "active",
+  Ended: "ended",
+  Cancelled: "cancelled",
+} as const;
+export type ContractStatus = OpenEnum<typeof ContractStatus>;
+
+/** @internal */
+export const ContractStatus$inboundSchema: z.ZodMiniType<
+  ContractStatus,
+  unknown
+> = openEnums.inboundSchema(ContractStatus);
+/** @internal */
+export const ContractStatus$outboundSchema: z.ZodMiniType<
+  string,
+  ContractStatus
+> = openEnums.outboundSchema(ContractStatus);

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

@@ -36,8 +36,11 @@ export type CreateEntitlementRequest = {
   endDate?: Date | undefined;
   entityId?: string | undefined;
   entityType?: EntitlementEntityType | undefined;
-  featureId: string;
-  featureType: FeatureType;
+  /**
+   * Required, except on a subscription entitlement grant (entity_type SUBSCRIPTION with grant config), which has no feature.
+   */
+  featureId?: string | undefined;
+  featureType?: FeatureType | undefined;
   grantAllocationBehavior?: EntitlementGrantAllocationBehavior | undefined;
   grantDurationUnit?: EntitlementGrantDurationUnit | undefined;
   grantDurationValue?: number | undefined;
@@ -50,6 +53,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;
 };
@@ -61,8 +67,8 @@ export type CreateEntitlementRequest$Outbound = {
   end_date?: string | undefined;
   entity_id?: string | undefined;
   entity_type?: string | undefined;
-  feature_id: string;
-  feature_type: string;
+  feature_id?: string | undefined;
+  feature_type?: string | undefined;
   grant_allocation_behavior?: string | undefined;
   grant_duration_unit?: string | undefined;
   grant_duration_value?: number | undefined;
@@ -90,8 +96,8 @@ export const CreateEntitlementRequest$outboundSchema: z.ZodMiniType<
     endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     entityId: z.optional(z.string()),
     entityType: z.optional(EntitlementEntityType$outboundSchema),
-    featureId: z.string(),
-    featureType: FeatureType$outboundSchema,
+    featureId: z.optional(z.string()),
+    featureType: z.optional(FeatureType$outboundSchema),
     grantAllocationBehavior: z.optional(
       EntitlementGrantAllocationBehavior$outboundSchema,
     ),

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

@@ -67,6 +67,7 @@ export type CreatePriceRequest = {
   minQuantity?: number | undefined;
   priceUnitConfig?: PriceUnitConfig | undefined;
   priceUnitType: PriceUnitType;
+  productId?: string | undefined;
   startDate?: Date | undefined;
   tierMode?: BillingTier | undefined;
   tiers?: Array<CreatePriceTier> | undefined;
@@ -97,6 +98,7 @@ export type CreatePriceRequest$Outbound = {
   min_quantity?: number | undefined;
   price_unit_config?: PriceUnitConfig$Outbound | undefined;
   price_unit_type: string;
+  product_id?: string | undefined;
   start_date?: string | undefined;
   tier_mode?: string | undefined;
   tiers?: Array<CreatePriceTier$Outbound> | undefined;
@@ -131,6 +133,7 @@ export const CreatePriceRequest$outboundSchema: z.ZodMiniType<
     minQuantity: z.optional(z.int()),
     priceUnitConfig: z.optional(PriceUnitConfig$outboundSchema),
     priceUnitType: PriceUnitType$outboundSchema,
+    productId: z.optional(z.string()),
     startDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     tierMode: z.optional(BillingTier$outboundSchema),
     tiers: z.optional(z.array(CreatePriceTier$outboundSchema)),
@@ -156,6 +159,7 @@ export const CreatePriceRequest$outboundSchema: z.ZodMiniType<
       minQuantity: "min_quantity",
       priceUnitConfig: "price_unit_config",
       priceUnitType: "price_unit_type",
+      productId: "product_id",
       startDate: "start_date",
       tierMode: "tier_mode",
       transformQuantity: "transform_quantity",

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-product-request.ts

@@ -0,0 +1,44 @@
+/*
+ * 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 CreateProductRequest = {
+  description?: string | undefined;
+  lookupKey: string;
+  name: string;
+};
+
+/** @internal */
+export type CreateProductRequest$Outbound = {
+  description?: string | undefined;
+  lookup_key: string;
+  name: string;
+};
+
+/** @internal */
+export const CreateProductRequest$outboundSchema: z.ZodMiniType<
+  CreateProductRequest$Outbound,
+  CreateProductRequest
+> = z.pipe(
+  z.object({
+    description: z.optional(z.string()),
+    lookupKey: z.string(),
+    name: z.string(),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      lookupKey: "lookup_key",
+    });
+  }),
+);
+
+export function createProductRequestToJSON(
+  createProductRequest: CreateProductRequest,
+): string {
+  return JSON.stringify(
+    CreateProductRequest$outboundSchema.parse(createProductRequest),
+  );
+}

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

@@ -0,0 +1,85 @@
+/*
+ * 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 {
+  EntitlementAggregationMode,
+  EntitlementAggregationMode$outboundSchema,
+} from "./entitlement-aggregation-mode.js";
+import {
+  EntitlementGrantAllocationBehavior,
+  EntitlementGrantAllocationBehavior$outboundSchema,
+} from "./entitlement-grant-allocation-behavior.js";
+import {
+  EntitlementGrantDurationUnit,
+  EntitlementGrantDurationUnit$outboundSchema,
+} from "./entitlement-grant-duration-unit.js";
+
+export type CreateSubscriptionEntitlementGrantRequest = {
+  aggregationMode?: EntitlementAggregationMode | undefined;
+  endDate?: Date | undefined;
+  grantAllocationBehavior?: EntitlementGrantAllocationBehavior | undefined;
+  grantDurationUnit: EntitlementGrantDurationUnit;
+  grantDurationValue?: number | undefined;
+  grantQuota: string;
+  /**
+   * StartDate defaults to the subscription's start; EndDate leaves the grant open.
+   */
+  startDate?: Date | undefined;
+};
+
+/** @internal */
+export type CreateSubscriptionEntitlementGrantRequest$Outbound = {
+  aggregation_mode?: string | undefined;
+  end_date?: string | undefined;
+  grant_allocation_behavior?: string | undefined;
+  grant_duration_unit: string;
+  grant_duration_value?: number | undefined;
+  grant_quota: string;
+  start_date?: string | undefined;
+};
+
+/** @internal */
+export const CreateSubscriptionEntitlementGrantRequest$outboundSchema:
+  z.ZodMiniType<
+    CreateSubscriptionEntitlementGrantRequest$Outbound,
+    CreateSubscriptionEntitlementGrantRequest
+  > = z.pipe(
+    z.object({
+      aggregationMode: z.optional(EntitlementAggregationMode$outboundSchema),
+      endDate: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+      grantAllocationBehavior: z.optional(
+        EntitlementGrantAllocationBehavior$outboundSchema,
+      ),
+      grantDurationUnit: EntitlementGrantDurationUnit$outboundSchema,
+      grantDurationValue: z.optional(z.int()),
+      grantQuota: z.string(),
+      startDate: z.optional(
+        z.pipe(z.date(), z.transform(v => v.toISOString())),
+      ),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        aggregationMode: "aggregation_mode",
+        endDate: "end_date",
+        grantAllocationBehavior: "grant_allocation_behavior",
+        grantDurationUnit: "grant_duration_unit",
+        grantDurationValue: "grant_duration_value",
+        grantQuota: "grant_quota",
+        startDate: "start_date",
+      });
+    }),
+  );
+
+export function createSubscriptionEntitlementGrantRequestToJSON(
+  createSubscriptionEntitlementGrantRequest:
+    CreateSubscriptionEntitlementGrantRequest,
+): string {
+  return JSON.stringify(
+    CreateSubscriptionEntitlementGrantRequest$outboundSchema.parse(
+      createSubscriptionEntitlementGrantRequest,
+    ),
+  );
+}