@vepler/sdk 1.9.10 → 1.10.0

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

@@ -0,0 +1,473 @@
+/*
+ * 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 GetSchoolByIdRequest = {
+  /**
+   * 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 ID
+   */
+  id: string;
+};
+
+export const GetSchoolByIdSchoolsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type GetSchoolByIdSchoolsType = ClosedEnum<
+  typeof GetSchoolByIdSchoolsType
+>;
+
+export type GetSchoolByIdSchoolsError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: GetSchoolByIdSchoolsType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolByIdSchoolsResponseBody = {
+  error: GetSchoolByIdSchoolsError;
+};
+
+export const GetSchoolByIdType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type GetSchoolByIdType = ClosedEnum<typeof GetSchoolByIdType>;
+
+export type GetSchoolByIdError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: GetSchoolByIdType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolByIdResponseBody = {
+  error: GetSchoolByIdError;
+};
+
+export type GetSchoolByIdResponse =
+  | shared.School
+  | GetSchoolByIdResponseBody
+  | GetSchoolByIdSchoolsResponseBody;
+
+/** @internal */
+export const GetSchoolByIdRequest$inboundSchema: z.ZodType<
+  GetSchoolByIdRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  id: z.string(),
+});
+
+/** @internal */
+export type GetSchoolByIdRequest$Outbound = {
+  expand?: string | undefined;
+  fields?: string | undefined;
+  id: string;
+};
+
+/** @internal */
+export const GetSchoolByIdRequest$outboundSchema: z.ZodType<
+  GetSchoolByIdRequest$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByIdRequest
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  id: 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 GetSchoolByIdRequest$ {
+  /** @deprecated use `GetSchoolByIdRequest$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdRequest$inboundSchema;
+  /** @deprecated use `GetSchoolByIdRequest$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdRequest$outboundSchema;
+  /** @deprecated use `GetSchoolByIdRequest$Outbound` instead. */
+  export type Outbound = GetSchoolByIdRequest$Outbound;
+}
+
+export function getSchoolByIdRequestToJSON(
+  getSchoolByIdRequest: GetSchoolByIdRequest,
+): string {
+  return JSON.stringify(
+    GetSchoolByIdRequest$outboundSchema.parse(getSchoolByIdRequest),
+  );
+}
+
+export function getSchoolByIdRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByIdRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByIdRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByIdRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByIdSchoolsType$inboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByIdSchoolsType
+> = z.nativeEnum(GetSchoolByIdSchoolsType);
+
+/** @internal */
+export const GetSchoolByIdSchoolsType$outboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByIdSchoolsType
+> = GetSchoolByIdSchoolsType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdSchoolsType$ {
+  /** @deprecated use `GetSchoolByIdSchoolsType$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdSchoolsType$inboundSchema;
+  /** @deprecated use `GetSchoolByIdSchoolsType$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdSchoolsType$outboundSchema;
+}
+
+/** @internal */
+export const GetSchoolByIdSchoolsError$inboundSchema: z.ZodType<
+  GetSchoolByIdSchoolsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByIdSchoolsType$inboundSchema,
+});
+
+/** @internal */
+export type GetSchoolByIdSchoolsError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetSchoolByIdSchoolsError$outboundSchema: z.ZodType<
+  GetSchoolByIdSchoolsError$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByIdSchoolsError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByIdSchoolsType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdSchoolsError$ {
+  /** @deprecated use `GetSchoolByIdSchoolsError$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdSchoolsError$inboundSchema;
+  /** @deprecated use `GetSchoolByIdSchoolsError$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdSchoolsError$outboundSchema;
+  /** @deprecated use `GetSchoolByIdSchoolsError$Outbound` instead. */
+  export type Outbound = GetSchoolByIdSchoolsError$Outbound;
+}
+
+export function getSchoolByIdSchoolsErrorToJSON(
+  getSchoolByIdSchoolsError: GetSchoolByIdSchoolsError,
+): string {
+  return JSON.stringify(
+    GetSchoolByIdSchoolsError$outboundSchema.parse(getSchoolByIdSchoolsError),
+  );
+}
+
+export function getSchoolByIdSchoolsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByIdSchoolsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByIdSchoolsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByIdSchoolsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByIdSchoolsResponseBody$inboundSchema: z.ZodType<
+  GetSchoolByIdSchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolByIdSchoolsError$inboundSchema),
+});
+
+/** @internal */
+export type GetSchoolByIdSchoolsResponseBody$Outbound = {
+  error: GetSchoolByIdSchoolsError$Outbound;
+};
+
+/** @internal */
+export const GetSchoolByIdSchoolsResponseBody$outboundSchema: z.ZodType<
+  GetSchoolByIdSchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByIdSchoolsResponseBody
+> = z.object({
+  error: z.lazy(() => GetSchoolByIdSchoolsError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdSchoolsResponseBody$ {
+  /** @deprecated use `GetSchoolByIdSchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdSchoolsResponseBody$inboundSchema;
+  /** @deprecated use `GetSchoolByIdSchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdSchoolsResponseBody$outboundSchema;
+  /** @deprecated use `GetSchoolByIdSchoolsResponseBody$Outbound` instead. */
+  export type Outbound = GetSchoolByIdSchoolsResponseBody$Outbound;
+}
+
+export function getSchoolByIdSchoolsResponseBodyToJSON(
+  getSchoolByIdSchoolsResponseBody: GetSchoolByIdSchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    GetSchoolByIdSchoolsResponseBody$outboundSchema.parse(
+      getSchoolByIdSchoolsResponseBody,
+    ),
+  );
+}
+
+export function getSchoolByIdSchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByIdSchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByIdSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByIdSchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByIdType$inboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByIdType
+> = z.nativeEnum(GetSchoolByIdType);
+
+/** @internal */
+export const GetSchoolByIdType$outboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolByIdType
+> = GetSchoolByIdType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdType$ {
+  /** @deprecated use `GetSchoolByIdType$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdType$inboundSchema;
+  /** @deprecated use `GetSchoolByIdType$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdType$outboundSchema;
+}
+
+/** @internal */
+export const GetSchoolByIdError$inboundSchema: z.ZodType<
+  GetSchoolByIdError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByIdType$inboundSchema,
+});
+
+/** @internal */
+export type GetSchoolByIdError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetSchoolByIdError$outboundSchema: z.ZodType<
+  GetSchoolByIdError$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByIdError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolByIdType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdError$ {
+  /** @deprecated use `GetSchoolByIdError$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdError$inboundSchema;
+  /** @deprecated use `GetSchoolByIdError$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdError$outboundSchema;
+  /** @deprecated use `GetSchoolByIdError$Outbound` instead. */
+  export type Outbound = GetSchoolByIdError$Outbound;
+}
+
+export function getSchoolByIdErrorToJSON(
+  getSchoolByIdError: GetSchoolByIdError,
+): string {
+  return JSON.stringify(
+    GetSchoolByIdError$outboundSchema.parse(getSchoolByIdError),
+  );
+}
+
+export function getSchoolByIdErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByIdError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByIdError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByIdError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByIdResponseBody$inboundSchema: z.ZodType<
+  GetSchoolByIdResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolByIdError$inboundSchema),
+});
+
+/** @internal */
+export type GetSchoolByIdResponseBody$Outbound = {
+  error: GetSchoolByIdError$Outbound;
+};
+
+/** @internal */
+export const GetSchoolByIdResponseBody$outboundSchema: z.ZodType<
+  GetSchoolByIdResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByIdResponseBody
+> = z.object({
+  error: z.lazy(() => GetSchoolByIdError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdResponseBody$ {
+  /** @deprecated use `GetSchoolByIdResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdResponseBody$inboundSchema;
+  /** @deprecated use `GetSchoolByIdResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdResponseBody$outboundSchema;
+  /** @deprecated use `GetSchoolByIdResponseBody$Outbound` instead. */
+  export type Outbound = GetSchoolByIdResponseBody$Outbound;
+}
+
+export function getSchoolByIdResponseBodyToJSON(
+  getSchoolByIdResponseBody: GetSchoolByIdResponseBody,
+): string {
+  return JSON.stringify(
+    GetSchoolByIdResponseBody$outboundSchema.parse(getSchoolByIdResponseBody),
+  );
+}
+
+export function getSchoolByIdResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByIdResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByIdResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByIdResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolByIdResponse$inboundSchema: z.ZodType<
+  GetSchoolByIdResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.School$inboundSchema,
+  z.lazy(() => GetSchoolByIdResponseBody$inboundSchema),
+  z.lazy(() => GetSchoolByIdSchoolsResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetSchoolByIdResponse$Outbound =
+  | shared.School$Outbound
+  | GetSchoolByIdResponseBody$Outbound
+  | GetSchoolByIdSchoolsResponseBody$Outbound;
+
+/** @internal */
+export const GetSchoolByIdResponse$outboundSchema: z.ZodType<
+  GetSchoolByIdResponse$Outbound,
+  z.ZodTypeDef,
+  GetSchoolByIdResponse
+> = z.union([
+  shared.School$outboundSchema,
+  z.lazy(() => GetSchoolByIdResponseBody$outboundSchema),
+  z.lazy(() => GetSchoolByIdSchoolsResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolByIdResponse$ {
+  /** @deprecated use `GetSchoolByIdResponse$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolByIdResponse$inboundSchema;
+  /** @deprecated use `GetSchoolByIdResponse$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolByIdResponse$outboundSchema;
+  /** @deprecated use `GetSchoolByIdResponse$Outbound` instead. */
+  export type Outbound = GetSchoolByIdResponse$Outbound;
+}
+
+export function getSchoolByIdResponseToJSON(
+  getSchoolByIdResponse: GetSchoolByIdResponse,
+): string {
+  return JSON.stringify(
+    GetSchoolByIdResponse$outboundSchema.parse(getSchoolByIdResponse),
+  );
+}
+
+export function getSchoolByIdResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolByIdResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolByIdResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolByIdResponse' from JSON`,
+  );
+}