@vepler/sdk 2.30.4 → 2.37.0

package/src/sdk/models/shared/companiesbylocationresponse.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CompanySummary,
+  CompanySummary$inboundSchema,
+} from "./companysummary.js";
+
+/**
+ * All companies registered at a specific property location, identified by UPRN. Useful for property-company intelligence, ownership analysis, and due diligence.
+ */
+export type CompaniesByLocationResponse = {
+  /**
+   * Array of companies whose registered office is at this property.
+   */
+  companies: Array<CompanySummary>;
+  /**
+   * The UPRN (Unique Property Reference Number) that was queried.
+   */
+  locationId: string;
+  /**
+   * Indicates the request was successful.
+   */
+  success: boolean;
+  /**
+   * Total number of companies registered at this property.
+   */
+  total: number;
+};
+
+/** @internal */
+export const CompaniesByLocationResponse$inboundSchema: z.ZodType<
+  CompaniesByLocationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  companies: z.array(CompanySummary$inboundSchema),
+  locationId: z.string(),
+  success: z.boolean(),
+  total: z.number().int(),
+});
+
+export function companiesByLocationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CompaniesByLocationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompaniesByLocationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompaniesByLocationResponse' from JSON`,
+  );
+}

package/src/sdk/models/shared/company.ts

@@ -0,0 +1,355 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CompanyAddress,
+  CompanyAddress$inboundSchema,
+} from "./companyaddress.js";
+import { PreviousName, PreviousName$inboundSchema } from "./previousname.js";
+import { SicCode, SicCode$inboundSchema } from "./siccode.js";
+
+/**
+ * Type of annual accounts the company files. Determined by company size. Null if no accounts information is available.
+ */
+export const AccountsType = {
+  Null: "null",
+  Full: "full",
+  Small: "small",
+  Medium: "medium",
+  Group: "group",
+  Dormant: "dormant",
+  Interim: "interim",
+  Initial: "initial",
+  TotalExemptionFull: "total-exemption-full",
+  TotalExemptionSmall: "total-exemption-small",
+  PartialExemption: "partial-exemption",
+  AuditExemptionSubsidiary: "audit-exemption-subsidiary",
+  FilingExemptionSubsidiary: "filing-exemption-subsidiary",
+  MicroEntity: "micro-entity",
+  NoAccountsTypeAvailable: "no-accounts-type-available",
+  AuditedAbridged: "audited-abridged",
+  UnauditedAbridged: "unaudited-abridged",
+} as const;
+/**
+ * Type of annual accounts the company files. Determined by company size. Null if no accounts information is available.
+ */
+export type AccountsType = OpenEnum<typeof AccountsType>;
+
+/**
+ * Current lifecycle status of the company on the Companies House register. Common values: 'active' (live and filing), 'dissolved' (struck off), 'liquidation' (being wound up). Overseas entities use 'open'/'closed' instead of 'active'/'dissolved'.
+ */
+export const CompanyStatus = {
+  Active: "active",
+  Dissolved: "dissolved",
+  Liquidation: "liquidation",
+  Receivership: "receivership",
+  ConvertedClosed: "converted-closed",
+  VoluntaryArrangement: "voluntary-arrangement",
+  InsolvencyProceedings: "insolvency-proceedings",
+  Administration: "administration",
+  Open: "open",
+  Closed: "closed",
+  Registered: "registered",
+  Removed: "removed",
+} as const;
+/**
+ * Current lifecycle status of the company on the Companies House register. Common values: 'active' (live and filing), 'dissolved' (struck off), 'liquidation' (being wound up). Overseas entities use 'open'/'closed' instead of 'active'/'dissolved'.
+ */
+export type CompanyStatus = OpenEnum<typeof CompanyStatus>;
+
+/**
+ * Optional subtype providing additional classification, e.g. 'community-interest-company'. Null for most companies.
+ */
+export const CompanySubtype = {
+  CommunityInterestCompany: "community-interest-company",
+  PrivateFundLimitedPartnership: "private-fund-limited-partnership",
+  Slp: "slp",
+  Pflp: "pflp",
+  Spflp: "spflp",
+} as const;
+/**
+ * Optional subtype providing additional classification, e.g. 'community-interest-company'. Null for most companies.
+ */
+export type CompanySubtype = OpenEnum<typeof CompanySubtype>;
+
+/**
+ * Legal structure of the entity as registered at Companies House. The most common types are 'ltd' (private limited by shares), 'plc' (public limited company), and 'llp' (limited liability partnership). See the enum values for the full list including overseas entities, European types, investment vehicles, and legacy types.
+ */
+export const CompanyType = {
+  PrivateUnlimited: "private-unlimited",
+  Ltd: "ltd",
+  Plc: "plc",
+  OldPublicCompany: "old-public-company",
+  PrivateLimitedGuarantNscLimitedExemption:
+    "private-limited-guarant-nsc-limited-exemption",
+  LimitedPartnership: "limited-partnership",
+  PrivateLimitedGuarantNsc: "private-limited-guarant-nsc",
+  ConvertedOrClosed: "converted-or-closed",
+  PrivateUnlimitedNsc: "private-unlimited-nsc",
+  PrivateLimitedSharesSection30Exemption:
+    "private-limited-shares-section-30-exemption",
+  ProtectedCellCompany: "protected-cell-company",
+  AssuranceCompany: "assurance-company",
+  OverseaCompany: "oversea-company",
+  EeigEstablishment: "eeig-establishment",
+  IcvcSecurities: "icvc-securities",
+  IcvcWarrant: "icvc-warrant",
+  IcvcUmbrella: "icvc-umbrella",
+  RegisteredSocietyNonJurisdictional: "registered-society-non-jurisdictional",
+  IndustrialAndProvidentSociety: "industrial-and-provident-society",
+  NorthernIreland: "northern-ireland",
+  NorthernIrelandOther: "northern-ireland-other",
+  Llp: "llp",
+  RoyalCharter: "royal-charter",
+  InvestmentCompanyWithVariableCapital:
+    "investment-company-with-variable-capital",
+  UnregisteredCompany: "unregistered-company",
+  Other: "other",
+  EuropeanPublicLimitedLiabilityCompanySe:
+    "european-public-limited-liability-company-se",
+  UnitedKingdomSocietas: "united-kingdom-societas",
+  UkEstablishment: "uk-establishment",
+  ScottishPartnership: "scottish-partnership",
+  CharitableIncorporatedOrganisation: "charitable-incorporated-organisation",
+  ScottishCharitableIncorporatedOrganisation:
+    "scottish-charitable-incorporated-organisation",
+  FurtherEducationOrSixthFormCollegeCorporation:
+    "further-education-or-sixth-form-college-corporation",
+  Eeig: "eeig",
+  Ukeig: "ukeig",
+  RegisteredOverseasEntity: "registered-overseas-entity",
+} as const;
+/**
+ * Legal structure of the entity as registered at Companies House. The most common types are 'ltd' (private limited by shares), 'plc' (public limited company), and 'llp' (limited liability partnership). See the enum values for the full list including overseas entities, European types, investment vehicles, and legacy types.
+ */
+export type CompanyType = OpenEnum<typeof CompanyType>;
+
+/**
+ * UK jurisdiction where the company is incorporated and registered. Determines the applicable legal framework and Companies House office. Most companies are 'england-wales'. Scottish companies are registered at the Edinburgh office.
+ */
+export const Jurisdiction = {
+  EnglandWales: "england-wales",
+  Wales: "wales",
+  Scotland: "scotland",
+  NorthernIreland: "northern-ireland",
+  EuropeanUnion: "european-union",
+  UnitedKingdom: "united-kingdom",
+  England: "england",
+  Noneu: "noneu",
+} as const;
+/**
+ * UK jurisdiction where the company is incorporated and registered. Determines the applicable legal framework and Companies House office. Most companies are 'england-wales'. Scottish companies are registered at the Edinburgh office.
+ */
+export type Jurisdiction = OpenEnum<typeof Jurisdiction>;
+
+/**
+ * The full company record.
+ */
+export type Company = {
+  /**
+   * End date of the period covered by the most recently filed accounts. ISO 8601 format.
+   */
+  accountsLastMadeUpToDate?: Date | null | undefined;
+  /**
+   * Deadline for the next annual accounts filing. ISO 8601 format.
+   */
+  accountsNextDueDate?: Date | null | undefined;
+  /**
+   * Type of annual accounts the company files. Determined by company size. Null if no accounts information is available.
+   */
+  accountsType?: AccountsType | null | undefined;
+  /**
+   * Whether the company is currently able to file documents with Companies House. False for dissolved companies or those in certain insolvency states.
+   */
+  canFile: boolean;
+  /**
+   * The official registered name of the company as it appears on the Companies House register. Typically in uppercase. Includes the legal suffix (e.g. 'LTD', 'PLC', 'LLP') unless exempt.
+   */
+  companyName: string;
+  /**
+   * The unique 8-character company registration number assigned by Companies House. Numeric for most UK companies (zero-padded, e.g. '00000006'), but may contain letters for certain entity types (e.g. 'OC' prefix for LLPs, 'SC' for Scottish companies, 'NI' for Northern Ireland, 'OE' for overseas entities).
+   */
+  companyNumber: string;
+  /**
+   * Current lifecycle status of the company on the Companies House register. Common values: 'active' (live and filing), 'dissolved' (struck off), 'liquidation' (being wound up). Overseas entities use 'open'/'closed' instead of 'active'/'dissolved'.
+   */
+  companyStatus: CompanyStatus;
+  /**
+   * Optional subtype providing additional classification, e.g. 'community-interest-company'. Null for most companies.
+   */
+  companySubtype?: CompanySubtype | null | undefined;
+  /**
+   * Legal structure of the entity as registered at Companies House. The most common types are 'ltd' (private limited by shares), 'plc' (public limited company), and 'llp' (limited liability partnership). See the enum values for the full list including overseas entities, European types, investment vehicles, and legacy types.
+   */
+  companyType: CompanyType;
+  /**
+   * Date up to which the most recent confirmation statement was made. ISO 8601 format.
+   */
+  confirmationStatementLastMadeUpToDate?: Date | null | undefined;
+  /**
+   * Deadline for the next confirmation statement (formerly annual return). Companies must confirm their details with Companies House at least once every 12 months. ISO 8601 format.
+   */
+  confirmationStatementNextDueDate?: Date | null | undefined;
+  /**
+   * Country of origin for overseas companies and foreign entities. Null for UK-incorporated companies.
+   */
+  countryOfOrigin?: string | null | undefined;
+  /**
+   * Timestamp when this record was first created in our database. ISO 8601 format.
+   */
+  createdAt: Date;
+  /**
+   * Date the company was dissolved and struck off the register. Null if the company is still active. ISO 8601 format.
+   */
+  dissolutionDate?: Date | null | undefined;
+  /**
+   * Registration number in the entity's home jurisdiction, for overseas companies and foreign entities. Null for UK-incorporated companies.
+   */
+  externalRegistrationNumber?: string | null | undefined;
+  /**
+   * Whether the company has any registered charges (mortgages, debentures, or other security interests). Charges are registered under Part 25 of the Companies Act 2006.
+   */
+  hasCharges: boolean;
+  /**
+   * Whether the company has any insolvency history (e.g. winding-up petitions, administration orders, CVAs, or liquidation proceedings).
+   */
+  hasInsolvencyHistory: boolean;
+  /**
+   * Date the company was incorporated (i.e. when it came into legal existence). ISO 8601 format. May be null for very old companies or certain entity types.
+   */
+  incorporationDate?: Date | null | undefined;
+  /**
+   * For overseas companies: whether the entity is still registered in its home jurisdiction. Null for UK-incorporated companies.
+   */
+  isOnRegisterInJurisdiction?: boolean | null | undefined;
+  /**
+   * UK jurisdiction where the company is incorporated and registered. Determines the applicable legal framework and Companies House office. Most companies are 'england-wales'. Scottish companies are registered at the Edinburgh office.
+   */
+  jurisdiction: Jurisdiction;
+  /**
+   * Date of the last annual return (pre-June 2016) or confirmation statement (post-June 2016). ISO 8601 format.
+   */
+  lastMembersListDate?: Date | null | undefined;
+  /**
+   * UPRN (Unique Property Reference Number) linking this company's registered office to a specific property in the Ordnance Survey AddressBase database. Enables property-level company intelligence. Null if the address could not be matched to a UPRN.
+   */
+  locationId?: string | null | undefined;
+  /**
+   * History of previous company names with their effective date ranges. Useful for tracing corporate identity changes over time. Up to 10 entries.
+   */
+  previousNames?: Array<PreviousName> | undefined;
+  /**
+   * The company's current registered office address. Every UK company must have a registered office, which is the official address for serving legal documents and correspondence from Companies House.
+   */
+  registeredOfficeAddress?: CompanyAddress | null | undefined;
+  /**
+   * Up to 4 Standard Industrial Classification (SIC 2007) codes describing the company's business activities. At least one is required at incorporation.
+   */
+  sicCodes: Array<SicCode>;
+  /**
+   * Timestamp when this record was last updated in our database. ISO 8601 format.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const AccountsType$inboundSchema: z.ZodType<
+  AccountsType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AccountsType);
+
+/** @internal */
+export const CompanyStatus$inboundSchema: z.ZodType<
+  CompanyStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CompanyStatus);
+
+/** @internal */
+export const CompanySubtype$inboundSchema: z.ZodType<
+  CompanySubtype,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CompanySubtype);
+
+/** @internal */
+export const CompanyType$inboundSchema: z.ZodType<
+  CompanyType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CompanyType);
+
+/** @internal */
+export const Jurisdiction$inboundSchema: z.ZodType<
+  Jurisdiction,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Jurisdiction);
+
+/** @internal */
+export const Company$inboundSchema: z.ZodType<Company, z.ZodTypeDef, unknown> =
+  z.object({
+    accountsLastMadeUpToDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    accountsNextDueDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    accountsType: z.nullable(AccountsType$inboundSchema).optional(),
+    canFile: z.boolean(),
+    companyName: z.string(),
+    companyNumber: z.string(),
+    companyStatus: CompanyStatus$inboundSchema,
+    companySubtype: z.nullable(CompanySubtype$inboundSchema).optional(),
+    companyType: CompanyType$inboundSchema,
+    confirmationStatementLastMadeUpToDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    confirmationStatementNextDueDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    countryOfOrigin: z.nullable(z.string()).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    dissolutionDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    externalRegistrationNumber: z.nullable(z.string()).optional(),
+    hasCharges: z.boolean(),
+    hasInsolvencyHistory: z.boolean(),
+    incorporationDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    isOnRegisterInJurisdiction: z.nullable(z.boolean()).optional(),
+    jurisdiction: Jurisdiction$inboundSchema,
+    lastMembersListDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    locationId: z.nullable(z.string()).optional(),
+    previousNames: z.array(PreviousName$inboundSchema).optional(),
+    registeredOfficeAddress: z.nullable(CompanyAddress$inboundSchema)
+      .optional(),
+    sicCodes: z.array(SicCode$inboundSchema),
+    updatedAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+export function companyFromJSON(
+  jsonString: string,
+): SafeParseResult<Company, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Company$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Company' from JSON`,
+  );
+}

package/src/sdk/models/shared/companyaddress.ts

@@ -0,0 +1,82 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The company's current registered office address. May be null in summary responses.
+ */
+export type CompanyAddress = {
+  /**
+   * First line of the street address (e.g. 'Heene Road').
+   */
+  addressLine1?: string | null | undefined;
+  /**
+   * Second line of the address, if applicable (e.g. a district or area within a town).
+   */
+  addressLine2?: string | null | undefined;
+  /**
+   * 'Care of' (c/o) name, used when mail should be directed via a third party.
+   */
+  careOf?: string | null | undefined;
+  /**
+   * Country name as recorded by Companies House (e.g. 'United Kingdom', 'England').
+   */
+  country?: string | null | undefined;
+  /**
+   * Pre-formatted single-line address string combining all available components.
+   */
+  formattedAddress?: string | null | undefined;
+  /**
+   * Town or city name.
+   */
+  locality?: string | null | undefined;
+  /**
+   * PO Box number, if the address uses a PO Box.
+   */
+  poBox?: string | null | undefined;
+  /**
+   * UK postcode or international postal code.
+   */
+  postalCode?: string | null | undefined;
+  /**
+   * Building name or number (e.g. 'MGM House', '10').
+   */
+  premises?: string | null | undefined;
+  /**
+   * County, region, or administrative area.
+   */
+  region?: string | null | undefined;
+};
+
+/** @internal */
+export const CompanyAddress$inboundSchema: z.ZodType<
+  CompanyAddress,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  addressLine1: z.nullable(z.string()).optional(),
+  addressLine2: z.nullable(z.string()).optional(),
+  careOf: z.nullable(z.string()).optional(),
+  country: z.nullable(z.string()).optional(),
+  formattedAddress: z.nullable(z.string()).optional(),
+  locality: z.nullable(z.string()).optional(),
+  poBox: z.nullable(z.string()).optional(),
+  postalCode: z.nullable(z.string()).optional(),
+  premises: z.nullable(z.string()).optional(),
+  region: z.nullable(z.string()).optional(),
+});
+
+export function companyAddressFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyAddress, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyAddress$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyAddress' from JSON`,
+  );
+}

package/src/sdk/models/shared/companylistresponse.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CompanySummary,
+  CompanySummary$inboundSchema,
+} from "./companysummary.js";
+
+/**
+ * Paginated list of companies matching search criteria.
+ */
+export type CompanyListResponse = {
+  /**
+   * Whether additional results are available beyond this page. Use offset + limit to fetch the next page.
+   */
+  hasMore: boolean;
+  /**
+   * The maximum number of results returned in this page.
+   */
+  limit: number;
+  /**
+   * The number of results skipped (for pagination).
+   */
+  offset: number;
+  /**
+   * Array of company summary records matching the search criteria.
+   */
+  results: Array<CompanySummary>;
+  /**
+   * Indicates the request was successful.
+   */
+  success: boolean;
+  /**
+   * Total number of companies matching the search criteria (across all pages).
+   */
+  total: number;
+};
+
+/** @internal */
+export const CompanyListResponse$inboundSchema: z.ZodType<
+  CompanyListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hasMore: z.boolean(),
+  limit: z.number().int(),
+  offset: z.number().int(),
+  results: z.array(CompanySummary$inboundSchema),
+  success: z.boolean(),
+  total: z.number().int(),
+});
+
+export function companyListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<CompanyListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompanyListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompanyListResponse' from JSON`,
+  );
+}