@tirdad/sdk 2.1.44 → 2.1.45

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

@@ -0,0 +1,97 @@
+/*
+ * 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 {
+  LedgerAccountKey,
+  LedgerAccountKey$outboundSchema,
+} from "./ledger-account-key.js";
+import {
+  RevenueReportGroupBy,
+  RevenueReportGroupBy$outboundSchema,
+} from "./revenue-report-group-by.js";
+
+export type RollforwardRequest = {
+  /**
+   * defaults to [deferred_revenue]
+   */
+  accounts?: Array<LedgerAccountKey> | undefined;
+  contractIds?: Array<string> | undefined;
+  currency: string;
+  customerIds?: Array<string> | undefined;
+  groupBy?: Array<RevenueReportGroupBy> | undefined;
+  /**
+   * item rows per page; totals are never paged
+   */
+  limit?: number | undefined;
+  offset?: number | undefined;
+  /**
+   * YYYY-MM, an ended month; defaults to period_start
+   */
+  periodEnd?: Date | undefined;
+  /**
+   * YYYY-MM
+   */
+  periodStart: Date;
+  pobIds?: Array<string> | undefined;
+  /**
+   * only entries posted at or before it: the books as they were then
+   */
+  postedBy?: string | undefined;
+};
+
+/** @internal */
+export type RollforwardRequest$Outbound = {
+  accounts?: Array<string> | undefined;
+  contract_ids?: Array<string> | undefined;
+  currency: string;
+  customer_ids?: Array<string> | undefined;
+  group_by?: Array<string> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  period_end?: string | undefined;
+  period_start: string;
+  pob_ids?: Array<string> | undefined;
+  posted_by?: string | undefined;
+};
+
+/** @internal */
+export const RollforwardRequest$outboundSchema: z.ZodMiniType<
+  RollforwardRequest$Outbound,
+  RollforwardRequest
+> = z.pipe(
+  z.object({
+    accounts: z.optional(z.array(LedgerAccountKey$outboundSchema)),
+    contractIds: z.optional(z.array(z.string())),
+    currency: z.string(),
+    customerIds: z.optional(z.array(z.string())),
+    groupBy: z.optional(z.array(RevenueReportGroupBy$outboundSchema)),
+    limit: z.optional(z.int()),
+    offset: z.optional(z.int()),
+    periodEnd: z.optional(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())),
+    postedBy: z.optional(z.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      contractIds: "contract_ids",
+      customerIds: "customer_ids",
+      groupBy: "group_by",
+      periodEnd: "period_end",
+      periodStart: "period_start",
+      pobIds: "pob_ids",
+      postedBy: "posted_by",
+    });
+  }),
+);
+
+export function rollforwardRequestToJSON(
+  rollforwardRequest: RollforwardRequest,
+): string {
+  return JSON.stringify(
+    RollforwardRequest$outboundSchema.parse(rollforwardRequest),
+  );
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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 {
+  RollforwardRow,
+  RollforwardRow$inboundSchema,
+} from "./rollforward-row.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type RollforwardResponse = {
+  /**
+   * per period, account and group; empty without group_by
+   */
+  items?: Array<RollforwardRow> | undefined;
+  pagination?: PaginationResponse | undefined;
+  /**
+   * per period and account, all groups
+   */
+  totals?: Array<RollforwardRow> | undefined;
+};
+
+/** @internal */
+export const RollforwardResponse$inboundSchema: z.ZodMiniType<
+  RollforwardResponse,
+  unknown
+> = z.object({
+  items: types.optional(z.array(RollforwardRow$inboundSchema)),
+  pagination: types.optional(PaginationResponse$inboundSchema),
+  totals: types.optional(z.array(RollforwardRow$inboundSchema)),
+});
+
+export function rollforwardResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<RollforwardResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RollforwardResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RollforwardResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * 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 {
+  LedgerAccountKey,
+  LedgerAccountKey$inboundSchema,
+} from "./ledger-account-key.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type RollforwardRow = {
+  account?: LedgerAccountKey | undefined;
+  closing?: string | undefined;
+  contractId?: string | undefined;
+  customerId?: string | undefined;
+  /**
+   * a missing category is 0
+   */
+  movements?: { [k: string]: string } | undefined;
+  opening?: string | undefined;
+  /**
+   * YYYY-MM
+   */
+  period?: string | undefined;
+  pobId?: string | undefined;
+};
+
+/** @internal */
+export const RollforwardRow$inboundSchema: z.ZodMiniType<
+  RollforwardRow,
+  unknown
+> = z.pipe(
+  z.object({
+    account: types.optional(LedgerAccountKey$inboundSchema),
+    closing: types.optional(types.string()),
+    contract_id: types.optional(types.string()),
+    customer_id: types.optional(types.string()),
+    movements: types.optional(z.record(z.string(), types.string())),
+    opening: types.optional(types.string()),
+    period: 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 rollforwardRowFromJSON(
+  jsonString: string,
+): SafeParseResult<RollforwardRow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RollforwardRow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RollforwardRow' from JSON`,
+  );
+}

package/src/sdk/models/subscription-entitlement-grants-response.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 {
+  EntitlementResponse,
+  EntitlementResponse$inboundSchema,
+} from "./entitlement-response.js";
+import { GrantState, GrantState$inboundSchema } from "./grant-state.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+
+export type SubscriptionEntitlementGrantsResponse = {
+  entitlements?: Array<EntitlementResponse> | undefined;
+  grantState?: GrantState | undefined;
+};
+
+/** @internal */
+export const SubscriptionEntitlementGrantsResponse$inboundSchema: z.ZodMiniType<
+  SubscriptionEntitlementGrantsResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    entitlements: types.optional(z.array(EntitlementResponse$inboundSchema)),
+    grant_state: types.optional(GrantState$inboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "grant_state": "grantState",
+    });
+  }),
+);
+
+export function subscriptionEntitlementGrantsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriptionEntitlementGrantsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SubscriptionEntitlementGrantsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriptionEntitlementGrantsResponse' from JSON`,
+  );
+}

package/src/sdk/models/subscription-entitlements-response.ts

@@ -12,10 +12,17 @@ import {
   AggregatedFeature$inboundSchema,
 } from "./aggregated-feature.js";
 import { SDKValidationError } from "./sdk-validation-error.js";
+import {
+  SubscriptionEntitlementGrantsResponse,
+  SubscriptionEntitlementGrantsResponse$inboundSchema,
+} from "./subscription-entitlement-grants-response.js";
 
 export type SubscriptionEntitlementsResponse = {
   features?: Array<AggregatedFeature> | undefined;
   planId?: string | undefined;
+  subscriptionEntitlementGrants?:
+    | SubscriptionEntitlementGrantsResponse
+    | undefined;
   subscriptionId?: string | undefined;
 };
 
@@ -27,11 +34,15 @@ export const SubscriptionEntitlementsResponse$inboundSchema: z.ZodMiniType<
   z.object({
     features: types.optional(z.array(AggregatedFeature$inboundSchema)),
     plan_id: types.optional(types.string()),
+    subscription_entitlement_grants: types.optional(
+      SubscriptionEntitlementGrantsResponse$inboundSchema,
+    ),
     subscription_id: types.optional(types.string()),
   }),
   z.transform((v) => {
     return remap$(v, {
       "plan_id": "planId",
+      "subscription_entitlement_grants": "subscriptionEntitlementGrants",
       "subscription_id": "subscriptionId",
     });
   }),

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`,
+  );
+}