@vepler/sdk 1.10.1 → 2.3.0

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

@@ -0,0 +1,950 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export const GeographicType = {
+  Postcode: "postcode",
+  Lsoa21: "lsoa21",
+  UkOutputArea: "uk_output_area",
+  Ward: "ward",
+  Country: "country",
+  County: "county",
+  LocalAuthorityDistrict: "local_authority_district",
+  AreaNaturalBeauty: "area_natural_beauty",
+  NationalScenicArea: "national_scenic_area",
+} as const;
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export type GeographicType = ClosedEnum<typeof GeographicType>;
+
+export type GetMetricValuesRequest = {
+  category?: string | undefined;
+  endPeriod?: string | undefined;
+  geographicCode?: string | undefined;
+  /**
+   * Type of geographic entity. Options: postcode (UK postal code area), lsoa21 (Lower Layer Super Output Area 2021), uk_output_area (Census Output Area), ward (Electoral ward), country (Country level), county (County level), local_authority_district (Local authority district), area_natural_beauty (Area of Outstanding Natural Beauty), national_scenic_area (National Scenic Area in Scotland)
+   */
+  geographicType?: GeographicType | undefined;
+  includeGeographyDetails?: string | undefined;
+  includeMetricDetails?: string | undefined;
+  limit?: string | undefined;
+  metricId?: string | undefined;
+  metricName?: string | undefined;
+  offset?: string | undefined;
+  period?: string | undefined;
+  startPeriod?: string | undefined;
+};
+
+/**
+ * Error response format for failed requests
+ */
+export type GetMetricValuesMetricsResponseResponseBody = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * Detailed error information for debugging
+   */
+  details?: string | undefined;
+  /**
+   * High-level error category or message
+   */
+  error: string;
+  /**
+   * Always false for error responses
+   */
+  success: boolean;
+};
+
+/**
+ * Error response format for failed requests
+ */
+export type GetMetricValuesMetricsResponseBody = {
+  /**
+   * Machine-readable error code
+   */
+  code?: string | undefined;
+  /**
+   * Detailed error information for debugging
+   */
+  details?: string | undefined;
+  /**
+   * High-level error category or message
+   */
+  error: string;
+  /**
+   * Always false for error responses
+   */
+  success: boolean;
+};
+
+export type Pagination = {
+  hasMore: boolean;
+  limit: number;
+  offset: number;
+  total: number;
+};
+
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export const GetMetricValuesGeographicType = {
+  Postcode: "postcode",
+  Lsoa21: "lsoa21",
+  UkOutputArea: "uk_output_area",
+  Ward: "ward",
+  Country: "country",
+  County: "county",
+  LocalAuthorityDistrict: "local_authority_district",
+  AreaNaturalBeauty: "area_natural_beauty",
+  NationalScenicArea: "national_scenic_area",
+} as const;
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export type GetMetricValuesGeographicType = ClosedEnum<
+  typeof GetMetricValuesGeographicType
+>;
+
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export const GetMetricValuesType = {
+  Postcode: "postcode",
+  Lsoa21: "lsoa21",
+  UkOutputArea: "uk_output_area",
+  Ward: "ward",
+  Country: "country",
+  County: "county",
+  LocalAuthorityDistrict: "local_authority_district",
+  AreaNaturalBeauty: "area_natural_beauty",
+  NationalScenicArea: "national_scenic_area",
+} as const;
+/**
+ * Geographic hierarchy type - from smallest (output_area) to largest (country)
+ */
+export type GetMetricValuesType = ClosedEnum<typeof GetMetricValuesType>;
+
+export type Geography = {
+  code: string;
+  name: string;
+  /**
+   * Geographic hierarchy type - from smallest (output_area) to largest (country)
+   */
+  type: GetMetricValuesType;
+};
+
+export const AggregationLevel = {
+  National: "national",
+  Regional: "regional",
+  LocalAuthority: "local_authority",
+  Ward: "ward",
+  Lsoa: "lsoa",
+  OutputArea: "output_area",
+  Postcode: "postcode",
+} as const;
+export type AggregationLevel = ClosedEnum<typeof AggregationLevel>;
+
+export const Frequency = {
+  Annual: "annual",
+  Quarterly: "quarterly",
+  Monthly: "monthly",
+  Weekly: "weekly",
+  Daily: "daily",
+  OneTime: "one_time",
+  Irregular: "irregular",
+} as const;
+export type Frequency = ClosedEnum<typeof Frequency>;
+
+export type Metric = {
+  aggregationLevel: AggregationLevel | null;
+  category: string | null;
+  description: string | null;
+  frequency: Frequency | null;
+  id: number;
+  metadata?: { [k: string]: any | null } | null | undefined;
+  name: string;
+  source: string | null;
+  tags?: Array<string> | null | undefined;
+  unit: string | null;
+};
+
+export type GetMetricValuesResult = {
+  confidence: number | null;
+  createdAt: string;
+  geographicCode: string;
+  /**
+   * Geographic hierarchy type - from smallest (output_area) to largest (country)
+   */
+  geographicType: GetMetricValuesGeographicType;
+  geography?: Geography | undefined;
+  id: number;
+  metadata?: { [k: string]: any | null } | null | undefined;
+  metric?: Metric | undefined;
+  metricId: number;
+  period: string | null;
+  updatedAt: string | null;
+  value: number;
+};
+
+/**
+ * Standard response envelope for all API responses
+ */
+export type GetMetricValuesResponseBody = {
+  /**
+   * Optional message providing additional context about the response
+   */
+  message?: string | undefined;
+  pagination: Pagination;
+  result: Array<GetMetricValuesResult>;
+  /**
+   * Indicates whether the request was successful
+   */
+  success: boolean;
+};
+
+export type GetMetricValuesResponse =
+  | GetMetricValuesResponseBody
+  | GetMetricValuesMetricsResponseBody
+  | GetMetricValuesMetricsResponseResponseBody;
+
+/** @internal */
+export const GeographicType$inboundSchema: z.ZodNativeEnum<
+  typeof GeographicType
+> = z.nativeEnum(GeographicType);
+
+/** @internal */
+export const GeographicType$outboundSchema: z.ZodNativeEnum<
+  typeof GeographicType
+> = GeographicType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GeographicType$ {
+  /** @deprecated use `GeographicType$inboundSchema` instead. */
+  export const inboundSchema = GeographicType$inboundSchema;
+  /** @deprecated use `GeographicType$outboundSchema` instead. */
+  export const outboundSchema = GeographicType$outboundSchema;
+}
+
+/** @internal */
+export const GetMetricValuesRequest$inboundSchema: z.ZodType<
+  GetMetricValuesRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  category: z.string().optional(),
+  endPeriod: z.string().optional(),
+  geographicCode: z.string().optional(),
+  geographicType: GeographicType$inboundSchema.optional(),
+  includeGeographyDetails: z.string().optional(),
+  includeMetricDetails: z.string().optional(),
+  limit: z.string().default("100"),
+  metricId: z.string().optional(),
+  metricName: z.string().optional(),
+  offset: z.string().default("0"),
+  period: z.string().optional(),
+  startPeriod: z.string().optional(),
+});
+
+/** @internal */
+export type GetMetricValuesRequest$Outbound = {
+  category?: string | undefined;
+  endPeriod?: string | undefined;
+  geographicCode?: string | undefined;
+  geographicType?: string | undefined;
+  includeGeographyDetails?: string | undefined;
+  includeMetricDetails?: string | undefined;
+  limit: string;
+  metricId?: string | undefined;
+  metricName?: string | undefined;
+  offset: string;
+  period?: string | undefined;
+  startPeriod?: string | undefined;
+};
+
+/** @internal */
+export const GetMetricValuesRequest$outboundSchema: z.ZodType<
+  GetMetricValuesRequest$Outbound,
+  z.ZodTypeDef,
+  GetMetricValuesRequest
+> = z.object({
+  category: z.string().optional(),
+  endPeriod: z.string().optional(),
+  geographicCode: z.string().optional(),
+  geographicType: GeographicType$outboundSchema.optional(),
+  includeGeographyDetails: z.string().optional(),
+  includeMetricDetails: z.string().optional(),
+  limit: z.string().default("100"),
+  metricId: z.string().optional(),
+  metricName: z.string().optional(),
+  offset: z.string().default("0"),
+  period: z.string().optional(),
+  startPeriod: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMetricValuesRequest$ {
+  /** @deprecated use `GetMetricValuesRequest$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesRequest$inboundSchema;
+  /** @deprecated use `GetMetricValuesRequest$outboundSchema` instead. */
+  export const outboundSchema = GetMetricValuesRequest$outboundSchema;
+  /** @deprecated use `GetMetricValuesRequest$Outbound` instead. */
+  export type Outbound = GetMetricValuesRequest$Outbound;
+}
+
+export function getMetricValuesRequestToJSON(
+  getMetricValuesRequest: GetMetricValuesRequest,
+): string {
+  return JSON.stringify(
+    GetMetricValuesRequest$outboundSchema.parse(getMetricValuesRequest),
+  );
+}
+
+export function getMetricValuesRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMetricValuesRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetMetricValuesRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMetricValuesRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMetricValuesMetricsResponseResponseBody$inboundSchema:
+  z.ZodType<GetMetricValuesMetricsResponseResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      code: z.string().optional(),
+      details: z.string().optional(),
+      error: z.string(),
+      success: z.boolean(),
+    });
+
+/** @internal */
+export type GetMetricValuesMetricsResponseResponseBody$Outbound = {
+  code?: string | undefined;
+  details?: string | undefined;
+  error: string;
+  success: boolean;
+};
+
+/** @internal */
+export const GetMetricValuesMetricsResponseResponseBody$outboundSchema:
+  z.ZodType<
+    GetMetricValuesMetricsResponseResponseBody$Outbound,
+    z.ZodTypeDef,
+    GetMetricValuesMetricsResponseResponseBody
+  > = z.object({
+    code: z.string().optional(),
+    details: z.string().optional(),
+    error: z.string(),
+    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 GetMetricValuesMetricsResponseResponseBody$ {
+  /** @deprecated use `GetMetricValuesMetricsResponseResponseBody$inboundSchema` instead. */
+  export const inboundSchema =
+    GetMetricValuesMetricsResponseResponseBody$inboundSchema;
+  /** @deprecated use `GetMetricValuesMetricsResponseResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetMetricValuesMetricsResponseResponseBody$outboundSchema;
+  /** @deprecated use `GetMetricValuesMetricsResponseResponseBody$Outbound` instead. */
+  export type Outbound = GetMetricValuesMetricsResponseResponseBody$Outbound;
+}
+
+export function getMetricValuesMetricsResponseResponseBodyToJSON(
+  getMetricValuesMetricsResponseResponseBody:
+    GetMetricValuesMetricsResponseResponseBody,
+): string {
+  return JSON.stringify(
+    GetMetricValuesMetricsResponseResponseBody$outboundSchema.parse(
+      getMetricValuesMetricsResponseResponseBody,
+    ),
+  );
+}
+
+export function getMetricValuesMetricsResponseResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetMetricValuesMetricsResponseResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetMetricValuesMetricsResponseResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetMetricValuesMetricsResponseResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMetricValuesMetricsResponseBody$inboundSchema: z.ZodType<
+  GetMetricValuesMetricsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string().optional(),
+  details: z.string().optional(),
+  error: z.string(),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetMetricValuesMetricsResponseBody$Outbound = {
+  code?: string | undefined;
+  details?: string | undefined;
+  error: string;
+  success: boolean;
+};
+
+/** @internal */
+export const GetMetricValuesMetricsResponseBody$outboundSchema: z.ZodType<
+  GetMetricValuesMetricsResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetMetricValuesMetricsResponseBody
+> = z.object({
+  code: z.string().optional(),
+  details: z.string().optional(),
+  error: z.string(),
+  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 GetMetricValuesMetricsResponseBody$ {
+  /** @deprecated use `GetMetricValuesMetricsResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesMetricsResponseBody$inboundSchema;
+  /** @deprecated use `GetMetricValuesMetricsResponseBody$outboundSchema` instead. */
+  export const outboundSchema =
+    GetMetricValuesMetricsResponseBody$outboundSchema;
+  /** @deprecated use `GetMetricValuesMetricsResponseBody$Outbound` instead. */
+  export type Outbound = GetMetricValuesMetricsResponseBody$Outbound;
+}
+
+export function getMetricValuesMetricsResponseBodyToJSON(
+  getMetricValuesMetricsResponseBody: GetMetricValuesMetricsResponseBody,
+): string {
+  return JSON.stringify(
+    GetMetricValuesMetricsResponseBody$outboundSchema.parse(
+      getMetricValuesMetricsResponseBody,
+    ),
+  );
+}
+
+export function getMetricValuesMetricsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMetricValuesMetricsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetMetricValuesMetricsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMetricValuesMetricsResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const Pagination$inboundSchema: z.ZodType<
+  Pagination,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hasMore: z.boolean(),
+  limit: z.number(),
+  offset: z.number(),
+  total: z.number(),
+});
+
+/** @internal */
+export type Pagination$Outbound = {
+  hasMore: boolean;
+  limit: number;
+  offset: number;
+  total: number;
+};
+
+/** @internal */
+export const Pagination$outboundSchema: z.ZodType<
+  Pagination$Outbound,
+  z.ZodTypeDef,
+  Pagination
+> = z.object({
+  hasMore: z.boolean(),
+  limit: z.number(),
+  offset: z.number(),
+  total: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Pagination$ {
+  /** @deprecated use `Pagination$inboundSchema` instead. */
+  export const inboundSchema = Pagination$inboundSchema;
+  /** @deprecated use `Pagination$outboundSchema` instead. */
+  export const outboundSchema = Pagination$outboundSchema;
+  /** @deprecated use `Pagination$Outbound` instead. */
+  export type Outbound = Pagination$Outbound;
+}
+
+export function paginationToJSON(pagination: Pagination): string {
+  return JSON.stringify(Pagination$outboundSchema.parse(pagination));
+}
+
+export function paginationFromJSON(
+  jsonString: string,
+): SafeParseResult<Pagination, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Pagination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Pagination' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMetricValuesGeographicType$inboundSchema: z.ZodNativeEnum<
+  typeof GetMetricValuesGeographicType
+> = z.nativeEnum(GetMetricValuesGeographicType);
+
+/** @internal */
+export const GetMetricValuesGeographicType$outboundSchema: z.ZodNativeEnum<
+  typeof GetMetricValuesGeographicType
+> = GetMetricValuesGeographicType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMetricValuesGeographicType$ {
+  /** @deprecated use `GetMetricValuesGeographicType$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesGeographicType$inboundSchema;
+  /** @deprecated use `GetMetricValuesGeographicType$outboundSchema` instead. */
+  export const outboundSchema = GetMetricValuesGeographicType$outboundSchema;
+}
+
+/** @internal */
+export const GetMetricValuesType$inboundSchema: z.ZodNativeEnum<
+  typeof GetMetricValuesType
+> = z.nativeEnum(GetMetricValuesType);
+
+/** @internal */
+export const GetMetricValuesType$outboundSchema: z.ZodNativeEnum<
+  typeof GetMetricValuesType
+> = GetMetricValuesType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMetricValuesType$ {
+  /** @deprecated use `GetMetricValuesType$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesType$inboundSchema;
+  /** @deprecated use `GetMetricValuesType$outboundSchema` instead. */
+  export const outboundSchema = GetMetricValuesType$outboundSchema;
+}
+
+/** @internal */
+export const Geography$inboundSchema: z.ZodType<
+  Geography,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  name: z.string(),
+  type: GetMetricValuesType$inboundSchema,
+});
+
+/** @internal */
+export type Geography$Outbound = {
+  code: string;
+  name: string;
+  type: string;
+};
+
+/** @internal */
+export const Geography$outboundSchema: z.ZodType<
+  Geography$Outbound,
+  z.ZodTypeDef,
+  Geography
+> = z.object({
+  code: z.string(),
+  name: z.string(),
+  type: GetMetricValuesType$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Geography$ {
+  /** @deprecated use `Geography$inboundSchema` instead. */
+  export const inboundSchema = Geography$inboundSchema;
+  /** @deprecated use `Geography$outboundSchema` instead. */
+  export const outboundSchema = Geography$outboundSchema;
+  /** @deprecated use `Geography$Outbound` instead. */
+  export type Outbound = Geography$Outbound;
+}
+
+export function geographyToJSON(geography: Geography): string {
+  return JSON.stringify(Geography$outboundSchema.parse(geography));
+}
+
+export function geographyFromJSON(
+  jsonString: string,
+): SafeParseResult<Geography, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Geography$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Geography' from JSON`,
+  );
+}
+
+/** @internal */
+export const AggregationLevel$inboundSchema: z.ZodNativeEnum<
+  typeof AggregationLevel
+> = z.nativeEnum(AggregationLevel);
+
+/** @internal */
+export const AggregationLevel$outboundSchema: z.ZodNativeEnum<
+  typeof AggregationLevel
+> = AggregationLevel$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AggregationLevel$ {
+  /** @deprecated use `AggregationLevel$inboundSchema` instead. */
+  export const inboundSchema = AggregationLevel$inboundSchema;
+  /** @deprecated use `AggregationLevel$outboundSchema` instead. */
+  export const outboundSchema = AggregationLevel$outboundSchema;
+}
+
+/** @internal */
+export const Frequency$inboundSchema: z.ZodNativeEnum<typeof Frequency> = z
+  .nativeEnum(Frequency);
+
+/** @internal */
+export const Frequency$outboundSchema: z.ZodNativeEnum<typeof Frequency> =
+  Frequency$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Frequency$ {
+  /** @deprecated use `Frequency$inboundSchema` instead. */
+  export const inboundSchema = Frequency$inboundSchema;
+  /** @deprecated use `Frequency$outboundSchema` instead. */
+  export const outboundSchema = Frequency$outboundSchema;
+}
+
+/** @internal */
+export const Metric$inboundSchema: z.ZodType<Metric, z.ZodTypeDef, unknown> = z
+  .object({
+    aggregationLevel: z.nullable(AggregationLevel$inboundSchema),
+    category: z.nullable(z.string()),
+    description: z.nullable(z.string()),
+    frequency: z.nullable(Frequency$inboundSchema),
+    id: z.number(),
+    metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+    name: z.string(),
+    source: z.nullable(z.string()),
+    tags: z.nullable(z.array(z.string())).optional(),
+    unit: z.nullable(z.string()),
+  });
+
+/** @internal */
+export type Metric$Outbound = {
+  aggregationLevel: string | null;
+  category: string | null;
+  description: string | null;
+  frequency: string | null;
+  id: number;
+  metadata?: { [k: string]: any | null } | null | undefined;
+  name: string;
+  source: string | null;
+  tags?: Array<string> | null | undefined;
+  unit: string | null;
+};
+
+/** @internal */
+export const Metric$outboundSchema: z.ZodType<
+  Metric$Outbound,
+  z.ZodTypeDef,
+  Metric
+> = z.object({
+  aggregationLevel: z.nullable(AggregationLevel$outboundSchema),
+  category: z.nullable(z.string()),
+  description: z.nullable(z.string()),
+  frequency: z.nullable(Frequency$outboundSchema),
+  id: z.number(),
+  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  name: z.string(),
+  source: z.nullable(z.string()),
+  tags: z.nullable(z.array(z.string())).optional(),
+  unit: z.nullable(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 Metric$ {
+  /** @deprecated use `Metric$inboundSchema` instead. */
+  export const inboundSchema = Metric$inboundSchema;
+  /** @deprecated use `Metric$outboundSchema` instead. */
+  export const outboundSchema = Metric$outboundSchema;
+  /** @deprecated use `Metric$Outbound` instead. */
+  export type Outbound = Metric$Outbound;
+}
+
+export function metricToJSON(metric: Metric): string {
+  return JSON.stringify(Metric$outboundSchema.parse(metric));
+}
+
+export function metricFromJSON(
+  jsonString: string,
+): SafeParseResult<Metric, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Metric$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metric' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMetricValuesResult$inboundSchema: z.ZodType<
+  GetMetricValuesResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidence: z.nullable(z.number()),
+  createdAt: z.string(),
+  geographicCode: z.string(),
+  geographicType: GetMetricValuesGeographicType$inboundSchema,
+  geography: z.lazy(() => Geography$inboundSchema).optional(),
+  id: z.number(),
+  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  metric: z.lazy(() => Metric$inboundSchema).optional(),
+  metricId: z.number(),
+  period: z.nullable(z.string()),
+  updatedAt: z.nullable(z.string()),
+  value: z.number(),
+});
+
+/** @internal */
+export type GetMetricValuesResult$Outbound = {
+  confidence: number | null;
+  createdAt: string;
+  geographicCode: string;
+  geographicType: string;
+  geography?: Geography$Outbound | undefined;
+  id: number;
+  metadata?: { [k: string]: any | null } | null | undefined;
+  metric?: Metric$Outbound | undefined;
+  metricId: number;
+  period: string | null;
+  updatedAt: string | null;
+  value: number;
+};
+
+/** @internal */
+export const GetMetricValuesResult$outboundSchema: z.ZodType<
+  GetMetricValuesResult$Outbound,
+  z.ZodTypeDef,
+  GetMetricValuesResult
+> = z.object({
+  confidence: z.nullable(z.number()),
+  createdAt: z.string(),
+  geographicCode: z.string(),
+  geographicType: GetMetricValuesGeographicType$outboundSchema,
+  geography: z.lazy(() => Geography$outboundSchema).optional(),
+  id: z.number(),
+  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  metric: z.lazy(() => Metric$outboundSchema).optional(),
+  metricId: z.number(),
+  period: z.nullable(z.string()),
+  updatedAt: z.nullable(z.string()),
+  value: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMetricValuesResult$ {
+  /** @deprecated use `GetMetricValuesResult$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesResult$inboundSchema;
+  /** @deprecated use `GetMetricValuesResult$outboundSchema` instead. */
+  export const outboundSchema = GetMetricValuesResult$outboundSchema;
+  /** @deprecated use `GetMetricValuesResult$Outbound` instead. */
+  export type Outbound = GetMetricValuesResult$Outbound;
+}
+
+export function getMetricValuesResultToJSON(
+  getMetricValuesResult: GetMetricValuesResult,
+): string {
+  return JSON.stringify(
+    GetMetricValuesResult$outboundSchema.parse(getMetricValuesResult),
+  );
+}
+
+export function getMetricValuesResultFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMetricValuesResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetMetricValuesResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMetricValuesResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMetricValuesResponseBody$inboundSchema: z.ZodType<
+  GetMetricValuesResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  message: z.string().optional(),
+  pagination: z.lazy(() => Pagination$inboundSchema),
+  result: z.array(z.lazy(() => GetMetricValuesResult$inboundSchema)),
+  success: z.boolean(),
+});
+
+/** @internal */
+export type GetMetricValuesResponseBody$Outbound = {
+  message?: string | undefined;
+  pagination: Pagination$Outbound;
+  result: Array<GetMetricValuesResult$Outbound>;
+  success: boolean;
+};
+
+/** @internal */
+export const GetMetricValuesResponseBody$outboundSchema: z.ZodType<
+  GetMetricValuesResponseBody$Outbound,
+  z.ZodTypeDef,
+  GetMetricValuesResponseBody
+> = z.object({
+  message: z.string().optional(),
+  pagination: z.lazy(() => Pagination$outboundSchema),
+  result: z.array(z.lazy(() => GetMetricValuesResult$outboundSchema)),
+  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 GetMetricValuesResponseBody$ {
+  /** @deprecated use `GetMetricValuesResponseBody$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesResponseBody$inboundSchema;
+  /** @deprecated use `GetMetricValuesResponseBody$outboundSchema` instead. */
+  export const outboundSchema = GetMetricValuesResponseBody$outboundSchema;
+  /** @deprecated use `GetMetricValuesResponseBody$Outbound` instead. */
+  export type Outbound = GetMetricValuesResponseBody$Outbound;
+}
+
+export function getMetricValuesResponseBodyToJSON(
+  getMetricValuesResponseBody: GetMetricValuesResponseBody,
+): string {
+  return JSON.stringify(
+    GetMetricValuesResponseBody$outboundSchema.parse(
+      getMetricValuesResponseBody,
+    ),
+  );
+}
+
+export function getMetricValuesResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMetricValuesResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetMetricValuesResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMetricValuesResponseBody' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMetricValuesResponse$inboundSchema: z.ZodType<
+  GetMetricValuesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => GetMetricValuesResponseBody$inboundSchema),
+  z.lazy(() => GetMetricValuesMetricsResponseBody$inboundSchema),
+  z.lazy(() => GetMetricValuesMetricsResponseResponseBody$inboundSchema),
+]);
+
+/** @internal */
+export type GetMetricValuesResponse$Outbound =
+  | GetMetricValuesResponseBody$Outbound
+  | GetMetricValuesMetricsResponseBody$Outbound
+  | GetMetricValuesMetricsResponseResponseBody$Outbound;
+
+/** @internal */
+export const GetMetricValuesResponse$outboundSchema: z.ZodType<
+  GetMetricValuesResponse$Outbound,
+  z.ZodTypeDef,
+  GetMetricValuesResponse
+> = z.union([
+  z.lazy(() => GetMetricValuesResponseBody$outboundSchema),
+  z.lazy(() => GetMetricValuesMetricsResponseBody$outboundSchema),
+  z.lazy(() => GetMetricValuesMetricsResponseResponseBody$outboundSchema),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMetricValuesResponse$ {
+  /** @deprecated use `GetMetricValuesResponse$inboundSchema` instead. */
+  export const inboundSchema = GetMetricValuesResponse$inboundSchema;
+  /** @deprecated use `GetMetricValuesResponse$outboundSchema` instead. */
+  export const outboundSchema = GetMetricValuesResponse$outboundSchema;
+  /** @deprecated use `GetMetricValuesResponse$Outbound` instead. */
+  export type Outbound = GetMetricValuesResponse$Outbound;
+}
+
+export function getMetricValuesResponseToJSON(
+  getMetricValuesResponse: GetMetricValuesResponse,
+): string {
+  return JSON.stringify(
+    GetMetricValuesResponse$outboundSchema.parse(getMetricValuesResponse),
+  );
+}
+
+export function getMetricValuesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMetricValuesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetMetricValuesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMetricValuesResponse' from JSON`,
+  );
+}