@vepler/sdk 2.0.0 → 2.3.0

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

@@ -0,0 +1,130 @@
+/*
+ * 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 Direction = {
+  Up: "up",
+  Down: "down",
+  Initial: "initial",
+} as const;
+/**
+ * Direction of price change
+ */
+export type Direction = ClosedEnum<typeof Direction>;
+
+export type ListingPriceChange = {
+  /**
+   * Amount of change in pence
+   */
+  amount: number;
+  /**
+   * Date of price change
+   */
+  date: Date;
+  /**
+   * Direction of price change
+   */
+  direction: Direction;
+  /**
+   * Percentage change
+   */
+  percent: number;
+  /**
+   * New price after change in pence
+   */
+  price: number;
+};
+
+/** @internal */
+export const Direction$inboundSchema: z.ZodNativeEnum<typeof Direction> = z
+  .nativeEnum(Direction);
+
+/** @internal */
+export const Direction$outboundSchema: z.ZodNativeEnum<typeof Direction> =
+  Direction$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Direction$ {
+  /** @deprecated use `Direction$inboundSchema` instead. */
+  export const inboundSchema = Direction$inboundSchema;
+  /** @deprecated use `Direction$outboundSchema` instead. */
+  export const outboundSchema = Direction$outboundSchema;
+}
+
+/** @internal */
+export const ListingPriceChange$inboundSchema: z.ZodType<
+  ListingPriceChange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.number(),
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  direction: Direction$inboundSchema,
+  percent: z.number(),
+  price: z.number(),
+});
+
+/** @internal */
+export type ListingPriceChange$Outbound = {
+  amount: number;
+  date: string;
+  direction: string;
+  percent: number;
+  price: number;
+};
+
+/** @internal */
+export const ListingPriceChange$outboundSchema: z.ZodType<
+  ListingPriceChange$Outbound,
+  z.ZodTypeDef,
+  ListingPriceChange
+> = z.object({
+  amount: z.number(),
+  date: z.date().transform(v => v.toISOString()),
+  direction: Direction$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 ListingPriceChange$ {
+  /** @deprecated use `ListingPriceChange$inboundSchema` instead. */
+  export const inboundSchema = ListingPriceChange$inboundSchema;
+  /** @deprecated use `ListingPriceChange$outboundSchema` instead. */
+  export const outboundSchema = ListingPriceChange$outboundSchema;
+  /** @deprecated use `ListingPriceChange$Outbound` instead. */
+  export type Outbound = ListingPriceChange$Outbound;
+}
+
+export function listingPriceChangeToJSON(
+  listingPriceChange: ListingPriceChange,
+): string {
+  return JSON.stringify(
+    ListingPriceChange$outboundSchema.parse(listingPriceChange),
+  );
+}
+
+export function listingPriceChangeFromJSON(
+  jsonString: string,
+): SafeParseResult<ListingPriceChange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListingPriceChange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListingPriceChange' from JSON`,
+  );
+}

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

@@ -35,27 +35,101 @@ export const ForSale = {
  */
 export type ForSale = ClosedEnum<typeof ForSale>;
 
+export const MarketStatusStatus = {
+  Live: "live",
+  Sstc: "sstc",
+  UnderOffer: "under_offer",
+  Reserved: "reserved",
+  Removed: "removed",
+} as const;
+export type MarketStatusStatus = ClosedEnum<typeof MarketStatusStatus>;
+
+export const MarketStatusSchemasStatus = {
+  Live: "live",
+  Sstc: "sstc",
+  UnderOffer: "under_offer",
+  Reserved: "reserved",
+  Removed: "removed",
+} as const;
+export type MarketStatusSchemasStatus = ClosedEnum<
+  typeof MarketStatusSchemasStatus
+>;
+
+export type StatusTimeline = {
+  /**
+   * Period end date
+   */
+  end?: Date | null | undefined;
+  /**
+   * Period start date
+   */
+  start: Date;
+  status: MarketStatusSchemasStatus;
+};
+
+export const MarketStatusType = {
+  Sale: "sale",
+  Rent: "rent",
+} as const;
+export type MarketStatusType = ClosedEnum<typeof MarketStatusType>;
+
+export type Timeline = {
+  end?: Date | null | undefined;
+  start: Date;
+  status?: MarketStatusStatus | undefined;
+  statusTimeline?: Array<StatusTimeline> | undefined;
+  type: MarketStatusType;
+};
+
 export type MarketStatus = {
   /**
-   * Number of days on market
+   * Back on the market for sale
+   */
+  backOTM?: boolean | null | undefined;
+  /**
+   * Back on the market for rent
    */
-  daysOnMarket?: number | undefined;
+  backOTMRent?: boolean | null | undefined;
   /**
    * Rental status
    */
-  forRent?: ForRent | undefined;
+  forRent: ForRent;
   /**
    * Sale status
    */
-  forSale?: ForSale | undefined;
+  forSale: ForSale;
   /**
-   * ISO date when property was listed
+   * Last date property was on the market for sale
    */
-  listingDate?: string | undefined;
+  lastOTM?: Date | null | undefined;
   /**
-   * ISO date when property was sold
+   * Last date property was on the market for rent
    */
-  soldDate?: string | undefined;
+  lastOTMRent?: Date | null | undefined;
+  /**
+   * Price per square foot
+   */
+  pricePerSqft?: number | null | undefined;
+  /**
+   * Price per square metre
+   */
+  pricePerSqm?: number | null | undefined;
+  /**
+   * Reserved date
+   */
+  reservedDate?: Date | null | undefined;
+  /**
+   * Sold Subject To Contract date
+   */
+  sstcDate?: Date | null | undefined;
+  /**
+   * Market timeline history
+   */
+  timeline: Array<Timeline>;
+  /**
+   * Under offer date
+   */
+  underOfferDate?: Date | null | undefined;
 };
 
 /** @internal */
@@ -96,26 +170,237 @@ export namespace ForSale$ {
   export const outboundSchema = ForSale$outboundSchema;
 }
 
+/** @internal */
+export const MarketStatusStatus$inboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusStatus
+> = z.nativeEnum(MarketStatusStatus);
+
+/** @internal */
+export const MarketStatusStatus$outboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusStatus
+> = MarketStatusStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarketStatusStatus$ {
+  /** @deprecated use `MarketStatusStatus$inboundSchema` instead. */
+  export const inboundSchema = MarketStatusStatus$inboundSchema;
+  /** @deprecated use `MarketStatusStatus$outboundSchema` instead. */
+  export const outboundSchema = MarketStatusStatus$outboundSchema;
+}
+
+/** @internal */
+export const MarketStatusSchemasStatus$inboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusSchemasStatus
+> = z.nativeEnum(MarketStatusSchemasStatus);
+
+/** @internal */
+export const MarketStatusSchemasStatus$outboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusSchemasStatus
+> = MarketStatusSchemasStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarketStatusSchemasStatus$ {
+  /** @deprecated use `MarketStatusSchemasStatus$inboundSchema` instead. */
+  export const inboundSchema = MarketStatusSchemasStatus$inboundSchema;
+  /** @deprecated use `MarketStatusSchemasStatus$outboundSchema` instead. */
+  export const outboundSchema = MarketStatusSchemasStatus$outboundSchema;
+}
+
+/** @internal */
+export const StatusTimeline$inboundSchema: z.ZodType<
+  StatusTimeline,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  end: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  status: MarketStatusSchemasStatus$inboundSchema,
+});
+
+/** @internal */
+export type StatusTimeline$Outbound = {
+  end?: string | null | undefined;
+  start: string;
+  status: string;
+};
+
+/** @internal */
+export const StatusTimeline$outboundSchema: z.ZodType<
+  StatusTimeline$Outbound,
+  z.ZodTypeDef,
+  StatusTimeline
+> = z.object({
+  end: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  start: z.date().transform(v => v.toISOString()),
+  status: MarketStatusSchemasStatus$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace StatusTimeline$ {
+  /** @deprecated use `StatusTimeline$inboundSchema` instead. */
+  export const inboundSchema = StatusTimeline$inboundSchema;
+  /** @deprecated use `StatusTimeline$outboundSchema` instead. */
+  export const outboundSchema = StatusTimeline$outboundSchema;
+  /** @deprecated use `StatusTimeline$Outbound` instead. */
+  export type Outbound = StatusTimeline$Outbound;
+}
+
+export function statusTimelineToJSON(statusTimeline: StatusTimeline): string {
+  return JSON.stringify(StatusTimeline$outboundSchema.parse(statusTimeline));
+}
+
+export function statusTimelineFromJSON(
+  jsonString: string,
+): SafeParseResult<StatusTimeline, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StatusTimeline$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StatusTimeline' from JSON`,
+  );
+}
+
+/** @internal */
+export const MarketStatusType$inboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusType
+> = z.nativeEnum(MarketStatusType);
+
+/** @internal */
+export const MarketStatusType$outboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusType
+> = MarketStatusType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarketStatusType$ {
+  /** @deprecated use `MarketStatusType$inboundSchema` instead. */
+  export const inboundSchema = MarketStatusType$inboundSchema;
+  /** @deprecated use `MarketStatusType$outboundSchema` instead. */
+  export const outboundSchema = MarketStatusType$outboundSchema;
+}
+
+/** @internal */
+export const Timeline$inboundSchema: z.ZodType<
+  Timeline,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  end: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  start: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  status: MarketStatusStatus$inboundSchema.optional(),
+  statusTimeline: z.array(z.lazy(() => StatusTimeline$inboundSchema))
+    .optional(),
+  type: MarketStatusType$inboundSchema,
+});
+
+/** @internal */
+export type Timeline$Outbound = {
+  end?: string | null | undefined;
+  start: string;
+  status?: string | undefined;
+  statusTimeline?: Array<StatusTimeline$Outbound> | undefined;
+  type: string;
+};
+
+/** @internal */
+export const Timeline$outboundSchema: z.ZodType<
+  Timeline$Outbound,
+  z.ZodTypeDef,
+  Timeline
+> = z.object({
+  end: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  start: z.date().transform(v => v.toISOString()),
+  status: MarketStatusStatus$outboundSchema.optional(),
+  statusTimeline: z.array(z.lazy(() => StatusTimeline$outboundSchema))
+    .optional(),
+  type: MarketStatusType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Timeline$ {
+  /** @deprecated use `Timeline$inboundSchema` instead. */
+  export const inboundSchema = Timeline$inboundSchema;
+  /** @deprecated use `Timeline$outboundSchema` instead. */
+  export const outboundSchema = Timeline$outboundSchema;
+  /** @deprecated use `Timeline$Outbound` instead. */
+  export type Outbound = Timeline$Outbound;
+}
+
+export function timelineToJSON(timeline: Timeline): string {
+  return JSON.stringify(Timeline$outboundSchema.parse(timeline));
+}
+
+export function timelineFromJSON(
+  jsonString: string,
+): SafeParseResult<Timeline, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Timeline$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Timeline' from JSON`,
+  );
+}
+
 /** @internal */
 export const MarketStatus$inboundSchema: z.ZodType<
   MarketStatus,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  daysOnMarket: z.number().optional(),
-  forRent: ForRent$inboundSchema.optional(),
-  forSale: ForSale$inboundSchema.optional(),
-  listingDate: z.string().optional(),
-  soldDate: z.string().optional(),
+  backOTM: z.nullable(z.boolean()).optional(),
+  backOTMRent: z.nullable(z.boolean()).optional(),
+  forRent: ForRent$inboundSchema,
+  forSale: ForSale$inboundSchema,
+  lastOTM: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  lastOTMRent: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  pricePerSqft: z.nullable(z.number()).optional(),
+  pricePerSqm: z.nullable(z.number()).optional(),
+  reservedDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  sstcDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  timeline: z.array(z.lazy(() => Timeline$inboundSchema)),
+  underOfferDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
 });
 
 /** @internal */
 export type MarketStatus$Outbound = {
-  daysOnMarket?: number | undefined;
-  forRent?: string | undefined;
-  forSale?: string | undefined;
-  listingDate?: string | undefined;
-  soldDate?: string | undefined;
+  backOTM?: boolean | null | undefined;
+  backOTMRent?: boolean | null | undefined;
+  forRent: string;
+  forSale: string;
+  lastOTM?: string | null | undefined;
+  lastOTMRent?: string | null | undefined;
+  pricePerSqft?: number | null | undefined;
+  pricePerSqm?: number | null | undefined;
+  reservedDate?: string | null | undefined;
+  sstcDate?: string | null | undefined;
+  timeline: Array<Timeline$Outbound>;
+  underOfferDate?: string | null | undefined;
 };
 
 /** @internal */
@@ -124,11 +409,19 @@ export const MarketStatus$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MarketStatus
 > = z.object({
-  daysOnMarket: z.number().optional(),
-  forRent: ForRent$outboundSchema.optional(),
-  forSale: ForSale$outboundSchema.optional(),
-  listingDate: z.string().optional(),
-  soldDate: z.string().optional(),
+  backOTM: z.nullable(z.boolean()).optional(),
+  backOTMRent: z.nullable(z.boolean()).optional(),
+  forRent: ForRent$outboundSchema,
+  forSale: ForSale$outboundSchema,
+  lastOTM: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  lastOTMRent: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  pricePerSqft: z.nullable(z.number()).optional(),
+  pricePerSqm: z.nullable(z.number()).optional(),
+  reservedDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  sstcDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  timeline: z.array(z.lazy(() => Timeline$outboundSchema)),
+  underOfferDate: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
 });
 
 /**

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

@@ -20,7 +20,7 @@ export type Spatial = {
   type: PlanningApplicationType;
 };
 
-export const Status = {
+export const PlanningApplicationStatus = {
   Received: "received",
   PendingValidation: "pending_validation",
   Invalid: "invalid",
@@ -36,7 +36,9 @@ export const Status = {
   Expired: "expired",
   Unknown: "unknown",
 } as const;
-export type Status = ClosedEnum<typeof Status>;
+export type PlanningApplicationStatus = ClosedEnum<
+  typeof PlanningApplicationStatus
+>;
 
 export type PlanningApplication = {
   appealedDate?: string | null | undefined;
@@ -57,7 +59,7 @@ export type PlanningApplication = {
   sourceId: string;
   spatial?: Spatial | null | undefined;
   spatialFeatures?: any | null | undefined;
-  status: Status;
+  status: PlanningApplicationStatus;
   statusConfidence?: number | null | undefined;
   statusExternal?: string | null | undefined;
   type?: string | null | undefined;
@@ -139,22 +141,24 @@ export function spatialFromJSON(
 }
 
 /** @internal */
-export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
-  .nativeEnum(Status);
+export const PlanningApplicationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PlanningApplicationStatus
+> = z.nativeEnum(PlanningApplicationStatus);
 
 /** @internal */
-export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
-  Status$inboundSchema;
+export const PlanningApplicationStatus$outboundSchema: z.ZodNativeEnum<
+  typeof PlanningApplicationStatus
+> = PlanningApplicationStatus$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;
+export namespace PlanningApplicationStatus$ {
+  /** @deprecated use `PlanningApplicationStatus$inboundSchema` instead. */
+  export const inboundSchema = PlanningApplicationStatus$inboundSchema;
+  /** @deprecated use `PlanningApplicationStatus$outboundSchema` instead. */
+  export const outboundSchema = PlanningApplicationStatus$outboundSchema;
 }
 
 /** @internal */
@@ -175,7 +179,7 @@ export const PlanningApplication$inboundSchema: z.ZodType<
   sourceId: z.string(),
   spatial: z.nullable(z.lazy(() => Spatial$inboundSchema)).optional(),
   spatialFeatures: z.nullable(z.any()).optional(),
-  status: Status$inboundSchema,
+  status: PlanningApplicationStatus$inboundSchema,
   statusConfidence: z.nullable(z.number()).optional(),
   statusExternal: z.nullable(z.string()).optional(),
   type: z.nullable(z.string()).optional(),
@@ -227,7 +231,7 @@ export const PlanningApplication$outboundSchema: z.ZodType<
   sourceId: z.string(),
   spatial: z.nullable(z.lazy(() => Spatial$outboundSchema)).optional(),
   spatialFeatures: z.nullable(z.any()).optional(),
-  status: Status$outboundSchema,
+  status: PlanningApplicationStatus$outboundSchema,
   statusConfidence: z.nullable(z.number()).optional(),
   statusExternal: z.nullable(z.string()).optional(),
   type: z.nullable(z.string()).optional(),