@vepler/sdk 2.0.0 → 2.6.2

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

@@ -8,34 +8,58 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PropertyTags = {
+  /**
+   * Property has agricultural tie restriction
+   */
+  agriculturalTie: boolean;
   /**
    * Is this property being sold at auction
    */
-  auction?: boolean | undefined;
+  auction: boolean;
+  /**
+   * Below Market Value property
+   */
+  bmv: boolean;
   /**
    * Cash buyers only
    */
-  cashBuyersOnly?: boolean | undefined;
+  cashBuyers: boolean;
   /**
    * Is this property chain free
    */
-  chainFree?: boolean | undefined;
+  chainFree: boolean;
+  /**
+   * House in Multiple Occupation
+   */
+  hmo: boolean;
   /**
-   * Investment opportunity
+   * Property in negative equity
    */
-  investment?: boolean | undefined;
+  negativeEquity: boolean;
   /**
-   * Is this a new build property
+   * Is this a new build scheme property
    */
-  newBuild?: boolean | undefined;
+  newBuildScheme: boolean;
+  /**
+   * Quick sale property
+   */
+  quickSale: boolean;
   /**
    * Is this a retirement property
    */
-  retirement?: boolean | undefined;
+  retirement: boolean;
   /**
    * Is this a shared ownership property
    */
-  sharedOwnership?: boolean | undefined;
+  sharedOwnership: boolean;
+  /**
+   * Property is slow to sell
+   */
+  slowToSell: boolean;
+  /**
+   * Property is unmodernised
+   */
+  unmodernised: boolean;
 };
 
 /** @internal */
@@ -44,58 +68,21 @@ export const PropertyTags$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  auction: z.boolean().default(false),
-  cashBuyersOnly: z.boolean().default(false),
-  chainFree: z.boolean().default(false),
-  investment: z.boolean().default(false),
-  newBuild: z.boolean().default(false),
-  retirement: z.boolean().default(false),
-  sharedOwnership: z.boolean().default(false),
+  agriculturalTie: z.boolean(),
+  auction: z.boolean(),
+  bmv: z.boolean(),
+  cashBuyers: z.boolean(),
+  chainFree: z.boolean(),
+  hmo: z.boolean(),
+  negativeEquity: z.boolean(),
+  newBuildScheme: z.boolean(),
+  quickSale: z.boolean(),
+  retirement: z.boolean(),
+  sharedOwnership: z.boolean(),
+  slowToSell: z.boolean(),
+  unmodernised: z.boolean(),
 });
 
-/** @internal */
-export type PropertyTags$Outbound = {
-  auction: boolean;
-  cashBuyersOnly: boolean;
-  chainFree: boolean;
-  investment: boolean;
-  newBuild: boolean;
-  retirement: boolean;
-  sharedOwnership: boolean;
-};
-
-/** @internal */
-export const PropertyTags$outboundSchema: z.ZodType<
-  PropertyTags$Outbound,
-  z.ZodTypeDef,
-  PropertyTags
-> = z.object({
-  auction: z.boolean().default(false),
-  cashBuyersOnly: z.boolean().default(false),
-  chainFree: z.boolean().default(false),
-  investment: z.boolean().default(false),
-  newBuild: z.boolean().default(false),
-  retirement: z.boolean().default(false),
-  sharedOwnership: z.boolean().default(false),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PropertyTags$ {
-  /** @deprecated use `PropertyTags$inboundSchema` instead. */
-  export const inboundSchema = PropertyTags$inboundSchema;
-  /** @deprecated use `PropertyTags$outboundSchema` instead. */
-  export const outboundSchema = PropertyTags$outboundSchema;
-  /** @deprecated use `PropertyTags$Outbound` instead. */
-  export type Outbound = PropertyTags$Outbound;
-}
-
-export function propertyTagsToJSON(propertyTags: PropertyTags): string {
-  return JSON.stringify(PropertyTags$outboundSchema.parse(propertyTags));
-}
-
 export function propertyTagsFromJSON(
   jsonString: string,
 ): SafeParseResult<PropertyTags, SDKValidationError> {

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

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Size of refurbishment required
+ */
+export const RefurbSize = {
+  Small: "small",
+  Medium: "medium",
+  Large: "large",
+} as const;
+/**
+ * Size of refurbishment required
+ */
+export type RefurbSize = ClosedEnum<typeof RefurbSize>;
+
+export type RefurbishmentData = {
+  /**
+   * Size of refurbishment required
+   */
+  refurbSize?: RefurbSize | null | undefined;
+};
+
+/** @internal */
+export const RefurbSize$inboundSchema: z.ZodNativeEnum<typeof RefurbSize> = z
+  .nativeEnum(RefurbSize);
+
+/** @internal */
+export const RefurbishmentData$inboundSchema: z.ZodType<
+  RefurbishmentData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  refurbSize: z.nullable(RefurbSize$inboundSchema).optional(),
+});
+
+export function refurbishmentDataFromJSON(
+  jsonString: string,
+): SafeParseResult<RefurbishmentData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RefurbishmentData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RefurbishmentData' from JSON`,
+  );
+}

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

@@ -11,15 +11,11 @@ export type RoomDetails = {
   /**
    * Number of bathrooms
    */
-  baths?: number | undefined;
+  baths?: number | null | undefined;
   /**
    * Number of bedrooms
    */
-  beds?: number | undefined;
-  /**
-   * Number of reception rooms
-   */
-  receptions?: number | undefined;
+  beds?: number | null | undefined;
 };
 
 /** @internal */
@@ -28,46 +24,10 @@ export const RoomDetails$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  baths: z.number().optional(),
-  beds: z.number().optional(),
-  receptions: z.number().optional(),
+  baths: z.nullable(z.number()).optional(),
+  beds: z.nullable(z.number()).optional(),
 });
 
-/** @internal */
-export type RoomDetails$Outbound = {
-  baths?: number | undefined;
-  beds?: number | undefined;
-  receptions?: number | undefined;
-};
-
-/** @internal */
-export const RoomDetails$outboundSchema: z.ZodType<
-  RoomDetails$Outbound,
-  z.ZodTypeDef,
-  RoomDetails
-> = z.object({
-  baths: z.number().optional(),
-  beds: z.number().optional(),
-  receptions: z.number().optional(),
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace RoomDetails$ {
-  /** @deprecated use `RoomDetails$inboundSchema` instead. */
-  export const inboundSchema = RoomDetails$inboundSchema;
-  /** @deprecated use `RoomDetails$outboundSchema` instead. */
-  export const outboundSchema = RoomDetails$outboundSchema;
-  /** @deprecated use `RoomDetails$Outbound` instead. */
-  export type Outbound = RoomDetails$Outbound;
-}
-
-export function roomDetailsToJSON(roomDetails: RoomDetails): string {
-  return JSON.stringify(RoomDetails$outboundSchema.parse(roomDetails));
-}
-
 export function roomDetailsFromJSON(
   jsonString: string,
 ): SafeParseResult<RoomDetails, SDKValidationError> {

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

@@ -9,21 +9,17 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type SaleRecord = {
   /**
-   * Sale completion date
-   */
-  date: string;
-  /**
-   * Was a new build at time of sale
+   * Sale price in pence
    */
-  newBuild?: boolean | undefined;
+  amount: number;
   /**
-   * Sale price in pence
+   * Sale completion date
    */
-  price: number;
+  date: Date;
   /**
-   * Property type at time of sale
+   * Source identifier for this sale record
    */
-  propertyType?: string | undefined;
+  sourceId: string;
 };
 
 /** @internal */
@@ -32,49 +28,11 @@ export const SaleRecord$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  date: z.string(),
-  newBuild: z.boolean().optional(),
-  price: z.number(),
-  propertyType: z.string().optional(),
+  amount: z.number(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  sourceId: z.string(),
 });
 
-/** @internal */
-export type SaleRecord$Outbound = {
-  date: string;
-  newBuild?: boolean | undefined;
-  price: number;
-  propertyType?: string | undefined;
-};
-
-/** @internal */
-export const SaleRecord$outboundSchema: z.ZodType<
-  SaleRecord$Outbound,
-  z.ZodTypeDef,
-  SaleRecord
-> = z.object({
-  date: z.string(),
-  newBuild: z.boolean().optional(),
-  price: z.number(),
-  propertyType: 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 SaleRecord$ {
-  /** @deprecated use `SaleRecord$inboundSchema` instead. */
-  export const inboundSchema = SaleRecord$inboundSchema;
-  /** @deprecated use `SaleRecord$outboundSchema` instead. */
-  export const outboundSchema = SaleRecord$outboundSchema;
-  /** @deprecated use `SaleRecord$Outbound` instead. */
-  export type Outbound = SaleRecord$Outbound;
-}
-
-export function saleRecordToJSON(saleRecord: SaleRecord): string {
-  return JSON.stringify(SaleRecord$outboundSchema.parse(saleRecord));
-}
-
 export function saleRecordFromJSON(
   jsonString: string,
 ): SafeParseResult<SaleRecord, SDKValidationError> {

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

@@ -258,45 +258,6 @@ export const Address$inboundSchema: z.ZodType<Address, z.ZodTypeDef, unknown> =
     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> {
@@ -312,22 +273,6 @@ 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,
@@ -338,39 +283,6 @@ export const Location$inboundSchema: z.ZodType<
   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> {
@@ -385,59 +297,14 @@ export function locationFromJSON(
 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({
@@ -478,105 +345,6 @@ export const School$inboundSchema: z.ZodType<School, z.ZodTypeDef, unknown> = z
     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> {

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

@@ -3,23 +3,11 @@
  */
 
 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 Security = {
   apiKeyAuth: string;
 };
 
-/** @internal */
-export const Security$inboundSchema: z.ZodType<
-  Security,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  apiKeyAuth: z.string(),
-});
-
 /** @internal */
 export type Security$Outbound = {
   apiKeyAuth: string;
@@ -34,29 +22,6 @@ export const Security$outboundSchema: z.ZodType<
   apiKeyAuth: 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 Security$ {
-  /** @deprecated use `Security$inboundSchema` instead. */
-  export const inboundSchema = Security$inboundSchema;
-  /** @deprecated use `Security$outboundSchema` instead. */
-  export const outboundSchema = Security$outboundSchema;
-  /** @deprecated use `Security$Outbound` instead. */
-  export type Outbound = Security$Outbound;
-}
-
 export function securityToJSON(security: Security): string {
   return JSON.stringify(Security$outboundSchema.parse(security));
 }
-
-export function securityFromJSON(
-  jsonString: string,
-): SafeParseResult<Security, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Security$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Security' from JSON`,
-  );
-}