@vepler/sdk 2.24.1 → 2.28.0

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

@@ -2,6 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./aggregationinput.js";
+export * from "./analysiscomparable.js";
+export * from "./avmanalysisrequest.js";
+export * from "./avmanalysisresponse.js";
 export * from "./avmconfidenceinterval.js";
 export * from "./avmmetadata.js";
 export * from "./avmpredictbylocationrequest.js";
@@ -22,11 +26,14 @@ export * from "./counciltaxbanddetails.js";
 export * from "./counciltaxdata.js";
 export * from "./epcdata.js";
 export * from "./healthresponse.js";
+export * from "./historicalvaluation.js";
+export * from "./leafaggregation.js";
 export * from "./lease.js";
 export * from "./listing.js";
 export * from "./listingimage.js";
 export * from "./listingpricechange.js";
 export * from "./marketstatus.js";
+export * from "./nestedaggregation.js";
 export * from "./planningapplication.js";
 export * from "./planninglistresponse.js";
 export * from "./planningqueryfilters.js";
@@ -34,6 +41,8 @@ export * from "./planningqueryrequest.js";
 export * from "./pricechange.js";
 export * from "./pricingdata.js";
 export * from "./propertyaddress.js";
+export * from "./propertyaggregaterequest.js";
+export * from "./propertyaggregateresponse.js";
 export * from "./propertyareafilter.js";
 export * from "./propertybyslugsrequest.js";
 export * from "./propertydataapi.js";
@@ -50,6 +59,7 @@ export * from "./propertyquerygroup.js";
 export * from "./propertyqueryoperator.js";
 export * from "./propertyqueryrequest.js";
 export * from "./propertytags.js";
+export * from "./rangedefinition.js";
 export * from "./refurbishmentdata.js";
 export * from "./roomdetails.js";
 export * from "./salerecord.js";

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

@@ -0,0 +1,149 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  RangeDefinition,
+  RangeDefinition$Outbound,
+  RangeDefinition$outboundSchema,
+} from "./rangedefinition.js";
+
+export const LeafAggregationOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type LeafAggregationOrder = ClosedEnum<typeof LeafAggregationOrder>;
+
+/**
+ * Type of aggregation
+ */
+export const LeafAggregationType = {
+  Terms: "terms",
+  Range: "range",
+  Histogram: "histogram",
+  DateHistogram: "date_histogram",
+  Stats: "stats",
+  ExtendedStats: "extended_stats",
+  Min: "min",
+  Max: "max",
+  Avg: "avg",
+  Sum: "sum",
+  Count: "count",
+  Cardinality: "cardinality",
+  Percentiles: "percentiles",
+} as const;
+/**
+ * Type of aggregation
+ */
+export type LeafAggregationType = ClosedEnum<typeof LeafAggregationType>;
+
+export type LeafAggregation = {
+  /**
+   * Calendar interval for date_histogram (1d, 1w, 1M, etc.)
+   */
+  calendarInterval?: string | undefined;
+  /**
+   * Field to aggregate on (must be in allowed field list)
+   */
+  field: string;
+  /**
+   * Fixed interval for date_histogram (1h, 90m, etc.)
+   */
+  fixedInterval?: string | undefined;
+  /**
+   * Date format for date_histogram
+   */
+  format?: string | undefined;
+  /**
+   * Interval for histogram aggregation
+   */
+  interval?: number | undefined;
+  /**
+   * Minimum document count for bucket to be returned
+   */
+  minDocCount?: number | undefined;
+  /**
+   * Unique name for this aggregation
+   */
+  name: string;
+  /**
+   * Sort order for terms buckets
+   */
+  order?: { [k: string]: LeafAggregationOrder } | undefined;
+  /**
+   * Percentiles to calculate
+   */
+  percents?: Array<number> | undefined;
+  /**
+   * Custom ranges for range aggregation
+   */
+  ranges?: Array<RangeDefinition> | undefined;
+  /**
+   * Max buckets for terms aggregation
+   */
+  size?: number | undefined;
+  /**
+   * Timezone for date_histogram
+   */
+  timeZone?: string | undefined;
+  /**
+   * Type of aggregation
+   */
+  type: LeafAggregationType;
+};
+
+/** @internal */
+export const LeafAggregationOrder$outboundSchema: z.ZodNativeEnum<
+  typeof LeafAggregationOrder
+> = z.nativeEnum(LeafAggregationOrder);
+
+/** @internal */
+export const LeafAggregationType$outboundSchema: z.ZodNativeEnum<
+  typeof LeafAggregationType
+> = z.nativeEnum(LeafAggregationType);
+
+/** @internal */
+export type LeafAggregation$Outbound = {
+  calendarInterval?: string | undefined;
+  field: string;
+  fixedInterval?: string | undefined;
+  format?: string | undefined;
+  interval?: number | undefined;
+  minDocCount?: number | undefined;
+  name: string;
+  order?: { [k: string]: string } | undefined;
+  percents?: Array<number> | undefined;
+  ranges?: Array<RangeDefinition$Outbound> | undefined;
+  size?: number | undefined;
+  timeZone?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const LeafAggregation$outboundSchema: z.ZodType<
+  LeafAggregation$Outbound,
+  z.ZodTypeDef,
+  LeafAggregation
+> = z.object({
+  calendarInterval: z.string().optional(),
+  field: z.string(),
+  fixedInterval: z.string().optional(),
+  format: z.string().optional(),
+  interval: z.number().optional(),
+  minDocCount: z.number().int().optional(),
+  name: z.string(),
+  order: z.record(LeafAggregationOrder$outboundSchema).optional(),
+  percents: z.array(z.number()).optional(),
+  ranges: z.array(RangeDefinition$outboundSchema).optional(),
+  size: z.number().int().optional(),
+  timeZone: z.string().optional(),
+  type: LeafAggregationType$outboundSchema,
+});
+
+export function leafAggregationToJSON(
+  leafAggregation: LeafAggregation,
+): string {
+  return JSON.stringify(LeafAggregation$outboundSchema.parse(leafAggregation));
+}

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

@@ -0,0 +1,162 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  LeafAggregation,
+  LeafAggregation$Outbound,
+  LeafAggregation$outboundSchema,
+} from "./leafaggregation.js";
+import {
+  RangeDefinition,
+  RangeDefinition$Outbound,
+  RangeDefinition$outboundSchema,
+} from "./rangedefinition.js";
+
+export const NestedAggregationOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+export type NestedAggregationOrder = ClosedEnum<typeof NestedAggregationOrder>;
+
+/**
+ * Type of aggregation
+ */
+export const NestedAggregationType = {
+  Terms: "terms",
+  Range: "range",
+  Histogram: "histogram",
+  DateHistogram: "date_histogram",
+  Stats: "stats",
+  ExtendedStats: "extended_stats",
+  Min: "min",
+  Max: "max",
+  Avg: "avg",
+  Sum: "sum",
+  Count: "count",
+  Cardinality: "cardinality",
+  Percentiles: "percentiles",
+} as const;
+/**
+ * Type of aggregation
+ */
+export type NestedAggregationType = ClosedEnum<typeof NestedAggregationType>;
+
+export type NestedAggregation = {
+  /**
+   * Leaf sub-aggregations (max 10, no further nesting)
+   */
+  aggs?: Array<LeafAggregation> | undefined;
+  /**
+   * Calendar interval for date_histogram (1d, 1w, 1M, etc.)
+   */
+  calendarInterval?: string | undefined;
+  /**
+   * Field to aggregate on (must be in allowed field list)
+   */
+  field: string;
+  /**
+   * Fixed interval for date_histogram (1h, 90m, etc.)
+   */
+  fixedInterval?: string | undefined;
+  /**
+   * Date format for date_histogram
+   */
+  format?: string | undefined;
+  /**
+   * Interval for histogram aggregation
+   */
+  interval?: number | undefined;
+  /**
+   * Minimum document count for bucket to be returned
+   */
+  minDocCount?: number | undefined;
+  /**
+   * Unique name for this aggregation
+   */
+  name: string;
+  /**
+   * Sort order for terms buckets
+   */
+  order?: { [k: string]: NestedAggregationOrder } | undefined;
+  /**
+   * Percentiles to calculate
+   */
+  percents?: Array<number> | undefined;
+  /**
+   * Custom ranges for range aggregation
+   */
+  ranges?: Array<RangeDefinition> | undefined;
+  /**
+   * Max buckets for terms aggregation
+   */
+  size?: number | undefined;
+  /**
+   * Timezone for date_histogram
+   */
+  timeZone?: string | undefined;
+  /**
+   * Type of aggregation
+   */
+  type: NestedAggregationType;
+};
+
+/** @internal */
+export const NestedAggregationOrder$outboundSchema: z.ZodNativeEnum<
+  typeof NestedAggregationOrder
+> = z.nativeEnum(NestedAggregationOrder);
+
+/** @internal */
+export const NestedAggregationType$outboundSchema: z.ZodNativeEnum<
+  typeof NestedAggregationType
+> = z.nativeEnum(NestedAggregationType);
+
+/** @internal */
+export type NestedAggregation$Outbound = {
+  aggs?: Array<LeafAggregation$Outbound> | undefined;
+  calendarInterval?: string | undefined;
+  field: string;
+  fixedInterval?: string | undefined;
+  format?: string | undefined;
+  interval?: number | undefined;
+  minDocCount?: number | undefined;
+  name: string;
+  order?: { [k: string]: string } | undefined;
+  percents?: Array<number> | undefined;
+  ranges?: Array<RangeDefinition$Outbound> | undefined;
+  size?: number | undefined;
+  timeZone?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const NestedAggregation$outboundSchema: z.ZodType<
+  NestedAggregation$Outbound,
+  z.ZodTypeDef,
+  NestedAggregation
+> = z.object({
+  aggs: z.array(LeafAggregation$outboundSchema).optional(),
+  calendarInterval: z.string().optional(),
+  field: z.string(),
+  fixedInterval: z.string().optional(),
+  format: z.string().optional(),
+  interval: z.number().optional(),
+  minDocCount: z.number().int().optional(),
+  name: z.string(),
+  order: z.record(NestedAggregationOrder$outboundSchema).optional(),
+  percents: z.array(z.number()).optional(),
+  ranges: z.array(RangeDefinition$outboundSchema).optional(),
+  size: z.number().int().optional(),
+  timeZone: z.string().optional(),
+  type: NestedAggregationType$outboundSchema,
+});
+
+export function nestedAggregationToJSON(
+  nestedAggregation: NestedAggregation,
+): string {
+  return JSON.stringify(
+    NestedAggregation$outboundSchema.parse(nestedAggregation),
+  );
+}

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

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AggregationInput,
+  AggregationInput$Outbound,
+  AggregationInput$outboundSchema,
+} from "./aggregationinput.js";
+import {
+  PropertyAreaFilter,
+  PropertyAreaFilter$Outbound,
+  PropertyAreaFilter$outboundSchema,
+} from "./propertyareafilter.js";
+import {
+  PropertyQueryOperator,
+  PropertyQueryOperator$Outbound,
+  PropertyQueryOperator$outboundSchema,
+} from "./propertyqueryoperator.js";
+
+export type PropertyAggregateRequest = {
+  /**
+   * Aggregation definitions (max 10)
+   */
+  aggregations: Array<AggregationInput>;
+  /**
+   * Geographic search areas (required, max 500 km² total for real-time aggregation)
+   */
+  area: Array<PropertyAreaFilter>;
+  /**
+   * Optional property filters (same structure as /property/query)
+   */
+  query?: Array<PropertyQueryOperator> | undefined;
+};
+
+/** @internal */
+export type PropertyAggregateRequest$Outbound = {
+  aggregations: Array<AggregationInput$Outbound>;
+  area: Array<PropertyAreaFilter$Outbound>;
+  query?: Array<PropertyQueryOperator$Outbound> | undefined;
+};
+
+/** @internal */
+export const PropertyAggregateRequest$outboundSchema: z.ZodType<
+  PropertyAggregateRequest$Outbound,
+  z.ZodTypeDef,
+  PropertyAggregateRequest
+> = z.object({
+  aggregations: z.array(AggregationInput$outboundSchema),
+  area: z.array(PropertyAreaFilter$outboundSchema),
+  query: z.array(PropertyQueryOperator$outboundSchema).optional(),
+});
+
+export function propertyAggregateRequestToJSON(
+  propertyAggregateRequest: PropertyAggregateRequest,
+): string {
+  return JSON.stringify(
+    PropertyAggregateRequest$outboundSchema.parse(propertyAggregateRequest),
+  );
+}

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

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 PropertyAggregateResponse = {
+  /**
+   * Aggregation results (structure varies by aggregation type)
+   */
+  aggregations: { [k: string]: any | null };
+  /**
+   * Calculated area size in km²
+   */
+  areaKm2: number;
+  success: boolean;
+  /**
+   * Total documents matching the query
+   */
+  total: number;
+};
+
+/** @internal */
+export const PropertyAggregateResponse$inboundSchema: z.ZodType<
+  PropertyAggregateResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  aggregations: z.record(z.nullable(z.any())),
+  areaKm2: z.number(),
+  success: z.boolean(),
+  total: z.number(),
+});
+
+export function propertyAggregateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyAggregateResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyAggregateResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyAggregateResponse' from JSON`,
+  );
+}

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

@@ -79,14 +79,16 @@ export type Mode = ClosedEnum<typeof Mode>;
 /**
  * Sort order
  */
-export const Order = {
+export const PropertyQueryRequestOrder = {
   Asc: "asc",
   Desc: "desc",
 } as const;
 /**
  * Sort order
  */
-export type Order = ClosedEnum<typeof Order>;
+export type PropertyQueryRequestOrder = ClosedEnum<
+  typeof PropertyQueryRequestOrder
+>;
 
 export type Sort = {
   /**
@@ -104,7 +106,7 @@ export type Sort = {
   /**
    * Sort order
    */
-  order: Order;
+  order: PropertyQueryRequestOrder;
 };
 
 export type PropertyQueryRequest = {
@@ -167,9 +169,9 @@ export const Mode$outboundSchema: z.ZodNativeEnum<typeof Mode> = z.nativeEnum(
 );
 
 /** @internal */
-export const Order$outboundSchema: z.ZodNativeEnum<typeof Order> = z.nativeEnum(
-  Order,
-);
+export const PropertyQueryRequestOrder$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryRequestOrder
+> = z.nativeEnum(PropertyQueryRequestOrder);
 
 /** @internal */
 export type Sort$Outbound = {
@@ -185,7 +187,7 @@ export const Sort$outboundSchema: z.ZodType<Sort$Outbound, z.ZodTypeDef, Sort> =
     field: Field$outboundSchema,
     missing: Missing$outboundSchema.optional(),
     mode: Mode$outboundSchema.optional(),
-    order: Order$outboundSchema,
+    order: PropertyQueryRequestOrder$outboundSchema,
   });
 
 export function sortToJSON(sort: Sort): string {

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

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type RangeDefinition = {
+  /**
+   * Range start (inclusive)
+   */
+  from?: number | undefined;
+  /**
+   * Optional label for this range
+   */
+  key?: string | undefined;
+  /**
+   * Range end (exclusive)
+   */
+  to?: number | undefined;
+};
+
+/** @internal */
+export type RangeDefinition$Outbound = {
+  from?: number | undefined;
+  key?: string | undefined;
+  to?: number | undefined;
+};
+
+/** @internal */
+export const RangeDefinition$outboundSchema: z.ZodType<
+  RangeDefinition$Outbound,
+  z.ZodTypeDef,
+  RangeDefinition
+> = z.object({
+  from: z.number().optional(),
+  key: z.string().optional(),
+  to: z.number().optional(),
+});
+
+export function rangeDefinitionToJSON(
+  rangeDefinition: RangeDefinition,
+): string {
+  return JSON.stringify(RangeDefinition$outboundSchema.parse(rangeDefinition));
+}

package/src/sdk/property.ts

@@ -2,6 +2,7 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { propertyAggregateProperties } from "../funcs/propertyAggregateProperties.js";
 import { propertyGetProperties } from "../funcs/propertyGetProperties.js";
 import { propertyGetPropertiesByLocation } from "../funcs/propertyGetPropertiesByLocation.js";
 import { propertyGetPropertiesBySlugs } from "../funcs/propertyGetPropertiesBySlugs.js";
@@ -13,6 +14,23 @@ import * as shared from "./models/shared/index.js";
 import { unwrapAsync } from "./types/fp.js";
 
 export class Property extends ClientSDK {
+  /**
+   * Aggregate property statistics within a geographic area
+   *
+   * @remarks
+   * Execute real-time aggregations (counts, averages, distributions) over property data within a specified geographic boundary. Limited to areas ≤500 km² for reliable performance. Returns computed statistics without individual property documents.
+   */
+  async aggregateProperties(
+    request?: shared.PropertyAggregateRequest | undefined,
+    options?: RequestOptions,
+  ): Promise<operations.AggregatePropertiesResponse> {
+    return unwrapAsync(propertyAggregateProperties(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get properties by property IDs
    *