@vepler/sdk 2.151.0 → 2.154.1

package/src/sdk/models/errors/queryfloodriskpoint.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 QueryFloodRiskPointFloodRiskResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryFloodRiskPointFloodRiskResponse503Type = OpenEnum<
+  typeof QueryFloodRiskPointFloodRiskResponse503Type
+>;
+
+export type QueryFloodRiskPointFloodRiskResponse503Error = {
+  /**
+   * 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: QueryFloodRiskPointFloodRiskResponse503Type;
+};
+
+/**
+ * Error response
+ */
+export type QueryFloodRiskPointFloodRiskResponse503ResponseBodyData = {
+  error: QueryFloodRiskPointFloodRiskResponse503Error;
+};
+
+/**
+ * Error response
+ */
+export class QueryFloodRiskPointFloodRiskResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: QueryFloodRiskPointFloodRiskResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryFloodRiskPointFloodRiskResponse503ResponseBodyData;
+
+  constructor(
+    err: QueryFloodRiskPointFloodRiskResponse503ResponseBodyData,
+    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 = "QueryFloodRiskPointFloodRiskResponse503ResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryFloodRiskPointFloodRiskResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryFloodRiskPointFloodRiskResponseType = OpenEnum<
+  typeof QueryFloodRiskPointFloodRiskResponseType
+>;
+
+export type QueryFloodRiskPointFloodRiskResponseError = {
+  /**
+   * 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: QueryFloodRiskPointFloodRiskResponseType;
+};
+
+/**
+ * Error response
+ */
+export type QueryFloodRiskPointFloodRiskResponseResponseBodyData = {
+  error: QueryFloodRiskPointFloodRiskResponseError;
+};
+
+/**
+ * Error response
+ */
+export class QueryFloodRiskPointFloodRiskResponseResponseBody
+  extends SDKBaseError
+{
+  error: QueryFloodRiskPointFloodRiskResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryFloodRiskPointFloodRiskResponseResponseBodyData;
+
+  constructor(
+    err: QueryFloodRiskPointFloodRiskResponseResponseBodyData,
+    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 = "QueryFloodRiskPointFloodRiskResponseResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryFloodRiskPointFloodRiskType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryFloodRiskPointFloodRiskType = OpenEnum<
+  typeof QueryFloodRiskPointFloodRiskType
+>;
+
+export type QueryFloodRiskPointFloodRiskError = {
+  /**
+   * 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: QueryFloodRiskPointFloodRiskType;
+};
+
+/**
+ * Error response
+ */
+export type QueryFloodRiskPointFloodRiskResponseBodyData = {
+  error: QueryFloodRiskPointFloodRiskError;
+};
+
+/**
+ * Error response
+ */
+export class QueryFloodRiskPointFloodRiskResponseBody extends SDKBaseError {
+  error: QueryFloodRiskPointFloodRiskError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryFloodRiskPointFloodRiskResponseBodyData;
+
+  constructor(
+    err: QueryFloodRiskPointFloodRiskResponseBodyData,
+    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 = "QueryFloodRiskPointFloodRiskResponseBody";
+  }
+}
+
+/**
+ * Error type category
+ */
+export const QueryFloodRiskPointType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Error type category
+ */
+export type QueryFloodRiskPointType = OpenEnum<typeof QueryFloodRiskPointType>;
+
+export type QueryFloodRiskPointError = {
+  /**
+   * 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: QueryFloodRiskPointType;
+};
+
+/**
+ * Error response
+ */
+export type QueryFloodRiskPointResponseBodyData = {
+  error: QueryFloodRiskPointError;
+};
+
+/**
+ * Error response
+ */
+export class QueryFloodRiskPointResponseBody extends SDKBaseError {
+  error: QueryFloodRiskPointError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryFloodRiskPointResponseBodyData;
+
+  constructor(
+    err: QueryFloodRiskPointResponseBodyData,
+    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 = "QueryFloodRiskPointResponseBody";
+  }
+}
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponse503Type$inboundSchema:
+  z.ZodType<
+    QueryFloodRiskPointFloodRiskResponse503Type,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(QueryFloodRiskPointFloodRiskResponse503Type);
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponse503Error$inboundSchema:
+  z.ZodType<
+    QueryFloodRiskPointFloodRiskResponse503Error,
+    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: QueryFloodRiskPointFloodRiskResponse503Type$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function queryFloodRiskPointFloodRiskResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryFloodRiskPointFloodRiskResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryFloodRiskPointFloodRiskResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryFloodRiskPointFloodRiskResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    QueryFloodRiskPointFloodRiskResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryFloodRiskPointFloodRiskResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryFloodRiskPointFloodRiskResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponseType$inboundSchema: z.ZodType<
+  QueryFloodRiskPointFloodRiskResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryFloodRiskPointFloodRiskResponseType);
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponseError$inboundSchema: z.ZodType<
+  QueryFloodRiskPointFloodRiskResponseError,
+  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: QueryFloodRiskPointFloodRiskResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryFloodRiskPointFloodRiskResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  QueryFloodRiskPointFloodRiskResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryFloodRiskPointFloodRiskResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'QueryFloodRiskPointFloodRiskResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponseResponseBody$inboundSchema:
+  z.ZodType<
+    QueryFloodRiskPointFloodRiskResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      QueryFloodRiskPointFloodRiskResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryFloodRiskPointFloodRiskResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskType$inboundSchema: z.ZodType<
+  QueryFloodRiskPointFloodRiskType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryFloodRiskPointFloodRiskType);
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskError$inboundSchema: z.ZodType<
+  QueryFloodRiskPointFloodRiskError,
+  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: QueryFloodRiskPointFloodRiskType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryFloodRiskPointFloodRiskErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryFloodRiskPointFloodRiskError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryFloodRiskPointFloodRiskError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryFloodRiskPointFloodRiskError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryFloodRiskPointFloodRiskResponseBody$inboundSchema: z.ZodType<
+  QueryFloodRiskPointFloodRiskResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryFloodRiskPointFloodRiskError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryFloodRiskPointFloodRiskResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export const QueryFloodRiskPointType$inboundSchema: z.ZodType<
+  QueryFloodRiskPointType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryFloodRiskPointType);
+
+/** @internal */
+export const QueryFloodRiskPointError$inboundSchema: z.ZodType<
+  QueryFloodRiskPointError,
+  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: QueryFloodRiskPointType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryFloodRiskPointErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryFloodRiskPointError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => QueryFloodRiskPointError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryFloodRiskPointError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryFloodRiskPointResponseBody$inboundSchema: z.ZodType<
+  QueryFloodRiskPointResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryFloodRiskPointError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryFloodRiskPointResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

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

@@ -12,7 +12,7 @@ import * as shared from "../shared/index.js";
 
 export type GetSchoolByIdRequest = {
   /**
-   * Comma-separated fields/blocks to return. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`. Performance/census/finance live on `/v1/schools/metrics`.
+   * Comma-separated fields/blocks to return. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks; list scalar field names to trim. Performance/census/finance live on `/v1/schools/metrics`.
    */
   attributes?: string | undefined;
   /**

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

@@ -27,7 +27,7 @@ export type PathParamProvider = ClosedEnum<typeof PathParamProvider>;
 
 export type GetSchoolBySourceRequest = {
   /**
-   * Comma-separated fields/blocks to return. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`. Performance/census/finance live on `/v1/schools/metrics`.
+   * Comma-separated fields/blocks to return. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks; list scalar field names to trim. Performance/census/finance live on `/v1/schools/metrics`.
    */
   attributes?: string | undefined;
   /**

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

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 /**
- * Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
+ * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
  */
 export type QuerySchoolsAttributes = string | Array<string>;
 
@@ -203,7 +203,7 @@ export type Within = {
  */
 export type QuerySchoolsRequestBody = {
   /**
-   * Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
+   * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
    */
   attributes?: string | Array<string> | undefined;
   /**

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

@@ -12,7 +12,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import * as shared from "../shared/index.js";
 
 /**
- * Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
+ * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
  */
 export type Attributes = string | Array<string>;
 
@@ -36,7 +36,7 @@ export type Provider = ClosedEnum<typeof Provider>;
  */
 export type QuerySchoolsBySourceRequestBody = {
   /**
-   * Fields/blocks to return per school. Default: the full flat record with no aggregate blocks. Aggregate blocks are opt-in: `inspections`.
+   * Fields/blocks to return per school. Default (omitted): the full flat record, no blocks. Aggregate blocks (`inspections`, `identifiers`, `trust`) are additive — requesting only block names keeps the full flat record and adds the blocks. List scalar field names to trim.
    */
   attributes?: string | Array<string> | undefined;
   /**

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

@@ -6,6 +6,18 @@ import * as z from "zod/v3";
 import { remap as remap$ } from "../../../lib/primitives.js";
 import { ClosedEnum } from "../../types/enums.js";
 
+/**
+ * Restrict address results to current, addressable properties only. When 'true', excludes historical and superseded address records (those without a current LPI), returning only addresses that resolve to a live property record. Defaults to 'false' (the full address universe, including historical entries). Applies to address-source results only.
+ */
+export const AddressableOnly = {
+  True: "true",
+  False: "false",
+} as const;
+/**
+ * Restrict address results to current, addressable properties only. When 'true', excludes historical and superseded address records (those without a current LPI), returning only addresses that resolve to a live property record. Defaults to 'false' (the full address universe, including historical entries). Applies to address-source results only.
+ */
+export type AddressableOnly = ClosedEnum<typeof AddressableOnly>;
+
 /**
  * Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
  */
@@ -42,6 +54,10 @@ export const GeoMode = {
 export type GeoMode = ClosedEnum<typeof GeoMode>;
 
 export type SearchSuggestRequest = {
+  /**
+   * Restrict address results to current, addressable properties only. When 'true', excludes historical and superseded address records (those without a current LPI), returning only addresses that resolve to a live property record. Defaults to 'false' (the full address universe, including historical entries). Applies to address-source results only.
+   */
+  addressableOnly?: AddressableOnly | undefined;
   /**
    * Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter, returns all address types. Defaults to 'residential'.
    */
@@ -85,6 +101,11 @@ export type SearchSuggestRequest = {
   source?: string | undefined;
 };
 
+/** @internal */
+export const AddressableOnly$outboundSchema: z.ZodNativeEnum<
+  typeof AddressableOnly
+> = z.nativeEnum(AddressableOnly);
+
 /** @internal */
 export const Classification$outboundSchema: z.ZodNativeEnum<
   typeof Classification
@@ -96,6 +117,7 @@ export const GeoMode$outboundSchema: z.ZodNativeEnum<typeof GeoMode> = z
 
 /** @internal */
 export type SearchSuggestRequest$Outbound = {
+  addressable_only?: string | undefined;
   classification?: string | undefined;
   geo_mode?: string | undefined;
   lat?: number | undefined;
@@ -113,6 +135,7 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SearchSuggestRequest
 > = z.object({
+  addressableOnly: AddressableOnly$outboundSchema.optional(),
   classification: Classification$outboundSchema.optional(),
   geoMode: GeoMode$outboundSchema.optional(),
   lat: z.number().optional(),
@@ -124,6 +147,7 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
   source: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
+    addressableOnly: "addressable_only",
     geoMode: "geo_mode",
     radiusMeters: "radius_meters",
   });