@vepler/sdk 2.33.0 → 2.37.0

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

@@ -0,0 +1,392 @@
+/*
+ * 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 ReverseGeocodeAddressResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ReverseGeocodeAddressResponseType = OpenEnum<
+  typeof ReverseGeocodeAddressResponseType
+>;
+
+export type ReverseGeocodeAddressResponseError = {
+  /**
+   * 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: ReverseGeocodeAddressResponseType;
+};
+
+/**
+ * Error response
+ */
+export type ReverseGeocodeAddressResponseResponseBodyData = {
+  error: ReverseGeocodeAddressResponseError;
+};
+
+/**
+ * Error response
+ */
+export class ReverseGeocodeAddressResponseResponseBody extends SDKBaseError {
+  error: ReverseGeocodeAddressResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ReverseGeocodeAddressResponseResponseBodyData;
+
+  constructor(
+    err: ReverseGeocodeAddressResponseResponseBodyData,
+    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 = "ReverseGeocodeAddressResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const ReverseGeocodeAddressType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ReverseGeocodeAddressType = OpenEnum<
+  typeof ReverseGeocodeAddressType
+>;
+
+export type ReverseGeocodeAddressError = {
+  /**
+   * 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: ReverseGeocodeAddressType;
+};
+
+/**
+ * Error response
+ */
+export type ReverseGeocodeAddressResponseBodyData = {
+  error: ReverseGeocodeAddressError;
+};
+
+/**
+ * Error response
+ */
+export class ReverseGeocodeAddressResponseBody extends SDKBaseError {
+  error: ReverseGeocodeAddressError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ReverseGeocodeAddressResponseBodyData;
+
+  constructor(
+    err: ReverseGeocodeAddressResponseBodyData,
+    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 = "ReverseGeocodeAddressResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const ReverseGeocodeType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ReverseGeocodeType = OpenEnum<typeof ReverseGeocodeType>;
+
+export type ReverseGeocodeError = {
+  /**
+   * 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: ReverseGeocodeType;
+};
+
+/**
+ * Error response
+ */
+export type ReverseGeocodeResponseBodyData = {
+  error: ReverseGeocodeError;
+};
+
+/**
+ * Error response
+ */
+export class ReverseGeocodeResponseBody extends SDKBaseError {
+  error: ReverseGeocodeError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ReverseGeocodeResponseBodyData;
+
+  constructor(
+    err: ReverseGeocodeResponseBodyData,
+    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 = "ReverseGeocodeResponseBody";
+  }
+}
+
+/** @internal */
+export const ReverseGeocodeAddressResponseType$inboundSchema: z.ZodType<
+  ReverseGeocodeAddressResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ReverseGeocodeAddressResponseType);
+
+/** @internal */
+export const ReverseGeocodeAddressResponseError$inboundSchema: z.ZodType<
+  ReverseGeocodeAddressResponseError,
+  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: ReverseGeocodeAddressResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function reverseGeocodeAddressResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ReverseGeocodeAddressResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ReverseGeocodeAddressResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReverseGeocodeAddressResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReverseGeocodeAddressResponseResponseBody$inboundSchema: z.ZodType<
+  ReverseGeocodeAddressResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ReverseGeocodeAddressResponseError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ReverseGeocodeAddressResponseResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const ReverseGeocodeAddressType$inboundSchema: z.ZodType<
+  ReverseGeocodeAddressType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ReverseGeocodeAddressType);
+
+/** @internal */
+export const ReverseGeocodeAddressError$inboundSchema: z.ZodType<
+  ReverseGeocodeAddressError,
+  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: ReverseGeocodeAddressType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function reverseGeocodeAddressErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ReverseGeocodeAddressError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReverseGeocodeAddressError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReverseGeocodeAddressError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReverseGeocodeAddressResponseBody$inboundSchema: z.ZodType<
+  ReverseGeocodeAddressResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ReverseGeocodeAddressError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ReverseGeocodeAddressResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const ReverseGeocodeType$inboundSchema: z.ZodType<
+  ReverseGeocodeType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ReverseGeocodeType);
+
+/** @internal */
+export const ReverseGeocodeError$inboundSchema: z.ZodType<
+  ReverseGeocodeError,
+  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: ReverseGeocodeType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function reverseGeocodeErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ReverseGeocodeError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReverseGeocodeError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReverseGeocodeError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ReverseGeocodeResponseBody$inboundSchema: z.ZodType<
+  ReverseGeocodeResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ReverseGeocodeError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ReverseGeocodeResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -44,6 +44,10 @@ export type SearchPlanningApplicationsPlanningError = {
    * Parameter that caused the error
    */
   param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
   /**
    * Error type category
    */
@@ -115,6 +119,10 @@ export type SearchPlanningApplicationsError = {
    * Parameter that caused the error
    */
   param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
   /**
    * Error type category
    */
@@ -168,6 +176,7 @@ export const SearchPlanningApplicationsPlanningError$inboundSchema: z.ZodType<
   doc_url: z.string().optional(),
   message: z.string(),
   param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
   type: SearchPlanningApplicationsPlanningType$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -228,6 +237,7 @@ export const SearchPlanningApplicationsError$inboundSchema: z.ZodType<
   doc_url: z.string().optional(),
   message: z.string(),
   param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
   type: SearchPlanningApplicationsType$inboundSchema,
 }).transform((v) => {
   return remap$(v, {

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

@@ -44,6 +44,10 @@ export type SearchPropertiesPropertyError = {
    * Parameter that caused the error
    */
   param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
   /**
    * Error type category
    */
@@ -111,6 +115,10 @@ export type SearchPropertiesError = {
    * Parameter that caused the error
    */
   param?: string | undefined;
+  /**
+   * Suggested corrections (e.g. postcode typo suggestions)
+   */
+  suggestions?: Array<string> | undefined;
   /**
    * Error type category
    */
@@ -164,6 +172,7 @@ export const SearchPropertiesPropertyError$inboundSchema: z.ZodType<
   doc_url: z.string().optional(),
   message: z.string(),
   param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
   type: SearchPropertiesPropertyType$inboundSchema,
 }).transform((v) => {
   return remap$(v, {
@@ -217,6 +226,7 @@ export const SearchPropertiesError$inboundSchema: z.ZodType<
   doc_url: z.string().optional(),
   message: z.string(),
   param: z.string().optional(),
+  suggestions: z.array(z.string()).optional(),
   type: SearchPropertiesType$inboundSchema,
 }).transform((v) => {
   return remap$(v, {