@vepler/sdk 2.33.0 → 2.38.2

package/dist/esm/sdk/models/operations/validatepostcode.d.ts

@@ -0,0 +1,15 @@
+import * as z from "zod/v3";
+export type ValidatePostcodeRequest = {
+    /**
+     * UK postcode to validate
+     */
+    postcode: string;
+};
+/** @internal */
+export type ValidatePostcodeRequest$Outbound = {
+    postcode: string;
+};
+/** @internal */
+export declare const ValidatePostcodeRequest$outboundSchema: z.ZodType<ValidatePostcodeRequest$Outbound, z.ZodTypeDef, ValidatePostcodeRequest>;
+export declare function validatePostcodeRequestToJSON(validatePostcodeRequest: ValidatePostcodeRequest): string;
+//# sourceMappingURL=validatepostcode.d.ts.map

package/dist/esm/sdk/models/operations/validatepostcode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatepostcode.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/validatepostcode.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,gCAAgC,GAAG;IAC7C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,sCAAsC,EAAE,CAAC,CAAC,OAAO,CAC5D,gCAAgC,EAChC,CAAC,CAAC,UAAU,EACZ,uBAAuB,CAGvB,CAAC;AAEH,wBAAgB,6BAA6B,CAC3C,uBAAuB,EAAE,uBAAuB,GAC/C,MAAM,CAIR"}

package/dist/esm/sdk/models/operations/validatepostcode.js

@@ -0,0 +1,12 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+/** @internal */
+export const ValidatePostcodeRequest$outboundSchema = z.object({
+    postcode: z.string(),
+});
+export function validatePostcodeRequestToJSON(validatePostcodeRequest) {
+    return JSON.stringify(ValidatePostcodeRequest$outboundSchema.parse(validatePostcodeRequest));
+}
+//# sourceMappingURL=validatepostcode.js.map

package/dist/esm/sdk/models/operations/validatepostcode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validatepostcode.js","sourceRoot":"","sources":["../../../../../src/sdk/models/operations/validatepostcode.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAc5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,sCAAsC,GAI/C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAC;AAEH,MAAM,UAAU,6BAA6B,CAC3C,uBAAgD;IAEhD,OAAO,IAAI,CAAC,SAAS,CACnB,sCAAsC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CACtE,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/addresscleanserequest.d.ts

@@ -0,0 +1,33 @@
+import * as z from "zod/v3";
+export type Addresses = {
+    /**
+     * Client-provided identifier for correlation
+     */
+    id?: string | undefined;
+    /**
+     * Raw address string to cleanse
+     */
+    input: string;
+};
+export type AddressCleanseRequest = {
+    /**
+     * Addresses to cleanse (max 25)
+     */
+    addresses: Array<Addresses>;
+};
+/** @internal */
+export type Addresses$Outbound = {
+    id?: string | undefined;
+    input: string;
+};
+/** @internal */
+export declare const Addresses$outboundSchema: z.ZodType<Addresses$Outbound, z.ZodTypeDef, Addresses>;
+export declare function addressesToJSON(addresses: Addresses): string;
+/** @internal */
+export type AddressCleanseRequest$Outbound = {
+    addresses: Array<Addresses$Outbound>;
+};
+/** @internal */
+export declare const AddressCleanseRequest$outboundSchema: z.ZodType<AddressCleanseRequest$Outbound, z.ZodTypeDef, AddressCleanseRequest>;
+export declare function addressCleanseRequestToJSON(addressCleanseRequest: AddressCleanseRequest): string;
+//# sourceMappingURL=addresscleanserequest.d.ts.map

package/dist/esm/sdk/models/shared/addresscleanserequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresscleanserequest.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/addresscleanserequest.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;CAC7B,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,SAAS,CAIT,CAAC;AAEH,wBAAgB,eAAe,CAAC,SAAS,EAAE,SAAS,GAAG,MAAM,CAE5D;AAED,gBAAgB;AAChB,MAAM,MAAM,8BAA8B,GAAG;IAC3C,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;CACtC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,8BAA8B,EAC9B,CAAC,CAAC,UAAU,EACZ,qBAAqB,CAGrB,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,qBAAqB,EAAE,qBAAqB,GAC3C,MAAM,CAIR"}

package/dist/esm/sdk/models/shared/addresscleanserequest.js

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+/** @internal */
+export const Addresses$outboundSchema = z.object({
+    id: z.string().optional(),
+    input: z.string(),
+});
+export function addressesToJSON(addresses) {
+    return JSON.stringify(Addresses$outboundSchema.parse(addresses));
+}
+/** @internal */
+export const AddressCleanseRequest$outboundSchema = z.object({
+    addresses: z.array(z.lazy(() => Addresses$outboundSchema)),
+});
+export function addressCleanseRequestToJSON(addressCleanseRequest) {
+    return JSON.stringify(AddressCleanseRequest$outboundSchema.parse(addressCleanseRequest));
+}
+//# sourceMappingURL=addresscleanserequest.js.map

package/dist/esm/sdk/models/shared/addresscleanserequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresscleanserequest.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/addresscleanserequest.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AA0B5B,gBAAgB;AAChB,MAAM,CAAC,MAAM,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,MAAM,UAAU,eAAe,CAAC,SAAoB;IAClD,OAAO,IAAI,CAAC,SAAS,CAAC,wBAAwB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;AACnE,CAAC;AAOD,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,CAAC;CAC3D,CAAC,CAAC;AAEH,MAAM,UAAU,2BAA2B,CACzC,qBAA4C;IAE5C,OAAO,IAAI,CAAC,SAAS,CACnB,oCAAoC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAClE,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/addresscleanseresponse.d.ts

@@ -0,0 +1,143 @@
+import * as z from "zod/v3";
+import { ClosedEnum, OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { PostcodeAddress } from "./postcodeaddress.js";
+export declare const ObjectT: {
+    readonly CleanseResult: "cleanse_result";
+};
+export type ObjectT = ClosedEnum<typeof ObjectT>;
+export type Changes = {
+    from: string;
+    to: string;
+};
+/**
+ * Recommended action based on match quality
+ */
+export declare const Action: {
+    readonly Accept: "accept";
+    readonly Review: "review";
+    readonly Reject: "reject";
+};
+/**
+ * Recommended action based on match quality
+ */
+export type Action = OpenEnum<typeof Action>;
+/**
+ * Quality grade: A (excellent) through F (fail)
+ */
+export declare const Grade: {
+    readonly A: "A";
+    readonly B: "B";
+    readonly C: "C";
+    readonly D: "D";
+    readonly F: "F";
+};
+/**
+ * Quality grade: A (excellent) through F (fail)
+ */
+export type Grade = OpenEnum<typeof Grade>;
+/**
+ * AIMS match quality assessment
+ */
+export type Quality = {
+    /**
+     * Recommended action based on match quality
+     */
+    action: Action;
+    /**
+     * Quality grade: A (excellent) through F (fail)
+     */
+    grade: Grade;
+    /**
+     * Whether the match is reliable enough for automatic use
+     */
+    isReliable: boolean;
+    /**
+     * Human-readable explanation of the quality assessment
+     */
+    reason: string;
+};
+export type Results = {
+    /**
+     * Fields that were corrected
+     */
+    changes?: {
+        [k: string]: Changes;
+    } | undefined;
+    /**
+     * AIMS match confidence score (0–100)
+     */
+    confidence: number;
+    /**
+     * Whether the address text was changed from the input
+     */
+    corrected: boolean;
+    /**
+     * Client-provided identifier
+     */
+    id?: string | undefined;
+    /**
+     * Original input address
+     */
+    input: string;
+    /**
+     * AIMS match quality assessment
+     */
+    quality?: Quality | undefined;
+    result?: PostcodeAddress | undefined;
+};
+/**
+ * Breakdown by AIMS quality action
+ */
+export type Summary = {
+    /**
+     * Count where quality action is accept
+     */
+    accepted: number;
+    /**
+     * Count where quality action is reject or no match
+     */
+    rejected: number;
+    /**
+     * Count where quality action is review
+     */
+    review: number;
+};
+export type AddressCleanseResponse = {
+    object: ObjectT;
+    /**
+     * Cleansing results
+     */
+    results: Array<Results>;
+    /**
+     * Breakdown by AIMS quality action
+     */
+    summary: Summary;
+    /**
+     * Total addresses processed
+     */
+    total: number;
+};
+/** @internal */
+export declare const ObjectT$inboundSchema: z.ZodNativeEnum<typeof ObjectT>;
+/** @internal */
+export declare const Changes$inboundSchema: z.ZodType<Changes, z.ZodTypeDef, unknown>;
+export declare function changesFromJSON(jsonString: string): SafeParseResult<Changes, SDKValidationError>;
+/** @internal */
+export declare const Action$inboundSchema: z.ZodType<Action, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const Grade$inboundSchema: z.ZodType<Grade, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const Quality$inboundSchema: z.ZodType<Quality, z.ZodTypeDef, unknown>;
+export declare function qualityFromJSON(jsonString: string): SafeParseResult<Quality, SDKValidationError>;
+/** @internal */
+export declare const Results$inboundSchema: z.ZodType<Results, z.ZodTypeDef, unknown>;
+export declare function resultsFromJSON(jsonString: string): SafeParseResult<Results, SDKValidationError>;
+/** @internal */
+export declare const Summary$inboundSchema: z.ZodType<Summary, z.ZodTypeDef, unknown>;
+export declare function summaryFromJSON(jsonString: string): SafeParseResult<Summary, SDKValidationError>;
+/** @internal */
+export declare const AddressCleanseResponse$inboundSchema: z.ZodType<AddressCleanseResponse, z.ZodTypeDef, unknown>;
+export declare function addressCleanseResponseFromJSON(jsonString: string): SafeParseResult<AddressCleanseResponse, SDKValidationError>;
+//# sourceMappingURL=addresscleanseresponse.d.ts.map

package/dist/esm/sdk/models/shared/addresscleanseresponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresscleanseresponse.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/addresscleanseresponse.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AACrE,OAAO,EACL,eAAe,EAEhB,MAAM,sBAAsB,CAAC;AAE9B,eAAO,MAAM,OAAO;;CAEV,CAAC;AACX,MAAM,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,OAAO,CAAC,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,MAAM;;;;CAIT,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,MAAM,CAAC,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,KAAK;;;;;;CAMR,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,MAAM,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;CACtC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACxB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,OAAO,CAC5C,CAAC;AAEvB,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAIxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;AAElC,gBAAgB;AAChB,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CACxC,CAAC;AAEjC,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAMxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CASxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAKxE,CAAC;AAEL,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAM9C;AAED,gBAAgB;AAChB,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,OAAO,CAC1D,sBAAsB,EACtB,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,8BAA8B,CAC5C,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAM7D"}

package/dist/esm/sdk/models/shared/addresscleanseresponse.js

@@ -0,0 +1,86 @@
+/*
+ * 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 { PostcodeAddress$inboundSchema, } from "./postcodeaddress.js";
+export const ObjectT = {
+    CleanseResult: "cleanse_result",
+};
+/**
+ * Recommended action based on match quality
+ */
+export const Action = {
+    Accept: "accept",
+    Review: "review",
+    Reject: "reject",
+};
+/**
+ * Quality grade: A (excellent) through F (fail)
+ */
+export const Grade = {
+    A: "A",
+    B: "B",
+    C: "C",
+    D: "D",
+    F: "F",
+};
+/** @internal */
+export const ObjectT$inboundSchema = z
+    .nativeEnum(ObjectT);
+/** @internal */
+export const Changes$inboundSchema = z.object({
+    from: z.string(),
+    to: z.string(),
+});
+export function changesFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Changes$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Changes' from JSON`);
+}
+/** @internal */
+export const Action$inboundSchema = openEnums.inboundSchema(Action);
+/** @internal */
+export const Grade$inboundSchema = openEnums.inboundSchema(Grade);
+/** @internal */
+export const Quality$inboundSchema = z.object({
+    action: Action$inboundSchema,
+    grade: Grade$inboundSchema,
+    isReliable: z.boolean(),
+    reason: z.string(),
+});
+export function qualityFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Quality$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Quality' from JSON`);
+}
+/** @internal */
+export const Results$inboundSchema = z.object({
+    changes: z.record(z.lazy(() => Changes$inboundSchema)).optional(),
+    confidence: z.number(),
+    corrected: z.boolean(),
+    id: z.string().optional(),
+    input: z.string(),
+    quality: z.lazy(() => Quality$inboundSchema).optional(),
+    result: PostcodeAddress$inboundSchema.optional(),
+});
+export function resultsFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Results$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Results' from JSON`);
+}
+/** @internal */
+export const Summary$inboundSchema = z.object({
+    accepted: z.number().int(),
+    rejected: z.number().int(),
+    review: z.number().int(),
+});
+export function summaryFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => Summary$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'Summary' from JSON`);
+}
+/** @internal */
+export const AddressCleanseResponse$inboundSchema = z.object({
+    object: ObjectT$inboundSchema,
+    results: z.array(z.lazy(() => Results$inboundSchema)),
+    summary: z.lazy(() => Summary$inboundSchema),
+    total: z.number().int(),
+});
+export function addressCleanseResponseFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => AddressCleanseResponse$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AddressCleanseResponse' from JSON`);
+}
+//# sourceMappingURL=addresscleanseresponse.js.map

package/dist/esm/sdk/models/shared/addresscleanseresponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addresscleanseresponse.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/addresscleanseresponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,sBAAsB,CAAC;AAIlD,OAAO,EAEL,6BAA6B,GAC9B,MAAM,sBAAsB,CAAC;AAE9B,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,aAAa,EAAE,gBAAgB;CACvB,CAAC;AAQX;;GAEG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;CACR,CAAC;AAMX;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,GAAG;CACE,CAAC;AA0FX,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAAoC,CAAC;KACpE,UAAU,CAAC,OAAO,CAAC,CAAC;AAEvB,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;CACf,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oBAAoB,GAC/B,SAAS,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;AAElC,gBAAgB;AAChB,MAAM,CAAC,MAAM,mBAAmB,GAC9B,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;AAEjC,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,oBAAoB;IAC5B,KAAK,EAAE,mBAAmB;IAC1B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;IACjE,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;IACvD,MAAM,EAAE,6BAA6B,CAAC,QAAQ,EAAE;CACjD,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,qBAAqB,GAChC,CAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC1B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACzB,CAAC,CAAC;AAEL,MAAM,UAAU,eAAe,CAC7B,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACjD,qCAAqC,CACtC,CAAC;AACJ,CAAC;AAED,gBAAgB;AAChB,MAAM,CAAC,MAAM,oCAAoC,GAI7C,CAAC,CAAC,MAAM,CAAC;IACX,MAAM,EAAE,qBAAqB;IAC7B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,CAAC;IACrD,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC;IAC5C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CACxB,CAAC,CAAC;AAEH,MAAM,UAAU,8BAA8B,CAC5C,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,oCAAoC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAChE,oDAAoD,CACrD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/aggregationinput.d.ts

@@ -8,7 +8,7 @@ export declare const Order: {
 };
 export type Order = ClosedEnum<typeof Order>;
 /**
- * Type of aggregation
+ * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
  */
 export declare const Type: {
     readonly Terms: "terms";
@@ -26,7 +26,7 @@ export declare const Type: {
     readonly Percentiles: "percentiles";
 };
 /**
- * Type of aggregation
+ * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
  */
 export type Type = ClosedEnum<typeof Type>;
 export type AggregationInput = {
@@ -35,57 +35,57 @@ export type AggregationInput = {
      */
     aggs?: Array<NestedAggregation> | 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]: Order;
     } | 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: Type;
 };

package/dist/esm/sdk/models/shared/aggregationinput.js

@@ -9,7 +9,7 @@ export const Order = {
     Desc: "desc",
 };
 /**
- * Type of aggregation
+ * Type of aggregation to perform. Each type has specific parameter requirements and returns a different result shape.
  */
 export const Type = {
     Terms: "terms",

package/dist/esm/sdk/models/shared/aggregationresult.d.ts

@@ -0,0 +1,12 @@
+import * as z from "zod/v3";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { HistogramAggregationResult } from "./histogramaggregationresult.js";
+import { SingleValueAggregationResult } from "./singlevalueaggregationresult.js";
+import { StatsAggregationResult } from "./statsaggregationresult.js";
+import { TermsAggregationResult } from "./termsaggregationresult.js";
+export type AggregationResult = StatsAggregationResult | TermsAggregationResult | HistogramAggregationResult | SingleValueAggregationResult;
+/** @internal */
+export declare const AggregationResult$inboundSchema: z.ZodType<AggregationResult, z.ZodTypeDef, unknown>;
+export declare function aggregationResultFromJSON(jsonString: string): SafeParseResult<AggregationResult, SDKValidationError>;
+//# sourceMappingURL=aggregationresult.d.ts.map

package/dist/esm/sdk/models/shared/aggregationresult.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregationresult.d.ts","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/aggregationresult.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,0BAA0B,EAE3B,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,4BAA4B,EAE7B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,sBAAsB,EAEvB,MAAM,6BAA6B,CAAC;AAErC,MAAM,MAAM,iBAAiB,GACzB,sBAAsB,GACtB,sBAAsB,GACtB,0BAA0B,GAC1B,4BAA4B,CAAC;AAEjC,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CAMP,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,iBAAiB,EAAE,kBAAkB,CAAC,CAMxD"}

package/dist/esm/sdk/models/shared/aggregationresult.js

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { HistogramAggregationResult$inboundSchema, } from "./histogramaggregationresult.js";
+import { SingleValueAggregationResult$inboundSchema, } from "./singlevalueaggregationresult.js";
+import { StatsAggregationResult$inboundSchema, } from "./statsaggregationresult.js";
+import { TermsAggregationResult$inboundSchema, } from "./termsaggregationresult.js";
+/** @internal */
+export const AggregationResult$inboundSchema = z.union([
+    StatsAggregationResult$inboundSchema,
+    TermsAggregationResult$inboundSchema,
+    HistogramAggregationResult$inboundSchema,
+    SingleValueAggregationResult$inboundSchema,
+]);
+export function aggregationResultFromJSON(jsonString) {
+    return safeParse(jsonString, (x) => AggregationResult$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'AggregationResult' from JSON`);
+}
+//# sourceMappingURL=aggregationresult.js.map

package/dist/esm/sdk/models/shared/aggregationresult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregationresult.js","sourceRoot":"","sources":["../../../../../src/sdk/models/shared/aggregationresult.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAGpD,OAAO,EAEL,wCAAwC,GACzC,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,0CAA0C,GAC3C,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAEL,oCAAoC,GACrC,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAEL,oCAAoC,GACrC,MAAM,6BAA6B,CAAC;AAQrC,gBAAgB;AAChB,MAAM,CAAC,MAAM,+BAA+B,GAIxC,CAAC,CAAC,KAAK,CAAC;IACV,oCAAoC;IACpC,oCAAoC;IACpC,wCAAwC;IACxC,0CAA0C;CAC3C,CAAC,CAAC;AAEH,MAAM,UAAU,yBAAyB,CACvC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,+BAA+B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC3D,+CAA+C,CAChD,CAAC;AACJ,CAAC"}

package/dist/esm/sdk/models/shared/appointmentsresponse.d.ts

@@ -0,0 +1,161 @@
+import * as z from "zod/v3";
+import { OpenEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+/**
+ * Current status of the company (e.g. 'active', 'dissolved'). Useful for understanding whether the appointment is at a live company.
+ */
+export declare const AppointmentsResponseCompanyStatus: {
+    readonly Active: "active";
+    readonly Dissolved: "dissolved";
+    readonly Liquidation: "liquidation";
+    readonly Receivership: "receivership";
+    readonly ConvertedClosed: "converted-closed";
+    readonly VoluntaryArrangement: "voluntary-arrangement";
+    readonly InsolvencyProceedings: "insolvency-proceedings";
+    readonly Administration: "administration";
+    readonly Open: "open";
+    readonly Closed: "closed";
+    readonly Registered: "registered";
+    readonly Removed: "removed";
+};
+/**
+ * Current status of the company (e.g. 'active', 'dissolved'). Useful for understanding whether the appointment is at a live company.
+ */
+export type AppointmentsResponseCompanyStatus = OpenEnum<typeof AppointmentsResponseCompanyStatus>;
+/**
+ * The specific role held by the officer in this appointment. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (e.g. 'corporate-director') indicate a body corporate acting as officer. See the full enum for European entity roles, partnership roles, and special roles.
+ */
+export declare const AppointmentsResponseOfficerRole: {
+    readonly CicManager: "cic-manager";
+    readonly CorporateDirector: "corporate-director";
+    readonly CorporateLlpDesignatedMember: "corporate-llp-designated-member";
+    readonly CorporateLlpMember: "corporate-llp-member";
+    readonly CorporateManagerOfAnEeig: "corporate-manager-of-an-eeig";
+    readonly CorporateManagingOfficer: "corporate-managing-officer";
+    readonly CorporateMemberOfAManagementOrgan: "corporate-member-of-a-management-organ";
+    readonly CorporateMemberOfASupervisoryOrgan: "corporate-member-of-a-supervisory-organ";
+    readonly CorporateMemberOfAnAdministrativeOrgan: "corporate-member-of-an-administrative-organ";
+    readonly CorporateNomineeDirector: "corporate-nominee-director";
+    readonly CorporateNomineeSecretary: "corporate-nominee-secretary";
+    readonly CorporateSecretary: "corporate-secretary";
+    readonly Director: "director";
+    readonly GeneralPartnerInALimitedPartnership: "general-partner-in-a-limited-partnership";
+    readonly JudicialFactor: "judicial-factor";
+    readonly LimitedPartnerInALimitedPartnership: "limited-partner-in-a-limited-partnership";
+    readonly LlpDesignatedMember: "llp-designated-member";
+    readonly LlpMember: "llp-member";
+    readonly ManagerOfAnEeig: "manager-of-an-eeig";
+    readonly ManagingOfficer: "managing-officer";
+    readonly MemberOfAManagementOrgan: "member-of-a-management-organ";
+    readonly MemberOfASupervisoryOrgan: "member-of-a-supervisory-organ";
+    readonly MemberOfAnAdministrativeOrgan: "member-of-an-administrative-organ";
+    readonly NomineeDirector: "nominee-director";
+    readonly NomineeSecretary: "nominee-secretary";
+    readonly PersonAuthorisedToAccept: "person-authorised-to-accept";
+    readonly PersonAuthorisedToRepresent: "person-authorised-to-represent";
+    readonly PersonAuthorisedToRepresentAndAccept: "person-authorised-to-represent-and-accept";
+    readonly ReceiverAndManager: "receiver-and-manager";
+    readonly Secretary: "secretary";
+};
+/**
+ * The specific role held by the officer in this appointment. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (e.g. 'corporate-director') indicate a body corporate acting as officer. See the full enum for European entity roles, partnership roles, and special roles.
+ */
+export type AppointmentsResponseOfficerRole = OpenEnum<typeof AppointmentsResponseOfficerRole>;
+/**
+ * Lightweight officer appointment summary for list responses. Contains key identification, role, and date fields.
+ */
+export type Appointments = {
+    /**
+     * Date the officer was appointed. ISO 8601 format.
+     */
+    appointedOn?: Date | null | undefined;
+    /**
+     * The registered name of the company for this appointment.
+     */
+    companyName?: string | undefined;
+    /**
+     * The 8-character registration number of the company.
+     */
+    companyNumber: string;
+    /**
+     * Current status of the company (e.g. 'active', 'dissolved'). Useful for understanding whether the appointment is at a live company.
+     */
+    companyStatus?: AppointmentsResponseCompanyStatus | null | undefined;
+    /**
+     * Unique identifier for this officer appointment record (UUID v4).
+     */
+    id: string;
+    /**
+     * Officer's name as recorded in this appointment.
+     */
+    name: string;
+    /**
+     * The officer's self-declared occupation.
+     */
+    occupation?: string | null | undefined;
+    /**
+     * The specific role held by the officer in this appointment. Common values: 'director', 'secretary', 'llp-member', 'llp-designated-member'. Corporate variants (e.g. 'corporate-director') indicate a body corporate acting as officer. See the full enum for European entity roles, partnership roles, and special roles.
+     */
+    officerRole: AppointmentsResponseOfficerRole;
+    /**
+     * Link to the deduplicated person record (for natural persons). Use with the /persons endpoint.
+     */
+    personId?: string | null | undefined;
+    /**
+     * Date the officer resigned. Null if still active. ISO 8601 format.
+     */
+    resignedOn?: Date | null | undefined;
+};
+/**
+ * All officer appointments held by a person across companies, including the company name and current status for each appointment.
+ */
+export type AppointmentsResponse = {
+    /**
+     * Number of currently active (non-resigned) officer appointments.
+     */
+    activeAppointments: number;
+    /**
+     * Array of officer appointments enriched with company name and status. Each entry represents one appointment at one company.
+     */
+    appointments: Array<Appointments>;
+    /**
+     * Whether additional appointment records 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;
+    /**
+     * The person identifier that was queried.
+     */
+    personId: string;
+    /**
+     * The person's full name.
+     */
+    personName: string;
+    /**
+     * Indicates the request was successful.
+     */
+    success: boolean;
+    /**
+     * Total officer appointments held by this person (active and resigned).
+     */
+    totalAppointments: number;
+};
+/** @internal */
+export declare const AppointmentsResponseCompanyStatus$inboundSchema: z.ZodType<AppointmentsResponseCompanyStatus, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const AppointmentsResponseOfficerRole$inboundSchema: z.ZodType<AppointmentsResponseOfficerRole, z.ZodTypeDef, unknown>;
+/** @internal */
+export declare const Appointments$inboundSchema: z.ZodType<Appointments, z.ZodTypeDef, unknown>;
+export declare function appointmentsFromJSON(jsonString: string): SafeParseResult<Appointments, SDKValidationError>;
+/** @internal */
+export declare const AppointmentsResponse$inboundSchema: z.ZodType<AppointmentsResponse, z.ZodTypeDef, unknown>;
+export declare function appointmentsResponseFromJSON(jsonString: string): SafeParseResult<AppointmentsResponse, SDKValidationError>;
+//# sourceMappingURL=appointmentsresponse.d.ts.map