@surfside/surfside-events 0.0.1 → 2.0.0

package/dist/index.umd.d.ts

@@ -168,6 +168,63 @@ interface segmentContext {
  * @param trackers - The tracker identifiers which the context will be stored against
  */
 declare function segment(context?: segmentContext, trackers?: Array<string>): void;
+/**
+ * Removes a Surfside Segment Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function removeSegment(context?: segmentContext, trackers?: Array<string>): void;
+/**
+ * A Surfside Local Business Location Context
+ */
+interface localBusinessLocationContext {
+    /** The Location ID */
+    id?: string;
+    /** The Location Latitude */
+    latitude?: string;
+    /** The Location Longitude */
+    longitude?: string;
+    /** The Location Country Code */
+    country_code?: string;
+    /** The Location Zip */
+    zip?: string;
+    /** The Location State Label */
+    state_label?: string;
+    /** The Location State */
+    state?: string;
+    /** The Location City */
+    city?: string;
+    /** The Location Street */
+    street?: string;
+    /** The Location Name */
+    name?: string;
+    /** The Location Parent */
+    parent?: string;
+    /** The Location Type */
+    type?: string;
+    /** The Location Category */
+    category?: string;
+}
+declare global {
+    interface Window {
+        surf: any;
+    }
+}
+/**
+ * Adds a Surfside  Local Business Location Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function setLocation(context?: localBusinessLocationContext, trackers?: Array<string>): void;
+/**
+ * Removes a Surfside  Local Business Location Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function removeLocation(context?: localBusinessLocationContext, trackers?: Array<string>): void;
 /**
  * A Surfside User Context
  */
@@ -192,6 +249,8 @@ interface userContext {
     userId?: string;
     /** The last name of the user */
     lastName?: string;
+    /** The phone number of the user */
+    phone?: string;
 }
 /**
  * Adds a Surfside User Context
@@ -200,6 +259,11 @@ interface userContext {
  * @param trackers - The tracker identifiers which the context will be stored against
  */
 declare function setUser(context?: userContext, trackers?: Array<string>): void;
+interface SurfIdContextRequest {
+    email?: string;
+    phone?: string;
+}
+declare function setSurfId(context?: SurfIdContextRequest, trackers?: Array<string>): void;
 /**
  * A Surfside User Context
  */
@@ -242,4 +306,136 @@ interface identifyUserContext {
  * @param trackers - The tracker identifiers which the context will be stored against
  */
 declare function identifyUser(context?: identifyUserContext, trackers?: Array<string>): void;
-export { SurfsideCommercePlugin, commerceAction, setCommerceAction, commerceTransactionContext, addTransaction, commerceImpressionContext, addImpression, commerceProductContext, addProduct, commercePromoContext, addPromotion, sourceContext, source, segmentContext, segment, userContext, setUser, identifyUserContext, identifyUser };
+type AuctionInitEvent = {
+    auctionId: string;
+    timestamp: number;
+    auctionStatus: string;
+    adUnits: AuctionInitEventAdUnit[];
+    bidderRequests: AdUnitBidderRequest[];
+};
+type AuctionInitEventAdUnit = {
+    requestId: string;
+    mediaTypes: object;
+    bids: AdUnitBid[];
+    timeout: number;
+    sizes: number[][];
+    transactionId: string;
+};
+type AdUnitBid = {
+    params: object;
+    user: object;
+};
+type AdUnitBidderRequest = {
+    bidderRequestId: string;
+    bids: BidderRequestBid[];
+    auctionStart: number;
+    timeout: number;
+    refererInfo: BidderRequestRefererInfo;
+};
+type BidderRequestBid = {
+    ortb2: {
+        site: {
+            page: string;
+            domain: string;
+        };
+        device: {
+            w: number;
+            h: number;
+            dnt: number;
+            ua: string;
+            language: string;
+        };
+    };
+};
+type BidderRequestRefererInfo = {
+    stack: string[];
+    location: string;
+    page: string;
+    domain: string;
+};
+declare function auctionInit(e: AuctionInitEvent & CommonEventProperties, trackers?: Array<string>): void;
+type BidRequestedEvent = {
+    auctionId: string;
+    bidderRequestId: string;
+    bids: BidRequestedBid[];
+    auctionStart: number;
+    timeout: number;
+    refererInfo: BidderRequestRefererInfo;
+    start: number;
+};
+type BidRequestedBid = {
+    params: object;
+    user: object;
+    ortb2Imp: object;
+    mediaTypes: object;
+    transactionId: string;
+    sizes: [];
+    bidId: string;
+    ortb2: {
+        site: {
+            page: string;
+            domain: string;
+        };
+        device: {
+            w: number;
+            h: number;
+            dnt: number;
+            ua: string;
+            language: string;
+        };
+    };
+};
+declare function bidRequested(e: BidRequestedEvent, trackers?: Array<string>): void;
+type BidResponseEvent = {
+    width: number;
+    height: number;
+    statusMessage: string;
+    adId: string;
+    requestId: string;
+    transactionId: string;
+    auctionId: string;
+    mediaType: string;
+    ad: string;
+    seatBidId: string;
+    cpm: number;
+    currency: string;
+    creative_id: string;
+    creativeId: string;
+    ttl: number;
+    netRevenue: boolean;
+    meta: {
+        advertiserDomains: string[];
+    };
+    originalRequest: {
+        ext: {
+            tid: string;
+        };
+        id: string;
+        banner: {
+            topFrame: number;
+            format: {
+                w: number;
+                h: number;
+            }[];
+        };
+        tagid: string;
+    };
+    originalCpm: number;
+    originalCurrency: string;
+    responseTimestamp: number;
+    requestTimestamp: number;
+    timeToRespond: number;
+    size: string;
+};
+declare function bidResponse(e: BidResponseEvent, trackers?: Array<string>): void;
+type BidderDoneEvent = BidRequestedEvent;
+declare function bidderDone(e: BidderDoneEvent, trackers?: Array<string>): void;
+type BidderErrorEvent = {
+    error: object;
+} & {
+    bidderRequest: BidRequestedEvent;
+};
+declare function bidderError(e: BidderErrorEvent, trackers?: Array<string>): void;
+type NoBidEvent = BidRequestedEvent;
+declare function noBid(e: NoBidEvent, trackers?: Array<string>): void;
+export { SurfsideCommercePlugin, commerceAction, setCommerceAction, commerceTransactionContext, addTransaction, commerceImpressionContext, addImpression, commerceProductContext, addProduct, commercePromoContext, addPromotion, sourceContext, source, segmentContext, segment, removeSegment, localBusinessLocationContext, setLocation, removeLocation, userContext, setUser, SurfIdContextRequest, setSurfId, identifyUserContext, identifyUser, auctionInit, bidRequested, bidResponse, bidderDone, bidderError, noBid };