@vepler/sdk 2.8.0 → 2.9.0

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

@@ -0,0 +1,479 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import * as shared from "../shared/index.js";
+
+/**
+ * Error type category
+ */
+export const PredictPropertyValueByLocationAVMResponse500Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PredictPropertyValueByLocationAVMResponse500Type = ClosedEnum<
+  typeof PredictPropertyValueByLocationAVMResponse500Type
+>;
+
+export type PredictPropertyValueByLocationAVMResponse500Error = {
+  /**
+   * 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;
+  /**
+   * Error type category
+   */
+  type: PredictPropertyValueByLocationAVMResponse500Type;
+};
+
+/**
+ * Error response
+ */
+export type PredictPropertyValueByLocationAVMResponse500ResponseBody = {
+  error: PredictPropertyValueByLocationAVMResponse500Error;
+};
+
+/**
+ * Error type category
+ */
+export const PredictPropertyValueByLocationAVMResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PredictPropertyValueByLocationAVMResponseType = ClosedEnum<
+  typeof PredictPropertyValueByLocationAVMResponseType
+>;
+
+export type PredictPropertyValueByLocationAVMResponseError = {
+  /**
+   * 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;
+  /**
+   * Error type category
+   */
+  type: PredictPropertyValueByLocationAVMResponseType;
+};
+
+/**
+ * Error response
+ */
+export type PredictPropertyValueByLocationAVMResponseResponseBody = {
+  error: PredictPropertyValueByLocationAVMResponseError;
+};
+
+/**
+ * Error type category
+ */
+export const PredictPropertyValueByLocationAVMType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PredictPropertyValueByLocationAVMType = ClosedEnum<
+  typeof PredictPropertyValueByLocationAVMType
+>;
+
+export type PredictPropertyValueByLocationAVMError = {
+  /**
+   * 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;
+  /**
+   * Error type category
+   */
+  type: PredictPropertyValueByLocationAVMType;
+};
+
+/**
+ * Error response
+ */
+export type PredictPropertyValueByLocationAVMResponseBody = {
+  error: PredictPropertyValueByLocationAVMError;
+};
+
+/**
+ * Error type category
+ */
+export const PredictPropertyValueByLocationType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type PredictPropertyValueByLocationType = ClosedEnum<
+  typeof PredictPropertyValueByLocationType
+>;
+
+export type PredictPropertyValueByLocationError = {
+  /**
+   * 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;
+  /**
+   * Error type category
+   */
+  type: PredictPropertyValueByLocationType;
+};
+
+/**
+ * Error response
+ */
+export type PredictPropertyValueByLocationResponseBody = {
+  error: PredictPropertyValueByLocationError;
+};
+
+export type PredictPropertyValueByLocationResponse =
+  | shared.AVMPredictResponse
+  | PredictPropertyValueByLocationResponseBody
+  | PredictPropertyValueByLocationAVMResponseBody
+  | PredictPropertyValueByLocationAVMResponseResponseBody
+  | PredictPropertyValueByLocationAVMResponse500ResponseBody;
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponse500Type$inboundSchema:
+  z.ZodNativeEnum<typeof PredictPropertyValueByLocationAVMResponse500Type> = z
+    .nativeEnum(PredictPropertyValueByLocationAVMResponse500Type);
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponse500Error$inboundSchema:
+  z.ZodType<
+    PredictPropertyValueByLocationAVMResponse500Error,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    code: z.string().optional(),
+    doc_url: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: PredictPropertyValueByLocationAVMResponse500Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function predictPropertyValueByLocationAVMResponse500ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PredictPropertyValueByLocationAVMResponse500Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationAVMResponse500Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PredictPropertyValueByLocationAVMResponse500Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponse500ResponseBody$inboundSchema:
+  z.ZodType<
+    PredictPropertyValueByLocationAVMResponse500ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      PredictPropertyValueByLocationAVMResponse500Error$inboundSchema
+    ),
+  });
+
+export function predictPropertyValueByLocationAVMResponse500ResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PredictPropertyValueByLocationAVMResponse500ResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationAVMResponse500ResponseBody$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'PredictPropertyValueByLocationAVMResponse500ResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponseType$inboundSchema:
+  z.ZodNativeEnum<typeof PredictPropertyValueByLocationAVMResponseType> = z
+    .nativeEnum(PredictPropertyValueByLocationAVMResponseType);
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponseError$inboundSchema:
+  z.ZodType<
+    PredictPropertyValueByLocationAVMResponseError,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    code: z.string().optional(),
+    doc_url: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: PredictPropertyValueByLocationAVMResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function predictPropertyValueByLocationAVMResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PredictPropertyValueByLocationAVMResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationAVMResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PredictPropertyValueByLocationAVMResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponseResponseBody$inboundSchema:
+  z.ZodType<
+    PredictPropertyValueByLocationAVMResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      PredictPropertyValueByLocationAVMResponseError$inboundSchema
+    ),
+  });
+
+export function predictPropertyValueByLocationAVMResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PredictPropertyValueByLocationAVMResponseResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationAVMResponseResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PredictPropertyValueByLocationAVMResponseResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMType$inboundSchema:
+  z.ZodNativeEnum<typeof PredictPropertyValueByLocationAVMType> = z.nativeEnum(
+    PredictPropertyValueByLocationAVMType,
+  );
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMError$inboundSchema: z.ZodType<
+  PredictPropertyValueByLocationAVMError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: PredictPropertyValueByLocationAVMType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function predictPropertyValueByLocationAVMErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PredictPropertyValueByLocationAVMError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationAVMError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PredictPropertyValueByLocationAVMError' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationAVMResponseBody$inboundSchema:
+  z.ZodType<
+    PredictPropertyValueByLocationAVMResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => PredictPropertyValueByLocationAVMError$inboundSchema),
+  });
+
+export function predictPropertyValueByLocationAVMResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PredictPropertyValueByLocationAVMResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationAVMResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PredictPropertyValueByLocationAVMResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationType$inboundSchema: z.ZodNativeEnum<
+  typeof PredictPropertyValueByLocationType
+> = z.nativeEnum(PredictPropertyValueByLocationType);
+
+/** @internal */
+export const PredictPropertyValueByLocationError$inboundSchema: z.ZodType<
+  PredictPropertyValueByLocationError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: PredictPropertyValueByLocationType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function predictPropertyValueByLocationErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PredictPropertyValueByLocationError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PredictPropertyValueByLocationError' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationResponseBody$inboundSchema:
+  z.ZodType<PredictPropertyValueByLocationResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => PredictPropertyValueByLocationError$inboundSchema),
+    });
+
+export function predictPropertyValueByLocationResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PredictPropertyValueByLocationResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PredictPropertyValueByLocationResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const PredictPropertyValueByLocationResponse$inboundSchema: z.ZodType<
+  PredictPropertyValueByLocationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.AVMPredictResponse$inboundSchema,
+  z.lazy(() => PredictPropertyValueByLocationResponseBody$inboundSchema),
+  z.lazy(() => PredictPropertyValueByLocationAVMResponseBody$inboundSchema),
+  z.lazy(() =>
+    PredictPropertyValueByLocationAVMResponseResponseBody$inboundSchema
+  ),
+  z.lazy(() =>
+    PredictPropertyValueByLocationAVMResponse500ResponseBody$inboundSchema
+  ),
+]);
+
+export function predictPropertyValueByLocationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PredictPropertyValueByLocationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PredictPropertyValueByLocationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PredictPropertyValueByLocationResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,31 @@
+/*
+ * 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";
+import * as shared from "../shared/index.js";
+
+export type VerifyRoaResponse = shared.RoaVerifyResponse | shared.RoaError;
+
+/** @internal */
+export const VerifyRoaResponse$inboundSchema: z.ZodType<
+  VerifyRoaResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  shared.RoaVerifyResponse$inboundSchema,
+  shared.RoaError$inboundSchema,
+]);
+
+export function verifyRoaResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VerifyRoaResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VerifyRoaResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VerifyRoaResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,194 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Override property condition
+ */
+export const Condition = {
+  Poor: "poor",
+  Average: "average",
+  Good: "good",
+  Excellent: "excellent",
+  NewBuild: "newBuild",
+} as const;
+/**
+ * Override property condition
+ */
+export type Condition = ClosedEnum<typeof Condition>;
+
+/**
+ * Override Energy Performance Certificate rating
+ */
+export const Epc = {
+  A: "A",
+  B: "B",
+  C: "C",
+  D: "D",
+  E: "E",
+  F: "F",
+  G: "G",
+} as const;
+/**
+ * Override Energy Performance Certificate rating
+ */
+export type Epc = ClosedEnum<typeof Epc>;
+
+/**
+ * Override property type from fetched data
+ */
+export const PropertyType = {
+  Detached: "detached",
+  SemiDetached: "semiDetached",
+  Terraced: "terraced",
+  Flat: "flat",
+  Bungalow: "bungalow",
+  Maisonette: "maisonette",
+  Cottage: "cottage",
+  Chalet: "chalet",
+  Lodge: "lodge",
+  CharacterProperty: "characterProperty",
+  MobileHome: "mobileHome",
+  Retirement: "retirement",
+  BlockOfFlats: "blockOfFlats",
+  Farmhouse: "farmhouse",
+  Unknown: "unknown",
+  Other: "other",
+} as const;
+/**
+ * Override property type from fetched data
+ */
+export type PropertyType = ClosedEnum<typeof PropertyType>;
+
+/**
+ * Type of transaction - sale or rental valuation
+ */
+export const TransactionType = {
+  Sale: "sale",
+  Rent: "rent",
+} as const;
+/**
+ * Type of transaction - sale or rental valuation
+ */
+export type TransactionType = ClosedEnum<typeof TransactionType>;
+
+/**
+ * Request to predict property value by location ID
+ */
+export type AVMPredictByLocationRequest = {
+  /**
+   * Override number of bathrooms from fetched data
+   */
+  baths?: number | undefined;
+  /**
+   * Override number of bedrooms from fetched data
+   */
+  beds?: number | undefined;
+  /**
+   * Override property condition
+   */
+  condition?: Condition | undefined;
+  /**
+   * Override Energy Performance Certificate rating
+   */
+  epc?: Epc | undefined;
+  /**
+   * Override floor area in square metres from fetched data
+   */
+  floorArea?: number | undefined;
+  /**
+   * Price to rate against market value (requires ratePrice: true)
+   */
+  inputPrice?: number | undefined;
+  /**
+   * Override listing price (for comparison)
+   */
+  listingPrice?: number | undefined;
+  /**
+   * Property location identifier
+   */
+  locationId: string;
+  /**
+   * Override property type from fetched data
+   */
+  propertyType?: PropertyType | undefined;
+  /**
+   * Whether to rate the input price against estimated market value
+   */
+  ratePrice?: boolean | undefined;
+  /**
+   * Type of transaction - sale or rental valuation
+   */
+  transactionType?: TransactionType | undefined;
+  /**
+   * Override year the property was built
+   */
+  yearBuilt?: number | undefined;
+};
+
+/** @internal */
+export const Condition$outboundSchema: z.ZodNativeEnum<typeof Condition> = z
+  .nativeEnum(Condition);
+
+/** @internal */
+export const Epc$outboundSchema: z.ZodNativeEnum<typeof Epc> = z.nativeEnum(
+  Epc,
+);
+
+/** @internal */
+export const PropertyType$outboundSchema: z.ZodNativeEnum<typeof PropertyType> =
+  z.nativeEnum(PropertyType);
+
+/** @internal */
+export const TransactionType$outboundSchema: z.ZodNativeEnum<
+  typeof TransactionType
+> = z.nativeEnum(TransactionType);
+
+/** @internal */
+export type AVMPredictByLocationRequest$Outbound = {
+  baths?: number | undefined;
+  beds?: number | undefined;
+  condition?: string | undefined;
+  epc?: string | undefined;
+  floorArea?: number | undefined;
+  inputPrice?: number | undefined;
+  listingPrice?: number | undefined;
+  locationId: string;
+  propertyType?: string | undefined;
+  ratePrice?: boolean | undefined;
+  transactionType: string;
+  yearBuilt?: number | undefined;
+};
+
+/** @internal */
+export const AVMPredictByLocationRequest$outboundSchema: z.ZodType<
+  AVMPredictByLocationRequest$Outbound,
+  z.ZodTypeDef,
+  AVMPredictByLocationRequest
+> = z.object({
+  baths: z.number().int().optional(),
+  beds: z.number().int().optional(),
+  condition: Condition$outboundSchema.optional(),
+  epc: Epc$outboundSchema.optional(),
+  floorArea: z.number().optional(),
+  inputPrice: z.number().optional(),
+  listingPrice: z.number().optional(),
+  locationId: z.string(),
+  propertyType: PropertyType$outboundSchema.optional(),
+  ratePrice: z.boolean().optional(),
+  transactionType: TransactionType$outboundSchema.default("sale"),
+  yearBuilt: z.number().int().optional(),
+});
+
+export function avmPredictByLocationRequestToJSON(
+  avmPredictByLocationRequest: AVMPredictByLocationRequest,
+): string {
+  return JSON.stringify(
+    AVMPredictByLocationRequest$outboundSchema.parse(
+      avmPredictByLocationRequest,
+    ),
+  );
+}