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

package/dist-types/client.d.ts

@@ -1,730 +1,137 @@
-import type { CheckConsentOutput, CheckConsentQuery, GetSubjectOutput, GetSubjectQuery, InitOutput, ListSubjectsOutput, ListSubjectsQuery, PatchSubjectFullInput, PatchSubjectOutput, PostSubjectInput, PostSubjectOutput, StatusOutput } from '@c15t/schema/types';
-import type { C15TClientOptions, FetchOptions, ResponseContext } from './types.js';
-/**
- * C15T Client for interacting with the consent management API
- *
- * @example
- * ```typescript
- * const client = new C15TClient({
- *   baseUrl: 'https://api.example.com',
- *   token: 'your-auth-token',
- * });
- *
- * // Check API status
- * const statusResponse = await client.status();
- *
- * // Initialize consent manager
- * const initResponse = await client.init();
- *
- * // Create a subject with consent
- * const subject = await client.createSubject({
- *   type: 'new',
- *   subjectId: 'sub_123',
- *   consents: { analytics: true },
- * });
- * ```
- */
-export declare class C15TClient {
+import type { ConsentPolicyType, ExperimentSummaryOutput, GetSubjectOutput, InitOutput, LegalDocumentCurrentOutput, LegalDocumentPolicyType, ListSubjectsOutput, PatchSubjectOutput, PostSubjectOutput, StatusOutput } from '@c15t/schema/types';
+import type { C15tCheckConsentInput, C15tCheckConsentOutput, C15tCreateSubjectInput, C15tExperimentSummaryRequest, C15tGetSubjectRequest, C15tIdentifySubjectInput, C15tInitRequest, C15tManifestRequest, C15tManifestResult, C15tPublishLegalDocumentInput } from './contract.js';
+import type { C15tCallOptions, C15tClientOptions } from './options.js';
+import type { C15tResult } from './result.js';
+/** `subjects` methods available without an API key. */
+export interface C15tPublicSubjects {
     /**
-     * Internal fetcher context
-     */
-    private context;
-    /**
-     * Creates a new C15T client instance
-     *
-     * @param options - Client configuration options
-     * @throws {TypeError} If baseUrl is invalid or not provided (and no env var)
-     */
-    constructor(options?: C15TClientOptions);
-    /**
-     * Get API status
+     * Reads a subject and its consents.
      *
-     * @param options - Optional fetch options
-     * @returns Status response with version and client info
+     * @param id - Subject id, such as `sub_2jv6z8n4q9`.
+     * @param request - Optional filter by policy type.
      */
-    status(options?: FetchOptions<StatusOutput>): Promise<ResponseContext<StatusOutput>>;
+    get: (id: string, request?: C15tGetSubjectRequest, options?: C15tCallOptions) => Promise<C15tResult<GetSubjectOutput, 'DATABASE_ERROR' | 'NOT_FOUND'>>;
     /**
-     * Initialize consent manager
+     * Records a consent, creating the subject if it does not exist.
+     * Retried submissions resolve to the same consent.
      *
-     * @param options - Optional fetch options
-     * @returns Init response with jurisdiction, location, translations, branding
+     * @param input - The consent. `type` selects which fields apply.
      */
-    init(options?: FetchOptions<InitOutput>): Promise<ResponseContext<InitOutput>>;
+    create: (input: C15tCreateSubjectInput, options?: C15tCallOptions) => Promise<C15tResult<PostSubjectOutput, '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'>>;
     /**
-     * Create a new subject with consent preferences
+     * Links a subject to your own user id, so `consents.check` and
+     * `subjects.list` can find it. Call it after the visitor signs in.
      *
-     * @param input - Subject creation input
-     * @param options - Optional fetch options
-     * @returns Created subject response
+     * @param id - Subject id from the visitor's browser.
+     * @param input - Your user id and, optionally, who issued it.
      */
-    createSubject(input: PostSubjectInput, options?: FetchOptions<PostSubjectOutput, PostSubjectInput>): Promise<ResponseContext<PostSubjectOutput>>;
-    /**
-     * Get a subject by ID
-     *
-     * @param id - Subject ID
-     * @param query - Optional query parameters
-     * @param options - Optional fetch options
-     * @returns Subject data response
-     */
-    getSubject(id: string, query?: GetSubjectQuery, options?: FetchOptions<GetSubjectOutput, never, GetSubjectQuery>): Promise<ResponseContext<GetSubjectOutput>>;
+    identify: (id: string, input: C15tIdentifySubjectInput, options?: C15tCallOptions) => Promise<C15tResult<PatchSubjectOutput, 'DATABASE_ERROR' | 'EXTERNAL_ID_REQUIRED' | 'NOT_FOUND'>>;
+}
+/** `subjects` methods on a client with an API key. */
+export interface C15tSubjects extends C15tPublicSubjects {
     /**
-     * Update a subject (link external ID or update preferences)
-     *
-     * @param id - Subject ID
-     * @param input - Patch input with externalId or other fields
-     * @param options - Optional fetch options
-     * @returns Updated subject response
+     * Lists every subject linked to one of your user ids, with their consents.
+     * Needs an API key.
      */
-    patchSubject(id: string, input: Omit<PatchSubjectFullInput, 'id'>, options?: FetchOptions<PatchSubjectOutput, Omit<PatchSubjectFullInput, 'id'>>): Promise<ResponseContext<PatchSubjectOutput>>;
+    list: (query: {
+        readonly externalId: string;
+    }, options?: C15tCallOptions) => Promise<C15tResult<ListSubjectsOutput, 'DATABASE_ERROR' | 'EXTERNAL_ID_REQUIRED' | 'UNAUTHORIZED'>>;
+}
+/** `consents` methods. */
+export interface C15tConsents {
     /**
-     * List subjects with optional filtering
+     * Reports whether a user has consented to each policy type. Every
+     * requested type appears in `results`, consented or not.
      *
-     * @param query - Query parameters for filtering
-     * @param options - Optional fetch options
-     * @returns List of subjects
+     * @example
+     * ```ts
+     * const result = await c15t.consents.check({
+     *   externalId: user.id,
+     *   types: ['marketing_communications'],
+     * });
+     * if (result.ok && result.data.results.marketing_communications.hasConsent) {
+     *   await sendNewsletter(user);
+     * }
+     * ```
      */
-    listSubjects(query?: ListSubjectsQuery, options?: FetchOptions<ListSubjectsOutput, never, ListSubjectsQuery>): Promise<ResponseContext<ListSubjectsOutput>>;
+    check: <const Types extends readonly [ConsentPolicyType, ...ConsentPolicyType[]]>(input: C15tCheckConsentInput<Types>, options?: C15tCallOptions) => Promise<C15tResult<C15tCheckConsentOutput<Types[number]>, 'DATABASE_ERROR' | 'EXTERNAL_ID_REQUIRED' | 'TYPE_REQUIRED'>>;
+}
+/** `experiments` methods. Need an API key. */
+export interface C15tExperiments {
     /**
-     * Check consent status for an external ID
+     * Counts choices per arm of a banner experiment, by action and surface,
+     * with the median time to decision.
      *
-     * @param query - Query parameters (externalId required)
-     * @param options - Optional fetch options
-     * @returns Consent check response
+     * @param id - Experiment id, as configured on the client.
      */
-    checkConsent(query: CheckConsentQuery, options?: FetchOptions<CheckConsentOutput, never, CheckConsentQuery>): Promise<ResponseContext<CheckConsentOutput>>;
+    summary: (id: string, request?: C15tExperimentSummaryRequest, options?: C15tCallOptions) => Promise<C15tResult<ExperimentSummaryOutput, 'DATABASE_ERROR' | 'INPUT_VALIDATION_FAILED' | 'UNAUTHORIZED'>>;
+}
+/** `legalDocuments` methods. Need an API key. */
+export interface C15tLegalDocuments {
     /**
-     * Make a custom API request to any endpoint
+     * Publishes a legal document release as the current version, so new
+     * consents record it. Call it from the job that ships the document.
      *
-     * @param path - API endpoint path
-     * @param options - Fetch options
-     * @returns Response context
-     */
-    $fetch<ResponseType, BodyType = unknown, QueryType = unknown>(path: string, options?: FetchOptions<ResponseType, BodyType, QueryType>): Promise<ResponseContext<ResponseType>>;
-    /**
-     * Namespaced access to consent endpoints
+     * @param type - Document type, such as `privacy_policy` or
+     * `terms_and_conditions_b2b`.
      */
-    consent: {
-        /**
-         * Check consent status for an external ID
-         */
-        check: (query: CheckConsentQuery, options?: FetchOptions<CheckConsentOutput, never, CheckConsentQuery>) => Promise<ResponseContext<{
-            results: {
-                [x: string]: {
-                    hasConsent: boolean;
-                    isLatestPolicy: boolean;
-                };
-            };
-        }>>;
-    };
+    publish: (type: LegalDocumentPolicyType, input: C15tPublishLegalDocumentInput, options?: C15tCallOptions) => Promise<C15tResult<LegalDocumentCurrentOutput, 'CONFLICT' | 'DATABASE_ERROR' | 'INPUT_VALIDATION_FAILED' | 'UNAUTHORIZED'>>;
+}
+/**
+ * A client created without an API key: the routes the backend serves
+ * without one.
+ */
+export interface C15tPublicClient {
+    /** Backend version and the request context it saw. */
+    status: (options?: C15tCallOptions) => Promise<C15tResult<StatusOutput, 'SERVICE_UNAVAILABLE'>>;
     /**
-     * Namespaced access to subject endpoints
+     * Resolves the consent banner for a visitor: jurisdiction, translations,
+     * policies. Pass the visitor's context when calling from a server.
      */
-    subjects: {
-        /**
-         * Create a new subject
-         */
-        create: (input: PostSubjectInput, options?: FetchOptions<PostSubjectOutput, PostSubjectInput>) => Promise<ResponseContext<{
-            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;
-        }>>;
-        /**
-         * Get a subject by ID
-         */
-        get: (id: string, query?: GetSubjectQuery, options?: FetchOptions<GetSubjectOutput, never, GetSubjectQuery>) => Promise<ResponseContext<{
-            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;
-            privacyDirectives?: {
-                authority: "api" | "subject";
-                categories: ("experience" | "functionality" | "marketing" | "measurement")[];
-                id: string;
-                recordedAt: number;
-                signalHeader: boolean | null;
-                source: "gpc";
-            }[] | undefined;
-            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;
-        }>>;
-        /**
-         * List subjects
-         */
-        list: (query?: ListSubjectsQuery, options?: FetchOptions<ListSubjectsOutput, never, ListSubjectsQuery>) => Promise<ResponseContext<{
-            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;
-            }[];
-        }>>;
-        /**
-         * Update a subject
-         */
-        patch: (id: string, input: Omit<PatchSubjectFullInput, 'id'>, options?: FetchOptions<PatchSubjectOutput, Omit<PatchSubjectFullInput, 'id'>>) => Promise<ResponseContext<{
-            subject: {
-                externalId: string;
-                id: string;
-            };
-            success: boolean;
-        }>>;
-    };
+    init: (request?: C15tInitRequest, options?: C15tCallOptions) => Promise<C15tResult<InitOutput>>;
     /**
-     * Namespaced access to meta endpoints
+     * Fetches the consent manifest, the cacheable configuration `init` is
+     * resolved from. Pass the `etag` you hold as `ifNoneMatch` to skip
+     * downloading an unchanged manifest.
      */
-    meta: {
-        /**
-         * Initialize consent manager
-         */
-        init: (options?: FetchOptions<InitOutput>) => Promise<ResponseContext<{
-            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;
-                    };
-                } | undefined;
-                features: {
-                    [x: string]: {
-                        description: string;
-                        descriptionLegal?: string | undefined;
-                        id: number;
-                        illustrations: string[];
-                        name: string;
-                    };
-                };
-                gvlSpecificationVersion: number;
-                lastUpdated: string;
-                purposes: {
-                    [x: string]: {
-                        description: string;
-                        descriptionLegal?: string | undefined;
-                        id: number;
-                        illustrations: string[];
-                        name: string;
-                    };
-                };
-                specialFeatures: {
-                    [x: string]: {
-                        description: string;
-                        descriptionLegal?: string | undefined;
-                        id: number;
-                        illustrations: string[];
-                        name: string;
-                    };
-                };
-                specialPurposes: {
-                    [x: string]: {
-                        description: string;
-                        descriptionLegal?: string | undefined;
-                        id: number;
-                        illustrations: string[];
-                        name: string;
-                    };
-                };
-                stacks: {
-                    [x: string]: {
-                        description: string;
-                        id: number;
-                        name: string;
-                        purposes: number[];
-                        specialFeatures: number[];
-                    };
-                };
-                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;
-                        } | undefined;
-                        deletedDate?: string | undefined;
-                        deviceStorageDisclosureUrl?: string | undefined;
-                        features: number[];
-                        flexiblePurposes: number[];
-                        id: number;
-                        legIntPurposes: number[];
-                        name: string;
-                        overflow?: {
-                            httpGetLimit: number;
-                        } | undefined;
-                        purposes: number[];
-                        specialFeatures: number[];
-                        specialPurposes: number[];
-                        urls: {
-                            langId: string;
-                            legIntClaim?: string | undefined;
-                            privacy?: string | undefined;
-                        }[];
-                        usesCookies: boolean;
-                        usesNonCookieAccess: boolean;
-                    };
-                };
-            } | 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;
-            jurisdiction: "APPI" | "AU" | "BR" | "CCPA" | "CH" | "GDPR" | "NONE" | "PIPA" | "PIPEDA" | "QC_LAW25" | "UK_GDPR";
-            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;
-                        acknowledge?: string | undefined;
-                        customize: string;
-                        dismiss?: string | undefined;
-                        rejectAll: string;
-                        save: string;
-                    };
-                    consentManagerDialog: {
-                        description: string;
-                        title: string;
-                        vendors?: {
-                            disabledByCategory?: string | undefined;
-                            privacyPolicy?: string | undefined;
-                            switchLabel?: string | undefined;
-                            title?: string | undefined;
-                        } | undefined;
-                    };
-                    consentTypes: {
-                        experience: {
-                            description: string;
-                            title: string;
-                        };
-                        functionality: {
-                            description: string;
-                            title: string;
-                        };
-                        marketing: {
-                            description: string;
-                            title: string;
-                        };
-                        measurement: {
-                            description: string;
-                            title: string;
-                        };
-                        necessary: {
-                            description: string;
-                            title: string;
-                        };
-                    };
-                    cookieBanner: {
-                        description: string;
-                        title: string;
-                        noticeDescription?: string | undefined;
-                        noticeTitle?: string | undefined;
-                    };
-                    frame: {
-                        actionButton: string;
-                        title: string;
-                    };
-                    legalLinks: {
-                        cookiePolicy: string;
-                        privacyPolicy: string;
-                        termsOfService: string;
-                    };
-                    rights?: {
-                        optOut?: string | undefined;
-                        preferences?: string | undefined;
-                    } | undefined;
-                } | {
-                    common: {
-                        acceptAll?: string | undefined;
-                        acknowledge?: string | undefined;
-                        customize?: string | undefined;
-                        dismiss?: string | undefined;
-                        rejectAll?: string | undefined;
-                        save?: string | 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;
-                    };
-                    frame?: {
-                        actionButton?: string | undefined;
-                        title?: string | undefined;
-                    } | 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/shared").VendorCategoryCondition;
-                description?: string | undefined;
-                disabled?: boolean | undefined;
-                homepageUrl?: string | undefined;
-                id: string;
-                legalName?: string | undefined;
-                name: string;
-                privacyPolicyUrl: string;
-            }[] | undefined;
-        }>>;
-        /**
-         * Get API status
-         */
-        status: (options?: FetchOptions<StatusOutput>) => Promise<ResponseContext<{
-            client: {
-                acceptLanguage: string | null;
-                ip: string | null;
-                region: {
-                    countryCode: string | null;
-                    regionCode: string | null;
-                };
-                userAgent: string | null;
-            };
-            timestamp: Date;
-            version: string;
-        }>>;
-    };
+    manifest: (request?: C15tManifestRequest, options?: C15tCallOptions) => Promise<C15tResult<C15tManifestResult>>;
+    readonly subjects: C15tPublicSubjects;
+    readonly consents: C15tConsents;
 }
+/** A client created with an API key. */
+export interface C15tClient extends C15tPublicClient {
+    readonly subjects: C15tSubjects;
+    readonly experiments: C15tExperiments;
+    readonly legalDocuments: C15tLegalDocuments;
+}
+/**
+ * Creates a client for a hosted or self-hosted c15t backend.
+ *
+ * Methods resolve to `{ ok: true, data }` or `{ ok: false, error }` and never
+ * reject. Methods that need an API key exist only on a client created with
+ * one.
+ *
+ * @param options - Backend URL, optional API key, transport settings.
+ * @returns A client. Its type depends on whether `apiKey` was passed.
+ * @throws {C15tConfigurationError} When an option is invalid. Every problem
+ * is reported at once.
+ *
+ * @example
+ * ```ts
+ * import { createC15tClient } from '@c15t/node-sdk';
+ *
+ * const c15t = createC15tClient({
+ *   baseUrl: 'https://consent.example.com/api/c15t',
+ *   apiKey: process.env.C15T_API_KEY!,
+ * });
+ *
+ * const result = await c15t.subjects.list({ externalId: 'user_123' });
+ * ```
+ */
+export declare function createC15tClient(options: C15tClientOptions & {
+    readonly apiKey: string;
+}): C15tClient;
+export declare function createC15tClient(options: C15tClientOptions & {
+    readonly apiKey?: undefined;
+}): C15tPublicClient;
+export declare function createC15tClient(options: C15tClientOptions): C15tClient | C15tPublicClient;