@vepler/sdk 1.10.1 → 2.0.0

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

@@ -2,8 +2,9 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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 {
@@ -24,6 +25,93 @@ import {
  */
 export type Attributes = string | Array<string>;
 
+/**
+ * Field to sort by (whitelisted fields only)
+ */
+export const Field = {
+  MarketStatusLastOTM: "marketStatus.lastOTM",
+  MarketStatusLastOTMRent: "marketStatus.lastOTMRent",
+  MarketStatusBackOTM: "marketStatus.backOTM",
+  MarketStatusBackOTMRent: "marketStatus.backOTMRent",
+  MarketStatusSstcDate: "marketStatus.sstcDate",
+  MarketStatusUnderOfferDate: "marketStatus.underOfferDate",
+  MarketStatusReservedDate: "marketStatus.reservedDate",
+  PricingCurrentSale: "pricing.currentSale",
+  PricingCurrentRent: "pricing.currentRent",
+  PricingPredictedPrice: "pricing.predictedPrice",
+  PricingPricePerSqft: "pricing.pricePerSqft",
+  RoomDetailsBeds: "roomDetails.beds",
+  RoomDetailsBaths: "roomDetails.baths",
+  RoomDetailsReceptions: "roomDetails.receptions",
+  BuildTotalFloorArea: "build.totalFloorArea",
+  BuildPlotSize: "build.plotSize",
+  BuildYearBuilt: "build.yearBuilt",
+  Score: "_score",
+  Doc: "_doc",
+} as const;
+/**
+ * Field to sort by (whitelisted fields only)
+ */
+export type Field = ClosedEnum<typeof Field>;
+
+/**
+ * How to handle missing values
+ */
+export const Missing = {
+  First: "_first",
+  Last: "_last",
+} as const;
+/**
+ * How to handle missing values
+ */
+export type Missing = ClosedEnum<typeof Missing>;
+
+/**
+ * Mode for multi-valued fields
+ */
+export const Mode = {
+  Min: "min",
+  Max: "max",
+  Sum: "sum",
+  Avg: "avg",
+  Median: "median",
+} as const;
+/**
+ * Mode for multi-valued fields
+ */
+export type Mode = ClosedEnum<typeof Mode>;
+
+/**
+ * Sort order
+ */
+export const Order = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort order
+ */
+export type Order = ClosedEnum<typeof Order>;
+
+export type Sort = {
+  /**
+   * Field to sort by (whitelisted fields only)
+   */
+  field: Field;
+  /**
+   * How to handle missing values
+   */
+  missing?: Missing | undefined;
+  /**
+   * Mode for multi-valued fields
+   */
+  mode?: Mode | undefined;
+  /**
+   * Sort order
+   */
+  order: Order;
+};
+
 export type PropertyQueryRequest = {
   /**
    * Geographic search areas (multiple areas will be combined with OR logic)
@@ -45,6 +133,10 @@ export type PropertyQueryRequest = {
    * Array of query operators for filtering
    */
   query: Array<PropertyQueryOperator>;
+  /**
+   * Sort configuration (max 3 fields)
+   */
+  sort?: Array<Sort> | undefined;
   /**
    * Enable tracking for billing purposes
    */
@@ -95,6 +187,138 @@ export function attributesFromJSON(
   );
 }
 
+/** @internal */
+export const Field$inboundSchema: z.ZodNativeEnum<typeof Field> = z.nativeEnum(
+  Field,
+);
+
+/** @internal */
+export const Field$outboundSchema: z.ZodNativeEnum<typeof Field> =
+  Field$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Field$ {
+  /** @deprecated use `Field$inboundSchema` instead. */
+  export const inboundSchema = Field$inboundSchema;
+  /** @deprecated use `Field$outboundSchema` instead. */
+  export const outboundSchema = Field$outboundSchema;
+}
+
+/** @internal */
+export const Missing$inboundSchema: z.ZodNativeEnum<typeof Missing> = z
+  .nativeEnum(Missing);
+
+/** @internal */
+export const Missing$outboundSchema: z.ZodNativeEnum<typeof Missing> =
+  Missing$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Missing$ {
+  /** @deprecated use `Missing$inboundSchema` instead. */
+  export const inboundSchema = Missing$inboundSchema;
+  /** @deprecated use `Missing$outboundSchema` instead. */
+  export const outboundSchema = Missing$outboundSchema;
+}
+
+/** @internal */
+export const Mode$inboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
+  Mode,
+);
+
+/** @internal */
+export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> =
+  Mode$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Mode$ {
+  /** @deprecated use `Mode$inboundSchema` instead. */
+  export const inboundSchema = Mode$inboundSchema;
+  /** @deprecated use `Mode$outboundSchema` instead. */
+  export const outboundSchema = Mode$outboundSchema;
+}
+
+/** @internal */
+export const Order$inboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
+  Order,
+);
+
+/** @internal */
+export const Order$outboundSchema: z.ZodNativeEnum<typeof Order> =
+  Order$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Order$ {
+  /** @deprecated use `Order$inboundSchema` instead. */
+  export const inboundSchema = Order$inboundSchema;
+  /** @deprecated use `Order$outboundSchema` instead. */
+  export const outboundSchema = Order$outboundSchema;
+}
+
+/** @internal */
+export const Sort$inboundSchema: z.ZodType<Sort, z.ZodTypeDef, unknown> = z
+  .object({
+    field: Field$inboundSchema,
+    missing: Missing$inboundSchema.optional(),
+    mode: Mode$inboundSchema.optional(),
+    order: Order$inboundSchema,
+  });
+
+/** @internal */
+export type Sort$Outbound = {
+  field: string;
+  missing?: string | undefined;
+  mode?: string | undefined;
+  order: string;
+};
+
+/** @internal */
+export const Sort$outboundSchema: z.ZodType<Sort$Outbound, z.ZodTypeDef, Sort> =
+  z.object({
+    field: Field$outboundSchema,
+    missing: Missing$outboundSchema.optional(),
+    mode: Mode$outboundSchema.optional(),
+    order: Order$outboundSchema,
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Sort$ {
+  /** @deprecated use `Sort$inboundSchema` instead. */
+  export const inboundSchema = Sort$inboundSchema;
+  /** @deprecated use `Sort$outboundSchema` instead. */
+  export const outboundSchema = Sort$outboundSchema;
+  /** @deprecated use `Sort$Outbound` instead. */
+  export type Outbound = Sort$Outbound;
+}
+
+export function sortToJSON(sort: Sort): string {
+  return JSON.stringify(Sort$outboundSchema.parse(sort));
+}
+
+export function sortFromJSON(
+  jsonString: string,
+): SafeParseResult<Sort, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Sort$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Sort' from JSON`,
+  );
+}
+
 /** @internal */
 export const PropertyQueryRequest$inboundSchema: z.ZodType<
   PropertyQueryRequest,
@@ -106,6 +330,7 @@ export const PropertyQueryRequest$inboundSchema: z.ZodType<
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(PropertyQueryOperator$inboundSchema),
+  sort: z.array(z.lazy(() => Sort$inboundSchema)).optional(),
   track: z.boolean().default(false),
 });
 
@@ -116,6 +341,7 @@ export type PropertyQueryRequest$Outbound = {
   limit: number;
   offset: number;
   query: Array<PropertyQueryOperator$Outbound>;
+  sort?: Array<Sort$Outbound> | undefined;
   track: boolean;
 };
 
@@ -130,6 +356,7 @@ export const PropertyQueryRequest$outboundSchema: z.ZodType<
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: z.array(PropertyQueryOperator$outboundSchema),
+  sort: z.array(z.lazy(() => Sort$outboundSchema)).optional(),
   track: z.boolean().default(false),
 });
 

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

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

@@ -2,7 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import * as z from "zod";
+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";

package/src/sdk/poi.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { poiGetNearestPOI } from "../funcs/poiGetNearestPOI.js";
+import { poiGetPOIMultipleTiles } from "../funcs/poiGetPOIMultipleTiles.js";
+import { GetPOITileAcceptEnum, poiGetPOITile } from "../funcs/poiGetPOITile.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as operations from "./models/operations/index.js";
+import { unwrapAsync } from "./types/fp.js";
+
+export { GetPOITileAcceptEnum } from "../funcs/poiGetPOITile.js";
+
+export class Poi extends ClientSDK {
+  /**
+   * Find nearest points of interest
+   *
+   * @remarks
+   * Find the nearest points of interest to a given location. Filter by POI category and optionally include routing distances.
+   */
+  async getNearestPOI(
+    request: operations.GetNearestPOIRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetNearestPOIResponse> {
+    return unwrapAsync(poiGetNearestPOI(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get POIs from multiple tiles
+   *
+   * @remarks
+   * Retrieve points of interest from multiple map tiles in a single request. Tiles specified as comma-separated z/x/y values.
+   */
+  async getPOIMultipleTiles(
+    request: operations.GetPOIMultipleTilesRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetPOIMultipleTilesResponse> {
+    return unwrapAsync(poiGetPOIMultipleTiles(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get POIs in a map tile
+   *
+   * @remarks
+   * Retrieve points of interest within a map tile specified by z/x/y coordinates. Supports GeoJSON and MVT formats.
+   */
+  async getPOITile(
+    request: operations.GetPOITileRequest,
+    options?: RequestOptions & { acceptHeaderOverride?: GetPOITileAcceptEnum },
+  ): Promise<operations.GetPOITileResponse> {
+    return unwrapAsync(poiGetPOITile(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/src/sdk/schools.ts

@@ -5,7 +5,9 @@
 import { schoolsGet } from "../funcs/schoolsGet.js";
 import { schoolsGetBySlug } from "../funcs/schoolsGetBySlug.js";
 import { schoolsGetByUrn } from "../funcs/schoolsGetByUrn.js";
+import { schoolsGetMetrics } from "../funcs/schoolsGetMetrics.js";
 import { schoolsList } from "../funcs/schoolsList.js";
+import { schoolsListProfiles } from "../funcs/schoolsListProfiles.js";
 import { schoolsSearchNearby } from "../funcs/schoolsSearchNearby.js";
 import { schoolsSearchWithin } from "../funcs/schoolsSearchWithin.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -64,6 +66,23 @@ export class Schools extends ClientSDK {
     ));
   }
 
+  /**
+   * Get school metrics
+   *
+   * @remarks
+   * Retrieve metrics for specified schools using metric codes or predefined profiles. Supports both point-in-time and time series queries.
+   */
+  async getMetrics(
+    request: operations.GetSchoolMetricsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.GetSchoolMetricsResponse> {
+    return unwrapAsync(schoolsGetMetrics(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * List schools
    *
@@ -81,6 +100,21 @@ export class Schools extends ClientSDK {
     ));
   }
 
+  /**
+   * List metric profiles
+   *
+   * @remarks
+   * Get a list of all available metric profiles with their descriptions and metric counts
+   */
+  async listProfiles(
+    options?: RequestOptions,
+  ): Promise<operations.GetMetricProfilesResponseBody> {
+    return unwrapAsync(schoolsListProfiles(
+      this,
+      options,
+    ));
+  }
+
   /**
    * Search schools near location
    *

package/src/sdk/sdk.ts

@@ -3,23 +3,64 @@
  */
 
 import { ClientSDK } from "../lib/sdks.js";
-import { Health } from "./health.js";
-import { Location } from "./location.js";
+import { Address } from "./address.js";
+import { Areas } from "./areas.js";
+import { Connectivity } from "./connectivity.js";
+import { Epc } from "./epc.js";
+import { Listings } from "./listings.js";
+import { Metrics } from "./metrics.js";
 import { Planning } from "./planning.js";
+import { Poi } from "./poi.js";
 import { Property } from "./property.js";
 import { Safety } from "./safety.js";
-import { SchoolMetrics } from "./schoolmetrics.js";
 import { Schools } from "./schools.js";
+import { Streets } from "./streets.js";
+import { System } from "./system.js";
 
 export class SDK extends ClientSDK {
-  private _health?: Health;
-  get health(): Health {
-    return (this._health ??= new Health(this._options));
+  private _address?: Address;
+  get address(): Address {
+    return (this._address ??= new Address(this._options));
   }
 
-  private _location?: Location;
-  get location(): Location {
-    return (this._location ??= new Location(this._options));
+  private _areas?: Areas;
+  get areas(): Areas {
+    return (this._areas ??= new Areas(this._options));
+  }
+
+  private _connectivity?: Connectivity;
+  get connectivity(): Connectivity {
+    return (this._connectivity ??= new Connectivity(this._options));
+  }
+
+  private _system?: System;
+  get system(): System {
+    return (this._system ??= new System(this._options));
+  }
+
+  private _metrics?: Metrics;
+  get metrics(): Metrics {
+    return (this._metrics ??= new Metrics(this._options));
+  }
+
+  private _poi?: Poi;
+  get poi(): Poi {
+    return (this._poi ??= new Poi(this._options));
+  }
+
+  private _epc?: Epc;
+  get epc(): Epc {
+    return (this._epc ??= new Epc(this._options));
+  }
+
+  private _listings?: Listings;
+  get listings(): Listings {
+    return (this._listings ??= new Listings(this._options));
+  }
+
+  private _streets?: Streets;
+  get streets(): Streets {
+    return (this._streets ??= new Streets(this._options));
   }
 
   private _planning?: Planning;
@@ -41,9 +82,4 @@ export class SDK extends ClientSDK {
   get schools(): Schools {
     return (this._schools ??= new Schools(this._options));
   }
-
-  private _schoolMetrics?: SchoolMetrics;
-  get schoolMetrics(): SchoolMetrics {
-    return (this._schoolMetrics ??= new SchoolMetrics(this._options));
-  }
 }

package/src/sdk/{location.ts → streets.ts}

@@ -2,13 +2,13 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { locationSearchStreets } from "../funcs/locationSearchStreets.js";
+import { streetsSearchStreets } from "../funcs/streetsSearchStreets.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "./models/operations/index.js";
 import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
-export class Location extends ClientSDK {
+export class Streets extends ClientSDK {
   /**
    * Query streets with flexible identifiers
    *
@@ -19,7 +19,7 @@ export class Location extends ClientSDK {
     request?: shared.StreetQueryRequest | undefined,
     options?: RequestOptions,
   ): Promise<operations.SearchStreetsResponse> {
-    return unwrapAsync(locationSearchStreets(
+    return unwrapAsync(streetsSearchStreets(
       this,
       request,
       options,