@vepler/sdk 2.33.0 → 2.37.0

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

@@ -0,0 +1,39 @@
+/*
+ * 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";
+
+export type MatchedSubstring = {
+  /**
+   * Length of the matched text
+   */
+  length: number;
+  /**
+   * Start position of the match
+   */
+  offset: number;
+};
+
+/** @internal */
+export const MatchedSubstring$inboundSchema: z.ZodType<
+  MatchedSubstring,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  length: z.number().int(),
+  offset: z.number().int(),
+});
+
+export function matchedSubstringFromJSON(
+  jsonString: string,
+): SafeParseResult<MatchedSubstring, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MatchedSubstring$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MatchedSubstring' from JSON`,
+  );
+}

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

@@ -0,0 +1,197 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * WGS84 coordinate pair
+ */
+export type NearestPostcodesResponseCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+export type Data = {
+  /**
+   * WGS84 coordinate pair
+   */
+  coordinates: NearestPostcodesResponseCoordinates;
+  /**
+   * Country
+   */
+  country?: string | undefined;
+  /**
+   * Distance from source in metres
+   */
+  distanceMetres: number;
+  /**
+   * Postcode
+   */
+  postcode: string;
+};
+
+export const NearestPostcodesResponseObject = {
+  List: "list",
+} as const;
+export type NearestPostcodesResponseObject = ClosedEnum<
+  typeof NearestPostcodesResponseObject
+>;
+
+/**
+ * WGS84 coordinate pair
+ */
+export type Coordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+export type NearestPostcodesResponse = {
+  /**
+   * Nearby postcodes sorted by distance
+   */
+  data: Array<Data>;
+  hasMore: boolean;
+  object: NearestPostcodesResponseObject;
+  /**
+   * Search radius in metres
+   */
+  radius: number;
+  /**
+   * WGS84 coordinate pair
+   */
+  sourceCoordinates: Coordinates;
+  /**
+   * Source postcode
+   */
+  sourcePostcode: string;
+  /**
+   * Total results returned
+   */
+  totalCount?: number | undefined;
+  /**
+   * Request URL
+   */
+  url: string;
+};
+
+/** @internal */
+export const NearestPostcodesResponseCoordinates$inboundSchema: z.ZodType<
+  NearestPostcodesResponseCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function nearestPostcodesResponseCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<NearestPostcodesResponseCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      NearestPostcodesResponseCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NearestPostcodesResponseCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const Data$inboundSchema: z.ZodType<Data, z.ZodTypeDef, unknown> = z
+  .object({
+    coordinates: z.lazy(() =>
+      NearestPostcodesResponseCoordinates$inboundSchema
+    ),
+    country: z.string().optional(),
+    distance_metres: z.number(),
+    postcode: z.string(),
+  }).transform((v) => {
+    return remap$(v, {
+      "distance_metres": "distanceMetres",
+    });
+  });
+
+export function dataFromJSON(
+  jsonString: string,
+): SafeParseResult<Data, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Data$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Data' from JSON`,
+  );
+}
+
+/** @internal */
+export const NearestPostcodesResponseObject$inboundSchema: z.ZodNativeEnum<
+  typeof NearestPostcodesResponseObject
+> = z.nativeEnum(NearestPostcodesResponseObject);
+
+/** @internal */
+export const Coordinates$inboundSchema: z.ZodType<
+  Coordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function coordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<Coordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Coordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const NearestPostcodesResponse$inboundSchema: z.ZodType<
+  NearestPostcodesResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => Data$inboundSchema)),
+  has_more: z.boolean(),
+  object: NearestPostcodesResponseObject$inboundSchema,
+  radius: z.number(),
+  source_coordinates: z.lazy(() => Coordinates$inboundSchema),
+  source_postcode: z.string(),
+  total_count: z.number().int().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "source_coordinates": "sourceCoordinates",
+    "source_postcode": "sourcePostcode",
+    "total_count": "totalCount",
+  });
+});
+
+export function nearestPostcodesResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<NearestPostcodesResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NearestPostcodesResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NearestPostcodesResponse' from JSON`,
+  );
+}

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

@@ -22,7 +22,7 @@ export const NestedAggregationOrder = {
 export type NestedAggregationOrder = ClosedEnum<typeof NestedAggregationOrder>;
 
 /**
- * Type of aggregation
+ * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
  */
 export const NestedAggregationType = {
   Terms: "terms",
@@ -40,7 +40,7 @@ export const NestedAggregationType = {
   Percentiles: "percentiles",
 } as const;
 /**
- * Type of aggregation
+ * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
  */
 export type NestedAggregationType = ClosedEnum<typeof NestedAggregationType>;
 
@@ -50,55 +50,55 @@ export type NestedAggregation = {
    */
   aggs?: Array<LeafAggregation> | undefined;
   /**
-   * Calendar interval for date_histogram (1d, 1w, 1M, etc.)
+   * Calendar-aware interval for date_histogram. Values: 1m (minute), 1h (hour), 1d (day), 1w (week), 1M (month), 1q (quarter), 1y (year). Mutually exclusive with fixedInterval — provide one or the other, not both.
    */
   calendarInterval?: string | undefined;
   /**
-   * Field to aggregate on (must be in allowed field list)
+   * Field to aggregate on. Must be a field allowed by the dataset's aggregation whitelist.
    */
   field: string;
   /**
-   * Fixed interval for date_histogram (1h, 90m, etc.)
+   * Fixed-duration interval for date_histogram. Values: any combination of number + unit (ms, s, m, h, d). Examples: "30m", "1h", "7d". Unlike calendarInterval, does not account for daylight saving or month lengths. Mutually exclusive with calendarInterval — provide one or the other, not both.
    */
   fixedInterval?: string | undefined;
   /**
-   * Date format for date_histogram
+   * Date format string for date_histogram bucket keys. Uses Elasticsearch date format patterns (e.g. "yyyy-MM-dd").
    */
   format?: string | undefined;
   /**
-   * Interval for histogram aggregation
+   * Bucket width for histogram aggregation. Required when type is "histogram".
    */
   interval?: number | undefined;
   /**
-   * Minimum document count for bucket to be returned
+   * Minimum document count for a bucket to be included in the result. Applies to: terms, histogram, date_histogram. Default is 1.
    */
   minDocCount?: number | undefined;
   /**
-   * Unique name for this aggregation
+   * Unique name for this aggregation. Used as the key in the response `aggregations` object.
    */
   name: string;
   /**
-   * Sort order for terms buckets
+   * Sort order for terms buckets. Key is the sort field ("_count", "_key", or a sub-aggregation name), value is direction.
    */
   order?: { [k: string]: NestedAggregationOrder } | undefined;
   /**
-   * Percentiles to calculate
+   * Percentile values to calculate (0-100). Required when type is "percentiles".
    */
   percents?: Array<number> | undefined;
   /**
-   * Custom ranges for range aggregation
+   * Custom numeric ranges for range aggregation. Required when type is "range". Each range has an inclusive `from` and exclusive `to`.
    */
   ranges?: Array<RangeDefinition> | undefined;
   /**
-   * Max buckets for terms aggregation
+   * Maximum number of buckets to return. Applies to: terms (default 20), geotile_grid (precision level). Ignored by metric aggregations (stats, min, max, etc.).
    */
   size?: number | undefined;
   /**
-   * Timezone for date_histogram
+   * IANA timezone for date_histogram bucketing (e.g. "Europe/London", "UTC"). Defaults to UTC.
    */
   timeZone?: string | undefined;
   /**
-   * Type of aggregation
+   * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
    */
   type: NestedAggregationType;
 };

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

@@ -0,0 +1,183 @@
+/*
+ * 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";
+
+/**
+ * The role held by this officer in the company. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (prefixed with 'corporate-') indicate a body corporate acting as officer.
+ */
+export const OfficerRole = {
+  CicManager: "cic-manager",
+  CorporateDirector: "corporate-director",
+  CorporateLlpDesignatedMember: "corporate-llp-designated-member",
+  CorporateLlpMember: "corporate-llp-member",
+  CorporateManagerOfAnEeig: "corporate-manager-of-an-eeig",
+  CorporateManagingOfficer: "corporate-managing-officer",
+  CorporateMemberOfAManagementOrgan: "corporate-member-of-a-management-organ",
+  CorporateMemberOfASupervisoryOrgan: "corporate-member-of-a-supervisory-organ",
+  CorporateMemberOfAnAdministrativeOrgan:
+    "corporate-member-of-an-administrative-organ",
+  CorporateNomineeDirector: "corporate-nominee-director",
+  CorporateNomineeSecretary: "corporate-nominee-secretary",
+  CorporateSecretary: "corporate-secretary",
+  Director: "director",
+  GeneralPartnerInALimitedPartnership:
+    "general-partner-in-a-limited-partnership",
+  JudicialFactor: "judicial-factor",
+  LimitedPartnerInALimitedPartnership:
+    "limited-partner-in-a-limited-partnership",
+  LlpDesignatedMember: "llp-designated-member",
+  LlpMember: "llp-member",
+  ManagerOfAnEeig: "manager-of-an-eeig",
+  ManagingOfficer: "managing-officer",
+  MemberOfAManagementOrgan: "member-of-a-management-organ",
+  MemberOfASupervisoryOrgan: "member-of-a-supervisory-organ",
+  MemberOfAnAdministrativeOrgan: "member-of-an-administrative-organ",
+  NomineeDirector: "nominee-director",
+  NomineeSecretary: "nominee-secretary",
+  PersonAuthorisedToAccept: "person-authorised-to-accept",
+  PersonAuthorisedToRepresent: "person-authorised-to-represent",
+  PersonAuthorisedToRepresentAndAccept:
+    "person-authorised-to-represent-and-accept",
+  ReceiverAndManager: "receiver-and-manager",
+  Secretary: "secretary",
+} as const;
+/**
+ * The role held by this officer in the company. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (prefixed with 'corporate-') indicate a body corporate acting as officer.
+ */
+export type OfficerRole = OpenEnum<typeof OfficerRole>;
+
+/**
+ * The full officer appointment record.
+ */
+export type Officer = {
+  /**
+   * Date the officer was appointed to this role. ISO 8601 format.
+   */
+  appointedOn?: Date | null | undefined;
+  /**
+   * The appointment identifier from the Companies House API. Used for cross-referencing with the Companies House officer appointment endpoint.
+   */
+  appointmentId?: string | null | undefined;
+  /**
+   * The 8-character Companies House registration number of the company this officer is appointed to.
+   */
+  companyNumber: string;
+  /**
+   * Date when the officer's consent to act in this role was filed with Companies House. ISO 8601 format.
+   */
+  consentFiled?: Date | null | undefined;
+  /**
+   * Link to the corporate entity record (for corporate officers only, i.e. when a company or body corporate acts as an officer of another company).
+   */
+  corporateEntityId?: string | null | undefined;
+  /**
+   * The country where the officer usually resides, as declared at the time of appointment.
+   */
+  countryOfResidence?: string | null | undefined;
+  /**
+   * Timestamp when this record was first created in our database. ISO 8601 format.
+   */
+  createdAt: Date;
+  /**
+   * Any former names of the officer, as declared on the appointment form.
+   */
+  formerNames?: string | null | undefined;
+  /**
+   * Unique identifier for this officer appointment record in our database (UUID v4).
+   */
+  id: string;
+  /**
+   * Officer's name as recorded in this specific appointment. Typically in uppercase. For natural persons this is the full name; for corporate officers it is the entity name. Note: the same person may appear with slightly different name formatting across appointments.
+   */
+  name: string;
+  /**
+   * The officer's nationality as declared at the time of appointment.
+   */
+  nationality?: string | null | undefined;
+  /**
+   * The officer's self-declared occupation at the time of appointment.
+   */
+  occupation?: string | null | undefined;
+  /**
+   * The role held by this officer in the company. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (prefixed with 'corporate-') indicate a body corporate acting as officer.
+   */
+  officerRole: OfficerRole;
+  /**
+   * Link to the deduplicated person record for this officer (for natural persons only). Use this ID with the /persons endpoint to retrieve the person's full profile and all their appointments across companies.
+   */
+  personId?: string | null | undefined;
+  /**
+   * Date the officer resigned or was removed from this role. Null indicates the appointment is still active. ISO 8601 format.
+   */
+  resignedOn?: Date | null | undefined;
+  /**
+   * Description of the officer's responsibilities. Primarily used for LLP designated members who have specific statutory duties beyond those of ordinary LLP members.
+   */
+  responsibilities?: string | null | undefined;
+  serviceAddress?: CompanyAddress | null | undefined;
+  /**
+   * Timestamp when this record was last updated in our database. ISO 8601 format.
+   */
+  updatedAt: Date;
+};
+
+/** @internal */
+export const OfficerRole$inboundSchema: z.ZodType<
+  OfficerRole,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(OfficerRole);
+
+/** @internal */
+export const Officer$inboundSchema: z.ZodType<Officer, z.ZodTypeDef, unknown> =
+  z.object({
+    appointedOn: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    appointmentId: z.nullable(z.string()).optional(),
+    companyNumber: z.string(),
+    consentFiled: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    corporateEntityId: z.nullable(z.string()).optional(),
+    countryOfResidence: z.nullable(z.string()).optional(),
+    createdAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+    formerNames: z.nullable(z.string()).optional(),
+    id: z.string(),
+    name: z.string(),
+    nationality: z.nullable(z.string()).optional(),
+    occupation: z.nullable(z.string()).optional(),
+    officerRole: OfficerRole$inboundSchema,
+    personId: z.nullable(z.string()).optional(),
+    resignedOn: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ).optional(),
+    responsibilities: z.nullable(z.string()).optional(),
+    serviceAddress: z.nullable(CompanyAddress$inboundSchema).optional(),
+    updatedAt: z.string().datetime({ offset: true }).transform(v =>
+      new Date(v)
+    ),
+  });
+
+export function officerFromJSON(
+  jsonString: string,
+): SafeParseResult<Officer, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Officer$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Officer' from JSON`,
+  );
+}

package/src/sdk/models/shared/officerlistresponse.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 {
+  OfficerSummary,
+  OfficerSummary$inboundSchema,
+} from "./officersummary.js";
+
+/**
+ * Paginated list of officer appointments for a company.
+ */
+export type OfficerListResponse = {
+  /**
+   * Whether additional results are available beyond this 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 officer appointment summaries.
+   */
+  results: Array<OfficerSummary>;
+  /**
+   * Indicates the request was successful.
+   */
+  success: boolean;
+  /**
+   * Total number of officer appointments matching the filters.
+   */
+  total: number;
+};
+
+/** @internal */
+export const OfficerListResponse$inboundSchema: z.ZodType<
+  OfficerListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  hasMore: z.boolean(),
+  limit: z.number().int(),
+  offset: z.number().int(),
+  results: z.array(OfficerSummary$inboundSchema),
+  success: z.boolean(),
+  total: z.number().int(),
+});
+
+export function officerListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<OfficerListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OfficerListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OfficerListResponse' from JSON`,
+  );
+}

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

@@ -0,0 +1,43 @@
+/*
+ * 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 { Officer, Officer$inboundSchema } from "./officer.js";
+
+/**
+ * Response containing a single officer appointment record.
+ */
+export type OfficerResponse = {
+  /**
+   * The full officer appointment record.
+   */
+  result: Officer;
+  /**
+   * Indicates the request was successful.
+   */
+  success: boolean;
+};
+
+/** @internal */
+export const OfficerResponse$inboundSchema: z.ZodType<
+  OfficerResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  result: Officer$inboundSchema,
+  success: z.boolean(),
+});
+
+export function officerResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<OfficerResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OfficerResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OfficerResponse' from JSON`,
+  );
+}