@vepler/sdk 0.1.0 → 1.9.9

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

@@ -0,0 +1,104 @@
+/*
+ * 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";
+
+export const Type = {
+  Point: "point",
+} as const;
+export type Type = ClosedEnum<typeof Type>;
+
+export type PointAreaFilter = {
+  /**
+   * [latitude, longitude] coordinates
+   */
+  coordinates: Array<number>;
+  /**
+   * Search radius in meters
+   */
+  radius: number;
+  type: Type;
+};
+
+/** @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 PointAreaFilter$inboundSchema: z.ZodType<
+  PointAreaFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  coordinates: z.array(z.number()),
+  radius: z.number(),
+  type: Type$inboundSchema,
+});
+
+/** @internal */
+export type PointAreaFilter$Outbound = {
+  coordinates: Array<number>;
+  radius: number;
+  type: string;
+};
+
+/** @internal */
+export const PointAreaFilter$outboundSchema: z.ZodType<
+  PointAreaFilter$Outbound,
+  z.ZodTypeDef,
+  PointAreaFilter
+> = z.object({
+  coordinates: z.array(z.number()),
+  radius: z.number(),
+  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 PointAreaFilter$ {
+  /** @deprecated use `PointAreaFilter$inboundSchema` instead. */
+  export const inboundSchema = PointAreaFilter$inboundSchema;
+  /** @deprecated use `PointAreaFilter$outboundSchema` instead. */
+  export const outboundSchema = PointAreaFilter$outboundSchema;
+  /** @deprecated use `PointAreaFilter$Outbound` instead. */
+  export type Outbound = PointAreaFilter$Outbound;
+}
+
+export function pointAreaFilterToJSON(
+  pointAreaFilter: PointAreaFilter,
+): string {
+  return JSON.stringify(PointAreaFilter$outboundSchema.parse(pointAreaFilter));
+}
+
+export function pointAreaFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<PointAreaFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PointAreaFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PointAreaFilter' from JSON`,
+  );
+}

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

@@ -0,0 +1,100 @@
+/*
+ * 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";
+
+export const PolygonAreaFilterType = {
+  Polygon: "polygon",
+} as const;
+export type PolygonAreaFilterType = ClosedEnum<typeof PolygonAreaFilterType>;
+
+export type PolygonAreaFilter = {
+  /**
+   * Array of [lat, lng] coordinates forming a polygon
+   */
+  polygon: Array<Array<number>>;
+  type: PolygonAreaFilterType;
+};
+
+/** @internal */
+export const PolygonAreaFilterType$inboundSchema: z.ZodNativeEnum<
+  typeof PolygonAreaFilterType
+> = z.nativeEnum(PolygonAreaFilterType);
+
+/** @internal */
+export const PolygonAreaFilterType$outboundSchema: z.ZodNativeEnum<
+  typeof PolygonAreaFilterType
+> = PolygonAreaFilterType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PolygonAreaFilterType$ {
+  /** @deprecated use `PolygonAreaFilterType$inboundSchema` instead. */
+  export const inboundSchema = PolygonAreaFilterType$inboundSchema;
+  /** @deprecated use `PolygonAreaFilterType$outboundSchema` instead. */
+  export const outboundSchema = PolygonAreaFilterType$outboundSchema;
+}
+
+/** @internal */
+export const PolygonAreaFilter$inboundSchema: z.ZodType<
+  PolygonAreaFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  polygon: z.array(z.array(z.number())),
+  type: PolygonAreaFilterType$inboundSchema,
+});
+
+/** @internal */
+export type PolygonAreaFilter$Outbound = {
+  polygon: Array<Array<number>>;
+  type: string;
+};
+
+/** @internal */
+export const PolygonAreaFilter$outboundSchema: z.ZodType<
+  PolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  PolygonAreaFilter
+> = z.object({
+  polygon: z.array(z.array(z.number())),
+  type: PolygonAreaFilterType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PolygonAreaFilter$ {
+  /** @deprecated use `PolygonAreaFilter$inboundSchema` instead. */
+  export const inboundSchema = PolygonAreaFilter$inboundSchema;
+  /** @deprecated use `PolygonAreaFilter$outboundSchema` instead. */
+  export const outboundSchema = PolygonAreaFilter$outboundSchema;
+  /** @deprecated use `PolygonAreaFilter$Outbound` instead. */
+  export type Outbound = PolygonAreaFilter$Outbound;
+}
+
+export function polygonAreaFilterToJSON(
+  polygonAreaFilter: PolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    PolygonAreaFilter$outboundSchema.parse(polygonAreaFilter),
+  );
+}
+
+export function polygonAreaFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<PolygonAreaFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PolygonAreaFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PolygonAreaFilter' from JSON`,
+  );
+}

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

@@ -0,0 +1,107 @@
+/*
+ * 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";
+
+export const PostcodeAreaFilterType = {
+  Postcode: "postcode",
+} as const;
+export type PostcodeAreaFilterType = ClosedEnum<typeof PostcodeAreaFilterType>;
+
+export type PostcodeAreaFilter = {
+  /**
+   * Search radius in meters
+   */
+  radius?: number | undefined;
+  type: PostcodeAreaFilterType;
+  /**
+   * UK postcode or partial postcode
+   */
+  value: string;
+};
+
+/** @internal */
+export const PostcodeAreaFilterType$inboundSchema: z.ZodNativeEnum<
+  typeof PostcodeAreaFilterType
+> = z.nativeEnum(PostcodeAreaFilterType);
+
+/** @internal */
+export const PostcodeAreaFilterType$outboundSchema: z.ZodNativeEnum<
+  typeof PostcodeAreaFilterType
+> = PostcodeAreaFilterType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PostcodeAreaFilterType$ {
+  /** @deprecated use `PostcodeAreaFilterType$inboundSchema` instead. */
+  export const inboundSchema = PostcodeAreaFilterType$inboundSchema;
+  /** @deprecated use `PostcodeAreaFilterType$outboundSchema` instead. */
+  export const outboundSchema = PostcodeAreaFilterType$outboundSchema;
+}
+
+/** @internal */
+export const PostcodeAreaFilter$inboundSchema: z.ZodType<
+  PostcodeAreaFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  radius: z.number().optional(),
+  type: PostcodeAreaFilterType$inboundSchema,
+  value: z.string(),
+});
+
+/** @internal */
+export type PostcodeAreaFilter$Outbound = {
+  radius?: number | undefined;
+  type: string;
+  value: string;
+};
+
+/** @internal */
+export const PostcodeAreaFilter$outboundSchema: z.ZodType<
+  PostcodeAreaFilter$Outbound,
+  z.ZodTypeDef,
+  PostcodeAreaFilter
+> = z.object({
+  radius: z.number().optional(),
+  type: PostcodeAreaFilterType$outboundSchema,
+  value: 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 PostcodeAreaFilter$ {
+  /** @deprecated use `PostcodeAreaFilter$inboundSchema` instead. */
+  export const inboundSchema = PostcodeAreaFilter$inboundSchema;
+  /** @deprecated use `PostcodeAreaFilter$outboundSchema` instead. */
+  export const outboundSchema = PostcodeAreaFilter$outboundSchema;
+  /** @deprecated use `PostcodeAreaFilter$Outbound` instead. */
+  export type Outbound = PostcodeAreaFilter$Outbound;
+}
+
+export function postcodeAreaFilterToJSON(
+  postcodeAreaFilter: PostcodeAreaFilter,
+): string {
+  return JSON.stringify(
+    PostcodeAreaFilter$outboundSchema.parse(postcodeAreaFilter),
+  );
+}
+
+export function postcodeAreaFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<PostcodeAreaFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PostcodeAreaFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PostcodeAreaFilter' from JSON`,
+  );
+}

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

@@ -8,9 +8,29 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PricingData = {
+  /**
+   * ISO currency code
+   */
   currency?: string | undefined;
-  currentPrice?: number | undefined;
-  estimatedValue?: number | undefined;
+  /**
+   * Current rental price per month in pence
+   */
+  currentRentPrice?: number | undefined;
+  /**
+   * Current sale price in pence
+   */
+  currentSalePrice?: number | undefined;
+  /**
+   * Estimated rental value per month in pence
+   */
+  estimatedRentValue?: number | undefined;
+  /**
+   * Estimated sale value in pence
+   */
+  estimatedSaleValue?: number | undefined;
+  /**
+   * Price per square foot
+   */
   pricePerSqFt?: number | undefined;
 };
 
@@ -21,16 +41,20 @@ export const PricingData$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   currency: z.string().default("GBP"),
-  currentPrice: z.number().optional(),
-  estimatedValue: z.number().optional(),
+  currentRentPrice: z.number().optional(),
+  currentSalePrice: z.number().optional(),
+  estimatedRentValue: z.number().optional(),
+  estimatedSaleValue: z.number().optional(),
   pricePerSqFt: z.number().optional(),
 });
 
 /** @internal */
 export type PricingData$Outbound = {
   currency: string;
-  currentPrice?: number | undefined;
-  estimatedValue?: number | undefined;
+  currentRentPrice?: number | undefined;
+  currentSalePrice?: number | undefined;
+  estimatedRentValue?: number | undefined;
+  estimatedSaleValue?: number | undefined;
   pricePerSqFt?: number | undefined;
 };
 
@@ -41,8 +65,10 @@ export const PricingData$outboundSchema: z.ZodType<
   PricingData
 > = z.object({
   currency: z.string().default("GBP"),
-  currentPrice: z.number().optional(),
-  estimatedValue: z.number().optional(),
+  currentRentPrice: z.number().optional(),
+  currentSalePrice: z.number().optional(),
+  estimatedRentValue: z.number().optional(),
+  estimatedSaleValue: z.number().optional(),
   pricePerSqFt: z.number().optional(),
 });
 

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

@@ -8,13 +8,49 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type PropertyAddress = {
+  /**
+   * ISO country code
+   */
   country?: string | undefined;
+  /**
+   * County or region
+   */
   county?: string | undefined;
+  /**
+   * Formatted display address
+   */
   displayAddress: string;
+  /**
+   * Postcode incode
+   */
+  incode?: string | undefined;
+  /**
+   * Local area or neighbourhood
+   */
   locality?: string | undefined;
+  /**
+   * Postcode outcode
+   */
+  outcode?: string | undefined;
+  /**
+   * Full UK postcode
+   */
   postcode: string;
+  /**
+   * Postcode without spaces
+   */
+  postcodeNoSpace?: string | undefined;
+  /**
+   * Street name
+   */
   streetName?: string | undefined;
+  /**
+   * Street/house number
+   */
   streetNumber?: string | undefined;
+  /**
+   * Town or city
+   */
   town?: string | undefined;
 };
 
@@ -24,11 +60,14 @@ export const PropertyAddress$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  country: z.string().optional(),
+  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(),
@@ -36,11 +75,14 @@ export const PropertyAddress$inboundSchema: z.ZodType<
 
 /** @internal */
 export type PropertyAddress$Outbound = {
-  country?: string | undefined;
+  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;
@@ -52,11 +94,14 @@ export const PropertyAddress$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   PropertyAddress
 > = z.object({
-  country: z.string().optional(),
+  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(),