@vepler/sdk 1.9.10 → 1.10.0

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

@@ -0,0 +1,479 @@
+/*
+ * 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 GetSchoolBySlugRequest = {
+  /**
+   * 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 slug
+   */
+  slug: string;
+};
+
+export const GetSchoolBySlugSchoolsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type GetSchoolBySlugSchoolsType = ClosedEnum<
+  typeof GetSchoolBySlugSchoolsType
+>;
+
+export type GetSchoolBySlugSchoolsError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: GetSchoolBySlugSchoolsType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolBySlugSchoolsResponseBody = {
+  error: GetSchoolBySlugSchoolsError;
+};
+
+export const GetSchoolBySlugType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type GetSchoolBySlugType = ClosedEnum<typeof GetSchoolBySlugType>;
+
+export type GetSchoolBySlugError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: GetSchoolBySlugType;
+};
+
+/**
+ * Error response
+ */
+export type GetSchoolBySlugResponseBody = {
+  error: GetSchoolBySlugError;
+};
+
+export type GetSchoolBySlugResponse =
+  | shared.School
+  | GetSchoolBySlugResponseBody
+  | GetSchoolBySlugSchoolsResponseBody;
+
+/** @internal */
+export const GetSchoolBySlugRequest$inboundSchema: z.ZodType<
+  GetSchoolBySlugRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  slug: z.string(),
+});
+
+/** @internal */
+export type GetSchoolBySlugRequest$Outbound = {
+  expand?: string | undefined;
+  fields?: string | undefined;
+  slug: string;
+};
+
+/** @internal */
+export const GetSchoolBySlugRequest$outboundSchema: z.ZodType<
+  GetSchoolBySlugRequest$Outbound,
+  z.ZodTypeDef,
+  GetSchoolBySlugRequest
+> = z.object({
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  slug: 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 GetSchoolBySlugRequest$ {
+  /** @deprecated use `GetSchoolBySlugRequest$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugRequest$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugRequest$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugRequest$outboundSchema;
+  /** @deprecated use `GetSchoolBySlugRequest$Outbound` instead. */
+  export type Outbound = GetSchoolBySlugRequest$Outbound;
+}
+
+export function getSchoolBySlugRequestToJSON(
+  getSchoolBySlugRequest: GetSchoolBySlugRequest,
+): string {
+  return JSON.stringify(
+    GetSchoolBySlugRequest$outboundSchema.parse(getSchoolBySlugRequest),
+  );
+}
+
+export function getSchoolBySlugRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySlugRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySlugRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySlugRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolBySlugSchoolsType$inboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolBySlugSchoolsType
+> = z.nativeEnum(GetSchoolBySlugSchoolsType);
+
+/** @internal */
+export const GetSchoolBySlugSchoolsType$outboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolBySlugSchoolsType
+> = GetSchoolBySlugSchoolsType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugSchoolsType$ {
+  /** @deprecated use `GetSchoolBySlugSchoolsType$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugSchoolsType$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugSchoolsType$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugSchoolsType$outboundSchema;
+}
+
+/** @internal */
+export const GetSchoolBySlugSchoolsError$inboundSchema: z.ZodType<
+  GetSchoolBySlugSchoolsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolBySlugSchoolsType$inboundSchema,
+});
+
+/** @internal */
+export type GetSchoolBySlugSchoolsError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetSchoolBySlugSchoolsError$outboundSchema: z.ZodType<
+  GetSchoolBySlugSchoolsError$Outbound,
+  z.ZodTypeDef,
+  GetSchoolBySlugSchoolsError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolBySlugSchoolsType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugSchoolsError$ {
+  /** @deprecated use `GetSchoolBySlugSchoolsError$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugSchoolsError$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugSchoolsError$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugSchoolsError$outboundSchema;
+  /** @deprecated use `GetSchoolBySlugSchoolsError$Outbound` instead. */
+  export type Outbound = GetSchoolBySlugSchoolsError$Outbound;
+}
+
+export function getSchoolBySlugSchoolsErrorToJSON(
+  getSchoolBySlugSchoolsError: GetSchoolBySlugSchoolsError,
+): string {
+  return JSON.stringify(
+    GetSchoolBySlugSchoolsError$outboundSchema.parse(
+      getSchoolBySlugSchoolsError,
+    ),
+  );
+}
+
+export function getSchoolBySlugSchoolsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySlugSchoolsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySlugSchoolsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySlugSchoolsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolBySlugSchoolsResponseBody$inboundSchema: z.ZodType<
+  GetSchoolBySlugSchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolBySlugSchoolsError$inboundSchema),
+});
+
+/** @internal */
+export type GetSchoolBySlugSchoolsResponseBody$Outbound = {
+  error: GetSchoolBySlugSchoolsError$Outbound;
+};
+
+/** @internal */
+export const GetSchoolBySlugSchoolsResponseBody$outboundSchema: z.ZodType<
+  GetSchoolBySlugSchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetSchoolBySlugSchoolsResponseBody
+> = z.object({
+  error: z.lazy(() => GetSchoolBySlugSchoolsError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugSchoolsResponseBody$ {
+  /** @deprecated use `GetSchoolBySlugSchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugSchoolsResponseBody$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugSchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetSchoolBySlugSchoolsResponseBody$outboundSchema;
+  /** @deprecated use `GetSchoolBySlugSchoolsResponseBody$Outbound` instead. */
+  export type Outbound = GetSchoolBySlugSchoolsResponseBody$Outbound;
+}
+
+export function getSchoolBySlugSchoolsResponseBodyToJSON(
+  getSchoolBySlugSchoolsResponseBody: GetSchoolBySlugSchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    GetSchoolBySlugSchoolsResponseBody$outboundSchema.parse(
+      getSchoolBySlugSchoolsResponseBody,
+    ),
+  );
+}
+
+export function getSchoolBySlugSchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySlugSchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSchoolBySlugSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySlugSchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolBySlugType$inboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolBySlugType
+> = z.nativeEnum(GetSchoolBySlugType);
+
+/** @internal */
+export const GetSchoolBySlugType$outboundSchema: z.ZodNativeEnum<
+  typeof GetSchoolBySlugType
+> = GetSchoolBySlugType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugType$ {
+  /** @deprecated use `GetSchoolBySlugType$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugType$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugType$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugType$outboundSchema;
+}
+
+/** @internal */
+export const GetSchoolBySlugError$inboundSchema: z.ZodType<
+  GetSchoolBySlugError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolBySlugType$inboundSchema,
+});
+
+/** @internal */
+export type GetSchoolBySlugError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetSchoolBySlugError$outboundSchema: z.ZodType<
+  GetSchoolBySlugError$Outbound,
+  z.ZodTypeDef,
+  GetSchoolBySlugError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetSchoolBySlugType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugError$ {
+  /** @deprecated use `GetSchoolBySlugError$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugError$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugError$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugError$outboundSchema;
+  /** @deprecated use `GetSchoolBySlugError$Outbound` instead. */
+  export type Outbound = GetSchoolBySlugError$Outbound;
+}
+
+export function getSchoolBySlugErrorToJSON(
+  getSchoolBySlugError: GetSchoolBySlugError,
+): string {
+  return JSON.stringify(
+    GetSchoolBySlugError$outboundSchema.parse(getSchoolBySlugError),
+  );
+}
+
+export function getSchoolBySlugErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySlugError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySlugError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySlugError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolBySlugResponseBody$inboundSchema: z.ZodType<
+  GetSchoolBySlugResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetSchoolBySlugError$inboundSchema),
+});
+
+/** @internal */
+export type GetSchoolBySlugResponseBody$Outbound = {
+  error: GetSchoolBySlugError$Outbound;
+};
+
+/** @internal */
+export const GetSchoolBySlugResponseBody$outboundSchema: z.ZodType<
+  GetSchoolBySlugResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetSchoolBySlugResponseBody
+> = z.object({
+  error: z.lazy(() => GetSchoolBySlugError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugResponseBody$ {
+  /** @deprecated use `GetSchoolBySlugResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugResponseBody$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugResponseBody$outboundSchema;
+  /** @deprecated use `GetSchoolBySlugResponseBody$Outbound` instead. */
+  export type Outbound = GetSchoolBySlugResponseBody$Outbound;
+}
+
+export function getSchoolBySlugResponseBodyToJSON(
+  getSchoolBySlugResponseBody: GetSchoolBySlugResponseBody,
+): string {
+  return JSON.stringify(
+    GetSchoolBySlugResponseBody$outboundSchema.parse(
+      getSchoolBySlugResponseBody,
+    ),
+  );
+}
+
+export function getSchoolBySlugResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySlugResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySlugResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySlugResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSchoolBySlugResponse$inboundSchema: z.ZodType<
+  GetSchoolBySlugResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.School$inboundSchema,
+  z.lazy(() => GetSchoolBySlugResponseBody$inboundSchema),
+  z.lazy(() => GetSchoolBySlugSchoolsResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetSchoolBySlugResponse$Outbound =
+  | shared.School$Outbound
+  | GetSchoolBySlugResponseBody$Outbound
+  | GetSchoolBySlugSchoolsResponseBody$Outbound;
+
+/** @internal */
+export const GetSchoolBySlugResponse$outboundSchema: z.ZodType<
+  GetSchoolBySlugResponse$Outbound,
+  z.ZodTypeDef,
+  GetSchoolBySlugResponse
+> = z.union([
+  shared.School$outboundSchema,
+  z.lazy(() => GetSchoolBySlugResponseBody$outboundSchema),
+  z.lazy(() => GetSchoolBySlugSchoolsResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetSchoolBySlugResponse$ {
+  /** @deprecated use `GetSchoolBySlugResponse$inboundSchema` instead. */
+  export const inboundSchema = GetSchoolBySlugResponse$inboundSchema;
+  /** @deprecated use `GetSchoolBySlugResponse$outboundSchema` instead. */
+  export const outboundSchema = GetSchoolBySlugResponse$outboundSchema;
+  /** @deprecated use `GetSchoolBySlugResponse$Outbound` instead. */
+  export type Outbound = GetSchoolBySlugResponse$Outbound;
+}
+
+export function getSchoolBySlugResponseToJSON(
+  getSchoolBySlugResponse: GetSchoolBySlugResponse,
+): string {
+  return JSON.stringify(
+    GetSchoolBySlugResponse$outboundSchema.parse(getSchoolBySlugResponse),
+  );
+}
+
+export function getSchoolBySlugResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSchoolBySlugResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSchoolBySlugResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSchoolBySlugResponse' from JSON`,
+  );
+}