@vepler/sdk 2.155.0 → 2.164.0

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

@@ -0,0 +1,267 @@
+/*
+ * 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 ListHeritageSnapshotsHeritageType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ListHeritageSnapshotsHeritageType = OpenEnum<
+  typeof ListHeritageSnapshotsHeritageType
+>;
+
+export type ListHeritageSnapshotsHeritageError = {
+  /**
+   * 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: ListHeritageSnapshotsHeritageType;
+};
+
+/**
+ * Error response
+ */
+export type ListHeritageSnapshotsHeritageResponseBodyData = {
+  error: ListHeritageSnapshotsHeritageError;
+};
+
+/**
+ * Error response
+ */
+export class ListHeritageSnapshotsHeritageResponseBody extends SDKBaseError {
+  error: ListHeritageSnapshotsHeritageError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ListHeritageSnapshotsHeritageResponseBodyData;
+
+  constructor(
+    err: ListHeritageSnapshotsHeritageResponseBodyData,
+    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 = "ListHeritageSnapshotsHeritageResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const ListHeritageSnapshotsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ListHeritageSnapshotsType = OpenEnum<
+  typeof ListHeritageSnapshotsType
+>;
+
+export type ListHeritageSnapshotsError = {
+  /**
+   * 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: ListHeritageSnapshotsType;
+};
+
+/**
+ * Error response
+ */
+export type ListHeritageSnapshotsResponseBodyData = {
+  error: ListHeritageSnapshotsError;
+};
+
+/**
+ * Error response
+ */
+export class ListHeritageSnapshotsResponseBody extends SDKBaseError {
+  error: ListHeritageSnapshotsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ListHeritageSnapshotsResponseBodyData;
+
+  constructor(
+    err: ListHeritageSnapshotsResponseBodyData,
+    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 = "ListHeritageSnapshotsResponseBody";
+  }
+}
+
+/** @internal */
+export const ListHeritageSnapshotsHeritageType$inboundSchema: z.ZodType<
+  ListHeritageSnapshotsHeritageType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListHeritageSnapshotsHeritageType);
+
+/** @internal */
+export const ListHeritageSnapshotsHeritageError$inboundSchema: z.ZodType<
+  ListHeritageSnapshotsHeritageError,
+  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: ListHeritageSnapshotsHeritageType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function listHeritageSnapshotsHeritageErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListHeritageSnapshotsHeritageError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ListHeritageSnapshotsHeritageError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListHeritageSnapshotsHeritageError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListHeritageSnapshotsHeritageResponseBody$inboundSchema: z.ZodType<
+  ListHeritageSnapshotsHeritageResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ListHeritageSnapshotsHeritageError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ListHeritageSnapshotsHeritageResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const ListHeritageSnapshotsType$inboundSchema: z.ZodType<
+  ListHeritageSnapshotsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListHeritageSnapshotsType);
+
+/** @internal */
+export const ListHeritageSnapshotsError$inboundSchema: z.ZodType<
+  ListHeritageSnapshotsError,
+  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: ListHeritageSnapshotsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function listHeritageSnapshotsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListHeritageSnapshotsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListHeritageSnapshotsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListHeritageSnapshotsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListHeritageSnapshotsResponseBody$inboundSchema: z.ZodType<
+  ListHeritageSnapshotsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ListHeritageSnapshotsError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ListHeritageSnapshotsResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -0,0 +1,264 @@
+/*
+ * 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 ListHeritageTypesHeritageType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ListHeritageTypesHeritageType = OpenEnum<
+  typeof ListHeritageTypesHeritageType
+>;
+
+export type ListHeritageTypesHeritageError = {
+  /**
+   * 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: ListHeritageTypesHeritageType;
+};
+
+/**
+ * Error response
+ */
+export type ListHeritageTypesHeritageResponseBodyData = {
+  error: ListHeritageTypesHeritageError;
+};
+
+/**
+ * Error response
+ */
+export class ListHeritageTypesHeritageResponseBody extends SDKBaseError {
+  error: ListHeritageTypesHeritageError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ListHeritageTypesHeritageResponseBodyData;
+
+  constructor(
+    err: ListHeritageTypesHeritageResponseBodyData,
+    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 = "ListHeritageTypesHeritageResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const ListHeritageTypesType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type ListHeritageTypesType = OpenEnum<typeof ListHeritageTypesType>;
+
+export type ListHeritageTypesError = {
+  /**
+   * 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: ListHeritageTypesType;
+};
+
+/**
+ * Error response
+ */
+export type ListHeritageTypesResponseBodyData = {
+  error: ListHeritageTypesError;
+};
+
+/**
+ * Error response
+ */
+export class ListHeritageTypesResponseBody extends SDKBaseError {
+  error: ListHeritageTypesError;
+
+  /** The original data that was passed to this error instance. */
+  data$: ListHeritageTypesResponseBodyData;
+
+  constructor(
+    err: ListHeritageTypesResponseBodyData,
+    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 = "ListHeritageTypesResponseBody";
+  }
+}
+
+/** @internal */
+export const ListHeritageTypesHeritageType$inboundSchema: z.ZodType<
+  ListHeritageTypesHeritageType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListHeritageTypesHeritageType);
+
+/** @internal */
+export const ListHeritageTypesHeritageError$inboundSchema: z.ZodType<
+  ListHeritageTypesHeritageError,
+  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: ListHeritageTypesHeritageType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function listHeritageTypesHeritageErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListHeritageTypesHeritageError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListHeritageTypesHeritageError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListHeritageTypesHeritageError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListHeritageTypesHeritageResponseBody$inboundSchema: z.ZodType<
+  ListHeritageTypesHeritageResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ListHeritageTypesHeritageError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ListHeritageTypesHeritageResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const ListHeritageTypesType$inboundSchema: z.ZodType<
+  ListHeritageTypesType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListHeritageTypesType);
+
+/** @internal */
+export const ListHeritageTypesError$inboundSchema: z.ZodType<
+  ListHeritageTypesError,
+  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: ListHeritageTypesType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function listHeritageTypesErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<ListHeritageTypesError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListHeritageTypesError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListHeritageTypesError' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListHeritageTypesResponseBody$inboundSchema: z.ZodType<
+  ListHeritageTypesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ListHeritageTypesError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ListHeritageTypesResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });