@vepler/sdk 1.9.11 → 1.10.0

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

@@ -2,12 +2,20 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./getmetricprofiles.js";
 export * from "./getplanningapplications.js";
 export * from "./getplanningapplicationsbysource.js";
 export * from "./getproperties.js";
 export * from "./getpropertiesbylocation.js";
 export * from "./getpropertiesbyslugs.js";
 export * from "./getpropertiesbysource.js";
+export * from "./getschoolbyid.js";
+export * from "./getschoolbyslug.js";
+export * from "./getschoolbyurn.js";
+export * from "./getschoolmetrics.js";
+export * from "./listschools.js";
 export * from "./searchplanningapplications.js";
 export * from "./searchproperties.js";
+export * from "./searchschoolsnearby.js";
+export * from "./searchschoolswithin.js";
 export * from "./searchstreets.js";

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

@@ -0,0 +1,470 @@
+/*
+ * 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";
+
+export type ListSchoolsRequest = {
+  /**
+   * Filter by local authority
+   */
+  authority?: string | undefined;
+  /**
+   * Comma-separated list of related data to include (currently supports: ratings)
+   */
+  expand?: string | undefined;
+  /**
+   * Comma-separated list of fields to include
+   */
+  fields?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: string | undefined;
+  /**
+   * Number of results to skip
+   */
+  offset?: string | undefined;
+  /**
+   * Filter by postcode area
+   */
+  postcode?: string | undefined;
+  /**
+   * Search query for school name or URN
+   */
+  query?: string | undefined;
+  /**
+   * Filter by Ofsted rating
+   */
+  rating?: string | undefined;
+  /**
+   * Filter by school status
+   */
+  status?: string | undefined;
+  /**
+   * Filter by school type
+   */
+  type?: string | undefined;
+};
+
+export const ListSchoolsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type ListSchoolsType = ClosedEnum<typeof ListSchoolsType>;
+
+export type ListSchoolsError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: ListSchoolsType;
+};
+
+/**
+ * Error response
+ */
+export type ListSchoolsSchoolsResponseBody = {
+  error: ListSchoolsError;
+};
+
+export const ListSchoolsObject = {
+  List: "list",
+} as const;
+export type ListSchoolsObject = ClosedEnum<typeof ListSchoolsObject>;
+
+/**
+ * Paginated list of schools
+ */
+export type ListSchoolsResponseBody = {
+  data: Array<shared.School>;
+  hasMore: boolean;
+  object: ListSchoolsObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+export type ListSchoolsResponse =
+  | ListSchoolsResponseBody
+  | ListSchoolsSchoolsResponseBody;
+
+/** @internal */
+export const ListSchoolsRequest$inboundSchema: z.ZodType<
+  ListSchoolsRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  authority: z.string().optional(),
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  limit: z.string().optional(),
+  offset: z.string().optional(),
+  postcode: z.string().optional(),
+  query: z.string().optional(),
+  rating: z.string().optional(),
+  status: z.string().optional(),
+  type: z.string().optional(),
+});
+
+/** @internal */
+export type ListSchoolsRequest$Outbound = {
+  authority?: string | undefined;
+  expand?: string | undefined;
+  fields?: string | undefined;
+  limit?: string | undefined;
+  offset?: string | undefined;
+  postcode?: string | undefined;
+  query?: string | undefined;
+  rating?: string | undefined;
+  status?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const ListSchoolsRequest$outboundSchema: z.ZodType<
+  ListSchoolsRequest$Outbound,
+  z.ZodTypeDef,
+  ListSchoolsRequest
+> = z.object({
+  authority: z.string().optional(),
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  limit: z.string().optional(),
+  offset: z.string().optional(),
+  postcode: z.string().optional(),
+  query: z.string().optional(),
+  rating: z.string().optional(),
+  status: z.string().optional(),
+  type: 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 ListSchoolsRequest$ {
+  /** @deprecated use `ListSchoolsRequest$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsRequest$inboundSchema;
+  /** @deprecated use `ListSchoolsRequest$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsRequest$outboundSchema;
+  /** @deprecated use `ListSchoolsRequest$Outbound` instead. */
+  export type Outbound = ListSchoolsRequest$Outbound;
+}
+
+export function listSchoolsRequestToJSON(
+  listSchoolsRequest: ListSchoolsRequest,
+): string {
+  return JSON.stringify(
+    ListSchoolsRequest$outboundSchema.parse(listSchoolsRequest),
+  );
+}
+
+export function listSchoolsRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSchoolsRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSchoolsRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSchoolsRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSchoolsType$inboundSchema: z.ZodNativeEnum<
+  typeof ListSchoolsType
+> = z.nativeEnum(ListSchoolsType);
+
+/** @internal */
+export const ListSchoolsType$outboundSchema: z.ZodNativeEnum<
+  typeof ListSchoolsType
+> = ListSchoolsType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListSchoolsType$ {
+  /** @deprecated use `ListSchoolsType$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsType$inboundSchema;
+  /** @deprecated use `ListSchoolsType$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsType$outboundSchema;
+}
+
+/** @internal */
+export const ListSchoolsError$inboundSchema: z.ZodType<
+  ListSchoolsError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: ListSchoolsType$inboundSchema,
+});
+
+/** @internal */
+export type ListSchoolsError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const ListSchoolsError$outboundSchema: z.ZodType<
+  ListSchoolsError$Outbound,
+  z.ZodTypeDef,
+  ListSchoolsError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: ListSchoolsType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListSchoolsError$ {
+  /** @deprecated use `ListSchoolsError$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsError$inboundSchema;
+  /** @deprecated use `ListSchoolsError$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsError$outboundSchema;
+  /** @deprecated use `ListSchoolsError$Outbound` instead. */
+  export type Outbound = ListSchoolsError$Outbound;
+}
+
+export function listSchoolsErrorToJSON(
+  listSchoolsError: ListSchoolsError,
+): string {
+  return JSON.stringify(
+    ListSchoolsError$outboundSchema.parse(listSchoolsError),
+  );
+}
+
+export function listSchoolsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSchoolsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSchoolsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSchoolsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSchoolsSchoolsResponseBody$inboundSchema: z.ZodType<
+  ListSchoolsSchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ListSchoolsError$inboundSchema),
+});
+
+/** @internal */
+export type ListSchoolsSchoolsResponseBody$Outbound = {
+  error: ListSchoolsError$Outbound;
+};
+
+/** @internal */
+export const ListSchoolsSchoolsResponseBody$outboundSchema: z.ZodType<
+  ListSchoolsSchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListSchoolsSchoolsResponseBody
+> = z.object({
+  error: z.lazy(() => ListSchoolsError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListSchoolsSchoolsResponseBody$ {
+  /** @deprecated use `ListSchoolsSchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsSchoolsResponseBody$inboundSchema;
+  /** @deprecated use `ListSchoolsSchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsSchoolsResponseBody$outboundSchema;
+  /** @deprecated use `ListSchoolsSchoolsResponseBody$Outbound` instead. */
+  export type Outbound = ListSchoolsSchoolsResponseBody$Outbound;
+}
+
+export function listSchoolsSchoolsResponseBodyToJSON(
+  listSchoolsSchoolsResponseBody: ListSchoolsSchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    ListSchoolsSchoolsResponseBody$outboundSchema.parse(
+      listSchoolsSchoolsResponseBody,
+    ),
+  );
+}
+
+export function listSchoolsSchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSchoolsSchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSchoolsSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSchoolsSchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSchoolsObject$inboundSchema: z.ZodNativeEnum<
+  typeof ListSchoolsObject
+> = z.nativeEnum(ListSchoolsObject);
+
+/** @internal */
+export const ListSchoolsObject$outboundSchema: z.ZodNativeEnum<
+  typeof ListSchoolsObject
+> = ListSchoolsObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListSchoolsObject$ {
+  /** @deprecated use `ListSchoolsObject$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsObject$inboundSchema;
+  /** @deprecated use `ListSchoolsObject$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsObject$outboundSchema;
+}
+
+/** @internal */
+export const ListSchoolsResponseBody$inboundSchema: z.ZodType<
+  ListSchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.School$inboundSchema),
+  has_more: z.boolean(),
+  object: ListSchoolsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type ListSchoolsResponseBody$Outbound = {
+  data: Array<shared.School$Outbound>;
+  has_more: boolean;
+  object: string;
+  total_count?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export const ListSchoolsResponseBody$outboundSchema: z.ZodType<
+  ListSchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  ListSchoolsResponseBody
+> = z.object({
+  data: z.array(shared.School$outboundSchema),
+  hasMore: z.boolean(),
+  object: ListSchoolsObject$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 ListSchoolsResponseBody$ {
+  /** @deprecated use `ListSchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsResponseBody$inboundSchema;
+  /** @deprecated use `ListSchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsResponseBody$outboundSchema;
+  /** @deprecated use `ListSchoolsResponseBody$Outbound` instead. */
+  export type Outbound = ListSchoolsResponseBody$Outbound;
+}
+
+export function listSchoolsResponseBodyToJSON(
+  listSchoolsResponseBody: ListSchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    ListSchoolsResponseBody$outboundSchema.parse(listSchoolsResponseBody),
+  );
+}
+
+export function listSchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListSchoolsResponse$inboundSchema: z.ZodType<
+  ListSchoolsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => ListSchoolsResponseBody$inboundSchema),
+  z.lazy(() => ListSchoolsSchoolsResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type ListSchoolsResponse$Outbound =
+  | ListSchoolsResponseBody$Outbound
+  | ListSchoolsSchoolsResponseBody$Outbound;
+
+/** @internal */
+export const ListSchoolsResponse$outboundSchema: z.ZodType<
+  ListSchoolsResponse$Outbound,
+  z.ZodTypeDef,
+  ListSchoolsResponse
+> = z.union([
+  z.lazy(() => ListSchoolsResponseBody$outboundSchema),
+  z.lazy(() => ListSchoolsSchoolsResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ListSchoolsResponse$ {
+  /** @deprecated use `ListSchoolsResponse$inboundSchema` instead. */
+  export const inboundSchema = ListSchoolsResponse$inboundSchema;
+  /** @deprecated use `ListSchoolsResponse$outboundSchema` instead. */
+  export const outboundSchema = ListSchoolsResponse$outboundSchema;
+  /** @deprecated use `ListSchoolsResponse$Outbound` instead. */
+  export type Outbound = ListSchoolsResponse$Outbound;
+}
+
+export function listSchoolsResponseToJSON(
+  listSchoolsResponse: ListSchoolsResponse,
+): string {
+  return JSON.stringify(
+    ListSchoolsResponse$outboundSchema.parse(listSchoolsResponse),
+  );
+}
+
+export function listSchoolsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListSchoolsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListSchoolsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListSchoolsResponse' from JSON`,
+  );
+}