@vepler/sdk 1.9.10 → 1.10.0

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

@@ -0,0 +1,475 @@
+/*
+ * 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 SearchSchoolsWithinRequest = {
+  /**
+   * Eastern boundary longitude
+   */
+  east: string;
+  /**
+   * 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
+   */
+  limit?: string | undefined;
+  /**
+   * Northern boundary latitude
+   */
+  north: string;
+  /**
+   * Ofsted rating filter
+   */
+  rating?: string | undefined;
+  /**
+   * Southern boundary latitude
+   */
+  south: string;
+  /**
+   * School status filter
+   */
+  status?: string | undefined;
+  /**
+   * Western boundary longitude
+   */
+  west: string;
+};
+
+export const SearchSchoolsWithinType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+export type SearchSchoolsWithinType = ClosedEnum<
+  typeof SearchSchoolsWithinType
+>;
+
+export type SearchSchoolsWithinError = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: SearchSchoolsWithinType;
+};
+
+/**
+ * Error response
+ */
+export type SearchSchoolsWithinSchoolsResponseBody = {
+  error: SearchSchoolsWithinError;
+};
+
+export const SearchSchoolsWithinObject = {
+  List: "list",
+} as const;
+export type SearchSchoolsWithinObject = ClosedEnum<
+  typeof SearchSchoolsWithinObject
+>;
+
+/**
+ * Paginated list of schools
+ */
+export type SearchSchoolsWithinResponseBody = {
+  data: Array<shared.School>;
+  hasMore: boolean;
+  object: SearchSchoolsWithinObject;
+  totalCount?: number | undefined;
+  url: string;
+};
+
+export type SearchSchoolsWithinResponse =
+  | SearchSchoolsWithinResponseBody
+  | SearchSchoolsWithinSchoolsResponseBody;
+
+/** @internal */
+export const SearchSchoolsWithinRequest$inboundSchema: z.ZodType<
+  SearchSchoolsWithinRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  east: z.string(),
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  limit: z.string().optional(),
+  north: z.string(),
+  rating: z.string().optional(),
+  south: z.string(),
+  status: z.string().optional(),
+  west: z.string(),
+});
+
+/** @internal */
+export type SearchSchoolsWithinRequest$Outbound = {
+  east: string;
+  expand?: string | undefined;
+  fields?: string | undefined;
+  limit?: string | undefined;
+  north: string;
+  rating?: string | undefined;
+  south: string;
+  status?: string | undefined;
+  west: string;
+};
+
+/** @internal */
+export const SearchSchoolsWithinRequest$outboundSchema: z.ZodType<
+  SearchSchoolsWithinRequest$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsWithinRequest
+> = z.object({
+  east: z.string(),
+  expand: z.string().optional(),
+  fields: z.string().optional(),
+  limit: z.string().optional(),
+  north: z.string(),
+  rating: z.string().optional(),
+  south: z.string(),
+  status: z.string().optional(),
+  west: 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 SearchSchoolsWithinRequest$ {
+  /** @deprecated use `SearchSchoolsWithinRequest$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsWithinRequest$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinRequest$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsWithinRequest$outboundSchema;
+  /** @deprecated use `SearchSchoolsWithinRequest$Outbound` instead. */
+  export type Outbound = SearchSchoolsWithinRequest$Outbound;
+}
+
+export function searchSchoolsWithinRequestToJSON(
+  searchSchoolsWithinRequest: SearchSchoolsWithinRequest,
+): string {
+  return JSON.stringify(
+    SearchSchoolsWithinRequest$outboundSchema.parse(searchSchoolsWithinRequest),
+  );
+}
+
+export function searchSchoolsWithinRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsWithinRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsWithinRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsWithinRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsWithinType$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsWithinType
+> = z.nativeEnum(SearchSchoolsWithinType);
+
+/** @internal */
+export const SearchSchoolsWithinType$outboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsWithinType
+> = SearchSchoolsWithinType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsWithinType$ {
+  /** @deprecated use `SearchSchoolsWithinType$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsWithinType$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinType$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsWithinType$outboundSchema;
+}
+
+/** @internal */
+export const SearchSchoolsWithinError$inboundSchema: z.ZodType<
+  SearchSchoolsWithinError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: SearchSchoolsWithinType$inboundSchema,
+});
+
+/** @internal */
+export type SearchSchoolsWithinError$Outbound = {
+  code?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const SearchSchoolsWithinError$outboundSchema: z.ZodType<
+  SearchSchoolsWithinError$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsWithinError
+> = z.object({
+  code: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: SearchSchoolsWithinType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsWithinError$ {
+  /** @deprecated use `SearchSchoolsWithinError$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsWithinError$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinError$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsWithinError$outboundSchema;
+  /** @deprecated use `SearchSchoolsWithinError$Outbound` instead. */
+  export type Outbound = SearchSchoolsWithinError$Outbound;
+}
+
+export function searchSchoolsWithinErrorToJSON(
+  searchSchoolsWithinError: SearchSchoolsWithinError,
+): string {
+  return JSON.stringify(
+    SearchSchoolsWithinError$outboundSchema.parse(searchSchoolsWithinError),
+  );
+}
+
+export function searchSchoolsWithinErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsWithinError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsWithinError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsWithinError' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsWithinSchoolsResponseBody$inboundSchema: z.ZodType<
+  SearchSchoolsWithinSchoolsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => SearchSchoolsWithinError$inboundSchema),
+});
+
+/** @internal */
+export type SearchSchoolsWithinSchoolsResponseBody$Outbound = {
+  error: SearchSchoolsWithinError$Outbound;
+};
+
+/** @internal */
+export const SearchSchoolsWithinSchoolsResponseBody$outboundSchema: z.ZodType<
+  SearchSchoolsWithinSchoolsResponseBody$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsWithinSchoolsResponseBody
+> = z.object({
+  error: z.lazy(() => SearchSchoolsWithinError$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsWithinSchoolsResponseBody$ {
+  /** @deprecated use `SearchSchoolsWithinSchoolsResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    SearchSchoolsWithinSchoolsResponseBody$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinSchoolsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    SearchSchoolsWithinSchoolsResponseBody$outboundSchema;
+  /** @deprecated use `SearchSchoolsWithinSchoolsResponseBody$Outbound` instead. */
+  export type Outbound = SearchSchoolsWithinSchoolsResponseBody$Outbound;
+}
+
+export function searchSchoolsWithinSchoolsResponseBodyToJSON(
+  searchSchoolsWithinSchoolsResponseBody:
+    SearchSchoolsWithinSchoolsResponseBody,
+): string {
+  return JSON.stringify(
+    SearchSchoolsWithinSchoolsResponseBody$outboundSchema.parse(
+      searchSchoolsWithinSchoolsResponseBody,
+    ),
+  );
+}
+
+export function searchSchoolsWithinSchoolsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsWithinSchoolsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchSchoolsWithinSchoolsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsWithinSchoolsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsWithinObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsWithinObject
+> = z.nativeEnum(SearchSchoolsWithinObject);
+
+/** @internal */
+export const SearchSchoolsWithinObject$outboundSchema: z.ZodNativeEnum<
+  typeof SearchSchoolsWithinObject
+> = SearchSchoolsWithinObject$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsWithinObject$ {
+  /** @deprecated use `SearchSchoolsWithinObject$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsWithinObject$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinObject$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsWithinObject$outboundSchema;
+}
+
+/** @internal */
+export const SearchSchoolsWithinResponseBody$inboundSchema: z.ZodType<
+  SearchSchoolsWithinResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(shared.School$inboundSchema),
+  has_more: z.boolean(),
+  object: SearchSchoolsWithinObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+/** @internal */
+export type SearchSchoolsWithinResponseBody$Outbound = {
+  data: Array<shared.School$Outbound>;
+  has_more: boolean;
+  object: string;
+  total_count?: number | undefined;
+  url: string;
+};
+
+/** @internal */
+export const SearchSchoolsWithinResponseBody$outboundSchema: z.ZodType<
+  SearchSchoolsWithinResponseBody$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsWithinResponseBody
+> = z.object({
+  data: z.array(shared.School$outboundSchema),
+  hasMore: z.boolean(),
+  object: SearchSchoolsWithinObject$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 SearchSchoolsWithinResponseBody$ {
+  /** @deprecated use `SearchSchoolsWithinResponseBody$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsWithinResponseBody$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinResponseBody$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsWithinResponseBody$outboundSchema;
+  /** @deprecated use `SearchSchoolsWithinResponseBody$Outbound` instead. */
+  export type Outbound = SearchSchoolsWithinResponseBody$Outbound;
+}
+
+export function searchSchoolsWithinResponseBodyToJSON(
+  searchSchoolsWithinResponseBody: SearchSchoolsWithinResponseBody,
+): string {
+  return JSON.stringify(
+    SearchSchoolsWithinResponseBody$outboundSchema.parse(
+      searchSchoolsWithinResponseBody,
+    ),
+  );
+}
+
+export function searchSchoolsWithinResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsWithinResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsWithinResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsWithinResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSchoolsWithinResponse$inboundSchema: z.ZodType<
+  SearchSchoolsWithinResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => SearchSchoolsWithinResponseBody$inboundSchema),
+  z.lazy(() => SearchSchoolsWithinSchoolsResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type SearchSchoolsWithinResponse$Outbound =
+  | SearchSchoolsWithinResponseBody$Outbound
+  | SearchSchoolsWithinSchoolsResponseBody$Outbound;
+
+/** @internal */
+export const SearchSchoolsWithinResponse$outboundSchema: z.ZodType<
+  SearchSchoolsWithinResponse$Outbound,
+  z.ZodTypeDef,
+  SearchSchoolsWithinResponse
+> = z.union([
+  z.lazy(() => SearchSchoolsWithinResponseBody$outboundSchema),
+  z.lazy(() => SearchSchoolsWithinSchoolsResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchSchoolsWithinResponse$ {
+  /** @deprecated use `SearchSchoolsWithinResponse$inboundSchema` instead. */
+  export const inboundSchema = SearchSchoolsWithinResponse$inboundSchema;
+  /** @deprecated use `SearchSchoolsWithinResponse$outboundSchema` instead. */
+  export const outboundSchema = SearchSchoolsWithinResponse$outboundSchema;
+  /** @deprecated use `SearchSchoolsWithinResponse$Outbound` instead. */
+  export type Outbound = SearchSchoolsWithinResponse$Outbound;
+}
+
+export function searchSchoolsWithinResponseToJSON(
+  searchSchoolsWithinResponse: SearchSchoolsWithinResponse,
+): string {
+  return JSON.stringify(
+    SearchSchoolsWithinResponse$outboundSchema.parse(
+      searchSchoolsWithinResponse,
+    ),
+  );
+}
+
+export function searchSchoolsWithinResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSchoolsWithinResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSchoolsWithinResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSchoolsWithinResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
+
+export type SearchStreetsResponse =
+  | shared.StreetQueryResponse
+  | shared.ErrorResponse;
+
+/** @internal */
+export const SearchStreetsResponse$inboundSchema: z.ZodType<
+  SearchStreetsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.StreetQueryResponse$inboundSchema,
+  shared.ErrorResponse$inboundSchema,
+]);
+
+/** @internal */
+export type SearchStreetsResponse$Outbound =
+  | shared.StreetQueryResponse$Outbound
+  | shared.ErrorResponse$Outbound;
+
+/** @internal */
+export const SearchStreetsResponse$outboundSchema: z.ZodType<
+  SearchStreetsResponse$Outbound,
+  z.ZodTypeDef,
+  SearchStreetsResponse
+> = z.union([
+  shared.StreetQueryResponse$outboundSchema,
+  shared.ErrorResponse$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SearchStreetsResponse$ {
+  /** @deprecated use `SearchStreetsResponse$inboundSchema` instead. */
+  export const inboundSchema = SearchStreetsResponse$inboundSchema;
+  /** @deprecated use `SearchStreetsResponse$outboundSchema` instead. */
+  export const outboundSchema = SearchStreetsResponse$outboundSchema;
+  /** @deprecated use `SearchStreetsResponse$Outbound` instead. */
+  export type Outbound = SearchStreetsResponse$Outbound;
+}
+
+export function searchStreetsResponseToJSON(
+  searchStreetsResponse: SearchStreetsResponse,
+): string {
+  return JSON.stringify(
+    SearchStreetsResponse$outboundSchema.parse(searchStreetsResponse),
+  );
+}
+
+export function searchStreetsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchStreetsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchStreetsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchStreetsResponse' from JSON`,
+  );
+}

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

@@ -26,6 +26,7 @@ export * from "./propertyqueryrequest.js";
 export * from "./propertytags.js";
 export * from "./roomdetails.js";
 export * from "./salerecord.js";
+export * from "./school.js";
 export * from "./security.js";
 export * from "./streetdescriptor.js";
 export * from "./streetdetails.js";

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

@@ -20,7 +20,7 @@ export type PostcodeAreaFilter = {
   radius?: number | undefined;
   type: PostcodeAreaFilterType;
   /**
-   * UK postcode or partial postcode
+   * Full or partial UK postcode
    */
   value: string;
 };

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

@@ -33,7 +33,7 @@ export type PropertyAddress = {
    */
   outcode?: string | undefined;
   /**
-   * Full UK postcode
+   * UK postcode
    */
   postcode: string;
   /**