@vepler/sdk 6.61.4 → 7.1.0

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

@@ -11,6 +11,81 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetPersonClusterCompaniesResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetPersonClusterCompaniesResponse503Type = OpenEnum<
+  typeof GetPersonClusterCompaniesResponse503Type
+>;
+
+export type GetPersonClusterCompaniesResponse503Error = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetPersonClusterCompaniesResponse503Type;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetPersonClusterCompaniesResponse503ResponseBodyData = {
+  error: GetPersonClusterCompaniesResponse503Error;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetPersonClusterCompaniesResponse503ResponseBody
+  extends SDKBaseError
+{
+  error: GetPersonClusterCompaniesResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetPersonClusterCompaniesResponse503ResponseBodyData;
+
+  constructor(
+    err: GetPersonClusterCompaniesResponse503ResponseBodyData,
+    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 = "GetPersonClusterCompaniesResponse503ResponseBody";
+  }
+}
+
 /**
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
@@ -230,6 +305,69 @@ export class GetPersonClusterResponseBody extends SDKBaseError {
   }
 }
 
+/** @internal */
+export const GetPersonClusterCompaniesResponse503Type$inboundSchema: z.ZodType<
+  GetPersonClusterCompaniesResponse503Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetPersonClusterCompaniesResponse503Type);
+
+/** @internal */
+export const GetPersonClusterCompaniesResponse503Error$inboundSchema: z.ZodType<
+  GetPersonClusterCompaniesResponse503Error,
+  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: GetPersonClusterCompaniesResponse503Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getPersonClusterCompaniesResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetPersonClusterCompaniesResponse503Error,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetPersonClusterCompaniesResponse503Error$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetPersonClusterCompaniesResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPersonClusterCompaniesResponse503ResponseBody$inboundSchema:
+  z.ZodType<
+    GetPersonClusterCompaniesResponse503ResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetPersonClusterCompaniesResponse503Error$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetPersonClusterCompaniesResponse503ResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
 /** @internal */
 export const GetPersonClusterCompaniesResponseType$inboundSchema: z.ZodType<
   GetPersonClusterCompaniesResponseType,

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

@@ -11,6 +11,79 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const GetPscCompaniesResponse503Type = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type GetPscCompaniesResponse503Type = OpenEnum<
+  typeof GetPscCompaniesResponse503Type
+>;
+
+export type GetPscCompaniesResponse503Error = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: GetPscCompaniesResponse503Type;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetPscCompaniesResponse503ResponseBodyData = {
+  error: GetPscCompaniesResponse503Error;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetPscCompaniesResponse503ResponseBody extends SDKBaseError {
+  error: GetPscCompaniesResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetPscCompaniesResponse503ResponseBodyData;
+
+  constructor(
+    err: GetPscCompaniesResponse503ResponseBodyData,
+    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 = "GetPscCompaniesResponse503ResponseBody";
+  }
+}
+
 /**
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
@@ -226,6 +299,60 @@ export class GetPscResponseBody extends SDKBaseError {
   }
 }
 
+/** @internal */
+export const GetPscCompaniesResponse503Type$inboundSchema: z.ZodType<
+  GetPscCompaniesResponse503Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetPscCompaniesResponse503Type);
+
+/** @internal */
+export const GetPscCompaniesResponse503Error$inboundSchema: z.ZodType<
+  GetPscCompaniesResponse503Error,
+  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: GetPscCompaniesResponse503Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getPscCompaniesResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPscCompaniesResponse503Error, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPscCompaniesResponse503Error$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPscCompaniesResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPscCompaniesResponse503ResponseBody$inboundSchema: z.ZodType<
+  GetPscCompaniesResponse503ResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => GetPscCompaniesResponse503Error$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new GetPscCompaniesResponse503ResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
 /** @internal */
 export const GetPscCompaniesResponseType$inboundSchema: z.ZodType<
   GetPscCompaniesResponseType,

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

@@ -11,6 +11,79 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const QueryCompaniesCompaniesResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type QueryCompaniesCompaniesResponseType = OpenEnum<
+  typeof QueryCompaniesCompaniesResponseType
+>;
+
+export type QueryCompaniesCompaniesResponseError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: QueryCompaniesCompaniesResponseType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type QueryCompaniesCompaniesResponseResponseBodyData = {
+  error: QueryCompaniesCompaniesResponseError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class QueryCompaniesCompaniesResponseResponseBody extends SDKBaseError {
+  error: QueryCompaniesCompaniesResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryCompaniesCompaniesResponseResponseBodyData;
+
+  constructor(
+    err: QueryCompaniesCompaniesResponseResponseBodyData,
+    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 = "QueryCompaniesCompaniesResponseResponseBody";
+  }
+}
+
 /**
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
@@ -155,6 +228,62 @@ export class QueryCompaniesResponseBody extends SDKBaseError {
   }
 }
 
+/** @internal */
+export const QueryCompaniesCompaniesResponseType$inboundSchema: z.ZodType<
+  QueryCompaniesCompaniesResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryCompaniesCompaniesResponseType);
+
+/** @internal */
+export const QueryCompaniesCompaniesResponseError$inboundSchema: z.ZodType<
+  QueryCompaniesCompaniesResponseError,
+  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: QueryCompaniesCompaniesResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryCompaniesCompaniesResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryCompaniesCompaniesResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryCompaniesCompaniesResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryCompaniesCompaniesResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryCompaniesCompaniesResponseResponseBody$inboundSchema:
+  z.ZodType<
+    QueryCompaniesCompaniesResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() => QueryCompaniesCompaniesResponseError$inboundSchema),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new QueryCompaniesCompaniesResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
 /** @internal */
 export const QueryCompaniesCompaniesType$inboundSchema: z.ZodType<
   QueryCompaniesCompaniesType,

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

@@ -11,6 +11,79 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKBaseError } from "./sdkbaseerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export const QueryPersonsCompaniesResponseType = {
+  ApiError: "api_error",
+  InvalidRequestError: "invalid_request_error",
+  AuthenticationError: "authentication_error",
+  RateLimitError: "rate_limit_error",
+} as const;
+/**
+ * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+ */
+export type QueryPersonsCompaniesResponseType = OpenEnum<
+  typeof QueryPersonsCompaniesResponseType
+>;
+
+export type QueryPersonsCompaniesResponseError = {
+  /**
+   * Stable code identifying the specific failure, safe to branch on.
+   */
+  code?: string | undefined;
+  /**
+   * Link to the documentation for this error.
+   */
+  docUrl?: string | undefined;
+  /**
+   * Human-readable explanation of what went wrong.
+   */
+  message: string;
+  /**
+   * Name of the request parameter at fault, where the failure can be traced to one.
+   */
+  param?: string | undefined;
+  /**
+   * Alternative values worth retrying when the supplied one could not be matched.
+   */
+  suggestions?: Array<string> | undefined;
+  /**
+   * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
+   */
+  type: QueryPersonsCompaniesResponseType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type QueryPersonsCompaniesResponseResponseBodyData = {
+  error: QueryPersonsCompaniesResponseError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class QueryPersonsCompaniesResponseResponseBody extends SDKBaseError {
+  error: QueryPersonsCompaniesResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: QueryPersonsCompaniesResponseResponseBodyData;
+
+  constructor(
+    err: QueryPersonsCompaniesResponseResponseBodyData,
+    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 = "QueryPersonsCompaniesResponseResponseBody";
+  }
+}
+
 /**
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
@@ -155,6 +228,61 @@ export class QueryPersonsResponseBody extends SDKBaseError {
   }
 }
 
+/** @internal */
+export const QueryPersonsCompaniesResponseType$inboundSchema: z.ZodType<
+  QueryPersonsCompaniesResponseType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(QueryPersonsCompaniesResponseType);
+
+/** @internal */
+export const QueryPersonsCompaniesResponseError$inboundSchema: z.ZodType<
+  QueryPersonsCompaniesResponseError,
+  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: QueryPersonsCompaniesResponseType$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function queryPersonsCompaniesResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<QueryPersonsCompaniesResponseError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      QueryPersonsCompaniesResponseError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'QueryPersonsCompaniesResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const QueryPersonsCompaniesResponseResponseBody$inboundSchema: z.ZodType<
+  QueryPersonsCompaniesResponseResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.lazy(() => QueryPersonsCompaniesResponseError$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new QueryPersonsCompaniesResponseResponseBody(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
 /** @internal */
 export const QueryPersonsCompaniesType$inboundSchema: z.ZodType<
   QueryPersonsCompaniesType,

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

@@ -10,11 +10,11 @@ export type GetCompanyRequest = {
    */
   companyNumber: string;
   /**
-   * Set to `true` to add up to 50 active officer summaries to the response. Any other value leaves them out.
+   * Set to `true` to add up to 50 active officer summaries to the response. Any other value leaves them out. While officer data is not available, `true` returns 503.
    */
   includeOfficers?: string | undefined;
   /**
-   * Set to `true` to add up to 50 active PSC summaries to the response. Any other value leaves them out.
+   * Set to `true` to add up to 50 active PSC summaries to the response, with pscDataAsOf. People whose identities are protected by court order are left out. Any other value leaves them out. While PSC data is not available, `true` returns 503.
    */
   includePscs?: string | undefined;
 };

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

@@ -30,7 +30,7 @@ export type GetNearestPOIRequest = {
    */
   routing?: string | undefined;
   /**
-   * Comma-separated categories to include, for example 'education,health,transport'. Every category is returned when omitted.
+   * Comma-separated category codes to include, for example 'RETAIL,RAIL'. The accepted codes are RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL. Case and the spaces around each code are ignored, and any other code rejects the request with a 400. Every category is returned when omitted or empty.
    */
   types?: string | undefined;
 };
@@ -101,7 +101,7 @@ export type GetNearestPOILocation = {
 };
 
 /**
- * A point of interest, such as a school, a hospital or a transport hub.
+ * A point of interest, such as a shop, a station or an airport.
  */
 export type GetNearestPOIResult = {
   /**
@@ -109,7 +109,7 @@ export type GetNearestPOIResult = {
    */
   address?: string | null | undefined;
   /**
-   * Code identifying the category the place belongs to, such as `education`. Pass it in `types` to filter a search.
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL. Pass it in `types` to filter a search.
    */
   categoryId: string;
   /**

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

@@ -104,7 +104,7 @@ export type GetPOIMultipleTilesProperties = {
    */
   category?: string | undefined;
   /**
-   * Code identifying the category the place belongs to, such as `education`.
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL.
    */
   categoryId: string;
   /**

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

@@ -67,7 +67,7 @@ export type Properties = {
    */
   category?: string | undefined;
   /**
-   * Code identifying the category the place belongs to, such as `education`.
+   * Code identifying the category the place belongs to, one of RETAIL, RAIL, METRO, FERRY, AIRPORT, BUS, AIRPORT_SMALL, AIRPORT_INTERNATIONAL.
    */
   categoryId: string;
   /**