@ketch-sdk/ketch-types 1.7.0 → 1.8.1

package/dist/index.d.ts

@@ -1,24 +1,7 @@
-/**
- * Status
- */
-export type Status = {
-    [key: string]: boolean;
-};
-/**
- * Consent
- */
-export type Consent = {
-    purposes: Status;
-    vendors?: string[];
-};
-/**
- * Identities
- */
-export type Identities = {
-    [key: string]: string;
-};
 /**
  * Tab
+ *
+ * @enum
  */
 export declare enum Tab {
     Overview = "overviewTab",
@@ -26,341 +9,249 @@ export declare enum Tab {
     Consents = "consentsTab"
 }
 /**
- * Determines if the Given value is a Tab
+ * Determines if the given value is a Tab
  *
- * @param value
+ * @param value The value to test
+ * @returns true if the given value is a Tab
  */
 export declare function isTab(value: string): value is Tab;
 /**
- * Plugin class
+ * ExperienceType is the type of experience that will be shown
  *
- * @deprecated New plugins should be functional plugins.
- * @see PluginFunction
+ * @enum
  */
-export interface PluginClass {
+export declare enum ExperienceType {
+    Consent = "experiences.consent",
+    Preference = "experiences.preference"
+}
+/**
+ * ConsentExperienceType is the type of consent experience that will be shown
+ *
+ * @enum
+ */
+export declare enum ConsentExperienceType {
+    Banner = "experiences.consent.banner",
+    Modal = "experiences.consent.modal",
+    JIT = "experiences.consent.jit"
+}
+/**
+ * ExperienceClosedReason describes the reason the experience was closed.
+ *
+ * setConsent = consent was accepted/set
+ * invokeRight = the right was invoked
+ * close = the close/exit button was clicked
+ * willNotShow = the experience was skipped
+ *
+ * @enum
+ */
+export declare enum ExperienceClosedReason {
+    SET_CONSENT = "setConsent",
+    INVOKE_RIGHT = "invokeRight",
+    CLOSE = "close",
+    WILL_NOT_SHOW = "willNotShow"
+}
+/**
+ * ExperienceDefault
+ *
+ * @enum
+ */
+export declare enum ExperienceDefault {
+    BANNER = 1,
+    MODAL = 2
+}
+/**
+ * ExperienceButtonDestination
+ *
+ * @enum
+ */
+export declare enum ExperienceButtonDestination {
+    GOTO_MODAL = 1,
+    GOTO_PREFERENCE = 2,
+    REJECT_ALL = 3
+}
+/**
+ * ExperiencePrimaryButtonAction
+ *
+ * @enum
+ */
+export declare enum ExperiencePrimaryButtonAction {
+    SAVE_CURRENT_STATE = 1,
+    ACCEPT_ALL = 2
+}
+/**
+ * MigrationOption
+ *
+ * @enum
+ */
+export declare enum MigrationOption {
+    MIGRATE_DEFAULT = 0,
+    MIGRATE_NEVER = 1,
+    MIGRATE_FROM_ALLOW = 2,
+    MIGRATE_FROM_DENY = 3,
+    MIGRATE_ALWAYS = 4
+}
+/**
+ * CookieDuration
+ *
+ * @enum
+ */
+export declare enum CookieDuration {
+    SESSION = 1,
+    PERSISTENT = 2
+}
+/**
+ * CookieProvenance
+ *
+ * @enum
+ */
+export declare enum CookieProvenance {
+    FIRST_PARTY = 1,
+    THIRD_PARTY = 2
+}
+/**
+ * CookieCategory
+ *
+ * @enum
+ */
+export declare enum CookieCategory {
+    STRICTLY_NECESSARY = 1,
+    FUNCTIONAL = 2,
+    PERFORMANCE = 3,
+    MARKETING = 4
+}
+/**
+ * IdentityLocation is the location on the page from which to retrieve identity information
+ *
+ * @enum
+ */
+export declare enum IdentityType {
+    IDENTITY_TYPE_UNDEFINED = "",
+    IDENTITY_TYPE_DATA_LAYER = "dataLayer",
+    IDENTITY_TYPE_WINDOW = "window",
+    IDENTITY_TYPE_COOKIE = "cookie",
+    IDENTITY_TYPE_MANAGED = "managedCookie",
+    IDENTITY_TYPE_LOCAL_STORAGE = "localStorage",
+    IDENTITY_TYPE_SESSION_STORAGE = "sessionStorage",
+    IDENTITY_TYPE_QUERY_STRING = "queryString"
+}
+/**
+ * IdentityFormat is the encoding of the string identity value
+ *
+ * @enum
+ */
+export declare enum IdentityFormat {
+    IDENTITY_FORMAT_UNDEFINED = "",
+    IDENTITY_FORMAT_STRING = "string",
+    IDENTITY_FORMAT_JSON = "json",
+    IDENTITY_FORMAT_JWT = "jwt",
+    IDENTITY_FORMAT_QUERY = "query",
+    IDENTITY_FORMAT_SEMICOLON = "semicolon"
+}
+/**
+ * SwitchTextRenderLogic
+ *
+ * @enum
+ */
+export declare enum SwitchTextRenderLogic {
     /**
-     * Initialize the plugin
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
+     * SWITCH_TEXT_RENDER_ALL always renders the switch text regardless of state
      */
-    init?: (host: Ketch, config: Configuration) => void;
+    SWITCH_TEXT_RENDER_ALL = 1,
     /**
-     * Equivalent of on('environment')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param env The environment
+     * SWITCH_TEXT_RENDER_LEGAL_BASIS renders the switch text only if different from the legal basis default
      */
-    environmentLoaded?: (host: Ketch, config: Configuration, env: Environment) => void;
+    SWITCH_TEXT_RENDER_LEGAL_BASIS = 2,
     /**
-     * Equivalent of on('geoip')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param ipInfo The IP information
+     * SWITCH_TEXT_RENDER_CHANGE renders the switch only if the user changes the state of the switch
      */
-    geoIPLoaded?: (host: Ketch, config: Configuration, ipInfo: IPInfo) => void;
+    SWITCH_TEXT_RENDER_CHANGE = 3,
     /**
-     * Equivalent of on('identities')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param identities The identities
+     * SWITCH_TEXT_RENDER_NEVER never renders the switch text
      */
-    identitiesLoaded?: (host: Ketch, config: Configuration, identities: Identities) => void;
+    SWITCH_TEXT_RENDER_NEVER = 4
+}
+/**
+ * BannerPosition
+ *
+ * @enum
+ */
+export declare enum BannerPosition {
+    BOTTOM = 1,
+    TOP = 2,
+    BOTTOM_LEFT = 3,
+    BOTTOM_RIGHT = 4
+}
+/**
+ * ModalPosition
+ *
+ * @enum
+ */
+export declare enum ModalPosition {
+    CENTER = 1,
+    LEFT_FULL_HEIGHT = 2,
+    RIGHT_FULL_HEIGHT = 3
+}
+/**
+ * ExperienceActionKind is the Kind of the ExperienceAction.
+ *
+ * @enum
+ */
+export declare enum ExperienceActionKind {
     /**
-     * Equivalent of on('jurisdiction')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param jurisdiction The jurisdiction
+     * The experience was shown
      */
-    jurisdictionLoaded?: (host: Ketch, config: Configuration, policyScope: string) => void;
+    ShowExperience = 0,
     /**
-     * Equivalent of on('regionInfo')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param regionInfo The region info
+     * The experience was hidden
      */
-    regionInfoLoaded?: (host: Ketch, config: Configuration, region: string) => void;
+    HideExperience = 1,
     /**
-     * Equivalent of on('consent')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param consent The consent
+     * Consent was changed
      */
-    consentChanged?: (host: Ketch, config: Configuration, consent: Consent) => void;
+    SetConsent = 2,
     /**
-     * Equivalent of on('rightInvoked')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param request The right invocation request
+     * Subscriptions were changed
      */
-    rightInvoked?: (host: Ketch, config: Configuration, request: InvokeRightRequest) => void;
+    SetSubscription = 3,
     /**
-     * Equivalent of on('showConsentExperience')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param consents The current consents
-     * @param options The options for the experience
+     * Right was invoked
      */
-    showConsentExperience?: (host: Ketch, config: Configuration, consents: Consent, options?: ShowConsentOptions) => void;
+    InvokeRight = 4
+}
+/**
+ * Storage policy setting
+ *
+ * @enum
+ */
+export declare enum StorageOriginPolicy {
     /**
-     * Equivalent of on('showPreferenceExperience')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param consents The current consents
-     * @param options The options for the experience
-     */
-    showPreferenceExperience?: (host: Ketch, config: Configuration, consents: Consent, options?: ShowPreferenceOptions) => void;
-    /**
-     * Equivalent of on('willShowExperience')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param type The type of the experience
+     * Storage saved cross-origin.
      */
-    willShowExperience?: (host: Ketch, config: Configuration, type: string) => void;
+    CrossOrigin = "cross-origin",
     /**
-     * Equivalent of on('experienceHidden')
-     *
-     * @param host The Ketch instance
-     * @param config The configuration
-     * @param reason The reason the experience was hidden
+     * Storage is same-origin only.
      */
-    experienceHidden?: (host: Ketch, config: Configuration, reason: string) => void;
+    SameOrigin = "same-origin,"
 }
 /**
- * Plugin factory function signature
- *
- * @param host The Ketch instance
- * @param config The plugin configuration
- */
-export type PluginFunction = (host: Ketch, config?: any) => Promise<void>;
-/**
- * Plugin
- */
-export type Plugin = PluginClass | PluginFunction;
-/**
- * IdentityProvider defines a function for providing identities
+ * Identities
  */
-export type IdentityProvider = () => Promise<string[]>;
+export type Identities = {
+    [key: string]: string;
+};
 /**
- * StorageProvider defines an interface for storage
+ * Status
  */
-export interface StorageProvider {
-    /**
-     * Get an item with the given key
-     *
-     * @param key The item key
-     */
-    getItem(key: string): Promise<string | null>;
-    /**
-     * Sets the value for the given key
-     *
-     * @param key The item key
-     * @param value The item value
-     */
-    setItem(key: string, value: string): Promise<void>;
-    /**
-     * Removes the given item
-     *
-     * @param key The item key
-     */
-    removeItem(key: string): Promise<void>;
-}
+export type Status = {
+    [key: string]: boolean;
+};
 /**
- * Storage policy setting
+ * Consent
  */
-export declare enum StorageOriginPolicy {
-    /**
-     * Storage saved cross-origin.
-     */
-    CrossOrigin = "cross-origin",
-    /**
-     * Storage is same-origin only.
-     */
-    SameOrigin = "same-origin,"
-}
-export interface Ketch {
-    /**
-     * Register a plugin with the given configuration
-     *
-     * @param plugin The plugin
-     * @param config The plugin configuration
-     */
-    registerPlugin(plugin: Plugin, config?: any): Promise<void>;
-    /**
-     * Register an identity provider for the given identity
-     *
-     * @param name The name of the identity
-     * @param provider The provider of the identity
-     */
-    registerIdentityProvider(name: string, provider: IdentityProvider): Promise<void>;
-    /**
-     * Register a storage provider
-     *
-     * @param policy The storage origin policy
-     * @param provider The provider implementation
-     */
-    registerStorageProvider(policy: StorageOriginPolicy, provider: StorageProvider): Promise<void>;
-    /**
-     * Returns the Consent
-     */
-    getConsent(): Promise<Consent>;
-    /**
-     * Sets the consent
-     *
-     * @param consent
-     */
-    setConsent(consent: Consent): Promise<void>;
-    /**
-     * Show the consent experience
-     */
-    showConsent(): Promise<void>;
-    /**
-     * Show the preference experience
-     *
-     * @param params The parameters for the experience
-     */
-    showPreferences(params?: ShowPreferenceOptions): Promise<void>;
-    /**
-     * Notify that the experience was closed
-     *
-     * @param reason Reason the experience was closed
-     * @deprecated This method will be moved to an experience interface.
-     */
-    experienceClosed(reason: ExperienceClosedReason): Promise<void>;
-    /**
-     * Invokes a right
-     *
-     * @param eventData The definition of the right
-     */
-    invokeRight(eventData: InvokeRightEvent): Promise<void>;
-    /**
-     * Get the Configuration.
-     */
-    getConfig(): Promise<Configuration>;
-    /**
-     * Get the Environment
-     */
-    getEnvironment(): Promise<Environment>;
-    /**
-     * Get the IP information
-     */
-    getGeoIP(): Promise<IPInfo>;
-    /**
-     * Get the identities
-     */
-    getIdentities(): Promise<Identities>;
-    /**
-     * Get the jurisdiction
-     */
-    getJurisdiction(): Promise<string>;
-    /**
-     * Get the region information
-     */
-    getRegionInfo(): Promise<string>;
-    /**
-     * Alias for `emitter.on(eventName, listener)`.
-     *
-     * @param eventName The name of the event.
-     * @param listener The callback function
-     */
-    addListener(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
-    /**
-     * Adds the `listener` function to the end of the listeners array for the
-     * event named `eventName`. No checks are made to see if the `listener` has
-     * already been added. Multiple calls passing the same combination of `eventName`
-     * and `listener` will result in the `listener` being added, and called, multiple
-     * times.
-     *
-     * Returns a reference to the `EventEmitter`, so that calls can be chained.
-     *
-     * By default, event listeners are invoked in the order they are added. The
-     * `emitter.prependListener()` method can be used as an alternative to add the
-     * event listener to the beginning of the listeners array.
-     *
-     * @param eventName The name of the event.
-     * @param listener The callback function
-     */
-    on(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
-    /**
-     * Adds a **one-time**`listener` function for the event named `eventName`. The
-     * next time `eventName` is triggered, this listener is removed and then invoked.
-     *
-     * By default, event listeners are invoked in the order they are added. The
-     * `emitter.prependOnceListener()` method can be used as an alternative to add the
-     * event listener to the beginning of the listeners array.
-     *
-     * @param eventName The name of the event.
-     * @param listener The callback function
-     */
-    once(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
-    /**
-     * Removes the specified `listener` from the listener array for the event
-     * named `eventName`.
-     *
-     * `removeListener()` will remove, at most, one instance of a listener from the
-     * listener array. If any single listener has been added multiple times to the
-     * listener array for the specified `eventName`, then `removeListener()` must be
-     * called multiple times to remove each instance.
-     *
-     * Once an event is emitted, all listeners attached to it at the
-     * time of emitting are called in order. This implies that any`removeListener()`
-     * or `removeAllListeners()` calls _after_ emitting and _before_ the last listener
-     * finishes execution will not remove them from`emit()` in progress. Subsequent
-     * events behave as expected.
-     *
-     * Because listeners are managed using an internal array, calling this will
-     * change the position indices of any listener registered _after_ the listener
-     * being removed. This will not impact the order in which listeners are called,
-     * but it means that any copies of the listener array as returned by
-     * the `emitter.listeners()` method will need to be recreated.
-     *
-     * When a single function has been added as a handler multiple times for a single
-     * event (as in the example below), `removeListener()` will remove the most
-     * recently added instance. In the example the `once('ping')` listener is removed
-     *
-     * @param eventName The name of the event.
-     * @param listener The callback function
-     */
-    removeListener(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
-    /**
-     * Alias for `emitter.removeListener()`.
-     *
-     * @param eventName The name of the event.
-     * @param listener The callback function
-     */
-    off(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
-    /**
-     * Removes all listeners, or those of the specified `eventName`.
-     *
-     * It is bad practice to remove listeners added elsewhere in the code,
-     * particularly when the `EventEmitter` instance was created by some other
-     * component or module (e.g. sockets or file streams).
-     *
-     * @param eventName The name of the event.
-     */
-    removeAllListeners(eventName?: string | symbol): Promise<void>;
-    /**
-     * Synchronously calls each of the listeners registered for the event named
-     * `eventName`, in the order they were registered, passing the supplied arguments
-     * to each.
-     *
-     * @returns `true` if the event had listeners, `false` otherwise.
-     *
-     * @param eventName The name of the event.
-     * @param args The arguments for the event.
-     */
-    emit(eventName: string | symbol, ...args: any[]): Promise<void>;
-}
+export type Consent = {
+    purposes: Status;
+    vendors?: string[];
+};
 /**
  * ShowPreferenceOptions
  */
@@ -390,25 +281,6 @@ export type ShowPreferenceOptions = {
      */
     showConsentsTab?: boolean;
 };
-/**
- * ExperienceType is the type of experience that will be shown
- *
- * @enum
- */
-export declare enum ExperienceType {
-    Consent = "experiences.consent",
-    Preference = "experiences.preference"
-}
-/**
- * ConsentExperienceType is the type of consent experience that will be shown
- *
- * @enum
- */
-export declare enum ConsentExperienceType {
-    Banner = "experiences.consent.banner",
-    Modal = "experiences.consent.modal",
-    JIT = "experiences.consent.jit"
-}
 /**
  * ShowConsentOptions
  */
@@ -424,91 +296,6 @@ export type InvokeRightEvent = {
     subject: DataSubject;
     recaptchaToken?: string;
 };
-/**
- * ExperienceClosedReason describes the reason the experience was closed.
- *
- * setConsent = consent was accepted/set
- * invokeRight = the right was invoked
- * close = the close/exit button was clicked
- * willNotShow = the experience was skipped
- *
- * @enum
- */
-export declare enum ExperienceClosedReason {
-    SET_CONSENT = "setConsent",
-    INVOKE_RIGHT = "invokeRight",
-    CLOSE = "close",
-    WILL_NOT_SHOW = "willNotShow"
-}
-/**
- * ExperienceDefault
- *
- * @enum
- */
-export declare enum ExperienceDefault {
-    BANNER = 1,
-    MODAL = 2
-}
-/**
- * ExperienceButtonDestination
- *
- * @enum
- */
-export declare enum ExperienceButtonDestination {
-    GOTO_MODAL = 1,
-    GOTO_PREFERENCE = 2,
-    REJECT_ALL = 3
-}
-/**
- * ExperiencePrimaryButtonAction
- *
- * @enum
- */
-export declare enum ExperiencePrimaryButtonAction {
-    SAVE_CURRENT_STATE = 1,
-    ACCEPT_ALL = 2
-}
-/**
- * MigrationOption
- *
- * @enum
- */
-export declare enum MigrationOption {
-    MIGRATE_DEFAULT = 0,
-    MIGRATE_NEVER = 1,
-    MIGRATE_FROM_ALLOW = 2,
-    MIGRATE_FROM_DENY = 3,
-    MIGRATE_ALWAYS = 4
-}
-/**
- * CookieDuration
- *
- * @enum
- */
-export declare enum CookieDuration {
-    SESSION = 1,
-    PERSISTENT = 2
-}
-/**
- * CookieProvenance
- *
- * @enum
- */
-export declare enum CookieProvenance {
-    FIRST_PARTY = 1,
-    THIRD_PARTY = 2
-}
-/**
- * CookieCategory
- *
- * @enum
- */
-export declare enum CookieCategory {
-    STRICTLY_NECESSARY = 1,
-    FUNCTIONAL = 2,
-    PERFORMANCE = 3,
-    MARKETING = 4
-}
 /**
  * IPLanguage
  */
@@ -548,18 +335,6 @@ export interface IPInfo {
     longitude: number;
     location: IPLocation;
 }
-/**
- * GetLocationRequest
- */
-export interface GetLocationRequest {
-    IP?: string;
-}
-/**
- * GetLocationResponse
- */
-export interface GetLocationResponse {
-    location: IPInfo;
-}
 /**
  * PurposeLegalBasis
  */
@@ -581,69 +356,6 @@ export interface PurposeAllowedLegalBasis {
     allowed: string;
     legalBasisCode: string;
 }
-/**
- * GetConsentRequest
- */
-export interface GetConsentRequest {
-    organizationCode: string;
-    controllerCode?: string;
-    propertyCode: string;
-    environmentCode: string;
-    jurisdictionCode: string;
-    identities: {
-        [key: string]: string;
-    };
-    purposes: {
-        [key: string]: PurposeLegalBasis;
-    };
-    /**
-     * list of vendor ids for which the user has opted out
-     */
-    vendors?: string[];
-    collectedAt?: number;
-}
-/**
- * GetConsentResponse
- */
-export interface GetConsentResponse {
-    organizationCode: string;
-    controllerCode?: string;
-    propertyCode: string;
-    environmentCode: string;
-    jurisdictionCode: string;
-    identities: {
-        [key: string]: string;
-    };
-    purposes: {
-        [key: string]: PurposeAllowed | string;
-    };
-    /**
-     * list of vendor ids for which the user has opted out
-     */
-    vendors?: string[];
-    collectedAt?: number;
-}
-/**
- * SetConsentRequest
- */
-export interface SetConsentRequest {
-    organizationCode: string;
-    controllerCode?: string;
-    propertyCode: string;
-    environmentCode: string;
-    jurisdictionCode: string;
-    identities: {
-        [key: string]: string;
-    };
-    collectedAt?: number;
-    purposes: {
-        [key: string]: PurposeAllowedLegalBasis;
-    };
-    /**
-     * list of vendor ids for which the user has opted out
-     */
-    vendors?: string[];
-}
 /**
  * DataSubject
  */
@@ -667,69 +379,6 @@ export interface DataSubject {
      */
     typeRelationshipDetails?: string;
 }
-/**
- * InvokeRightRequest
- */
-export interface InvokeRightRequest {
-    organizationCode: string;
-    controllerCode?: string;
-    propertyCode: string;
-    environmentCode: string;
-    identities: {
-        [key: string]: string;
-    };
-    invokedAt?: number;
-    jurisdictionCode: string;
-    rightCode: string;
-    user: DataSubject;
-    recaptchaToken?: string;
-}
-/**
- * GetBootstrapConfigurationRequest
- */
-export interface GetBootstrapConfigurationRequest {
-    organizationCode: string;
-    propertyCode: string;
-}
-/**
- * GetFullConfigurationRequest
- */
-export interface GetFullConfigurationRequest {
-    organizationCode: string;
-    propertyCode: string;
-    environmentCode?: string;
-    hash?: string;
-    deploymentID?: string;
-    jurisdictionCode?: string;
-    languageCode?: string;
-}
-/**
- * GetPreferenceQRRequest
- */
-export interface GetPreferenceQRRequest {
-    organizationCode: string;
-    propertyCode: string;
-    environmentCode?: string;
-    imageSize?: number;
-    path?: string;
-    backgroundColor?: string;
-    foregroundColor?: string;
-    parameters: {
-        [key: string]: string;
-    };
-}
-/**
- * WebReportRequest
- */
-export interface WebReportRequest {
-    type: string;
-    age: number;
-    url: string;
-    user_agent: string;
-    body: {
-        [key: string]: any;
-    };
-}
 /**
  * Organization
  */
@@ -816,552 +465,1206 @@ export interface Purpose {
     legalBasisName?: string;
     legalBasisDescription?: string;
     /**
-     * the data subject types for which the purpose is relevant. If this list is empty then the purpose applies to all
-     * data subject types
+     * the data subject types for which the purpose is relevant. If this list is empty then the purpose applies to all
+     * data subject types
+     */
+    dataSubjectTypeCodes?: string[];
+}
+/**
+ * CanonicalPurpose
+ */
+export interface CanonicalPurpose {
+    code: string;
+    name: string;
+    purposeCodes?: string[];
+}
+/**
+ * Identity represents all the metadata for an identifier on the page
+ */
+export interface Identity {
+    /**
+     * type is the location on the page from which to retrieve identity information
+     */
+    type: IdentityType;
+    /**
+     * variable is the name to look up the identity value in the specified location
+     */
+    variable: string;
+    /**
+     * format is the encoding of the value
+     */
+    format: IdentityFormat;
+    /**
+     * key is the identifier to find the identity within the value if the format is IDENTITY_FORMAT_STRING then key
+     * will be undefined
+     */
+    key?: string;
+    /**
+     * priority of the identity for consent conflict resolution
+     */
+    priority?: number;
+}
+/**
+ * PolicyDocument
+ */
+export interface PolicyDocument {
+    code: string;
+    version: number;
+    url: string;
+}
+/**
+ * Banner
+ */
+export interface Banner {
+    title?: string;
+    footerDescription: string;
+    buttonText: string;
+    primaryButtonAction?: ExperiencePrimaryButtonAction;
+    secondaryButtonText?: string;
+    secondaryButtonDestination?: ExperienceButtonDestination;
+    /**
+     * showCloseIcon determines whether the x out icon appears in the experience. Default do not show
+     */
+    showCloseIcon?: boolean;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Modal
+ */
+export interface Modal {
+    title: string;
+    bodyTitle?: string;
+    bodyDescription?: string;
+    footerDescription?: string;
+    buttonText: string;
+    /**
+     * consentTitle is the heading that goes above the list of purposes this optionally overrides the standard title
+     */
+    consentTitle?: string;
+    /**
+     * hideConsentTitle determines whether the consent title should be hidden. Default is to show
+     */
+    hideConsentTitle?: boolean;
+    /**
+     * hideLegalBases determines whether the legal bases should be hidden. Default is to show
+     */
+    hideLegalBases?: boolean;
+    /**
+     * switchOnText overrides the standard text for a consent switch in the on state
+     */
+    switchOnText?: string;
+    /**
+     * switchOffText overrides the standard text for a consent switch in the off state
+     */
+    switchOffText?: string;
+    /**
+     * switchTextRenderLogic determines the logic for showing the switch text
+     */
+    switchTextRenderLogic?: SwitchTextRenderLogic;
+    /**
+     * showCloseIcon determines whether the x out icon appears in the experience. Default do not show
+     */
+    showCloseIcon?: boolean;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * JIT
+ */
+export interface JIT {
+    title?: string;
+    bodyDescription?: string;
+    acceptButtonText: string;
+    declineButtonText: string;
+    moreInfoText?: string;
+    moreInfoDestination?: ExperienceButtonDestination;
+    /**
+     * showCloseIcon determines whether the x out icon appears in the experience. Default do not show
+     */
+    showCloseIcon?: boolean;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * RightsTab
+ */
+export interface RightsTab {
+    tabName: string;
+    bodyTitle?: string;
+    bodyDescription?: string;
+    buttonText: string;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * ConsentsTab
+ */
+export interface ConsentsTab {
+    tabName: string;
+    bodyTitle?: string;
+    bodyDescription?: string;
+    buttonText: string;
+    /**
+     * consentTitle is the heading that goes above the list of purposes
+     * this optionally overrides the standard title
+     */
+    consentTitle?: string;
+    /**
+     * hideConsentTitle determines whether the consent title should be hidden. Default is to show
+     */
+    hideConsentTitle?: boolean;
+    /**
+     * hideLegalBases determines whether the legal bases should be hidden. Default is to show
+     */
+    hideLegalBases?: boolean;
+    /**
+     * switchOnText overrides the standard text for a consent switch in the on state
+     */
+    switchOnText?: string;
+    /**
+     * switchOffText overrides the standard text for a consent switch in the off state
+     */
+    switchOffText?: string;
+    /**
+     * switchTextRenderLogic determines the logic for showing the switch text
+     */
+    switchTextRenderLogic?: SwitchTextRenderLogic;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * OverviewTab
+ */
+export interface OverviewTab {
+    tabName: string;
+    bodyTitle?: string;
+    bodyDescription: string;
+    /**
+     * additional extensions
+     * */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * ConsentExperience
+ */
+export interface ConsentExperience {
+    code: string;
+    version: number;
+    banner: Banner;
+    modal: Modal;
+    jit?: JIT;
+    experienceDefault: ExperienceDefault;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * PreferenceExperience
+ */
+export interface PreferenceExperience {
+    code: string;
+    version: number;
+    title: string;
+    rights?: RightsTab;
+    consents?: ConsentsTab;
+    overview: OverviewTab;
+    /**
+     * additional extensions
+     */
+    extensions?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Right
+ */
+export interface Right {
+    code: string;
+    name: string;
+    description: string;
+    /**
+     * the data subject types for which the right is relevant. If this list is empty then the right applies to all
+     * data subject types
+     */
+    dataSubjectTypeCodes?: string[];
+}
+/**
+ * Experience
+ */
+export interface Experience {
+    consent?: ConsentExperience;
+    preference?: PreferenceExperience;
+}
+/**
+ * Theme
+ */
+export interface Theme {
+    code?: string;
+    name?: string;
+    description?: string;
+    watermark?: boolean;
+    buttonBorderRadius: number;
+    font?: string;
+    bannerBackgroundColor: string;
+    bannerContentColor?: string;
+    bannerButtonColor: string;
+    bannerSecondaryButtonColor?: string;
+    bannerPosition?: BannerPosition;
+    modalHeaderBackgroundColor: string;
+    modalHeaderContentColor?: string;
+    modalContentColor: string;
+    modalButtonColor: string;
+    modalPosition?: ModalPosition;
+    /**
+     * modalSwitchOnColor is the color of the consent switch in the on state for the modal this overrides standard theme
+     * colors
+     */
+    modalSwitchOnColor?: string;
+    /**
+     * modalSwitchOffColor is the color of the consent switch in the off state for the modal this overrides standard
+     * theme colors
+     */
+    modalSwitchOffColor?: string;
+    formHeaderBackgroundColor: string;
+    formHeaderContentColor?: string;
+    formContentColor: string;
+    formButtonColor: string;
+    /**
+     * formSwitchOnColor is the color of the consent switch in the on state for the form this overrides standard theme
+     * colors
+     */
+    formSwitchOnColor?: string;
+    /**
+     * formSwitchOffColor is the color of the consent switch in the off state for the form this overrides standard theme
+     * colors
+     */
+    formSwitchOffColor?: string;
+    /**
+     * qrBackgroundColor is the override for the QR code background color
+     */
+    qrBackgroundColor?: string;
+    /**
+     * qrForegroundColor is the override for the QR code foreground color
+     */
+    qrForegroundColor?: string;
+}
+/**
+ * Vendor purpose
+ */
+export interface VendorPurpose {
+    name: string;
+    legalBasis?: string;
+}
+/**
+ * Vendor definition
+ */
+export interface Vendor {
+    id: string;
+    name: string;
+    purposes?: VendorPurpose[];
+    specialPurposes?: VendorPurpose[];
+    features?: VendorPurpose[];
+    specialFeatures?: VendorPurpose[];
+    policyUrl?: string;
+    cookieMaxAgeSeconds?: number;
+    usesCookies?: boolean;
+    usesNonCookieAccess?: boolean;
+}
+/**
+ * DataSubjectType represents user defined data subject types with code as the unique identifier
+ */
+export interface DataSubjectType {
+    code: string;
+    name: string;
+    /**
+     * requiresUserInput is true if additional information must be requested to describe the data subject relation
+     */
+    requiresUserInput: boolean;
+}
+/**
+ * Stack represents a grouping of purposes to be displayed in an experience
+ */
+export interface Stack {
+    /**
+     * name of the stack to be displayed
+     */
+    name: string;
+    /**
+     * list of purpose codes that are members of the stack
+     */
+    purposeCodes: string[];
+}
+/**
+ * Configuration
+ */
+export interface Configuration {
+    /**
+     * Organization this configuration belongs to
+     */
+    organization: Organization;
+    /**
+     * Property this configuration belongs to
+     */
+    property?: Property;
+    /**
+     * Language for all text
+     */
+    language?: string;
+    /**
+     * Available environments. Only available in the "boot" configuration.
+     */
+    environments?: Environment[];
+    /**
+     * Environment for this configuration. Only available in the "full" configuration.
+     */
+    environment?: Environment;
+    /**
+     * Applicable jurisdiction.
+     */
+    jurisdiction?: JurisdictionInfo;
+    /**
+     * Identity spaces defined for this property
+     */
+    identities?: {
+        [key: string]: Identity;
+    };
+    /**
+     * Deployment information. Only available in the "full" configuration.
+     */
+    deployment?: Deployment;
+    /**
+     * Regulations enabled for this jurisdiction.
+     */
+    regulations?: string[];
+    /**
+     * Rights available in this jurisdiction.
+     */
+    rights?: Right[];
+    /**
+     * Purposes in this jurisdiction.
+     */
+    purposes?: Purpose[];
+    /**
+     * Mapping of purposes to canonical purposes.
+     */
+    canonicalPurposes?: {
+        [key: string]: CanonicalPurpose;
+    };
+    /**
+     * Privacy policy document
+     */
+    privacyPolicy?: PolicyDocument;
+    /**
+     * Terms of Service (ToS) policy document
+     */
+    termsOfService?: PolicyDocument;
+    /**
+     * Theme
+     */
+    theme?: Theme;
+    /**
+     * Experience definitions
+     */
+    experiences?: Experience;
+    /**
+     * Vendors (TCF)
+     */
+    vendors?: Vendor[];
+    /**
+     * Data subject types relevant for this configuration
+     */
+    dataSubjectTypes?: DataSubjectType[];
+    /**
+     * Stacks to be displayed in an experience
+     */
+    stacks?: Stack[];
+    /**
+     * Services
+     */
+    services?: {
+        [key: string]: string;
+    };
+    /**
+     * Flexible options
+     */
+    options?: {
+        [key: string]: string;
+    };
+    /**
+     * Scripts to load
+     */
+    scripts?: string[];
+    /**
+     * Plugins configured for the configuration
+     */
+    plugins?: {
+        [key: string]: any;
+    };
+    /**
+     * Recaptcha config
+     */
+    recaptcha?: Recaptcha;
+}
+/**
+ * Recaptcha interface defines the Recaptcha config
+ */
+export interface Recaptcha {
+    /**
+     * siteKey: Recaptcha site/public key used to exchange for a reCaptcha token
+     */
+    siteKey?: string;
+}
+/**
+ * Details about showing the Experience
+ */
+export interface ShowExperienceAction {
+    /**
+     * ShowExperience
+     */
+    kind: ExperienceActionKind.ShowExperience;
+    /**
+     * Agent string for the Experience Server (e.g., `lanyard/1.0.3`). Useful for diagnostics.
+     */
+    server: string;
+    /**
+     * Kind of the experience
+     */
+    experienceKind: ExperienceType;
+    /**
+     * Mode of the experience
+     */
+    experienceMode?: ConsentExperienceType;
+    /**
+     * Timestamp when the action happened
+     */
+    ts: Date;
+}
+/**
+ * Details about hiding the Experience
+ */
+export interface HideExperienceAction {
+    /**
+     * HideExperience
+     */
+    kind: ExperienceActionKind.HideExperience;
+    /**
+     * Timestamp when the action happened
+     */
+    ts: Date;
+}
+/**
+ * Details about setting consent
+ */
+export interface SetConsentExperienceAction {
+    /**
+     * SetConsent
+     */
+    kind: ExperienceActionKind.SetConsent;
+    /**
+     * The consent
      */
-    dataSubjectTypeCodes?: string[];
+    consent: Consent;
+    /**
+     * Timestamp when the action happened
+     */
+    ts: Date;
 }
 /**
- * CanonicalPurpose
+ * Details about setting subscriptions
  */
-export interface CanonicalPurpose {
-    code: string;
-    name: string;
-    purposeCodes?: string[];
+export interface SetSubscriptionExperienceAction {
+    /**
+     * SetSubscription
+     */
+    kind: ExperienceActionKind.SetSubscription;
+    /**
+     * Timestamp when the action happened
+     */
+    ts: Date;
 }
 /**
- * IdentityLocation is the location on the page from which to retrieve identity information
- *
- * @enum
+ * Details about invoking rights
  */
-export declare enum IdentityType {
-    IDENTITY_TYPE_UNDEFINED = "",
-    IDENTITY_TYPE_DATA_LAYER = "dataLayer",
-    IDENTITY_TYPE_WINDOW = "window",
-    IDENTITY_TYPE_COOKIE = "cookie",
-    IDENTITY_TYPE_MANAGED = "managedCookie",
-    IDENTITY_TYPE_LOCAL_STORAGE = "localStorage",
-    IDENTITY_TYPE_SESSION_STORAGE = "sessionStorage",
-    IDENTITY_TYPE_QUERY_STRING = "queryString"
+export interface InvokeRightExperienceAction {
+    /**
+     * InvokeRight
+     */
+    kind: ExperienceActionKind.InvokeRight;
+    /**
+     * The right details
+     */
+    right: InvokeRightEvent;
+    /**
+     * Timestamp when the action happened
+     */
+    ts: Date;
 }
 /**
- * IdentityFormat is the encoding of the string identity value
- *
- * @enum
+ * ExperienceResult action
  */
-export declare enum IdentityFormat {
-    IDENTITY_FORMAT_UNDEFINED = "",
-    IDENTITY_FORMAT_STRING = "string",
-    IDENTITY_FORMAT_JSON = "json",
-    IDENTITY_FORMAT_JWT = "jwt",
-    IDENTITY_FORMAT_QUERY = "query",
-    IDENTITY_FORMAT_SEMICOLON = "semicolon"
-}
+export type ExperienceAction = ShowExperienceAction | HideExperienceAction | SetConsentExperienceAction | SetSubscriptionExperienceAction | InvokeRightExperienceAction;
 /**
- * Identity represents all the metadata for an identifier on the page
+ * Options for a modal consent experience
  */
-export interface Identity {
+export interface ModalConsentExperienceOptions {
     /**
-     * type is the location on the page from which to retrieve identity information
+     * Consent
      */
-    type: IdentityType;
+    kind: ExperienceType.Consent;
     /**
-     * variable is the name to look up the identity value in the specified location
+     * Modal
      */
-    variable: string;
+    mode: ConsentExperienceType.Modal;
     /**
-     * format is the encoding of the value
+     * Code of the experience
      */
-    format: IdentityFormat;
+    code: string;
     /**
-     * key is the identifier to find the identity within the value if the format is IDENTITY_FORMAT_STRING then key
-     * will be undefined
+     * Version of the experience
      */
-    key?: string;
+    version: number;
     /**
-     * priority of the identity for consent conflict resolution
+     * Configuration of the Modal
      */
-    priority?: number;
+    config: Modal;
+    /**
+     * Theme for rendering the Modal
+     */
+    theme: Theme;
 }
 /**
- * PolicyDocument
+ * Options for a banner consent experience
  */
-export interface PolicyDocument {
+export interface BannerConsentExperienceOptions {
+    /**
+     * Consent
+     */
+    kind: ExperienceType.Consent;
+    /**
+     * Banner
+     */
+    mode: ConsentExperienceType.Banner;
+    /**
+     * Code of the experience
+     */
     code: string;
+    /**
+     * Version of the experience
+     */
     version: number;
-    url: string;
+    /**
+     * Configuration of the Banner
+     */
+    config: Banner;
+    /**
+     * Theme for rendering the Banner
+     */
+    theme: Theme;
 }
 /**
- * SwitchTextRenderLogic
- *
- * @enum
+ * Options for a JIT consent experience
  */
-export declare enum SwitchTextRenderLogic {
+export interface JITConsentExperienceOptions {
     /**
-     * SWITCH_TEXT_RENDER_ALL always renders the switch text regardless of state
+     * Consent
      */
-    SWITCH_TEXT_RENDER_ALL = 1,
+    kind: ExperienceType.Consent;
     /**
-     * SWITCH_TEXT_RENDER_LEGAL_BASIS renders the switch text only if different from the legal basis default
+     * JIT
      */
-    SWITCH_TEXT_RENDER_LEGAL_BASIS = 2,
+    mode: ConsentExperienceType.JIT;
     /**
-     * SWITCH_TEXT_RENDER_CHANGE renders the switch only if the user changes the state of the switch
+     * Code of the experience
      */
-    SWITCH_TEXT_RENDER_CHANGE = 3,
+    code: string;
     /**
-     * SWITCH_TEXT_RENDER_NEVER never renders the switch text
+     * Version of the experience
      */
-    SWITCH_TEXT_RENDER_NEVER = 4
-}
-/**
- * Banner
- */
-export interface Banner {
-    title?: string;
-    footerDescription: string;
-    buttonText: string;
-    primaryButtonAction?: ExperiencePrimaryButtonAction;
-    secondaryButtonText?: string;
-    secondaryButtonDestination?: ExperienceButtonDestination;
+    version: number;
     /**
-     * showCloseIcon determines whether the x out icon appears in the experience. Default do not show
+     * Configuration of the JIT
      */
-    showCloseIcon?: boolean;
+    config: JIT;
     /**
-     * additional extensions
+     * Purposes for which consent is sought
      */
-    extensions?: {
-        [key: string]: string;
-    };
+    purposes: string[];
+    /**
+     * Theme for rendering the Consents
+     */
+    theme: Theme;
 }
 /**
- * Modal
+ * Consent experience options
  */
-export interface Modal {
-    title: string;
-    bodyTitle?: string;
-    bodyDescription?: string;
-    footerDescription?: string;
-    buttonText: string;
+export type ConsentExperienceOptions = ModalConsentExperienceOptions | BannerConsentExperienceOptions | JITConsentExperienceOptions;
+/**
+ * Preferences configuration
+ */
+export interface Preferences {
     /**
-     * consentTitle is the heading that goes above the list of purposes this optionally overrides the standard title
+     * Title of the experience
      */
-    consentTitle?: string;
+    title: string;
     /**
-     * hideConsentTitle determines whether the consent title should be hidden. Default is to show
+     * Overview tab configuration
      */
-    hideConsentTitle?: boolean;
+    overview?: OverviewTab;
     /**
-     * hideLegalBases determines whether the legal bases should be hidden. Default is to show
+     * Consents tab configuration
      */
-    hideLegalBases?: boolean;
+    consents?: ConsentsTab;
     /**
-     * switchOnText overrides the standard text for a consent switch in the on state
+     * Rights tab configuration
      */
-    switchOnText?: string;
+    rights?: RightsTab;
     /**
-     * switchOffText overrides the standard text for a consent switch in the off state
+     * Subscriptions tab configuration
      */
-    switchOffText?: string;
+    subscriptions?: any;
+}
+/**
+ * Preference experience options
+ */
+export interface PreferencesExperienceOptions {
     /**
-     * switchTextRenderLogic determines the logic for showing the switch text
+     * Preference
      */
-    switchTextRenderLogic?: SwitchTextRenderLogic;
+    kind: ExperienceType.Preference;
     /**
-     * showCloseIcon determines whether the x out icon appears in the experience. Default do not show
+     * Code of the experience
      */
-    showCloseIcon?: boolean;
+    code: string;
     /**
-     * additional extensions
+     * Version of the experience
      */
-    extensions?: {
-        [key: string]: string;
-    };
-}
-/**
- * JIT
- */
-export interface JIT {
-    title?: string;
-    bodyDescription?: string;
-    acceptButtonText: string;
-    declineButtonText: string;
-    moreInfoText?: string;
-    moreInfoDestination?: ExperienceButtonDestination;
+    version: number;
     /**
-     * showCloseIcon determines whether the x out icon appears in the experience. Default do not show
+     * Configuration of the Preferences
      */
-    showCloseIcon?: boolean;
+    config: Preferences;
     /**
-     * additional extensions
+     * Theme for rendering the Preferences
      */
-    extensions?: {
-        [key: string]: string;
-    };
+    theme: Theme;
 }
 /**
- * RightsTab
+ * Experience options
  */
-export interface RightsTab {
-    tabName: string;
-    bodyTitle?: string;
-    bodyDescription?: string;
-    buttonText: string;
+export type ExperienceOptions = ConsentExperienceOptions | PreferencesExperienceOptions;
+/**
+ * ExperienceServer provides an interface implemented by experience servers for rendering experiences
+ */
+export declare interface ExperienceServer {
     /**
-     * additional extensions
+     * Render is called to render an experience.
+     *
+     * @param options Options specific to the requested kind of experience.
+     * @returns ExperienceResults that describe what happened and what actions were taken in the experience
      */
-    extensions?: {
-        [key: string]: string;
-    };
+    render(options: ExperienceOptions): Promise<ExperienceAction[]>;
 }
 /**
- * ConsentsTab
+ * Plugin class
+ *
+ * @deprecated New plugins should be functional plugins.
+ * @see PluginFunction
  */
-export interface ConsentsTab {
-    tabName: string;
-    bodyTitle?: string;
-    bodyDescription?: string;
-    buttonText: string;
+export interface PluginClass {
     /**
-     * consentTitle is the heading that goes above the list of purposes
-     * this optionally overrides the standard title
+     * Initialize the plugin
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
      */
-    consentTitle?: string;
+    init?: (host: Ketch, config: Configuration) => void;
     /**
-     * hideConsentTitle determines whether the consent title should be hidden. Default is to show
+     * Equivalent of on('environment')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param env The environment
      */
-    hideConsentTitle?: boolean;
+    environmentLoaded?: (host: Ketch, config: Configuration, env: Environment) => void;
     /**
-     * hideLegalBases determines whether the legal bases should be hidden. Default is to show
+     * Equivalent of on('geoip')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param ipInfo The IP information
      */
-    hideLegalBases?: boolean;
+    geoIPLoaded?: (host: Ketch, config: Configuration, ipInfo: IPInfo) => void;
     /**
-     * switchOnText overrides the standard text for a consent switch in the on state
+     * Equivalent of on('identities')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param identities The identities
      */
-    switchOnText?: string;
+    identitiesLoaded?: (host: Ketch, config: Configuration, identities: Identities) => void;
+    /**
+     * Equivalent of on('jurisdiction')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param jurisdiction The jurisdiction
+     */
+    jurisdictionLoaded?: (host: Ketch, config: Configuration, policyScope: string) => void;
+    /**
+     * Equivalent of on('regionInfo')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param regionInfo The region info
+     */
+    regionInfoLoaded?: (host: Ketch, config: Configuration, region: string) => void;
+    /**
+     * Equivalent of on('consent')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param consent The consent
+     */
+    consentChanged?: (host: Ketch, config: Configuration, consent: Consent) => void;
+    /**
+     * Equivalent of on('rightInvoked')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param request The right invocation request
+     */
+    rightInvoked?: (host: Ketch, config: Configuration, request: InvokeRightRequest) => void;
+    /**
+     * Equivalent of on('showConsentExperience')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param consents The current consents
+     * @param options The options for the experience
+     */
+    showConsentExperience?: (host: Ketch, config: Configuration, consents: Consent, options?: ShowConsentOptions) => void;
     /**
-     * switchOffText overrides the standard text for a consent switch in the off state
+     * Equivalent of on('showPreferenceExperience')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param consents The current consents
+     * @param options The options for the experience
      */
-    switchOffText?: string;
+    showPreferenceExperience?: (host: Ketch, config: Configuration, consents: Consent, options?: ShowPreferenceOptions) => void;
     /**
-     * switchTextRenderLogic determines the logic for showing the switch text
+     * Equivalent of on('willShowExperience')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param type The type of the experience
      */
-    switchTextRenderLogic?: SwitchTextRenderLogic;
+    willShowExperience?: (host: Ketch, config: Configuration, type: string) => void;
     /**
-     * additional extensions
+     * Equivalent of on('experienceHidden')
+     *
+     * @param host The Ketch instance
+     * @param config The configuration
+     * @param reason The reason the experience was hidden
      */
-    extensions?: {
-        [key: string]: string;
-    };
+    experienceHidden?: (host: Ketch, config: Configuration, reason: string) => void;
 }
 /**
- * OverviewTab
+ * Plugin factory function signature
+ *
+ * @param host The Ketch instance
+ * @param config The plugin configuration
  */
-export interface OverviewTab {
-    tabName: string;
-    bodyTitle?: string;
-    bodyDescription: string;
-    /**
-     * additional extensions
-     * */
-    extensions?: {
-        [key: string]: string;
-    };
-}
+export type PluginFunction = (host: Ketch, config?: any) => Promise<void>;
 /**
- * ConsentExperience
+ * Plugin
  */
-export interface ConsentExperience {
-    code: string;
-    version: number;
-    banner: Banner;
-    modal: Modal;
-    jit?: JIT;
-    experienceDefault: ExperienceDefault;
-    /**
-     * additional extensions
-     */
-    extensions?: {
-        [key: string]: string;
-    };
-}
+export type Plugin = PluginClass | PluginFunction;
 /**
- * PreferenceExperience
+ * IdentityProvider defines a function for providing identities
  */
-export interface PreferenceExperience {
-    code: string;
-    version: number;
-    title: string;
-    rights?: RightsTab;
-    consents?: ConsentsTab;
-    overview: OverviewTab;
-    /**
-     * additional extensions
-     */
-    extensions?: {
-        [key: string]: string;
-    };
-}
+export type IdentityProvider = () => Promise<string[]>;
 /**
- * Right
+ * StorageProvider defines an interface for storage
  */
-export interface Right {
-    code: string;
-    name: string;
-    description: string;
+export interface StorageProvider {
     /**
-     * the data subject types for which the right is relevant. If this list is empty then the right applies to all
-     * data subject types
+     * Get an item with the given key
+     *
+     * @param key The item key
      */
-    dataSubjectTypeCodes?: string[];
+    getItem(key: string): Promise<string | null>;
+    /**
+     * Sets the value for the given key
+     *
+     * @param key The item key
+     * @param value The item value
+     */
+    setItem(key: string, value: string): Promise<void>;
+    /**
+     * Removes the given item
+     *
+     * @param key The item key
+     */
+    removeItem(key: string): Promise<void>;
 }
 /**
- * Experience
+ * GetLocationRequest
  */
-export interface Experience {
-    consent?: ConsentExperience;
-    preference?: PreferenceExperience;
+export interface GetLocationRequest {
+    IP?: string;
 }
 /**
- * BannerPosition
- *
- * @enum
+ * GetLocationResponse
  */
-export declare enum BannerPosition {
-    BOTTOM = 1,
-    TOP = 2,
-    BOTTOM_LEFT = 3,
-    BOTTOM_RIGHT = 4
+export interface GetLocationResponse {
+    location: IPInfo;
 }
 /**
- * ModalPosition
- *
- * @enum
+ * GetConsentRequest
  */
-export declare enum ModalPosition {
-    CENTER = 1,
-    LEFT_FULL_HEIGHT = 2,
-    RIGHT_FULL_HEIGHT = 3
+export interface GetConsentRequest {
+    organizationCode: string;
+    controllerCode?: string;
+    propertyCode: string;
+    environmentCode: string;
+    jurisdictionCode: string;
+    identities: {
+        [key: string]: string;
+    };
+    purposes: {
+        [key: string]: PurposeLegalBasis;
+    };
+    /**
+     * list of vendor ids for which the user has opted out
+     */
+    vendors?: string[];
+    collectedAt?: number;
 }
 /**
- * Theme
+ * GetConsentResponse
  */
-export interface Theme {
-    code?: string;
-    name?: string;
-    description?: string;
-    watermark?: boolean;
-    buttonBorderRadius: number;
-    font?: string;
-    bannerBackgroundColor: string;
-    bannerContentColor?: string;
-    bannerButtonColor: string;
-    bannerSecondaryButtonColor?: string;
-    bannerPosition?: BannerPosition;
-    modalHeaderBackgroundColor: string;
-    modalHeaderContentColor?: string;
-    modalContentColor: string;
-    modalButtonColor: string;
-    modalPosition?: ModalPosition;
-    /**
-     * modalSwitchOnColor is the color of the consent switch in the on state for the modal this overrides standard theme
-     * colors
-     */
-    modalSwitchOnColor?: string;
-    /**
-     * modalSwitchOffColor is the color of the consent switch in the off state for the modal this overrides standard
-     * theme colors
-     */
-    modalSwitchOffColor?: string;
-    formHeaderBackgroundColor: string;
-    formHeaderContentColor?: string;
-    formContentColor: string;
-    formButtonColor: string;
-    /**
-     * formSwitchOnColor is the color of the consent switch in the on state for the form this overrides standard theme
-     * colors
-     */
-    formSwitchOnColor?: string;
-    /**
-     * formSwitchOffColor is the color of the consent switch in the off state for the form this overrides standard theme
-     * colors
-     */
-    formSwitchOffColor?: string;
+export interface GetConsentResponse {
+    organizationCode: string;
+    controllerCode?: string;
+    propertyCode: string;
+    environmentCode: string;
+    jurisdictionCode: string;
+    identities: {
+        [key: string]: string;
+    };
+    purposes: {
+        [key: string]: PurposeAllowed | string;
+    };
     /**
-     * qrBackgroundColor is the override for the QR code background color
+     * list of vendor ids for which the user has opted out
      */
-    qrBackgroundColor?: string;
+    vendors?: string[];
+    collectedAt?: number;
+}
+/**
+ * SetConsentRequest
+ */
+export interface SetConsentRequest {
+    organizationCode: string;
+    controllerCode?: string;
+    propertyCode: string;
+    environmentCode: string;
+    jurisdictionCode: string;
+    identities: {
+        [key: string]: string;
+    };
+    collectedAt?: number;
+    purposes: {
+        [key: string]: PurposeAllowedLegalBasis;
+    };
     /**
-     * qrForegroundColor is the override for the QR code foreground color
+     * list of vendor ids for which the user has opted out
      */
-    qrForegroundColor?: string;
+    vendors?: string[];
 }
 /**
- * Vendor purpose
+ * InvokeRightRequest
  */
-export interface VendorPurpose {
-    name: string;
-    legalBasis?: string;
+export interface InvokeRightRequest {
+    organizationCode: string;
+    controllerCode?: string;
+    propertyCode: string;
+    environmentCode: string;
+    identities: {
+        [key: string]: string;
+    };
+    invokedAt?: number;
+    jurisdictionCode: string;
+    rightCode: string;
+    user: DataSubject;
+    recaptchaToken?: string;
 }
 /**
- * Vendor definition
+ * GetBootstrapConfigurationRequest
+ */
+export interface GetBootstrapConfigurationRequest {
+    organizationCode: string;
+    propertyCode: string;
+}
+/**
+ * GetFullConfigurationRequest
  */
-export interface Vendor {
-    id: string;
-    name: string;
-    purposes?: VendorPurpose[];
-    specialPurposes?: VendorPurpose[];
-    features?: VendorPurpose[];
-    specialFeatures?: VendorPurpose[];
-    policyUrl?: string;
-    cookieMaxAgeSeconds?: number;
-    usesCookies?: boolean;
-    usesNonCookieAccess?: boolean;
+export interface GetFullConfigurationRequest {
+    organizationCode: string;
+    propertyCode: string;
+    environmentCode?: string;
+    hash?: string;
+    deploymentID?: string;
+    jurisdictionCode?: string;
+    languageCode?: string;
 }
 /**
- * DataSubjectType represents user defined data subject types with code as the unique identifier
+ * GetPreferenceQRRequest
  */
-export interface DataSubjectType {
-    code: string;
-    name: string;
-    /**
-     * requiresUserInput is true if additional information must be requested to describe the data subject relation
-     */
-    requiresUserInput: boolean;
+export interface GetPreferenceQRRequest {
+    organizationCode: string;
+    propertyCode: string;
+    environmentCode?: string;
+    imageSize?: number;
+    path?: string;
+    backgroundColor?: string;
+    foregroundColor?: string;
+    parameters: {
+        [key: string]: string;
+    };
 }
 /**
- * Stack represents a grouping of purposes to be displayed in an experience
+ * WebReportRequest
  */
-export interface Stack {
-    /**
-     * name of the stack to be displayed
-     */
-    name: string;
-    /**
-     * list of purpose codes that are members of the stack
-     */
-    purposeCodes: string[];
+export interface WebReportRequest {
+    type: string;
+    age: number;
+    url: string;
+    user_agent: string;
+    body: {
+        [key: string]: any;
+    };
 }
 /**
- * Configuration
+ * Ketch is the standard interface to the tag
  */
-export interface Configuration {
+export interface Ketch {
     /**
-     * Organization this configuration belongs to
+     * Register a plugin with the given configuration
+     *
+     * @param plugin The plugin
+     * @param config The plugin configuration
      */
-    organization: Organization;
+    registerPlugin(plugin: Plugin, config?: any): Promise<void>;
     /**
-     * Property this configuration belongs to
+     * Register an identity provider for the given identity
+     *
+     * @param name The name of the identity
+     * @param provider The provider of the identity
      */
-    property?: Property;
+    registerIdentityProvider(name: string, provider: IdentityProvider): Promise<void>;
     /**
-     * Language for all text
+     * Register an experience server to use for rendering experiences.
+     *
+     * @param server The experience server
      */
-    language?: string;
+    registerExperienceServer(server: ExperienceServer): Promise<void>;
     /**
-     * Available environments. Only available in the "boot" configuration.
+     * Register a storage provider
+     *
+     * @param policy The storage origin policy
+     * @param provider The provider implementation
      */
-    environments?: Environment[];
+    registerStorageProvider(policy: StorageOriginPolicy, provider: StorageProvider): Promise<void>;
     /**
-     * Environment for this configuration. Only available in the "full" configuration.
+     * Returns the Consent
      */
-    environment?: Environment;
+    getConsent(): Promise<Consent>;
     /**
-     * Applicable jurisdiction.
+     * Sets the consent
+     *
+     * @param consent Consents
      */
-    jurisdiction?: JurisdictionInfo;
+    setConsent(consent: Consent): Promise<void>;
     /**
-     * Identity spaces defined for this property
+     * Sets the provisional consent
+     *
+     * @param consent Consents
      */
-    identities?: {
-        [key: string]: Identity;
-    };
+    setProvisionalConsent(consent: Consent): Promise<void>;
     /**
-     * Deployment information. Only available in the "full" configuration.
+     * Show the consent experience
      */
-    deployment?: Deployment;
+    showConsent(): Promise<void>;
     /**
-     * Regulations enabled for this jurisdiction.
+     * Show the experience as described
+     *
+     * @param options The experience options
      */
-    regulations?: string[];
+    showExperience(options: ExperienceOptions): Promise<void>;
     /**
-     * Rights available in this jurisdiction.
+     * Show the preference experience
+     *
+     * @param params The parameters for the experience
      */
-    rights?: Right[];
+    showPreferences(params?: ShowPreferenceOptions): Promise<void>;
     /**
-     * Purposes in this jurisdiction.
+     * Notify that the experience was closed
+     *
+     * @param reason Reason the experience was closed
+     * @deprecated This method will be moved to an experience interface.
      */
-    purposes?: Purpose[];
+    experienceClosed(reason: ExperienceClosedReason): Promise<void>;
     /**
-     * Mapping of purposes to canonical purposes.
+     * Invokes a right
+     *
+     * @param eventData The definition of the right
      */
-    canonicalPurposes?: {
-        [key: string]: CanonicalPurpose;
-    };
+    invokeRight(eventData: InvokeRightEvent): Promise<void>;
     /**
-     * Privacy policy document
+     * Get the Configuration.
      */
-    privacyPolicy?: PolicyDocument;
+    getConfig(): Promise<Configuration>;
     /**
-     * Terms of Service (ToS) policy document
+     * Get the Environment
      */
-    termsOfService?: PolicyDocument;
+    getEnvironment(): Promise<Environment>;
     /**
-     * Theme
+     * Get the IP information
      */
-    theme?: Theme;
+    getGeoIP(): Promise<IPInfo>;
     /**
-     * Experience definitions
+     * Get the identities
      */
-    experiences?: Experience;
+    getIdentities(): Promise<Identities>;
     /**
-     * Vendors (TCF)
+     * Get the jurisdiction
      */
-    vendors?: Vendor[];
+    getJurisdiction(): Promise<string>;
     /**
-     * Data subject types relevant for this configuration
+     * Get the region information
      */
-    dataSubjectTypes?: DataSubjectType[];
+    getRegionInfo(): Promise<string>;
     /**
-     * Stacks to be displayed in an experience
+     * Alias for `emitter.on(eventName, listener)`.
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
      */
-    stacks?: Stack[];
+    addListener(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
     /**
-     * Services
+     * Adds the `listener` function to the end of the listeners array for the
+     * event named `eventName`. No checks are made to see if the `listener` has
+     * already been added. Multiple calls passing the same combination of `eventName`
+     * and `listener` will result in the `listener` being added, and called, multiple
+     * times.
+     *
+     * Returns a reference to the `EventEmitter`, so that calls can be chained.
+     *
+     * By default, event listeners are invoked in the order they are added. The
+     * `emitter.prependListener()` method can be used as an alternative to add the
+     * event listener to the beginning of the listeners array.
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
      */
-    services?: {
-        [key: string]: string;
-    };
+    on(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
     /**
-     * Flexible options
+     * Adds a **one-time**`listener` function for the event named `eventName`. The
+     * next time `eventName` is triggered, this listener is removed and then invoked.
+     *
+     * By default, event listeners are invoked in the order they are added. The
+     * `emitter.prependOnceListener()` method can be used as an alternative to add the
+     * event listener to the beginning of the listeners array.
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
      */
-    options?: {
-        [key: string]: string;
-    };
+    once(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
     /**
-     * Scripts to load
+     * Removes the specified `listener` from the listener array for the event
+     * named `eventName`.
+     *
+     * `removeListener()` will remove, at most, one instance of a listener from the
+     * listener array. If any single listener has been added multiple times to the
+     * listener array for the specified `eventName`, then `removeListener()` must be
+     * called multiple times to remove each instance.
+     *
+     * Once an event is emitted, all listeners attached to it at the
+     * time of emitting are called in order. This implies that any`removeListener()`
+     * or `removeAllListeners()` calls _after_ emitting and _before_ the last listener
+     * finishes execution will not remove them from`emit()` in progress. Subsequent
+     * events behave as expected.
+     *
+     * Because listeners are managed using an internal array, calling this will
+     * change the position indices of any listener registered _after_ the listener
+     * being removed. This will not impact the order in which listeners are called,
+     * but it means that any copies of the listener array as returned by
+     * the `emitter.listeners()` method will need to be recreated.
+     *
+     * When a single function has been added as a handler multiple times for a single
+     * event (as in the example below), `removeListener()` will remove the most
+     * recently added instance. In the example the `once('ping')` listener is removed
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
      */
-    scripts?: string[];
+    removeListener(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
     /**
-     * Plugins configured for the configuration
+     * Alias for `emitter.removeListener()`.
+     *
+     * @param eventName The name of the event.
+     * @param listener The callback function
      */
-    plugins?: {
-        [key: string]: any;
-    };
+    off(eventName: string | symbol, listener: (...args: any[]) => void): Promise<void>;
     /**
-     * Recaptcha config
+     * Removes all listeners, or those of the specified `eventName`.
+     *
+     * It is bad practice to remove listeners added elsewhere in the code,
+     * particularly when the `EventEmitter` instance was created by some other
+     * component or module (e.g. sockets or file streams).
+     *
+     * @param eventName The name of the event.
      */
-    recaptcha?: Recaptcha;
-}
-/**
- * Recaptcha interface defines the Recaptcha config
- */
-export interface Recaptcha {
+    removeAllListeners(eventName?: string | symbol): Promise<void>;
     /**
-     * siteKey: Recaptcha site/public key used to exchange for a reCaptcha token
+     * Synchronously calls each of the listeners registered for the event named
+     * `eventName`, in the order they were registered, passing the supplied arguments
+     * to each.
+     *
+     * @returns `true` if the event had listeners, `false` otherwise.
+     *
+     * @param eventName The name of the event.
+     * @param args The arguments for the event.
      */
-    siteKey?: string;
+    emit(eventName: string | symbol, ...args: any[]): Promise<void>;
 }
 /**
  * Pusher interface defines a type that has a push function like an array