@rakutenanalytics/rat-ts 0.6.2-rc.c84a2bd

package/dist/lib/types/genericParams.d.ts

@@ -0,0 +1,778 @@
+export declare enum AflgEnum {
+    NOT_APPLIED = 0,
+    APPLIED = 1
+}
+export declare enum ChkoutEnum {
+    TEN = 10,
+    TWENTY = 20,
+    THIRTY = 30,
+    FORTY = 40,
+    FIFTY = 50
+}
+export declare enum IfrEnum {
+    NOT_APPLIED = 0,
+    APPLIED = 1
+}
+export declare enum IsscEnum {
+    NOT_APPLIED = 0,
+    APPLIED = 1
+}
+export declare enum MnetwEnum {
+    V_1 = -1,
+    V1 = 1,
+    V2 = 2,
+    V3 = 3,
+    V4 = 4,
+    V5 = 5
+}
+export declare enum MnetwdEnum {
+    V_1 = -1,
+    V1 = 1,
+    V2 = 2,
+    V3 = 3,
+    V4 = 4,
+    V5 = 5
+}
+export declare enum MoriEnum {
+    V1 = 1,
+    V2 = 2
+}
+export declare enum NavtypeEnum {
+    TYPE0 = 0,
+    TYPE1 = 1,
+    TYPE2 = 2,
+    TYPE3 = 3,
+    TYPE255 = 255
+}
+export declare enum OaEnum {
+    OR = "o",
+    AND = "a",
+    NO = "x"
+}
+export declare enum PglEnum {
+    PC = "PC",
+    PC_LOWER = "pc",
+    SP = "SP",
+    SP_LOWER = "sp",
+    TB = "TB",
+    TB_LOWER = "tb",
+    RESP = "RESP",
+    RESP_LOWER = "resp"
+}
+export declare enum PgtEnum {
+    TOP = "top",
+    SEARCH = "search",
+    SHOP_ITEM = "shop_item",
+    CART_MODIFY = "cart_modify",
+    CART_CHECKOUT = "cart_checkout"
+}
+export declare enum PowerstatusEnum {
+    V0 = 0,
+    V1 = 1
+}
+export declare enum SrtEnum {
+    NONE = "none",
+    OR = "or",
+    GENRE = "genre",
+    NGRAM = "ngram"
+}
+export interface OutputGenericParams {
+    /** Rp cookie */
+    Rp?: string;
+    /** Rz cookie */
+    Rz?: string;
+    /** AB test id */
+    abtest?: string;
+    /** For A/B test targeting */
+    abtest_target?: Record<string, unknown>;
+    /** Each account ID corresponds to a group of services */
+    acc?: number;
+    /** Action Type (ex: click, link_intercept) */
+    actype?: string;
+    /** Affiliate id */
+    afid?: number;
+    /** Adult flag */
+    aflg?: AflgEnum;
+    /** The service ID is assigned individually for each service. Multiple services can have same ID if their account ID differs. This is an optional parameter. */
+    aid?: number;
+    /** Flag for AMP page */
+    amp?: boolean;
+    /** App name */
+    app_name?: string;
+    /** App version */
+    app_ver?: string;
+    /** List of areas */
+    area?: string[];
+    /** Site section as used in site catalyst */
+    assc?: string;
+    /** Asynchronous elements load timing (ms) */
+    astime?: number;
+    /** Books genre */
+    bgenre?: string[];
+    /** Beacon id */
+    bid?: string;
+    /** Browser language as returned by the browser. Format: see IETF language tag (https://tools.ietf.org/html/bcp47) */
+    bln?: string;
+    /** Brand's name */
+    brand?: string[];
+    /** Cart state */
+    cart?: number;
+    /** Campaign code */
+    cc?: string;
+    /** Checkout step */
+    chkout?: ChkoutEnum;
+    /** Checkpoint step */
+    chkpt?: number;
+    /** Browser cookies of the request HTTP Header */
+    ck?: Record<string, unknown>;
+    /** Browser cookies total size in byte of the request HTTP Header */
+    ck_tbs?: number;
+    /** Browser cookies total count of the request HTTP Header */
+    ck_tc?: number;
+    /** IDFA/ADID */
+    cka?: string;
+    /** Value is set indirectly by specifying the corresponding cookie name */
+    ckp?: string;
+    /** Session Cookie with a unique value for each user, regardless of their membership. This value will match the Rp Cookie, and it will only be set on the rakuten.co.jp domain or on third party domains which have been allowed access to the Rp Cookie. On other third party domains this property will not be present. */
+    cks?: string;
+    /** Session Cookie with a unique value for each user, regardless of their membership. This value will match the Rp Cookie and the cks param in cases where the domain is rakuten.co.jp or a third party domain which has been allowed to access the Rp Cookie. In other cases, this value will match the _ra Cookie. */
+    cks2?: string;
+    /** Language used in the page content. Format: see IETF language tag (https://tools.ietf.org/html/bcp47) */
+    cntln?: string;
+    /** Id of page components involved in the current event */
+    compid?: string[];
+    /** Vertical position (pixels from the top of the page) of page components referenced in compid */
+    comptop?: number[];
+    /** ISO_3166 Alpha-2 Code */
+    country?: string;
+    /** Coupon used per order */
+    coupon_price?: number[];
+    /** List of coupon IDs prefixed with a shopid. When there are several coupons used in one shop, they are separated by colons : {shopid01}/{coupon_id01}:{coupon_id_02}, {shopid02}/{coupon_id03}:{coupon_id_04} */
+    couponid?: string[];
+    /** Custom parameter group: contain fields which are specific to certain services but do not apply in general to all services */
+    cp?: Record<string, unknown>;
+    /** Customer ID */
+    customerid?: string;
+    /** Custom conversion information */
+    cv?: Record<string, unknown>;
+    /** Currency code */
+    cycode?: string;
+    /** Currency code list */
+    cycodelist?: string[];
+    /** List of device identifiers (Android only) */
+    deviceid_list?: Record<string, unknown>;
+    /** Device language */
+    dln?: string;
+    /** In principle this should be in cp group since it applies to Ichiba only */
+    easyid?: string;
+    /** Encrypted easyid */
+    eeid?: string;
+    /** Error list */
+    errorlist?: Record<string, unknown>[];
+    /** Application form errors */
+    errors?: Record<string, unknown>;
+    /** Excluded search query */
+    esq?: string;
+    /** Event type */
+    etype?: string;
+    /** Google application set ID for Android devices that allows developers to correlate user activity across a set of their own apps installed on a single device. */
+    gas?: string;
+    /** Search genre */
+    genre?: string;
+    /** Goal id */
+    gol?: string;
+    /** Page URL, obtained from the tracking request's referrer header */
+    hurl?: string;
+    /** Indicates where the page was loaded. 0: Main window, 1: Frame */
+    ifr?: IfrEnum;
+    /** Represents the genre id associated with each item in itemid */
+    igenre?: string[];
+    /** Represents a genre name's hierarchy */
+    igenrenamepath?: string;
+    /** Represents a genre id's hierarchy */
+    igenrepath?: string;
+    /** RMS item number */
+    ino?: string[];
+    /** Event source IP adress */
+    ip?: string;
+    /** Receiver server version */
+    rcv_version?: string;
+    /** Receiver server hostname */
+    hostname?: string;
+    /** flag set to 1 on the first scroll event within a page */
+    issc?: IsscEnum;
+    /** Represents tags associated with each item in itemid, as a slash separated list */
+    itag?: string[];
+    /** Item name */
+    item_name?: string;
+    /** This contains an array of strings of the form "shopid/itemID"; if the shopid is missing the itemID is considered a productID */
+    itemid?: string[];
+    /** Short item ID used in page URL */
+    itemurl?: string;
+    /** Java plugin presence flag */
+    jav?: boolean;
+    /** User agent as obtained from JavaScript */
+    js_ua?: string;
+    /** Device type as obtained from JavaScript */
+    js_devtype?: string;
+    /** To support search in a user selected language different than the content or browser language */
+    lang?: string;
+    /** Page rendering time (ms) */
+    ldtime?: number;
+    /** Geolocation coordinates (ref: https://dev.w3.org/geo/api/spec-source.html#navi-geo) */
+    loc?: Record<string, unknown>;
+    /** Optional action parameters for requestion a location for an event of type `loc`, sent only when atleast one of them is present */
+    action_params?: Record<string, unknown>;
+    /** To indiacate location collection is user action or interval/distance based location collection, not sent when geotracker is disabled */
+    isaction?: boolean;
+    /** Script start time */
+    ltm?: string;
+    /** Maker's name */
+    maker?: string[];
+    /** Battery usage */
+    mbat?: string;
+    /** Mobile carrier name */
+    mcn?: string;
+    /** Mobile carrier name for dual SIM functionality */
+    mcnd?: string;
+    /** Detailed mobile network information (Android only) */
+    mno?: Record<string, unknown>;
+    /** Carrier identifier of the current subscription */
+    simcid?: number;
+    /** Carrier identifier name of the current subscription */
+    simcn?: string;
+    /** Service Provider Name (SPN) */
+    simopn?: string;
+    /** MCC+MNC of the provider of the SIM */
+    simop?: string;
+    /** Alphabetic name of current registered operator */
+    netopn?: string;
+    /** MCC+MNC of current registered operator */
+    netop?: string;
+    /** The current network is considered to be in roaming or not */
+    isroam?: boolean;
+    /** Details for the video/audio media-related events. */
+    media?: Record<string, unknown>;
+    /** The name of the event being tracked. */
+    event_name?: string;
+    /** Member id for global market places other than Ichiba */
+    memberid?: string;
+    /** Mobile navigation time (milliseconds) */
+    mnavtime?: number;
+    /** Mobile network type (-1-Unknown, 1-Wifi, 2-GPRS/2G, 3-3G, 4-4G/LTE, 5-5G) */
+    mnetw?: MnetwEnum;
+    /** Mobile network type (-1-Unknown, 1-Wifi, 2-GPRS/2G, 3-3G, 4-4G/LTE, 5-5G) for dual SIM functionality */
+    mnetwd?: MnetwdEnum;
+    /** Mobile device brand model */
+    model?: string;
+    /** Mobile orientation (1: portrait, 2: landscape) */
+    mori?: MoriEnum;
+    /** Mobile OS */
+    mos?: string;
+    /** m3_r cookie */
+    m3_r?: string;
+    /** Indicates how the page was loaded. 0: Normal navigation, 1: Page refresh, 2: Browser history back/forward, 3: Close window (app), 255: Unspecified */
+    navtype?: NavtypeEnum;
+    /** Goes with the 'itemid' parameter. Represents the number of items ordered for each item in the cart. */
+    ni?: number[];
+    /** Total item count per order, this goes together with the "order_list" parameter */
+    ni_order?: number[];
+    /** For search results pages. Indicates the logical relationship that was used between the search keywords ("o":exact OR, "a":exact AND, "x":approximate) */
+    oa?: OaEnum;
+    /** Online status when creating the event client side */
+    online?: boolean;
+    /** Order id */
+    order_id?: string;
+    /** List of order IDs; this was added for supporting the multiple order at once scenario, should replace the single "order_id" parameter eventually */
+    order_list?: string[];
+    /** Payment method */
+    payment?: string;
+    /** Page id */
+    pgid?: string;
+    /** PC: desktop browser, SP: Smartphone, TB: Tablet, RESP: Responsive layout */
+    pgl?: PglEnum;
+    /** Page name */
+    pgn?: string;
+    /** Page Section */
+    pgs?: string;
+    /** Page type */
+    pgt?: PgtEnum;
+    /** For integration with in-house AB test tool "Phoenix" */
+    phoenix_pattern?: string;
+    /** Point used per order */
+    point_price?: number[];
+    /** Battery charging status (0-Not charging, 1-Charging) */
+    powerstatus?: PowerstatusEnum;
+    /** Product code */
+    prdctcd?: string[];
+    /** Specifies the price of each item listed in itemid */
+    price?: number[];
+    /** Publisher's name */
+    publisher?: string[];
+    /** RAN code */
+    rancode?: string;
+    /** Unique event id */
+    ratid?: number;
+    /** Referrer URL */
+    ref?: string;
+    /** Error or result code */
+    reqc?: string;
+    /** Device screen resolution */
+    res?: string;
+    /** Reservation creation date */
+    rescreadate?: string;
+    /** Reserved date */
+    resdate?: string;
+    /** Reservation id */
+    reservation_id?: string;
+    /** Page layout used to display search results */
+    reslayout?: string;
+    /** Network response time to the initial page load request (ms) */
+    rqtime?: number;
+    /** Personal data cookie */
+    Rg?: string;
+    /** List of search criteria id */
+    scond?: string[];
+    /** SDK source which was used for sending an event. */
+    sdk_source?: string;
+    /** Specifies an entity type for each item in itemid (organic, ad, shop, item, product, etc) */
+    search_entity?: number[];
+    /** Service type */
+    service?: string;
+    /** Shop specific genre */
+    sgenre?: string;
+    /** Shipping method */
+    shipping?: string;
+    /** Shipping fee per order */
+    shipping_fee?: number[];
+    /** Shop id */
+    shopid?: string;
+    /** Shop id list */
+    shopidlist?: string[];
+    /** Part of the URL that identifies the shop */
+    shopurl?: string;
+    /** Shop url list */
+    shopurllist?: string[];
+    /** For integration with in-house AB test tool "Sphinx" */
+    sphinx_pattern?: string;
+    /** Search query */
+    sq?: string;
+    /** Same as itemid, for use with scroll events */
+    sresv?: string[];
+    /** Indicates the type of alternate search used when the initial search does not return anything */
+    srt?: SrtEnum;
+    /** ss_r cookie */
+    ss_r?: string;
+    /** Bigger page/screen analysis granularity than page name */
+    ssc?: string;
+    /** Screen width in density-independent pixels (dp). */
+    sw_dp?: number;
+    /** A list of search tags */
+    tag?: string[];
+    /** Unique target_ele to all clickable element <p>{screen_name}:{component_name}-{element_type}.{action}</p> */
+    target_ele?: string;
+    /** Position in list of elements, starting from 0 */
+    target_pos?: number[];
+    /** Cookie generated used for tracking. History ID */
+    tg_af_histid?: string;
+    /** Random unique id for repeated accesses to a domain within the same browser tab. Note: the id will not persist across page loads in IE7 and below, or in private browsing mode in Safari/Android browsers */
+    tid?: string;
+    /** Character set of page content */
+    tis?: string;
+    /** Total prices per order, this goes together with the "order_list" parameter */
+    total_price?: number[];
+    /** Total time for page load. From navigationStart to loadEventEnd */
+    tpgldtime?: number;
+    /** Event reception timestamp (seconds, epoch time) */
+    ts?: number;
+    /** For redirect and native app purposes only. Format: seconds since epoch time */
+    ts1?: number;
+    /** Timezone expressed in hour offset from GMT */
+    tzo?: number;
+    /** User agent */
+    ua?: string;
+    /** A user agent's branding and significant version */
+    uach?: string;
+    /** The architecture of the platform */
+    uach_arch?: string;
+    /** The bitness of the architecture of the platform */
+    uach_bitness?: string;
+    /** The full version for each brand in its brands list */
+    uach_full_version_list?: string;
+    /** Whether or not a user agent prefers a "mobile" user experience */
+    uach_mobile?: string;
+    /** Device model */
+    uach_model?: string;
+    /** OS Platform */
+    uach_platform?: string;
+    /** OS platform version */
+    uach_platform_version?: string;
+    /** Whether or not a user agent binary is running in 32-bit mode on 64-bit Windows */
+    uach_wow64?: string;
+    /** Enriched user agent string to capture device and OS details. */
+    ua_enriched?: string;
+    /** Page URL */
+    url?: string;
+    /** Defined for applications to pass users encrypted member id */
+    userid?: string;
+    /** Flag to indicate whether cks was issued via the Server or client side (via JavaScript). When true, cks was issued via the Server as the Rp Cookie. When false, cks was issued client side as the _ra Cookie. */
+    use_cks?: boolean;
+    /** A list of item id used to identify variants of items/services */
+    variantid?: string[];
+    /** Goes together with the "itemid" parameter. Key-value mappings of each item's variations. Short names and abbreviations are preferred */
+    variation?: Record<string, unknown>[];
+    /** Client SDK or Library version */
+    ver?: string;
+    /** For integration with in-house AB test tool "Widowbird" */
+    wb_pattern?: string;
+    /** Web-Vitals metric of measuring the first content paint. Reports the time from when the user first navigated to the page to when any part of the page's content is rendered on the screen. Unit is "milliseconds" */
+    wv_fcp?: number;
+    /** Web-Vitals metric of measuring the largest content paint. Reports the render time of the largest image or text block visible in the viewport. Unit is "milliseconds" */
+    wv_lcp?: number;
+    /** (deprecated) Web-Vitals metric of measuring the delay of the first user input. Unit is "milliseconds" */
+    wv_fid?: number;
+    /** Web-Vitals metric of measuring the interaction to next paint. Reports the highest latency out of all interactions a user made with the page. Unit is "milliseconds" */
+    wv_inp?: number;
+    /** Web-Vitals metric of measuring the cumulative layout shift. Reports the largest burst of layout shift scores for unexpected layout shifts. */
+    wv_cls?: number;
+    /** Web-Vitals metric of measuring the time to the first byte of request. Reports the time between the request for the page and when the first byte of a response begins to arrive. Unit is "milliseconds" */
+    wv_ttfb?: number;
+    /** Web-Vitals script version */
+    wv_ver?: string;
+    /** Cookie with a unique value for each user (browser), regardless of their membership. _ra is issued at client side via JavaScript. */
+    _ra?: string;
+}
+export interface InputGenericParams {
+    /** defName: Rp - Rp cookie */
+    rpCookie?: string;
+    /** defName: Rz - Rz cookie */
+    rzCookie?: string;
+    /** defName: abtest - AB test id */
+    abTest?: string;
+    /** defName: abtest_target - For A/B test targeting */
+    testTargeting?: Record<string, unknown>;
+    /** defName: acc - Each account ID corresponds to a group of services */
+    accountId?: number;
+    /** defName: afid - Affiliate id */
+    affiliateId?: number;
+    /** defName: aflg - Adult flag */
+    adultFlag?: AflgEnum;
+    /** defName: aid - The service ID is assigned individually for each service. Multiple services can have same ID if their account ID differs. This is an optional parameter. */
+    serviceId?: number;
+    /** defName: app_name - App name */
+    appName?: string;
+    /** defName: app_ver - App version */
+    appVersion?: string;
+    /** defName: area - List of areas */
+    area?: string[];
+    /** defName: assc - Site section as used in site catalyst */
+    adobeSiteSection?: string;
+    /** defName: bgenre - Books genre */
+    booksGenre?: string[];
+    /** defName: brand - Brand's name */
+    brand?: string[];
+    /** defName: cart - Cart state */
+    cartState?: number;
+    /** defName: cc - Campaign code */
+    campaignCode?: string;
+    /** defName: chkout - Checkout step */
+    checkout?: ChkoutEnum;
+    /** defName: chkpt - Checkpoint step */
+    checkpoint?: number;
+    /** defName: cka - IDFA/ADID */
+    idfaCookie?: string;
+    /** defName: ckp - Value is set indirectly by specifying the corresponding cookie name */
+    persistentCookie?: string;
+    /** defName: cks - Session Cookie with a unique value for each user, regardless of their membership. This value will match the Rp Cookie, and it will only be set on the rakuten.co.jp domain or on third party domains which have been allowed access to the Rp Cookie. On other third party domains this property will not be present. */
+    sessionCookie?: string;
+    /** defName: cks2 - Session Cookie with a unique value for each user, regardless of their membership. This value will match the Rp Cookie and the cks param in cases where the domain is rakuten.co.jp or a third party domain which has been allowed to access the Rp Cookie. In other cases, this value will match the _ra Cookie. */
+    sessionCookieV2?: string;
+    /** defName: cntln - Language used in the page content. Format: see IETF language tag (https://tools.ietf.org/html/bcp47) */
+    contentLanguage?: string;
+    /** defName: compid - Id of page components involved in the current event */
+    componentId?: string[];
+    /** defName: country - ISO_3166 Alpha-2 Code */
+    countryCode?: string;
+    /** defName: coupon_price - Coupon used per order */
+    couponPrice?: number[];
+    /** defName: couponid - List of coupon IDs prefixed with a shopid. When there are several coupons used in one shop, they are separated by colons : {shopid01}/{coupon_id01}:{coupon_id_02}, {shopid02}/{coupon_id03}:{coupon_id_04} */
+    couponId?: string[];
+    /** defName: cp - Custom parameter group: contain fields which are specific to certain services but do not apply in general to all services */
+    customParameters?: Record<string, unknown>;
+    /** defName: customerid - Customer ID */
+    customerId?: string;
+    /** defName: cv - Custom conversion information */
+    cvEvent?: Record<string, unknown>;
+    /** defName: cycode - Currency code */
+    currencyCode?: string;
+    /** defName: cycodelist - Currency code list */
+    currencyCodeList?: string[];
+    /** defName: dln - Device language */
+    deviceLanguage?: string;
+    /** defName: eeid - Encrypted easyid */
+    eeid?: string;
+    /** defName: errorlist - Error list */
+    errorList?: Record<string, unknown>[];
+    /** defName: errors - Application form errors */
+    errors?: Record<string, unknown>;
+    /** defName: esq - Excluded search query */
+    excludeQuery?: string;
+    /** defName: etype - Event type */
+    eventType?: string;
+    /** defName: genre - Search genre */
+    genre?: string;
+    /** defName: gol - Goal id */
+    goalId?: string;
+    /** defName: igenre - Represents the genre id associated with each item in itemid */
+    itemGenre?: string[];
+    /** defName: igenrenamepath - Represents a genre name's hierarchy */
+    itemGenreNamePath?: string;
+    /** defName: igenrepath - Represents a genre id's hierarchy */
+    itemGenrePath?: string;
+    /** defName: ino - RMS item number */
+    rmsItemNumber?: string[];
+    /** defName: itag - Represents tags associated with each item in itemid, as a slash separated list */
+    itemTag?: string[];
+    /** defName: item_name - Item name */
+    itemName?: string;
+    /** defName: itemid - This contains an array of strings of the form "shopid/itemID"; if the shopid is missing the itemID is considered a productID */
+    itemId?: string[];
+    /** defName: itemurl - Short item ID used in page URL */
+    itemUrl?: string;
+    /** defName: lang - To support search in a user selected language different than the content or browser language */
+    language?: string;
+    /** defName: loc - Geolocation coordinates (ref: https://dev.w3.org/geo/api/spec-source.html#navi-geo) */
+    location?: Record<string, unknown>;
+    /** defName: action_params - Optional action parameters for requestion a location for an event of type `loc`, sent only when atleast one of them is present */
+    requestLocationActionParameters?: Record<string, unknown>;
+    /** defName: maker - Maker's name */
+    maker?: string[];
+    /** defName: mbat - Battery usage */
+    batteryUsage?: string;
+    /** defName: mcn - Mobile carrier name */
+    mobileCarrierName?: string;
+    /** defName: mcnd - Mobile carrier name for dual SIM functionality */
+    mobileCarrierNameForDualSim?: string;
+    /** defName: media - Details for the video/audio media-related events. */
+    media?: Record<string, unknown>;
+    /** defName: event_name - The name of the event being tracked. */
+    eventName?: string;
+    /** defName: mnavtime - Mobile navigation time (milliseconds) */
+    mobileNavigationTime?: number;
+    /** defName: model - Mobile device brand model */
+    mobileDeviceBrandModel?: string;
+    /** defName: mori - Mobile orientation (1: portrait, 2: landscape) */
+    mobileOrientation?: MoriEnum;
+    /** defName: mos - Mobile OS */
+    mobileOs?: string;
+    /** defName: m3_r - m3_r cookie */
+    m3rCookie?: string;
+    /** defName: ni - Goes with the 'itemid' parameter. Represents the number of items ordered for each item in the cart. */
+    itemCount?: number[];
+    /** defName: ni_order - Total item count per order, this goes together with the "order_list" parameter */
+    itemCountOrder?: number[];
+    /** defName: oa - For search results pages. Indicates the logical relationship that was used between the search keywords ("o":exact OR, "a":exact AND, "x":approximate) */
+    orAnd?: OaEnum;
+    /** defName: order_id - Order id */
+    orderId?: string;
+    /** defName: order_list - List of order IDs; this was added for supporting the multiple order at once scenario, should replace the single "order_id" parameter eventually */
+    orderList?: string[];
+    /** defName: payment - Payment method */
+    payment?: string;
+    /** defName: pgl - PC: desktop browser, SP: Smartphone, TB: Tablet, RESP: Responsive layout */
+    pageLayout?: PglEnum;
+    /** defName: pgn - Page name */
+    pageName?: string;
+    /** defName: pgs - Page Section */
+    pageSection?: string;
+    /** defName: pgt - Page type */
+    pageType?: PgtEnum;
+    /** defName: phoenix_pattern - For integration with in-house AB test tool "Phoenix" */
+    phoenixPattern?: string;
+    /** defName: point_price - Point used per order */
+    pointPrice?: number[];
+    /** defName: powerstatus - Battery charging status (0-Not charging, 1-Charging) */
+    batteryChargingStatus?: PowerstatusEnum;
+    /** defName: prdctcd - Product code */
+    productCode?: string[];
+    /** defName: price - Specifies the price of each item listed in itemid */
+    price?: number[];
+    /** defName: publisher - Publisher's name */
+    publisher?: string[];
+    /** defName: rancode - RAN code */
+    ranCode?: string;
+    /** defName: reqc - Error or result code */
+    requestResult?: string;
+    /** defName: rescreadate - Reservation creation date */
+    reservationMadeDate?: string;
+    /** defName: resdate - Reserved date */
+    reservedDate?: string;
+    /** defName: reservation_id - Reservation id */
+    reservationId?: string;
+    /** defName: reslayout - Page layout used to display search results */
+    resultLayout?: string;
+    /** defName: Rg - Personal data cookie */
+    rgCookie?: string;
+    /** defName: scond - List of search criteria id */
+    searchCondition?: string[];
+    /** defName: search_entity - Specifies an entity type for each item in itemid (organic, ad, shop, item, product, etc) */
+    searchEntity?: number[];
+    /** defName: service - Service type */
+    serviceType?: string;
+    /** defName: sgenre - Shop specific genre */
+    shopGenre?: string;
+    /** defName: shipping - Shipping method */
+    shippingMethod?: string;
+    /** defName: shipping_fee - Shipping fee per order */
+    shippingFee?: number[];
+    /** defName: shopid - Shop id */
+    shopId?: string;
+    /** defName: shopidlist - Shop id list */
+    shopIdList?: string[];
+    /** defName: shopurl - Part of the URL that identifies the shop */
+    shopUrl?: string;
+    /** defName: shopurllist - Shop url list */
+    shopUrlList?: string[];
+    /** defName: sphinx_pattern - For integration with in-house AB test tool "Sphinx" */
+    sphinxPattern?: string;
+    /** defName: sq - Search query */
+    searchQuery?: string;
+    /** defName: sresv - Same as itemid, for use with scroll events */
+    scrollViewed?: string[];
+    /** defName: srt - Indicates the type of alternate search used when the initial search does not return anything */
+    retryType?: SrtEnum;
+    /** defName: ss_r - ss_r cookie */
+    ssrCookie?: string;
+    /** defName: ssc - Bigger page/screen analysis granularity than page name */
+    siteSection?: string;
+    /** defName: tag - A list of search tags */
+    tag?: string[];
+    /** defName: target_ele - Unique target_ele to all clickable element <p>{screen_name}:{component_name}-{element_type}.{action}</p> */
+    targetElement?: string;
+    /** defName: total_price - Total prices per order, this goes together with the "order_list" parameter */
+    totalPrice?: number[];
+    /** defName: ts1 - For redirect and native app purposes only. Format: seconds since epoch time */
+    clientProvidedTimestamp?: number;
+    /** defName: userid - Defined for applications to pass users encrypted member id */
+    userId?: string;
+    /** defName: variantid - A list of item id used to identify variants of items/services */
+    variantid?: string[];
+    /** defName: variation - Goes together with the "itemid" parameter. Key-value mappings of each item's variations. Short names and abbreviations are preferred */
+    itemVariation?: Record<string, unknown>[];
+    /** defName: wb_pattern - For integration with in-house AB test tool "Widowbird" */
+    widowbirdPattern?: string;
+    /** defName: _ra - Cookie with a unique value for each user (browser), regardless of their membership. _ra is issued at client side via JavaScript. */
+    userCookieJs?: string;
+}
+export declare const inputToOutputMap: {
+    readonly rpCookie: "Rp";
+    readonly rzCookie: "Rz";
+    readonly abTest: "abtest";
+    readonly testTargeting: "abtest_target";
+    readonly accountId: "acc";
+    readonly affiliateId: "afid";
+    readonly adultFlag: "aflg";
+    readonly serviceId: "aid";
+    readonly appName: "app_name";
+    readonly appVersion: "app_ver";
+    readonly area: "area";
+    readonly adobeSiteSection: "assc";
+    readonly booksGenre: "bgenre";
+    readonly brand: "brand";
+    readonly cartState: "cart";
+    readonly campaignCode: "cc";
+    readonly checkout: "chkout";
+    readonly checkpoint: "chkpt";
+    readonly idfaCookie: "cka";
+    readonly persistentCookie: "ckp";
+    readonly sessionCookie: "cks";
+    readonly sessionCookieV2: "cks2";
+    readonly contentLanguage: "cntln";
+    readonly componentId: "compid";
+    readonly countryCode: "country";
+    readonly couponPrice: "coupon_price";
+    readonly couponId: "couponid";
+    readonly customParameters: "cp";
+    readonly customerId: "customerid";
+    readonly cvEvent: "cv";
+    readonly currencyCode: "cycode";
+    readonly currencyCodeList: "cycodelist";
+    readonly deviceLanguage: "dln";
+    readonly eeid: "eeid";
+    readonly errorList: "errorlist";
+    readonly errors: "errors";
+    readonly excludeQuery: "esq";
+    readonly eventType: "etype";
+    readonly genre: "genre";
+    readonly goalId: "gol";
+    readonly itemGenre: "igenre";
+    readonly itemGenreNamePath: "igenrenamepath";
+    readonly itemGenrePath: "igenrepath";
+    readonly rmsItemNumber: "ino";
+    readonly itemTag: "itag";
+    readonly itemName: "item_name";
+    readonly itemId: "itemid";
+    readonly itemUrl: "itemurl";
+    readonly language: "lang";
+    readonly location: "loc";
+    readonly requestLocationActionParameters: "action_params";
+    readonly maker: "maker";
+    readonly batteryUsage: "mbat";
+    readonly mobileCarrierName: "mcn";
+    readonly mobileCarrierNameForDualSim: "mcnd";
+    readonly media: "media";
+    readonly eventName: "event_name";
+    readonly mobileNavigationTime: "mnavtime";
+    readonly mobileDeviceBrandModel: "model";
+    readonly mobileOrientation: "mori";
+    readonly mobileOs: "mos";
+    readonly m3rCookie: "m3_r";
+    readonly itemCount: "ni";
+    readonly itemCountOrder: "ni_order";
+    readonly orAnd: "oa";
+    readonly orderId: "order_id";
+    readonly orderList: "order_list";
+    readonly payment: "payment";
+    readonly pageLayout: "pgl";
+    readonly pageName: "pgn";
+    readonly pageSection: "pgs";
+    readonly pageType: "pgt";
+    readonly phoenixPattern: "phoenix_pattern";
+    readonly pointPrice: "point_price";
+    readonly batteryChargingStatus: "powerstatus";
+    readonly productCode: "prdctcd";
+    readonly price: "price";
+    readonly publisher: "publisher";
+    readonly ranCode: "rancode";
+    readonly requestResult: "reqc";
+    readonly reservationMadeDate: "rescreadate";
+    readonly reservedDate: "resdate";
+    readonly reservationId: "reservation_id";
+    readonly resultLayout: "reslayout";
+    readonly rgCookie: "Rg";
+    readonly searchCondition: "scond";
+    readonly searchEntity: "search_entity";
+    readonly serviceType: "service";
+    readonly shopGenre: "sgenre";
+    readonly shippingMethod: "shipping";
+    readonly shippingFee: "shipping_fee";
+    readonly shopId: "shopid";
+    readonly shopIdList: "shopidlist";
+    readonly shopUrl: "shopurl";
+    readonly shopUrlList: "shopurllist";
+    readonly sphinxPattern: "sphinx_pattern";
+    readonly searchQuery: "sq";
+    readonly scrollViewed: "sresv";
+    readonly retryType: "srt";
+    readonly ssrCookie: "ss_r";
+    readonly siteSection: "ssc";
+    readonly tag: "tag";
+    readonly targetElement: "target_ele";
+    readonly totalPrice: "total_price";
+    readonly clientProvidedTimestamp: "ts1";
+    readonly userId: "userid";
+    readonly variantid: "variantid";
+    readonly itemVariation: "variation";
+    readonly widowbirdPattern: "wb_pattern";
+    readonly userCookieJs: "_ra";
+};