@tirdad/sdk 2.1.43 → 2.1.45

package/src/sdk/models/trigger-force-run-request.ts

@@ -6,12 +6,17 @@ import * as z from "zod/v4-mini";
 import { remap as remap$ } from "../../lib/primitives.js";
 
 export type TriggerForceRunRequest = {
+  /**
+   * Limits a wallet_ledger export to these customers; empty means every customer.
+   */
+  customerExternalIds: Array<string>;
   endTime?: Date | undefined;
   startTime?: Date | undefined;
 };
 
 /** @internal */
 export type TriggerForceRunRequest$Outbound = {
+  customer_external_ids: Array<string>;
   end_time?: string | undefined;
   start_time?: string | undefined;
 };
@@ -22,11 +27,13 @@ export const TriggerForceRunRequest$outboundSchema: z.ZodMiniType<
   TriggerForceRunRequest
 > = z.pipe(
   z.object({
+    customerExternalIds: z.array(z.string()),
     endTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
     startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
   }),
   z.transform((v) => {
     return remap$(v, {
+      customerExternalIds: "customer_external_ids",
       endTime: "end_time",
       startTime: "start_time",
     });

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

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  UpdateCommitmentRequest,
+  UpdateCommitmentRequest$Outbound,
+  UpdateCommitmentRequest$outboundSchema,
+} from "./update-commitment-request.js";
+
+export type UpdateCommitmentRequestRequest = {
+  /**
+   * Commitment ID
+   */
+  id: string;
+  /**
+   * Commitment update
+   */
+  body: UpdateCommitmentRequest;
+};
+
+/** @internal */
+export type UpdateCommitmentRequestRequest$Outbound = {
+  id: string;
+  body: UpdateCommitmentRequest$Outbound;
+};
+
+/** @internal */
+export const UpdateCommitmentRequestRequest$outboundSchema: z.ZodMiniType<
+  UpdateCommitmentRequestRequest$Outbound,
+  UpdateCommitmentRequestRequest
+> = z.object({
+  id: z.string(),
+  body: UpdateCommitmentRequest$outboundSchema,
+});
+
+export function updateCommitmentRequestRequestToJSON(
+  updateCommitmentRequestRequest: UpdateCommitmentRequestRequest,
+): string {
+  return JSON.stringify(
+    UpdateCommitmentRequestRequest$outboundSchema.parse(
+      updateCommitmentRequestRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,48 @@
+/*
+ * 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 UpdateCommitmentRequest = {
+  invoiceDescription?: string | undefined;
+  invoiceLabel?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export type UpdateCommitmentRequest$Outbound = {
+  invoice_description?: string | undefined;
+  invoice_label?: string | undefined;
+  metadata?: { [k: string]: string } | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const UpdateCommitmentRequest$outboundSchema: z.ZodMiniType<
+  UpdateCommitmentRequest$Outbound,
+  UpdateCommitmentRequest
+> = z.pipe(
+  z.object({
+    invoiceDescription: z.optional(z.string()),
+    invoiceLabel: z.optional(z.string()),
+    metadata: z.optional(z.record(z.string(), z.string())),
+    name: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      invoiceDescription: "invoice_description",
+      invoiceLabel: "invoice_label",
+    });
+  }),
+);
+
+export function updateCommitmentRequestToJSON(
+  updateCommitmentRequest: UpdateCommitmentRequest,
+): string {
+  return JSON.stringify(
+    UpdateCommitmentRequest$outboundSchema.parse(updateCommitmentRequest),
+  );
+}

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

@@ -37,6 +37,9 @@ export type UpdateEntitlementRequest = {
   isEnabled?: boolean | undefined;
   isSoftLimit?: boolean | undefined;
   staticValue?: string | undefined;
+  /**
+   * Deprecated: use grant_quota.
+   */
   usageLimit?: number | undefined;
   usageResetPeriod?: EntitlementUsageResetPeriod | undefined;
 };

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

@@ -53,6 +53,10 @@ export type UpdatePriceRequest = {
    * PriceUnitTiers are the price unit tiers (for CUSTOM price unit type, TIERED billing model)
    */
   priceUnitTiers?: Array<CreatePriceTier> | undefined;
+  /**
+   * ProductID sets the price's product while it has none; once set it never changes.
+   */
+  productId?: string | undefined;
   tierMode?: BillingTier | undefined;
   /**
    * Tiers determines the pricing tiers for this line item
@@ -74,6 +78,7 @@ export type UpdatePriceRequest$Outbound = {
   metadata?: { [k: string]: string } | undefined;
   price_unit_amount?: string | undefined;
   price_unit_tiers?: Array<CreatePriceTier$Outbound> | undefined;
+  product_id?: string | undefined;
   tier_mode?: string | undefined;
   tiers?: Array<CreatePriceTier$Outbound> | undefined;
   transform_quantity?: PriceTransformQuantity$Outbound | undefined;
@@ -96,6 +101,7 @@ export const UpdatePriceRequest$outboundSchema: z.ZodMiniType<
     metadata: z.optional(z.record(z.string(), z.string())),
     priceUnitAmount: z.optional(z.string()),
     priceUnitTiers: z.optional(z.array(CreatePriceTier$outboundSchema)),
+    productId: z.optional(z.string()),
     tierMode: z.optional(BillingTier$outboundSchema),
     tiers: z.optional(z.array(CreatePriceTier$outboundSchema)),
     transformQuantity: z.optional(PriceTransformQuantity$outboundSchema),
@@ -110,6 +116,7 @@ export const UpdatePriceRequest$outboundSchema: z.ZodMiniType<
       lookupKey: "lookup_key",
       priceUnitAmount: "price_unit_amount",
       priceUnitTiers: "price_unit_tiers",
+      productId: "product_id",
       tierMode: "tier_mode",
       transformQuantity: "transform_quantity",
     });

package/src/sdk/models/update-product-op.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import {
+  UpdateProductRequest,
+  UpdateProductRequest$Outbound,
+  UpdateProductRequest$outboundSchema,
+} from "./update-product-request.js";
+
+export type UpdateProductRequestRequest = {
+  /**
+   * Product ID
+   */
+  id: string;
+  /**
+   * Update Product Request
+   */
+  body: UpdateProductRequest;
+};
+
+/** @internal */
+export type UpdateProductRequestRequest$Outbound = {
+  id: string;
+  body: UpdateProductRequest$Outbound;
+};
+
+/** @internal */
+export const UpdateProductRequestRequest$outboundSchema: z.ZodMiniType<
+  UpdateProductRequestRequest$Outbound,
+  UpdateProductRequestRequest
+> = z.object({
+  id: z.string(),
+  body: UpdateProductRequest$outboundSchema,
+});
+
+export function updateProductRequestRequestToJSON(
+  updateProductRequestRequest: UpdateProductRequestRequest,
+): string {
+  return JSON.stringify(
+    UpdateProductRequestRequest$outboundSchema.parse(
+      updateProductRequestRequest,
+    ),
+  );
+}

package/src/sdk/models/update-product-request.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+
+export type UpdateProductRequest = {
+  description?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export type UpdateProductRequest$Outbound = {
+  description?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const UpdateProductRequest$outboundSchema: z.ZodMiniType<
+  UpdateProductRequest$Outbound,
+  UpdateProductRequest
+> = z.object({
+  description: z.optional(z.string()),
+  name: z.optional(z.string()),
+});
+
+export function updateProductRequestToJSON(
+  updateProductRequest: UpdateProductRequest,
+): string {
+  return JSON.stringify(
+    UpdateProductRequest$outboundSchema.parse(updateProductRequest),
+  );
+}

package/src/sdk/models/waterfall-cell.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 {
+  RevenueBreakdown,
+  RevenueBreakdown$inboundSchema,
+} from "./revenue-breakdown.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type WaterfallCell = {
+  /**
+   * details: closing deferred_revenue, ended months only
+   */
+  deferred?: string | undefined;
+  /**
+   * YYYY-MM
+   */
+  period?: string | undefined;
+  revenue?: RevenueBreakdown | undefined;
+  /**
+   * details: closing unbilled_receivable, ended months only
+   */
+  unbilled?: string | undefined;
+};
+
+/** @internal */
+export const WaterfallCell$inboundSchema: z.ZodMiniType<
+  WaterfallCell,
+  unknown
+> = z.object({
+  deferred: types.optional(types.string()),
+  period: types.optional(types.string()),
+  revenue: types.optional(RevenueBreakdown$inboundSchema),
+  unbilled: types.optional(types.string()),
+});
+
+export function waterfallCellFromJSON(
+  jsonString: string,
+): SafeParseResult<WaterfallCell, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WaterfallCell$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WaterfallCell' from JSON`,
+  );
+}

package/src/sdk/models/waterfall-request.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 {
+  RevenueReportGroupBy,
+  RevenueReportGroupBy$outboundSchema,
+} from "./revenue-report-group-by.js";
+
+export type WaterfallRequest = {
+  /**
+   * report date: pending and scheduled split here; defaults to now
+   */
+  asOf?: string | undefined;
+  contractIds?: Array<string> | undefined;
+  currency: string;
+  customerIds?: Array<string> | undefined;
+  /**
+   * month-end deferred and unbilled balances
+   */
+  details?: boolean | undefined;
+  groupBy?: RevenueReportGroupBy | undefined;
+  /**
+   * rows per page; totals are never paged
+   */
+  limit?: number | undefined;
+  offset?: number | undefined;
+  /**
+   * YYYY-MM, at most 36 months from period_start
+   */
+  periodEnd: Date;
+  /**
+   * YYYY-MM
+   */
+  periodStart: Date;
+  pobIds?: Array<string> | undefined;
+};
+
+/** @internal */
+export type WaterfallRequest$Outbound = {
+  as_of?: string | undefined;
+  contract_ids?: Array<string> | undefined;
+  currency: string;
+  customer_ids?: Array<string> | undefined;
+  details?: boolean | undefined;
+  group_by?: string | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  period_end: string;
+  period_start: string;
+  pob_ids?: Array<string> | undefined;
+};
+
+/** @internal */
+export const WaterfallRequest$outboundSchema: z.ZodMiniType<
+  WaterfallRequest$Outbound,
+  WaterfallRequest
+> = z.pipe(
+  z.object({
+    asOf: z.optional(z.string()),
+    contractIds: z.optional(z.array(z.string())),
+    currency: z.string(),
+    customerIds: z.optional(z.array(z.string())),
+    details: z.optional(z.boolean()),
+    groupBy: z.optional(RevenueReportGroupBy$outboundSchema),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    periodEnd: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    periodStart: z.pipe(z.date(), z.transform(v => v.toISOString())),
+    pobIds: z.optional(z.array(z.string())),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      asOf: "as_of",
+      contractIds: "contract_ids",
+      customerIds: "customer_ids",
+      groupBy: "group_by",
+      periodEnd: "period_end",
+      periodStart: "period_start",
+      pobIds: "pob_ids",
+    });
+  }),
+);
+
+export function waterfallRequestToJSON(
+  waterfallRequest: WaterfallRequest,
+): string {
+  return JSON.stringify(
+    WaterfallRequest$outboundSchema.parse(waterfallRequest),
+  );
+}

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

@@ -0,0 +1,47 @@
+/*
+ * 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 {
+  PaginationResponse,
+  PaginationResponse$inboundSchema,
+} from "./pagination-response.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  WaterfallCell,
+  WaterfallCell$inboundSchema,
+} from "./waterfall-cell.js";
+import { WaterfallRow, WaterfallRow$inboundSchema } from "./waterfall-row.js";
+
+export type WaterfallResponse = {
+  items?: Array<WaterfallRow> | undefined;
+  pagination?: PaginationResponse | undefined;
+  /**
+   * per period over all rows, never paged
+   */
+  totals?: Array<WaterfallCell> | undefined;
+};
+
+/** @internal */
+export const WaterfallResponse$inboundSchema: z.ZodMiniType<
+  WaterfallResponse,
+  unknown
+> = z.object({
+  items: types.optional(z.array(WaterfallRow$inboundSchema)),
+  pagination: types.optional(PaginationResponse$inboundSchema),
+  totals: types.optional(z.array(WaterfallCell$inboundSchema)),
+});
+
+export function waterfallResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<WaterfallResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WaterfallResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WaterfallResponse' from JSON`,
+  );
+}

package/src/sdk/models/waterfall-row.ts

@@ -0,0 +1,52 @@
+/*
+ * 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";
+import {
+  WaterfallCell,
+  WaterfallCell$inboundSchema,
+} from "./waterfall-cell.js";
+
+export type WaterfallRow = {
+  /**
+   * one per requested period, in order
+   */
+  cells?: Array<WaterfallCell> | undefined;
+  contractId?: string | undefined;
+  customerId?: string | undefined;
+  pobId?: string | undefined;
+};
+
+/** @internal */
+export const WaterfallRow$inboundSchema: z.ZodMiniType<WaterfallRow, unknown> =
+  z.pipe(
+    z.object({
+      cells: types.optional(z.array(WaterfallCell$inboundSchema)),
+      contract_id: types.optional(types.string()),
+      customer_id: types.optional(types.string()),
+      pob_id: types.optional(types.string()),
+    }),
+    z.transform((v) => {
+      return remap$(v, {
+        "contract_id": "contractId",
+        "customer_id": "customerId",
+        "pob_id": "pobId",
+      });
+    }),
+  );
+
+export function waterfallRowFromJSON(
+  jsonString: string,
+): SafeParseResult<WaterfallRow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WaterfallRow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WaterfallRow' from JSON`,
+  );
+}

package/src/sdk/models/webhook-dto-commitment-webhook-payload.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 {
+  CommitmentResponse,
+  CommitmentResponse$inboundSchema,
+} from "./commitment-response.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  WebhookEventName,
+  WebhookEventName$inboundSchema,
+} from "./webhook-event-name.js";
+
+export type WebhookDtoCommitmentWebhookPayload = {
+  commitment?: CommitmentResponse | undefined;
+  eventType?: WebhookEventName | undefined;
+};
+
+/** @internal */
+export const WebhookDtoCommitmentWebhookPayload$inboundSchema: z.ZodMiniType<
+  WebhookDtoCommitmentWebhookPayload,
+  unknown
+> = z.pipe(
+  z.object({
+    commitment: types.optional(CommitmentResponse$inboundSchema),
+    event_type: types.optional(WebhookEventName$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "event_type": "eventType",
+    });
+  }),
+);
+
+export function webhookDtoCommitmentWebhookPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<WebhookDtoCommitmentWebhookPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      WebhookDtoCommitmentWebhookPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WebhookDtoCommitmentWebhookPayload' from JSON`,
+  );
+}

package/src/sdk/models/webhook-event-name.ts

@@ -25,6 +25,9 @@ export const WebhookEventName = {
   EntitlementCreated: "entitlement.created",
   EntitlementUpdated: "entitlement.updated",
   EntitlementDeleted: "entitlement.deleted",
+  CommitmentCreated: "commitment.created",
+  CommitmentUpdated: "commitment.updated",
+  CommitmentTerminated: "commitment.terminated",
   WalletCreated: "wallet.created",
   WalletUpdated: "wallet.updated",
   WalletTerminated: "wallet.terminated",

package/src/sdk/models/zoho-pay-pal-payment-method.ts

@@ -0,0 +1,19 @@
+/*
+ * 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 ZohoPayPalPaymentMethod = {
+  Standard: "standard",
+  Adaptive: "adaptive",
+} as const;
+export type ZohoPayPalPaymentMethod = OpenEnum<typeof ZohoPayPalPaymentMethod>;
+
+/** @internal */
+export const ZohoPayPalPaymentMethod$inboundSchema: z.ZodMiniType<
+  ZohoPayPalPaymentMethod,
+  unknown
+> = openEnums.inboundSchema(ZohoPayPalPaymentMethod);

package/src/sdk/models/zoho-payment-gateway-settings.ts

@@ -0,0 +1,53 @@
+/*
+ * 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";
+import {
+  ZohoPayPalPaymentMethod,
+  ZohoPayPalPaymentMethod$inboundSchema,
+} from "./zoho-pay-pal-payment-method.js";
+import {
+  ZohoPaymentGateway,
+  ZohoPaymentGateway$inboundSchema,
+} from "./zoho-payment-gateway.js";
+
+export type ZohoPaymentGatewaySettings = {
+  enabled?: boolean | undefined;
+  gateways?: Array<ZohoPaymentGateway> | undefined;
+  paypalPaymentMethod?: ZohoPayPalPaymentMethod | undefined;
+};
+
+/** @internal */
+export const ZohoPaymentGatewaySettings$inboundSchema: z.ZodMiniType<
+  ZohoPaymentGatewaySettings,
+  unknown
+> = z.pipe(
+  z.object({
+    enabled: types.optional(types.boolean()),
+    gateways: types.optional(z.array(ZohoPaymentGateway$inboundSchema)),
+    paypal_payment_method: types.optional(
+      ZohoPayPalPaymentMethod$inboundSchema,
+    ),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "paypal_payment_method": "paypalPaymentMethod",
+    });
+  }),
+);
+
+export function zohoPaymentGatewaySettingsFromJSON(
+  jsonString: string,
+): SafeParseResult<ZohoPaymentGatewaySettings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ZohoPaymentGatewaySettings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ZohoPaymentGatewaySettings' from JSON`,
+  );
+}

package/src/sdk/models/zoho-payment-gateway.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 ZohoPaymentGateway = {
+  Paypal: "paypal",
+  Stripe: "stripe",
+  AuthorizeNet: "authorize_net",
+  PayflowPro: "payflow_pro",
+  Twocheckout: "2checkout",
+  Braintree: "braintree",
+  Razorpay: "razorpay",
+} as const;
+export type ZohoPaymentGateway = OpenEnum<typeof ZohoPaymentGateway>;
+
+/** @internal */
+export const ZohoPaymentGateway$inboundSchema: z.ZodMiniType<
+  ZohoPaymentGateway,
+  unknown
+> = openEnums.inboundSchema(ZohoPaymentGateway);