@vepler/sdk 6.66.0 → 7.1.0

package/src/funcs/companiesGetPerson.ts

@@ -43,6 +43,7 @@ export function companiesGetPerson(
     | errors.GetPersonResponseBody
     | errors.GetPersonCompaniesResponseBody
     | errors.GetPersonCompaniesResponseResponseBody
+    | errors.GetPersonCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPersonResponseBody
       | errors.GetPersonCompaniesResponseBody
       | errors.GetPersonCompaniesResponseResponseBody
+      | errors.GetPersonCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -161,6 +163,7 @@ async function $do(
     | errors.GetPersonResponseBody
     | errors.GetPersonCompaniesResponseBody
     | errors.GetPersonCompaniesResponseResponseBody
+    | errors.GetPersonCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -174,6 +177,10 @@ async function $do(
     M.jsonErr(400, errors.GetPersonResponseBody$inboundSchema),
     M.jsonErr(404, errors.GetPersonCompaniesResponseBody$inboundSchema),
     M.jsonErr(500, errors.GetPersonCompaniesResponseResponseBody$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.GetPersonCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPersonAppointments.ts

@@ -43,6 +43,7 @@ export function companiesGetPersonAppointments(
     | errors.GetPersonAppointmentsResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseResponseBody
+    | errors.GetPersonAppointmentsCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPersonAppointmentsResponseBody
       | errors.GetPersonAppointmentsCompaniesResponseBody
       | errors.GetPersonAppointmentsCompaniesResponseResponseBody
+      | errors.GetPersonAppointmentsCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -171,6 +173,7 @@ async function $do(
     | errors.GetPersonAppointmentsResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseBody
     | errors.GetPersonAppointmentsCompaniesResponseResponseBody
+    | errors.GetPersonAppointmentsCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -190,6 +193,11 @@ async function $do(
       500,
       errors.GetPersonAppointmentsCompaniesResponseResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors
+        .GetPersonAppointmentsCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPersonCluster.ts

@@ -43,6 +43,7 @@ export function companiesGetPersonCluster(
     | errors.GetPersonClusterResponseBody
     | errors.GetPersonClusterCompaniesResponseBody
     | errors.GetPersonClusterCompaniesResponseResponseBody
+    | errors.GetPersonClusterCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPersonClusterResponseBody
       | errors.GetPersonClusterCompaniesResponseBody
       | errors.GetPersonClusterCompaniesResponseResponseBody
+      | errors.GetPersonClusterCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -163,6 +165,7 @@ async function $do(
     | errors.GetPersonClusterResponseBody
     | errors.GetPersonClusterCompaniesResponseBody
     | errors.GetPersonClusterCompaniesResponseResponseBody
+    | errors.GetPersonClusterCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -179,6 +182,10 @@ async function $do(
       500,
       errors.GetPersonClusterCompaniesResponseResponseBody$inboundSchema,
     ),
+    M.jsonErr(
+      503,
+      errors.GetPersonClusterCompaniesResponse503ResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesGetPsc.ts

@@ -43,6 +43,7 @@ export function companiesGetPsc(
     | errors.GetPscResponseBody
     | errors.GetPscCompaniesResponseBody
     | errors.GetPscCompaniesResponseResponseBody
+    | errors.GetPscCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -71,6 +72,7 @@ async function $do(
       | errors.GetPscResponseBody
       | errors.GetPscCompaniesResponseBody
       | errors.GetPscCompaniesResponseResponseBody
+      | errors.GetPscCompaniesResponse503ResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -161,6 +163,7 @@ async function $do(
     | errors.GetPscResponseBody
     | errors.GetPscCompaniesResponseBody
     | errors.GetPscCompaniesResponseResponseBody
+    | errors.GetPscCompaniesResponse503ResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -174,6 +177,7 @@ async function $do(
     M.jsonErr(400, errors.GetPscResponseBody$inboundSchema),
     M.jsonErr(404, errors.GetPscCompaniesResponseBody$inboundSchema),
     M.jsonErr(500, errors.GetPscCompaniesResponseResponseBody$inboundSchema),
+    M.jsonErr(503, errors.GetPscCompaniesResponse503ResponseBody$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesQueryCompanies.ts

@@ -30,17 +30,18 @@ import { Result } from "../sdk/types/fp.js";
  * Search companies with filters
  *
  * @remarks
- * Searches the company register by name, number, status, type, jurisdiction, SIC code, location, incorporation date and the charge and insolvency flags. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
+ * Searches the company register by name, number, status, type, SIC code, location, incorporation date and the charges flag. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
  */
 export function companiesQueryCompanies(
   client: SDKCore,
-  request?: shared.CompanyQueryRequest | undefined,
+  request: shared.CompanyQueryRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
     shared.CompanyListResponse,
     | errors.QueryCompaniesResponseBody
     | errors.QueryCompaniesCompaniesResponseBody
+    | errors.QueryCompaniesCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -60,7 +61,7 @@ export function companiesQueryCompanies(
 
 async function $do(
   client: SDKCore,
-  request?: shared.CompanyQueryRequest | undefined,
+  request: shared.CompanyQueryRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -68,6 +69,7 @@ async function $do(
       shared.CompanyListResponse,
       | errors.QueryCompaniesResponseBody
       | errors.QueryCompaniesCompaniesResponseBody
+      | errors.QueryCompaniesCompaniesResponseResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -82,17 +84,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      shared.CompanyQueryRequest$outboundSchema.optional().parse(value),
+    (value) => shared.CompanyQueryRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/v1/companies/query")();
 
@@ -155,6 +154,7 @@ async function $do(
     shared.CompanyListResponse,
     | errors.QueryCompaniesResponseBody
     | errors.QueryCompaniesCompaniesResponseBody
+    | errors.QueryCompaniesCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -167,6 +167,10 @@ async function $do(
     M.json(200, shared.CompanyListResponse$inboundSchema),
     M.jsonErr(400, errors.QueryCompaniesResponseBody$inboundSchema),
     M.jsonErr(500, errors.QueryCompaniesCompaniesResponseBody$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.QueryCompaniesCompaniesResponseResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/funcs/companiesQueryPersons.ts

@@ -41,6 +41,7 @@ export function companiesQueryPersons(
     shared.PersonListResponse,
     | errors.QueryPersonsResponseBody
     | errors.QueryPersonsCompaniesResponseBody
+    | errors.QueryPersonsCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -68,6 +69,7 @@ async function $do(
       shared.PersonListResponse,
       | errors.QueryPersonsResponseBody
       | errors.QueryPersonsCompaniesResponseBody
+      | errors.QueryPersonsCompaniesResponseResponseBody
       | SDKBaseError
       | ResponseValidationError
       | ConnectionError
@@ -154,6 +156,7 @@ async function $do(
     shared.PersonListResponse,
     | errors.QueryPersonsResponseBody
     | errors.QueryPersonsCompaniesResponseBody
+    | errors.QueryPersonsCompaniesResponseResponseBody
     | SDKBaseError
     | ResponseValidationError
     | ConnectionError
@@ -166,6 +169,10 @@ async function $do(
     M.json(200, shared.PersonListResponse$inboundSchema),
     M.jsonErr(400, errors.QueryPersonsResponseBody$inboundSchema),
     M.jsonErr(500, errors.QueryPersonsCompaniesResponseBody$inboundSchema),
+    M.jsonErr(
+      503,
+      errors.QueryPersonsCompaniesResponseResponseBody$inboundSchema,
+    ),
     M.fail("4XX"),
     M.fail("5XX"),
   )(response, req, { extraFields: responseFields });

package/src/lib/config.ts

@@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "6.66.0",
+  openapiDocVersion: "7.1.0",
   sdkVersion: "0.12.0",
   genVersion: "2.954.8",
-  userAgent: "speakeasy-sdk/typescript 0.12.0 2.954.8 6.66.0 @vepler/sdk",
+  userAgent: "speakeasy-sdk/typescript 0.12.0 2.954.8 7.1.0 @vepler/sdk",
 } as const;

package/src/sdk/companies.ts

@@ -40,7 +40,7 @@ export class Companies extends ClientSDK {
    * Get company by registration number
    *
    * @remarks
-   * Returns the full company record held on the Companies House register for one eight-character registration number, including its status, type, registered office and filing dates. Set includeOfficers=true or includePscs=true to add up to 50 active officer or PSC summaries.
+   * Returns the full company record held on the Companies House register for one eight-character registration number, including its status, type, registered office and filing dates. Set includeOfficers=true or includePscs=true to add up to 50 active officer or PSC summaries; while that data is not available the request returns 503 rather than leaving them out.
    */
   async getCompany(
     request: operations.GetCompanyRequest,
@@ -74,7 +74,7 @@ export class Companies extends ClientSDK {
    * Get persons with significant control for a company
    *
    * @remarks
-   * Returns the people and entities with significant control over a company, as defined by Part 21A of the Companies Act 2006, covering individuals, corporate entities and other legal persons. People whose identities are protected by court order are left out unless excludeSuperSecure is set to `false`.
+   * Returns the people and entities with significant control over a company, as defined by Part 21A of the Companies Act 2006, covering individuals, corporate entities and other legal persons. People whose identities are protected by court order are left out unless excludeSuperSecure is set to `false`. Companies known from PSC data alone are answered too, with companyInRegister false. Returns 503 while PSC data is not available.
    */
   async getCompanyPscs(
     request: operations.GetCompanyPscsRequest,
@@ -176,10 +176,10 @@ export class Companies extends ClientSDK {
    * Search companies with filters
    *
    * @remarks
-   * Searches the company register by name, number, status, type, jurisdiction, SIC code, location, incorporation date and the charge and insolvency flags. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
+   * Searches the company register by name, number, status, type, SIC code, location, incorporation date and the charges flag. Returns a page of company summaries with the total number of matches; limit accepts up to 100 results per page. Officers, PSCs and the registered office address are not part of a search result.
    */
   async queryCompanies(
-    request?: shared.CompanyQueryRequest | undefined,
+    request: shared.CompanyQueryRequest,
     options?: RequestOptions,
   ): Promise<shared.CompanyListResponse> {
     return unwrapAsync(companiesQueryCompanies(

package/src/sdk/models/errors/getcompaniesbylocation.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 GetCompaniesByLocationCompaniesResponseType = {
+  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 GetCompaniesByLocationCompaniesResponseType = OpenEnum<
+  typeof GetCompaniesByLocationCompaniesResponseType
+>;
+
+export type GetCompaniesByLocationCompaniesResponseError = {
+  /**
+   * 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: GetCompaniesByLocationCompaniesResponseType;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetCompaniesByLocationCompaniesResponseResponseBodyData = {
+  error: GetCompaniesByLocationCompaniesResponseError;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetCompaniesByLocationCompaniesResponseResponseBody
+  extends SDKBaseError
+{
+  error: GetCompaniesByLocationCompaniesResponseError;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCompaniesByLocationCompaniesResponseResponseBodyData;
+
+  constructor(
+    err: GetCompaniesByLocationCompaniesResponseResponseBodyData,
+    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 = "GetCompaniesByLocationCompaniesResponseResponseBody";
+  }
+}
+
 /**
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
@@ -157,6 +232,71 @@ export class GetCompaniesByLocationResponseBody extends SDKBaseError {
   }
 }
 
+/** @internal */
+export const GetCompaniesByLocationCompaniesResponseType$inboundSchema:
+  z.ZodType<
+    GetCompaniesByLocationCompaniesResponseType,
+    z.ZodTypeDef,
+    unknown
+  > = openEnums.inboundSchema(GetCompaniesByLocationCompaniesResponseType);
+
+/** @internal */
+export const GetCompaniesByLocationCompaniesResponseError$inboundSchema:
+  z.ZodType<
+    GetCompaniesByLocationCompaniesResponseError,
+    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: GetCompaniesByLocationCompaniesResponseType$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "doc_url": "docUrl",
+    });
+  });
+
+export function getCompaniesByLocationCompaniesResponseErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetCompaniesByLocationCompaniesResponseError,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCompaniesByLocationCompaniesResponseError$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetCompaniesByLocationCompaniesResponseError' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCompaniesByLocationCompaniesResponseResponseBody$inboundSchema:
+  z.ZodType<
+    GetCompaniesByLocationCompaniesResponseResponseBody,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    error: z.lazy(() =>
+      GetCompaniesByLocationCompaniesResponseError$inboundSchema
+    ),
+    request$: z.instanceof(Request),
+    response$: z.instanceof(Response),
+    body$: z.string(),
+  })
+    .transform((v) => {
+      return new GetCompaniesByLocationCompaniesResponseResponseBody(v, {
+        request: v.request$,
+        response: v.response$,
+        body: v.body$,
+      });
+    });
+
 /** @internal */
 export const GetCompaniesByLocationCompaniesType$inboundSchema: z.ZodType<
   GetCompaniesByLocationCompaniesType,

package/src/sdk/models/errors/getcompany.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 GetCompanyCompaniesResponse503Type = {
+  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 GetCompanyCompaniesResponse503Type = OpenEnum<
+  typeof GetCompanyCompaniesResponse503Type
+>;
+
+export type GetCompanyCompaniesResponse503Error = {
+  /**
+   * 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: GetCompanyCompaniesResponse503Type;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export type GetCompanyCompaniesResponse503ResponseBodyData = {
+  error: GetCompanyCompaniesResponse503Error;
+};
+
+/**
+ * Returned in place of the normal payload whenever a request fails.
+ */
+export class GetCompanyCompaniesResponse503ResponseBody extends SDKBaseError {
+  error: GetCompanyCompaniesResponse503Error;
+
+  /** The original data that was passed to this error instance. */
+  data$: GetCompanyCompaniesResponse503ResponseBodyData;
+
+  constructor(
+    err: GetCompanyCompaniesResponse503ResponseBodyData,
+    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 = "GetCompanyCompaniesResponse503ResponseBody";
+  }
+}
+
 /**
  * Broad category of the failure: a malformed request, an authentication problem, a rate limit, or a fault on the server side.
  */
@@ -226,6 +299,59 @@ export class GetCompanyResponseBody extends SDKBaseError {
   }
 }
 
+/** @internal */
+export const GetCompanyCompaniesResponse503Type$inboundSchema: z.ZodType<
+  GetCompanyCompaniesResponse503Type,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(GetCompanyCompaniesResponse503Type);
+
+/** @internal */
+export const GetCompanyCompaniesResponse503Error$inboundSchema: z.ZodType<
+  GetCompanyCompaniesResponse503Error,
+  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: GetCompanyCompaniesResponse503Type$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "doc_url": "docUrl",
+  });
+});
+
+export function getCompanyCompaniesResponse503ErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<GetCompanyCompaniesResponse503Error, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetCompanyCompaniesResponse503Error$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetCompanyCompaniesResponse503Error' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetCompanyCompaniesResponse503ResponseBody$inboundSchema:
+  z.ZodType<GetCompanyCompaniesResponse503ResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      error: z.lazy(() => GetCompanyCompaniesResponse503Error$inboundSchema),
+      request$: z.instanceof(Request),
+      response$: z.instanceof(Response),
+      body$: z.string(),
+    })
+      .transform((v) => {
+        return new GetCompanyCompaniesResponse503ResponseBody(v, {
+          request: v.request$,
+          response: v.response$,
+          body: v.body$,
+        });
+      });
+
 /** @internal */
 export const GetCompanyCompaniesResponseType$inboundSchema: z.ZodType<
   GetCompanyCompaniesResponseType,