/* * 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 { smartUnion } from "../../types/smartUnion.js"; import { ListResourceProduct, ListResourceProduct$inboundSchema, } from "../components/listresourceproduct.js"; import { ProductSortProperty, ProductSortProperty$outboundSchema, } from "../components/productsortproperty.js"; import { ProductVisibility, ProductVisibility$outboundSchema, } from "../components/productvisibility.js"; import { MetadataQuery, MetadataQuery$Outbound, MetadataQuery$outboundSchema, } from "../components/subscriptionslist.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * Filter by product ID. */ export type QueryParamProductIDFilter = string | Array; /** * Filter by organization ID. */ export type ProductsListQueryParamOrganizationIDFilter = string | Array; /** * Filter products granting specific benefit. */ export type BenefitIDFilter = string | Array; export type ProductsListRequest = { /** * Filter by product ID. */ id?: string | Array | null | undefined; /** * Filter by organization ID. */ organizationId?: string | Array | null | undefined; /** * Filter by product name. */ query?: string | null | undefined; /** * Filter on archived products. */ isArchived?: boolean | null | undefined; /** * Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned. */ isRecurring?: boolean | null | undefined; /** * Filter products granting specific benefit. */ benefitId?: string | Array | null | undefined; /** * Filter by visibility. */ visibility?: Array | null | undefined; /** * Page number, defaults to 1. */ page?: number | undefined; /** * Size of a page, defaults to 10. Maximum is 100. */ limit?: number | undefined; /** * Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order. */ sorting?: Array | null | undefined; /** * Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`. */ metadata?: { [k: string]: MetadataQuery } | null | undefined; }; export type ProductsListResponse = { result: ListResourceProduct; }; /** @internal */ export type QueryParamProductIDFilter$Outbound = string | Array; /** @internal */ export const QueryParamProductIDFilter$outboundSchema: z.ZodMiniType< QueryParamProductIDFilter$Outbound, QueryParamProductIDFilter > = smartUnion([z.string(), z.array(z.string())]); export function queryParamProductIDFilterToJSON( queryParamProductIDFilter: QueryParamProductIDFilter, ): string { return JSON.stringify( QueryParamProductIDFilter$outboundSchema.parse(queryParamProductIDFilter), ); } /** @internal */ export type ProductsListQueryParamOrganizationIDFilter$Outbound = | string | Array; /** @internal */ export const ProductsListQueryParamOrganizationIDFilter$outboundSchema: z.ZodMiniType< ProductsListQueryParamOrganizationIDFilter$Outbound, ProductsListQueryParamOrganizationIDFilter > = smartUnion([z.string(), z.array(z.string())]); export function productsListQueryParamOrganizationIDFilterToJSON( productsListQueryParamOrganizationIDFilter: ProductsListQueryParamOrganizationIDFilter, ): string { return JSON.stringify( ProductsListQueryParamOrganizationIDFilter$outboundSchema.parse( productsListQueryParamOrganizationIDFilter, ), ); } /** @internal */ export type BenefitIDFilter$Outbound = string | Array; /** @internal */ export const BenefitIDFilter$outboundSchema: z.ZodMiniType< BenefitIDFilter$Outbound, BenefitIDFilter > = smartUnion([z.string(), z.array(z.string())]); export function benefitIDFilterToJSON( benefitIDFilter: BenefitIDFilter, ): string { return JSON.stringify(BenefitIDFilter$outboundSchema.parse(benefitIDFilter)); } /** @internal */ export type ProductsListRequest$Outbound = { id?: string | Array | null | undefined; organization_id?: string | Array | null | undefined; query?: string | null | undefined; is_archived?: boolean | null | undefined; is_recurring?: boolean | null | undefined; benefit_id?: string | Array | null | undefined; visibility?: Array | null | undefined; page: number; limit: number; sorting?: Array | null | undefined; metadata?: { [k: string]: MetadataQuery$Outbound } | null | undefined; }; /** @internal */ export const ProductsListRequest$outboundSchema: z.ZodMiniType< ProductsListRequest$Outbound, ProductsListRequest > = z.pipe( z.object({ id: z.optional(z.nullable(smartUnion([z.string(), z.array(z.string())]))), organizationId: z.optional( z.nullable(smartUnion([z.string(), z.array(z.string())])), ), query: z.optional(z.nullable(z.string())), isArchived: z.optional(z.nullable(z.boolean())), isRecurring: z.optional(z.nullable(z.boolean())), benefitId: z.optional( z.nullable(smartUnion([z.string(), z.array(z.string())])), ), visibility: z.optional( z.nullable(z.array(ProductVisibility$outboundSchema)), ), page: z._default(z.int(), 1), limit: z._default(z.int(), 10), sorting: z.optional( z.nullable(z.array(ProductSortProperty$outboundSchema)), ), metadata: z.optional( z.nullable(z.record(z.string(), MetadataQuery$outboundSchema)), ), }), z.transform((v) => { return remap$(v, { organizationId: "organization_id", isArchived: "is_archived", isRecurring: "is_recurring", benefitId: "benefit_id", }); }), ); export function productsListRequestToJSON( productsListRequest: ProductsListRequest, ): string { return JSON.stringify( ProductsListRequest$outboundSchema.parse(productsListRequest), ); } /** @internal */ export const ProductsListResponse$inboundSchema: z.ZodMiniType< ProductsListResponse, unknown > = z.pipe( z.object({ Result: ListResourceProduct$inboundSchema, }), z.transform((v) => { return remap$(v, { "Result": "result", }); }), ); export function productsListResponseFromJSON( jsonString: string, ): SafeParseResult { return safeParse( jsonString, (x) => ProductsListResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'ProductsListResponse' from JSON`, ); }