@vepler/sdk 2.155.0 → 2.164.0

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

@@ -0,0 +1,569 @@
+/*
+ * 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 QueryLandConstraintDesignationsLandConstraintResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryLandConstraintDesignationsLandConstraintResponse503Type =
+  OpenEnum<typeof QueryLandConstraintDesignationsLandConstraintResponse503Type>;
+
+export type QueryLandConstraintDesignationsLandConstraintResponse503Error = {
+  /**
+   * 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: QueryLandConstraintDesignationsLandConstraintResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type QueryLandConstraintDesignationsLandConstraintResponse503ResponseBodyData =
+  {
+    error: QueryLandConstraintDesignationsLandConstraintResponse503Error;
+  };
+
+/**
+ * Error response
+ */
+export class QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: QueryLandConstraintDesignationsLandConstraintResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$:
+    QueryLandConstraintDesignationsLandConstraintResponse503ResponseBodyData;
+
+  constructor(
+    err:
+      QueryLandConstraintDesignationsLandConstraintResponse503ResponseBodyData,
+    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 =
+      "QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryLandConstraintDesignationsLandConstraintResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryLandConstraintDesignationsLandConstraintResponseType =
+  OpenEnum<typeof QueryLandConstraintDesignationsLandConstraintResponseType>;
+
+export type QueryLandConstraintDesignationsLandConstraintResponseError = {
+  /**
+   * 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: QueryLandConstraintDesignationsLandConstraintResponseType;
+};
+
+/**
+ * Error response
+ */
+export type QueryLandConstraintDesignationsLandConstraintResponseResponseBodyData =
+  {
+    error: QueryLandConstraintDesignationsLandConstraintResponseError;
+  };
+
+/**
+ * Error response
+ */
+export class QueryLandConstraintDesignationsLandConstraintResponseResponseBody
+  extends SDKBaseError
+{
+  error: QueryLandConstraintDesignationsLandConstraintResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryLandConstraintDesignationsLandConstraintResponseResponseBodyData;
+
+  constructor(
+    err: QueryLandConstraintDesignationsLandConstraintResponseResponseBodyData,
+    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 =
+      "QueryLandConstraintDesignationsLandConstraintResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryLandConstraintDesignationsLandConstraintType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryLandConstraintDesignationsLandConstraintType = OpenEnum<
+  typeof QueryLandConstraintDesignationsLandConstraintType
+>;
+
+export type QueryLandConstraintDesignationsLandConstraintError = {
+  /**
+   * 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: QueryLandConstraintDesignationsLandConstraintType;
+};
+
+/**
+ * Error response
+ */
+export type QueryLandConstraintDesignationsLandConstraintResponseBodyData = {
+  error: QueryLandConstraintDesignationsLandConstraintError;
+};
+
+/**
+ * Error response
+ */
+export class QueryLandConstraintDesignationsLandConstraintResponseBody
+  extends SDKBaseError
+{
+  error: QueryLandConstraintDesignationsLandConstraintError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryLandConstraintDesignationsLandConstraintResponseBodyData;
+
+  constructor(
+    err: QueryLandConstraintDesignationsLandConstraintResponseBodyData,
+    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 = "QueryLandConstraintDesignationsLandConstraintResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryLandConstraintDesignationsType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryLandConstraintDesignationsType = OpenEnum<
+  typeof QueryLandConstraintDesignationsType
+>;
+
+export type QueryLandConstraintDesignationsError = {
+  /**
+   * 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: QueryLandConstraintDesignationsType;
+};
+
+/**
+ * Error response
+ */
+export type QueryLandConstraintDesignationsResponseBodyData = {
+  error: QueryLandConstraintDesignationsError;
+};
+
+/**
+ * Error response
+ */
+export class QueryLandConstraintDesignationsResponseBody extends SDKBaseError {
+  error: QueryLandConstraintDesignationsError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryLandConstraintDesignationsResponseBodyData;
+
+  constructor(
+    err: QueryLandConstraintDesignationsResponseBodyData,
+    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 = "QueryLandConstraintDesignationsResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponse503Type$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    QueryLandConstraintDesignationsLandConstraintResponse503Type,
+  );
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponse503Error$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponse503Error,
+    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:
+      QueryLandConstraintDesignationsLandConstraintResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryLandConstraintDesignationsLandConstraintResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryLandConstraintDesignationsLandConstraintResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryLandConstraintDesignationsLandConstraintResponse503Error$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'QueryLandConstraintDesignationsLandConstraintResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryLandConstraintDesignationsLandConstraintResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryLandConstraintDesignationsLandConstraintResponse503ResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponseType$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    QueryLandConstraintDesignationsLandConstraintResponseType,
+  );
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponseError$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponseError,
+    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:
+      QueryLandConstraintDesignationsLandConstraintResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryLandConstraintDesignationsLandConstraintResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryLandConstraintDesignationsLandConstraintResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryLandConstraintDesignationsLandConstraintResponseError$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'QueryLandConstraintDesignationsLandConstraintResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponseResponseBody$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryLandConstraintDesignationsLandConstraintResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryLandConstraintDesignationsLandConstraintResponseResponseBody(
+        v,
+        { request: v.request$, response: v.response$, body: v.body$ },
+      );
+    });
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintType$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(
+    QueryLandConstraintDesignationsLandConstraintType,
+  );
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintError$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintError,
+    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: QueryLandConstraintDesignationsLandConstraintType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryLandConstraintDesignationsLandConstraintErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryLandConstraintDesignationsLandConstraintError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryLandConstraintDesignationsLandConstraintError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryLandConstraintDesignationsLandConstraintError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryLandConstraintDesignationsLandConstraintResponseBody$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsLandConstraintResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryLandConstraintDesignationsLandConstraintError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryLandConstraintDesignationsLandConstraintResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryLandConstraintDesignationsType$inboundSchema: z.ZodType<
+  QueryLandConstraintDesignationsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryLandConstraintDesignationsType);
+
+/** @internal */
+export const QueryLandConstraintDesignationsError$inboundSchema: z.ZodType<
+  QueryLandConstraintDesignationsError,
+  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: QueryLandConstraintDesignationsType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryLandConstraintDesignationsErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryLandConstraintDesignationsError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryLandConstraintDesignationsError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryLandConstraintDesignationsError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryLandConstraintDesignationsResponseBody$inboundSchema:
+  z.ZodType<
+    QueryLandConstraintDesignationsResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => QueryLandConstraintDesignationsError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryLandConstraintDesignationsResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });

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

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetConservationDesignationRequest = {
+  /**
+   * Stable designation id: design.{product}.{nation}.{type}.{reference}.
+   */
+  designationId: string;
+};
+
+/** @internal */
+export type GetConservationDesignationRequest$Outbound = {
+  designationId: string;
+};
+
+/** @internal */
+export const GetConservationDesignationRequest$outboundSchema: z.ZodType<
+  GetConservationDesignationRequest$Outbound,
+  z.ZodTypeDef,
+  GetConservationDesignationRequest
+> = z.object({
+  designationId: z.string(),
+});
+
+export function getConservationDesignationRequestToJSON(
+  getConservationDesignationRequest: GetConservationDesignationRequest,
+): string {
+  return JSON.stringify(
+    GetConservationDesignationRequest$outboundSchema.parse(
+      getConservationDesignationRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetHeritageDesignationRequest = {
+  /**
+   * Stable designation id: design.{product}.{nation}.{type}.{reference}.
+   */
+  designationId: string;
+};
+
+/** @internal */
+export type GetHeritageDesignationRequest$Outbound = {
+  designationId: string;
+};
+
+/** @internal */
+export const GetHeritageDesignationRequest$outboundSchema: z.ZodType<
+  GetHeritageDesignationRequest$Outbound,
+  z.ZodTypeDef,
+  GetHeritageDesignationRequest
+> = z.object({
+  designationId: z.string(),
+});
+
+export function getHeritageDesignationRequestToJSON(
+  getHeritageDesignationRequest: GetHeritageDesignationRequest,
+): string {
+  return JSON.stringify(
+    GetHeritageDesignationRequest$outboundSchema.parse(
+      getHeritageDesignationRequest,
+    ),
+  );
+}

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

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetLandConstraintDesignationRequest = {
+  /**
+   * Stable designation id: design.{product}.{nation}.{type}.{reference}.
+   */
+  designationId: string;
+};
+
+/** @internal */
+export type GetLandConstraintDesignationRequest$Outbound = {
+  designationId: string;
+};
+
+/** @internal */
+export const GetLandConstraintDesignationRequest$outboundSchema: z.ZodType<
+  GetLandConstraintDesignationRequest$Outbound,
+  z.ZodTypeDef,
+  GetLandConstraintDesignationRequest
+> = z.object({
+  designationId: z.string(),
+});
+
+export function getLandConstraintDesignationRequestToJSON(
+  getLandConstraintDesignationRequest: GetLandConstraintDesignationRequest,
+): string {
+  return JSON.stringify(
+    GetLandConstraintDesignationRequest$outboundSchema.parse(
+      getLandConstraintDesignationRequest,
+    ),
+  );
+}