/*
 * 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 {
  BenefitSortProperty,
  BenefitSortProperty$outboundSchema,
} from "../components/benefitsortproperty.js";
import {
  BenefitType,
  BenefitType$outboundSchema,
} from "../components/benefittype.js";
import {
  ListResourceBenefit,
  ListResourceBenefit$inboundSchema,
} from "../components/listresourcebenefit.js";
import {
  MetadataQuery,
  MetadataQuery$Outbound,
  MetadataQuery$outboundSchema,
} from "../components/subscriptionslist.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";

/**
 * Filter by organization ID.
 */
export type QueryParamOrganizationIDFilter = string | Array<string>;

/**
 * Filter by benefit type.
 */
export type BenefitTypeFilter = BenefitType | Array<BenefitType>;

/**
 * Filter by benefit IDs.
 */
export type FilterIDs = string | Array<string>;

/**
 * Exclude benefits with these IDs.
 */
export type ExcludeIDs = string | Array<string>;

export type BenefitsListRequest = {
  /**
   * Filter by organization ID.
   */
  organizationId?: string | Array<string> | null | undefined;
  /**
   * Filter by benefit type.
   */
  typeFilter?: BenefitType | Array<BenefitType> | null | undefined;
  /**
   * Filter by benefit IDs.
   */
  id?: string | Array<string> | null | undefined;
  /**
   * Exclude benefits with these IDs.
   */
  excludeId?: string | Array<string> | null | undefined;
  /**
   * Filter by description.
   */
  query?: string | 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<BenefitSortProperty> | 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 BenefitsListResponse = {
  result: ListResourceBenefit;
};

/** @internal */
export type QueryParamOrganizationIDFilter$Outbound = string | Array<string>;

/** @internal */
export const QueryParamOrganizationIDFilter$outboundSchema: z.ZodMiniType<
  QueryParamOrganizationIDFilter$Outbound,
  QueryParamOrganizationIDFilter
> = smartUnion([z.string(), z.array(z.string())]);

export function queryParamOrganizationIDFilterToJSON(
  queryParamOrganizationIDFilter: QueryParamOrganizationIDFilter,
): string {
  return JSON.stringify(
    QueryParamOrganizationIDFilter$outboundSchema.parse(
      queryParamOrganizationIDFilter,
    ),
  );
}

/** @internal */
export type BenefitTypeFilter$Outbound = string | Array<string>;

/** @internal */
export const BenefitTypeFilter$outboundSchema: z.ZodMiniType<
  BenefitTypeFilter$Outbound,
  BenefitTypeFilter
> = smartUnion([
  BenefitType$outboundSchema,
  z.array(BenefitType$outboundSchema),
]);

export function benefitTypeFilterToJSON(
  benefitTypeFilter: BenefitTypeFilter,
): string {
  return JSON.stringify(
    BenefitTypeFilter$outboundSchema.parse(benefitTypeFilter),
  );
}

/** @internal */
export type FilterIDs$Outbound = string | Array<string>;

/** @internal */
export const FilterIDs$outboundSchema: z.ZodMiniType<
  FilterIDs$Outbound,
  FilterIDs
> = smartUnion([z.string(), z.array(z.string())]);

export function filterIDsToJSON(filterIDs: FilterIDs): string {
  return JSON.stringify(FilterIDs$outboundSchema.parse(filterIDs));
}

/** @internal */
export type ExcludeIDs$Outbound = string | Array<string>;

/** @internal */
export const ExcludeIDs$outboundSchema: z.ZodMiniType<
  ExcludeIDs$Outbound,
  ExcludeIDs
> = smartUnion([z.string(), z.array(z.string())]);

export function excludeIDsToJSON(excludeIDs: ExcludeIDs): string {
  return JSON.stringify(ExcludeIDs$outboundSchema.parse(excludeIDs));
}

/** @internal */
export type BenefitsListRequest$Outbound = {
  organization_id?: string | Array<string> | null | undefined;
  type_filter?: string | Array<string> | null | undefined;
  id?: string | Array<string> | null | undefined;
  exclude_id?: string | Array<string> | null | undefined;
  query?: string | null | undefined;
  page: number;
  limit: number;
  sorting?: Array<string> | null | undefined;
  metadata?: { [k: string]: MetadataQuery$Outbound } | null | undefined;
};

/** @internal */
export const BenefitsListRequest$outboundSchema: z.ZodMiniType<
  BenefitsListRequest$Outbound,
  BenefitsListRequest
> = z.pipe(
  z.object({
    organizationId: z.optional(
      z.nullable(smartUnion([z.string(), z.array(z.string())])),
    ),
    typeFilter: z.optional(
      z.nullable(
        smartUnion([
          BenefitType$outboundSchema,
          z.array(BenefitType$outboundSchema),
        ]),
      ),
    ),
    id: z.optional(z.nullable(smartUnion([z.string(), z.array(z.string())]))),
    excludeId: z.optional(
      z.nullable(smartUnion([z.string(), z.array(z.string())])),
    ),
    query: z.optional(z.nullable(z.string())),
    page: z._default(z.int(), 1),
    limit: z._default(z.int(), 10),
    sorting: z.optional(
      z.nullable(z.array(BenefitSortProperty$outboundSchema)),
    ),
    metadata: z.optional(
      z.nullable(z.record(z.string(), MetadataQuery$outboundSchema)),
    ),
  }),
  z.transform((v) => {
    return remap$(v, {
      organizationId: "organization_id",
      typeFilter: "type_filter",
      excludeId: "exclude_id",
    });
  }),
);

export function benefitsListRequestToJSON(
  benefitsListRequest: BenefitsListRequest,
): string {
  return JSON.stringify(
    BenefitsListRequest$outboundSchema.parse(benefitsListRequest),
  );
}

/** @internal */
export const BenefitsListResponse$inboundSchema: z.ZodMiniType<
  BenefitsListResponse,
  unknown
> = z.pipe(
  z.object({
    Result: ListResourceBenefit$inboundSchema,
  }),
  z.transform((v) => {
    return remap$(v, {
      "Result": "result",
    });
  }),
);

export function benefitsListResponseFromJSON(
  jsonString: string,
): SafeParseResult<BenefitsListResponse, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => BenefitsListResponse$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'BenefitsListResponse' from JSON`,
  );
}