@vepler/sdk 1.9.10 → 1.10.0

package/src/sdk/models/operations/searchschoolsnearby.ts

@@ -0,0 +1,507 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
+
+/**
+ * Unit for radius
+ */
+export const Unit = {
+  Meters: "meters",
+  Miles: "miles",
+} as const;
+/**
+ * Unit for radius
+ */
+export type Unit = ClosedEnum<typeof Unit>;
+
+export type SearchSchoolsNearbyRequest = {
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
+  expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
+  fields?: string | undefined;
+  /**
+   * Latitude coordinate
+   */
+  latitude: string;
+  /**
+   * Maximum number of results
+   */
+  limit?: string | undefined;
+  /**
+   * Longitude coordinate
+   */
+  longitude: string;
+  /**
+   * Search radius
+   */
+  radius?: string | undefined;
+  /**
+   * Ofsted rating filter
+   */
+  rating?: string | undefined;
+  /**
+   * School status filter
+   */
+  status?: string | undefined;
+  /**
+   * Unit for radius
+   */
+  unit?: Unit | undefined;
+};
+
+export const SearchSchoolsNearbyType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type SearchSchoolsNearbyType = ClosedEnum<
+  typeof SearchSchoolsNearbyType
+>;
+
+export type SearchSchoolsNearbyError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: SearchSchoolsNearbyType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSchoolsNearbySchoolsResponseBody = {
+  error: SearchSchoolsNearbyError;
+};
+
+export const SearchSchoolsNearbyObject = {
+  List: "list",
+} as const;
+export type SearchSchoolsNearbyObject = ClosedEnum<
+  typeof SearchSchoolsNearbyObject
+>;
+
+/**
+ * Paginated list of schools
+ */
+export type SearchSchoolsNearbyResponseBody = {
+  data: Array<shared.School>;
+  hasMore: boolean;
+  object: SearchSchoolsNearbyObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+export type SearchSchoolsNearbyResponse =
+  | SearchSchoolsNearbyResponseBody
+  | SearchSchoolsNearbySchoolsResponseBody;
+
+/** @internal */
+export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
+  Unit,
+);
+
+/** @internal */
+export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
+  Unit$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Unit$ {
+  /** @deprecated use `Unit$inboundSchema` instead. */
+  export const inboundSchema = Unit$inboundSchema;
+  /** @deprecated use `Unit$outboundSchema` instead. */
+  export const outboundSchema = Unit$outboundSchema;
+}
+
+/** @internal */
+export const SearchSchoolsNearbyRequest$inboundSchema: z.ZodType<
+  SearchSchoolsNearbyRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  latitude: z.string(),
+  limit: z.string().optional(),
+  longitude: z.string(),
+  radius: z.string().default("5000"),
+  rating: z.string().optional(),
+  status: z.string().optional(),
+  unit: Unit$inboundSchema.default("meters"),
+});
+
+/** @internal */
+export type SearchSchoolsNearbyRequest$Outbound = {
+  expand?: string | undefined;
+  fields?: string | undefined;
+  latitude: string;
+  limit?: string | undefined;
+  longitude: string;
+  radius: string;
+  rating?: string | undefined;
+  status?: string | undefined;
+  unit: string;
+};
+
+/** @internal */
+export const SearchSchoolsNearbyRequest$outboundSchema: z.ZodType<
+  SearchSchoolsNearbyRequest$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsNearbyRequest
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  latitude: z.string(),
+  limit: z.string().optional(),
+  longitude: z.string(),
+  radius: z.string().default("5000"),
+  rating: z.string().optional(),
+  status: z.string().optional(),
+  unit: Unit$outboundSchema.default("meters"),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbyRequest$ {
+  /** @deprecated use `SearchSchoolsNearbyRequest$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsNearbyRequest$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyRequest$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsNearbyRequest$outboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyRequest$Outbound` instead. */
+  export type Outbound = SearchSchoolsNearbyRequest$Outbound;
+}
+
+export function searchSchoolsNearbyRequestToJSON(
+  searchSchoolsNearbyRequest: SearchSchoolsNearbyRequest,
+): string {
+  return JSON.stringify(
+    SearchSchoolsNearbyRequest$outboundSchema.parse(searchSchoolsNearbyRequest),
+  );
+}
+
+export function searchSchoolsNearbyRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsNearbyRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsNearbyRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsNearbyRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsNearbyType$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsNearbyType
+> = z.nativeEnum(SearchSchoolsNearbyType);
+
+/** @internal */
+export const SearchSchoolsNearbyType$outboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsNearbyType
+> = SearchSchoolsNearbyType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbyType$ {
+  /** @deprecated use `SearchSchoolsNearbyType$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsNearbyType$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyType$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsNearbyType$outboundSchema;
+}
+
+/** @internal */
+export const SearchSchoolsNearbyError$inboundSchema: z.ZodType<
+  SearchSchoolsNearbyError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: SearchSchoolsNearbyType$inboundSchema,
+});
+
+/** @internal */
+export type SearchSchoolsNearbyError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const SearchSchoolsNearbyError$outboundSchema: z.ZodType<
+  SearchSchoolsNearbyError$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsNearbyError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: SearchSchoolsNearbyType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbyError$ {
+  /** @deprecated use `SearchSchoolsNearbyError$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsNearbyError$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyError$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsNearbyError$outboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyError$Outbound` instead. */
+  export type Outbound = SearchSchoolsNearbyError$Outbound;
+}
+
+export function searchSchoolsNearbyErrorToJSON(
+  searchSchoolsNearbyError: SearchSchoolsNearbyError,
+): string {
+  return JSON.stringify(
+    SearchSchoolsNearbyError$outboundSchema.parse(searchSchoolsNearbyError),
+  );
+}
+
+export function searchSchoolsNearbyErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsNearbyError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsNearbyError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsNearbyError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsNearbySchoolsResponseBody$inboundSchema: z.ZodType<
+  SearchSchoolsNearbySchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SearchSchoolsNearbyError$inboundSchema),
+});
+
+/** @internal */
+export type SearchSchoolsNearbySchoolsResponseBody$Outbound = {
+  error: SearchSchoolsNearbyError$Outbound;
+};
+
+/** @internal */
+export const SearchSchoolsNearbySchoolsResponseBody$outboundSchema: z.ZodType<
+  SearchSchoolsNearbySchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsNearbySchoolsResponseBody
+> = z.object({
+  error: z.lazy(() => SearchSchoolsNearbyError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbySchoolsResponseBody$ {
+  /** @deprecated use `SearchSchoolsNearbySchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    SearchSchoolsNearbySchoolsResponseBody$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbySchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    SearchSchoolsNearbySchoolsResponseBody$outboundSchema;
+  /** @deprecated use `SearchSchoolsNearbySchoolsResponseBody$Outbound` instead. */
+  export type Outbound = SearchSchoolsNearbySchoolsResponseBody$Outbound;
+}
+
+export function searchSchoolsNearbySchoolsResponseBodyToJSON(
+  searchSchoolsNearbySchoolsResponseBody:
+    SearchSchoolsNearbySchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    SearchSchoolsNearbySchoolsResponseBody$outboundSchema.parse(
+      searchSchoolsNearbySchoolsResponseBody,
+    ),
+  );
+}
+
+export function searchSchoolsNearbySchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsNearbySchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchSchoolsNearbySchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsNearbySchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsNearbyObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsNearbyObject
+> = z.nativeEnum(SearchSchoolsNearbyObject);
+
+/** @internal */
+export const SearchSchoolsNearbyObject$outboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsNearbyObject
+> = SearchSchoolsNearbyObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbyObject$ {
+  /** @deprecated use `SearchSchoolsNearbyObject$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsNearbyObject$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyObject$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsNearbyObject$outboundSchema;
+}
+
+/** @internal */
+export const SearchSchoolsNearbyResponseBody$inboundSchema: z.ZodType<
+  SearchSchoolsNearbyResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.School$inboundSchema),
+  has_more: z.boolean(),
+  object: SearchSchoolsNearbyObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type SearchSchoolsNearbyResponseBody$Outbound = {
+  data: Array<shared.School$Outbound>;
+  has_more: boolean;
+  object: string;
+  total_count?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export const SearchSchoolsNearbyResponseBody$outboundSchema: z.ZodType<
+  SearchSchoolsNearbyResponseBody$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsNearbyResponseBody
+> = z.object({
+  data: z.array(shared.School$outboundSchema),
+  hasMore: z.boolean(),
+  object: SearchSchoolsNearbyObject$outboundSchema,
+  totalCount: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    hasMore: "has_more",
+    totalCount: "total_count",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbyResponseBody$ {
+  /** @deprecated use `SearchSchoolsNearbyResponseBody$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsNearbyResponseBody$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyResponseBody$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsNearbyResponseBody$outboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyResponseBody$Outbound` instead. */
+  export type Outbound = SearchSchoolsNearbyResponseBody$Outbound;
+}
+
+export function searchSchoolsNearbyResponseBodyToJSON(
+  searchSchoolsNearbyResponseBody: SearchSchoolsNearbyResponseBody,
+): string {
+  return JSON.stringify(
+    SearchSchoolsNearbyResponseBody$outboundSchema.parse(
+      searchSchoolsNearbyResponseBody,
+    ),
+  );
+}
+
+export function searchSchoolsNearbyResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsNearbyResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsNearbyResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsNearbyResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsNearbyResponse$inboundSchema: z.ZodType<
+  SearchSchoolsNearbyResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => SearchSchoolsNearbyResponseBody$inboundSchema),
+  z.lazy(() => SearchSchoolsNearbySchoolsResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type SearchSchoolsNearbyResponse$Outbound =
+  | SearchSchoolsNearbyResponseBody$Outbound
+  | SearchSchoolsNearbySchoolsResponseBody$Outbound;
+
+/** @internal */
+export const SearchSchoolsNearbyResponse$outboundSchema: z.ZodType<
+  SearchSchoolsNearbyResponse$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsNearbyResponse
+> = z.union([
+  z.lazy(() => SearchSchoolsNearbyResponseBody$outboundSchema),
+  z.lazy(() => SearchSchoolsNearbySchoolsResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsNearbyResponse$ {
+  /** @deprecated use `SearchSchoolsNearbyResponse$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsNearbyResponse$inboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyResponse$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsNearbyResponse$outboundSchema;
+  /** @deprecated use `SearchSchoolsNearbyResponse$Outbound` instead. */
+  export type Outbound = SearchSchoolsNearbyResponse$Outbound;
+}
+
+export function searchSchoolsNearbyResponseToJSON(
+  searchSchoolsNearbyResponse: SearchSchoolsNearbyResponse,
+): string {
+  return JSON.stringify(
+    SearchSchoolsNearbyResponse$outboundSchema.parse(
+      searchSchoolsNearbyResponse,
+    ),
+  );
+}
+
+export function searchSchoolsNearbyResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsNearbyResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsNearbyResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsNearbyResponse' from JSON`,
+  );
+}