iOS SDK

pod 'RavelinCore',  '~> 2.0.0', :source => 'https://github.com/unravelin/Specs.git'

pod 'RavelinEncrypt', '1.1.2, :source => 'https://github.com/unravelin/Specs.git'

'pod 'RavelinCore', '1.0.2' or: pod 'RavelinCore'

pod 'RavelinCore', '~> 2.0.0', :source => 'https://github.com/unravelin/Specs.git'

import RavelinCore
import RavelinEncrypt

@import RavelinCore;
@import RavelinEncrypt;

// Instantiation for tracking only
let ravelin = Ravelin.createInstance("publishable_key_live_----")

// Instantiation for encryption
let ravelinEncrypt = RVNEncryption.sharedInstance()
ravelinEncrypt.rsaKey = "----|----"

   /// Configure the singleton instance of the Ravelin sdk with your public key
    /// - Parameters:
    ///   - apiKey: The public API key from your Ravelin dashboard
    /// - Optional Parameters:
    ///   - customerId: Set a customerId
    ///   - tempCustomerId: Set a tempCustomerId
    ///   - orderId: Set an orderId
    ///   - customDeviceId: Set a customDeviceId
    ///   - appVersion: Set an appVersion
    ///   - logLevel: Set the logLevel (for debug/development)
    ///   - sendFingerprint: Defaults to true to send a fingerprint
    ///   - reset: reset the persisted ID
    ///   - completion: Completion handler for the response
    /// - Remark: Use this method when using RavelinSDK in your app for the first time
    public func configure(apiKey: String, customerId: String?, tempCustomerId: String? = nil, orderId: String? = nil, customDeviceId: String? = nil, appVersion: String? = nil, logLevel: RavelinCore.LogLevel = .error, sendFingerprint: Bool = true, reset: Bool = false, completion: @escaping RavelinCore.TrackResultResponse)

Ravelin.shared.configure(apiKey: "publishable_key_live_----", customerId: "customer012345", appVersion: "1.2.3") { result in
    switch result {
    case .success:
        if let deviceId = Ravelin.shared.deviceId {
            print("deviceId: \(deviceId)")
        }
    case .failure(let error):
            print("\(error)")
            return false
    }
}

Ravelin.shared.configure(apiKey: "publishable_key_live_----", customerId: "customer012345", sendFingerprint: false)

// Instantiation for tracking only
self.ravelin = [Ravelin createInstance:@"publishable_key_live_----"];

// Instantiation for encryption
self.ravelinEncrypt = [RVNEncryption sharedInstance];
self.ravelinEncrypt.rsaKey = @"----|----";

// Directly
Ravelin.sharedInstance().methodName()
// For RavelinCore version 2
RavelinSDK.shared.methodName()

// Directly
[[Ravelin sharedInstance] methodName];

[[RVNEncryption sharedInstance]] methodName];

// Variable
let ravelin = Ravelin.sharedInstance()
// For RavelinCore version 2
let ravelinSDK = RavelinSDK.shared

let ravelinEncrypt = RVNEncryption.sharedInstance()

// Variable
Ravelin *ravelin = [Ravelin sharedInstance];

RVNEncryption *ravelinEncrypt = [RVNEncryption sharedInstance];

var error: NSError? = nil

let encryptionPayload = RVNEncryption.sharedInstance().encrypt("41111111111111", month: "10", year: "10", nameOnCard: "Mr John Doe", error: &error)

if let error = error {
    print("Ravelin encryption error \(error.localizedDescription)")
} else {
    print("Ravelin Encryption payload: \(encryptionPayload as AnyObject)")
    // Send to your servers
}

// Card details
NSString *pan = @"41111111111111";
NSString *month = @"10";
NSString *year = @"2027";
NSString *cardHolder = @"Mr John Doe";

// Error handling
NSError *error;

// Encrypt
NSDictionary *encryptionPayload = [[RVNEncryption sharedInstance] encrypt:pan month:month year:year nameOnCard:cardHolder error:&error];

if(!error) {
    NSLog(@"Ravelin encryption payload: %@",encryptionPayload);
    // Send to your servers
} else {
    NSLog(@"Ravelin encryption error %@", error.localizedDescription);
}

let ravelinSDK = Ravelin.createInstance("publishable_key_live_----")

ravelinSDK.customerId = "customer012345"
ravelinSDK.trackFingerprint()

// optionally providing customerId as a parameter and/or a completion handler:
ravelinSDK.trackFingerprint("customer012345") { _,_,_ in
    if let deviceId = self.ravelinSDK.deviceId {
        print("trackFingerprint for deviceId: \(deviceId)")
    }
}

// from version 2, there is an equivalent async/await function
try await ravelinSDK.trackFingerprint()

ravelinSDK.configure(apiKey: "publishable_key_live_----", customerId: "customer012345")

self.ravelin = [Ravelin createInstance:@"publishable_key_live_----"];
self.ravelin.customerId = @"customer012345";
[self.ravelin trackFingerprint];

let ravelinSDK = RavelinSDK.shared

// after ravelinSDK has been configured
ravelinSDK.trackPage("checkout page")
// optionally providing additional parameters and/or a completion handler:
ravelinSDK.trackPage("checkout page", eventProperties: ["p1" : "v1", "p2": "v2"]) {_, response, error in
    if let error {
        print("\(error)")
    }
}
// from v2, there is an equivalent async/await function
try await ravelinSDK.trackPageLoadedEvent("checkout page")

NSDictionary *eventProperties = @{
    @"p1" : @"v1",
    @"p2" : @"v2",
    @"p3" : @"v3"
    };

[self.ravelin trackPage: @"checkout page" eventProperties: eventProperties];

ravelinSDK.trackSearch("search page", searchValue: "searchValue")

[[Ravelin sharedInstance] trackPage:@"search page" searchValue: @"searchValue"];

ravelinSDK.trackSelectOption("selection page", option: "option selected", optionValue: "option value")

[[Ravelin sharedInstance] trackSelectOption:@"selection page" option: @"option selected"];

ravelinSDK.trackAddToCart("basket", itemName: "item name", quantity: 1)
ravelinSDK.trackRemoveFromCart("basket", itemName: "item name", quantity: 1)

[[Ravelin sharedInstance] trackAddToCart:@"basket" itemName: @"item name"];
[[Ravelin sharedInstance] trackRemoveFromCart:@"basket" itemName: @"item name"];

ravelinSDK.trackAddToWishlist("wish list", itemName: "item name")
ravelinSDK.trackRemoveFromWishlist("wish list", itemName: "item name")

[[Ravelin sharedInstance] trackAddToWishlist:@"wish list" itemName: @"item name"];
[[Ravelin sharedInstance] trackRemoveFromWishlist:@"wish list" itemName: @"item name"];

ravelinSDK.trackViewContent("content page", contentType: "video")

[[Ravelin sharedInstance] trackViewContent:@"content page" contentType: @"deliveryOptions"];

ravelinSDK.trackLogin("login page")
// optionally providing additional parameters:
ravelinSDK.trackLogin("login page", eventProperties: ["p1" : "v1", "p2": "v2"])

NSDictionary *eventProperties = @{
    @"p1" : @"v1",
    @"p2" : @"v2",
    @"p3" : @"v3"
    };

[self.ravelin trackLogin: @"login page" eventProperties: eventProperties];

ravelinSDK.trackLogout("logout page")

[self.ravelin trackLogout: @"logout page"];

ravelinSDK.trackCurrencyChange("currency update", currency: "EUR")

[self.ravelin trackCurrencyChange: @"currency update"];

ravelinSDK.trackLanguageChange("currency update", language: "en-us")

[self.ravelin trackLanguageChange: @"currency update"];

ravelinSDK.trackPaste("user details form", pastedValue: "pasted value")

[self.ravelin trackPaste: @"user details for"];

     func textField(_ textField: UITextField, shouldChangeCharactersIn range: NSRange, replacementString string: String) -> Bool {
             // avoid checking the pasteboard when a user is typing and only adding a single character at a time
            guard string.count > 1 else {
                return true
            }
            guard string.contains(UIPasteboard.general.string ?? "") else {
                return true
            }
            let pageTitle = "home"
            // Send paste event to Ravelin SDK v1
            RavelinSDK.shared.track(pageTitle, eventName: "PASTE", eventProperties: ["pastedValue": string])
            // Send paste event to Ravelin SDK v2
            RavelinSDK.shared.trackPaste(pageTitle, pastedValue: string)
            return true
        }

- (BOOL)textField:(UITextField *)iTextField shouldChangeCharactersInRange:(NSRange)range replacementString:(NSString *)string
{
    // avoid checking the pasteboard when a user is typing and only adding a single character at a time
    if(string.length <= 1) { return YES; }
    // Check if the textfield contains pasted text
    if([string containsString:[UIPasteboard generalPasteboard].string]) {
        NSString *pageTitle = @"home";
        // Send paste event to Ravelin SDK v1
        [self.ravelin track:pageTitle eventName:@"PASTE" eventProperties: @{@"pastedValue": string}];
        // Send paste event to Ravelin SDK v2
        [self.ravelin trackPaste:pageTitle pastedValue:string];
    }

    return YES;
}

let pageTitle = "product page"
let eventName = "SHARE_PRODUCT"
let meta = ["productId" : "213", "sharePlaftorm" : "facebook"]
ravelinSDK.track(pageTitle, eventName: eventName, eventProperties: meta)

NSString *pagetitle = @"product page";
NSString *eventName = @"SHARE_PRODUCT";
NSDictionary *meta = @{@"productId" : @"213", @"sharePlaftorm" : @"facebook"};
[[Ravelin sharedInstance]track:pageTitle eventName:eventName eventProperties:meta];

import UIKit
import RavelinCore

class ViewController: UIViewController {
    
    let ravelinSDK = RavelinSDK.shared
    
    override func viewDidLoad() {
        super.viewDidLoad()
        
        setupRavelinSDK()
    }

    func setupRavelinSDK() {
        // by default, calling `configure` will also send device fingerprint data, avoiding the need to make a subsequent call to `trackFingerprint`
        ravelinSDK.configure(apiKey: "publishable_key_live_----", customerId: "customer012345", appVersion: "1.2.3") { result in
            switch result {
            case .success():
                print("setup success")
            case .failure(let error):
                print("setup error: \(error)")
            }
        }
    }
    
    @IBAction func trackButtonTouched(_ sender: Any) {
        trackLogin()
    }

    func trackLogin() {
        guard ravelinSDK.apiKey != nil else {
            print("trackLogin - apiKey has not been set")
            return
        }
        ravelinSDK.trackLogin("loginPage", eventProperties: nil) {_,_,error in
            if let error {
                print("trackLogin - didFailWithError \(error.localizedDescription)")
                return
            }
        }
    }
}

import UIKit
import RavelinCore

class ViewController: UIViewController {

    // Declare Ravelin Shared Instance with API keys
    private var ravelin = Ravelin.createInstance("publishable_key_live_----")

    override func viewDidLoad() {
        super.viewDidLoad()
        trackFingerprint()
    }

    func trackFingerprint() {
        ravelin.customerId = "customer012345"
        ravelin.trackFingerprint() { _, response, error in
            if let error = error { // handle error
                print("Ravelin error \(error.localizedDescription)")
            } else if let httpResponse = response as? HTTPURLResponse {
                if httpResponse.statusCode == 200 { // handle success
                    ravelin.trackLogin("loginPage")
                    ravelin.orderId = "order-001"
                    ravelin.trackPage("checkout")
                }
            }
        }
    }
}

import UIKit
import RavelinEncrypt

class ViewController: UIViewController {

    private var ravelinEncrypt = RVNEncryption.sharedInstance()

    override func viewDidLoad() {
        super.viewDidLoad()

        // set up ravelin encryption RSA key
        ravelinEncrypt.rsaKey = "----|----"

        // Encrypt customer card details, ready for sending for payment
        var error: NSError? = nil
        let encryptionPayload = ravelinEncrypt.encrypt("41111111111111", month: "10", year: "27", nameOnCard: "Mr John Doe", error: &error)
        if let error = error {
            print("Ravelin encryption error \(error.localizedDescription)")
        } else {
            print("Ravelin Encryption payload: \(encryptionPayload as AnyObject)")
            // Send to server
        }
    }
}

@import RavelinCore;

@interface ViewController ()
@property (strong, nonatomic) Ravelin *ravelin;
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    [self useCore];
}

- (void)useCore {

    // Make Ravelin instance with API keys
    self.ravelin = [Ravelin createInstance:@"publishable_key_live_----"];

    self.ravelin.customerId = @"customer012345";

    // Send a device fingerprint with a completion block
    [self.ravelin trackFingerprint:^(NSData *data, NSURLResponse *response, NSError *error) {
        if(!error) {
            NSDictionary *responseData;
            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *)response;
            if (httpResponse.statusCode == 200) {
                responseData = [NSJSONSerialization JSONObjectWithData:data options:NSJSONReadingMutableContainers|NSJSONReadingAllowFragments error:nil];
                NSLog(@"trackFingerprint - success");
                // track login
                [self.ravelin trackLogin:@"login"];
                self.ravelin.orderId = @"order-001";
                // track customer moving to a new page
                [self.ravelin trackPage:@"checkout"];
                // track logout
                [self.ravelin trackLogout:@"logout"];
            } else {
                // Status was not 200. Handle failure
                NSLog(@"trackFingerprint - failure");
            }
        } else {
            NSLog(@"%@",error.localizedDescription);
        }
    }];
}
@end

@import RavelinEncrypt;

@interface ViewController ()
@property (strong, nonatomic) RVNEncryption *ravelinEncrypt;
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];

    [self useEncrypt];
}

- (void)useEncrypt {
    // Make RavelinEncrypt instance with rsa key
    self.ravelinEncrypt = [RVNEncryption sharedInstance];
    self.ravelinEncrypt.rsaKey = @"----|---------";
    
    // Encrypt customer card details, ready for sending for payment
    NSError *error;
    NSDictionary *encryptionPayload = [self.ravelinEncrypt encrypt:@"41111111111111" month:@"10" year:@"27" nameOnCard:@"Mr John Doe" error:&error];
    if(!error) {
        NSLog(@"Ravelin Encryption payload: %@", encryptionPayload);
    } else {
        NSLog(@"Ravelin encryption error %@", error.localizedDescription);
    }
}

@end

import UIKit
import WebKit
import RavelinCore

extension WKWebView {
    func set(cookie: HTTPCookie, completion: SetCookieResponse? = nil) {
        configuration.websiteDataStore.httpCookieStore.setCookie(cookie, completionHandler: completion)
    }
}

class WebViewController: UIViewController {

    // get a reference to the deviceId from the shared instance which has been configured elsewhere
    private let deviceId = Ravelin.sharedInstance().deviceId
    private var webView: WKWebView!

    private func makeWebView() -> WKWebView {
        let configuration = WKWebViewConfiguration()
        configuration.websiteDataStore = WKWebsiteDataStore.default()
        let webView = WKWebView(frame: .zero, configuration: configuration)
        webView.translatesAutoresizingMaskIntoConstraints = false
        view.addSubview(self.webView)
        // ... complete WebView configuration and layout
        return webView
    }

    private func makeDeviceIdCookie(deviceId: String) -> HTTPCookie? {
        // example cookie
        var properties: [HTTPCookiePropertyKey: Any] = [
            .domain: "your.webite.com",
            .path: "/",
            .name: "ravelinDeviceId",
            .expires: NSDate(timeIntervalSinceNow: yearInterval),
            .value: deviceId]
        if #available(iOS 13.0, *) {
            properties[.sameSitePolicy] = HTTPCookieStringPolicy.sameSiteLax
        }
        return HTTPCookie(properties: properties)
    }

    private func shareDeviceIdWithWebView(deviceId: String, webView: WKWebView) {
        let cookie = makeDeviceIdCookie(deviceId)
        webView.set(cookie: cookie) {
            print("setting cookie: \(cookie)")
        }
    }

    override func viewDidLoad() {
        super.viewDidLoad()

        webView = makeWebView()
        shareDeviceIdWithWebView(deviceId: deviceId, webView: webView)
    }
}

<!-- Privacy manifest file for Ravelin Core SDK for iOS -->
<key>NSPrivacyTracking</key>
<false/>

<!-- Privacy manifest file for Ravelin Core SDK for iOS -->
<key>NSPrivacyTrackingDomains</key>
<array/>

<!-- Privacy manifest file for Ravelin Core SDK for iOS -->
<key>NSPrivacyCollectedDataTypes</key>
  <array>
		<dict>
			<key>NSPrivacyCollectedDataType</key>
			<string>NSPrivacyCollectedDataTypeDeviceID</string>
			<key>NSPrivacyCollectedDataTypeLinked</key>
			<false/>
			<key>NSPrivacyCollectedDataTypeTracking</key>
			<false/>
			<key>NSPrivacyCollectedDataTypePurposes</key>
			<array>
				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
			</array>
		</dict>
		<dict>
			<key>NSPrivacyCollectedDataType</key>
			<string>NSPrivacyCollectedDataTypePreciseLocation</string>
			<key>NSPrivacyCollectedDataTypeLinked</key>
			<false/>
			<key>NSPrivacyCollectedDataTypeTracking</key>
			<false/>
			<key>NSPrivacyCollectedDataTypePurposes</key>
			<array>
				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
			</array>
		</dict>
		<dict>
			<key>NSPrivacyCollectedDataType</key>
			<string>NSPrivacyCollectedDataTypeProductInteraction</string>
			<key>NSPrivacyCollectedDataTypeLinked</key>
			<false/>
			<key>NSPrivacyCollectedDataTypeTracking</key>
			<false/>
			<key>NSPrivacyCollectedDataTypePurposes</key>
			<array>
				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
			</array>
		</dict>
		<dict>
			<key>NSPrivacyCollectedDataType</key>
			<string>NSPrivacyCollectedDataTypeOtherUsageData</string>
			<key>NSPrivacyCollectedDataTypeLinked</key>
			<false/>
			<key>NSPrivacyCollectedDataTypeTracking</key>
			<false/>
			<key>NSPrivacyCollectedDataTypePurposes</key>
			<array>
				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
			</array>
		</dict>
	</array>

<!-- Privacy manifest file for Ravelin Core SDK for iOS -->
<key>NSPrivacyAccessedAPITypes</key>
<array/>

    /// The singleton instance of the class
    public static let shared: RavelinCore.Ravelin

    /// for legacy compatibility
    public static func sharedInstance() -> RavelinCore.Ravelin

    /// get or set the orderId
    public var orderId: String?

    /// get or set customerId
    public var customerId: String?

    /// get or set tempCustomerId
    public var tempCustomerId: String?

    /// get or set customDeviceId
    public var customDeviceId: String?

    /// get or set appVersion
    public var appVersion: String?

    /// get or set logLevel
    public var logLevel: RavelinCore.LogLevel

    /// if set, return customDeviceId or return sdk generated deviceId
    public var deviceId: String? { get }

    /// return the sdk generated sessionId
    public var sessionId: String? { get }

    /// return the public API key from your Ravelin dashboard
    public var apiKey: String? { get }

public typealias RavelinSDK = RavelinCore.Ravelin
public typealias RVNCore = RavelinCore.Ravelin

    /// Configure the singleton instance of the Ravelin sdk with your public key
    /// - Parameters:
    ///   - apiKey: The public API key from your Ravelin dashboard
    ///   - customerId: Set a customerId
    ///   - tempCustomerId: Set a tempCustomerId
    ///   - orderId: Set an orderId
    ///   - customDeviceId: Set a customDeviceId
    ///   - appVersion: Set an appVersion
    ///   - logLevel: Set the logLevel
    ///   - sendFingerprint: Defaults to true to send a fingerprint
    ///   - reset: reset the persisted ID
    ///   - completion: Completion handler for the response
    /// - Remark: Use this method when using RavelinSDK in your app for the first time
    public func configure(apiKey: String, customerId: String?, tempCustomerId: String? = nil, orderId: String? = nil, customDeviceId: String? = nil, appVersion: String? = nil, logLevel: RavelinCore.LogLevel = .error, sendFingerprint: Bool = true, reset: Bool = false, completion: @escaping RavelinCore.TrackResultResponse)

    /// Configure the singleton instance of the Ravelin sdk with your public key
    /// - Parameters:
    ///   - apiKey: The public API key from your Ravelin dashboard
    ///   - customerId: Set a customerId
    ///   - tempCustomerId: Set a tempCustomerId
    ///   - orderId: Set an orderId
    ///   - customDeviceId: Set a customDeviceId
    ///   - appVersion: Set an appVersion
    ///   - logLevel: Set the logLevel
    ///   - sendFingerprint: Defaults to true to send a fingerprint
    ///   - reset: reset the persisted ID
    /// - Remark: Use this method when using RavelinSDK in your app for the first time
    @available(iOS 13.0.0, *)
    public func configure(apiKey: String, customerId: String?, tempCustomerId: String? = nil, orderId: String? = nil, customDeviceId: String? = nil, appVersion: String? = nil, logLevel: RavelinCore.LogLevel = .error, sendFingerprint: Bool = true, reset: Bool = false) async throws

    /// Return the events that have been sent
    /// - Returns: an array of events as json data
    public var eventsData: Data? { get }
    // example usage
       if let eventsData = ravelinSDK.eventsData,
           let jsonString = String(data: eventsData, encoding: .utf8) {
            print("\(jsonString)")
        }

    /// Removes any previously cached sent event data
    public func deleteEventsData()

    /// Configure a singleton instance of the Ravelin sdk with your public key
    /// - Parameters:
    ///   - apiKey: The public API key from your Ravelin dashboard
    /// - Returns: The singleton instance of the class
    /// - Remark: Use this method when using RavelinSDK in your app for the first time
    public class func createInstance(_ apiKey: String) -> RavelinCore.Ravelin

    /// Fingerprints the device and sends results to Ravelin
    /// - Parameters:
    ///   - customerId: The customerId to set for this device fingerprint.
    ///   - completionHandler: Completion handler for the response
    public func trackFingerprint(_ customerId: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Fingerprints the device and sends results to Ravelin
    /// - Parameters:
    ///   - customerId: The customerId to set for this device fingerprint.
    @available(iOS 13.0.0, *)
    public func trackFingerprint(customerId: String?) async throws

    /// Sends a track page event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventProperties: A dictionary of meta data to send with the event
    ///   - completionHandler: Completion handler for the response
    public func trackPage(_ pageTitle: String?, eventProperties: [String : Any]?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track page loaded event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventProperties: A dictionary of meta data to send with the event
    @available(iOS 13.0.0, *)
    public func trackPageLoadedEvent(_ pageTitle: String?, eventProperties: [String : Any]? = nil) async throws

    /// Sends a track search event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - searchValue: The searched term
    ///   - completionHandler: Completion handler for the response
    public func trackSearch(_ pageTitle: String?, searchValue: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track search event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - searchValue: The searched term
    @available(iOS 13.0.0, *)
    public func trackSearchEvent(_ pageTitle: String?, searchValue: String?) async throws

    /// Sends a track select option event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - option: The name of the option
    ///   - optionValue: The value of the option
    ///   - completionHandler: Completion handler for the response
    public func trackSelectOption(_ pageTitle: String?, option: String?, optionValue: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track select option event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - option: The name of the option
    ///   - optionValue: The value of the option
    @available(iOS 13.0.0, *)
    public func trackSelectOptionEvent(_ pageTitle: String?, option: String?, optionValue: String?) async throws

    /// Sends a track add to cart event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName:  Name of the item
    ///   - quantity: Quantity of the item
    ///   - completionHandler: Completion handler for the response
    public func trackAddToCart(_ pageTitle: String?, itemName: String?, quantity: NSNumber?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track add to cart event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName:  Name of the item
    ///   - quantity: Quantity of the item
    @available(iOS 13.0.0, *)
    public func trackAddToCartEvent(_ pageTitle: String?, itemName: String?, quantity: NSNumber?) async throws

    /// Sends a track remove from cart event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName: Name of the item
    ///   - quantity: Quantity of the item
    ///   - completionHandler: Completion handler for the response
    public func trackRemoveFromCart(_ pageTitle: String?, itemName: String?, quantity: NSNumber?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track remove from cart event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName: Name of the item
    ///   - quantity: Quantity of the item
    @available(iOS 13.0.0, *)
    public func trackRemoveFromCartEvent(_ pageTitle: String?, itemName: String?, quantity: NSNumber?) async throws

    /// Sends a track add to wishlist event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName: Name of the item
    ///   - completionHandler: Completion handler for the response
    public func trackAddToWishlist(_ pageTitle: String?, itemName: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track add to wishlist event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName: Name of the item
    @available(iOS 13.0.0, *)
    public func trackAddToWishlistEvent(_ pageTitle: String?, itemName: String?) async throws

    /// Sends a track remove from wishlist event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName: Name of the item
    ///   - completionHandler: Completion handler for the response
    public func trackRemoveFromWishlist(_ pageTitle: String?, itemName: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track remove from wishlist event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - itemName: Name of the item
    @available(iOS 13.0.0, *)
    public func trackRemoveFromWishlistEvent(_ pageTitle: String?, itemName: String?) async throws

    /// Sends a track view content event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - contentType: The type of the content
    ///   - completionHandler: Completion handler for the response
    public func trackViewContent(_ pageTitle: String?, contentType: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track view content event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - contentType: The type of the content
    @available(iOS 13.0.0, *)
    public func trackViewContentEvent(_ pageTitle: String?, contentType: String?) async throws

    /// Sends a track login event to Ravelin and sends customerId automatically if set
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventProperties: A dictionary of meta data to send with the event
    ///   - completionHandler: Completion handler for the response
    public func trackLogin(_ pageTitle: String?, eventProperties: [String : Any]?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track login event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventProperties: A dictionary of meta data to send with the event
    @available(iOS 13.0.0, *)
    public func trackLoginEvent(_ pageTitle: String?, eventProperties: [String : Any]? = nil) async throws

    /// Ends current Ravelin session and sends logout event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventProperties: A dictionary of meta data to send with the event
    ///   - completionHandler: Completion handler for the response
    public func trackLogout(_ pageTitle: String?, eventProperties: [String : Any]?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track logout event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventProperties: A dictionary of meta data to send with the event
    @available(iOS 13.0.0, *)
    public func trackLogoutEvent(_ pageTitle: String?, eventProperties: [String : Any]? = nil) async throws

    /// Sends a track event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventName: The name of the event
    ///   - eventProperties: A dictionary of meta data to send with the event
    ///   - completionHandler: Completion handler for the response
    public func track(_ pageTitle: String?, eventName: String?, eventProperties: [String : Any]?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - eventName: The name of the event
    ///   - eventProperties: A dictionary of meta data to send with the event
    @available(iOS 13.0.0, *)
    public func trackEvent(_ pageTitle: String?, eventName: String?, eventProperties: [String : Any]?) async throws

    /// Sends a track currency change event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - currency: Name of the currency
    ///   - completionHandler: Completion handler for the response
    public func trackCurrencyChange(_ pageTitle: String?, currency: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track currency change event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - currency: Name of the currency
    @available(iOS 13.0.0, *)
    public func trackCurrencyChangeEvent(_ pageTitle: String?, currency: String?) async throws

    /// Sends a track language change event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - language: Name of the language
    ///   - completionHandler: Completion handler for the response
    public func trackLanguageChange(_ pageTitle: String?, language: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track language change event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - language: Name of the language
    @available(iOS 13.0.0, *)
    public func trackLanguageChangeEvent(_ pageTitle: String?, language: String?) async throws

    /// Sends a track paste event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - pastedValue: The pasted vale
    ///   - completionHandler: Completion handler for the response
    public func trackPaste(_ pageTitle: String?, pastedValue: String?, completionHandler: RavelinCore.TrackResponse?)

    /// Sends a track paste event to Ravelin
    /// - Parameters:
    ///   - pageTitle: The title of the current page
    ///   - pastedValue: The pasted vale
    @available(iOS 13.0.0, *)
    public func trackPasteEvent(_ pageTitle: String?, pastedValue: String?) async throws