@vepler/sdk 2.0.0 → 2.6.2

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

@@ -35,118 +35,204 @@ 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;
+  /**
+   * Last date property was on the market for sale
+   */
+  lastOTM?: Date | null | undefined;
+  /**
+   * Last date property was on the market for rent
+   */
+  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;
   /**
-   * ISO date when property was listed
+   * Market timeline history
    */
-  listingDate?: string | undefined;
+  timeline: Array<Timeline>;
   /**
-   * ISO date when property was sold
+   * Under offer date
    */
-  soldDate?: string | undefined;
+  underOfferDate?: Date | null | undefined;
 };
 
 /** @internal */
 export const ForRent$inboundSchema: z.ZodNativeEnum<typeof ForRent> = z
   .nativeEnum(ForRent);
 
-/** @internal */
-export const ForRent$outboundSchema: z.ZodNativeEnum<typeof ForRent> =
-  ForRent$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ForRent$ {
-  /** @deprecated use `ForRent$inboundSchema` instead. */
-  export const inboundSchema = ForRent$inboundSchema;
-  /** @deprecated use `ForRent$outboundSchema` instead. */
-  export const outboundSchema = ForRent$outboundSchema;
-}
-
 /** @internal */
 export const ForSale$inboundSchema: z.ZodNativeEnum<typeof ForSale> = z
   .nativeEnum(ForSale);
 
 /** @internal */
-export const ForSale$outboundSchema: z.ZodNativeEnum<typeof ForSale> =
-  ForSale$inboundSchema;
+export const MarketStatusStatus$inboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusStatus
+> = z.nativeEnum(MarketStatusStatus);
 
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ForSale$ {
-  /** @deprecated use `ForSale$inboundSchema` instead. */
-  export const inboundSchema = ForSale$inboundSchema;
-  /** @deprecated use `ForSale$outboundSchema` instead. */
-  export const outboundSchema = ForSale$outboundSchema;
-}
+/** @internal */
+export const MarketStatusSchemasStatus$inboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusSchemasStatus
+> = z.nativeEnum(MarketStatusSchemasStatus);
 
 /** @internal */
-export const MarketStatus$inboundSchema: z.ZodType<
-  MarketStatus,
+export const StatusTimeline$inboundSchema: z.ZodType<
+  StatusTimeline,
   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(),
+  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,
 });
 
+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 type MarketStatus$Outbound = {
-  daysOnMarket?: number | undefined;
-  forRent?: string | undefined;
-  forSale?: string | undefined;
-  listingDate?: string | undefined;
-  soldDate?: string | undefined;
-};
+export const MarketStatusType$inboundSchema: z.ZodNativeEnum<
+  typeof MarketStatusType
+> = z.nativeEnum(MarketStatusType);
 
 /** @internal */
-export const MarketStatus$outboundSchema: z.ZodType<
-  MarketStatus$Outbound,
+export const Timeline$inboundSchema: z.ZodType<
+  Timeline,
   z.ZodTypeDef,
-  MarketStatus
+  unknown
 > = z.object({
-  daysOnMarket: z.number().optional(),
-  forRent: ForRent$outboundSchema.optional(),
-  forSale: ForSale$outboundSchema.optional(),
-  listingDate: z.string().optional(),
-  soldDate: z.string().optional(),
+  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
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MarketStatus$ {
-  /** @deprecated use `MarketStatus$inboundSchema` instead. */
-  export const inboundSchema = MarketStatus$inboundSchema;
-  /** @deprecated use `MarketStatus$outboundSchema` instead. */
-  export const outboundSchema = MarketStatus$outboundSchema;
-  /** @deprecated use `MarketStatus$Outbound` instead. */
-  export type Outbound = MarketStatus$Outbound;
+export function timelineFromJSON(
+  jsonString: string,
+): SafeParseResult<Timeline, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Timeline$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Timeline' from JSON`,
+  );
 }
 
-export function marketStatusToJSON(marketStatus: MarketStatus): string {
-  return JSON.stringify(MarketStatus$outboundSchema.parse(marketStatus));
-}
+/** @internal */
+export const MarketStatus$inboundSchema: z.ZodType<
+  MarketStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  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(),
+});
 
 export function marketStatusFromJSON(
   jsonString: string,

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;
@@ -72,22 +74,6 @@ export const PlanningApplicationType$inboundSchema: z.ZodNativeEnum<
   typeof PlanningApplicationType
 > = z.nativeEnum(PlanningApplicationType);
 
-/** @internal */
-export const PlanningApplicationType$outboundSchema: z.ZodNativeEnum<
-  typeof PlanningApplicationType
-> = PlanningApplicationType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace PlanningApplicationType$ {
-  /** @deprecated use `PlanningApplicationType$inboundSchema` instead. */
-  export const inboundSchema = PlanningApplicationType$inboundSchema;
-  /** @deprecated use `PlanningApplicationType$outboundSchema` instead. */
-  export const outboundSchema = PlanningApplicationType$outboundSchema;
-}
-
 /** @internal */
 export const Spatial$inboundSchema: z.ZodType<Spatial, z.ZodTypeDef, unknown> =
   z.object({
@@ -95,39 +81,6 @@ export const Spatial$inboundSchema: z.ZodType<Spatial, z.ZodTypeDef, unknown> =
     type: PlanningApplicationType$inboundSchema,
   });
 
-/** @internal */
-export type Spatial$Outbound = {
-  coordinates: Array<number>;
-  type: string;
-};
-
-/** @internal */
-export const Spatial$outboundSchema: z.ZodType<
-  Spatial$Outbound,
-  z.ZodTypeDef,
-  Spatial
-> = z.object({
-  coordinates: z.array(z.number()),
-  type: PlanningApplicationType$outboundSchema,
-});
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Spatial$ {
-  /** @deprecated use `Spatial$inboundSchema` instead. */
-  export const inboundSchema = Spatial$inboundSchema;
-  /** @deprecated use `Spatial$outboundSchema` instead. */
-  export const outboundSchema = Spatial$outboundSchema;
-  /** @deprecated use `Spatial$Outbound` instead. */
-  export type Outbound = Spatial$Outbound;
-}
-
-export function spatialToJSON(spatial: Spatial): string {
-  return JSON.stringify(Spatial$outboundSchema.parse(spatial));
-}
-
 export function spatialFromJSON(
   jsonString: string,
 ): SafeParseResult<Spatial, SDKValidationError> {
@@ -139,23 +92,9 @@ export function spatialFromJSON(
 }
 
 /** @internal */
-export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
-  .nativeEnum(Status);
-
-/** @internal */
-export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
-  Status$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 const PlanningApplicationStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PlanningApplicationStatus
+> = z.nativeEnum(PlanningApplicationStatus);
 
 /** @internal */
 export const PlanningApplication$inboundSchema: z.ZodType<
@@ -175,59 +114,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,
-  statusConfidence: z.nullable(z.number()).optional(),
-  statusExternal: z.nullable(z.string()).optional(),
-  type: z.nullable(z.string()).optional(),
-  typeConfidence: z.nullable(z.number()).optional(),
-  typeExternal: z.nullable(z.string()).optional(),
-  updatedAt: z.string(),
-  validatedDate: z.nullable(z.string()).optional(),
-});
-
-/** @internal */
-export type PlanningApplication$Outbound = {
-  appealedDate?: string | null | undefined;
-  appealedStatus?: string | null | undefined;
-  createdAt: string;
-  description?: string | null | undefined;
-  developmentCategory?: string | null | undefined;
-  id: string;
-  key: string;
-  provider: string;
-  receivedDate?: string | null | undefined;
-  sourceId: string;
-  spatial?: Spatial$Outbound | null | undefined;
-  spatialFeatures?: any | null | undefined;
-  status: string;
-  statusConfidence?: number | null | undefined;
-  statusExternal?: string | null | undefined;
-  type?: string | null | undefined;
-  typeConfidence?: number | null | undefined;
-  typeExternal?: string | null | undefined;
-  updatedAt: string;
-  validatedDate?: string | null | undefined;
-};
-
-/** @internal */
-export const PlanningApplication$outboundSchema: z.ZodType<
-  PlanningApplication$Outbound,
-  z.ZodTypeDef,
-  PlanningApplication
-> = z.object({
-  appealedDate: z.nullable(z.string()).optional(),
-  appealedStatus: z.nullable(z.string()).optional(),
-  createdAt: z.string(),
-  description: z.nullable(z.string()).optional(),
-  developmentCategory: z.nullable(z.string()).optional(),
-  id: z.string(),
-  key: z.string(),
-  provider: z.string(),
-  receivedDate: z.nullable(z.string()).optional(),
-  sourceId: z.string(),
-  spatial: z.nullable(z.lazy(() => Spatial$outboundSchema)).optional(),
-  spatialFeatures: z.nullable(z.any()).optional(),
-  status: Status$outboundSchema,
+  status: PlanningApplicationStatus$inboundSchema,
   statusConfidence: z.nullable(z.number()).optional(),
   statusExternal: z.nullable(z.string()).optional(),
   type: z.nullable(z.string()).optional(),
@@ -237,27 +124,6 @@ export const PlanningApplication$outboundSchema: z.ZodType<
   validatedDate: z.nullable(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 PlanningApplication$ {
-  /** @deprecated use `PlanningApplication$inboundSchema` instead. */
-  export const inboundSchema = PlanningApplication$inboundSchema;
-  /** @deprecated use `PlanningApplication$outboundSchema` instead. */
-  export const outboundSchema = PlanningApplication$outboundSchema;
-  /** @deprecated use `PlanningApplication$Outbound` instead. */
-  export type Outbound = PlanningApplication$Outbound;
-}
-
-export function planningApplicationToJSON(
-  planningApplication: PlanningApplication,
-): string {
-  return JSON.stringify(
-    PlanningApplication$outboundSchema.parse(planningApplication),
-  );
-}
-
 export function planningApplicationFromJSON(
   jsonString: string,
 ): SafeParseResult<PlanningApplication, SDKValidationError> {

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

@@ -9,8 +9,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   PlanningApplication,
   PlanningApplication$inboundSchema,
-  PlanningApplication$Outbound,
-  PlanningApplication$outboundSchema,
 } from "./planningapplication.js";
 
 export type PlanningListResponse = {
@@ -34,49 +32,6 @@ export const PlanningListResponse$inboundSchema: z.ZodType<
   total: z.number(),
 });
 
-/** @internal */
-export type PlanningListResponse$Outbound = {
-  applications: Array<PlanningApplication$Outbound>;
-  limit: number;
-  offset: number;
-  success: boolean;
-  total: number;
-};
-
-/** @internal */
-export const PlanningListResponse$outboundSchema: z.ZodType<
-  PlanningListResponse$Outbound,
-  z.ZodTypeDef,
-  PlanningListResponse
-> = z.object({
-  applications: z.array(PlanningApplication$outboundSchema),
-  limit: z.number(),
-  offset: z.number(),
-  success: z.boolean(),
-  total: 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 PlanningListResponse$ {
-  /** @deprecated use `PlanningListResponse$inboundSchema` instead. */
-  export const inboundSchema = PlanningListResponse$inboundSchema;
-  /** @deprecated use `PlanningListResponse$outboundSchema` instead. */
-  export const outboundSchema = PlanningListResponse$outboundSchema;
-  /** @deprecated use `PlanningListResponse$Outbound` instead. */
-  export type Outbound = PlanningListResponse$Outbound;
-}
-
-export function planningListResponseToJSON(
-  planningListResponse: PlanningListResponse,
-): string {
-  return JSON.stringify(
-    PlanningListResponse$outboundSchema.parse(planningListResponse),
-  );
-}
-
 export function planningListResponseFromJSON(
   jsonString: string,
 ): SafeParseResult<PlanningListResponse, SDKValidationError> {

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

@@ -3,9 +3,6 @@
  */
 
 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 PlanningQueryFilters = {
   /**
@@ -54,25 +51,6 @@ export type PlanningQueryFilters = {
   validatedDateTo?: string | undefined;
 };
 
-/** @internal */
-export const PlanningQueryFilters$inboundSchema: z.ZodType<
-  PlanningQueryFilters,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  appealedDateFrom: z.string().optional(),
-  appealedDateTo: z.string().optional(),
-  councils: z.array(z.string()).optional(),
-  developmentCategories: z.array(z.string()).optional(),
-  key: z.string().optional(),
-  receivedDateFrom: z.string().optional(),
-  receivedDateTo: z.string().optional(),
-  statuses: z.array(z.string()).optional(),
-  types: z.array(z.string()).optional(),
-  validatedDateFrom: z.string().optional(),
-  validatedDateTo: z.string().optional(),
-});
-
 /** @internal */
 export type PlanningQueryFilters$Outbound = {
   appealedDateFrom?: string | undefined;
@@ -107,19 +85,6 @@ export const PlanningQueryFilters$outboundSchema: z.ZodType<
   validatedDateTo: 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 PlanningQueryFilters$ {
-  /** @deprecated use `PlanningQueryFilters$inboundSchema` instead. */
-  export const inboundSchema = PlanningQueryFilters$inboundSchema;
-  /** @deprecated use `PlanningQueryFilters$outboundSchema` instead. */
-  export const outboundSchema = PlanningQueryFilters$outboundSchema;
-  /** @deprecated use `PlanningQueryFilters$Outbound` instead. */
-  export type Outbound = PlanningQueryFilters$Outbound;
-}
-
 export function planningQueryFiltersToJSON(
   planningQueryFilters: PlanningQueryFilters,
 ): string {
@@ -127,13 +92,3 @@ export function planningQueryFiltersToJSON(
     PlanningQueryFilters$outboundSchema.parse(planningQueryFilters),
   );
 }
-
-export function planningQueryFiltersFromJSON(
-  jsonString: string,
-): SafeParseResult<PlanningQueryFilters, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => PlanningQueryFilters$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'PlanningQueryFilters' from JSON`,
-  );
-}