@vepler/sdk 1.9.10 → 1.10.0

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

@@ -0,0 +1,474 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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";
+
+export type GetSchoolByUrnRequest = {
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
+  expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
+  fields?: string | undefined;
+  /**
+   * School URN (Unique Reference Number)
+   */
+  urn: string;
+};
+
+export const GetSchoolByUrnSchoolsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type GetSchoolByUrnSchoolsType = ClosedEnum<
+  typeof GetSchoolByUrnSchoolsType
+>;
+
+export type GetSchoolByUrnSchoolsError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: GetSchoolByUrnSchoolsType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolByUrnSchoolsResponseBody = {
+  error: GetSchoolByUrnSchoolsError;
+};
+
+export const GetSchoolByUrnType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type GetSchoolByUrnType = ClosedEnum<typeof GetSchoolByUrnType>;
+
+export type GetSchoolByUrnError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: GetSchoolByUrnType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolByUrnResponseBody = {
+  error: GetSchoolByUrnError;
+};
+
+export type GetSchoolByUrnResponse =
+  | shared.School
+  | GetSchoolByUrnResponseBody
+  | GetSchoolByUrnSchoolsResponseBody;
+
+/** @internal */
+export const GetSchoolByUrnRequest$inboundSchema: z.ZodType<
+  GetSchoolByUrnRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  urn: z.string(),
+});
+
+/** @internal */
+export type GetSchoolByUrnRequest$Outbound = {
+  expand?: string | undefined;
+  fields?: string | undefined;
+  urn: string;
+};
+
+/** @internal */
+export const GetSchoolByUrnRequest$outboundSchema: z.ZodType<
+  GetSchoolByUrnRequest$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByUrnRequest
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  urn: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnRequest$ {
+  /** @deprecated use `GetSchoolByUrnRequest$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnRequest$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnRequest$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnRequest$outboundSchema;
+  /** @deprecated use `GetSchoolByUrnRequest$Outbound` instead. */
+  export type Outbound = GetSchoolByUrnRequest$Outbound;
+}
+
+export function getSchoolByUrnRequestToJSON(
+  getSchoolByUrnRequest: GetSchoolByUrnRequest,
+): string {
+  return JSON.stringify(
+    GetSchoolByUrnRequest$outboundSchema.parse(getSchoolByUrnRequest),
+  );
+}
+
+export function getSchoolByUrnRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByUrnRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByUrnRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByUrnRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByUrnSchoolsType$inboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByUrnSchoolsType
+> = z.nativeEnum(GetSchoolByUrnSchoolsType);
+
+/** @internal */
+export const GetSchoolByUrnSchoolsType$outboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByUrnSchoolsType
+> = GetSchoolByUrnSchoolsType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnSchoolsType$ {
+  /** @deprecated use `GetSchoolByUrnSchoolsType$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnSchoolsType$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnSchoolsType$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnSchoolsType$outboundSchema;
+}
+
+/** @internal */
+export const GetSchoolByUrnSchoolsError$inboundSchema: z.ZodType<
+  GetSchoolByUrnSchoolsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByUrnSchoolsType$inboundSchema,
+});
+
+/** @internal */
+export type GetSchoolByUrnSchoolsError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetSchoolByUrnSchoolsError$outboundSchema: z.ZodType<
+  GetSchoolByUrnSchoolsError$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByUrnSchoolsError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByUrnSchoolsType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnSchoolsError$ {
+  /** @deprecated use `GetSchoolByUrnSchoolsError$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnSchoolsError$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnSchoolsError$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnSchoolsError$outboundSchema;
+  /** @deprecated use `GetSchoolByUrnSchoolsError$Outbound` instead. */
+  export type Outbound = GetSchoolByUrnSchoolsError$Outbound;
+}
+
+export function getSchoolByUrnSchoolsErrorToJSON(
+  getSchoolByUrnSchoolsError: GetSchoolByUrnSchoolsError,
+): string {
+  return JSON.stringify(
+    GetSchoolByUrnSchoolsError$outboundSchema.parse(getSchoolByUrnSchoolsError),
+  );
+}
+
+export function getSchoolByUrnSchoolsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByUrnSchoolsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByUrnSchoolsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByUrnSchoolsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByUrnSchoolsResponseBody$inboundSchema: z.ZodType<
+  GetSchoolByUrnSchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolByUrnSchoolsError$inboundSchema),
+});
+
+/** @internal */
+export type GetSchoolByUrnSchoolsResponseBody$Outbound = {
+  error: GetSchoolByUrnSchoolsError$Outbound;
+};
+
+/** @internal */
+export const GetSchoolByUrnSchoolsResponseBody$outboundSchema: z.ZodType<
+  GetSchoolByUrnSchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByUrnSchoolsResponseBody
+> = z.object({
+  error: z.lazy(() => GetSchoolByUrnSchoolsError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnSchoolsResponseBody$ {
+  /** @deprecated use `GetSchoolByUrnSchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnSchoolsResponseBody$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnSchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetSchoolByUrnSchoolsResponseBody$outboundSchema;
+  /** @deprecated use `GetSchoolByUrnSchoolsResponseBody$Outbound` instead. */
+  export type Outbound = GetSchoolByUrnSchoolsResponseBody$Outbound;
+}
+
+export function getSchoolByUrnSchoolsResponseBodyToJSON(
+  getSchoolByUrnSchoolsResponseBody: GetSchoolByUrnSchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    GetSchoolByUrnSchoolsResponseBody$outboundSchema.parse(
+      getSchoolByUrnSchoolsResponseBody,
+    ),
+  );
+}
+
+export function getSchoolByUrnSchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByUrnSchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByUrnSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByUrnSchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByUrnType$inboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByUrnType
+> = z.nativeEnum(GetSchoolByUrnType);
+
+/** @internal */
+export const GetSchoolByUrnType$outboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByUrnType
+> = GetSchoolByUrnType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnType$ {
+  /** @deprecated use `GetSchoolByUrnType$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnType$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnType$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnType$outboundSchema;
+}
+
+/** @internal */
+export const GetSchoolByUrnError$inboundSchema: z.ZodType<
+  GetSchoolByUrnError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByUrnType$inboundSchema,
+});
+
+/** @internal */
+export type GetSchoolByUrnError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetSchoolByUrnError$outboundSchema: z.ZodType<
+  GetSchoolByUrnError$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByUrnError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByUrnType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnError$ {
+  /** @deprecated use `GetSchoolByUrnError$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnError$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnError$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnError$outboundSchema;
+  /** @deprecated use `GetSchoolByUrnError$Outbound` instead. */
+  export type Outbound = GetSchoolByUrnError$Outbound;
+}
+
+export function getSchoolByUrnErrorToJSON(
+  getSchoolByUrnError: GetSchoolByUrnError,
+): string {
+  return JSON.stringify(
+    GetSchoolByUrnError$outboundSchema.parse(getSchoolByUrnError),
+  );
+}
+
+export function getSchoolByUrnErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByUrnError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByUrnError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByUrnError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByUrnResponseBody$inboundSchema: z.ZodType<
+  GetSchoolByUrnResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolByUrnError$inboundSchema),
+});
+
+/** @internal */
+export type GetSchoolByUrnResponseBody$Outbound = {
+  error: GetSchoolByUrnError$Outbound;
+};
+
+/** @internal */
+export const GetSchoolByUrnResponseBody$outboundSchema: z.ZodType<
+  GetSchoolByUrnResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByUrnResponseBody
+> = z.object({
+  error: z.lazy(() => GetSchoolByUrnError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnResponseBody$ {
+  /** @deprecated use `GetSchoolByUrnResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnResponseBody$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnResponseBody$outboundSchema;
+  /** @deprecated use `GetSchoolByUrnResponseBody$Outbound` instead. */
+  export type Outbound = GetSchoolByUrnResponseBody$Outbound;
+}
+
+export function getSchoolByUrnResponseBodyToJSON(
+  getSchoolByUrnResponseBody: GetSchoolByUrnResponseBody,
+): string {
+  return JSON.stringify(
+    GetSchoolByUrnResponseBody$outboundSchema.parse(getSchoolByUrnResponseBody),
+  );
+}
+
+export function getSchoolByUrnResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByUrnResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByUrnResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByUrnResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByUrnResponse$inboundSchema: z.ZodType<
+  GetSchoolByUrnResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.School$inboundSchema,
+  z.lazy(() => GetSchoolByUrnResponseBody$inboundSchema),
+  z.lazy(() => GetSchoolByUrnSchoolsResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetSchoolByUrnResponse$Outbound =
+  | shared.School$Outbound
+  | GetSchoolByUrnResponseBody$Outbound
+  | GetSchoolByUrnSchoolsResponseBody$Outbound;
+
+/** @internal */
+export const GetSchoolByUrnResponse$outboundSchema: z.ZodType<
+  GetSchoolByUrnResponse$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByUrnResponse
+> = z.union([
+  shared.School$outboundSchema,
+  z.lazy(() => GetSchoolByUrnResponseBody$outboundSchema),
+  z.lazy(() => GetSchoolByUrnSchoolsResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByUrnResponse$ {
+  /** @deprecated use `GetSchoolByUrnResponse$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByUrnResponse$inboundSchema;
+  /** @deprecated use `GetSchoolByUrnResponse$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByUrnResponse$outboundSchema;
+  /** @deprecated use `GetSchoolByUrnResponse$Outbound` instead. */
+  export type Outbound = GetSchoolByUrnResponse$Outbound;
+}
+
+export function getSchoolByUrnResponseToJSON(
+  getSchoolByUrnResponse: GetSchoolByUrnResponse,
+): string {
+  return JSON.stringify(
+    GetSchoolByUrnResponse$outboundSchema.parse(getSchoolByUrnResponse),
+  );
+}
+
+export function getSchoolByUrnResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByUrnResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByUrnResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByUrnResponse' from JSON`,
+  );
+}