@vepler/sdk 2.0.0 → 2.6.2

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

@@ -3,13 +3,9 @@
  */
 
 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";
 import {
   PlanningQueryFilters,
-  PlanningQueryFilters$inboundSchema,
   PlanningQueryFilters$Outbound,
   PlanningQueryFilters$outboundSchema,
 } from "./planningqueryfilters.js";
@@ -38,56 +34,13 @@ export type PlanningQueryRequest = {
 };
 
 /** @internal */
-export const SortBy$inboundSchema: z.ZodNativeEnum<typeof SortBy> = z
+export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> = z
   .nativeEnum(SortBy);
 
 /** @internal */
-export const SortBy$outboundSchema: z.ZodNativeEnum<typeof SortBy> =
-  SortBy$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SortBy$ {
-  /** @deprecated use `SortBy$inboundSchema` instead. */
-  export const inboundSchema = SortBy$inboundSchema;
-  /** @deprecated use `SortBy$outboundSchema` instead. */
-  export const outboundSchema = SortBy$outboundSchema;
-}
-
-/** @internal */
-export const SortOrder$inboundSchema: z.ZodNativeEnum<typeof SortOrder> = z
+export const SortOrder$outboundSchema: z.ZodNativeEnum<typeof SortOrder> = z
   .nativeEnum(SortOrder);
 
-/** @internal */
-export const SortOrder$outboundSchema: z.ZodNativeEnum<typeof SortOrder> =
-  SortOrder$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace SortOrder$ {
-  /** @deprecated use `SortOrder$inboundSchema` instead. */
-  export const inboundSchema = SortOrder$inboundSchema;
-  /** @deprecated use `SortOrder$outboundSchema` instead. */
-  export const outboundSchema = SortOrder$outboundSchema;
-}
-
-/** @internal */
-export const PlanningQueryRequest$inboundSchema: z.ZodType<
-  PlanningQueryRequest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  limit: z.number().default(50),
-  offset: z.number().default(0),
-  query: PlanningQueryFilters$inboundSchema.optional(),
-  sortBy: SortBy$inboundSchema.default("receivedDate"),
-  sortOrder: SortOrder$inboundSchema.default("desc"),
-});
-
 /** @internal */
 export type PlanningQueryRequest$Outbound = {
   limit: number;
@@ -110,19 +63,6 @@ export const PlanningQueryRequest$outboundSchema: z.ZodType<
   sortOrder: SortOrder$outboundSchema.default("desc"),
 });
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PlanningQueryRequest$ {
-  /** @deprecated use `PlanningQueryRequest$inboundSchema` instead. */
-  export const inboundSchema = PlanningQueryRequest$inboundSchema;
-  /** @deprecated use `PlanningQueryRequest$outboundSchema` instead. */
-  export const outboundSchema = PlanningQueryRequest$outboundSchema;
-  /** @deprecated use `PlanningQueryRequest$Outbound` instead. */
-  export type Outbound = PlanningQueryRequest$Outbound;
-}
-
 export function planningQueryRequestToJSON(
   planningQueryRequest: PlanningQueryRequest,
 ): string {
@@ -130,13 +70,3 @@ export function planningQueryRequestToJSON(
     PlanningQueryRequest$outboundSchema.parse(planningQueryRequest),
   );
 }
-
-export function planningQueryRequestFromJSON(
-  jsonString: string,
-): SafeParseResult<PlanningQueryRequest, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PlanningQueryRequest$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PlanningQueryRequest' from JSON`,
-  );
-}

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

@@ -0,0 +1,73 @@
+/*
+ * 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";
+
+/**
+ * Direction of price change
+ */
+export const PriceChangeDirection = {
+  Up: "up",
+  Down: "down",
+  Initial: "initial",
+} as const;
+/**
+ * Direction of price change
+ */
+export type PriceChangeDirection = ClosedEnum<typeof PriceChangeDirection>;
+
+export type PriceChange = {
+  /**
+   * Amount of change in pence
+   */
+  amount: number;
+  /**
+   * Date of price change
+   */
+  date: Date;
+  /**
+   * Direction of price change
+   */
+  direction: PriceChangeDirection;
+  /**
+   * Percentage change
+   */
+  percent: number;
+  /**
+   * New price after change in pence
+   */
+  price: number;
+};
+
+/** @internal */
+export const PriceChangeDirection$inboundSchema: z.ZodNativeEnum<
+  typeof PriceChangeDirection
+> = z.nativeEnum(PriceChangeDirection);
+
+/** @internal */
+export const PriceChange$inboundSchema: z.ZodType<
+  PriceChange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.number(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  direction: PriceChangeDirection$inboundSchema,
+  percent: z.number(),
+  price: z.number(),
+});
+
+export function priceChangeFromJSON(
+  jsonString: string,
+): SafeParseResult<PriceChange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PriceChange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PriceChange' from JSON`,
+  );
+}

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

@@ -15,23 +15,19 @@ export type PricingData = {
   /**
    * Current rental price per month in pence
    */
-  currentRentPrice?: number | undefined;
+  currentRent?: number | null | undefined;
   /**
    * Current sale price in pence
    */
-  currentSalePrice?: number | undefined;
+  currentSale?: number | null | undefined;
   /**
    * Estimated rental value per month in pence
    */
-  estimatedRentValue?: number | undefined;
+  estimatedRent?: number | null | undefined;
   /**
    * Estimated sale value in pence
    */
-  estimatedSaleValue?: number | undefined;
-  /**
-   * Price per square foot
-   */
-  pricePerSqFt?: number | undefined;
+  estimatedSale?: number | null | undefined;
 };
 
 /** @internal */
@@ -40,55 +36,13 @@ export const PricingData$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  currency: z.string().default("GBP"),
-  currentRentPrice: z.number().optional(),
-  currentSalePrice: z.number().optional(),
-  estimatedRentValue: z.number().optional(),
-  estimatedSaleValue: z.number().optional(),
-  pricePerSqFt: z.number().optional(),
+  currency: z.string().optional(),
+  currentRent: z.nullable(z.number()).optional(),
+  currentSale: z.nullable(z.number()).optional(),
+  estimatedRent: z.nullable(z.number()).optional(),
+  estimatedSale: z.nullable(z.number()).optional(),
 });
 
-/** @internal */
-export type PricingData$Outbound = {
-  currency: string;
-  currentRentPrice?: number | undefined;
-  currentSalePrice?: number | undefined;
-  estimatedRentValue?: number | undefined;
-  estimatedSaleValue?: number | undefined;
-  pricePerSqFt?: number | undefined;
-};
-
-/** @internal */
-export const PricingData$outboundSchema: z.ZodType<
-  PricingData$Outbound,
-  z.ZodTypeDef,
-  PricingData
-> = z.object({
-  currency: z.string().default("GBP"),
-  currentRentPrice: z.number().optional(),
-  currentSalePrice: z.number().optional(),
-  estimatedRentValue: z.number().optional(),
-  estimatedSaleValue: z.number().optional(),
-  pricePerSqFt: 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 PricingData$ {
-  /** @deprecated use `PricingData$inboundSchema` instead. */
-  export const inboundSchema = PricingData$inboundSchema;
-  /** @deprecated use `PricingData$outboundSchema` instead. */
-  export const outboundSchema = PricingData$outboundSchema;
-  /** @deprecated use `PricingData$Outbound` instead. */
-  export type Outbound = PricingData$Outbound;
-}
-
-export function pricingDataToJSON(pricingData: PricingData): string {
-  return JSON.stringify(PricingData$outboundSchema.parse(pricingData));
-}
-
 export function pricingDataFromJSON(
   jsonString: string,
 ): SafeParseResult<PricingData, SDKValidationError> {

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

@@ -12,10 +12,6 @@ export type PropertyAddress = {
    * ISO country code
    */
   country?: string | undefined;
-  /**
-   * County or region
-   */
-  county?: string | undefined;
   /**
    * Formatted display address
    */
@@ -23,15 +19,11 @@ export type PropertyAddress = {
   /**
    * Postcode incode
    */
-  incode?: string | undefined;
-  /**
-   * Local area or neighbourhood
-   */
-  locality?: string | undefined;
+  incode: string;
   /**
    * Postcode outcode
    */
-  outcode?: string | undefined;
+  outcode: string;
   /**
    * UK postcode
    */
@@ -39,19 +31,7 @@ export type PropertyAddress = {
   /**
    * Postcode without spaces
    */
-  postcodeNoSpace?: string | undefined;
-  /**
-   * Street name
-   */
-  streetName?: string | undefined;
-  /**
-   * Street/house number
-   */
-  streetNumber?: string | undefined;
-  /**
-   * Town or city
-   */
-  town?: string | undefined;
+  postcodeNoSpace: string;
 };
 
 /** @internal */
@@ -61,71 +41,13 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   country: z.string().default("GB"),
-  county: z.string().optional(),
-  displayAddress: z.string(),
-  incode: z.string().optional(),
-  locality: z.string().optional(),
-  outcode: z.string().optional(),
-  postcode: z.string(),
-  postcodeNoSpace: z.string().optional(),
-  streetName: z.string().optional(),
-  streetNumber: z.string().optional(),
-  town: z.string().optional(),
-});
-
-/** @internal */
-export type PropertyAddress$Outbound = {
-  country: string;
-  county?: string | undefined;
-  displayAddress: string;
-  incode?: string | undefined;
-  locality?: string | undefined;
-  outcode?: string | undefined;
-  postcode: string;
-  postcodeNoSpace?: string | undefined;
-  streetName?: string | undefined;
-  streetNumber?: string | undefined;
-  town?: string | undefined;
-};
-
-/** @internal */
-export const PropertyAddress$outboundSchema: z.ZodType<
-  PropertyAddress$Outbound,
-  z.ZodTypeDef,
-  PropertyAddress
-> = z.object({
-  country: z.string().default("GB"),
-  county: z.string().optional(),
   displayAddress: z.string(),
-  incode: z.string().optional(),
-  locality: z.string().optional(),
-  outcode: z.string().optional(),
+  incode: z.string(),
+  outcode: z.string(),
   postcode: z.string(),
-  postcodeNoSpace: z.string().optional(),
-  streetName: z.string().optional(),
-  streetNumber: z.string().optional(),
-  town: z.string().optional(),
+  postcodeNoSpace: 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 PropertyAddress$ {
-  /** @deprecated use `PropertyAddress$inboundSchema` instead. */
-  export const inboundSchema = PropertyAddress$inboundSchema;
-  /** @deprecated use `PropertyAddress$outboundSchema` instead. */
-  export const outboundSchema = PropertyAddress$outboundSchema;
-  /** @deprecated use `PropertyAddress$Outbound` instead. */
-  export type Outbound = PropertyAddress$Outbound;
-}
-
-export function propertyAddressToJSON(
-  propertyAddress: PropertyAddress,
-): string {
-  return JSON.stringify(PropertyAddress$outboundSchema.parse(propertyAddress));
-}
-
 export function propertyAddressFromJSON(
   jsonString: string,
 ): SafeParseResult<PropertyAddress, SDKValidationError> {

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

@@ -3,42 +3,33 @@
  */
 
 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";
 import {
   PropertyLocationIdAreaFilter,
-  PropertyLocationIdAreaFilter$inboundSchema,
   PropertyLocationIdAreaFilter$Outbound,
   PropertyLocationIdAreaFilter$outboundSchema,
 } from "./propertylocationidareafilter.js";
 import {
   PropertyMultiPolygonAreaFilter,
-  PropertyMultiPolygonAreaFilter$inboundSchema,
   PropertyMultiPolygonAreaFilter$Outbound,
   PropertyMultiPolygonAreaFilter$outboundSchema,
 } from "./propertymultipolygonareafilter.js";
 import {
   PropertyOutcodeAreaFilter,
-  PropertyOutcodeAreaFilter$inboundSchema,
   PropertyOutcodeAreaFilter$Outbound,
   PropertyOutcodeAreaFilter$outboundSchema,
 } from "./propertyoutcodeareafilter.js";
 import {
   PropertyPointAreaFilter,
-  PropertyPointAreaFilter$inboundSchema,
   PropertyPointAreaFilter$Outbound,
   PropertyPointAreaFilter$outboundSchema,
 } from "./propertypointareafilter.js";
 import {
   PropertyPolygonAreaFilter,
-  PropertyPolygonAreaFilter$inboundSchema,
   PropertyPolygonAreaFilter$Outbound,
   PropertyPolygonAreaFilter$outboundSchema,
 } from "./propertypolygonareafilter.js";
 import {
   PropertyPostcodeAreaFilter,
-  PropertyPostcodeAreaFilter$inboundSchema,
   PropertyPostcodeAreaFilter$Outbound,
   PropertyPostcodeAreaFilter$outboundSchema,
 } from "./propertypostcodeareafilter.js";
@@ -51,20 +42,6 @@ export type PropertyAreaFilter =
   | PropertyMultiPolygonAreaFilter
   | PropertyLocationIdAreaFilter;
 
-/** @internal */
-export const PropertyAreaFilter$inboundSchema: z.ZodType<
-  PropertyAreaFilter,
-  z.ZodTypeDef,
-  unknown
-> = z.union([
-  PropertyPointAreaFilter$inboundSchema,
-  PropertyPostcodeAreaFilter$inboundSchema,
-  PropertyOutcodeAreaFilter$inboundSchema,
-  PropertyPolygonAreaFilter$inboundSchema,
-  PropertyMultiPolygonAreaFilter$inboundSchema,
-  PropertyLocationIdAreaFilter$inboundSchema,
-]);
-
 /** @internal */
 export type PropertyAreaFilter$Outbound =
   | PropertyPointAreaFilter$Outbound
@@ -88,19 +65,6 @@ export const PropertyAreaFilter$outboundSchema: z.ZodType<
   PropertyLocationIdAreaFilter$outboundSchema,
 ]);
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PropertyAreaFilter$ {
-  /** @deprecated use `PropertyAreaFilter$inboundSchema` instead. */
-  export const inboundSchema = PropertyAreaFilter$inboundSchema;
-  /** @deprecated use `PropertyAreaFilter$outboundSchema` instead. */
-  export const outboundSchema = PropertyAreaFilter$outboundSchema;
-  /** @deprecated use `PropertyAreaFilter$Outbound` instead. */
-  export type Outbound = PropertyAreaFilter$Outbound;
-}
-
 export function propertyAreaFilterToJSON(
   propertyAreaFilter: PropertyAreaFilter,
 ): string {
@@ -108,13 +72,3 @@ export function propertyAreaFilterToJSON(
     PropertyAreaFilter$outboundSchema.parse(propertyAreaFilter),
   );
 }
-
-export function propertyAreaFilterFromJSON(
-  jsonString: string,
-): SafeParseResult<PropertyAreaFilter, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PropertyAreaFilter$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PropertyAreaFilter' from JSON`,
-  );
-}

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

@@ -3,13 +3,10 @@
  */
 
 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 PropertyBySlugsRequest = {
   /**
-   * List of attributes to include in response
+   * List of attributes to include in response. Only specified fields will be returned (plus locationId which is always included)
    */
   attributes?: Array<string> | undefined;
   /**
@@ -26,18 +23,6 @@ export type PropertyBySlugsRequest = {
   track?: boolean | undefined;
 };
 
-/** @internal */
-export const PropertyBySlugsRequest$inboundSchema: z.ZodType<
-  PropertyBySlugsRequest,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  attributes: z.array(z.string()).optional(),
-  limit: z.number().default(25),
-  slugs: z.array(z.string()),
-  track: z.boolean().default(false),
-});
-
 /** @internal */
 export type PropertyBySlugsRequest$Outbound = {
   attributes?: Array<string> | undefined;
@@ -58,19 +43,6 @@ export const PropertyBySlugsRequest$outboundSchema: z.ZodType<
   track: 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 PropertyBySlugsRequest$ {
-  /** @deprecated use `PropertyBySlugsRequest$inboundSchema` instead. */
-  export const inboundSchema = PropertyBySlugsRequest$inboundSchema;
-  /** @deprecated use `PropertyBySlugsRequest$outboundSchema` instead. */
-  export const outboundSchema = PropertyBySlugsRequest$outboundSchema;
-  /** @deprecated use `PropertyBySlugsRequest$Outbound` instead. */
-  export type Outbound = PropertyBySlugsRequest$Outbound;
-}
-
 export function propertyBySlugsRequestToJSON(
   propertyBySlugsRequest: PropertyBySlugsRequest,
 ): string {
@@ -78,13 +50,3 @@ export function propertyBySlugsRequestToJSON(
     PropertyBySlugsRequest$outboundSchema.parse(propertyBySlugsRequest),
   );
 }
-
-export function propertyBySlugsRequestFromJSON(
-  jsonString: string,
-): SafeParseResult<PropertyBySlugsRequest, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PropertyBySlugsRequest$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PropertyBySlugsRequest' from JSON`,
-  );
-}