@vepler/sdk 2.50.3 → 2.86.0

package/src/sdk/models/errors/queryepc.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKBaseError } from "./sdkbaseerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+/**
+ * Error type category
+ */
+export const QueryEpcType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryEpcType = OpenEnum<typeof QueryEpcType>;
+
+export type QueryEpcError = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * URL to relevant documentation
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable error message
+   */
+  message: string;
+  /**
+   * Parameter that caused the error
+   */
+  param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Error type category
+   */
+  type: QueryEpcType;
+};
+
+/**
+ * Error response
+ */
+export type QueryEpcResponseBodyData = {
+  error: QueryEpcError;
+};
+
+/**
+ * Error response
+ */
+export class QueryEpcResponseBody extends SDKBaseError {
+  error: QueryEpcError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryEpcResponseBodyData;
+
+  constructor(
+    err: QueryEpcResponseBodyData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.error?.message
+      || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "QueryEpcResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryEpcType$inboundSchema: z.ZodType<
+  QueryEpcType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryEpcType);
+
+/** @internal */
+export const QueryEpcError$inboundSchema: z.ZodType<
+  QueryEpcError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
+  type: QueryEpcType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryEpcErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryEpcError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryEpcError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryEpcError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryEpcResponseBody$inboundSchema: z.ZodType<
+  QueryEpcResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryEpcError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryEpcResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/sdk/models/operations/getlistingbyid.ts

@@ -153,7 +153,7 @@ export type BrochureImages = {
    */
   type?: GetListingByIdListingsType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -203,7 +203,7 @@ export type EnergyRatingImages = {
    */
   type?: GetListingByIdListingsResponseType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -255,7 +255,7 @@ export type FloorPlanImages = {
    */
   type?: GetListingByIdListingsResponse200Type | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -293,7 +293,7 @@ export type Images = {
    */
   type?: GetListingByIdListingsResponse200ApplicationJSONType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };

package/src/sdk/models/operations/getlistingbysource.ts

@@ -173,7 +173,7 @@ export type GetListingBySourceBrochureImages = {
    */
   type?: GetListingBySourceListingsType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -225,7 +225,7 @@ export type GetListingBySourceEnergyRatingImages = {
    */
   type?: GetListingBySourceListingsResponseType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -277,7 +277,7 @@ export type GetListingBySourceFloorPlanImages = {
    */
   type?: GetListingBySourceListingsResponse200Type | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -315,7 +315,7 @@ export type GetListingBySourceImages = {
    */
   type?: GetListingBySourceListingsResponse200ApplicationJSONType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };

package/src/sdk/models/operations/getlistingsbylocation.ts

@@ -172,7 +172,7 @@ export type GetListingsByLocationBrochureImages = {
    */
   type?: GetListingsByLocationListingsType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -224,7 +224,7 @@ export type GetListingsByLocationEnergyRatingImages = {
    */
   type?: GetListingsByLocationListingsResponseType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -276,7 +276,7 @@ export type GetListingsByLocationFloorPlanImages = {
    */
   type?: GetListingsByLocationListingsResponse200Type | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -315,7 +315,7 @@ export type GetListingsByLocationImages = {
     | GetListingsByLocationListingsResponse200ApplicationJSONType
     | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };

package/src/sdk/models/operations/querylistings.ts

@@ -219,7 +219,7 @@ export type QueryListingsBrochureImages = {
    */
   type?: QueryListingsListingsType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -269,7 +269,7 @@ export type QueryListingsEnergyRatingImages = {
    */
   type?: QueryListingsListingsResponseType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -321,7 +321,7 @@ export type QueryListingsFloorPlanImages = {
    */
   type?: QueryListingsListingsResponse200Type | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -359,7 +359,7 @@ export type QueryListingsImages = {
    */
   type?: QueryListingsListingsResponse200ApplicationJSONType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };

package/src/sdk/models/operations/querylistingsbysource.ts

@@ -161,7 +161,7 @@ export type QueryListingsBySourceBrochureImages = {
    */
   type?: QueryListingsBySourceListingsType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -213,7 +213,7 @@ export type QueryListingsBySourceEnergyRatingImages = {
    */
   type?: QueryListingsBySourceListingsResponseType | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -265,7 +265,7 @@ export type QueryListingsBySourceFloorPlanImages = {
    */
   type?: QueryListingsBySourceListingsResponse200Type | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };
@@ -304,7 +304,7 @@ export type QueryListingsBySourceImages = {
     | QueryListingsBySourceListingsResponse200ApplicationJSONType
     | undefined;
   /**
-   * Absolute URL to the image file. Images are typically served from provider CDNs (e.g. media.rightmove.co.uk, lid.zoocdn.com). URLs may include query parameters for resizing. These are publicly accessible and do not require authentication.
+   * Absolute URL to the image file. URLs may include query parameters for resizing.
    */
   url: string;
 };

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

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  EPCLocalAuthorityAreaFilter,
+  EPCLocalAuthorityAreaFilter$Outbound,
+  EPCLocalAuthorityAreaFilter$outboundSchema,
+} from "./epclocalauthorityareafilter.js";
+import {
+  EPCPointAreaFilter,
+  EPCPointAreaFilter$Outbound,
+  EPCPointAreaFilter$outboundSchema,
+} from "./epcpointareafilter.js";
+import {
+  EPCPolygonAreaFilter,
+  EPCPolygonAreaFilter$Outbound,
+  EPCPolygonAreaFilter$outboundSchema,
+} from "./epcpolygonareafilter.js";
+import {
+  EPCPostcodeAreaFilter,
+  EPCPostcodeAreaFilter$Outbound,
+  EPCPostcodeAreaFilter$outboundSchema,
+} from "./epcpostcodeareafilter.js";
+
+export type EPCAreaFilter =
+  | EPCPostcodeAreaFilter
+  | EPCPointAreaFilter
+  | EPCPolygonAreaFilter
+  | EPCLocalAuthorityAreaFilter;
+
+/** @internal */
+export type EPCAreaFilter$Outbound =
+  | EPCPostcodeAreaFilter$Outbound
+  | EPCPointAreaFilter$Outbound
+  | EPCPolygonAreaFilter$Outbound
+  | EPCLocalAuthorityAreaFilter$Outbound;
+
+/** @internal */
+export const EPCAreaFilter$outboundSchema: z.ZodType<
+  EPCAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCAreaFilter
+> = z.union([
+  EPCPostcodeAreaFilter$outboundSchema,
+  EPCPointAreaFilter$outboundSchema,
+  EPCPolygonAreaFilter$outboundSchema,
+  EPCLocalAuthorityAreaFilter$outboundSchema,
+]);
+
+export function epcAreaFilterToJSON(epcAreaFilter: EPCAreaFilter): string {
+  return JSON.stringify(EPCAreaFilter$outboundSchema.parse(epcAreaFilter));
+}

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

@@ -781,7 +781,7 @@ export type SecondaryHeating = {
 /**
  * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
  */
-export const Construction = {
+export const EPCDataConstruction = {
   Cavity: "cavity",
   SolidBrick: "solid_brick",
   TimberFrame: "timber_frame",
@@ -799,7 +799,7 @@ export const Construction = {
 /**
  * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
  */
-export type Construction = OpenEnum<typeof Construction>;
+export type EPCDataConstruction = OpenEnum<typeof EPCDataConstruction>;
 
 /**
  * Non-null when the source value was corrupted/incomplete. Null = normal quality.
@@ -882,7 +882,7 @@ export type Walls = {
   /**
    * Wall construction type: cavity, solid_brick, timber_frame, sandstone_or_limestone, etc.
    */
-  construction: Construction | null;
+  construction: EPCDataConstruction | null;
   /**
    * Non-null when the source value was corrupted/incomplete. Null = normal quality.
    */
@@ -2142,11 +2142,11 @@ export function secondaryHeatingFromJSON(
 }
 
 /** @internal */
-export const Construction$inboundSchema: z.ZodType<
-  Construction,
+export const EPCDataConstruction$inboundSchema: z.ZodType<
+  EPCDataConstruction,
   z.ZodTypeDef,
   unknown
-> = openEnums.inboundSchema(Construction);
+> = openEnums.inboundSchema(EPCDataConstruction);
 
 /** @internal */
 export const EPCDataSchemasFabricDataQuality$inboundSchema: z.ZodType<
@@ -2180,7 +2180,7 @@ export const EPCDataSchemasInsulationType$inboundSchema: z.ZodType<
 /** @internal */
 export const Walls$inboundSchema: z.ZodType<Walls, z.ZodTypeDef, unknown> = z
   .object({
-    construction: z.nullable(Construction$inboundSchema),
+    construction: z.nullable(EPCDataConstruction$inboundSchema),
     dataQuality: z.nullable(EPCDataSchemasFabricDataQuality$inboundSchema),
     description: z.nullable(z.string()),
     energyEfficiency: z.nullable(

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCLocalAuthorityAreaFilter = {
+  type: "local_authority";
+  /**
+   * ONS local authority code (e.g. 'E09000033').
+   */
+  value: string;
+};
+
+/** @internal */
+export type EPCLocalAuthorityAreaFilter$Outbound = {
+  type: "local_authority";
+  value: string;
+};
+
+/** @internal */
+export const EPCLocalAuthorityAreaFilter$outboundSchema: z.ZodType<
+  EPCLocalAuthorityAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCLocalAuthorityAreaFilter
+> = z.object({
+  type: z.literal("local_authority"),
+  value: z.string(),
+});
+
+export function epcLocalAuthorityAreaFilterToJSON(
+  epcLocalAuthorityAreaFilter: EPCLocalAuthorityAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCLocalAuthorityAreaFilter$outboundSchema.parse(
+      epcLocalAuthorityAreaFilter,
+    ),
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCPointAreaFilter = {
+  /**
+   * [latitude, longitude] in WGS84. Note: [lat, lng] order, not GeoJSON.
+   */
+  coordinates: Array<number>;
+  /**
+   * Search radius in metres.
+   */
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export type EPCPointAreaFilter$Outbound = {
+  coordinates: Array<number>;
+  radius: number;
+  type: "point";
+};
+
+/** @internal */
+export const EPCPointAreaFilter$outboundSchema: z.ZodType<
+  EPCPointAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCPointAreaFilter
+> = z.object({
+  coordinates: z.array(z.number()),
+  radius: z.number(),
+  type: z.literal("point"),
+});
+
+export function epcPointAreaFilterToJSON(
+  epcPointAreaFilter: EPCPointAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCPointAreaFilter$outboundSchema.parse(epcPointAreaFilter),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCPolygonAreaFilter = {
+  /**
+   * Polygon rings as [lat, lng] pairs. First and last coordinate must match.
+   */
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export type EPCPolygonAreaFilter$Outbound = {
+  coordinates: Array<Array<Array<number>>>;
+  type: "polygon";
+};
+
+/** @internal */
+export const EPCPolygonAreaFilter$outboundSchema: z.ZodType<
+  EPCPolygonAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCPolygonAreaFilter
+> = z.object({
+  coordinates: z.array(z.array(z.array(z.number()))),
+  type: z.literal("polygon"),
+});
+
+export function epcPolygonAreaFilterToJSON(
+  epcPolygonAreaFilter: EPCPolygonAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCPolygonAreaFilter$outboundSchema.parse(epcPolygonAreaFilter),
+  );
+}

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type EPCPostcodeAreaFilter = {
+  type: "postcode";
+  /**
+   * Full or partial UK postcode
+   */
+  value: string;
+};
+
+/** @internal */
+export type EPCPostcodeAreaFilter$Outbound = {
+  type: "postcode";
+  value: string;
+};
+
+/** @internal */
+export const EPCPostcodeAreaFilter$outboundSchema: z.ZodType<
+  EPCPostcodeAreaFilter$Outbound,
+  z.ZodTypeDef,
+  EPCPostcodeAreaFilter
+> = z.object({
+  type: z.literal("postcode"),
+  value: z.string(),
+});
+
+export function epcPostcodeAreaFilterToJSON(
+  epcPostcodeAreaFilter: EPCPostcodeAreaFilter,
+): string {
+  return JSON.stringify(
+    EPCPostcodeAreaFilter$outboundSchema.parse(epcPostcodeAreaFilter),
+  );
+}