@uptime.app/contracts 1.0.38-rc.1 → 1.0.38-rc.2

package/dist/cjs/index.d.ts

@@ -50,6 +50,8 @@ export * from './pending-hack/pending-hack-with-voice-events';
 export * from './profile/profile';
 export * from './profile/translated-profile';
 export * from './profile/profile-events';
+export * from './referral/referral';
+export * from './referral/referral-events';
 export * from './segment/segment-with-voice';
 export * from './segment/segment-commands';
 export * from './segment/segment';

package/dist/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAE5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,8DAA8D,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAE5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAE3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,8DAA8D,CAAC"}

package/dist/cjs/index.js

@@ -66,6 +66,8 @@ __exportStar(require("./pending-hack/pending-hack-with-voice-events"), exports);
 __exportStar(require("./profile/profile"), exports);
 __exportStar(require("./profile/translated-profile"), exports);
 __exportStar(require("./profile/profile-events"), exports);
+__exportStar(require("./referral/referral"), exports);
+__exportStar(require("./referral/referral-events"), exports);
 __exportStar(require("./segment/segment-with-voice"), exports);
 __exportStar(require("./segment/segment-commands"), exports);
 __exportStar(require("./segment/segment"), exports);

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6EAA2D;AAC3D,uEAAqD;AAErD,2DAAyC;AACzC,+DAA6C;AAC7C,iEAA+C;AAE/C,sEAAoD;AACpD,6EAA2D;AAE3D,6EAA2D;AAC3D,oFAAkE;AAElE,gDAA8B;AAC9B,uDAAqC;AAErC,0DAAwC;AACxC,iEAA+C;AAC/C,mEAAiD;AACjD,0EAAwD;AAExD,qEAAmD;AACnD,mEAAiD;AACjD,yEAAuD;AAEvD,0DAAwC;AACxC,iEAA+C;AAE/C,gFAA8D;AAC9D,uFAAqE;AAErE,gEAA8C;AAC9C,uEAAqD;AAErD,kEAAgD;AAChD,yEAAuD;AAEvD,2DAAyC;AACzC,qDAAmC;AACnC,wDAAsC;AACtC,yDAAuC;AACvC,gEAA8C;AAC9C,8CAA4B;AAC5B,8DAA4C;AAE5C,gEAA8C;AAC9C,uEAAqD;AAErD,oEAAkD;AAClD,2EAAyD;AAEzD,sEAAoD;AACpD,6EAA2D;AAE3D,8DAA4C;AAC5C,iEAA+C;AAC/C,qEAAmD;AACnD,mEAAiD;AAEjD,sEAAoD;AACpD,6EAA2D;AAE3D,8DAA4C;AAC5C,qEAAmD;AACnD,yEAAuD;AACvD,gFAA8D;AAE9D,oDAAkC;AAClC,+DAA6C;AAC7C,2DAAyC;AAEzC,+DAA6C;AAC7C,6DAA2C;AAC3C,oDAAkC;AAClC,2DAAyC;AAEzC,8CAA4B;AAC5B,qDAAmC;AAEnC,0EAAwD;AACxD,yEAAuD;AACvD,oEAAkD;AAClD,gEAA8C;AAE9C,gDAA8B;AAC9B,uDAAqC;AAErC,mEAAiD;AACjD,4DAA0C;AAE1C,4DAA0C;AAC1C,6DAA2C;AAE3C,8DAA4C;AAC5C,qEAAmD;AAEnD,wFAAsE;AACtE,+FAA6E"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6EAA2D;AAC3D,uEAAqD;AAErD,2DAAyC;AACzC,+DAA6C;AAC7C,iEAA+C;AAE/C,sEAAoD;AACpD,6EAA2D;AAE3D,6EAA2D;AAC3D,oFAAkE;AAElE,gDAA8B;AAC9B,uDAAqC;AAErC,0DAAwC;AACxC,iEAA+C;AAC/C,mEAAiD;AACjD,0EAAwD;AAExD,qEAAmD;AACnD,mEAAiD;AACjD,yEAAuD;AAEvD,0DAAwC;AACxC,iEAA+C;AAE/C,gFAA8D;AAC9D,uFAAqE;AAErE,gEAA8C;AAC9C,uEAAqD;AAErD,kEAAgD;AAChD,yEAAuD;AAEvD,2DAAyC;AACzC,qDAAmC;AACnC,wDAAsC;AACtC,yDAAuC;AACvC,gEAA8C;AAC9C,8CAA4B;AAC5B,8DAA4C;AAE5C,gEAA8C;AAC9C,uEAAqD;AAErD,oEAAkD;AAClD,2EAAyD;AAEzD,sEAAoD;AACpD,6EAA2D;AAE3D,8DAA4C;AAC5C,iEAA+C;AAC/C,qEAAmD;AACnD,mEAAiD;AAEjD,sEAAoD;AACpD,6EAA2D;AAE3D,8DAA4C;AAC5C,qEAAmD;AACnD,yEAAuD;AACvD,gFAA8D;AAE9D,oDAAkC;AAClC,+DAA6C;AAC7C,2DAAyC;AAEzC,sDAAoC;AACpC,6DAA2C;AAE3C,+DAA6C;AAC7C,6DAA2C;AAC3C,oDAAkC;AAClC,2DAAyC;AAEzC,8CAA4B;AAC5B,qDAAmC;AAEnC,0EAAwD;AACxD,yEAAuD;AACvD,oEAAkD;AAClD,gEAA8C;AAE9C,gDAA8B;AAC9B,uDAAqC;AAErC,mEAAiD;AACjD,4DAA0C;AAE1C,4DAA0C;AAC1C,6DAA2C;AAE3C,8DAA4C;AAC5C,qEAAmD;AAEnD,wFAAsE;AACtE,+FAA6E"}

package/dist/cjs/referral/referral-events.d.ts

@@ -0,0 +1,34 @@
+import { ReferralCredit, ReferralLink } from './referral';
+export interface ReferralCreditCreatedEvent {
+    id: string;
+    type: 'ReferralCreditCreated';
+    payload: ReferralCredit;
+}
+export interface ReferralCreditUpdatedEvent {
+    id: string;
+    type: 'ReferralCreditUpdated';
+    payload: ReferralCredit;
+}
+export interface ReferralCreditDeletedEvent {
+    id: string;
+    type: 'ReferralCreditDeleted';
+    payload: ReferralCredit;
+}
+export type ReferralCreditChangedEvent = ReferralCreditCreatedEvent | ReferralCreditUpdatedEvent | ReferralCreditDeletedEvent;
+export interface ReferralLinkCreatedEvent {
+    id: string;
+    type: 'ReferralLinkCreated';
+    payload: ReferralLink;
+}
+export interface ReferralLinkUpdatedEvent {
+    id: string;
+    type: 'ReferralLinkUpdated';
+    payload: ReferralLink;
+}
+export interface ReferralLinkDeletedEvent {
+    id: string;
+    type: 'ReferralLinkDeleted';
+    payload: ReferralLink;
+}
+export type ReferralLinkChangedEvent = ReferralLinkCreatedEvent | ReferralLinkUpdatedEvent | ReferralLinkDeletedEvent;
+//# sourceMappingURL=referral-events.d.ts.map

package/dist/cjs/referral/referral-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral-events.d.ts","sourceRoot":"","sources":["../../../src/referral/referral-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAE9H,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,GAAG,wBAAwB,GAAG,wBAAwB,CAAC"}

package/dist/cjs/referral/referral-events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=referral-events.js.map

package/dist/cjs/referral/referral-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral-events.js","sourceRoot":"","sources":["../../../src/referral/referral-events.ts"],"names":[],"mappings":""}

package/dist/cjs/referral/referral.d.ts

@@ -0,0 +1,69 @@
+export interface ReferredUserPurchase {
+    /** The price the referred user paid in their currency */
+    price: number;
+    /** The currency the referred user paid in */
+    currency: string;
+    /** The price they paid in United States Dollars (USD) */
+    priceInUSD: number;
+    /** The RevenueCat transaction ID */
+    transactionId: string;
+    /** The RevenueCat original transaction ID */
+    originalTransactionId: string;
+}
+export interface ReferralCredit {
+    /** The unique identifier of a referral credit */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who shared the referral link */
+    referrerUserId: string;
+    /** If the referrer is a creator, this contains their creator ID */
+    referrerCreatorId?: string;
+    /** If the referrer is a partner of Uptime, this contains their partner ID */
+    referrerPartnerId?: string;
+    /** The unique device ID of the user who shared the referral link */
+    referrerUniqueDeviceId?: string;
+    /** The purchase the referred user made (if applicable) */
+    referredUserPurchase?: ReferredUserPurchase;
+    /** The ID of the user who clicked on the referral link and triggered the referral */
+    referredUserId?: string;
+    /** The unique device ID of the user who clicked on the referral link and triggered the referral */
+    referredUserUniqueDeviceId?: string;
+    /** The ISO 8601 UTC timestamp of the successful referral event */
+    eventTimestamp: string;
+    /** The source of the successful referral event e.g. Branch */
+    eventSource: string;
+    /** The action that triggered the successful referral event e.g. a user sign-up  */
+    eventTrigger: string;
+}
+export interface ReferralLink {
+    /** The unique identifier of a referral link */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who will share the link and be credited if it is used */
+    referrerUserId: string;
+    /** The URL of the referral deep link */
+    url: string;
+    /** The source of the referral link e.g. Branch */
+    source: string;
+    /** The action that triggers a successful referral e.g. a user sign-up  */
+    trigger: string;
+}
+export declare enum ReferralEventSource {
+    Branch = "branch",
+    RevenueCat = "revenue-cat"
+}
+export declare enum ReferralEventTrigger {
+    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
+    SignUp = "sign-up",
+    /** A user clicks on a deep link and starts a trial during that session. */
+    TrialStarted = "trial-started",
+    /** A trial-started referred user converts to premium during their trial. */
+    TrialConverted = "trial-converted",
+    /** A user clicks a on deep link and pays for premium during that session. */
+    PaidSubscription = "paid-subscription"
+}
+//# sourceMappingURL=referral.d.ts.map

package/dist/cjs/referral/referral.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../../src/referral/referral.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACjC,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,qBAAqB,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC3B,iDAAiD;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,cAAc,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oEAAoE;IACpE,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,qFAAqF;IACrF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mGAAmG;IACnG,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,kEAAkE;IAClE,cAAc,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IACzB,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,cAAc,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,mBAAmB;IAC3B,MAAM,WAAW;IACjB,UAAU,gBAAgB;CAC7B;AAMD,oBAAY,oBAAoB;IAC5B,gFAAgF;IAChF,MAAM,YAAY;IAClB,2EAA2E;IAC3E,YAAY,kBAAkB;IAC9B,4EAA4E;IAC5E,cAAc,oBAAoB;IAClC,6EAA6E;IAC7E,gBAAgB,sBAAsB;CACzC"}

package/dist/cjs/referral/referral.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralEventTrigger = exports.ReferralEventSource = void 0;
+var ReferralEventSource;
+(function (ReferralEventSource) {
+    ReferralEventSource["Branch"] = "branch";
+    ReferralEventSource["RevenueCat"] = "revenue-cat";
+})(ReferralEventSource || (exports.ReferralEventSource = ReferralEventSource = {}));
+/* None of these events are mututally exlusive. For example, a single premium payment could
+ * yield both a 'trial-converted' and a 'paid-subscription' referral credit, and it's possible
+ * they could be attributed to different referrers, so we need to track both.
+ */
+var ReferralEventTrigger;
+(function (ReferralEventTrigger) {
+    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
+    ReferralEventTrigger["SignUp"] = "sign-up";
+    /** A user clicks on a deep link and starts a trial during that session. */
+    ReferralEventTrigger["TrialStarted"] = "trial-started";
+    /** A trial-started referred user converts to premium during their trial. */
+    ReferralEventTrigger["TrialConverted"] = "trial-converted";
+    /** A user clicks a on deep link and pays for premium during that session. */
+    ReferralEventTrigger["PaidSubscription"] = "paid-subscription";
+})(ReferralEventTrigger || (exports.ReferralEventTrigger = ReferralEventTrigger = {}));
+//# sourceMappingURL=referral.js.map

package/dist/cjs/referral/referral.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral.js","sourceRoot":"","sources":["../../../src/referral/referral.ts"],"names":[],"mappings":";;;AAyDA,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,wCAAiB,CAAA;IACjB,iDAA0B,CAAA;AAC9B,CAAC,EAHW,mBAAmB,mCAAnB,mBAAmB,QAG9B;AAED;;;GAGG;AACH,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC5B,gFAAgF;IAChF,0CAAkB,CAAA;IAClB,2EAA2E;IAC3E,sDAA8B,CAAA;IAC9B,4EAA4E;IAC5E,0DAAkC,CAAA;IAClC,6EAA6E;IAC7E,8DAAsC,CAAA;AAC1C,CAAC,EATW,oBAAoB,oCAApB,oBAAoB,QAS/B"}

package/dist/esm/index.d.ts

@@ -50,6 +50,8 @@ export * from './pending-hack/pending-hack-with-voice-events';
 export * from './profile/profile';
 export * from './profile/translated-profile';
 export * from './profile/profile-events';
+export * from './referral/referral';
+export * from './referral/referral-events';
 export * from './segment/segment-with-voice';
 export * from './segment/segment-commands';
 export * from './segment/segment';

package/dist/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAE5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,8DAA8D,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAE5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAE3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,8DAA8D,CAAC"}

package/dist/esm/index.js

@@ -50,6 +50,8 @@ export * from './pending-hack/pending-hack-with-voice-events';
 export * from './profile/profile';
 export * from './profile/translated-profile';
 export * from './profile/profile-events';
+export * from './referral/referral';
+export * from './referral/referral-events';
 export * from './segment/segment-with-voice';
 export * from './segment/segment-commands';
 export * from './segment/segment';

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAE5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,8DAA8D,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4CAA4C,CAAC;AAC3D,cAAc,sCAAsC,CAAC;AAErD,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAE/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,mDAAmD,CAAC;AAElE,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,yCAAyC,CAAC;AAExD,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AACjD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAE/C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sDAAsD,CAAC;AAErE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,iCAAiC,CAAC;AAChD,cAAc,wCAAwC,CAAC;AAEvD,cAAc,0BAA0B,CAAC;AACzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,wBAAwB,CAAC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,aAAa,CAAC;AAC5B,cAAc,6BAA6B,CAAC;AAE5C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AAErD,cAAc,mCAAmC,CAAC;AAClD,cAAc,0CAA0C,CAAC;AAEzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAE3D,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAE9D,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,0BAA0B,CAAC;AAEzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,4BAA4B,CAAC;AAE3C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AAEnC,cAAc,yCAAyC,CAAC;AACxD,cAAc,wCAAwC,CAAC;AACvD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAE9C,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AAErC,cAAc,kCAAkC,CAAC;AACjD,cAAc,2BAA2B,CAAC;AAE1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uDAAuD,CAAC;AACtE,cAAc,8DAA8D,CAAC"}

package/dist/esm/referral/referral-events.d.ts

@@ -0,0 +1,34 @@
+import { ReferralCredit, ReferralLink } from './referral';
+export interface ReferralCreditCreatedEvent {
+    id: string;
+    type: 'ReferralCreditCreated';
+    payload: ReferralCredit;
+}
+export interface ReferralCreditUpdatedEvent {
+    id: string;
+    type: 'ReferralCreditUpdated';
+    payload: ReferralCredit;
+}
+export interface ReferralCreditDeletedEvent {
+    id: string;
+    type: 'ReferralCreditDeleted';
+    payload: ReferralCredit;
+}
+export type ReferralCreditChangedEvent = ReferralCreditCreatedEvent | ReferralCreditUpdatedEvent | ReferralCreditDeletedEvent;
+export interface ReferralLinkCreatedEvent {
+    id: string;
+    type: 'ReferralLinkCreated';
+    payload: ReferralLink;
+}
+export interface ReferralLinkUpdatedEvent {
+    id: string;
+    type: 'ReferralLinkUpdated';
+    payload: ReferralLink;
+}
+export interface ReferralLinkDeletedEvent {
+    id: string;
+    type: 'ReferralLinkDeleted';
+    payload: ReferralLink;
+}
+export type ReferralLinkChangedEvent = ReferralLinkCreatedEvent | ReferralLinkUpdatedEvent | ReferralLinkDeletedEvent;
+//# sourceMappingURL=referral-events.d.ts.map

package/dist/esm/referral/referral-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral-events.d.ts","sourceRoot":"","sources":["../../../src/referral/referral-events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1D,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,WAAW,0BAA0B;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,uBAAuB,CAAC;IAC9B,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,MAAM,0BAA0B,GAAG,0BAA0B,GAAG,0BAA0B,GAAG,0BAA0B,CAAC;AAE9H,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,WAAW,wBAAwB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,qBAAqB,CAAC;IAC5B,OAAO,EAAE,YAAY,CAAC;CACzB;AAED,MAAM,MAAM,wBAAwB,GAAG,wBAAwB,GAAG,wBAAwB,GAAG,wBAAwB,CAAC"}

package/dist/esm/referral/referral-events.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=referral-events.js.map

package/dist/esm/referral/referral-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral-events.js","sourceRoot":"","sources":["../../../src/referral/referral-events.ts"],"names":[],"mappings":""}

package/dist/esm/referral/referral.d.ts

@@ -0,0 +1,69 @@
+export interface ReferredUserPurchase {
+    /** The price the referred user paid in their currency */
+    price: number;
+    /** The currency the referred user paid in */
+    currency: string;
+    /** The price they paid in United States Dollars (USD) */
+    priceInUSD: number;
+    /** The RevenueCat transaction ID */
+    transactionId: string;
+    /** The RevenueCat original transaction ID */
+    originalTransactionId: string;
+}
+export interface ReferralCredit {
+    /** The unique identifier of a referral credit */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who shared the referral link */
+    referrerUserId: string;
+    /** If the referrer is a creator, this contains their creator ID */
+    referrerCreatorId?: string;
+    /** If the referrer is a partner of Uptime, this contains their partner ID */
+    referrerPartnerId?: string;
+    /** The unique device ID of the user who shared the referral link */
+    referrerUniqueDeviceId?: string;
+    /** The purchase the referred user made (if applicable) */
+    referredUserPurchase?: ReferredUserPurchase;
+    /** The ID of the user who clicked on the referral link and triggered the referral */
+    referredUserId?: string;
+    /** The unique device ID of the user who clicked on the referral link and triggered the referral */
+    referredUserUniqueDeviceId?: string;
+    /** The ISO 8601 UTC timestamp of the successful referral event */
+    eventTimestamp: string;
+    /** The source of the successful referral event e.g. Branch */
+    eventSource: string;
+    /** The action that triggered the successful referral event e.g. a user sign-up  */
+    eventTrigger: string;
+}
+export interface ReferralLink {
+    /** The unique identifier of a referral link */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who will share the link and be credited if it is used */
+    referrerUserId: string;
+    /** The URL of the referral deep link */
+    url: string;
+    /** The source of the referral link e.g. Branch */
+    source: string;
+    /** The action that triggers a successful referral e.g. a user sign-up  */
+    trigger: string;
+}
+export declare enum ReferralEventSource {
+    Branch = "branch",
+    RevenueCat = "revenue-cat"
+}
+export declare enum ReferralEventTrigger {
+    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
+    SignUp = "sign-up",
+    /** A user clicks on a deep link and starts a trial during that session. */
+    TrialStarted = "trial-started",
+    /** A trial-started referred user converts to premium during their trial. */
+    TrialConverted = "trial-converted",
+    /** A user clicks a on deep link and pays for premium during that session. */
+    PaidSubscription = "paid-subscription"
+}
+//# sourceMappingURL=referral.d.ts.map

package/dist/esm/referral/referral.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral.d.ts","sourceRoot":"","sources":["../../../src/referral/referral.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACjC,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,UAAU,EAAE,MAAM,CAAC;IACnB,oCAAoC;IACpC,aAAa,EAAE,MAAM,CAAC;IACtB,6CAA6C;IAC7C,qBAAqB,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC3B,iDAAiD;IACjD,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,cAAc,EAAE,MAAM,CAAC;IACvB,mEAAmE;IACnE,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oEAAoE;IACpE,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,0DAA0D;IAC1D,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,qFAAqF;IACrF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mGAAmG;IACnG,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,kEAAkE;IAClE,cAAc,EAAE,MAAM,CAAC;IACvB,8DAA8D;IAC9D,WAAW,EAAE,MAAM,CAAC;IACpB,mFAAmF;IACnF,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IACzB,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,CAAC,EAAE,MAAM,CAAC;IACV,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,cAAc,EAAE,MAAM,CAAC;IACvB,wCAAwC;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,oBAAY,mBAAmB;IAC3B,MAAM,WAAW;IACjB,UAAU,gBAAgB;CAC7B;AAMD,oBAAY,oBAAoB;IAC5B,gFAAgF;IAChF,MAAM,YAAY;IAClB,2EAA2E;IAC3E,YAAY,kBAAkB;IAC9B,4EAA4E;IAC5E,cAAc,oBAAoB;IAClC,6EAA6E;IAC7E,gBAAgB,sBAAsB;CACzC"}

package/dist/esm/referral/referral.js

@@ -0,0 +1,21 @@
+export var ReferralEventSource;
+(function (ReferralEventSource) {
+    ReferralEventSource["Branch"] = "branch";
+    ReferralEventSource["RevenueCat"] = "revenue-cat";
+})(ReferralEventSource || (ReferralEventSource = {}));
+/* None of these events are mututally exlusive. For example, a single premium payment could
+ * yield both a 'trial-converted' and a 'paid-subscription' referral credit, and it's possible
+ * they could be attributed to different referrers, so we need to track both.
+ */
+export var ReferralEventTrigger;
+(function (ReferralEventTrigger) {
+    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
+    ReferralEventTrigger["SignUp"] = "sign-up";
+    /** A user clicks on a deep link and starts a trial during that session. */
+    ReferralEventTrigger["TrialStarted"] = "trial-started";
+    /** A trial-started referred user converts to premium during their trial. */
+    ReferralEventTrigger["TrialConverted"] = "trial-converted";
+    /** A user clicks a on deep link and pays for premium during that session. */
+    ReferralEventTrigger["PaidSubscription"] = "paid-subscription";
+})(ReferralEventTrigger || (ReferralEventTrigger = {}));
+//# sourceMappingURL=referral.js.map

package/dist/esm/referral/referral.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referral.js","sourceRoot":"","sources":["../../../src/referral/referral.ts"],"names":[],"mappings":"AAyDA,MAAM,CAAN,IAAY,mBAGX;AAHD,WAAY,mBAAmB;IAC3B,wCAAiB,CAAA;IACjB,iDAA0B,CAAA;AAC9B,CAAC,EAHW,mBAAmB,KAAnB,mBAAmB,QAG9B;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,oBASX;AATD,WAAY,oBAAoB;IAC5B,gFAAgF;IAChF,0CAAkB,CAAA;IAClB,2EAA2E;IAC3E,sDAA8B,CAAA;IAC9B,4EAA4E;IAC5E,0DAAkC,CAAA;IAClC,6EAA6E;IAC7E,8DAAsC,CAAA;AAC1C,CAAC,EATW,oBAAoB,KAApB,oBAAoB,QAS/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.app/contracts",
-  "version": "1.0.38-rc.1",
+  "version": "1.0.38-rc.2",
   "license": "MIT",
   "types": "./dist/esm/index.d.ts",
   "main": "./dist/cjs/index.js",
@@ -13,5 +13,5 @@
   "devDependencies": {
     "typescript": "^5.4.3"
   },
-  "gitHead": "7b23bd3bd11600479311f7cbd1702da22bb9cfc9"
+  "gitHead": "d634c3e2b8a8e971a2aa85fc96ef20c7f71d7443"
 }

package/src/index.ts

@@ -69,6 +69,9 @@ export * from './profile/profile';
 export * from './profile/translated-profile';
 export * from './profile/profile-events';
 
+export * from './referral/referral';
+export * from './referral/referral-events';
+
 export * from './segment/segment-with-voice';
 export * from './segment/segment-commands';
 export * from './segment/segment';

package/src/referral/referral-events.ts

@@ -0,0 +1,41 @@
+import { ReferralCredit, ReferralLink } from './referral';
+
+export interface ReferralCreditCreatedEvent {
+    id: string;
+    type: 'ReferralCreditCreated';
+    payload: ReferralCredit;
+}
+
+export interface ReferralCreditUpdatedEvent {
+    id: string;
+    type: 'ReferralCreditUpdated';
+    payload: ReferralCredit;
+}
+
+export interface ReferralCreditDeletedEvent {
+    id: string;
+    type: 'ReferralCreditDeleted';
+    payload: ReferralCredit;
+}
+
+export type ReferralCreditChangedEvent = ReferralCreditCreatedEvent | ReferralCreditUpdatedEvent | ReferralCreditDeletedEvent;
+
+export interface ReferralLinkCreatedEvent {
+    id: string;
+    type: 'ReferralLinkCreated';
+    payload: ReferralLink;
+}
+
+export interface ReferralLinkUpdatedEvent {
+    id: string;
+    type: 'ReferralLinkUpdated';
+    payload: ReferralLink;
+}
+
+export interface ReferralLinkDeletedEvent {
+    id: string;
+    type: 'ReferralLinkDeleted';
+    payload: ReferralLink;
+}
+
+export type ReferralLinkChangedEvent = ReferralLinkCreatedEvent | ReferralLinkUpdatedEvent | ReferralLinkDeletedEvent;

package/src/referral/referral.ts

@@ -0,0 +1,76 @@
+export interface ReferredUserPurchase {
+    /** The price the referred user paid in their currency */
+    price: number;
+    /** The currency the referred user paid in */
+    currency: string;
+    /** The price they paid in United States Dollars (USD) */
+    priceInUSD: number;
+    /** The RevenueCat transaction ID */
+    transactionId: string;
+    /** The RevenueCat original transaction ID */
+    originalTransactionId: string;
+}
+
+export interface ReferralCredit {
+    /** The unique identifier of a referral credit */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who shared the referral link */
+    referrerUserId: string;
+    /** If the referrer is a creator, this contains their creator ID */
+    referrerCreatorId?: string;
+    /** If the referrer is a partner of Uptime, this contains their partner ID */
+    referrerPartnerId?: string;
+    /** The unique device ID of the user who shared the referral link */
+    referrerUniqueDeviceId?: string;
+    /** The purchase the referred user made (if applicable) */
+    referredUserPurchase?: ReferredUserPurchase;
+    /** The ID of the user who clicked on the referral link and triggered the referral */
+    referredUserId?: string;
+    /** The unique device ID of the user who clicked on the referral link and triggered the referral */
+    referredUserUniqueDeviceId?: string;
+    /** The ISO 8601 UTC timestamp of the successful referral event */
+    eventTimestamp: string;
+    /** The source of the successful referral event e.g. Branch */
+    eventSource: string;
+    /** The action that triggered the successful referral event e.g. a user sign-up  */
+    eventTrigger: string;
+}
+
+export interface ReferralLink {
+    /** The unique identifier of a referral link */
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    /** The ID of the user who will share the link and be credited if it is used */
+    referrerUserId: string;
+    /** The URL of the referral deep link */
+    url: string;
+    /** The source of the referral link e.g. Branch */
+    source: string;
+    /** The action that triggers a successful referral e.g. a user sign-up  */
+    trigger: string;
+}
+
+export enum ReferralEventSource {
+    Branch = 'branch',
+    RevenueCat = 'revenue-cat'
+}
+
+/* None of these events are mututally exlusive. For example, a single premium payment could 
+ * yield both a 'trial-converted' and a 'paid-subscription' referral credit, and it's possible
+ * they could be attributed to different referrers, so we need to track both.
+ */
+export enum ReferralEventTrigger {
+    /** A new user clicks on a deep link, downloads the Uptime app and registers. */
+    SignUp = 'sign-up',
+    /** A user clicks on a deep link and starts a trial during that session. */
+    TrialStarted = 'trial-started',
+    /** A trial-started referred user converts to premium during their trial. */
+    TrialConverted = 'trial-converted',
+    /** A user clicks a on deep link and pays for premium during that session. */
+    PaidSubscription = 'paid-subscription'
+}