@sheerid/jslib-nightly/src/lib/conversion/conversion.d.ts

SheerID JavaScript Library

import { Conversion, ConversionRequest, DatabaseId } from '../types/types';
/**
 * @description attempts to record a conversion with SheerID's REST API using a previously-set verificationId (set in a cookie)
 */
export declare const convert: (conversionRequest: ConversionRequest) => void;
/**
 * Begin a conversion session recording.
 * Saves verificationId as a cookie for use later.
 * This should be called by the page that has the SheerID <iframe>, not the page that renders the verification form.
 */
export declare const listenForVerificationId: () => void;
/**
 * @private
 * @todo Note we are _only_ using JSON serialize/parse because https://services.sheerid.com/jsapi/SheerID.js
 *  breaks if it cannot parse a json frame message.
 */
export declare const onSheerIdFrameMessage: (event: any) => void;
/**
 * @private
 */
export declare const storeConversionVerificationIdCookie: (verificationId: DatabaseId) => void;
/**
 * @private
 */
export declare const saveVerificationIdForConversion: (verificationId: DatabaseId) => void;
/**
 * @private
 */
export declare const resolveTrackingId: (trackingId?: string) => string;
/**
 * The public export of conversion-related fuqnctions
 */
export declare const conversion: Conversion;