@vepler/sdk 2.0.0 → 2.3.0

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

@@ -0,0 +1,128 @@
+/*
+ * 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 PriceChangeDirection$outboundSchema: z.ZodNativeEnum<
+  typeof PriceChangeDirection
+> = PriceChangeDirection$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PriceChangeDirection$ {
+  /** @deprecated use `PriceChangeDirection$inboundSchema` instead. */
+  export const inboundSchema = PriceChangeDirection$inboundSchema;
+  /** @deprecated use `PriceChangeDirection$outboundSchema` instead. */
+  export const outboundSchema = PriceChangeDirection$outboundSchema;
+}
+
+/** @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(),
+});
+
+/** @internal */
+export type PriceChange$Outbound = {
+  amount: number;
+  date: string;
+  direction: string;
+  percent: number;
+  price: number;
+};
+
+/** @internal */
+export const PriceChange$outboundSchema: z.ZodType<
+  PriceChange$Outbound,
+  z.ZodTypeDef,
+  PriceChange
+> = z.object({
+  amount: z.number(),
+  date: z.date().transform(v => v.toISOString()),
+  direction: PriceChangeDirection$outboundSchema,
+  percent: z.number(),
+  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 PriceChange$ {
+  /** @deprecated use `PriceChange$inboundSchema` instead. */
+  export const inboundSchema = PriceChange$inboundSchema;
+  /** @deprecated use `PriceChange$outboundSchema` instead. */
+  export const outboundSchema = PriceChange$outboundSchema;
+  /** @deprecated use `PriceChange$Outbound` instead. */
+  export type Outbound = PriceChange$Outbound;
+}
+
+export function priceChangeToJSON(priceChange: PriceChange): string {
+  return JSON.stringify(PriceChange$outboundSchema.parse(priceChange));
+}
+
+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,22 +36,20 @@ 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;
+  currency?: string | undefined;
+  currentRent?: number | null | undefined;
+  currentSale?: number | null | undefined;
+  estimatedRent?: number | null | undefined;
+  estimatedSale?: number | null | undefined;
 };
 
 /** @internal */
@@ -64,12 +58,11 @@ export const PricingData$outboundSchema: z.ZodType<
   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(),
+  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(),
 });
 
 /**

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,31 +41,21 @@ 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(),
+  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 */
 export type PropertyAddress$Outbound = {
   country: string;
-  county?: string | undefined;
   displayAddress: string;
-  incode?: string | undefined;
-  locality?: string | undefined;
-  outcode?: string | undefined;
+  incode: string;
+  outcode: string;
   postcode: string;
-  postcodeNoSpace?: string | undefined;
-  streetName?: string | undefined;
-  streetNumber?: string | undefined;
-  town?: string | undefined;
+  postcodeNoSpace: string;
 };
 
 /** @internal */
@@ -95,16 +65,11 @@ export const PropertyAddress$outboundSchema: z.ZodType<
   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(),
 });
 
 /**