/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import * as z from "zod"; import { remap as remap$ } from "../../lib/primitives.js"; import { safeParse } from "../../lib/schemas.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import * as components from "../components/index.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export type HrisEmployeesAllGlobals = { /** * ID of the consumer which you want to get or push data from */ consumerId?: string | undefined; /** * The ID of your Unify application */ appId?: string | undefined; }; export type HrisEmployeesAllRequest = { /** * Include raw response. Mostly used for debugging purposes */ raw?: boolean | undefined; /** * Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. */ serviceId?: string | undefined; /** * Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response. */ cursor?: string | null | undefined; /** * Number of results to return. Minimum 1, Maximum 200, Default 20 */ limit?: number | undefined; /** * Apply filters */ filter?: components.EmployeesFilter | undefined; /** * Apply sorting */ sort?: components.EmployeesSort | undefined; /** * Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads */ passThrough?: { [k: string]: any } | undefined; /** * The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation.

Example: `fields=name,email,addresses.city`

In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. */ fields?: string | null | undefined; }; export type HrisEmployeesAllResponse = { httpMeta: components.HTTPMetadata; /** * Employees */ getEmployeesResponse?: components.GetEmployeesResponse | undefined; /** * Unexpected error */ unexpectedErrorResponse?: components.UnexpectedErrorResponse | undefined; }; /** @internal */ export const HrisEmployeesAllGlobals$inboundSchema: z.ZodType< HrisEmployeesAllGlobals, z.ZodTypeDef, unknown > = z.object({ consumerId: z.string().optional(), appId: z.string().optional(), }); /** @internal */ export type HrisEmployeesAllGlobals$Outbound = { consumerId?: string | undefined; appId?: string | undefined; }; /** @internal */ export const HrisEmployeesAllGlobals$outboundSchema: z.ZodType< HrisEmployeesAllGlobals$Outbound, z.ZodTypeDef, HrisEmployeesAllGlobals > = z.object({ consumerId: z.string().optional(), appId: z.string().optional(), }); /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export namespace HrisEmployeesAllGlobals$ { /** @deprecated use `HrisEmployeesAllGlobals$inboundSchema` instead. */ export const inboundSchema = HrisEmployeesAllGlobals$inboundSchema; /** @deprecated use `HrisEmployeesAllGlobals$outboundSchema` instead. */ export const outboundSchema = HrisEmployeesAllGlobals$outboundSchema; /** @deprecated use `HrisEmployeesAllGlobals$Outbound` instead. */ export type Outbound = HrisEmployeesAllGlobals$Outbound; } export function hrisEmployeesAllGlobalsToJSON( hrisEmployeesAllGlobals: HrisEmployeesAllGlobals, ): string { return JSON.stringify( HrisEmployeesAllGlobals$outboundSchema.parse(hrisEmployeesAllGlobals), ); } export function hrisEmployeesAllGlobalsFromJSON( jsonString: string, ): SafeParseResult { return safeParse( jsonString, (x) => HrisEmployeesAllGlobals$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'HrisEmployeesAllGlobals' from JSON`, ); } /** @internal */ export const HrisEmployeesAllRequest$inboundSchema: z.ZodType< HrisEmployeesAllRequest, z.ZodTypeDef, unknown > = z.object({ raw: z.boolean().default(false), serviceId: z.string().optional(), cursor: z.nullable(z.string()).optional(), limit: z.number().int().default(20), filter: components.EmployeesFilter$inboundSchema.optional(), sort: components.EmployeesSort$inboundSchema.optional(), pass_through: z.record(z.any()).optional(), fields: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { "pass_through": "passThrough", }); }); /** @internal */ export type HrisEmployeesAllRequest$Outbound = { raw: boolean; serviceId?: string | undefined; cursor?: string | null | undefined; limit: number; filter?: components.EmployeesFilter$Outbound | undefined; sort?: components.EmployeesSort$Outbound | undefined; pass_through?: { [k: string]: any } | undefined; fields?: string | null | undefined; }; /** @internal */ export const HrisEmployeesAllRequest$outboundSchema: z.ZodType< HrisEmployeesAllRequest$Outbound, z.ZodTypeDef, HrisEmployeesAllRequest > = z.object({ raw: z.boolean().default(false), serviceId: z.string().optional(), cursor: z.nullable(z.string()).optional(), limit: z.number().int().default(20), filter: components.EmployeesFilter$outboundSchema.optional(), sort: components.EmployeesSort$outboundSchema.optional(), passThrough: z.record(z.any()).optional(), fields: z.nullable(z.string()).optional(), }).transform((v) => { return remap$(v, { passThrough: "pass_through", }); }); /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export namespace HrisEmployeesAllRequest$ { /** @deprecated use `HrisEmployeesAllRequest$inboundSchema` instead. */ export const inboundSchema = HrisEmployeesAllRequest$inboundSchema; /** @deprecated use `HrisEmployeesAllRequest$outboundSchema` instead. */ export const outboundSchema = HrisEmployeesAllRequest$outboundSchema; /** @deprecated use `HrisEmployeesAllRequest$Outbound` instead. */ export type Outbound = HrisEmployeesAllRequest$Outbound; } export function hrisEmployeesAllRequestToJSON( hrisEmployeesAllRequest: HrisEmployeesAllRequest, ): string { return JSON.stringify( HrisEmployeesAllRequest$outboundSchema.parse(hrisEmployeesAllRequest), ); } export function hrisEmployeesAllRequestFromJSON( jsonString: string, ): SafeParseResult { return safeParse( jsonString, (x) => HrisEmployeesAllRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'HrisEmployeesAllRequest' from JSON`, ); } /** @internal */ export const HrisEmployeesAllResponse$inboundSchema: z.ZodType< HrisEmployeesAllResponse, z.ZodTypeDef, unknown > = z.object({ HttpMeta: components.HTTPMetadata$inboundSchema, GetEmployeesResponse: components.GetEmployeesResponse$inboundSchema .optional(), UnexpectedErrorResponse: components.UnexpectedErrorResponse$inboundSchema .optional(), }).transform((v) => { return remap$(v, { "HttpMeta": "httpMeta", "GetEmployeesResponse": "getEmployeesResponse", "UnexpectedErrorResponse": "unexpectedErrorResponse", }); }); /** @internal */ export type HrisEmployeesAllResponse$Outbound = { HttpMeta: components.HTTPMetadata$Outbound; GetEmployeesResponse?: components.GetEmployeesResponse$Outbound | undefined; UnexpectedErrorResponse?: | components.UnexpectedErrorResponse$Outbound | undefined; }; /** @internal */ export const HrisEmployeesAllResponse$outboundSchema: z.ZodType< HrisEmployeesAllResponse$Outbound, z.ZodTypeDef, HrisEmployeesAllResponse > = z.object({ httpMeta: components.HTTPMetadata$outboundSchema, getEmployeesResponse: components.GetEmployeesResponse$outboundSchema .optional(), unexpectedErrorResponse: components.UnexpectedErrorResponse$outboundSchema .optional(), }).transform((v) => { return remap$(v, { httpMeta: "HttpMeta", getEmployeesResponse: "GetEmployeesResponse", unexpectedErrorResponse: "UnexpectedErrorResponse", }); }); /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export namespace HrisEmployeesAllResponse$ { /** @deprecated use `HrisEmployeesAllResponse$inboundSchema` instead. */ export const inboundSchema = HrisEmployeesAllResponse$inboundSchema; /** @deprecated use `HrisEmployeesAllResponse$outboundSchema` instead. */ export const outboundSchema = HrisEmployeesAllResponse$outboundSchema; /** @deprecated use `HrisEmployeesAllResponse$Outbound` instead. */ export type Outbound = HrisEmployeesAllResponse$Outbound; } export function hrisEmployeesAllResponseToJSON( hrisEmployeesAllResponse: HrisEmployeesAllResponse, ): string { return JSON.stringify( HrisEmployeesAllResponse$outboundSchema.parse(hrisEmployeesAllResponse), ); } export function hrisEmployeesAllResponseFromJSON( jsonString: string, ): SafeParseResult { return safeParse( jsonString, (x) => HrisEmployeesAllResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'HrisEmployeesAllResponse' from JSON`, ); }