@vepler/sdk 1.10.1 → 2.3.0

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

@@ -0,0 +1,598 @@
+/*
+ * 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";
+
+export type GetEPCByLocationIdRequest = {
+  /**
+   * Location identifier (UPRN)
+   */
+  locationId: string;
+};
+
+/**
+ * Error type category
+ */
+export const GetEPCByLocationIdEPCType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEPCByLocationIdEPCType = ClosedEnum<
+  typeof GetEPCByLocationIdEPCType
+>;
+
+export type GetEPCByLocationIdError = {
+  /**
+   * 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: GetEPCByLocationIdEPCType;
+};
+
+/**
+ * Error response
+ */
+export type GetEPCByLocationIdEPCResponseResponseBody = {
+  error: GetEPCByLocationIdError;
+};
+
+/**
+ * Error type category
+ */
+export const GetEPCByLocationIdType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type GetEPCByLocationIdType = ClosedEnum<typeof GetEPCByLocationIdType>;
+
+export type ErrorT = {
+  /**
+   * 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: GetEPCByLocationIdType;
+};
+
+/**
+ * Error response
+ */
+export type GetEPCByLocationIdEPCResponseBody = {
+  error: ErrorT;
+};
+
+/**
+ * EPC data successfully retrieved
+ */
+export type GetEPCByLocationIdResponseBody = {
+  data?: any | null | undefined;
+  success: boolean;
+};
+
+export type GetEPCByLocationIdResponse =
+  | GetEPCByLocationIdResponseBody
+  | GetEPCByLocationIdEPCResponseBody
+  | GetEPCByLocationIdEPCResponseResponseBody;
+
+/** @internal */
+export const GetEPCByLocationIdRequest$inboundSchema: z.ZodType<
+  GetEPCByLocationIdRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  locationId: z.string(),
+});
+
+/** @internal */
+export type GetEPCByLocationIdRequest$Outbound = {
+  locationId: string;
+};
+
+/** @internal */
+export const GetEPCByLocationIdRequest$outboundSchema: z.ZodType<
+  GetEPCByLocationIdRequest$Outbound,
+  z.ZodTypeDef,
+  GetEPCByLocationIdRequest
+> = z.object({
+  locationId: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdRequest$ {
+  /** @deprecated use `GetEPCByLocationIdRequest$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdRequest$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdRequest$outboundSchema` instead. */
+  export const outboundSchema = GetEPCByLocationIdRequest$outboundSchema;
+  /** @deprecated use `GetEPCByLocationIdRequest$Outbound` instead. */
+  export type Outbound = GetEPCByLocationIdRequest$Outbound;
+}
+
+export function getEPCByLocationIdRequestToJSON(
+  getEPCByLocationIdRequest: GetEPCByLocationIdRequest,
+): string {
+  return JSON.stringify(
+    GetEPCByLocationIdRequest$outboundSchema.parse(getEPCByLocationIdRequest),
+  );
+}
+
+export function getEPCByLocationIdRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEPCByLocationIdRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEPCByLocationIdRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEPCByLocationIdRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEPCByLocationIdEPCType$inboundSchema: z.ZodNativeEnum<
+  typeof GetEPCByLocationIdEPCType
+> = z.nativeEnum(GetEPCByLocationIdEPCType);
+
+/** @internal */
+export const GetEPCByLocationIdEPCType$outboundSchema: z.ZodNativeEnum<
+  typeof GetEPCByLocationIdEPCType
+> = GetEPCByLocationIdEPCType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdEPCType$ {
+  /** @deprecated use `GetEPCByLocationIdEPCType$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdEPCType$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdEPCType$outboundSchema` instead. */
+  export const outboundSchema = GetEPCByLocationIdEPCType$outboundSchema;
+}
+
+/** @internal */
+export const GetEPCByLocationIdError$inboundSchema: z.ZodType<
+  GetEPCByLocationIdError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  doc_url: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetEPCByLocationIdEPCType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+/** @internal */
+export type GetEPCByLocationIdError$Outbound = {
+  code?: string | undefined;
+  doc_url?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const GetEPCByLocationIdError$outboundSchema: z.ZodType<
+  GetEPCByLocationIdError$Outbound,
+  z.ZodTypeDef,
+  GetEPCByLocationIdError
+> = z.object({
+  code: z.string().optional(),
+  docUrl: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetEPCByLocationIdEPCType$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    docUrl: "doc_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdError$ {
+  /** @deprecated use `GetEPCByLocationIdError$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdError$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdError$outboundSchema` instead. */
+  export const outboundSchema = GetEPCByLocationIdError$outboundSchema;
+  /** @deprecated use `GetEPCByLocationIdError$Outbound` instead. */
+  export type Outbound = GetEPCByLocationIdError$Outbound;
+}
+
+export function getEPCByLocationIdErrorToJSON(
+  getEPCByLocationIdError: GetEPCByLocationIdError,
+): string {
+  return JSON.stringify(
+    GetEPCByLocationIdError$outboundSchema.parse(getEPCByLocationIdError),
+  );
+}
+
+export function getEPCByLocationIdErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEPCByLocationIdError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEPCByLocationIdError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEPCByLocationIdError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEPCByLocationIdEPCResponseResponseBody$inboundSchema: z.ZodType<
+  GetEPCByLocationIdEPCResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetEPCByLocationIdError$inboundSchema),
+});
+
+/** @internal */
+export type GetEPCByLocationIdEPCResponseResponseBody$Outbound = {
+  error: GetEPCByLocationIdError$Outbound;
+};
+
+/** @internal */
+export const GetEPCByLocationIdEPCResponseResponseBody$outboundSchema:
+  z.ZodType<
+    GetEPCByLocationIdEPCResponseResponseBody$Outbound,
+    z.ZodTypeDef,
+    GetEPCByLocationIdEPCResponseResponseBody
+  > = z.object({
+    error: z.lazy(() => GetEPCByLocationIdError$outboundSchema),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdEPCResponseResponseBody$ {
+  /** @deprecated use `GetEPCByLocationIdEPCResponseResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetEPCByLocationIdEPCResponseResponseBody$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdEPCResponseResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetEPCByLocationIdEPCResponseResponseBody$outboundSchema;
+  /** @deprecated use `GetEPCByLocationIdEPCResponseResponseBody$Outbound` instead. */
+  export type Outbound = GetEPCByLocationIdEPCResponseResponseBody$Outbound;
+}
+
+export function getEPCByLocationIdEPCResponseResponseBodyToJSON(
+  getEPCByLocationIdEPCResponseResponseBody:
+    GetEPCByLocationIdEPCResponseResponseBody,
+): string {
+  return JSON.stringify(
+    GetEPCByLocationIdEPCResponseResponseBody$outboundSchema.parse(
+      getEPCByLocationIdEPCResponseResponseBody,
+    ),
+  );
+}
+
+export function getEPCByLocationIdEPCResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetEPCByLocationIdEPCResponseResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetEPCByLocationIdEPCResponseResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetEPCByLocationIdEPCResponseResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEPCByLocationIdType$inboundSchema: z.ZodNativeEnum<
+  typeof GetEPCByLocationIdType
+> = z.nativeEnum(GetEPCByLocationIdType);
+
+/** @internal */
+export const GetEPCByLocationIdType$outboundSchema: z.ZodNativeEnum<
+  typeof GetEPCByLocationIdType
+> = GetEPCByLocationIdType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdType$ {
+  /** @deprecated use `GetEPCByLocationIdType$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdType$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdType$outboundSchema` instead. */
+  export const outboundSchema = GetEPCByLocationIdType$outboundSchema;
+}
+
+/** @internal */
+export const ErrorT$inboundSchema: z.ZodType<ErrorT, z.ZodTypeDef, unknown> = z
+  .object({
+    code: z.string().optional(),
+    doc_url: z.string().optional(),
+    message: z.string(),
+    param: z.string().optional(),
+    type: GetEPCByLocationIdType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+/** @internal */
+export type ErrorT$Outbound = {
+  code?: string | undefined;
+  doc_url?: string | undefined;
+  message: string;
+  param?: string | undefined;
+  type: string;
+};
+
+/** @internal */
+export const ErrorT$outboundSchema: z.ZodType<
+  ErrorT$Outbound,
+  z.ZodTypeDef,
+  ErrorT
+> = z.object({
+  code: z.string().optional(),
+  docUrl: z.string().optional(),
+  message: z.string(),
+  param: z.string().optional(),
+  type: GetEPCByLocationIdType$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    docUrl: "doc_url",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ErrorT$ {
+  /** @deprecated use `ErrorT$inboundSchema` instead. */
+  export const inboundSchema = ErrorT$inboundSchema;
+  /** @deprecated use `ErrorT$outboundSchema` instead. */
+  export const outboundSchema = ErrorT$outboundSchema;
+  /** @deprecated use `ErrorT$Outbound` instead. */
+  export type Outbound = ErrorT$Outbound;
+}
+
+export function errorToJSON(errorT: ErrorT): string {
+  return JSON.stringify(ErrorT$outboundSchema.parse(errorT));
+}
+
+export function errorFromJSON(
+  jsonString: string,
+): SafeParseResult<ErrorT, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ErrorT$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ErrorT' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEPCByLocationIdEPCResponseBody$inboundSchema: z.ZodType<
+  GetEPCByLocationIdEPCResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => ErrorT$inboundSchema),
+});
+
+/** @internal */
+export type GetEPCByLocationIdEPCResponseBody$Outbound = {
+  error: ErrorT$Outbound;
+};
+
+/** @internal */
+export const GetEPCByLocationIdEPCResponseBody$outboundSchema: z.ZodType<
+  GetEPCByLocationIdEPCResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetEPCByLocationIdEPCResponseBody
+> = z.object({
+  error: z.lazy(() => ErrorT$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdEPCResponseBody$ {
+  /** @deprecated use `GetEPCByLocationIdEPCResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdEPCResponseBody$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdEPCResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetEPCByLocationIdEPCResponseBody$outboundSchema;
+  /** @deprecated use `GetEPCByLocationIdEPCResponseBody$Outbound` instead. */
+  export type Outbound = GetEPCByLocationIdEPCResponseBody$Outbound;
+}
+
+export function getEPCByLocationIdEPCResponseBodyToJSON(
+  getEPCByLocationIdEPCResponseBody: GetEPCByLocationIdEPCResponseBody,
+): string {
+  return JSON.stringify(
+    GetEPCByLocationIdEPCResponseBody$outboundSchema.parse(
+      getEPCByLocationIdEPCResponseBody,
+    ),
+  );
+}
+
+export function getEPCByLocationIdEPCResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEPCByLocationIdEPCResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEPCByLocationIdEPCResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEPCByLocationIdEPCResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEPCByLocationIdResponseBody$inboundSchema: z.ZodType<
+  GetEPCByLocationIdResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.nullable(z.any()).optional(),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetEPCByLocationIdResponseBody$Outbound = {
+  data?: any | null | undefined;
+  success: boolean;
+};
+
+/** @internal */
+export const GetEPCByLocationIdResponseBody$outboundSchema: z.ZodType<
+  GetEPCByLocationIdResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetEPCByLocationIdResponseBody
+> = z.object({
+  data: z.nullable(z.any()).optional(),
+  success: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdResponseBody$ {
+  /** @deprecated use `GetEPCByLocationIdResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdResponseBody$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetEPCByLocationIdResponseBody$outboundSchema;
+  /** @deprecated use `GetEPCByLocationIdResponseBody$Outbound` instead. */
+  export type Outbound = GetEPCByLocationIdResponseBody$Outbound;
+}
+
+export function getEPCByLocationIdResponseBodyToJSON(
+  getEPCByLocationIdResponseBody: GetEPCByLocationIdResponseBody,
+): string {
+  return JSON.stringify(
+    GetEPCByLocationIdResponseBody$outboundSchema.parse(
+      getEPCByLocationIdResponseBody,
+    ),
+  );
+}
+
+export function getEPCByLocationIdResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEPCByLocationIdResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEPCByLocationIdResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEPCByLocationIdResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetEPCByLocationIdResponse$inboundSchema: z.ZodType<
+  GetEPCByLocationIdResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetEPCByLocationIdResponseBody$inboundSchema),
+  z.lazy(() => GetEPCByLocationIdEPCResponseBody$inboundSchema),
+  z.lazy(() => GetEPCByLocationIdEPCResponseResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetEPCByLocationIdResponse$Outbound =
+  | GetEPCByLocationIdResponseBody$Outbound
+  | GetEPCByLocationIdEPCResponseBody$Outbound
+  | GetEPCByLocationIdEPCResponseResponseBody$Outbound;
+
+/** @internal */
+export const GetEPCByLocationIdResponse$outboundSchema: z.ZodType<
+  GetEPCByLocationIdResponse$Outbound,
+  z.ZodTypeDef,
+  GetEPCByLocationIdResponse
+> = z.union([
+  z.lazy(() => GetEPCByLocationIdResponseBody$outboundSchema),
+  z.lazy(() => GetEPCByLocationIdEPCResponseBody$outboundSchema),
+  z.lazy(() => GetEPCByLocationIdEPCResponseResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEPCByLocationIdResponse$ {
+  /** @deprecated use `GetEPCByLocationIdResponse$inboundSchema` instead. */
+  export const inboundSchema = GetEPCByLocationIdResponse$inboundSchema;
+  /** @deprecated use `GetEPCByLocationIdResponse$outboundSchema` instead. */
+  export const outboundSchema = GetEPCByLocationIdResponse$outboundSchema;
+  /** @deprecated use `GetEPCByLocationIdResponse$Outbound` instead. */
+  export type Outbound = GetEPCByLocationIdResponse$Outbound;
+}
+
+export function getEPCByLocationIdResponseToJSON(
+  getEPCByLocationIdResponse: GetEPCByLocationIdResponse,
+): string {
+  return JSON.stringify(
+    GetEPCByLocationIdResponse$outboundSchema.parse(getEPCByLocationIdResponse),
+  );
+}
+
+export function getEPCByLocationIdResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEPCByLocationIdResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEPCByLocationIdResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEPCByLocationIdResponse' from JSON`,
+  );
+}