@vepler/sdk 0.1.0 → 1.9.9

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

@@ -4,6 +4,7 @@
 
 import * as z from "zod";
 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 {
@@ -19,14 +20,110 @@ import {
   PropertyFilters$outboundSchema,
 } from "./propertyfilters.js";
 
+/**
+ * Field to sort results by
+ */
+export const PropertyQueryRequestSortBy = {
+  Price: "price",
+  Date: "date",
+  Beds: "beds",
+  FloorArea: "floorArea",
+  YearBuilt: "yearBuilt",
+} as const;
+/**
+ * Field to sort results by
+ */
+export type PropertyQueryRequestSortBy = ClosedEnum<
+  typeof PropertyQueryRequestSortBy
+>;
+
+/**
+ * Sort order
+ */
+export const PropertyQueryRequestSortOrder = {
+  Asc: "asc",
+  Desc: "desc",
+} as const;
+/**
+ * Sort order
+ */
+export type PropertyQueryRequestSortOrder = ClosedEnum<
+  typeof PropertyQueryRequestSortOrder
+>;
+
 export type PropertyQueryRequest = {
+  /**
+   * Geographic search areas (multiple areas will be combined with OR logic)
+   */
   area: Array<AreaFilter>;
-  attributes?: string | undefined;
+  /**
+   * Specific fields to include in response
+   */
+  attributes?: Array<string> | undefined;
+  /**
+   * Number of results to return per page
+   */
   limit?: number | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
   offset?: number | undefined;
+  /**
+   * Property attribute filters
+   */
   query?: PropertyFilters | undefined;
+  /**
+   * Field to sort results by
+   */
+  sortBy?: PropertyQueryRequestSortBy | undefined;
+  /**
+   * Sort order
+   */
+  sortOrder?: PropertyQueryRequestSortOrder | undefined;
 };
 
+/** @internal */
+export const PropertyQueryRequestSortBy$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryRequestSortBy
+> = z.nativeEnum(PropertyQueryRequestSortBy);
+
+/** @internal */
+export const PropertyQueryRequestSortBy$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryRequestSortBy
+> = PropertyQueryRequestSortBy$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyQueryRequestSortBy$ {
+  /** @deprecated use `PropertyQueryRequestSortBy$inboundSchema` instead. */
+  export const inboundSchema = PropertyQueryRequestSortBy$inboundSchema;
+  /** @deprecated use `PropertyQueryRequestSortBy$outboundSchema` instead. */
+  export const outboundSchema = PropertyQueryRequestSortBy$outboundSchema;
+}
+
+/** @internal */
+export const PropertyQueryRequestSortOrder$inboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryRequestSortOrder
+> = z.nativeEnum(PropertyQueryRequestSortOrder);
+
+/** @internal */
+export const PropertyQueryRequestSortOrder$outboundSchema: z.ZodNativeEnum<
+  typeof PropertyQueryRequestSortOrder
+> = PropertyQueryRequestSortOrder$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyQueryRequestSortOrder$ {
+  /** @deprecated use `PropertyQueryRequestSortOrder$inboundSchema` instead. */
+  export const inboundSchema = PropertyQueryRequestSortOrder$inboundSchema;
+  /** @deprecated use `PropertyQueryRequestSortOrder$outboundSchema` instead. */
+  export const outboundSchema = PropertyQueryRequestSortOrder$outboundSchema;
+}
+
 /** @internal */
 export const PropertyQueryRequest$inboundSchema: z.ZodType<
   PropertyQueryRequest,
@@ -34,19 +131,23 @@ export const PropertyQueryRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   area: z.array(AreaFilter$inboundSchema),
-  attributes: z.string().optional(),
+  attributes: z.array(z.string()).optional(),
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: PropertyFilters$inboundSchema.optional(),
+  sortBy: PropertyQueryRequestSortBy$inboundSchema.optional(),
+  sortOrder: PropertyQueryRequestSortOrder$inboundSchema.default("asc"),
 });
 
 /** @internal */
 export type PropertyQueryRequest$Outbound = {
   area: Array<AreaFilter$Outbound>;
-  attributes?: string | undefined;
+  attributes?: Array<string> | undefined;
   limit: number;
   offset: number;
   query?: PropertyFilters$Outbound | undefined;
+  sortBy?: string | undefined;
+  sortOrder: string;
 };
 
 /** @internal */
@@ -56,10 +157,12 @@ export const PropertyQueryRequest$outboundSchema: z.ZodType<
   PropertyQueryRequest
 > = z.object({
   area: z.array(AreaFilter$outboundSchema),
-  attributes: z.string().optional(),
+  attributes: z.array(z.string()).optional(),
   limit: z.number().default(25),
   offset: z.number().default(0),
   query: PropertyFilters$outboundSchema.optional(),
+  sortBy: PropertyQueryRequestSortBy$outboundSchema.optional(),
+  sortOrder: PropertyQueryRequestSortOrder$outboundSchema.default("asc"),
 });
 
 /**

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

@@ -0,0 +1,107 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PropertyTags = {
+  /**
+   * Is this property being sold at auction
+   */
+  auction?: boolean | undefined;
+  /**
+   * Cash buyers only
+   */
+  cashBuyersOnly?: boolean | undefined;
+  /**
+   * Is this property chain free
+   */
+  chainFree?: boolean | undefined;
+  /**
+   * Investment opportunity
+   */
+  investment?: boolean | undefined;
+  /**
+   * Is this a new build property
+   */
+  newBuild?: boolean | undefined;
+  /**
+   * Is this a retirement property
+   */
+  retirement?: boolean | undefined;
+  /**
+   * Is this a shared ownership property
+   */
+  sharedOwnership?: boolean | undefined;
+};
+
+/** @internal */
+export const PropertyTags$inboundSchema: z.ZodType<
+  PropertyTags,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  auction: z.boolean().default(false),
+  cashBuyersOnly: z.boolean().default(false),
+  chainFree: z.boolean().default(false),
+  investment: z.boolean().default(false),
+  newBuild: z.boolean().default(false),
+  retirement: z.boolean().default(false),
+  sharedOwnership: z.boolean().default(false),
+});
+
+/** @internal */
+export type PropertyTags$Outbound = {
+  auction: boolean;
+  cashBuyersOnly: boolean;
+  chainFree: boolean;
+  investment: boolean;
+  newBuild: boolean;
+  retirement: boolean;
+  sharedOwnership: boolean;
+};
+
+/** @internal */
+export const PropertyTags$outboundSchema: z.ZodType<
+  PropertyTags$Outbound,
+  z.ZodTypeDef,
+  PropertyTags
+> = z.object({
+  auction: z.boolean().default(false),
+  cashBuyersOnly: z.boolean().default(false),
+  chainFree: z.boolean().default(false),
+  investment: z.boolean().default(false),
+  newBuild: z.boolean().default(false),
+  retirement: z.boolean().default(false),
+  sharedOwnership: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PropertyTags$ {
+  /** @deprecated use `PropertyTags$inboundSchema` instead. */
+  export const inboundSchema = PropertyTags$inboundSchema;
+  /** @deprecated use `PropertyTags$outboundSchema` instead. */
+  export const outboundSchema = PropertyTags$outboundSchema;
+  /** @deprecated use `PropertyTags$Outbound` instead. */
+  export type Outbound = PropertyTags$Outbound;
+}
+
+export function propertyTagsToJSON(propertyTags: PropertyTags): string {
+  return JSON.stringify(PropertyTags$outboundSchema.parse(propertyTags));
+}
+
+export function propertyTagsFromJSON(
+  jsonString: string,
+): SafeParseResult<PropertyTags, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PropertyTags$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PropertyTags' from JSON`,
+  );
+}

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

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type RoomDetails = {
+  /**
+   * Number of bathrooms
+   */
+  baths?: number | undefined;
+  /**
+   * Number of bedrooms
+   */
+  beds?: number | undefined;
+  /**
+   * Number of reception rooms
+   */
+  receptions?: number | undefined;
+};
+
+/** @internal */
+export const RoomDetails$inboundSchema: z.ZodType<
+  RoomDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  baths: z.number().optional(),
+  beds: z.number().optional(),
+  receptions: z.number().optional(),
+});
+
+/** @internal */
+export type RoomDetails$Outbound = {
+  baths?: number | undefined;
+  beds?: number | undefined;
+  receptions?: number | undefined;
+};
+
+/** @internal */
+export const RoomDetails$outboundSchema: z.ZodType<
+  RoomDetails$Outbound,
+  z.ZodTypeDef,
+  RoomDetails
+> = z.object({
+  baths: z.number().optional(),
+  beds: z.number().optional(),
+  receptions: z.number().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RoomDetails$ {
+  /** @deprecated use `RoomDetails$inboundSchema` instead. */
+  export const inboundSchema = RoomDetails$inboundSchema;
+  /** @deprecated use `RoomDetails$outboundSchema` instead. */
+  export const outboundSchema = RoomDetails$outboundSchema;
+  /** @deprecated use `RoomDetails$Outbound` instead. */
+  export type Outbound = RoomDetails$Outbound;
+}
+
+export function roomDetailsToJSON(roomDetails: RoomDetails): string {
+  return JSON.stringify(RoomDetails$outboundSchema.parse(roomDetails));
+}
+
+export function roomDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<RoomDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => RoomDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'RoomDetails' from JSON`,
+  );
+}

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

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SaleRecord = {
+  /**
+   * Sale completion date
+   */
+  date: string;
+  /**
+   * Was a new build at time of sale
+   */
+  newBuild?: boolean | undefined;
+  /**
+   * Sale price in pence
+   */
+  price: number;
+  /**
+   * Property type at time of sale
+   */
+  propertyType?: string | undefined;
+};
+
+/** @internal */
+export const SaleRecord$inboundSchema: z.ZodType<
+  SaleRecord,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date: z.string(),
+  newBuild: z.boolean().optional(),
+  price: z.number(),
+  propertyType: z.string().optional(),
+});
+
+/** @internal */
+export type SaleRecord$Outbound = {
+  date: string;
+  newBuild?: boolean | undefined;
+  price: number;
+  propertyType?: string | undefined;
+};
+
+/** @internal */
+export const SaleRecord$outboundSchema: z.ZodType<
+  SaleRecord$Outbound,
+  z.ZodTypeDef,
+  SaleRecord
+> = z.object({
+  date: z.string(),
+  newBuild: z.boolean().optional(),
+  price: z.number(),
+  propertyType: 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 SaleRecord$ {
+  /** @deprecated use `SaleRecord$inboundSchema` instead. */
+  export const inboundSchema = SaleRecord$inboundSchema;
+  /** @deprecated use `SaleRecord$outboundSchema` instead. */
+  export const outboundSchema = SaleRecord$outboundSchema;
+  /** @deprecated use `SaleRecord$Outbound` instead. */
+  export type Outbound = SaleRecord$Outbound;
+}
+
+export function saleRecordToJSON(saleRecord: SaleRecord): string {
+  return JSON.stringify(SaleRecord$outboundSchema.parse(saleRecord));
+}
+
+export function saleRecordFromJSON(
+  jsonString: string,
+): SafeParseResult<SaleRecord, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SaleRecord$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SaleRecord' from JSON`,
+  );
+}

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

@@ -3,7 +3,6 @@
  */
 
 import * as z from "zod";
-import { remap as remap$ } from "../../../lib/primitives.js";
 import { safeParse } from "../../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -18,16 +17,12 @@ export const Security$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  ApiKeyAuth: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    "ApiKeyAuth": "apiKeyAuth",
-  });
+  apiKeyAuth: z.string(),
 });
 
 /** @internal */
 export type Security$Outbound = {
-  ApiKeyAuth: string;
+  apiKeyAuth: string;
 };
 
 /** @internal */
@@ -37,10 +32,6 @@ export const Security$outboundSchema: z.ZodType<
   Security
 > = z.object({
   apiKeyAuth: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    apiKeyAuth: "ApiKeyAuth",
-  });
 });
 
 /**

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

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type StreetDescriptor = {
+  /**
+   * Administrative area
+   */
+  administrativeArea?: string | undefined;
+  /**
+   * Language code
+   */
+  language?: string | undefined;
+  /**
+   * Local area name
+   */
+  locality?: string | undefined;
+  /**
+   * Full street name
+   */
+  streetDescription: string;
+  /**
+   * Town or city name
+   */
+  townName?: string | undefined;
+};
+
+/** @internal */
+export const StreetDescriptor$inboundSchema: z.ZodType<
+  StreetDescriptor,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  administrativeArea: z.string().optional(),
+  language: z.string().default("ENG"),
+  locality: z.string().optional(),
+  streetDescription: z.string(),
+  townName: z.string().optional(),
+});
+
+/** @internal */
+export type StreetDescriptor$Outbound = {
+  administrativeArea?: string | undefined;
+  language: string;
+  locality?: string | undefined;
+  streetDescription: string;
+  townName?: string | undefined;
+};
+
+/** @internal */
+export const StreetDescriptor$outboundSchema: z.ZodType<
+  StreetDescriptor$Outbound,
+  z.ZodTypeDef,
+  StreetDescriptor
+> = z.object({
+  administrativeArea: z.string().optional(),
+  language: z.string().default("ENG"),
+  locality: z.string().optional(),
+  streetDescription: z.string(),
+  townName: 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 StreetDescriptor$ {
+  /** @deprecated use `StreetDescriptor$inboundSchema` instead. */
+  export const inboundSchema = StreetDescriptor$inboundSchema;
+  /** @deprecated use `StreetDescriptor$outboundSchema` instead. */
+  export const outboundSchema = StreetDescriptor$outboundSchema;
+  /** @deprecated use `StreetDescriptor$Outbound` instead. */
+  export type Outbound = StreetDescriptor$Outbound;
+}
+
+export function streetDescriptorToJSON(
+  streetDescriptor: StreetDescriptor,
+): string {
+  return JSON.stringify(
+    StreetDescriptor$outboundSchema.parse(streetDescriptor),
+  );
+}
+
+export function streetDescriptorFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetDescriptor, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetDescriptor$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetDescriptor' from JSON`,
+  );
+}

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

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  StreetDescriptor,
+  StreetDescriptor$inboundSchema,
+  StreetDescriptor$Outbound,
+  StreetDescriptor$outboundSchema,
+} from "./streetdescriptor.js";
+
+export type StreetDetails = {
+  /**
+   * Street name descriptors in different languages
+   */
+  descriptors: Array<StreetDescriptor>;
+  /**
+   * Street end latitude (WGS84)
+   */
+  streetEndLat?: number | undefined;
+  /**
+   * Street end longitude (WGS84)
+   */
+  streetEndLng?: number | undefined;
+  /**
+   * Street start latitude (WGS84)
+   */
+  streetStartLat?: number | undefined;
+  /**
+   * Street start longitude (WGS84)
+   */
+  streetStartLng?: number | undefined;
+  /**
+   * Unique Street Reference Number
+   */
+  usrn: number;
+};
+
+/** @internal */
+export const StreetDetails$inboundSchema: z.ZodType<
+  StreetDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  descriptors: z.array(StreetDescriptor$inboundSchema),
+  streetEndLat: z.number().optional(),
+  streetEndLng: z.number().optional(),
+  streetStartLat: z.number().optional(),
+  streetStartLng: z.number().optional(),
+  usrn: z.number(),
+});
+
+/** @internal */
+export type StreetDetails$Outbound = {
+  descriptors: Array<StreetDescriptor$Outbound>;
+  streetEndLat?: number | undefined;
+  streetEndLng?: number | undefined;
+  streetStartLat?: number | undefined;
+  streetStartLng?: number | undefined;
+  usrn: number;
+};
+
+/** @internal */
+export const StreetDetails$outboundSchema: z.ZodType<
+  StreetDetails$Outbound,
+  z.ZodTypeDef,
+  StreetDetails
+> = z.object({
+  descriptors: z.array(StreetDescriptor$outboundSchema),
+  streetEndLat: z.number().optional(),
+  streetEndLng: z.number().optional(),
+  streetStartLat: z.number().optional(),
+  streetStartLng: z.number().optional(),
+  usrn: 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 StreetDetails$ {
+  /** @deprecated use `StreetDetails$inboundSchema` instead. */
+  export const inboundSchema = StreetDetails$inboundSchema;
+  /** @deprecated use `StreetDetails$outboundSchema` instead. */
+  export const outboundSchema = StreetDetails$outboundSchema;
+  /** @deprecated use `StreetDetails$Outbound` instead. */
+  export type Outbound = StreetDetails$Outbound;
+}
+
+export function streetDetailsToJSON(streetDetails: StreetDetails): string {
+  return JSON.stringify(StreetDetails$outboundSchema.parse(streetDetails));
+}
+
+export function streetDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<StreetDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StreetDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StreetDetails' from JSON`,
+  );
+}