@usercentrics/react-native-sdk 2.23.2 → 2.24.0

package/src/models/UsercentricsLabels.tsx

@@ -0,0 +1,276 @@
+export class UsercentricsLabels {
+
+    btnAcceptAll: string
+    btnDeny: string
+    btnSave: string
+    firstLayerTitle: string
+    accepted: string
+    denied: string
+    date: string
+    decision: string
+    dataCollectedList: string
+    dataCollectedInfo: string
+    locationOfProcessing: string
+    transferToThirdCountries: string
+    transferToThirdCountriesInfo: string
+    dataPurposes: string
+    dataPurposesInfo: string
+    dataRecipientsList: string
+    descriptionOfService: string
+    history: string
+    historyDescription: string
+    legalBasisList: string
+    legalBasisInfo: string
+    processingCompanyTitle: string
+    retentionPeriod: string
+    technologiesUsed: string
+    technologiesUsedInfo: string
+    cookiePolicyInfo: string
+    optOut: string
+    policyOf: string
+    imprintLinkText: string
+    privacyPolicyLinkText: string
+    categories: string
+    anyDomain: string
+    day: string
+    days: string
+    domain: string
+    duration: string
+    informationLoadingNotPossible: string
+    hour: string
+    hours: string
+    identifier: string
+    maximumAgeCookieStorage: string
+    minute: string
+    minutes: string
+    month: string
+    months: string
+    multipleDomains: string
+    no: string
+    nonCookieStorage: string
+    seconds: string
+    session: string
+    loadingStorageInformation: string
+    storageInformation: string
+    detailedStorageInformation: string
+    tryAgain: string
+    type: string
+    year: string
+    years: string
+    yes: string
+    storageInformationDescription: string
+    btnBannerReadMore: string
+    readLess: string
+    btnMore: string
+    more: string
+    linkToDpaInfo: string
+    second: string
+    consent: string
+    headerModal: string
+    secondLayerDescriptionHtml: string
+    secondLayerTitle: string
+
+    // Optional
+    settings: string
+    subConsents: string
+    btnAccept: string
+    poweredBy: string
+    dataProtectionOfficer: string
+    nameOfProcessingCompany: string
+    btnBack: string
+    copy: string
+    copied: string
+    basic: string
+    advanced: string
+    processingCompany: string
+    name: string
+    explicit: string
+    implicit: string
+    btnMoreInfo: string
+    furtherInformationOptOut: string
+    cookiePolicyLinkText: string
+    noImplicit: string
+    yesImplicit: string
+
+    constructor(
+        btnAcceptAll: string,
+        btnDeny: string,
+        btnSave: string,
+        firstLayerTitle: string,
+        accepted: string,
+        denied: string,
+        date: string,
+        decision: string,
+        dataCollectedList: string,
+        dataCollectedInfo: string,
+        locationOfProcessing: string,
+        transferToThirdCountries: string,
+        transferToThirdCountriesInfo: string,
+        dataPurposes: string,
+        dataPurposesInfo: string,
+        dataRecipientsList: string,
+        descriptionOfService: string,
+        history: string,
+        historyDescription: string,
+        legalBasisList: string,
+        legalBasisInfo: string,
+        processingCompanyTitle: string,
+        retentionPeriod: string,
+        technologiesUsed: string,
+        technologiesUsedInfo: string,
+        cookiePolicyInfo: string,
+        optOut: string,
+        policyOf: string,
+        imprintLinkText: string,
+        privacyPolicyLinkText: string,
+        categories: string,
+        anyDomain: string,
+        day: string,
+        days: string,
+        domain: string,
+        duration: string,
+        informationLoadingNotPossible: string,
+        hour: string,
+        hours: string,
+        identifier: string,
+        maximumAgeCookieStorage: string,
+        minute: string,
+        minutes: string,
+        month: string,
+        months: string,
+        multipleDomains: string,
+        no: string,
+        nonCookieStorage: string,
+        seconds: string,
+        session: string,
+        loadingStorageInformation: string,
+        storageInformation: string,
+        detailedStorageInformation: string,
+        tryAgain: string,
+        type: string,
+        year: string,
+        years: string,
+        yes: string,
+        storageInformationDescription: string,
+        btnBannerReadMore: string,
+        readLess: string,
+        btnMore: string,
+        more: string,
+        linkToDpaInfo: string,
+        second: string,
+        consent: string,
+        headerModal: string,
+        secondLayerDescriptionHtml: string,
+        secondLayerTitle: string,
+        settings: string,
+        subConsents: string,
+        btnAccept: string,
+        poweredBy: string,
+        dataProtectionOfficer: string,
+        nameOfProcessingCompany: string,
+        btnBack: string,
+        copy: string,
+        copied: string,
+        basic: string,
+        advanced: string,
+        processingCompany: string,
+        name: string,
+        explicit: string,
+        implicit: string,
+        btnMoreInfo: string,
+        furtherInformationOptOut: string,
+        cookiePolicyLinkText: string,
+        noImplicit: string,
+        yesImplicit: string,
+    ) {
+        this.btnAcceptAll = btnAcceptAll
+        this.btnDeny = btnDeny
+        this.btnSave = btnSave
+        this.firstLayerTitle = firstLayerTitle
+        this.accepted = accepted
+        this.denied = denied
+        this.date = date
+        this.decision = decision
+        this.dataCollectedList = dataCollectedList
+        this.dataCollectedInfo = dataCollectedInfo
+        this.locationOfProcessing = locationOfProcessing
+        this.transferToThirdCountries = transferToThirdCountries
+        this.transferToThirdCountriesInfo = transferToThirdCountriesInfo
+        this.dataPurposes = dataPurposes
+        this.dataPurposesInfo = dataPurposesInfo
+        this.dataRecipientsList = dataRecipientsList
+        this.descriptionOfService = descriptionOfService
+        this.history = history
+        this.historyDescription = historyDescription
+        this.legalBasisList = legalBasisList
+        this.legalBasisInfo = legalBasisInfo
+        this.processingCompanyTitle = processingCompanyTitle
+        this.retentionPeriod = retentionPeriod
+        this.technologiesUsed = technologiesUsed
+        this.technologiesUsedInfo = technologiesUsedInfo
+        this.cookiePolicyInfo = cookiePolicyInfo
+        this.optOut = optOut
+        this.policyOf = policyOf
+        this.imprintLinkText = imprintLinkText
+        this.privacyPolicyLinkText = privacyPolicyLinkText
+        this.categories = categories
+        this.anyDomain = anyDomain
+        this.day = day
+        this.days = days
+        this.domain = domain
+        this.duration = duration
+        this.informationLoadingNotPossible = informationLoadingNotPossible
+        this.hour = hour
+        this.hours = hours
+        this.identifier = identifier
+        this.maximumAgeCookieStorage = maximumAgeCookieStorage
+        this.minute = minute
+        this.minutes = minutes
+        this.month = month
+        this.months = months
+        this.multipleDomains = multipleDomains
+        this.no = no
+        this.nonCookieStorage = nonCookieStorage
+        this.seconds = seconds
+        this.session = session
+        this.loadingStorageInformation = loadingStorageInformation
+        this.storageInformation = storageInformation
+        this.detailedStorageInformation = detailedStorageInformation
+        this.tryAgain = tryAgain
+        this.type = type
+        this.year = year
+        this.years = years
+        this.yes = yes
+        this.storageInformationDescription = storageInformationDescription
+        this.btnBannerReadMore = btnBannerReadMore
+        this.readLess = readLess
+        this.btnMore = btnMore
+        this.more = more
+        this.linkToDpaInfo = linkToDpaInfo
+        this.second = second
+        this.consent = consent
+        this.headerModal = headerModal
+        this.secondLayerDescriptionHtml = secondLayerDescriptionHtml
+        this.secondLayerTitle = secondLayerTitle
+        this.settings = settings
+        this.subConsents = subConsents
+        this.btnAccept = btnAccept
+        this.poweredBy = poweredBy
+        this.dataProtectionOfficer = dataProtectionOfficer
+        this.nameOfProcessingCompany = nameOfProcessingCompany
+        this.btnBack = btnBack
+        this.copy = copy
+        this.copied = copied
+        this.basic = basic
+        this.advanced = advanced
+        this.processingCompany = processingCompany
+        this.name = name
+        this.explicit = explicit
+        this.implicit = implicit
+        this.btnMoreInfo = btnMoreInfo
+        this.furtherInformationOptOut = furtherInformationOptOut
+        this.cookiePolicyLinkText = cookiePolicyLinkText
+        this.noImplicit = noImplicit
+        this.yesImplicit = yesImplicit
+    }
+}

package/src/models/UsercentricsLocation.tsx

@@ -0,0 +1,32 @@
+export class UsercentricsLocation {
+
+    /// The country code. E.g 'DE'.
+    countryCode: string
+
+    /// The region code following the local format. E.g 'CA'.
+    regionCode: string
+
+    /// True, if the location is inside the European Union. False, it not.
+    isInEU: boolean
+
+    /// True, if the location is inside the United States of America. False, it not.
+    isInUS: boolean
+
+    /// True, if the location is inside the state of California. False, it not.
+    isInCalifornia: boolean
+
+    constructor(
+        countryCode: string,
+        regionCode: string,
+        isInEU: boolean,
+        isInUS: boolean,
+        isInCalifornia: boolean
+    ) {
+        this.countryCode = countryCode
+        this.regionCode = regionCode
+        this.isInEU = isInEU
+        this.isInUS = isInUS
+        this.isInCalifornia = isInCalifornia
+    }
+
+}

package/src/models/UsercentricsLoggerLevel.tsx

@@ -0,0 +1,7 @@
+export enum UsercentricsLoggerLevel {
+
+    none = 0,
+    error = 1,
+    warning = 2,
+    debug = 3
+}

package/src/models/UsercentricsOptions.tsx

@@ -0,0 +1,45 @@
+import {NetworkMode, UsercentricsLoggerLevel} from ".";
+
+export class UsercentricsOptions {
+    settingsId?: string;
+    ruleSetId?: string;
+    defaultLanguage?: string;
+    loggerLevel?: UsercentricsLoggerLevel;
+    timeoutMillis?: number;
+    version?: string;
+    networkMode?: NetworkMode;
+    consentMediation?: Boolean;
+    initTimeoutMillis?: number;
+
+    constructor({
+                    settingsId = "",
+                    ruleSetId = "",
+                    defaultLanguage = undefined,
+                    loggerLevel = undefined,
+                    timeoutMillis = undefined,
+                    version = undefined,
+                    networkMode = undefined,
+                    consentMediation = undefined,
+                    initTimeoutMillis = undefined
+                }: {
+        settingsId?: string,
+        ruleSetId?: string,
+        defaultLanguage?: string,
+        loggerLevel?: UsercentricsLoggerLevel,
+        timeoutMillis?: number,
+        version?: string,
+        networkMode?: NetworkMode,
+        consentMediation?: Boolean,
+        initTimeoutMillis?: number
+    }) {
+        this.settingsId = settingsId;
+        this.ruleSetId = ruleSetId;
+        this.defaultLanguage = defaultLanguage
+        this.loggerLevel = loggerLevel
+        this.timeoutMillis = timeoutMillis
+        this.version = version
+        this.networkMode = networkMode
+        this.consentMediation = consentMediation
+        this.initTimeoutMillis = initTimeoutMillis
+    }
+}

package/src/models/UsercentricsReadyStatus.tsx

@@ -0,0 +1,20 @@
+import {UsercentricsLocation, UsercentricsServiceConsent} from "."
+import {GeolocationRuleset} from "./GeolocationRuleset";
+
+export class UsercentricsReadyStatus {
+
+    shouldCollectConsent: boolean
+    consents: [UsercentricsServiceConsent]
+    geolocationRuleset?: GeolocationRuleset;
+    location: UsercentricsLocation;
+
+    constructor(shouldCollectConsent: boolean,
+                consents: [UsercentricsServiceConsent],
+                location: UsercentricsLocation,
+                geolocationRuleSet?: GeolocationRuleset,) {
+        this.shouldCollectConsent = shouldCollectConsent
+        this.consents = consents
+        this.geolocationRuleset = geolocationRuleSet
+        this.location = location
+    }
+}

package/src/models/UsercentricsService.tsx

@@ -0,0 +1,134 @@
+import {ConsentDisclosureObject} from "./ConsentDisclosureObject";
+
+export class UsercentricsService {
+
+    /// The template ID of the service.
+    templateId: string
+
+    /// The version of the service.
+    version: string
+
+    /// The category slug identifier of the service.
+    categorySlug: string
+
+    isEssential: boolean
+
+    type: string
+    dataProcessor: string
+    dataPurposes: [string]
+    processingCompany: string
+    nameOfProcessingCompany: string
+    addressOfProcessingCompany: string
+    descriptionOfService: string
+    languagesAvailable: [string]
+    dataCollectedList: [string]
+    dataPurposesList: [string]
+    dataRecipientsList: [string]
+    legalBasisList: [string]
+    retentionPeriodList: [string]
+    subConsents: [string]
+    language: string
+    linkToDpa: string
+    legalGround: string
+    optOutUrl: string
+    policyOfProcessorUrl: string
+    retentionPeriodDescription: string
+    dataProtectionOfficer: string
+    privacyPolicyURL: string
+    cookiePolicyURL: string
+    locationOfProcessing: string
+    dataCollectedDescription: string
+    thirdCountryTransfer: string
+    description: string
+    cookieMaxAgeSeconds: number
+    usesNonCookieAccess?: boolean
+    deviceStorageDisclosureUrl: string
+    technologyUsed: [string]
+    isDeactivated?: boolean
+    disableLegalBasis?: boolean
+    deviceStorage?: ConsentDisclosureObject
+    isHidden: boolean
+
+    constructor(
+        templateId: string,
+        version: string,
+        categorySlug: string,
+        type: string,
+        isEssential: boolean,
+        dataProcessor: string,
+        dataPurposes: [string],
+        processingCompany: string,
+        nameOfProcessingCompany: string,
+        addressOfProcessingCompany: string,
+        descriptionOfService: string,
+        languagesAvailable: [string],
+        dataCollectedList: [string],
+        dataPurposesList: [string],
+        dataRecipientsList: [string],
+        legalBasisList: [string],
+        retentionPeriodList: [string],
+        subConsents: [string],
+        language: string,
+        linkToDpa: string,
+        legalGround: string,
+        optOutUrl: string,
+        policyOfProcessorUrl: string,
+        retentionPeriod: number,
+        retentionPeriodDescription: string,
+        dataProtectionOfficer: string,
+        privacyPolicyURL: string,
+        cookiePolicyURL: string,
+        locationOfProcessing: string,
+        dataCollectedDescription: string,
+        thirdCountryTransfer: string,
+        description: string,
+        cookieMaxAgeSeconds: number,
+        deviceStorageDisclosureUrl: string,
+        technologyUsed: [string],
+        isHidden: boolean,
+        isDeactivated?: boolean,
+        disableLegalBasis?: boolean,
+        usesNonCookieAccess?: boolean,
+        deviceStorage?: ConsentDisclosureObject,
+    ) {
+        this.templateId = templateId
+        this.version = version
+        this.categorySlug = categorySlug
+        this.type = type
+        this.dataProcessor = dataProcessor
+        this.dataPurposes = dataPurposes
+        this.processingCompany = processingCompany
+        this.nameOfProcessingCompany = nameOfProcessingCompany
+        this.addressOfProcessingCompany = addressOfProcessingCompany
+        this.descriptionOfService = descriptionOfService
+        this.languagesAvailable = languagesAvailable
+        this.dataCollectedList = dataCollectedList
+        this.dataPurposesList = dataPurposesList
+        this.dataRecipientsList = dataRecipientsList
+        this.legalBasisList = legalBasisList
+        this.retentionPeriodList = retentionPeriodList
+        this.subConsents = subConsents
+        this.language = language
+        this.linkToDpa = linkToDpa
+        this.legalGround = legalGround
+        this.optOutUrl = optOutUrl
+        this.policyOfProcessorUrl = policyOfProcessorUrl
+        this.retentionPeriodDescription = retentionPeriodDescription
+        this.dataProtectionOfficer = dataProtectionOfficer
+        this.privacyPolicyURL = privacyPolicyURL
+        this.cookiePolicyURL = cookiePolicyURL
+        this.locationOfProcessing = locationOfProcessing
+        this.dataCollectedDescription = dataCollectedDescription
+        this.thirdCountryTransfer = thirdCountryTransfer
+        this.description = description
+        this.cookieMaxAgeSeconds = cookieMaxAgeSeconds
+        this.usesNonCookieAccess = usesNonCookieAccess
+        this.deviceStorageDisclosureUrl = deviceStorageDisclosureUrl
+        this.isDeactivated = isDeactivated
+        this.disableLegalBasis = disableLegalBasis
+        this.isEssential = isEssential
+        this.technologyUsed = technologyUsed
+        this.deviceStorage = deviceStorage
+        this.isHidden = isHidden
+    }
+}

package/src/models/UsercentricsServiceConsent.tsx

@@ -0,0 +1,37 @@
+import {UsercentricsConsentType} from "."
+
+export class UsercentricsServiceConsent {
+
+    templateId: string
+    status: boolean
+    dataProcessor: string
+    version: string
+    type: UsercentricsConsentType
+    isEssential: boolean
+    history: UsercentricsConsentHistoryEntry[]
+    category: string
+
+    constructor(templateId: string, status: boolean, dataProcessor: string, version: string, type: UsercentricsConsentType, isEssential: boolean, history: UsercentricsConsentHistoryEntry[], category: string) {
+        this.templateId = templateId
+        this.status = status
+        this.dataProcessor = dataProcessor
+        this.version = version
+        this.type = type
+        this.isEssential = isEssential
+        this.history = history
+        this.category = category;
+    }
+}
+
+export class UsercentricsConsentHistoryEntry {
+
+    status: boolean
+    type: UsercentricsConsentType
+    timestampInMillis: number
+
+    constructor(status: boolean, type: UsercentricsConsentType, timestampInMillis: number) {
+        this.status = status;
+        this.type = type;
+        this.timestampInMillis = timestampInMillis;
+    }
+}