API Reference

static func initialize(
    apiKey: String,
    debug: Bool = false,
    timeout: TimeInterval = 30
)

// Async
static func getInitialLink() async -> ClipprLink?

// Completion handler
static func getInitialLink(completion: @escaping (ClipprLink?) -> Void)

static var onLink: ((ClipprLink) -> Void)?

// From URL
@discardableResult
static func handleUniversalLink(_ url: URL) -> Bool

// From NSUserActivity
@discardableResult
static func handleUniversalLink(_ userActivity: NSUserActivity) -> Bool

// Async
static func track(_ eventName: String, params: [String: Any]? = nil) async throws

// Completion handler
static func track(_ eventName: String, params: [String: Any]? = nil, completion: ((Error?) -> Void)? = nil)

// Async
static func trackRevenue(
    _ eventName: String,
    revenue: Double,
    currency: String,
    params: [String: Any]? = nil
) async throws

// Completion handler
static func trackRevenue(
    _ eventName: String,
    revenue: Double,
    currency: String,
    params: [String: Any]? = nil,
    completion: ((Error?) -> Void)? = nil
)

// Async
static func createLink(_ parameters: LinkParameters) async throws -> ShortLink

// Completion handler
static func createLink(_ parameters: LinkParameters, completion: @escaping (ShortLink?, Error?) -> Void)

struct ClipprLink: Equatable, Codable {
    let path: String
    let metadata: [String: Any]?
    let attribution: Attribution?
    let matchType: MatchType
    let confidence: Double?
}

struct Attribution: Equatable, Codable {
    let campaign: String?
    let source: String?
    let medium: String?
}

enum MatchType: String, Codable {
    case direct
    case probabilistic
    case none
}

struct LinkParameters {
    var path: String
    var metadata: [String: Any]?
    var campaign: String?
    var source: String?
    var medium: String?
    var alias: String?
    var socialTags: SocialMetaTags?
}

struct SocialMetaTags {
    var title: String?
    var description: String?
    var imageUrl: String?
}

struct ShortLink {
    let url: String
    let shortCode: String
    let path: String
}

enum ClipprError: Error {
    case notInitialized
    case invalidAPIKey
    case aliasAlreadyExists
    case networkError(Error)
    case invalidResponse
    case rateLimited
}