@vepler/sdk 0.1.0 → 1.9.9

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

@@ -0,0 +1,357 @@
+/*
+ * 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 {
+  StreetQueryByCoordinates,
+  StreetQueryByCoordinates$inboundSchema,
+  StreetQueryByCoordinates$Outbound,
+  StreetQueryByCoordinates$outboundSchema,
+} from "./streetquerybycoordinates.js";
+import {
+  StreetQueryByName,
+  StreetQueryByName$inboundSchema,
+  StreetQueryByName$Outbound,
+  StreetQueryByName$outboundSchema,
+} from "./streetquerybyname.js";
+import {
+  StreetQueryByPostcode,
+  StreetQueryByPostcode$inboundSchema,
+  StreetQueryByPostcode$Outbound,
+  StreetQueryByPostcode$outboundSchema,
+} from "./streetquerybypostcode.js";
+import {
+  StreetQueryByUprn,
+  StreetQueryByUprn$inboundSchema,
+  StreetQueryByUprn$Outbound,
+  StreetQueryByUprn$outboundSchema,
+} from "./streetquerybyuprn.js";
+import {
+  StreetQueryByUsrn,
+  StreetQueryByUsrn$inboundSchema,
+  StreetQueryByUsrn$Outbound,
+  StreetQueryByUsrn$outboundSchema,
+} from "./streetquerybyusrn.js";
+
+/**
+ * Street identifier - supports multiple query types
+ */
+export type Identifier =
+  | (StreetQueryByCoordinates & { type: "coordinates" })
+  | (StreetQueryByName & { type: "name" })
+  | (StreetQueryByPostcode & { type: "postcode" })
+  | (StreetQueryByUprn & { type: "uprn" })
+  | (StreetQueryByUsrn & { type: "usrn" });
+
+/**
+ * Options for property listing
+ */
+export type PropertyOptions = {
+  /**
+   * Include historic properties
+   */
+  includeHistoric?: boolean | undefined;
+  /**
+   * Max properties to return
+   */
+  limit?: number | undefined;
+  /**
+   * Pagination offset
+   */
+  offset?: number | undefined;
+};
+
+export type StreetQueryRequest = {
+  /**
+   * Street identifier - supports multiple query types
+   */
+  identifier:
+    | (StreetQueryByCoordinates & { type: "coordinates" })
+    | (StreetQueryByName & { type: "name" })
+    | (StreetQueryByPostcode & { type: "postcode" })
+    | (StreetQueryByUprn & { type: "uprn" })
+    | (StreetQueryByUsrn & { type: "usrn" });
+  /**
+   * Include properties on the street
+   */
+  includeProperties?: boolean | undefined;
+  /**
+   * Include street statistics
+   */
+  includeStatistics?: boolean | undefined;
+  /**
+   * Options for property listing
+   */
+  propertyOptions?: PropertyOptions | undefined;
+};
+
+/** @internal */
+export const Identifier$inboundSchema: z.ZodType<
+  Identifier,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  StreetQueryByCoordinates$inboundSchema.and(
+    z.object({ type: z.literal("coordinates") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  StreetQueryByName$inboundSchema.and(
+    z.object({ type: z.literal("name") }).transform((v) => ({ type: v.type })),
+  ),
+  StreetQueryByPostcode$inboundSchema.and(
+    z.object({ type: z.literal("postcode") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  StreetQueryByUprn$inboundSchema.and(
+    z.object({ type: z.literal("uprn") }).transform((v) => ({ type: v.type })),
+  ),
+  StreetQueryByUsrn$inboundSchema.and(
+    z.object({ type: z.literal("usrn") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+
+/** @internal */
+export type Identifier$Outbound =
+  | (StreetQueryByCoordinates$Outbound & { type: "coordinates" })
+  | (StreetQueryByName$Outbound & { type: "name" })
+  | (StreetQueryByPostcode$Outbound & { type: "postcode" })
+  | (StreetQueryByUprn$Outbound & { type: "uprn" })
+  | (StreetQueryByUsrn$Outbound & { type: "usrn" });
+
+/** @internal */
+export const Identifier$outboundSchema: z.ZodType<
+  Identifier$Outbound,
+  z.ZodTypeDef,
+  Identifier
+> = z.union([
+  StreetQueryByCoordinates$outboundSchema.and(
+    z.object({ type: z.literal("coordinates") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  StreetQueryByName$outboundSchema.and(
+    z.object({ type: z.literal("name") }).transform((v) => ({ type: v.type })),
+  ),
+  StreetQueryByPostcode$outboundSchema.and(
+    z.object({ type: z.literal("postcode") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  StreetQueryByUprn$outboundSchema.and(
+    z.object({ type: z.literal("uprn") }).transform((v) => ({ type: v.type })),
+  ),
+  StreetQueryByUsrn$outboundSchema.and(
+    z.object({ type: z.literal("usrn") }).transform((v) => ({ type: v.type })),
+  ),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Identifier$ {
+  /** @deprecated use `Identifier$inboundSchema` instead. */
+  export const inboundSchema = Identifier$inboundSchema;
+  /** @deprecated use `Identifier$outboundSchema` instead. */
+  export const outboundSchema = Identifier$outboundSchema;
+  /** @deprecated use `Identifier$Outbound` instead. */
+  export type Outbound = Identifier$Outbound;
+}
+
+export function identifierToJSON(identifier: Identifier): string {
+  return JSON.stringify(Identifier$outboundSchema.parse(identifier));
+}
+
+export function identifierFromJSON(
+  jsonString: string,
+): SafeParseResult<Identifier, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Identifier$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Identifier' from JSON`,
+  );
+}
+
+/** @internal */
+export const PropertyOptions$inboundSchema: z.ZodType<
+  PropertyOptions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  includeHistoric: z.boolean().default(false),
+  limit: z.number().default(100),
+  offset: z.number().default(0),
+});
+
+/** @internal */
+export type PropertyOptions$Outbound = {
+  includeHistoric: boolean;
+  limit: number;
+  offset: number;
+};
+
+/** @internal */
+export const PropertyOptions$outboundSchema: z.ZodType<
+  PropertyOptions$Outbound,
+  z.ZodTypeDef,
+  PropertyOptions
+> = z.object({
+  includeHistoric: z.boolean().default(false),
+  limit: z.number().default(100),
+  offset: z.number().default(0),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyOptions$ {
+  /** @deprecated use `PropertyOptions$inboundSchema` instead. */
+  export const inboundSchema = PropertyOptions$inboundSchema;
+  /** @deprecated use `PropertyOptions$outboundSchema` instead. */
+  export const outboundSchema = PropertyOptions$outboundSchema;
+  /** @deprecated use `PropertyOptions$Outbound` instead. */
+  export type Outbound = PropertyOptions$Outbound;
+}
+
+export function propertyOptionsToJSON(
+  propertyOptions: PropertyOptions,
+): string {
+  return JSON.stringify(PropertyOptions$outboundSchema.parse(propertyOptions));
+}
+
+export function propertyOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyOptions' from JSON`,
+  );
+}
+
+/** @internal */
+export const StreetQueryRequest$inboundSchema: z.ZodType<
+  StreetQueryRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  identifier: z.union([
+    StreetQueryByCoordinates$inboundSchema.and(
+      z.object({ type: z.literal("coordinates") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByName$inboundSchema.and(
+      z.object({ type: z.literal("name") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByPostcode$inboundSchema.and(
+      z.object({ type: z.literal("postcode") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByUprn$inboundSchema.and(
+      z.object({ type: z.literal("uprn") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByUsrn$inboundSchema.and(
+      z.object({ type: z.literal("usrn") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+  includeProperties: z.boolean().default(false),
+  includeStatistics: z.boolean().default(false),
+  propertyOptions: z.lazy(() => PropertyOptions$inboundSchema).optional(),
+});
+
+/** @internal */
+export type StreetQueryRequest$Outbound = {
+  identifier:
+    | (StreetQueryByCoordinates$Outbound & { type: "coordinates" })
+    | (StreetQueryByName$Outbound & { type: "name" })
+    | (StreetQueryByPostcode$Outbound & { type: "postcode" })
+    | (StreetQueryByUprn$Outbound & { type: "uprn" })
+    | (StreetQueryByUsrn$Outbound & { type: "usrn" });
+  includeProperties: boolean;
+  includeStatistics: boolean;
+  propertyOptions?: PropertyOptions$Outbound | undefined;
+};
+
+/** @internal */
+export const StreetQueryRequest$outboundSchema: z.ZodType<
+  StreetQueryRequest$Outbound,
+  z.ZodTypeDef,
+  StreetQueryRequest
+> = z.object({
+  identifier: z.union([
+    StreetQueryByCoordinates$outboundSchema.and(
+      z.object({ type: z.literal("coordinates") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByName$outboundSchema.and(
+      z.object({ type: z.literal("name") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByPostcode$outboundSchema.and(
+      z.object({ type: z.literal("postcode") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByUprn$outboundSchema.and(
+      z.object({ type: z.literal("uprn") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+    StreetQueryByUsrn$outboundSchema.and(
+      z.object({ type: z.literal("usrn") }).transform((v) => ({
+        type: v.type,
+      })),
+    ),
+  ]),
+  includeProperties: z.boolean().default(false),
+  includeStatistics: z.boolean().default(false),
+  propertyOptions: z.lazy(() => PropertyOptions$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StreetQueryRequest$ {
+  /** @deprecated use `StreetQueryRequest$inboundSchema` instead. */
+  export const inboundSchema = StreetQueryRequest$inboundSchema;
+  /** @deprecated use `StreetQueryRequest$outboundSchema` instead. */
+  export const outboundSchema = StreetQueryRequest$outboundSchema;
+  /** @deprecated use `StreetQueryRequest$Outbound` instead. */
+  export type Outbound = StreetQueryRequest$Outbound;
+}
+
+export function streetQueryRequestToJSON(
+  streetQueryRequest: StreetQueryRequest,
+): string {
+  return JSON.stringify(
+    StreetQueryRequest$outboundSchema.parse(streetQueryRequest),
+  );
+}
+
+export function streetQueryRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetQueryRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetQueryRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetQueryRequest' from JSON`,
+  );
+}

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

@@ -0,0 +1,119 @@
+/*
+ * 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 {
+  PropertyOnStreet,
+  PropertyOnStreet$inboundSchema,
+  PropertyOnStreet$Outbound,
+  PropertyOnStreet$outboundSchema,
+} from "./propertyonstreet.js";
+import {
+  StreetDetails,
+  StreetDetails$inboundSchema,
+  StreetDetails$Outbound,
+  StreetDetails$outboundSchema,
+} from "./streetdetails.js";
+import {
+  StreetStatistics,
+  StreetStatistics$inboundSchema,
+  StreetStatistics$Outbound,
+  StreetStatistics$outboundSchema,
+} from "./streetstatistics.js";
+
+export type StreetQueryResponse = {
+  /**
+   * Additional information or warnings
+   */
+  message?: string | undefined;
+  /**
+   * Properties on the street(s)
+   */
+  properties?: Array<PropertyOnStreet> | undefined;
+  /**
+   * Statistics per street (keyed by USRN)
+   */
+  statistics?: { [k: string]: StreetStatistics } | undefined;
+  /**
+   * Array of street details
+   */
+  streets: Array<StreetDetails>;
+  success: boolean;
+  /**
+   * Total number of streets found
+   */
+  total: number;
+};
+
+/** @internal */
+export const StreetQueryResponse$inboundSchema: z.ZodType<
+  StreetQueryResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string().optional(),
+  properties: z.array(PropertyOnStreet$inboundSchema).optional(),
+  statistics: z.record(StreetStatistics$inboundSchema).optional(),
+  streets: z.array(StreetDetails$inboundSchema),
+  success: z.boolean(),
+  total: z.number(),
+});
+
+/** @internal */
+export type StreetQueryResponse$Outbound = {
+  message?: string | undefined;
+  properties?: Array<PropertyOnStreet$Outbound> | undefined;
+  statistics?: { [k: string]: StreetStatistics$Outbound } | undefined;
+  streets: Array<StreetDetails$Outbound>;
+  success: boolean;
+  total: number;
+};
+
+/** @internal */
+export const StreetQueryResponse$outboundSchema: z.ZodType<
+  StreetQueryResponse$Outbound,
+  z.ZodTypeDef,
+  StreetQueryResponse
+> = z.object({
+  message: z.string().optional(),
+  properties: z.array(PropertyOnStreet$outboundSchema).optional(),
+  statistics: z.record(StreetStatistics$outboundSchema).optional(),
+  streets: z.array(StreetDetails$outboundSchema),
+  success: z.boolean(),
+  total: 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 StreetQueryResponse$ {
+  /** @deprecated use `StreetQueryResponse$inboundSchema` instead. */
+  export const inboundSchema = StreetQueryResponse$inboundSchema;
+  /** @deprecated use `StreetQueryResponse$outboundSchema` instead. */
+  export const outboundSchema = StreetQueryResponse$outboundSchema;
+  /** @deprecated use `StreetQueryResponse$Outbound` instead. */
+  export type Outbound = StreetQueryResponse$Outbound;
+}
+
+export function streetQueryResponseToJSON(
+  streetQueryResponse: StreetQueryResponse,
+): string {
+  return JSON.stringify(
+    StreetQueryResponse$outboundSchema.parse(streetQueryResponse),
+  );
+}
+
+export function streetQueryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetQueryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetQueryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetQueryResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,76 @@
+/*
+ * 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";
+
+export type StreetStatistics = {
+  /**
+   * Property classification breakdown
+   */
+  classifications: { [k: string]: number };
+  /**
+   * Total number of properties on street
+   */
+  propertyCount: number;
+};
+
+/** @internal */
+export const StreetStatistics$inboundSchema: z.ZodType<
+  StreetStatistics,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  classifications: z.record(z.number()),
+  propertyCount: z.number(),
+});
+
+/** @internal */
+export type StreetStatistics$Outbound = {
+  classifications: { [k: string]: number };
+  propertyCount: number;
+};
+
+/** @internal */
+export const StreetStatistics$outboundSchema: z.ZodType<
+  StreetStatistics$Outbound,
+  z.ZodTypeDef,
+  StreetStatistics
+> = z.object({
+  classifications: z.record(z.number()),
+  propertyCount: 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 StreetStatistics$ {
+  /** @deprecated use `StreetStatistics$inboundSchema` instead. */
+  export const inboundSchema = StreetStatistics$inboundSchema;
+  /** @deprecated use `StreetStatistics$outboundSchema` instead. */
+  export const outboundSchema = StreetStatistics$outboundSchema;
+  /** @deprecated use `StreetStatistics$Outbound` instead. */
+  export type Outbound = StreetStatistics$Outbound;
+}
+
+export function streetStatisticsToJSON(
+  streetStatistics: StreetStatistics,
+): string {
+  return JSON.stringify(
+    StreetStatistics$outboundSchema.parse(streetStatistics),
+  );
+}
+
+export function streetStatisticsFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetStatistics, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetStatistics$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetStatistics' from JSON`,
+  );
+}

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

@@ -0,0 +1,121 @@
+/*
+ * 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";
+
+/**
+ * Property tenure type
+ */
+export const TenureDataType = {
+  Freehold: "freehold",
+  Leasehold: "leasehold",
+  Unknown: "unknown",
+} as const;
+/**
+ * Property tenure type
+ */
+export type TenureDataType = ClosedEnum<typeof TenureDataType>;
+
+export type TenureData = {
+  /**
+   * Annual ground rent in pence
+   */
+  groundRent?: number | undefined;
+  /**
+   * Years remaining on lease
+   */
+  leaseYearsRemaining?: number | undefined;
+  /**
+   * Annual service charge in pence
+   */
+  serviceCharge?: number | undefined;
+  /**
+   * Property tenure type
+   */
+  type?: TenureDataType | undefined;
+};
+
+/** @internal */
+export const TenureDataType$inboundSchema: z.ZodNativeEnum<
+  typeof TenureDataType
+> = z.nativeEnum(TenureDataType);
+
+/** @internal */
+export const TenureDataType$outboundSchema: z.ZodNativeEnum<
+  typeof TenureDataType
+> = TenureDataType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TenureDataType$ {
+  /** @deprecated use `TenureDataType$inboundSchema` instead. */
+  export const inboundSchema = TenureDataType$inboundSchema;
+  /** @deprecated use `TenureDataType$outboundSchema` instead. */
+  export const outboundSchema = TenureDataType$outboundSchema;
+}
+
+/** @internal */
+export const TenureData$inboundSchema: z.ZodType<
+  TenureData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  groundRent: z.number().optional(),
+  leaseYearsRemaining: z.number().optional(),
+  serviceCharge: z.number().optional(),
+  type: TenureDataType$inboundSchema.optional(),
+});
+
+/** @internal */
+export type TenureData$Outbound = {
+  groundRent?: number | undefined;
+  leaseYearsRemaining?: number | undefined;
+  serviceCharge?: number | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const TenureData$outboundSchema: z.ZodType<
+  TenureData$Outbound,
+  z.ZodTypeDef,
+  TenureData
+> = z.object({
+  groundRent: z.number().optional(),
+  leaseYearsRemaining: z.number().optional(),
+  serviceCharge: z.number().optional(),
+  type: TenureDataType$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TenureData$ {
+  /** @deprecated use `TenureData$inboundSchema` instead. */
+  export const inboundSchema = TenureData$inboundSchema;
+  /** @deprecated use `TenureData$outboundSchema` instead. */
+  export const outboundSchema = TenureData$outboundSchema;
+  /** @deprecated use `TenureData$Outbound` instead. */
+  export type Outbound = TenureData$Outbound;
+}
+
+export function tenureDataToJSON(tenureData: TenureData): string {
+  return JSON.stringify(TenureData$outboundSchema.parse(tenureData));
+}
+
+export function tenureDataFromJSON(
+  jsonString: string,
+): SafeParseResult<TenureData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TenureData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TenureData' from JSON`,
+  );
+}

package/src/sdk/sdk.ts

@@ -4,6 +4,7 @@
 
 import { ClientSDK } from "../lib/sdks.js";
 import { Health } from "./health.js";
+import { Location } from "./location.js";
 import { Planning } from "./planning.js";
 import { Property } from "./property.js";
 
@@ -13,6 +14,11 @@ export class SDK extends ClientSDK {
     return (this._health ??= new Health(this._options));
   }
 
+  private _location?: Location;
+  get location(): Location {
+    return (this._location ??= new Location(this._options));
+  }
+
   private _planning?: Planning;
   get planning(): Planning {
     return (this._planning ??= new Planning(this._options));

package/.claude/settings.local.json

@@ -1,14 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "WebFetch(domain:traveltime.com)",
-      "WebSearch",
-      "WebFetch(domain:github.com)",
-      "Read(//Users/goran/Projects/vepler-stack/**)",
-      "Bash(git add:*)",
-      "Bash(npm view:*)"
-    ],
-    "deny": [],
-    "ask": []
-  }
-}