@c15t/node-sdk 2.2.0 → 3.0.0-alpha.0

package/dist-types/client.d.ts

@@ -124,362 +124,563 @@ export declare class C15TClient {
          * Create a new subject
          */
         create: (input: PostSubjectInput, options?: FetchOptions<PostSubjectOutput, PostSubjectInput>) => Promise<ResponseContext<{
-            subjectId: string;
+            appliedPreferences?: {
+                [x: string]: boolean;
+            } | undefined;
             consentId: string;
-            domainId: string;
             domain: string;
-            type: string;
+            domainId: string;
+            givenAt: Date;
             metadata?: {
                 [x: string]: unknown;
             } | undefined;
-            appliedPreferences?: {
-                [x: string]: boolean;
-            } | undefined;
+            subjectId: string;
+            type: string;
             uiSource?: string | undefined;
-            givenAt: Date;
         }>>;
         /**
          * Get a subject by ID
          */
         get: (id: string, query?: GetSubjectQuery, options?: FetchOptions<GetSubjectOutput, never, GetSubjectQuery>) => Promise<ResponseContext<{
-            subject: {
-                id: string;
-                externalId?: string | undefined;
-                createdAt?: Date | undefined;
-            };
             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;
-                type: string;
+                isLatestPolicy: boolean;
+                policyEffectiveDate?: Date | undefined;
+                policyHash?: string | undefined;
                 policyId?: string | undefined;
                 policyVersion?: string | undefined;
-                policyHash?: string | undefined;
-                policyEffectiveDate?: Date | undefined;
-                isLatestPolicy: boolean;
                 preferences?: {
                     [x: string]: boolean;
                 } | undefined;
-                givenAt: Date;
+                type: string;
             }[];
             isValid: boolean;
-        }>>;
-        /**
-         * Update a subject
-         */
-        patch: (id: string, input: Omit<PatchSubjectFullInput, 'id'>, options?: FetchOptions<PatchSubjectOutput, Omit<PatchSubjectFullInput, 'id'>>) => Promise<ResponseContext<{
-            success: 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;
-                externalId: 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;
         }>>;
         /**
          * List subjects
          */
         list: (query?: ListSubjectsQuery, options?: FetchOptions<ListSubjectsOutput, never, ListSubjectsQuery>) => Promise<ResponseContext<{
             subjects: {
-                id: string;
-                externalId: string;
-                createdAt: Date;
                 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;
-                    type: string;
+                    isLatestPolicy: boolean;
+                    policyEffectiveDate?: Date | undefined;
+                    policyHash?: string | undefined;
                     policyId?: string | undefined;
                     policyVersion?: string | undefined;
-                    policyHash?: string | undefined;
-                    policyEffectiveDate?: Date | undefined;
-                    isLatestPolicy: boolean;
                     preferences?: {
                         [x: string]: boolean;
                     } | undefined;
-                    givenAt: Date;
+                    type: string;
                 }[];
+                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;
+        }>>;
     };
     /**
      * Namespaced access to meta endpoints
      */
     meta: {
-        /**
-         * Get API status
-         */
-        status: (options?: FetchOptions<StatusOutput>) => Promise<ResponseContext<{
-            version: string;
-            timestamp: Date;
-            client: {
-                ip: string | null;
-                acceptLanguage: string | null;
-                userAgent: string | null;
-                region: {
-                    countryCode: string | null;
-                    regionCode: string | null;
-                };
-            };
-        }>>;
         /**
          * 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;
-                        rejectAll: string;
+                        acknowledge?: string | undefined;
                         customize: string;
+                        dismiss?: string | undefined;
+                        rejectAll: string;
                         save: string;
                     };
-                    cookieBanner: {
-                        title: string;
-                        description: string;
-                    };
                     consentManagerDialog: {
-                        title: string;
                         description: string;
+                        title: string;
                     };
                     consentTypes: {
                         experience: {
-                            title: string;
                             description: string;
+                            title: string;
                         };
                         functionality: {
-                            title: string;
                             description: string;
+                            title: string;
                         };
                         marketing: {
-                            title: string;
                             description: string;
+                            title: string;
                         };
                         measurement: {
-                            title: string;
                             description: string;
+                            title: string;
                         };
                         necessary: {
-                            title: string;
                             description: string;
+                            title: string;
                         };
                     };
-                    frame: {
+                    cookieBanner: {
+                        description: string;
                         title: string;
+                        noticeDescription?: string | undefined;
+                        noticeTitle?: string | undefined;
+                    };
+                    frame: {
                         actionButton: string;
+                        title: string;
                     };
                     legalLinks: {
+                        cookiePolicy: string;
                         privacyPolicy: string;
                         termsOfService: string;
-                        cookiePolicy: string;
                     };
+                    rights?: {
+                        optOut?: string | undefined;
+                        preferences?: string | undefined;
+                    } | undefined;
                 } | {
                     common: {
                         acceptAll?: string | undefined;
-                        rejectAll?: string | undefined;
+                        acknowledge?: string | undefined;
                         customize?: string | undefined;
+                        dismiss?: string | undefined;
+                        rejectAll?: string | undefined;
                         save?: string | undefined;
                     };
-                    cookieBanner: {
-                        title?: string | undefined;
-                        description?: string | undefined;
-                    };
                     consentManagerDialog: {
-                        title?: string | undefined;
                         description?: string | undefined;
+                        title?: string | undefined;
                     };
                     consentTypes: {
                         experience?: {
-                            title?: string | undefined;
                             description?: string | undefined;
+                            title?: string | undefined;
                         } | undefined;
                         functionality?: {
-                            title?: string | undefined;
                             description?: string | undefined;
+                            title?: string | undefined;
                         } | undefined;
                         marketing?: {
-                            title?: string | undefined;
                             description?: string | undefined;
+                            title?: string | undefined;
                         } | undefined;
                         measurement?: {
-                            title?: string | undefined;
                             description?: string | undefined;
+                            title?: string | undefined;
                         } | undefined;
                         necessary?: {
-                            title?: string | undefined;
                             description?: string | undefined;
+                            title?: string | undefined;
                         } | undefined;
                     };
-                    frame?: {
+                    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;
-                        cookiePolicy?: string | undefined;
+                    } | undefined;
+                    rights?: {
+                        optOut?: string | undefined;
+                        preferences?: string | undefined;
                     } | undefined;
                 };
             };
-            branding: "c15t" | "consent" | "inth" | "none";
-            gvl?: {
-                gvlSpecificationVersion: number;
-                vendorListVersion: number;
-                tcfPolicyVersion: number;
-                lastUpdated: string;
-                purposes: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        description: string;
-                        illustrations: string[];
-                        descriptionLegal?: string | undefined;
-                    };
-                };
-                specialPurposes: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        description: string;
-                        illustrations: string[];
-                        descriptionLegal?: string | undefined;
-                    };
-                };
-                features: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        description: string;
-                        illustrations: string[];
-                        descriptionLegal?: string | undefined;
-                    };
-                };
-                specialFeatures: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        description: string;
-                        illustrations: string[];
-                        descriptionLegal?: string | undefined;
-                    };
-                };
-                vendors: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        purposes: number[];
-                        legIntPurposes: number[];
-                        flexiblePurposes: number[];
-                        specialPurposes: number[];
-                        features: number[];
-                        specialFeatures: number[];
-                        cookieMaxAgeSeconds: number | null;
-                        usesCookies: boolean;
-                        cookieRefresh: boolean;
-                        usesNonCookieAccess: boolean;
-                        urls: {
-                            langId: string;
-                            privacy?: string | undefined;
-                            legIntClaim?: string | undefined;
-                        }[];
-                        deviceStorageDisclosureUrl?: string | undefined;
-                        dataCategories?: number[] | undefined;
-                        dataRetention?: {
-                            purposes?: {
-                                [x: string]: number;
-                            } | undefined;
-                            specialPurposes?: {
-                                [x: string]: number;
-                            } | undefined;
-                            stdRetention?: number | undefined;
-                        } | undefined;
-                        deletedDate?: string | undefined;
-                        overflow?: {
-                            httpGetLimit: number;
-                        } | undefined;
-                    };
-                };
-                stacks: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        description: string;
-                        purposes: number[];
-                        specialFeatures: number[];
-                    };
+        }>>;
+        /**
+         * Get API status
+         */
+        status: (options?: FetchOptions<StatusOutput>) => Promise<ResponseContext<{
+            client: {
+                acceptLanguage: string | null;
+                ip: string | null;
+                region: {
+                    countryCode: string | null;
+                    regionCode: string | null;
                 };
-                dataCategories?: {
-                    [x: string]: {
-                        id: number;
-                        name: string;
-                        description: string;
-                    };
-                } | undefined;
-            } | null | undefined;
-            customVendors?: {
-                id: string | number;
-                name: string;
-                privacyPolicyUrl: string;
-                description?: string | undefined;
-                purposes: number[];
-                legIntPurposes?: number[] | undefined;
-                features?: number[] | undefined;
-                specialFeatures?: number[] | undefined;
-                dataCategories?: number[] | undefined;
-                cookieMaxAgeSeconds?: number | undefined;
-                usesCookies?: boolean | undefined;
-                usesNonCookieAccess?: boolean | undefined;
-                dataRetentionDays?: number | undefined;
-            }[] | undefined;
-            cmpId?: number | undefined;
-            policy?: {
-                id: string;
-                model: "iab" | "none" | "opt-in" | "opt-out";
-                i18n?: {
-                    language?: string | undefined;
-                    messageProfile?: string | undefined;
-                } | undefined;
-                consent?: {
-                    expiryDays?: number | undefined;
-                    scopeMode?: "permissive" | "strict" | undefined;
-                    categories?: string[] | undefined;
-                    preselectedCategories?: string[] | undefined;
-                    gpc?: boolean | undefined;
-                } | undefined;
-                ui?: {
-                    mode?: "banner" | "dialog" | "none" | undefined;
-                    banner?: {
-                        allowedActions?: ("accept" | "customize" | "reject")[] | undefined;
-                        primaryActions?: ("accept" | "customize" | "reject")[] | undefined;
-                        layout?: ("accept" | "customize" | "reject" | ("accept" | "customize" | "reject")[])[] | undefined;
-                        direction?: "column" | "row" | undefined;
-                        uiProfile?: "balanced" | "compact" | "strict" | undefined;
-                        scrollLock?: boolean | undefined;
-                    } | undefined;
-                    dialog?: {
-                        allowedActions?: ("accept" | "customize" | "reject")[] | undefined;
-                        primaryActions?: ("accept" | "customize" | "reject")[] | undefined;
-                        layout?: ("accept" | "customize" | "reject" | ("accept" | "customize" | "reject")[])[] | undefined;
-                        direction?: "column" | "row" | undefined;
-                        uiProfile?: "balanced" | "compact" | "strict" | undefined;
-                        scrollLock?: boolean | undefined;
-                    } | undefined;
-                } | undefined;
-                proof?: {
-                    storeIp?: boolean | undefined;
-                    storeUserAgent?: boolean | undefined;
-                    storeLanguage?: boolean | undefined;
-                } | undefined;
-            } | undefined;
-            policyDecision?: {
-                policyId: string;
-                fingerprint: string;
-                matchedBy: "country" | "default" | "fallback" | "region";
-                country: string | null;
-                region: string | null;
-                jurisdiction: "APPI" | "AU" | "BR" | "CCPA" | "CH" | "GDPR" | "NONE" | "PIPA" | "PIPEDA" | "QC_LAW25" | "UK_GDPR";
-            } | undefined;
-            policySnapshotToken?: string | undefined;
+                userAgent: string | null;
+            };
+            timestamp: Date;
+            version: string;
         }>>;
     };
 }