@springtree/eva-core/EVA.Cloe.d.ts

The EVA core typings

declare module EVA.Cloe {

  /**
   * Generates a tracking identifier for `Cloe`. If available, the `SessionID` can be provided.
   * The generated tracking identifier should be used to call the `CloeTrackEvent` service.
   */
  export interface CloeGetTrackingID {
    SessionID?: string;
  }

  export interface CloeGetTrackingIDResponse {
    TrackingID: string;
    Error: EVA.Core.ServiceError;
  }

  /**
   * Track events for `Cloe`. All fields are mandatory. The `TrackingID` can be generated with the `CloeGetTrackingID` service.
   */
  export interface CloeTrackEvent {
    TrackingID: string;
    EventID: string;
    Data: { [key: string]: any };
  }

  /**
   * Accepts a list of product/Fingerprint pairs and updates the cloe_fingerprint property on the given products.
   * 
   * To identify the product, either specify ProductID or ProductIdentifier. When ProductIdentifier is used, it's matched to an EVA product
   * using the value of the `Cloe:ProductIdentifierField` setting (for example `backend_id`).
   * 
   *  The service returns immediately and processing happens in the background.
   */
  export interface CloeUpdateProductFingerprints {
    Fingerprints: ProductFingerprint[];
  }

  export interface ProductFingerprint {
    ProductID: number;
    ProductIdentifier: string;
    Fingerprint: string;
  }

}