osmos-web-sdk/dist/types/index.d.ts

OnlineSales.ai Web SDK for Vue and React projects

export interface OsmosSDKOptions {
    clientId: number;
    productAdsHost: string;
    displayAdsHost: string;
    eventTrackingHost?: string;
    cliUbid?: string | number;
    device?: 'MOBILE' | 'TABLET' | 'DESKTOP';
    mobileMediaQuery?: string;
    tabletMediaQuery?: string;
    detectDeviceViaUA?: boolean;
    enableTracking?: boolean;
    fireDefaultPixel?: boolean;
    trackingParams?: (() => Record<string, any>) | Record<string, any>;
    searchKeywordKey?: string;
    customQueryParams?: (() => Record<string, any>) | Record<string, any>;
    queryToParamMapping?: Record<string, string>;
    urlToParamMapping?: Record<string, string>;
    videoView?: number;
    defaultTrackSeconds?: number[];
    enableOMSdk?: boolean;
    omSdkOptions?: Record<string, any>;
    selectorPrefix?: string;
    retryCount?: number;
    debugMode?: boolean;
}
export interface DisplayAdsQuery {
    cliUbid: string | number;
    adUnit: string | string[];
    pageType: string;
    productCount: number;
    keyword?: string;
    device?: string;
    skuId?: string | number;
    categoryId?: string | number;
    brand?: string;
    categoryL1?: string;
    categoryL2?: string;
    categoryL3?: string;
    storeId?: string | number;
    city?: string;
    state?: string;
    country?: string;
    customParam1?: string | number;
    customParam2?: string | number;
    customParam3?: string | number;
    customParam4?: string | number;
    customParam5?: string | number;
}
export interface ProductPageAdsQuery {
    cliUbid: string | number;
    skuIds: string[];
    productCount?: number;
    device?: string;
    pageName?: string;
    storeId?: string | number;
    maxPrice?: number;
    minPrice?: number;
    brands?: string[];
    categories?: string[];
    brandIds?: string[];
}
export interface SearchPageAdsQuery {
    cliUbid: string | number;
    keyword: string;
    productCount?: number;
    device?: string;
    pageName?: string;
    storeId?: string | number;
    maxPrice?: number;
    minPrice?: number;
}
export interface CategoryPageAdsQuery {
    cliUbid: string | number;
    categoryId?: string | number;
    categories?: string[];
    productCount?: number;
    device?: string;
    pageName?: string;
    storeId?: string | number;
    maxPrice?: number;
    minPrice?: number;
    brands?: string[];
    brandIds?: string[];
}
export interface TPAPageAdsQuery {
    cliUbid: string | number;
    productCount?: number;
    device?: string;
    pageName?: string;
    skuIds?: string[];
    isPersonalized?: string;
}
export interface PurchasePageAdsQuery {
    cliUbid: string | number;
    skuIds: string[];
    productCount?: number;
    device?: string;
    pageName?: string;
    storeId?: string | number;
    maxPrice?: number;
    minPrice?: number;
    brands?: string[];
    categories?: string[];
    brandIds?: string[];
}
export interface HomePageAdsQuery {
    cliUbid: string | number;
    productCount?: number;
    device?: string;
    pageName?: string;
    storeId?: string | number;
    maxPrice?: number;
    minPrice?: number;
    brands?: string[];
    categories?: string[];
    brandIds?: string[];
}
export interface CustomPageAdsQuery {
    cliUbid: string | number;
    pageName: string;
    productCount?: number;
    device?: string;
    mcategoriesIds?: string[];
    brands?: string[];
    categories?: string[];
    maxPrice?: number;
    minPrice?: number;
}
export interface AdResponse {
    success: boolean;
    data?: any;
    error?: string;
}
export type DeviceType = 'MOBILE' | 'TABLET' | 'DESKTOP';
//# sourceMappingURL=index.d.ts.map