@vepler/sdk 2.0.0 → 2.3.0

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

@@ -2,15 +2,24 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./builddata.js";
+export * from "./chargeentry.js";
+export * from "./chargehistory.js";
+export * from "./counciltaxbanddetails.js";
 export * from "./counciltaxdata.js";
 export * from "./epcdata.js";
 export * from "./errorresponse.js";
 export * from "./healthresponse.js";
+export * from "./lease.js";
+export * from "./listing.js";
+export * from "./listingimage.js";
+export * from "./listingpricechange.js";
 export * from "./marketstatus.js";
 export * from "./planningapplication.js";
 export * from "./planninglistresponse.js";
 export * from "./planningqueryfilters.js";
 export * from "./planningqueryrequest.js";
+export * from "./pricechange.js";
 export * from "./pricingdata.js";
 export * from "./propertyaddress.js";
 export * from "./propertyareafilter.js";
@@ -29,6 +38,7 @@ export * from "./propertyquerygroup.js";
 export * from "./propertyqueryoperator.js";
 export * from "./propertyqueryrequest.js";
 export * from "./propertytags.js";
+export * from "./refurbishmentdata.js";
 export * from "./roomdetails.js";
 export * from "./salerecord.js";
 export * from "./school.js";
@@ -43,4 +53,5 @@ export * from "./streetquerybyusrn.js";
 export * from "./streetqueryrequest.js";
 export * from "./streetqueryresponse.js";
 export * from "./streetstatistics.js";
+export * from "./tenancydata.js";
 export * from "./tenuredata.js";

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

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type Lease = {
+  /**
+   * Whether lease has alienation restrictions
+   */
+  alienationClause: boolean;
+  /**
+   * Date when lease was granted
+   */
+  dateOfLease?: string | null | undefined;
+  /**
+   * Date when lease expires
+   */
+  expiryDate?: string | null | undefined;
+  /**
+   * Type of lease
+   */
+  leaseType: string;
+};
+
+/** @internal */
+export const Lease$inboundSchema: z.ZodType<Lease, z.ZodTypeDef, unknown> = z
+  .object({
+    alienationClause: z.boolean(),
+    dateOfLease: z.nullable(z.string()).optional(),
+    expiryDate: z.nullable(z.string()).optional(),
+    leaseType: z.string(),
+  });
+
+/** @internal */
+export type Lease$Outbound = {
+  alienationClause: boolean;
+  dateOfLease?: string | null | undefined;
+  expiryDate?: string | null | undefined;
+  leaseType: string;
+};
+
+/** @internal */
+export const Lease$outboundSchema: z.ZodType<
+  Lease$Outbound,
+  z.ZodTypeDef,
+  Lease
+> = z.object({
+  alienationClause: z.boolean(),
+  dateOfLease: z.nullable(z.string()).optional(),
+  expiryDate: z.nullable(z.string()).optional(),
+  leaseType: 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 Lease$ {
+  /** @deprecated use `Lease$inboundSchema` instead. */
+  export const inboundSchema = Lease$inboundSchema;
+  /** @deprecated use `Lease$outboundSchema` instead. */
+  export const outboundSchema = Lease$outboundSchema;
+  /** @deprecated use `Lease$Outbound` instead. */
+  export type Outbound = Lease$Outbound;
+}
+
+export function leaseToJSON(lease: Lease): string {
+  return JSON.stringify(Lease$outboundSchema.parse(lease));
+}
+
+export function leaseFromJSON(
+  jsonString: string,
+): SafeParseResult<Lease, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Lease$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Lease' from JSON`,
+  );
+}

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

@@ -0,0 +1,505 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  ListingImage,
+  ListingImage$inboundSchema,
+  ListingImage$Outbound,
+  ListingImage$outboundSchema,
+} from "./listingimage.js";
+import {
+  ListingPriceChange,
+  ListingPriceChange$inboundSchema,
+  ListingPriceChange$Outbound,
+  ListingPriceChange$outboundSchema,
+} from "./listingpricechange.js";
+
+/**
+ * Property features from listing
+ */
+export type Features = {
+  alarm?: boolean | undefined;
+  balcony?: boolean | undefined;
+  cctv?: boolean | undefined;
+  centralHeating?: boolean | undefined;
+  chainFree?: boolean | undefined;
+  conservatory?: boolean | undefined;
+  doubleGlazing?: boolean | undefined;
+  ensuite?: boolean | undefined;
+  fireplace?: boolean | undefined;
+  furnished?: boolean | undefined;
+  garage?: boolean | undefined;
+  garden?: boolean | undefined;
+  groundFloor?: boolean | undefined;
+  lift?: boolean | undefined;
+  newBuild?: boolean | undefined;
+  parking?: boolean | undefined;
+  partFurnished?: boolean | undefined;
+  patio?: boolean | undefined;
+  terrace?: boolean | undefined;
+  topFloor?: boolean | undefined;
+  unfurnished?: boolean | undefined;
+};
+
+/**
+ * Listing pricing information
+ */
+export type Pricing = {
+  /**
+   * Currency code
+   */
+  currency: string;
+  /**
+   * Estimated price in pence
+   */
+  estimated?: number | null | undefined;
+  /**
+   * Listed price in pence
+   */
+  price: number;
+};
+
+/**
+ * Seller information
+ */
+export type Seller = {
+  /**
+   * Property Agent Identifier (PAID)
+   */
+  paid?: string | undefined;
+  /**
+   * Seller/agent name
+   */
+  name?: string | undefined;
+};
+
+/**
+ * Listing status
+ */
+export const Status = {
+  Live: "live",
+  Unavailable: "unavailable",
+  Removed: "removed",
+  Sstc: "sstc",
+  UnderOffer: "under_offer",
+  Sold: "sold",
+  Reserved: "reserved",
+} as const;
+/**
+ * Listing status
+ */
+export type Status = ClosedEnum<typeof Status>;
+
+/**
+ * Listing type
+ */
+export const Type = {
+  Sale: "sale",
+  Rent: "rent",
+} as const;
+/**
+ * Listing type
+ */
+export type Type = ClosedEnum<typeof Type>;
+
+export type Listing = {
+  /**
+   * Listing description text
+   */
+  description?: string | null | undefined;
+  /**
+   * Property features from listing
+   */
+  features: Features;
+  /**
+   * Floor plan images
+   */
+  floorPlanImages: Array<ListingImage>;
+  /**
+   * Property images
+   */
+  images: Array<ListingImage>;
+  /**
+   * Unique listing identifier
+   */
+  listingId: string;
+  /**
+   * Price change history for this listing
+   */
+  priceChange: Array<ListingPriceChange>;
+  /**
+   * Listing pricing information
+   */
+  pricing: Pricing;
+  /**
+   * Date listing was published
+   */
+  publishedDate: Date;
+  /**
+   * Date listing was removed
+   */
+  removedDate?: Date | null | undefined;
+  /**
+   * Seller information
+   */
+  seller: Seller;
+  /**
+   * Listing status
+   */
+  status: Status;
+  /**
+   * Listing type
+   */
+  type: Type;
+};
+
+/** @internal */
+export const Features$inboundSchema: z.ZodType<
+  Features,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  alarm: z.boolean().optional(),
+  balcony: z.boolean().optional(),
+  cctv: z.boolean().optional(),
+  centralHeating: z.boolean().optional(),
+  chainFree: z.boolean().optional(),
+  conservatory: z.boolean().optional(),
+  doubleGlazing: z.boolean().optional(),
+  ensuite: z.boolean().optional(),
+  fireplace: z.boolean().optional(),
+  furnished: z.boolean().optional(),
+  garage: z.boolean().optional(),
+  garden: z.boolean().optional(),
+  groundFloor: z.boolean().optional(),
+  lift: z.boolean().optional(),
+  newBuild: z.boolean().optional(),
+  parking: z.boolean().optional(),
+  partFurnished: z.boolean().optional(),
+  patio: z.boolean().optional(),
+  terrace: z.boolean().optional(),
+  topFloor: z.boolean().optional(),
+  unfurnished: z.boolean().optional(),
+});
+
+/** @internal */
+export type Features$Outbound = {
+  alarm?: boolean | undefined;
+  balcony?: boolean | undefined;
+  cctv?: boolean | undefined;
+  centralHeating?: boolean | undefined;
+  chainFree?: boolean | undefined;
+  conservatory?: boolean | undefined;
+  doubleGlazing?: boolean | undefined;
+  ensuite?: boolean | undefined;
+  fireplace?: boolean | undefined;
+  furnished?: boolean | undefined;
+  garage?: boolean | undefined;
+  garden?: boolean | undefined;
+  groundFloor?: boolean | undefined;
+  lift?: boolean | undefined;
+  newBuild?: boolean | undefined;
+  parking?: boolean | undefined;
+  partFurnished?: boolean | undefined;
+  patio?: boolean | undefined;
+  terrace?: boolean | undefined;
+  topFloor?: boolean | undefined;
+  unfurnished?: boolean | undefined;
+};
+
+/** @internal */
+export const Features$outboundSchema: z.ZodType<
+  Features$Outbound,
+  z.ZodTypeDef,
+  Features
+> = z.object({
+  alarm: z.boolean().optional(),
+  balcony: z.boolean().optional(),
+  cctv: z.boolean().optional(),
+  centralHeating: z.boolean().optional(),
+  chainFree: z.boolean().optional(),
+  conservatory: z.boolean().optional(),
+  doubleGlazing: z.boolean().optional(),
+  ensuite: z.boolean().optional(),
+  fireplace: z.boolean().optional(),
+  furnished: z.boolean().optional(),
+  garage: z.boolean().optional(),
+  garden: z.boolean().optional(),
+  groundFloor: z.boolean().optional(),
+  lift: z.boolean().optional(),
+  newBuild: z.boolean().optional(),
+  parking: z.boolean().optional(),
+  partFurnished: z.boolean().optional(),
+  patio: z.boolean().optional(),
+  terrace: z.boolean().optional(),
+  topFloor: z.boolean().optional(),
+  unfurnished: z.boolean().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Features$ {
+  /** @deprecated use `Features$inboundSchema` instead. */
+  export const inboundSchema = Features$inboundSchema;
+  /** @deprecated use `Features$outboundSchema` instead. */
+  export const outboundSchema = Features$outboundSchema;
+  /** @deprecated use `Features$Outbound` instead. */
+  export type Outbound = Features$Outbound;
+}
+
+export function featuresToJSON(features: Features): string {
+  return JSON.stringify(Features$outboundSchema.parse(features));
+}
+
+export function featuresFromJSON(
+  jsonString: string,
+): SafeParseResult<Features, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Features$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Features' from JSON`,
+  );
+}
+
+/** @internal */
+export const Pricing$inboundSchema: z.ZodType<Pricing, z.ZodTypeDef, unknown> =
+  z.object({
+    currency: z.string(),
+    estimated: z.nullable(z.number()).optional(),
+    price: z.number(),
+  });
+
+/** @internal */
+export type Pricing$Outbound = {
+  currency: string;
+  estimated?: number | null | undefined;
+  price: number;
+};
+
+/** @internal */
+export const Pricing$outboundSchema: z.ZodType<
+  Pricing$Outbound,
+  z.ZodTypeDef,
+  Pricing
+> = z.object({
+  currency: z.string(),
+  estimated: z.nullable(z.number()).optional(),
+  price: 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 Pricing$ {
+  /** @deprecated use `Pricing$inboundSchema` instead. */
+  export const inboundSchema = Pricing$inboundSchema;
+  /** @deprecated use `Pricing$outboundSchema` instead. */
+  export const outboundSchema = Pricing$outboundSchema;
+  /** @deprecated use `Pricing$Outbound` instead. */
+  export type Outbound = Pricing$Outbound;
+}
+
+export function pricingToJSON(pricing: Pricing): string {
+  return JSON.stringify(Pricing$outboundSchema.parse(pricing));
+}
+
+export function pricingFromJSON(
+  jsonString: string,
+): SafeParseResult<Pricing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pricing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pricing' from JSON`,
+  );
+}
+
+/** @internal */
+export const Seller$inboundSchema: z.ZodType<Seller, z.ZodTypeDef, unknown> = z
+  .object({
+    PAID: z.string().optional(),
+    name: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "PAID": "paid",
+    });
+  });
+
+/** @internal */
+export type Seller$Outbound = {
+  PAID?: string | undefined;
+  name?: string | undefined;
+};
+
+/** @internal */
+export const Seller$outboundSchema: z.ZodType<
+  Seller$Outbound,
+  z.ZodTypeDef,
+  Seller
+> = z.object({
+  paid: z.string().optional(),
+  name: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    paid: "PAID",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Seller$ {
+  /** @deprecated use `Seller$inboundSchema` instead. */
+  export const inboundSchema = Seller$inboundSchema;
+  /** @deprecated use `Seller$outboundSchema` instead. */
+  export const outboundSchema = Seller$outboundSchema;
+  /** @deprecated use `Seller$Outbound` instead. */
+  export type Outbound = Seller$Outbound;
+}
+
+export function sellerToJSON(seller: Seller): string {
+  return JSON.stringify(Seller$outboundSchema.parse(seller));
+}
+
+export function sellerFromJSON(
+  jsonString: string,
+): SafeParseResult<Seller, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Seller$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Seller' from JSON`,
+  );
+}
+
+/** @internal */
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
+
+/** @internal */
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Status$ {
+  /** @deprecated use `Status$inboundSchema` instead. */
+  export const inboundSchema = Status$inboundSchema;
+  /** @deprecated use `Status$outboundSchema` instead. */
+  export const outboundSchema = Status$outboundSchema;
+}
+
+/** @internal */
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
+
+/** @internal */
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
+}
+
+/** @internal */
+export const Listing$inboundSchema: z.ZodType<Listing, z.ZodTypeDef, unknown> =
+  z.object({
+    description: z.nullable(z.string()).optional(),
+    features: z.lazy(() => Features$inboundSchema),
+    floorPlanImages: z.array(ListingImage$inboundSchema),
+    images: z.array(ListingImage$inboundSchema),
+    listingId: z.string(),
+    priceChange: z.array(ListingPriceChange$inboundSchema),
+    pricing: z.lazy(() => Pricing$inboundSchema),
+    publishedDate: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    removedDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    seller: z.lazy(() => Seller$inboundSchema),
+    status: Status$inboundSchema,
+    type: Type$inboundSchema,
+  });
+
+/** @internal */
+export type Listing$Outbound = {
+  description?: string | null | undefined;
+  features: Features$Outbound;
+  floorPlanImages: Array<ListingImage$Outbound>;
+  images: Array<ListingImage$Outbound>;
+  listingId: string;
+  priceChange: Array<ListingPriceChange$Outbound>;
+  pricing: Pricing$Outbound;
+  publishedDate: string;
+  removedDate?: string | null | undefined;
+  seller: Seller$Outbound;
+  status: string;
+  type: string;
+};
+
+/** @internal */
+export const Listing$outboundSchema: z.ZodType<
+  Listing$Outbound,
+  z.ZodTypeDef,
+  Listing
+> = z.object({
+  description: z.nullable(z.string()).optional(),
+  features: z.lazy(() => Features$outboundSchema),
+  floorPlanImages: z.array(ListingImage$outboundSchema),
+  images: z.array(ListingImage$outboundSchema),
+  listingId: z.string(),
+  priceChange: z.array(ListingPriceChange$outboundSchema),
+  pricing: z.lazy(() => Pricing$outboundSchema),
+  publishedDate: z.date().transform(v => v.toISOString()),
+  removedDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  seller: z.lazy(() => Seller$outboundSchema),
+  status: Status$outboundSchema,
+  type: Type$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Listing$ {
+  /** @deprecated use `Listing$inboundSchema` instead. */
+  export const inboundSchema = Listing$inboundSchema;
+  /** @deprecated use `Listing$outboundSchema` instead. */
+  export const outboundSchema = Listing$outboundSchema;
+  /** @deprecated use `Listing$Outbound` instead. */
+  export type Outbound = Listing$Outbound;
+}
+
+export function listingToJSON(listing: Listing): string {
+  return JSON.stringify(Listing$outboundSchema.parse(listing));
+}
+
+export function listingFromJSON(
+  jsonString: string,
+): SafeParseResult<Listing, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Listing$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Listing' from JSON`,
+  );
+}

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

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type ListingImage = {
+  /**
+   * Image URL
+   */
+  url: string;
+};
+
+/** @internal */
+export const ListingImage$inboundSchema: z.ZodType<
+  ListingImage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+});
+
+/** @internal */
+export type ListingImage$Outbound = {
+  url: string;
+};
+
+/** @internal */
+export const ListingImage$outboundSchema: z.ZodType<
+  ListingImage$Outbound,
+  z.ZodTypeDef,
+  ListingImage
+> = z.object({
+  url: 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 ListingImage$ {
+  /** @deprecated use `ListingImage$inboundSchema` instead. */
+  export const inboundSchema = ListingImage$inboundSchema;
+  /** @deprecated use `ListingImage$outboundSchema` instead. */
+  export const outboundSchema = ListingImage$outboundSchema;
+  /** @deprecated use `ListingImage$Outbound` instead. */
+  export type Outbound = ListingImage$Outbound;
+}
+
+export function listingImageToJSON(listingImage: ListingImage): string {
+  return JSON.stringify(ListingImage$outboundSchema.parse(listingImage));
+}
+
+export function listingImageFromJSON(
+  jsonString: string,
+): SafeParseResult<ListingImage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListingImage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListingImage' from JSON`,
+  );
+}