@vepler/sdk 2.131.2 → 2.133.0

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

@@ -0,0 +1,542 @@
+/*
+ * 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 QueryAirQualityPointAirQualityResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryAirQualityPointAirQualityResponse503Type = OpenEnum<
+  typeof QueryAirQualityPointAirQualityResponse503Type
+>;
+
+export type QueryAirQualityPointAirQualityResponse503Error = {
+  /**
+   * 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: QueryAirQualityPointAirQualityResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type QueryAirQualityPointAirQualityResponse503ResponseBodyData = {
+  error: QueryAirQualityPointAirQualityResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class QueryAirQualityPointAirQualityResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: QueryAirQualityPointAirQualityResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryAirQualityPointAirQualityResponse503ResponseBodyData;
+
+  constructor(
+    err: QueryAirQualityPointAirQualityResponse503ResponseBodyData,
+    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 = "QueryAirQualityPointAirQualityResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryAirQualityPointAirQualityResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryAirQualityPointAirQualityResponseType = OpenEnum<
+  typeof QueryAirQualityPointAirQualityResponseType
+>;
+
+export type QueryAirQualityPointAirQualityResponseError = {
+  /**
+   * 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: QueryAirQualityPointAirQualityResponseType;
+};
+
+/**
+ * Error response
+ */
+export type QueryAirQualityPointAirQualityResponseResponseBodyData = {
+  error: QueryAirQualityPointAirQualityResponseError;
+};
+
+/**
+ * Error response
+ */
+export class QueryAirQualityPointAirQualityResponseResponseBody
+  extends SDKBaseError
+{
+  error: QueryAirQualityPointAirQualityResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryAirQualityPointAirQualityResponseResponseBodyData;
+
+  constructor(
+    err: QueryAirQualityPointAirQualityResponseResponseBodyData,
+    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 = "QueryAirQualityPointAirQualityResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryAirQualityPointAirQualityType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryAirQualityPointAirQualityType = OpenEnum<
+  typeof QueryAirQualityPointAirQualityType
+>;
+
+export type QueryAirQualityPointAirQualityError = {
+  /**
+   * 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: QueryAirQualityPointAirQualityType;
+};
+
+/**
+ * Error response
+ */
+export type QueryAirQualityPointAirQualityResponseBodyData = {
+  error: QueryAirQualityPointAirQualityError;
+};
+
+/**
+ * Error response
+ */
+export class QueryAirQualityPointAirQualityResponseBody extends SDKBaseError {
+  error: QueryAirQualityPointAirQualityError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryAirQualityPointAirQualityResponseBodyData;
+
+  constructor(
+    err: QueryAirQualityPointAirQualityResponseBodyData,
+    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 = "QueryAirQualityPointAirQualityResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryAirQualityPointType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryAirQualityPointType = OpenEnum<
+  typeof QueryAirQualityPointType
+>;
+
+export type QueryAirQualityPointError = {
+  /**
+   * 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: QueryAirQualityPointType;
+};
+
+/**
+ * Error response
+ */
+export type QueryAirQualityPointResponseBodyData = {
+  error: QueryAirQualityPointError;
+};
+
+/**
+ * Error response
+ */
+export class QueryAirQualityPointResponseBody extends SDKBaseError {
+  error: QueryAirQualityPointError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryAirQualityPointResponseBodyData;
+
+  constructor(
+    err: QueryAirQualityPointResponseBodyData,
+    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 = "QueryAirQualityPointResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponse503Type$inboundSchema:
+  z.ZodType<
+    QueryAirQualityPointAirQualityResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(QueryAirQualityPointAirQualityResponse503Type);
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponse503Error$inboundSchema:
+  z.ZodType<
+    QueryAirQualityPointAirQualityResponse503Error,
+    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: QueryAirQualityPointAirQualityResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryAirQualityPointAirQualityResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryAirQualityPointAirQualityResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryAirQualityPointAirQualityResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryAirQualityPointAirQualityResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    QueryAirQualityPointAirQualityResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryAirQualityPointAirQualityResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryAirQualityPointAirQualityResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponseType$inboundSchema:
+  z.ZodType<QueryAirQualityPointAirQualityResponseType, z.ZodTypeDef, unknown> =
+    openEnums.inboundSchema(QueryAirQualityPointAirQualityResponseType);
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponseError$inboundSchema:
+  z.ZodType<
+    QueryAirQualityPointAirQualityResponseError,
+    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: QueryAirQualityPointAirQualityResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryAirQualityPointAirQualityResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryAirQualityPointAirQualityResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryAirQualityPointAirQualityResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryAirQualityPointAirQualityResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponseResponseBody$inboundSchema:
+  z.ZodType<
+    QueryAirQualityPointAirQualityResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryAirQualityPointAirQualityResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryAirQualityPointAirQualityResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryAirQualityPointAirQualityType$inboundSchema: z.ZodType<
+  QueryAirQualityPointAirQualityType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryAirQualityPointAirQualityType);
+
+/** @internal */
+export const QueryAirQualityPointAirQualityError$inboundSchema: z.ZodType<
+  QueryAirQualityPointAirQualityError,
+  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: QueryAirQualityPointAirQualityType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryAirQualityPointAirQualityErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryAirQualityPointAirQualityError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryAirQualityPointAirQualityError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryAirQualityPointAirQualityError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryAirQualityPointAirQualityResponseBody$inboundSchema:
+  z.ZodType<QueryAirQualityPointAirQualityResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => QueryAirQualityPointAirQualityError$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new QueryAirQualityPointAirQualityResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
+/** @internal */
+export const QueryAirQualityPointType$inboundSchema: z.ZodType<
+  QueryAirQualityPointType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryAirQualityPointType);
+
+/** @internal */
+export const QueryAirQualityPointError$inboundSchema: z.ZodType<
+  QueryAirQualityPointError,
+  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: QueryAirQualityPointType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryAirQualityPointErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryAirQualityPointError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryAirQualityPointError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryAirQualityPointError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryAirQualityPointResponseBody$inboundSchema: z.ZodType<
+  QueryAirQualityPointResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryAirQualityPointError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryAirQualityPointResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -159,7 +159,7 @@ export type GetAreaCoverageMetadata = {
    * Total count of entities in source area (for intersectsWith queries)
    */
   totalEntities?: number | undefined;
-  additionalProperties?: { [k: string]: any | null } | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
 };
 
 /**

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

@@ -169,7 +169,7 @@ export type GetAreasByFieldAndIdsResult = {
   /**
    * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
    */
-  geometry?: any | null | undefined;
+  geometry?: any | undefined;
   /**
    * Geographic hierarchy showing parent areas at different administrative levels
    */
@@ -189,7 +189,7 @@ export type GetAreasByFieldAndIdsResult = {
   /**
    * Additional metadata about the area. Contents vary by geography type. Postcodes: may include household count, delivery point count. LSOAs: may include population, household count, IMD rank. Local authorities: may include population, area size. Null for geography types with no additional metadata.
    */
-  metadata?: { [k: string]: any | null } | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   /**
    * Human-readable name of the geographic area
    */
@@ -325,13 +325,13 @@ export const GetAreasByFieldAndIdsResult$inboundSchema: z.ZodType<
 > = z.object({
   areaSqm: z.nullable(z.number()).optional(),
   code: z.string(),
-  geometry: z.nullable(z.any()).optional(),
+  geometry: z.any().optional(),
   hierarchy: z.nullable(z.array(z.lazy(() => Hierarchy$inboundSchema)))
     .optional(),
   id: z.number().optional(),
   lat: z.nullable(z.number()).optional(),
   long: z.nullable(z.number()).optional(),
-  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   name: z.string(),
   relationships: z.nullable(z.array(z.lazy(() => Relationships$inboundSchema)))
     .optional(),

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

@@ -229,7 +229,7 @@ export type GetAreasWithinRadiusResult = {
   /**
    * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
    */
-  geometry?: any | null | undefined;
+  geometry?: any | undefined;
   /**
    * Geographic hierarchy showing parent areas at different administrative levels
    */
@@ -249,7 +249,7 @@ export type GetAreasWithinRadiusResult = {
   /**
    * Additional metadata about the area. Contents vary by geography type. Postcodes: may include household count, delivery point count. LSOAs: may include population, household count, IMD rank. Local authorities: may include population, area size. Null for geography types with no additional metadata.
    */
-  metadata?: { [k: string]: any | null } | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   /**
    * Human-readable name of the geographic area
    */
@@ -387,14 +387,14 @@ export const GetAreasWithinRadiusResult$inboundSchema: z.ZodType<
   areaSqm: z.nullable(z.number()).optional(),
   code: z.string(),
   distance: z.number(),
-  geometry: z.nullable(z.any()).optional(),
+  geometry: z.any().optional(),
   hierarchy: z.nullable(
     z.array(z.lazy(() => GetAreasWithinRadiusHierarchy$inboundSchema)),
   ).optional(),
   id: z.number().optional(),
   lat: z.nullable(z.number()).optional(),
   long: z.nullable(z.number()).optional(),
-  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   name: z.string(),
   relationships: z.nullable(
     z.array(z.lazy(() => GetAreasWithinRadiusRelationships$inboundSchema)),

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

@@ -151,7 +151,7 @@ export type BorderingAreas = {
   /**
    * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
    */
-  geometry?: any | null | undefined;
+  geometry?: any | undefined;
   /**
    * Geographic hierarchy showing parent areas at different administrative levels
    */
@@ -171,7 +171,7 @@ export type BorderingAreas = {
   /**
    * Additional metadata about the area. Contents vary by geography type. Postcodes: may include household count, delivery point count. LSOAs: may include population, household count, IMD rank. Local authorities: may include population, area size. Null for geography types with no additional metadata.
    */
-  metadata?: { [k: string]: any | null } | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   /**
    * Human-readable name of the geographic area
    */
@@ -315,7 +315,7 @@ export type Target = {
   /**
    * GeoJSON geometry object representing the area boundary (Polygon or MultiPolygon format)
    */
-  geometry?: any | null | undefined;
+  geometry?: any | undefined;
   /**
    * Geographic hierarchy showing parent areas at different administrative levels
    */
@@ -335,7 +335,7 @@ export type Target = {
   /**
    * Additional metadata about the area. Contents vary by geography type. Postcodes: may include household count, delivery point count. LSOAs: may include population, household count, IMD rank. Local authorities: may include population, area size. Null for geography types with no additional metadata.
    */
-  metadata?: { [k: string]: any | null } | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   /**
    * Human-readable name of the geographic area
    */
@@ -469,14 +469,14 @@ export const BorderingAreas$inboundSchema: z.ZodType<
 > = z.object({
   areaSqm: z.nullable(z.number()).optional(),
   code: z.string(),
-  geometry: z.nullable(z.any()).optional(),
+  geometry: z.any().optional(),
   hierarchy: z.nullable(
     z.array(z.lazy(() => GetBorderingAreasHierarchy$inboundSchema)),
   ).optional(),
   id: z.number().optional(),
   lat: z.nullable(z.number()).optional(),
   long: z.nullable(z.number()).optional(),
-  metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   name: z.string(),
   relationships: z.nullable(
     z.array(z.lazy(() => GetBorderingAreasRelationships$inboundSchema)),
@@ -554,14 +554,14 @@ export const Target$inboundSchema: z.ZodType<Target, z.ZodTypeDef, unknown> = z
   .object({
     areaSqm: z.nullable(z.number()).optional(),
     code: z.string(),
-    geometry: z.nullable(z.any()).optional(),
+    geometry: z.any().optional(),
     hierarchy: z.nullable(
       z.array(z.lazy(() => GetBorderingAreasAreasHierarchy$inboundSchema)),
     ).optional(),
     id: z.number().optional(),
     lat: z.nullable(z.number()).optional(),
     long: z.nullable(z.number()).optional(),
-    metadata: z.nullable(z.record(z.nullable(z.any()))).optional(),
+    metadata: z.nullable(z.record(z.any())).optional(),
     name: z.string(),
     relationships: z.nullable(
       z.array(z.lazy(() => GetBorderingAreasAreasRelationships$inboundSchema)),