@surfside/ads-core 2.0.1 → 2.0.2

package/lib/types/models/rtb/IBidRequest.d.ts

@@ -1,399 +0,0 @@
-export interface IBrandVersion {
-    brand: string;
-    version?: string[];
-    ext?: any;
-}
-export interface IUserAgent {
-    browsers?: IBrandVersion[];
-    platform?: IBrandVersion;
-    mobile?: number;
-    architecture?: string;
-    bitness?: string;
-    model?: string;
-    source?: number;
-    ext?: any;
-}
-export declare enum AgentTypes {
-    SESSION = 1,
-    DEVICE = 2,
-    USER = 3
-}
-export interface IUid {
-    id: string;
-    atype?: AgentTypes;
-    ext?: any;
-}
-export interface IEid {
-    source: string;
-    uids: IUid[];
-    ext?: any;
-}
-export interface ISupplyChainNode {
-    asi?: string;
-    sid?: string;
-    hp?: number;
-    rid?: string;
-    name?: string;
-    domain?: string;
-    ext?: any;
-}
-export interface ISupplyChain {
-    complete: number;
-    nodes: ISupplyChainNode[];
-    ver: string;
-    ext?: any;
-}
-export interface IChannel {
-    id?: string;
-    name?: string;
-    domain?: string;
-    ext?: any;
-}
-export interface INetwork {
-    id?: string;
-    name?: string;
-    domain?: string;
-    ext?: any;
-}
-export interface ISegment {
-    id?: string;
-    name?: string;
-    value?: string;
-    ext?: any;
-}
-export interface IData {
-    id?: string;
-    name?: string;
-    segment?: ISegment[];
-    ext?: any;
-}
-export interface IUser {
-    id?: string;
-    buyeruid?: string;
-    yob?: number;
-    gender?: string;
-    keywords?: string;
-    kwarray?: string[];
-    customdata?: string;
-    geo?: IGeo;
-    data?: IData[];
-    cconsent?: string;
-    eids?: IEid[];
-    ext?: any;
-}
-export interface IGeo {
-    lat?: number;
-    lon?: number;
-    type?: number;
-    accuracy?: number;
-    lastfix?: number;
-    ipservice?: number;
-    country?: string;
-    region?: string;
-    regionfips104?: string;
-    metro?: string;
-    city?: string;
-    zip?: string;
-    utcoffset?: number;
-    ext?: any;
-}
-export declare enum AdCom10DeviceTypes {
-    MOBILE = 1,
-    PC = 2,
-    CTV = 3,
-    PHONE = 4,
-    TABLET = 5,
-    CONNECTED = 6,
-    SET_TOP = 7,
-    OOH = 8
-}
-export interface IDevice {
-    ua?: string;
-    geo?: IGeo;
-    dnt?: number;
-    lmt?: number;
-    ip?: string;
-    ipv6?: string;
-    devicetype?: number;
-    make?: string;
-    model?: string;
-    os?: string;
-    osv?: string;
-    hwv?: string;
-    h?: number;
-    w?: number;
-    ppi?: number;
-    pxratio?: number;
-    js?: number;
-    geofetch?: number;
-    flashver?: string;
-    language?: string;
-    lanbg?: string;
-    carrier?: string;
-    mccmnc?: string;
-    connectiontype?: number;
-    ifa?: string;
-    didsha1?: string;
-    didmd5?: string;
-    dpidsha1?: string;
-    dpidmd5?: string;
-    macsha1?: string;
-    macmd5?: string;
-    ext?: any;
-    sua?: IUserAgent;
-}
-export interface IProducer {
-    id?: string;
-    name?: string;
-    cattax?: number[];
-    cat?: string[];
-    domain?: string;
-    ext?: any;
-}
-export interface IContent {
-    id?: string;
-    episode?: number;
-    title?: string;
-    series?: string;
-    season?: string;
-    artist?: string;
-    genre?: string;
-    album?: string;
-    isrc?: string;
-    producer?: IProducer;
-    url?: string;
-    cattax?: number[];
-    cat?: string[];
-    prodq?: number;
-    videoquality?: number;
-    context?: number;
-    contentrating?: string;
-    userrating?: string;
-    qagmediarating?: number;
-    keywords?: string;
-    kwarray?: string[];
-    livestream?: number;
-    sourcerelationship?: number;
-    len?: number;
-    language?: string;
-    langb?: string;
-    embeddable?: number;
-    data?: IData[];
-    network?: INetwork;
-    channel?: IChannel;
-    ext?: any;
-}
-export interface IPublisher {
-    id?: string;
-    name?: string;
-    cattax?: number[];
-    cat?: string[];
-    domain?: string;
-    ext?: any;
-}
-export interface IApp {
-    id?: string;
-    name?: string;
-    bundle?: string;
-    domain?: string;
-    storeurl?: string;
-    cat?: string[];
-    sectioncat?: string[];
-    pagecat?: string[];
-    ver?: string;
-    privacypolicy?: number;
-    paid?: number;
-    publisher?: IPublisher;
-    content?: IContent;
-    keywords?: string;
-    kwarray?: string[];
-    ext?: any;
-}
-export interface ISite {
-    id?: string;
-    name?: string;
-    domain?: string;
-    cat?: string[];
-    sectioncat?: string[];
-    pagecat?: string[];
-    page?: string;
-    ref?: string;
-    search?: string;
-    mobile?: number;
-    privacypolicy?: number;
-    publisher?: IPublisher;
-    content?: IContent;
-    keywords?: string;
-    kwarray?: string[];
-    ext?: any;
-}
-export interface IDeal {
-    id: string;
-    bidfloor: number;
-    bidfloorcur?: string;
-    at?: number;
-    wseat?: string[];
-    wadomain?: string[];
-    ext?: any;
-}
-export interface IPmp {
-    private_auction?: number;
-    deals?: IDeal[];
-    ext?: any;
-}
-export interface IFormat {
-    w?: number;
-    h?: number;
-    wratio?: number;
-    hratio?: number;
-    wmin?: number;
-    ext?: any;
-}
-export interface INative {
-    request: string;
-    ver?: string;
-    api?: number[];
-    battr?: number[];
-    ext?: any;
-}
-export interface IAudio {
-    mimes: string[];
-    minduration?: number;
-    maxduration?: number;
-    poddur?: number;
-    protocols?: number[];
-    startdelay?: number;
-    rqddurs?: number[];
-    podid?: string;
-    podseq?: number;
-    sequence?: number;
-    slotinpod?: number;
-    mincpmpersec?: number;
-    battr?: number[];
-    maxextended?: number;
-    minbitrate?: number;
-    maxbitrate?: number;
-    delivery?: number[];
-    companionad?: IBanner[];
-    api?: number[];
-    companiontype?: number[];
-    maxseq?: number;
-    feed?: number;
-    stitched?: number;
-    nvol?: number;
-    ext?: any;
-}
-export interface IVideo {
-    mimes: string[];
-    minduration?: number;
-    maxduration?: number;
-    startdelay?: number;
-    maxseq?: number;
-    poddur?: number;
-    protocols?: number[];
-    w?: number;
-    h?: number;
-    podid?: string;
-    podseq?: number;
-    rqddurs?: number[];
-    placement?: number;
-    linearity?: number;
-    skip?: number;
-    skipmin?: number;
-    skipafter?: number;
-    sequence?: number;
-    slotinpod?: number;
-    mincpmpersec?: number;
-    battr?: number[];
-    maxextended?: number;
-    minbitrate?: number;
-    maxbitrate?: number;
-    boxingallowed?: number;
-    playbackmethod?: number[];
-    playbackend?: number;
-    delivery?: number[];
-    pos?: number;
-    companionad?: IBanner[];
-    api?: number[];
-    companiontype?: number[];
-    ext?: any;
-}
-export interface IBanner {
-    format?: IFormat[];
-    w?: number;
-    h?: number;
-    btype?: number[];
-    battr?: number[];
-    pos?: number;
-    mimes?: string[];
-    topframe?: number;
-    expdir?: number[];
-    api?: number[];
-    id?: string;
-    ext?: any;
-}
-export interface IMetric {
-    type: string;
-    value: number;
-    vendor?: string;
-    ext?: any;
-}
-export interface IImp {
-    id: string;
-    metric?: IMetric[];
-    banner?: IBanner;
-    video?: IVideo;
-    audio?: IAudio;
-    native?: INative;
-    pmp?: IPmp;
-    displaymanager?: string;
-    displaymanagerver?: string;
-    instl?: number;
-    tagid?: string;
-    bidfloor?: number;
-    bidfloorcur?: string;
-    clickbrowser?: number;
-    secure?: number;
-    iframebuster?: string[];
-    rwdd?: number;
-    ssai?: number;
-    exp?: number;
-    ext?: any;
-}
-export interface IRegs {
-    coppa?: number;
-    ext?: any;
-    gdpr?: number;
-    us_privacy?: string;
-}
-export interface ISource {
-    fd?: number;
-    tid?: string;
-    pchain?: string;
-    schain?: ISupplyChain;
-    ext?: any;
-}
-export interface IBidRequest {
-    id: string;
-    imp: IImp[];
-    site?: ISite;
-    app?: IApp;
-    device?: IDevice;
-    user?: IUser;
-    test?: number;
-    at?: number;
-    tmax?: number;
-    wseat?: string[];
-    bseat?: string[];
-    allimps?: number;
-    cur?: string[];
-    wlang?: string[];
-    wlangb?: string[];
-    bcat?: string[];
-    cattax?: number[];
-    badv?: string[];
-    bapp?: string[];
-    source?: ISource;
-    regs?: IRegs;
-    ext?: any;
-}

package/lib/types/models/rtb/IBidResponse.d.ts

@@ -1,47 +0,0 @@
-export interface IBid {
-    id: string;
-    impid: string;
-    price: number;
-    nurl?: string;
-    burl?: string;
-    lurl?: string;
-    adm?: string;
-    adid?: string;
-    adomain?: string[];
-    bundle?: string;
-    iurl?: string;
-    cid?: string;
-    crid?: string;
-    tactic?: string;
-    cattax?: number;
-    cat?: string[];
-    attr?: number[];
-    api?: number;
-    protocol?: number;
-    qagmediarating?: number;
-    language?: string;
-    dealid?: string;
-    w?: number;
-    h?: number;
-    wratio?: number;
-    hratio?: number;
-    exp?: number;
-    ext?: any;
-    dur?: number;
-    mtype?: number;
-    slotinpid?: number;
-}
-export interface ISeatBid {
-    bid: IBid[];
-    seat?: string;
-    group?: number;
-    ext?: any;
-}
-export interface IBidResponse {
-    id: string;
-    seatbid?: ISeatBid[];
-    bidid?: string;
-    cur?: string;
-    nbr?: number;
-    ext?: any;
-}

package/lib/types/models/rtb/native/Constants.d.ts

@@ -1,60 +0,0 @@
-export declare enum CreativeType {
-    BANNER = 0,
-    INLINE = 1,
-    PRODUCT_CARD = 2,
-    PRODUCT_CAROUSEL = 3,
-    VIDEO = 4
-}
-export declare enum NativePosition {
-    UNKNOWN = 0,
-    ABOVE_THE_FOLD = 1,
-    BELOW_THE_FOLD = 3,
-    HEADER = 4,
-    FOOTER = 5,
-    SIDEBAR = 6,
-    FULL_SCREN = 7
-}
-export declare enum NativeImageTypes {
-    ICON = 1,
-    MAIN = 3
-}
-export declare enum NativeDataTypes {
-    SPONSORED = 1,
-    DESC = 2,
-    RATING = 3,
-    LIKES = 4,
-    DOWNLOADS = 5,
-    PRICE = 6,
-    SALEPRICE = 7,
-    PHONE = 8,
-    ADDRESS = 9,
-    DESC2 = 10,
-    DISPLAYURL = 11,
-    CTATEXT = 12,
-    SURF_STRAIN = 500,
-    SURF_THC = 501,
-    SURF_CBD = 502,
-    SURF_CATEGORY = 503
-}
-export declare enum NativeAssetId {
-    TITLE = 0,
-    IMAGE = 1,
-    SPONSORED = 2,
-    DESC = 3,
-    RATING = 4,
-    PRICE = 5,
-    SALEPRICE = 6,
-    DISPLAYURL = 7,
-    CTATEXT = 8,
-    SURF_CATEGORY = 9,
-    SURF_THC = 10,
-    SURF_CBD = 11,
-    SURF_STRAIN = 12
-}
-export interface INativeDataAsset {
-    id: number;
-    required: 0 | 1;
-    data: {
-        type: number;
-    };
-}

package/lib/types/models/rtb/native/INativeRequest.d.ts

@@ -1,54 +0,0 @@
-import type { ContextSubTypes, ContextTypes, EventTrackingMethods, EventTypes, NativeDataTypes, PlacementTypes, VideoMimes } from './NativeConstants';
-export interface INativeRequest {
-    ver?: string;
-    context?: ContextTypes;
-    contextsubtype?: ContextSubTypes;
-    plcmttype?: PlacementTypes;
-    plcmtcnt?: number;
-    seq?: number;
-    assets: IAssetObject[];
-    aurlsupport?: number;
-    durlsupport?: number;
-    eventtrackers?: IEventTrackerRequestObject[];
-    privacy?: number;
-    ext?: any;
-}
-export interface IAssetObject {
-    id: number;
-    required?: number;
-    title?: ITitleRequestObject;
-    img?: IImageRequestObject;
-    video?: IVideoRequestObject;
-    data?: IDataRequestObject;
-    ext?: any;
-}
-export interface ITitleRequestObject {
-    len: number;
-    ext?: any;
-}
-export interface IImageRequestObject {
-    type?: number;
-    w?: number;
-    wmin?: number;
-    h?: number;
-    hmin?: number;
-    mimes?: string[];
-    ext?: any;
-}
-export interface IVideoRequestObject {
-    mimes: VideoMimes[] | string[];
-    minduration: number;
-    maxduration: number;
-    protocols: number[];
-    ext?: any;
-}
-export interface IDataRequestObject {
-    type: NativeDataTypes;
-    len?: number;
-    ext?: any;
-}
-export interface IEventTrackerRequestObject {
-    event: EventTypes;
-    methods: EventTrackingMethods[];
-    ext?: any;
-}

package/lib/types/models/rtb/native/INativeResponse.d.ts

@@ -1,60 +0,0 @@
-import { type EventTrackingMethods, type IProductInformation, type NativeDataTypes, NativeImageTypes, EventTypes } from '../../../models';
-export interface INativeResponse {
-    native: INativeResponseDetails;
-}
-export interface INativeResponseDetails {
-    ver?: string;
-    assets?: IAssetResponseObject[];
-    assetsurl?: string;
-    dcourl?: string;
-    link: ILinkResponseObject;
-    imptrackers?: string[];
-    jstracker?: string;
-    eventtrackers?: IEventTrackerResponseObject[];
-    privacy?: string;
-    ext?: any;
-}
-export interface IAssetResponseObject {
-    id?: number;
-    required?: number;
-    title?: ITitleResponseObject;
-    img?: IImageResponseObject;
-    data?: IDataResponseObject;
-    video?: IVideoResponseObject;
-    link?: ILinkResponseObject;
-    ext?: any;
-}
-export interface ITitleResponseObject {
-    text: string;
-    len?: number;
-    ext?: any;
-}
-export interface IImageResponseObject {
-    type: NativeImageTypes;
-    url: string;
-    w?: number;
-    h?: number;
-    ext?: any;
-}
-export interface IDataResponseObject {
-    type?: NativeDataTypes;
-    value: string;
-    ext?: any;
-}
-export interface IVideoResponseObject {
-    vasttag: string;
-}
-export interface ILinkResponseObject {
-    url: string;
-    clicktrackers?: string[];
-    fallback?: string;
-    ext?: any;
-}
-export interface IEventTrackerResponseObject {
-    event: EventTypes;
-    method: EventTrackingMethods;
-    url?: string;
-    customdata?: any;
-    ext?: any;
-}
-export declare function NativeResponseToProductInformation(native: INativeResponse): IProductInformation;