API Reference

static Future<void> initialize({
  required String apiKey,
  bool debug = false,
})

await Clippr.initialize(
  apiKey: 'YOUR_API_KEY',
  debug: true,
);

static Future<ClipprLink?> getInitialLink()

final link = await Clippr.getInitialLink();
if (link != null) {
  print('App opened with path: ${link.path}');
}

static void Function(ClipprLink link)? onLink

Clippr.onLink = (link) {
  print('Received link: ${link.path}');
};

// Clear the listener
Clippr.onLink = null;

static Future<void> track(
  String eventName, {
  Map<String, dynamic>? params,
})

await Clippr.track('add_to_cart', params: {
  'product_id': '12345',
  'price': 29.99,
});

static Future<void> trackRevenue(
  String eventName, {
  required double revenue,
  required String currency,
  Map<String, dynamic>? params,
})

await Clippr.trackRevenue(
  'purchase',
  revenue: 99.99,
  currency: 'USD',
  params: {'order_id': 'ORDER-123'},
);

static Future<ShortLink> createLink(LinkParameters parameters)

final params = LinkParameters(
  path: '/product/123',
  campaign: 'summer_sale',
);

final shortLink = await Clippr.createLink(params);
print('URL: ${shortLink.url}');

static Future<bool> handle(Uri uri)

final uri = Uri.parse('https://yourapp.clppr.xyz/promo/summer');
final handled = await Clippr.handle(uri);

class ClipprLink {
  final String path;
  final Map<String, dynamic>? metadata;
  final Attribution? attribution;
  final MatchType matchType;
  final double? confidence;
}

class Attribution {
  final String? campaign;
  final String? source;
  final String? medium;
}

enum MatchType {
  direct,
  deterministic,
  probabilistic,
  none,
}

class LinkParameters {
  final String path;
  final Map<String, dynamic>? metadata;
  final String? campaign;
  final String? source;
  final String? medium;
  final String? alias;
  final SocialMetaTags? socialTags;
}

LinkParameters({
  required String path,
  Map<String, dynamic>? metadata,
  String? campaign,
  String? source,
  String? medium,
  String? alias,
  SocialMetaTags? socialTags,
})

class SocialMetaTags {
  final String? title;
  final String? description;
  final String? imageUrl;
}

SocialMetaTags({
  String? title,
  String? description,
  String? imageUrl,
})

class ShortLink {
  final String url;
  final String shortCode;
  final String path;
}

class ClipprException implements Exception {
  final String message;
  final String? code;
}