@tirdad/sdk 2.1.44 → 2.1.45

package/src/sdk/models/performance-obligation-association-response.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 PerformanceObligationAssociationResponse = {
+  createdAt?: Date | undefined;
+  entityId?: string | undefined;
+  entityType?: RevRecEntityType | undefined;
+  id?: string | undefined;
+};
+
+/** @internal */
+export const PerformanceObligationAssociationResponse$inboundSchema:
+  z.ZodMiniType<PerformanceObligationAssociationResponse, 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 performanceObligationAssociationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PerformanceObligationAssociationResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PerformanceObligationAssociationResponse$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PerformanceObligationAssociationResponse' from JSON`,
+  );
+}

package/src/sdk/models/performance-obligation-response.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 {
+  AmortizationMethod,
+  AmortizationMethod$inboundSchema,
+} from "./amortization-method.js";
+import {
+  PerformanceObligationAssociationResponse,
+  PerformanceObligationAssociationResponse$inboundSchema,
+} from "./performance-obligation-association-response.js";
+import {
+  PerformanceObligationStatus,
+  PerformanceObligationStatus$inboundSchema,
+} from "./performance-obligation-status.js";
+import {
+  RecognitionMethod,
+  RecognitionMethod$inboundSchema,
+} from "./recognition-method.js";
+import { SDKValidationError } from "./sdk-validation-error.js";
+import { Status, Status$inboundSchema } from "./status.js";
+
+export type PerformanceObligationResponse = {
+  amortizationMethod?: AmortizationMethod | undefined;
+  associations?: Array<PerformanceObligationAssociationResponse> | undefined;
+  contractId?: string | undefined;
+  createdAt?: Date | undefined;
+  id?: string | undefined;
+  name?: string | undefined;
+  pobStatus?: PerformanceObligationStatus | undefined;
+  recognitionMethod?: RecognitionMethod | undefined;
+  serviceEnd?: Date | undefined;
+  serviceStart?: Date | undefined;
+  status?: Status | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const PerformanceObligationResponse$inboundSchema: z.ZodMiniType<
+  PerformanceObligationResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    amortization_method: types.optional(AmortizationMethod$inboundSchema),
+    associations: types.optional(
+      z.array(PerformanceObligationAssociationResponse$inboundSchema),
+    ),
+    contract_id: types.optional(types.string()),
+    created_at: types.optional(types.date()),
+    id: types.optional(types.string()),
+    name: types.optional(types.string()),
+    pob_status: types.optional(PerformanceObligationStatus$inboundSchema),
+    recognition_method: types.optional(RecognitionMethod$inboundSchema),
+    service_end: types.optional(types.date()),
+    service_start: types.optional(types.date()),
+    status: types.optional(Status$inboundSchema),
+    updated_at: types.optional(types.date()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "amortization_method": "amortizationMethod",
+      "contract_id": "contractId",
+      "created_at": "createdAt",
+      "pob_status": "pobStatus",
+      "recognition_method": "recognitionMethod",
+      "service_end": "serviceEnd",
+      "service_start": "serviceStart",
+      "updated_at": "updatedAt",
+    });
+  }),
+);
+
+export function performanceObligationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PerformanceObligationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PerformanceObligationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PerformanceObligationResponse' from JSON`,
+  );
+}

package/src/sdk/models/performance-obligation-status.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 PerformanceObligationStatus = {
+  Draft: "draft",
+  Active: "active",
+  Satisfied: "satisfied",
+  Cancelled: "cancelled",
+} as const;
+export type PerformanceObligationStatus = OpenEnum<
+  typeof PerformanceObligationStatus
+>;
+
+/** @internal */
+export const PerformanceObligationStatus$inboundSchema: z.ZodMiniType<
+  PerformanceObligationStatus,
+  unknown
+> = openEnums.inboundSchema(PerformanceObligationStatus);
+/** @internal */
+export const PerformanceObligationStatus$outboundSchema: z.ZodMiniType<
+  string,
+  PerformanceObligationStatus
+> = openEnums.outboundSchema(PerformanceObligationStatus);

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

@@ -0,0 +1,112 @@
+/*
+ * 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 {
+  FilterCondition,
+  FilterCondition$Outbound,
+  FilterCondition$outboundSchema,
+} from "./filter-condition.js";
+import {
+  PerformanceObligationStatus,
+  PerformanceObligationStatus$outboundSchema,
+} from "./performance-obligation-status.js";
+import {
+  RecognitionMethod,
+  RecognitionMethod$outboundSchema,
+} from "./recognition-method.js";
+import {
+  SortCondition,
+  SortCondition$Outbound,
+  SortCondition$outboundSchema,
+} from "./sort-condition.js";
+import { Status, Status$outboundSchema } from "./status.js";
+
+export const PobFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type PobFilterOrder = ClosedEnum<typeof PobFilterOrder>;
+
+export type PobFilter = {
+  contractIds?: Array<string> | undefined;
+  customerIds?: Array<string> | undefined;
+  endTime?: Date | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: PobFilterOrder | undefined;
+  performanceObligationIds?: Array<string> | undefined;
+  pobStatuses?: Array<PerformanceObligationStatus> | undefined;
+  recognitionMethods?: Array<RecognitionMethod> | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+};
+
+/** @internal */
+export const PobFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof PobFilterOrder
+> = z.enum(PobFilterOrder);
+
+/** @internal */
+export type PobFilter$Outbound = {
+  contract_ids?: Array<string> | undefined;
+  customer_ids?: Array<string> | undefined;
+  end_time?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  limit?: number | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  performance_obligation_ids?: Array<string> | undefined;
+  pob_statuses?: Array<string> | undefined;
+  recognition_methods?: Array<string> | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+};
+
+/** @internal */
+export const PobFilter$outboundSchema: z.ZodMiniType<
+  PobFilter$Outbound,
+  PobFilter
+> = z.pipe(
+  z.object({
+    contractIds: z.optional(z.array(z.string())),
+    customerIds: z.optional(z.array(z.string())),
+    endTime: 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(PobFilterOrder$outboundSchema),
+    performanceObligationIds: z.optional(z.array(z.string())),
+    pobStatuses: z.optional(
+      z.array(PerformanceObligationStatus$outboundSchema),
+    ),
+    recognitionMethods: z.optional(z.array(RecognitionMethod$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),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      contractIds: "contract_ids",
+      customerIds: "customer_ids",
+      endTime: "end_time",
+      performanceObligationIds: "performance_obligation_ids",
+      pobStatuses: "pob_statuses",
+      recognitionMethods: "recognition_methods",
+      startTime: "start_time",
+    });
+  }),
+);
+
+export function pobFilterToJSON(pobFilter: PobFilter): string {
+  return JSON.stringify(PobFilter$outboundSchema.parse(pobFilter));
+}

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

@@ -47,6 +47,7 @@ export type PriceFilter = {
    */
   planIds?: Array<string> | undefined;
   priceIds?: Array<string> | undefined;
+  productIds?: Array<string> | undefined;
   sort?: string | undefined;
   startDateLt?: string | undefined;
   startTime?: Date | undefined;
@@ -83,6 +84,7 @@ export type PriceFilter$Outbound = {
   parent_price_id?: string | undefined;
   plan_ids?: Array<string> | undefined;
   price_ids?: Array<string> | undefined;
+  product_ids?: Array<string> | undefined;
   sort?: string | undefined;
   start_date_lt?: string | undefined;
   start_time?: string | undefined;
@@ -111,6 +113,7 @@ export const PriceFilter$outboundSchema: z.ZodMiniType<
     parentPriceId: z.optional(z.string()),
     planIds: z.optional(z.array(z.string())),
     priceIds: z.optional(z.array(z.string())),
+    productIds: z.optional(z.array(z.string())),
     sort: z.optional(z.string()),
     startDateLt: z.optional(z.string()),
     startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
@@ -129,6 +132,7 @@ export const PriceFilter$outboundSchema: z.ZodMiniType<
       parentPriceId: "parent_price_id",
       planIds: "plan_ids",
       priceIds: "price_ids",
+      productIds: "product_ids",
       startDateLt: "start_date_lt",
       startTime: "start_time",
       subscriptionId: "subscription_id",

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

@@ -143,6 +143,7 @@ export type PricePrice = {
    */
   priceUnitTiers?: Array<PricePriceTier> | undefined;
   priceUnitType?: PriceUnitType | undefined;
+  productId?: string | undefined;
   /**
    * Sequence is the monotonic stamp bumped on every state change that
    *
@@ -208,6 +209,7 @@ export const PricePrice$inboundSchema: z.ZodMiniType<PricePrice, unknown> = z
       price_unit_id: types.optional(types.string()),
       price_unit_tiers: types.optional(z.array(PricePriceTier$inboundSchema)),
       price_unit_type: types.optional(PriceUnitType$inboundSchema),
+      product_id: types.optional(types.string()),
       sequence: types.optional(types.number()),
       start_date: types.optional(types.date()),
       status: types.optional(Status$inboundSchema),
@@ -250,6 +252,7 @@ export const PricePrice$inboundSchema: z.ZodMiniType<PricePrice, unknown> = z
         "price_unit_id": "priceUnitId",
         "price_unit_tiers": "priceUnitTiers",
         "price_unit_type": "priceUnitType",
+        "product_id": "productId",
         "start_date": "startDate",
         "tenant_id": "tenantId",
         "tier_mode": "tierMode",

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

@@ -170,6 +170,7 @@ export type PriceResponse = {
   priceUnitTiers?: Array<PricePriceTier> | undefined;
   priceUnitType?: PriceUnitType | undefined;
   pricingUnit?: PriceUnitResponse | undefined;
+  productId?: string | undefined;
   /**
    * Sequence is the monotonic stamp bumped on every state change that
    *
@@ -243,6 +244,7 @@ export const PriceResponse$inboundSchema: z.ZodMiniType<
     price_unit_tiers: types.optional(z.array(PricePriceTier$inboundSchema)),
     price_unit_type: types.optional(PriceUnitType$inboundSchema),
     pricing_unit: types.optional(PriceUnitResponse$inboundSchema),
+    product_id: types.optional(types.string()),
     sequence: types.optional(types.number()),
     start_date: types.optional(types.date()),
     status: types.optional(Status$inboundSchema),
@@ -286,6 +288,7 @@ export const PriceResponse$inboundSchema: z.ZodMiniType<
       "price_unit_tiers": "priceUnitTiers",
       "price_unit_type": "priceUnitType",
       "pricing_unit": "pricingUnit",
+      "product_id": "productId",
       "start_date": "startDate",
       "tenant_id": "tenantId",
       "tier_mode": "tierMode",

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

@@ -0,0 +1,90 @@
+/*
+ * 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 {
+  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 ProductFilterOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type ProductFilterOrder = ClosedEnum<typeof ProductFilterOrder>;
+
+export type ProductFilter = {
+  endTime?: Date | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition> | undefined;
+  limit?: number | undefined;
+  lookupKeys?: Array<string> | undefined;
+  offset?: number | undefined;
+  order?: ProductFilterOrder | undefined;
+  productIds?: Array<string> | undefined;
+  sort?: Array<SortCondition> | undefined;
+  startTime?: Date | undefined;
+  status?: Status | undefined;
+};
+
+/** @internal */
+export const ProductFilterOrder$outboundSchema: z.ZodMiniEnum<
+  typeof ProductFilterOrder
+> = z.enum(ProductFilterOrder);
+
+/** @internal */
+export type ProductFilter$Outbound = {
+  end_time?: string | undefined;
+  expand?: string | undefined;
+  filters?: Array<FilterCondition$Outbound> | undefined;
+  limit?: number | undefined;
+  lookup_keys?: Array<string> | undefined;
+  offset?: number | undefined;
+  order?: string | undefined;
+  product_ids?: Array<string> | undefined;
+  sort?: Array<SortCondition$Outbound> | undefined;
+  start_time?: string | undefined;
+  status?: string | undefined;
+};
+
+/** @internal */
+export const ProductFilter$outboundSchema: z.ZodMiniType<
+  ProductFilter$Outbound,
+  ProductFilter
+> = z.pipe(
+  z.object({
+    endTime: 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()),
+    lookupKeys: z.optional(z.array(z.string())),
+    offset: z.optional(z.int()),
+    order: z.optional(ProductFilterOrder$outboundSchema),
+    productIds: z.optional(z.array(z.string())),
+    sort: z.optional(z.array(SortCondition$outboundSchema)),
+    startTime: z.optional(z.pipe(z.date(), z.transform(v => v.toISOString()))),
+    status: z.optional(Status$outboundSchema),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      endTime: "end_time",
+      lookupKeys: "lookup_keys",
+      productIds: "product_ids",
+      startTime: "start_time",
+    });
+  }),
+);
+
+export function productFilterToJSON(productFilter: ProductFilter): string {
+  return JSON.stringify(ProductFilter$outboundSchema.parse(productFilter));
+}

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

@@ -0,0 +1,54 @@
+/*
+ * 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 { Status, Status$inboundSchema } from "./status.js";
+
+export type ProductResponse = {
+  createdAt?: Date | undefined;
+  description?: string | undefined;
+  id?: string | undefined;
+  lookupKey?: string | undefined;
+  name?: string | undefined;
+  status?: Status | undefined;
+  updatedAt?: Date | undefined;
+};
+
+/** @internal */
+export const ProductResponse$inboundSchema: z.ZodMiniType<
+  ProductResponse,
+  unknown
+> = z.pipe(
+  z.object({
+    created_at: types.optional(types.date()),
+    description: types.optional(types.string()),
+    id: types.optional(types.string()),
+    lookup_key: types.optional(types.string()),
+    name: types.optional(types.string()),
+    status: types.optional(Status$inboundSchema),
+    updated_at: types.optional(types.date()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "created_at": "createdAt",
+      "lookup_key": "lookupKey",
+      "updated_at": "updatedAt",
+    });
+  }),
+);
+
+export function productResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ProductResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ProductResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ProductResponse' from JSON`,
+  );
+}

package/src/sdk/models/recognition-method.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 RecognitionMethod = {
+  PointInTime: "point_in_time",
+  StraightLine: "straight_line",
+  AsConsumed: "as_consumed",
+} as const;
+export type RecognitionMethod = OpenEnum<typeof RecognitionMethod>;
+
+/** @internal */
+export const RecognitionMethod$inboundSchema: z.ZodMiniType<
+  RecognitionMethod,
+  unknown
+> = openEnums.inboundSchema(RecognitionMethod);
+/** @internal */
+export const RecognitionMethod$outboundSchema: z.ZodMiniType<
+  string,
+  RecognitionMethod
+> = openEnums.outboundSchema(RecognitionMethod);

package/src/sdk/models/rev-rec-entity-type.ts

@@ -0,0 +1,29 @@
+/*
+ * 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 RevRecEntityType = {
+  Subscription: "subscription",
+  SubscriptionLineItem: "subscription_line_item",
+  Invoice: "invoice",
+  CreditNote: "credit_note",
+  Payment: "payment",
+  Refund: "refund",
+  Pob: "pob",
+} as const;
+export type RevRecEntityType = OpenEnum<typeof RevRecEntityType>;
+
+/** @internal */
+export const RevRecEntityType$inboundSchema: z.ZodMiniType<
+  RevRecEntityType,
+  unknown
+> = openEnums.inboundSchema(RevRecEntityType);
+/** @internal */
+export const RevRecEntityType$outboundSchema: z.ZodMiniType<
+  string,
+  RevRecEntityType
+> = openEnums.outboundSchema(RevRecEntityType);

package/src/sdk/models/revenue-breakdown.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 RevenueBreakdown = {
+  actual?: string | undefined;
+  pending?: string | undefined;
+  scheduled?: string | undefined;
+  /**
+   * actual + pending + scheduled
+   */
+  total?: string | undefined;
+};
+
+/** @internal */
+export const RevenueBreakdown$inboundSchema: z.ZodMiniType<
+  RevenueBreakdown,
+  unknown
+> = z.object({
+  actual: types.optional(types.string()),
+  pending: types.optional(types.string()),
+  scheduled: types.optional(types.string()),
+  total: types.optional(types.string()),
+});
+
+export function revenueBreakdownFromJSON(
+  jsonString: string,
+): SafeParseResult<RevenueBreakdown, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RevenueBreakdown$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RevenueBreakdown' from JSON`,
+  );
+}

package/src/sdk/models/revenue-report-group-by.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const RevenueReportGroupBy = {
+  CustomerId: "customer_id",
+  ContractId: "contract_id",
+  PobId: "pob_id",
+} as const;
+export type RevenueReportGroupBy = ClosedEnum<typeof RevenueReportGroupBy>;
+
+/** @internal */
+export const RevenueReportGroupBy$outboundSchema: z.ZodMiniEnum<
+  typeof RevenueReportGroupBy
+> = z.enum(RevenueReportGroupBy);