@c15t/node-sdk 3.0.0-alpha.3 → 3.0.0-alpha.5

package/dist-types/contract.d.ts

@@ -0,0 +1,868 @@
+/**
+ * The endpoint table.
+ *
+ * Each entry pairs one backend route with everything the client needs to
+ * call it: method, path template, auth, idempotency, input validation, the
+ * error codes the route can return, and how to decode its success body. The
+ * client, the mock client and the tests are all built from this table, so a
+ * route is described once.
+ */
+import type { CheckConsentOutput, ConsentManifest, ConsentPolicyType, LegalDocumentPolicyType, PatchSubjectFullInput, PostSubjectInput } from '@c15t/schema/types';
+import type { C15tApiErrorCode, C15tIssue } from './errors.js';
+import type { PathParams } from './path.js';
+export type HttpMethod = 'GET' | 'PATCH' | 'POST' | 'PUT';
+/** What an endpoint turns its input into before it is sent. */
+export interface PreparedRequest<Path extends string> {
+    readonly params: PathParams<Path>;
+    readonly query?: Readonly<Record<string, string | undefined>>;
+    readonly body?: unknown;
+    readonly headers?: Readonly<Record<string, string>>;
+}
+/** One backend route, as the client calls it. */
+export interface Endpoint<Path extends string, Input, Data, Code extends C15tApiErrorCode> {
+    /** Method name on the client, such as `subjects.get`. */
+    readonly name: string;
+    readonly method: HttpMethod;
+    readonly path: Path;
+    /** `api-key` routes are refused with `MISSING_API_KEY` before sending. */
+    readonly auth: 'api-key' | 'none';
+    /**
+     * Whether repeating the request has the same effect as sending it once.
+     * Only idempotent endpoints are retried.
+     */
+    readonly idempotent: boolean;
+    /** Codes the route can put in `cause.code`. Others become `UNEXPECTED_RESPONSE`. */
+    readonly errorCodes: readonly Code[];
+    readonly validate: (input: Input) => Promise<readonly C15tIssue[]>;
+    readonly prepare: (input: Input) => PreparedRequest<Path>;
+    /** Statuses treated as success. Defaults to 200–299. */
+    readonly accepts?: (status: number) => boolean;
+    /**
+     * Turns a success body into `Data`. Throws when the body does not have the
+     * documented shape, which the client reports as `UNEXPECTED_RESPONSE`.
+     */
+    readonly decode: (body: unknown, response: Response, input: Input) => Data;
+}
+/** An endpoint of any shape, for code that handles them generically. */
+export type AnyEndpoint = Endpoint<string, never, unknown, C15tApiErrorCode>;
+/** A success body without the documented shape. */
+export declare class DecodeError extends Error {
+    readonly name = "DecodeError";
+}
+/** Request context for `init`, sent as the headers the backend reads. */
+export interface C15tInitRequest {
+    /** Language to resolve translations for. Sent as `Accept-Language`. */
+    readonly language?: string;
+    /** ISO 3166-1 alpha-2 country, such as `DE`. Overrides geolocation. */
+    readonly country?: string;
+    /** ISO 3166-2 subdivision, such as `BE`. Overrides geolocation. */
+    readonly region?: string;
+    /** The visitor's Global Privacy Control signal. */
+    readonly gpc?: boolean;
+}
+/** Options for `manifest`. */
+export interface C15tManifestRequest {
+    /** Return only this language's translations. */
+    readonly language?: string;
+    /**
+     * The `etag` of a manifest you already hold. An unchanged manifest comes
+     * back as `{ status: 'not-modified' }` without a body.
+     */
+    readonly ifNoneMatch?: string;
+}
+/** `manifest` result data. */
+export type C15tManifestResult = {
+    readonly status: 'modified';
+    readonly manifest: ConsentManifest;
+    readonly etag: string | undefined;
+} | {
+    readonly status: 'not-modified';
+    readonly etag: string | undefined;
+};
+/** Options for `subjects.get`. */
+export interface C15tGetSubjectRequest {
+    /** Only return consents of these policy types. */
+    readonly types?: readonly ConsentPolicyType[];
+}
+/**
+ * Input for `subjects.create`: the `POST /subjects` body, except `givenAt`
+ * also accepts a `Date`.
+ */
+export type C15tCreateSubjectInput = PostSubjectInput extends infer Variant ? Variant extends PostSubjectInput ? Omit<Variant, 'givenAt'> & {
+    /** When consent was given: a `Date` or epoch milliseconds. */
+    readonly givenAt: Date | number;
+} : never : never;
+/** Input for `subjects.identify`. */
+export type C15tIdentifySubjectInput = Omit<PatchSubjectFullInput, 'id'>;
+/** Input for `consents.check`. */
+export interface C15tCheckConsentInput<Types extends readonly ConsentPolicyType[]> {
+    /** Your user id, as linked with `subjects.identify`. */
+    readonly externalId: string;
+    /** Policy types to report. Every one appears in `results`. */
+    readonly types: Types;
+}
+/** `consents.check` data, with one result per requested type. */
+export interface C15tCheckConsentOutput<Type extends string> {
+    readonly results: {
+        readonly [Key in Type]: CheckConsentOutput['results'][string];
+    };
+}
+/** Filters for `experiments.summary`. */
+export interface C15tExperimentSummaryRequest {
+    /** Only consents given at or after this instant. A date-only string means the start of that day, UTC. */
+    readonly from?: Date | string;
+    /** Only consents given at or before this instant. A date-only string means the end of that day, UTC. */
+    readonly to?: Date | string;
+    /** Only consents recorded for this domain. */
+    readonly domain?: string;
+}
+/** Input for `legalDocuments.publish`. */
+export interface C15tPublishLegalDocumentInput {
+    /** Release identifier, such as `2026-01-01`. */
+    readonly version: string;
+    /** Content hash of the released document, such as `sha256:…`. */
+    readonly hash: string;
+    /** When this version takes effect. */
+    readonly effectiveDate: Date | string;
+}
+interface GetSubjectEndpointInput {
+    readonly id: string;
+    readonly request: C15tGetSubjectRequest | undefined;
+}
+interface IdentifySubjectEndpointInput {
+    readonly id: string;
+    readonly input: C15tIdentifySubjectInput;
+}
+interface ExperimentSummaryEndpointInput {
+    readonly id: string;
+    readonly request: C15tExperimentSummaryRequest | undefined;
+}
+interface PublishLegalDocumentEndpointInput {
+    readonly type: LegalDocumentPolicyType;
+    readonly input: C15tPublishLegalDocumentInput;
+}
+/** Every endpoint the client calls. */
+export declare const endpoints: {
+    readonly checkConsent: Endpoint<"/consents/check", C15tCheckConsentInput<readonly ConsentPolicyType[]>, {
+        results: {
+            [x: string]: {
+                hasConsent: boolean;
+                isLatestPolicy: boolean;
+            };
+        };
+    }, "DATABASE_ERROR" | "EXTERNAL_ID_REQUIRED" | "TYPE_REQUIRED">;
+    readonly createSubject: Endpoint<"/subjects", (Omit<{
+        consentAction?: string | undefined;
+        documentSnapshotToken?: string | undefined;
+        domain: string;
+        externalSubjectId?: string | undefined;
+        givenAt: number;
+        identityProvider?: string | undefined;
+        jurisdiction?: string | undefined;
+        jurisdictionModel?: string | undefined;
+        metadata?: {
+            [x: string]: unknown;
+        } | undefined;
+        model?: string | undefined;
+        policySnapshotToken?: string | undefined;
+        subjectId: string;
+        tcString?: string | undefined;
+        uiSource?: string | undefined;
+        country?: string | null | undefined;
+        fingerprint?: string | undefined;
+        gpc?: boolean | undefined;
+        language?: string | undefined;
+        policyId?: string | null | undefined;
+        region?: string | null | undefined;
+        choice?: {
+            categories: {
+                experience?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+                functionality?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+                marketing?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+                measurement?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+            };
+            version: 3;
+        } | undefined;
+        preferences: {
+            [x: string]: boolean;
+        };
+        type: "cookie_banner";
+        vendorChoice?: {
+            confirmedAt: number;
+            grants: {
+                [x: string]: boolean;
+            };
+            version: 1;
+        } | undefined;
+    }, "givenAt"> & {
+        /** When consent was given: a `Date` or epoch milliseconds. */
+        readonly givenAt: Date | number;
+    }) | (Omit<{
+        consentAction?: string | undefined;
+        documentSnapshotToken?: string | undefined;
+        domain: string;
+        externalSubjectId?: string | undefined;
+        givenAt: number;
+        identityProvider?: string | undefined;
+        jurisdiction?: string | undefined;
+        jurisdictionModel?: string | undefined;
+        metadata?: {
+            [x: string]: unknown;
+        } | undefined;
+        model?: string | undefined;
+        policySnapshotToken?: string | undefined;
+        subjectId: string;
+        tcString?: string | undefined;
+        uiSource?: string | undefined;
+        policyHash?: string | undefined;
+        policyId?: string | undefined;
+        preferences?: {
+            [x: string]: boolean;
+        } | undefined;
+        type: string;
+    }, "givenAt"> & {
+        /** When consent was given: a `Date` or epoch milliseconds. */
+        readonly givenAt: Date | number;
+    }) | (Omit<{
+        consentAction?: string | undefined;
+        documentSnapshotToken?: string | undefined;
+        domain: string;
+        externalSubjectId?: string | undefined;
+        givenAt: number;
+        identityProvider?: string | undefined;
+        jurisdiction?: string | undefined;
+        jurisdictionModel?: string | undefined;
+        metadata?: {
+            [x: string]: unknown;
+        } | undefined;
+        model?: string | undefined;
+        policySnapshotToken?: string | undefined;
+        subjectId: string;
+        tcString?: string | undefined;
+        uiSource?: string | undefined;
+        preferences?: {
+            [x: string]: boolean;
+        } | undefined;
+        type: "age_verification" | "marketing_communications" | "other";
+    }, "givenAt"> & {
+        /** When consent was given: a `Date` or epoch milliseconds. */
+        readonly givenAt: Date | number;
+    }), {
+        appliedPreferences?: {
+            [x: string]: boolean;
+        } | undefined;
+        consentId: string;
+        domain: string;
+        domainId: string;
+        givenAt: Date;
+        metadata?: {
+            [x: string]: unknown;
+        } | undefined;
+        subjectId: string;
+        type: string;
+        uiSource?: string | undefined;
+    }, "CHOICE_OUT_OF_SCOPE" | "CHOICE_PREFERENCE_MISMATCH" | "CONFLICT" | "DATABASE_ERROR" | "INPUT_VALIDATION_FAILED" | "POLICY_SNAPSHOT_EXPIRED" | "POLICY_SNAPSHOT_INVALID" | "POLICY_SNAPSHOT_REQUIRED" | "PURPOSE_NOT_ALLOWED" | "STALE_POLICY" | "SUBJECT_CONFLICT">;
+    readonly experimentSummary: Endpoint<"/experiments/:id/summary", ExperimentSummaryEndpointInput, {
+        arms: {
+            arm: string;
+            byAction: {
+                accept_all: number;
+                custom: number;
+                opt_out: number;
+                reject_all: number;
+                unknown: number;
+            };
+            bySurface: {
+                [x: string]: number;
+            };
+            choices: number;
+            medianTimeToDecisionMs: number | null;
+        }[];
+        experimentId: string;
+        from: string | null;
+        to: string | null;
+    }, "DATABASE_ERROR" | "INPUT_VALIDATION_FAILED" | "UNAUTHORIZED">;
+    readonly getSubject: Endpoint<"/subjects/:id", GetSubjectEndpointInput, {
+        consents: {
+            choice?: {
+                categories: {
+                    experience?: {
+                        basis: {
+                            fingerprint: string;
+                            kind: "choice-v1";
+                        } | {
+                            kind: "legacy-v2";
+                            materialFingerprint?: string | undefined;
+                        };
+                        confirmedAt: number;
+                        value: boolean;
+                    } | undefined;
+                    functionality?: {
+                        basis: {
+                            fingerprint: string;
+                            kind: "choice-v1";
+                        } | {
+                            kind: "legacy-v2";
+                            materialFingerprint?: string | undefined;
+                        };
+                        confirmedAt: number;
+                        value: boolean;
+                    } | undefined;
+                    marketing?: {
+                        basis: {
+                            fingerprint: string;
+                            kind: "choice-v1";
+                        } | {
+                            kind: "legacy-v2";
+                            materialFingerprint?: string | undefined;
+                        };
+                        confirmedAt: number;
+                        value: boolean;
+                    } | undefined;
+                    measurement?: {
+                        basis: {
+                            fingerprint: string;
+                            kind: "choice-v1";
+                        } | {
+                            kind: "legacy-v2";
+                            materialFingerprint?: string | undefined;
+                        };
+                        confirmedAt: number;
+                        value: boolean;
+                    } | undefined;
+                };
+                version: 3;
+            } | null | undefined;
+            givenAt: Date;
+            id: string;
+            isLatestPolicy: boolean;
+            policyEffectiveDate?: Date | undefined;
+            policyHash?: string | undefined;
+            policyId?: string | undefined;
+            policyVersion?: string | undefined;
+            preferences?: {
+                [x: string]: boolean;
+            } | undefined;
+            type: string;
+            vendorChoice?: {
+                confirmedAt: number;
+                grants: {
+                    [x: string]: boolean;
+                };
+                version: 1;
+            } | null | undefined;
+        }[];
+        isValid: boolean;
+        subject: {
+            createdAt?: Date | undefined;
+            externalId?: string | undefined;
+            id: string;
+            identityProvider?: string | undefined;
+        };
+        subjectChoice?: {
+            categories: {
+                experience?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+                functionality?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+                marketing?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+                measurement?: {
+                    basis: {
+                        fingerprint: string;
+                        kind: "choice-v1";
+                    } | {
+                        kind: "legacy-v2";
+                        materialFingerprint?: string | undefined;
+                    };
+                    confirmedAt: number;
+                    value: boolean;
+                } | undefined;
+            };
+            version: 3;
+        } | null | undefined;
+        subjectVendorChoice?: {
+            confirmedAt: number;
+            grants: {
+                [x: string]: boolean;
+            };
+            version: 1;
+        } | null | undefined;
+    }, "DATABASE_ERROR" | "NOT_FOUND">;
+    readonly identifySubject: Endpoint<"/subjects/:id", IdentifySubjectEndpointInput, {
+        subject: {
+            externalId: string;
+            id: string;
+            identityProvider: string;
+        };
+    }, "DATABASE_ERROR" | "EXTERNAL_ID_REQUIRED" | "NOT_FOUND">;
+    readonly init: Endpoint<"/init", C15tInitRequest | undefined, {
+        branding: "c15t" | "consent" | "inth" | "none";
+        cmpId?: number | undefined;
+        customVendors?: {
+            cookieMaxAgeSeconds?: number | undefined;
+            dataCategories?: number[] | undefined;
+            dataRetentionDays?: number | undefined;
+            description?: string | undefined;
+            features?: number[] | undefined;
+            id: string | number;
+            legIntPurposes?: number[] | undefined;
+            name: string;
+            privacyPolicyUrl: string;
+            purposes: number[];
+            specialFeatures?: number[] | undefined;
+            usesCookies?: boolean | undefined;
+            usesNonCookieAccess?: boolean | undefined;
+        }[] | undefined;
+        gvl?: ({
+            dataCategories?: {
+                [x: string]: {
+                    description: string;
+                    id: number;
+                    name: string;
+                } & {
+                    [key: string]: unknown;
+                };
+            } | undefined;
+            features: {
+                [x: string]: {
+                    description: string;
+                    descriptionLegal?: string | undefined;
+                    id: number;
+                    illustrations: string[];
+                    name: string;
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+            gvlSpecificationVersion: number;
+            lastUpdated: string;
+            purposes: {
+                [x: string]: {
+                    description: string;
+                    descriptionLegal?: string | undefined;
+                    id: number;
+                    illustrations: string[];
+                    name: string;
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+            specialFeatures: {
+                [x: string]: {
+                    description: string;
+                    descriptionLegal?: string | undefined;
+                    id: number;
+                    illustrations: string[];
+                    name: string;
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+            specialPurposes: {
+                [x: string]: {
+                    description: string;
+                    descriptionLegal?: string | undefined;
+                    id: number;
+                    illustrations: string[];
+                    name: string;
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+            stacks: {
+                [x: string]: {
+                    description: string;
+                    id: number;
+                    name: string;
+                    purposes: number[];
+                    specialFeatures: number[];
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+            standardTexts?: ({
+                features: string;
+                purposes?: string | undefined;
+                specialFeatures?: string | undefined;
+                specialPurposes?: string | undefined;
+            } & {
+                [key: string]: unknown;
+            }) | undefined;
+            tcfPolicyVersion: number;
+            vendorListVersion: number;
+            vendors: {
+                [x: string]: {
+                    cookieMaxAgeSeconds: number | null;
+                    cookieRefresh: boolean;
+                    dataCategories?: number[] | undefined;
+                    dataRetention?: ({
+                        purposes?: {
+                            [x: string]: number;
+                        } | undefined;
+                        specialPurposes?: {
+                            [x: string]: number;
+                        } | undefined;
+                        stdRetention?: number | undefined;
+                    } & {
+                        [key: string]: unknown;
+                    }) | undefined;
+                    deletedDate?: string | undefined;
+                    deviceStorageDisclosureUrl?: string | undefined;
+                    features: number[];
+                    flexiblePurposes: number[];
+                    id: number;
+                    legIntPurposes: number[];
+                    name: string;
+                    overflow?: ({
+                        httpGetLimit: number;
+                    } & {
+                        [key: string]: unknown;
+                    }) | undefined;
+                    purposes: number[];
+                    specialFeatures: number[];
+                    specialPurposes: number[];
+                    urls: ({
+                        langId: string;
+                        legIntClaim?: string | undefined;
+                        privacy?: string | undefined;
+                    } & {
+                        [key: string]: unknown;
+                    })[];
+                    usesCookies: boolean;
+                    usesNonCookieAccess: boolean;
+                } & {
+                    [key: string]: unknown;
+                };
+            };
+        } & {
+            [key: string]: unknown;
+        }) | null | undefined;
+        gvlReference?: {
+            context?: {
+                country?: string | undefined;
+                gpc?: boolean | undefined;
+                region?: string | undefined;
+            } | undefined;
+            format?: "init" | undefined;
+            language: string;
+            summary?: {
+                items: string[];
+                vendorCount: number;
+            } | undefined;
+            url: string;
+            vendorListVersion: number;
+        } | undefined;
+        location: {
+            countryCode: string | null;
+            regionCode: string | null;
+        };
+        policyResolution: {
+            policy: null;
+            status: "unconfigured";
+            version: 1;
+        } | {
+            policy: null;
+            status: "no-match";
+            version: 1;
+        } | {
+            policy: null;
+            reason: "insufficient-inputs" | "invalid-configuration" | "invalid-payload" | "transport" | "unsupported-contract";
+            status: "failed";
+            version: 1;
+        } | {
+            fingerprints: {
+                choice: string;
+                legacyMaterial?: string | undefined;
+                notice: string;
+                policy: string;
+            };
+            matchedBy: "country" | "default" | "fallback" | "region";
+            policy: {
+                actions: {
+                    allowed: ("accept" | "customize" | "dismiss" | "reject")[];
+                    equivalent: ("accept" | "customize" | "dismiss" | "reject")[][];
+                    required: ("accept" | "customize" | "dismiss" | "reject")[];
+                };
+                copyRevision: string | null;
+                i18n?: {
+                    language?: string | undefined;
+                    messageProfile?: string | undefined;
+                } | undefined;
+                id: string;
+                model: "iab" | "none" | "opt-in" | "opt-out";
+                preselectedCategories: ("experience" | "functionality" | "marketing" | "measurement")[];
+                privacySignals: {
+                    gpc: {
+                        denyCategories: ("experience" | "functionality" | "marketing" | "measurement")[];
+                    };
+                };
+                prompt: "choice" | "none" | "notice";
+                proof: {
+                    storeIp: boolean;
+                    storeLanguage: boolean;
+                    storeUserAgent: boolean;
+                };
+                rights: ("disclosure" | "opt-out" | "preferences")[];
+                scope: ("experience" | "functionality" | "marketing" | "measurement")[];
+                scopeMode: "permissive" | "strict";
+                validity: {
+                    choiceMs: number;
+                    noticeMs: number;
+                };
+            };
+            policyId: string;
+            status: "matched";
+            version: 1;
+        };
+        policySnapshotToken?: string | undefined;
+        resolvedPrivacySignals?: {
+            gpc?: boolean | undefined;
+        } | undefined;
+        translations: {
+            language: string;
+            translations: {
+                common: {
+                    acceptAll?: string | undefined;
+                    acknowledge?: string | undefined;
+                    customize?: string | undefined;
+                    dismiss?: string | undefined;
+                    rejectAll?: string | undefined;
+                    save?: string | undefined;
+                };
+                consentGate?: {
+                    actionButton?: string | undefined;
+                    title?: string | undefined;
+                } | undefined;
+                consentManagerDialog: {
+                    description?: string | undefined;
+                    title?: string | undefined;
+                    vendors?: {
+                        disabledByCategory?: string | undefined;
+                        privacyPolicy?: string | undefined;
+                        switchLabel?: string | undefined;
+                        title?: string | undefined;
+                    } | undefined;
+                };
+                consentTypes: {
+                    experience?: {
+                        description?: string | undefined;
+                        title?: string | undefined;
+                    } | undefined;
+                    functionality?: {
+                        description?: string | undefined;
+                        title?: string | undefined;
+                    } | undefined;
+                    marketing?: {
+                        description?: string | undefined;
+                        title?: string | undefined;
+                    } | undefined;
+                    measurement?: {
+                        description?: string | undefined;
+                        title?: string | undefined;
+                    } | undefined;
+                    necessary?: {
+                        description?: string | undefined;
+                        title?: string | undefined;
+                    } | undefined;
+                };
+                cookieBanner: {
+                    description?: string | undefined;
+                    title?: string | undefined;
+                    noticeDescription?: string | undefined;
+                    noticeTitle?: string | undefined;
+                };
+                legalLinks?: {
+                    cookiePolicy?: string | undefined;
+                    privacyPolicy?: string | undefined;
+                    termsOfService?: string | undefined;
+                } | undefined;
+                rights?: {
+                    optOut?: string | undefined;
+                    preferences?: string | undefined;
+                } | undefined;
+            };
+        };
+        vendorListVersion?: string | undefined;
+        vendors?: {
+            category: import("@c15t/schema").VendorCategoryCondition;
+            description?: string | undefined;
+            disabled?: boolean | undefined;
+            homepageUrl?: string | undefined;
+            id: string;
+            legalName?: string | undefined;
+            name: string;
+            privacyPolicyUrl: string;
+        }[] | undefined;
+    }, never>;
+    readonly listSubjects: Endpoint<"/subjects", {
+        readonly externalId: string;
+    }, {
+        subjects: {
+            consents: {
+                choice?: {
+                    categories: {
+                        experience?: {
+                            basis: {
+                                fingerprint: string;
+                                kind: "choice-v1";
+                            } | {
+                                kind: "legacy-v2";
+                                materialFingerprint?: string | undefined;
+                            };
+                            confirmedAt: number;
+                            value: boolean;
+                        } | undefined;
+                        functionality?: {
+                            basis: {
+                                fingerprint: string;
+                                kind: "choice-v1";
+                            } | {
+                                kind: "legacy-v2";
+                                materialFingerprint?: string | undefined;
+                            };
+                            confirmedAt: number;
+                            value: boolean;
+                        } | undefined;
+                        marketing?: {
+                            basis: {
+                                fingerprint: string;
+                                kind: "choice-v1";
+                            } | {
+                                kind: "legacy-v2";
+                                materialFingerprint?: string | undefined;
+                            };
+                            confirmedAt: number;
+                            value: boolean;
+                        } | undefined;
+                        measurement?: {
+                            basis: {
+                                fingerprint: string;
+                                kind: "choice-v1";
+                            } | {
+                                kind: "legacy-v2";
+                                materialFingerprint?: string | undefined;
+                            };
+                            confirmedAt: number;
+                            value: boolean;
+                        } | undefined;
+                    };
+                    version: 3;
+                } | null | undefined;
+                givenAt: Date;
+                id: string;
+                isLatestPolicy: boolean;
+                policyEffectiveDate?: Date | undefined;
+                policyHash?: string | undefined;
+                policyId?: string | undefined;
+                policyVersion?: string | undefined;
+                preferences?: {
+                    [x: string]: boolean;
+                } | undefined;
+                type: string;
+                vendorChoice?: {
+                    confirmedAt: number;
+                    grants: {
+                        [x: string]: boolean;
+                    };
+                    version: 1;
+                } | null | undefined;
+            }[];
+            createdAt: Date;
+            externalId: string;
+            id: string;
+        }[];
+    }, "DATABASE_ERROR" | "EXTERNAL_ID_REQUIRED" | "UNAUTHORIZED">;
+    readonly manifest: Endpoint<"/manifest", C15tManifestRequest | undefined, C15tManifestResult, never>;
+    readonly publishLegalDocument: Endpoint<"/legal-documents/:type/current", PublishLegalDocumentEndpointInput, {
+        policy: {
+            effectiveDate: Date;
+            hash: string;
+            id: string;
+            isActive: boolean;
+            type: string;
+            version: string;
+        };
+    }, "CONFLICT" | "DATABASE_ERROR" | "INPUT_VALIDATION_FAILED" | "UNAUTHORIZED">;
+    readonly status: Endpoint<"/status", undefined, {
+        client: {
+            acceptLanguage: string | null;
+            ip: string | null;
+            region: {
+                countryCode: string | null;
+                regionCode: string | null;
+            };
+            userAgent: string | null;
+        };
+        timestamp: Date;
+        version: string;
+    }, "SERVICE_UNAVAILABLE">;
+};
+export {};