@vepler/sdk 1.9.11 → 1.10.1

package/src/sdk/models/shared/school.ts

@@ -0,0 +1,588 @@
+/*
+ * 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";
+
+/**
+ * School address information
+ */
+export type Address = {
+  /**
+   * County or region
+   */
+  county?: string | undefined;
+  /**
+   * Locality or district
+   */
+  locality?: string | undefined;
+  /**
+   * UK postcode
+   */
+  postcode?: string | undefined;
+  /**
+   * Street name and number
+   */
+  street?: string | undefined;
+  /**
+   * Town or city
+   */
+  town?: string | undefined;
+};
+
+/**
+ * Current Ofsted rating
+ */
+export const CurrentRating = {
+  Outstanding: "outstanding",
+  Good: "good",
+  Satisfactory: "satisfactory",
+  Inadequate: "inadequate",
+} as const;
+/**
+ * Current Ofsted rating
+ */
+export type CurrentRating = ClosedEnum<typeof CurrentRating>;
+
+/**
+ * Geographic coordinates
+ */
+export type Location = {
+  /**
+   * WGS84 latitude coordinate
+   */
+  latitude: number;
+  /**
+   * WGS84 longitude coordinate
+   */
+  longitude: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const ObjectT = {
+  School: "school",
+} as const;
+/**
+ * Object type identifier
+ */
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+
+/**
+ * Current operational status
+ */
+export const SchoolStatus = {
+  Open: "open",
+  Closed: "closed",
+  PendingClosure: "pending_closure",
+} as const;
+/**
+ * Current operational status
+ */
+export type SchoolStatus = ClosedEnum<typeof SchoolStatus>;
+
+/**
+ * Type of educational institution
+ */
+export const SchoolType = {
+  Nursery: "nursery",
+  Primary: "primary",
+  Secondary: "secondary",
+  AllThrough: "all-through",
+  SixthForm: "sixth-form",
+  Special: "special",
+  Independent: "independent",
+  Academy: "academy",
+  Other: "other",
+} as const;
+/**
+ * Type of educational institution
+ */
+export type SchoolType = ClosedEnum<typeof SchoolType>;
+
+export type School = {
+  /**
+   * School address information
+   */
+  address?: Address | undefined;
+  /**
+   * Admissions policy type
+   */
+  admissionsPolicy?: string | undefined;
+  /**
+   * Age range of students
+   */
+  ageRange?: string | undefined;
+  /**
+   * Maximum student capacity
+   */
+  capacity?: number | undefined;
+  /**
+   * Creation timestamp in ISO format
+   */
+  createdAt: string;
+  /**
+   * Current Ofsted rating
+   */
+  currentRating?: CurrentRating | undefined;
+  /**
+   * Current Ofsted rating value
+   */
+  currentRatingValue?: string | undefined;
+  /**
+   * Distance from search point in meters (only in geographic searches)
+   */
+  distance?: number | undefined;
+  /**
+   * DfE establishment number
+   */
+  establishmentNumber?: number | undefined;
+  /**
+   * Gender admission policy
+   */
+  gender?: string | undefined;
+  /**
+   * Name of the headteacher or principal
+   */
+  headteacher?: string | undefined;
+  /**
+   * Unique internal identifier
+   */
+  id: number;
+  /**
+   * Local authority code
+   */
+  laCode?: string | undefined;
+  /**
+   * Local authority name
+   */
+  laName?: string | undefined;
+  /**
+   * Date of last Ofsted inspection
+   */
+  lastInspectionDate?: string | undefined;
+  /**
+   * Last data update timestamp in ISO format
+   */
+  lastUpdated: string;
+  /**
+   * Geographic coordinates
+   */
+  location?: Location | undefined;
+  /**
+   * Lower level geography code (LSOA)
+   */
+  lowerLevelGeographyCode: string | null;
+  /**
+   * Official name of the school
+   */
+  name: string;
+  /**
+   * Current number of enrolled students
+   */
+  numberOfPupils?: number | undefined;
+  /**
+   * Object type identifier
+   */
+  object: ObjectT;
+  /**
+   * Educational phase (e.g., Primary, Secondary, All-through)
+   */
+  phase?: string | undefined;
+  /**
+   * Religious affiliation if any
+   */
+  religiousCharacter?: string | undefined;
+  /**
+   * URL-friendly version of the school name
+   */
+  slug: string | null;
+  /**
+   * Special educational provision
+   */
+  specialClasses?: string | undefined;
+  /**
+   * Specialist resources available
+   */
+  specialistResource?: string | undefined;
+  /**
+   * Current operational status
+   */
+  status: SchoolStatus;
+  /**
+   * Sub-type of educational institution
+   */
+  subType: string;
+  /**
+   * Main contact telephone number
+   */
+  telephone?: string | undefined;
+  /**
+   * Unique identifier of the academy trust
+   */
+  trustId?: string | undefined;
+  /**
+   * Name of the academy trust if applicable
+   */
+  trustName?: string | undefined;
+  /**
+   * Type of educational institution
+   */
+  type: SchoolType;
+  /**
+   * Last update timestamp in ISO format
+   */
+  updatedAt: string;
+  /**
+   * Unique Reference Number assigned by the Department for Education
+   */
+  urn: number;
+  /**
+   * School website URL
+   */
+  website?: string | undefined;
+};
+
+/** @internal */
+export const Address$inboundSchema: z.ZodType<Address, z.ZodTypeDef, unknown> =
+  z.object({
+    county: z.string().optional(),
+    locality: z.string().optional(),
+    postcode: z.string().optional(),
+    street: z.string().optional(),
+    town: z.string().optional(),
+  });
+
+/** @internal */
+export type Address$Outbound = {
+  county?: string | undefined;
+  locality?: string | undefined;
+  postcode?: string | undefined;
+  street?: string | undefined;
+  town?: string | undefined;
+};
+
+/** @internal */
+export const Address$outboundSchema: z.ZodType<
+  Address$Outbound,
+  z.ZodTypeDef,
+  Address
+> = z.object({
+  county: z.string().optional(),
+  locality: z.string().optional(),
+  postcode: z.string().optional(),
+  street: z.string().optional(),
+  town: 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 Address$ {
+  /** @deprecated use `Address$inboundSchema` instead. */
+  export const inboundSchema = Address$inboundSchema;
+  /** @deprecated use `Address$outboundSchema` instead. */
+  export const outboundSchema = Address$outboundSchema;
+  /** @deprecated use `Address$Outbound` instead. */
+  export type Outbound = Address$Outbound;
+}
+
+export function addressToJSON(address: Address): string {
+  return JSON.stringify(Address$outboundSchema.parse(address));
+}
+
+export function addressFromJSON(
+  jsonString: string,
+): SafeParseResult<Address, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Address$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Address' from JSON`,
+  );
+}
+
+/** @internal */
+export const CurrentRating$inboundSchema: z.ZodNativeEnum<
+  typeof CurrentRating
+> = z.nativeEnum(CurrentRating);
+
+/** @internal */
+export const CurrentRating$outboundSchema: z.ZodNativeEnum<
+  typeof CurrentRating
+> = CurrentRating$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CurrentRating$ {
+  /** @deprecated use `CurrentRating$inboundSchema` instead. */
+  export const inboundSchema = CurrentRating$inboundSchema;
+  /** @deprecated use `CurrentRating$outboundSchema` instead. */
+  export const outboundSchema = CurrentRating$outboundSchema;
+}
+
+/** @internal */
+export const Location$inboundSchema: z.ZodType<
+  Location,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  latitude: z.number(),
+  longitude: z.number(),
+});
+
+/** @internal */
+export type Location$Outbound = {
+  latitude: number;
+  longitude: number;
+};
+
+/** @internal */
+export const Location$outboundSchema: z.ZodType<
+  Location$Outbound,
+  z.ZodTypeDef,
+  Location
+> = z.object({
+  latitude: z.number(),
+  longitude: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Location$ {
+  /** @deprecated use `Location$inboundSchema` instead. */
+  export const inboundSchema = Location$inboundSchema;
+  /** @deprecated use `Location$outboundSchema` instead. */
+  export const outboundSchema = Location$outboundSchema;
+  /** @deprecated use `Location$Outbound` instead. */
+  export type Outbound = Location$Outbound;
+}
+
+export function locationToJSON(location: Location): string {
+  return JSON.stringify(Location$outboundSchema.parse(location));
+}
+
+export function locationFromJSON(
+  jsonString: string,
+): SafeParseResult<Location, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Location$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Location' from JSON`,
+  );
+}
+
+/** @internal */
+export const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT> = z
+  .nativeEnum(ObjectT);
+
+/** @internal */
+export const ObjectT$outboundSchema: z.ZodNativeEnum<typeof ObjectT> =
+  ObjectT$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ObjectT$ {
+  /** @deprecated use `ObjectT$inboundSchema` instead. */
+  export const inboundSchema = ObjectT$inboundSchema;
+  /** @deprecated use `ObjectT$outboundSchema` instead. */
+  export const outboundSchema = ObjectT$outboundSchema;
+}
+
+/** @internal */
+export const SchoolStatus$inboundSchema: z.ZodNativeEnum<typeof SchoolStatus> =
+  z.nativeEnum(SchoolStatus);
+
+/** @internal */
+export const SchoolStatus$outboundSchema: z.ZodNativeEnum<typeof SchoolStatus> =
+  SchoolStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SchoolStatus$ {
+  /** @deprecated use `SchoolStatus$inboundSchema` instead. */
+  export const inboundSchema = SchoolStatus$inboundSchema;
+  /** @deprecated use `SchoolStatus$outboundSchema` instead. */
+  export const outboundSchema = SchoolStatus$outboundSchema;
+}
+
+/** @internal */
+export const SchoolType$inboundSchema: z.ZodNativeEnum<typeof SchoolType> = z
+  .nativeEnum(SchoolType);
+
+/** @internal */
+export const SchoolType$outboundSchema: z.ZodNativeEnum<typeof SchoolType> =
+  SchoolType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SchoolType$ {
+  /** @deprecated use `SchoolType$inboundSchema` instead. */
+  export const inboundSchema = SchoolType$inboundSchema;
+  /** @deprecated use `SchoolType$outboundSchema` instead. */
+  export const outboundSchema = SchoolType$outboundSchema;
+}
+
+/** @internal */
+export const School$inboundSchema: z.ZodType<School, z.ZodTypeDef, unknown> = z
+  .object({
+    address: z.lazy(() => Address$inboundSchema).optional(),
+    admissionsPolicy: z.string().optional(),
+    ageRange: z.string().optional(),
+    capacity: z.number().optional(),
+    createdAt: z.string(),
+    currentRating: CurrentRating$inboundSchema.optional(),
+    currentRatingValue: z.string().optional(),
+    distance: z.number().optional(),
+    establishmentNumber: z.number().optional(),
+    gender: z.string().optional(),
+    headteacher: z.string().optional(),
+    id: z.number(),
+    laCode: z.string().optional(),
+    laName: z.string().optional(),
+    lastInspectionDate: z.string().optional(),
+    lastUpdated: z.string(),
+    location: z.lazy(() => Location$inboundSchema).optional(),
+    lowerLevelGeographyCode: z.nullable(z.string()),
+    name: z.string(),
+    numberOfPupils: z.number().optional(),
+    object: ObjectT$inboundSchema,
+    phase: z.string().optional(),
+    religiousCharacter: z.string().optional(),
+    slug: z.nullable(z.string()),
+    specialClasses: z.string().optional(),
+    specialistResource: z.string().optional(),
+    status: SchoolStatus$inboundSchema,
+    subType: z.string(),
+    telephone: z.string().optional(),
+    trustId: z.string().optional(),
+    trustName: z.string().optional(),
+    type: SchoolType$inboundSchema,
+    updatedAt: z.string(),
+    urn: z.number(),
+    website: z.string().optional(),
+  });
+
+/** @internal */
+export type School$Outbound = {
+  address?: Address$Outbound | undefined;
+  admissionsPolicy?: string | undefined;
+  ageRange?: string | undefined;
+  capacity?: number | undefined;
+  createdAt: string;
+  currentRating?: string | undefined;
+  currentRatingValue?: string | undefined;
+  distance?: number | undefined;
+  establishmentNumber?: number | undefined;
+  gender?: string | undefined;
+  headteacher?: string | undefined;
+  id: number;
+  laCode?: string | undefined;
+  laName?: string | undefined;
+  lastInspectionDate?: string | undefined;
+  lastUpdated: string;
+  location?: Location$Outbound | undefined;
+  lowerLevelGeographyCode: string | null;
+  name: string;
+  numberOfPupils?: number | undefined;
+  object: string;
+  phase?: string | undefined;
+  religiousCharacter?: string | undefined;
+  slug: string | null;
+  specialClasses?: string | undefined;
+  specialistResource?: string | undefined;
+  status: string;
+  subType: string;
+  telephone?: string | undefined;
+  trustId?: string | undefined;
+  trustName?: string | undefined;
+  type: string;
+  updatedAt: string;
+  urn: number;
+  website?: string | undefined;
+};
+
+/** @internal */
+export const School$outboundSchema: z.ZodType<
+  School$Outbound,
+  z.ZodTypeDef,
+  School
+> = z.object({
+  address: z.lazy(() => Address$outboundSchema).optional(),
+  admissionsPolicy: z.string().optional(),
+  ageRange: z.string().optional(),
+  capacity: z.number().optional(),
+  createdAt: z.string(),
+  currentRating: CurrentRating$outboundSchema.optional(),
+  currentRatingValue: z.string().optional(),
+  distance: z.number().optional(),
+  establishmentNumber: z.number().optional(),
+  gender: z.string().optional(),
+  headteacher: z.string().optional(),
+  id: z.number(),
+  laCode: z.string().optional(),
+  laName: z.string().optional(),
+  lastInspectionDate: z.string().optional(),
+  lastUpdated: z.string(),
+  location: z.lazy(() => Location$outboundSchema).optional(),
+  lowerLevelGeographyCode: z.nullable(z.string()),
+  name: z.string(),
+  numberOfPupils: z.number().optional(),
+  object: ObjectT$outboundSchema,
+  phase: z.string().optional(),
+  religiousCharacter: z.string().optional(),
+  slug: z.nullable(z.string()),
+  specialClasses: z.string().optional(),
+  specialistResource: z.string().optional(),
+  status: SchoolStatus$outboundSchema,
+  subType: z.string(),
+  telephone: z.string().optional(),
+  trustId: z.string().optional(),
+  trustName: z.string().optional(),
+  type: SchoolType$outboundSchema,
+  updatedAt: z.string(),
+  urn: z.number(),
+  website: 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 School$ {
+  /** @deprecated use `School$inboundSchema` instead. */
+  export const inboundSchema = School$inboundSchema;
+  /** @deprecated use `School$outboundSchema` instead. */
+  export const outboundSchema = School$outboundSchema;
+  /** @deprecated use `School$Outbound` instead. */
+  export type Outbound = School$Outbound;
+}
+
+export function schoolToJSON(school: School): string {
+  return JSON.stringify(School$outboundSchema.parse(school));
+}
+
+export function schoolFromJSON(
+  jsonString: string,
+): SafeParseResult<School, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => School$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'School' from JSON`,
+  );
+}

package/src/sdk/models/shared/streetquerybycoordinates.ts

@@ -17,11 +17,11 @@ export type StreetQueryByCoordinatesType = ClosedEnum<
 
 export type StreetQueryByCoordinates = {
   /**
-   * Latitude
+   * Latitude in decimal degrees
    */
   lat: number;
   /**
-   * Longitude
+   * Longitude in decimal degrees
    */
   lng: number;
   /**

package/src/sdk/safety.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { safetyGetV1SafetyCrime } from "../funcs/safetyGetV1SafetyCrime.js";
+import { safetyGetV1SafetyCrimeStats } from "../funcs/safetyGetV1SafetyCrimeStats.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class Safety extends ClientSDK {
+  /**
+   * Get crime data near location
+   *
+   * @remarks
+   * Retrieve crime incidents within a specified radius of coordinates
+   */
+  async getV1SafetyCrime(
+    request: operations.GetV1SafetyCrimeRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1SafetyCrimeResponse> {
+    return unwrapAsync(safetyGetV1SafetyCrime(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get crime statistics for an area
+   *
+   * @remarks
+   * Retrieve aggregated crime statistics for a specified area
+   */
+  async getV1SafetyCrimeStats(
+    request: operations.GetV1SafetyCrimeStatsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetV1SafetyCrimeStatsResponse> {
+    return unwrapAsync(safetyGetV1SafetyCrimeStats(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/schoolmetrics.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { schoolMetricsGetMetrics } from "../funcs/schoolMetricsGetMetrics.js";
+import { schoolMetricsListProfiles } from "../funcs/schoolMetricsListProfiles.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export class SchoolMetrics extends ClientSDK {
+  /**
+   * Get school metrics
+   *
+   * @remarks
+   * Retrieve metrics for specified schools using metric codes or predefined profiles. Supports both point-in-time and time series queries.
+   */
+  async getMetrics(
+    request: operations.GetSchoolMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetSchoolMetricsResponse> {
+    return unwrapAsync(schoolMetricsGetMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * List metric profiles
+   *
+   * @remarks
+   * Get a list of all available metric profiles with their descriptions and metric counts
+   */
+  async listProfiles(
+    options?: RequestOptions,
+  ): Promise<operations.GetMetricProfilesResponseBody> {
+    return unwrapAsync(schoolMetricsListProfiles(
+      this,
+      options,
+    ));
+  }
+}