@vepler/sdk 2.30.4 → 2.37.0

package/dist/commonjs/sdk/models/shared/personcluster.js

@@ -0,0 +1,57 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonCluster$inboundSchema = void 0;
+exports.personClusterFromJSON = personClusterFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+const personsummary_js_1 = require("./personsummary.js");
+/** @internal */
+exports.PersonCluster$inboundSchema = z.object({
+    canonicalPerson: z.nullable(personsummary_js_1.PersonSummary$inboundSchema).optional(),
+    clusterConfidence: z.nullable(z.number()).optional(),
+    clusterId: z.string(),
+    combinedActiveAppointments: z.number().int(),
+    combinedAppointments: z.number().int(),
+    members: z.array(z.nullable(personsummary_js_1.PersonSummary$inboundSchema)),
+    totalRecords: z.number().int(),
+});
+function personClusterFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PersonCluster$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PersonCluster' from JSON`);
+}
+//# sourceMappingURL=personcluster.js.map

package/dist/commonjs/sdk/models/shared/personcluster.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personcluster.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personcluster.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDH,sDAQC;AA/DD,0CAA4B;AAC5B,wDAAoD;AAGpD,yDAAgF;AAoChF,gBAAgB;AACH,QAAA,2BAA2B,GAIpC,CAAC,CAAC,MAAM,CAAC;IACX,eAAe,EAAE,CAAC,CAAC,QAAQ,CAAC,8CAA2B,CAAC,CAAC,QAAQ,EAAE;IACnE,iBAAiB,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5C,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACtC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,8CAA2B,CAAC,CAAC;IACzD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC/B,CAAC,CAAC;AAEH,SAAgB,qBAAqB,CACnC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,mCAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACvD,2CAA2C,CAC5C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/personclusterresponse.d.ts

@@ -0,0 +1,21 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PersonCluster } from "./personcluster.js";
+/**
+ * Response containing an entity resolution cluster -- a group of person records that belong to the same real-world individual. Requires COMPANIES_HOUSE_PREMIUM.
+ */
+export type PersonClusterResponse = {
+    /**
+     * The entity resolution cluster with all member records.
+     */
+    result: PersonCluster;
+    /**
+     * Indicates the request was successful.
+     */
+    success: boolean;
+};
+/** @internal */
+export declare const PersonClusterResponse$inboundSchema: z.ZodType<PersonClusterResponse, z.ZodTypeDef, unknown>;
+export declare function personClusterResponseFromJSON(jsonString: string): SafeParseResult<PersonClusterResponse, SDKValidationError>;
+//# sourceMappingURL=personclusterresponse.d.ts.map

package/dist/commonjs/sdk/models/shared/personclusterresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personclusterresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personclusterresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,mCAAmC,EAAE,CAAC,CAAC,OAAO,CACzD,qBAAqB,EACrB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAM5D"}

package/dist/commonjs/sdk/models/shared/personclusterresponse.js

@@ -0,0 +1,52 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonClusterResponse$inboundSchema = void 0;
+exports.personClusterResponseFromJSON = personClusterResponseFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+const personcluster_js_1 = require("./personcluster.js");
+/** @internal */
+exports.PersonClusterResponse$inboundSchema = z.object({
+    result: personcluster_js_1.PersonCluster$inboundSchema,
+    success: z.boolean(),
+});
+function personClusterResponseFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PersonClusterResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PersonClusterResponse' from JSON`);
+}
+//# sourceMappingURL=personclusterresponse.js.map

package/dist/commonjs/sdk/models/shared/personclusterresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personclusterresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personclusterresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCH,sEAQC;AAtCD,0CAA4B;AAC5B,wDAAoD;AAGpD,yDAAgF;AAgBhF,gBAAgB;AACH,QAAA,mCAAmC,GAI5C,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,8CAA2B;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAEH,SAAgB,6BAA6B,CAC3C,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,2CAAmC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC/D,mDAAmD,CACpD,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/personlistresponse.d.ts

@@ -0,0 +1,37 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PersonSummary } from "./personsummary.js";
+/**
+ * Paginated list of deduplicated persons matching search criteria.
+ */
+export type PersonListResponse = {
+    /**
+     * 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 person summary records matching the search criteria.
+     */
+    results: Array<PersonSummary | null>;
+    /**
+     * Indicates the request was successful.
+     */
+    success: boolean;
+    /**
+     * Total number of persons matching the search criteria (across all pages).
+     */
+    total: number;
+};
+/** @internal */
+export declare const PersonListResponse$inboundSchema: z.ZodType<PersonListResponse, z.ZodTypeDef, unknown>;
+export declare function personListResponseFromJSON(jsonString: string): SafeParseResult<PersonListResponse, SDKValidationError>;
+//# sourceMappingURL=personlistresponse.d.ts.map

package/dist/commonjs/sdk/models/shared/personlistresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personlistresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personlistresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,aAAa,EAA+B,MAAM,oBAAoB,CAAC;AAEhF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAQP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}

package/dist/commonjs/sdk/models/shared/personlistresponse.js

@@ -0,0 +1,56 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonListResponse$inboundSchema = void 0;
+exports.personListResponseFromJSON = personListResponseFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+const personsummary_js_1 = require("./personsummary.js");
+/** @internal */
+exports.PersonListResponse$inboundSchema = z.object({
+    hasMore: z.boolean(),
+    limit: z.number().int(),
+    offset: z.number().int(),
+    results: z.array(z.nullable(personsummary_js_1.PersonSummary$inboundSchema)),
+    success: z.boolean(),
+    total: z.number().int(),
+});
+function personListResponseFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PersonListResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PersonListResponse' from JSON`);
+}
+//# sourceMappingURL=personlistresponse.js.map

package/dist/commonjs/sdk/models/shared/personlistresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personlistresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personlistresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDH,gEAQC;AA1DD,0CAA4B;AAC5B,wDAAoD;AAGpD,yDAAgF;AAgChF,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACxB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,8CAA2B,CAAC,CAAC;IACzD,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACxB,CAAC,CAAC;AAEH,SAAgB,0BAA0B,CACxC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,wCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/personqueryrequest.d.ts

@@ -0,0 +1,112 @@
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+/**
+ * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+ */
+export declare const PersonQueryRequestSortBy: {
+    readonly Name: "name";
+    readonly TotalAppointments: "totalAppointments";
+    readonly ActiveAppointments: "activeAppointments";
+    readonly UpdatedAt: "updatedAt";
+};
+/**
+ * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+ */
+export type PersonQueryRequestSortBy = ClosedEnum<typeof PersonQueryRequestSortBy>;
+/**
+ * Sort direction: 'asc' for ascending, 'desc' for descending.
+ */
+export declare const PersonQueryRequestSortOrder: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+/**
+ * Sort direction: 'asc' for ascending, 'desc' for descending.
+ */
+export type PersonQueryRequestSortOrder = ClosedEnum<typeof PersonQueryRequestSortOrder>;
+/**
+ * Person search request body. Supports filtering by name, surname, date of birth, nationality, country of residence, appointment counts, and entity resolution cluster. Returns paginated, deduplicated person records.
+ */
+export type PersonQueryRequest = {
+    /**
+     * Find all person records belonging to a specific entity resolution cluster. Returns all members of the cluster (both canonical and non-canonical). Requires COMPANIES_HOUSE_PREMIUM.
+     */
+    clusterId?: string | undefined;
+    /**
+     * Filter by country of usual residence (e.g. 'United Kingdom').
+     */
+    countryOfResidence?: string | undefined;
+    /**
+     * Filter by birth month (1 = January, 12 = December). Best used in combination with dobYear.
+     */
+    dobMonth?: number | undefined;
+    /**
+     * Filter by 4-digit birth year. Best used in combination with dobMonth for precise matching.
+     */
+    dobYear?: number | undefined;
+    /**
+     * When false (default), only canonical (primary) person records are returned, avoiding duplicate results for merged identities. Set to true to include non-canonical records that have been merged into a canonical record.
+     */
+    includeNonCanonical?: boolean | undefined;
+    /**
+     * Maximum number of results to return per page (1-50, default: 25).
+     */
+    limit?: number | undefined;
+    /**
+     * Only return persons with at least this many currently active officer appointments.
+     */
+    minActiveAppointments?: number | undefined;
+    /**
+     * Only return persons with at least this many total officer appointments (active and resigned combined). Useful for finding prolific directors.
+     */
+    minAppointments?: number | undefined;
+    /**
+     * Search by person name. Supports fuzzy matching -- partial names will return relevant results. Case-insensitive.
+     */
+    name?: string | undefined;
+    /**
+     * Filter by nationality (e.g. 'British', 'Irish'). As declared on appointment forms.
+     */
+    nationality?: string | undefined;
+    /**
+     * Number of results to skip for pagination.
+     */
+    offset?: number | undefined;
+    /**
+     * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+     */
+    sortBy?: PersonQueryRequestSortBy | undefined;
+    /**
+     * Sort direction: 'asc' for ascending, 'desc' for descending.
+     */
+    sortOrder?: PersonQueryRequestSortOrder | undefined;
+    /**
+     * Filter by exact surname (family name). Case-insensitive.
+     */
+    surname?: string | undefined;
+};
+/** @internal */
+export declare const PersonQueryRequestSortBy$outboundSchema: z.ZodNativeEnum<typeof PersonQueryRequestSortBy>;
+/** @internal */
+export declare const PersonQueryRequestSortOrder$outboundSchema: z.ZodNativeEnum<typeof PersonQueryRequestSortOrder>;
+/** @internal */
+export type PersonQueryRequest$Outbound = {
+    clusterId?: string | undefined;
+    countryOfResidence?: string | undefined;
+    dobMonth?: number | undefined;
+    dobYear?: number | undefined;
+    includeNonCanonical: boolean;
+    limit: number;
+    minActiveAppointments?: number | undefined;
+    minAppointments?: number | undefined;
+    name?: string | undefined;
+    nationality?: string | undefined;
+    offset: number;
+    sortBy: string;
+    sortOrder: string;
+    surname?: string | undefined;
+};
+/** @internal */
+export declare const PersonQueryRequest$outboundSchema: z.ZodType<PersonQueryRequest$Outbound, z.ZodTypeDef, PersonQueryRequest>;
+export declare function personQueryRequestToJSON(personQueryRequest: PersonQueryRequest): string;
+//# sourceMappingURL=personqueryrequest.d.ts.map

package/dist/commonjs/sdk/models/shared/personqueryrequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personqueryrequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personqueryrequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;CAK3B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,CAC/C,OAAO,wBAAwB,CAChC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B;;;CAG9B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG,UAAU,CAClD,OAAO,2BAA2B,CACnC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,SAAS,CAAC,EAAE,2BAA2B,GAAG,SAAS,CAAC;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,uCAAuC,EAAE,CAAC,CAAC,aAAa,CACnE,OAAO,wBAAwB,CACS,CAAC;AAE3C,gBAAgB;AAChB,eAAO,MAAM,0CAA0C,EAAE,CAAC,CAAC,aAAa,CACtE,OAAO,2BAA2B,CACS,CAAC;AAE9C,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,qBAAqB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3C,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAgBlB,CAAC;AAEH,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR"}

package/dist/commonjs/sdk/models/shared/personqueryrequest.js

@@ -0,0 +1,82 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonQueryRequest$outboundSchema = exports.PersonQueryRequestSortOrder$outboundSchema = exports.PersonQueryRequestSortBy$outboundSchema = exports.PersonQueryRequestSortOrder = exports.PersonQueryRequestSortBy = void 0;
+exports.personQueryRequestToJSON = personQueryRequestToJSON;
+const z = __importStar(require("zod/v3"));
+/**
+ * Field to sort results by. 'name' for alphabetical, 'totalAppointments' or 'activeAppointments' for most/least connected, 'updatedAt' for most recently changed.
+ */
+exports.PersonQueryRequestSortBy = {
+    Name: "name",
+    TotalAppointments: "totalAppointments",
+    ActiveAppointments: "activeAppointments",
+    UpdatedAt: "updatedAt",
+};
+/**
+ * Sort direction: 'asc' for ascending, 'desc' for descending.
+ */
+exports.PersonQueryRequestSortOrder = {
+    Asc: "asc",
+    Desc: "desc",
+};
+/** @internal */
+exports.PersonQueryRequestSortBy$outboundSchema = z.nativeEnum(exports.PersonQueryRequestSortBy);
+/** @internal */
+exports.PersonQueryRequestSortOrder$outboundSchema = z.nativeEnum(exports.PersonQueryRequestSortOrder);
+/** @internal */
+exports.PersonQueryRequest$outboundSchema = z.object({
+    clusterId: z.string().optional(),
+    countryOfResidence: z.string().optional(),
+    dobMonth: z.number().int().optional(),
+    dobYear: z.number().int().optional(),
+    includeNonCanonical: z.boolean().default(false),
+    limit: z.number().int().default(25),
+    minActiveAppointments: z.number().int().optional(),
+    minAppointments: z.number().int().optional(),
+    name: z.string().optional(),
+    nationality: z.string().optional(),
+    offset: z.number().int().default(0),
+    sortBy: exports.PersonQueryRequestSortBy$outboundSchema.default("name"),
+    sortOrder: exports.PersonQueryRequestSortOrder$outboundSchema.default("asc"),
+    surname: z.string().optional(),
+});
+function personQueryRequestToJSON(personQueryRequest) {
+    return JSON.stringify(exports.PersonQueryRequest$outboundSchema.parse(personQueryRequest));
+}
+//# sourceMappingURL=personqueryrequest.js.map

package/dist/commonjs/sdk/models/shared/personqueryrequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personqueryrequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personqueryrequest.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmJH,4DAMC;AAvJD,0CAA4B;AAG5B;;GAEG;AACU,QAAA,wBAAwB,GAAG;IACtC,IAAI,EAAE,MAAM;IACZ,iBAAiB,EAAE,mBAAmB;IACtC,kBAAkB,EAAE,oBAAoB;IACxC,SAAS,EAAE,WAAW;CACd,CAAC;AAQX;;GAEG;AACU,QAAA,2BAA2B,GAAG;IACzC,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACJ,CAAC;AAsEX,gBAAgB;AACH,QAAA,uCAAuC,GAEhD,CAAC,CAAC,UAAU,CAAC,gCAAwB,CAAC,CAAC;AAE3C,gBAAgB;AACH,QAAA,0CAA0C,GAEnD,CAAC,CAAC,UAAU,CAAC,mCAA2B,CAAC,CAAC;AAoB9C,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACpC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IAC/C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;IACnC,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAClD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IACnC,MAAM,EAAE,+CAAuC,CAAC,OAAO,CAAC,MAAM,CAAC;IAC/D,SAAS,EAAE,kDAA0C,CAAC,OAAO,CAAC,KAAK,CAAC;IACpE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAC;AAEH,SAAgB,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,yCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/personresponse.d.ts

@@ -0,0 +1,31 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { OfficerSummary } from "./officersummary.js";
+import { Person } from "./person.js";
+import { PscSummary } from "./pscsummary.js";
+/**
+ * Response containing a single deduplicated person record.
+ */
+export type PersonResponse = {
+    /**
+     * Officer appointments held by this person (if requested).
+     */
+    appointments?: Array<OfficerSummary> | undefined;
+    /**
+     * PSC notification records linked to this person (if requested).
+     */
+    pscNotifications?: Array<PscSummary> | undefined;
+    /**
+     * The full deduplicated person record.
+     */
+    result: Person;
+    /**
+     * Indicates the request was successful.
+     */
+    success: boolean;
+};
+/** @internal */
+export declare const PersonResponse$inboundSchema: z.ZodType<PersonResponse, z.ZodTypeDef, unknown>;
+export declare function personResponseFromJSON(jsonString: string): SafeParseResult<PersonResponse, SDKValidationError>;
+//# sourceMappingURL=personresponse.d.ts.map

package/dist/commonjs/sdk/models/shared/personresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,cAAc,EAEf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,MAAM,EAAwB,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,UAAU,EAA4B,MAAM,iBAAiB,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,OAAO,CAClD,cAAc,EACd,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD"}

package/dist/commonjs/sdk/models/shared/personresponse.js

@@ -0,0 +1,56 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PersonResponse$inboundSchema = void 0;
+exports.personResponseFromJSON = personResponseFromJSON;
+const z = __importStar(require("zod/v3"));
+const schemas_js_1 = require("../../../lib/schemas.js");
+const officersummary_js_1 = require("./officersummary.js");
+const person_js_1 = require("./person.js");
+const pscsummary_js_1 = require("./pscsummary.js");
+/** @internal */
+exports.PersonResponse$inboundSchema = z.object({
+    appointments: z.array(officersummary_js_1.OfficerSummary$inboundSchema).optional(),
+    pscNotifications: z.array(pscsummary_js_1.PscSummary$inboundSchema).optional(),
+    result: person_js_1.Person$inboundSchema,
+    success: z.boolean(),
+});
+function personResponseFromJSON(jsonString) {
+    return (0, schemas_js_1.safeParse)(jsonString, (x) => exports.PersonResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'PersonResponse' from JSON`);
+}
+//# sourceMappingURL=personresponse.js.map

package/dist/commonjs/sdk/models/shared/personresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"personresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personresponse.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CH,wDAQC;AArDD,0CAA4B;AAC5B,wDAAoD;AAGpD,2DAG6B;AAC7B,2CAA2D;AAC3D,mDAAuE;AAwBvE,gBAAgB;AACH,QAAA,4BAA4B,GAIrC,CAAC,CAAC,MAAM,CAAC;IACX,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,gDAA4B,CAAC,CAAC,QAAQ,EAAE;IAC9D,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,wCAAwB,CAAC,CAAC,QAAQ,EAAE;IAC9D,MAAM,EAAE,gCAAoB;IAC5B,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;CACrB,CAAC,CAAC;AAEH,SAAgB,sBAAsB,CACpC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,oCAA4B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACxD,4CAA4C,CAC7C,CAAC;AACJ,CAAC"}

package/dist/commonjs/sdk/models/shared/personsummary.d.ts

@@ -0,0 +1,54 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { DateOfBirth } from "./dateofbirth.js";
+/**
+ * The canonical (primary) person record in this cluster. This is the authoritative representation of the individual. Null if no canonical record has been designated.
+ */
+export type PersonSummary = {
+    /**
+     * Number of currently active (non-resigned) officer appointments.
+     */
+    activeAppointments: number;
+    /**
+     * Entity resolution cluster identifier. Requires COMPANIES_HOUSE_PREMIUM.
+     */
+    clusterId?: string | null | undefined;
+    /**
+     * Country of usual residence.
+     */
+    countryOfResidence?: string | null | undefined;
+    dateOfBirth?: DateOfBirth | null | undefined;
+    /**
+     * First (given) name.
+     */
+    forename?: string | null | undefined;
+    /**
+     * Unique identifier for this person record (UUID v4).
+     */
+    id: string;
+    /**
+     * Whether this is the canonical (primary) record within its entity resolution cluster.
+     */
+    isCanonical: boolean;
+    /**
+     * Full name as recorded, typically uppercase.
+     */
+    name: string;
+    /**
+     * Nationality as declared.
+     */
+    nationality?: string | null | undefined;
+    /**
+     * Surname (family name).
+     */
+    surname?: string | null | undefined;
+    /**
+     * Total officer appointments (active and resigned) across all companies.
+     */
+    totalAppointments: number;
+};
+/** @internal */
+export declare const PersonSummary$inboundSchema: z.ZodType<PersonSummary, z.ZodTypeDef, unknown>;
+export declare function personSummaryFromJSON(jsonString: string): SafeParseResult<PersonSummary, SDKValidationError>;
+//# sourceMappingURL=personsummary.d.ts.map

package/dist/commonjs/sdk/models/shared/personsummary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"personsummary.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/personsummary.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EAAE,WAAW,EAA6B,MAAM,kBAAkB,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACtC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/C,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IACpC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,2BAA2B,EAAE,CAAC,CAAC,OAAO,CACjD,aAAa,EACb,CAAC,CAAC,UAAU,EACZ,OAAO,CAaP,CAAC;AAEH,wBAAgB,qBAAqB,CACnC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAMpD"}