{
  "api": {
    "name": "LinkrunnerPlugin",
    "slug": "linkrunnerplugin",
    "docs": "Main Linkrunner plugin interface",
    "tags": [],
    "methods": [
      {
        "name": "init",
        "signature": "(options: InitOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Initialization options including token and optional parameters",
            "type": "InitOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Initialization options including token and optional parameters"
          }
        ],
        "docs": "Initialize the Linkrunner SDK",
        "complexTypes": [
          "InitOptions"
        ],
        "slug": "init"
      },
      {
        "name": "signup",
        "signature": "(options: SignupOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Signup options including user data and optional additional data",
            "type": "SignupOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Signup options including user data and optional additional data"
          }
        ],
        "docs": "Register a new user signup",
        "complexTypes": [
          "SignupOptions"
        ],
        "slug": "signup"
      },
      {
        "name": "setUserData",
        "signature": "(options: SetUserDataOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "User data to update",
            "type": "SetUserDataOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options User data to update"
          }
        ],
        "docs": "Update user data",
        "complexTypes": [
          "SetUserDataOptions"
        ],
        "slug": "setuserdata"
      },
      {
        "name": "capturePayment",
        "signature": "(options: CapturePaymentOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Payment details including user ID, amount, type, and status",
            "type": "CapturePaymentOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Payment details including user ID, amount, type, and status"
          }
        ],
        "docs": "Capture a payment event",
        "complexTypes": [
          "CapturePaymentOptions"
        ],
        "slug": "capturepayment"
      },
      {
        "name": "removePayment",
        "signature": "(options: RemovePaymentOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Payment removal details including user ID and optional payment ID",
            "type": "RemovePaymentOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Payment removal details including user ID and optional payment ID"
          }
        ],
        "docs": "Remove or refund a payment",
        "complexTypes": [
          "RemovePaymentOptions"
        ],
        "slug": "removepayment"
      },
      {
        "name": "trackEvent",
        "signature": "(options: TrackEventOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Event details including name, data, and optional ID",
            "type": "TrackEventOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Event details including name, data, and optional ID"
          }
        ],
        "docs": "Track a custom event",
        "complexTypes": [
          "TrackEventOptions"
        ],
        "slug": "trackevent"
      },
      {
        "name": "getAttributionData",
        "signature": "() => Promise<AttributionDataResult>",
        "parameters": [],
        "returns": "Promise<AttributionDataResult>",
        "tags": [
          {
            "name": "returns",
            "text": "Attribution data including campaign information and deeplink"
          }
        ],
        "docs": "Retrieve attribution data",
        "complexTypes": [
          "AttributionDataResult"
        ],
        "slug": "getattributiondata"
      },
      {
        "name": "setAdditionalData",
        "signature": "(options: SetAdditionalDataOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Integration data including platform identifiers",
            "type": "SetAdditionalDataOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Integration data including platform identifiers"
          }
        ],
        "docs": "Set additional integration data for third-party platforms",
        "complexTypes": [
          "SetAdditionalDataOptions"
        ],
        "slug": "setadditionaldata"
      },
      {
        "name": "enablePIIHashing",
        "signature": "(options: EnablePIIHashingOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Options to enable or disable PII hashing",
            "type": "EnablePIIHashingOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Options to enable or disable PII hashing"
          }
        ],
        "docs": "Enable or disable PII hashing",
        "complexTypes": [
          "EnablePIIHashingOptions"
        ],
        "slug": "enablepiihashing"
      },
      {
        "name": "setPushToken",
        "signature": "(options: SetPushTokenOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Options containing the push token",
            "type": "SetPushTokenOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Options containing the push token"
          }
        ],
        "docs": "Set the push notification token for the device",
        "complexTypes": [
          "SetPushTokenOptions"
        ],
        "slug": "setpushtoken"
      },
      {
        "name": "setCustomerUserId",
        "signature": "(options: SetCustomerUserIdOptions) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "Options containing the customer user ID",
            "type": "SetCustomerUserIdOptions"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options Options containing the customer user ID"
          }
        ],
        "docs": "Set the customer user ID",
        "complexTypes": [
          "SetCustomerUserIdOptions"
        ],
        "slug": "setcustomeruserid"
      },
      {
        "name": "handleDeeplink",
        "signature": "(options: HandleDeeplinkOptions) => Promise<HandleDeeplinkResult>",
        "parameters": [
          {
            "name": "options",
            "docs": "Options containing the deeplink URL",
            "type": "HandleDeeplinkOptions"
          }
        ],
        "returns": "Promise<HandleDeeplinkResult>",
        "tags": [
          {
            "name": "param",
            "text": "options Options containing the deeplink URL"
          },
          {
            "name": "returns",
            "text": "Deeplink data wrapped in a result object"
          }
        ],
        "docs": "Handle a deeplink for re-engagement attribution",
        "complexTypes": [
          "HandleDeeplinkResult",
          "HandleDeeplinkOptions"
        ],
        "slug": "handledeeplink"
      },
      {
        "name": "getPackageVersion",
        "signature": "() => Promise<{ version: string; }>",
        "parameters": [],
        "returns": "Promise<{ version: string; }>",
        "tags": [
          {
            "name": "returns",
            "text": "Object containing the version string"
          }
        ],
        "docs": "Get the SDK package version",
        "complexTypes": [],
        "slug": "getpackageversion"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "InitOptions",
      "slug": "initoptions",
      "docs": "Options for SDK initialization",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "token",
          "tags": [],
          "docs": "Required authentication token",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "secretKey",
          "tags": [],
          "docs": "Optional secret key for request signing",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "keyId",
          "tags": [],
          "docs": "Optional key ID for request signing",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "disableIdfa",
          "tags": [],
          "docs": "Optional flag to disable IDFA collection on iOS",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "debug",
          "tags": [],
          "docs": "Optional flag to enable debug logging",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "packageVersion",
          "tags": [],
          "docs": "SDK package version",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "SignupOptions",
      "slug": "signupoptions",
      "docs": "Options for user signup",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "userData",
          "tags": [],
          "docs": "Required user data",
          "complexTypes": [
            "UserData"
          ],
          "type": "UserData"
        },
        {
          "name": "data",
          "tags": [],
          "docs": "Optional additional data",
          "complexTypes": [
            "Record"
          ],
          "type": "Record<string, any>"
        }
      ]
    },
    {
      "name": "UserData",
      "slug": "userdata",
      "docs": "User data interface for Linkrunner SDK",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "id",
          "tags": [],
          "docs": "Required user identifier",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "name",
          "tags": [],
          "docs": "Optional user name",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "phone",
          "tags": [],
          "docs": "Optional user phone number",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "email",
          "tags": [],
          "docs": "Optional user email address",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "user_created_at",
          "tags": [],
          "docs": "Optional user creation timestamp",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "is_first_time_user",
          "tags": [],
          "docs": "Optional flag indicating if this is a first-time user",
          "complexTypes": [],
          "type": "boolean | undefined"
        },
        {
          "name": "mixpanel_distinct_id",
          "tags": [],
          "docs": "Optional Mixpanel distinct ID",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "amplitude_device_id",
          "tags": [],
          "docs": "Optional Amplitude device ID",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "posthog_distinct_id",
          "tags": [],
          "docs": "Optional PostHog distinct ID",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "braze_device_id",
          "tags": [],
          "docs": "Optional Braze device ID",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "ga_app_instance_id",
          "tags": [],
          "docs": "Optional Google Analytics app instance ID",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "ga_session_id",
          "tags": [],
          "docs": "Optional Google Analytics session ID",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "netcore_device_guid",
          "tags": [],
          "docs": "Optional Netcore device GUID",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "SetUserDataOptions",
      "slug": "setuserdataoptions",
      "docs": "Options for setting user data",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "userData",
          "tags": [],
          "docs": "Required user data",
          "complexTypes": [
            "UserData"
          ],
          "type": "UserData"
        }
      ]
    },
    {
      "name": "CapturePaymentOptions",
      "slug": "capturepaymentoptions",
      "docs": "Options for capturing payment",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "paymentId",
          "tags": [],
          "docs": "Optional payment identifier",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "userId",
          "tags": [],
          "docs": "Required user identifier; pass \"\" to fall back to the stored signup user_id",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "amount",
          "tags": [],
          "docs": "Required payment amount",
          "complexTypes": [],
          "type": "number"
        },
        {
          "name": "type",
          "tags": [],
          "docs": "Optional payment type (defaults to 'DEFAULT')",
          "complexTypes": [
            "PaymentType"
          ],
          "type": "PaymentType"
        },
        {
          "name": "status",
          "tags": [],
          "docs": "Optional payment status (defaults to 'PAYMENT_COMPLETED')",
          "complexTypes": [
            "PaymentStatus"
          ],
          "type": "PaymentStatus"
        }
      ]
    },
    {
      "name": "RemovePaymentOptions",
      "slug": "removepaymentoptions",
      "docs": "Options for removing payment",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "paymentId",
          "tags": [],
          "docs": "Optional payment identifier",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "userId",
          "tags": [],
          "docs": "Required user identifier",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "TrackEventOptions",
      "slug": "trackeventoptions",
      "docs": "Options for tracking events",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "eventName",
          "tags": [],
          "docs": "Required event name",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "eventData",
          "tags": [],
          "docs": "Optional event data",
          "complexTypes": [
            "Record"
          ],
          "type": "Record<string, any>"
        },
        {
          "name": "eventId",
          "tags": [],
          "docs": "Optional event identifier (string or number)",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "AttributionDataResult",
      "slug": "attributiondataresult",
      "docs": "Result from getAttributionData",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "data",
          "tags": [],
          "docs": "Attribution data",
          "complexTypes": [
            "AttributionData"
          ],
          "type": "AttributionData"
        }
      ]
    },
    {
      "name": "AttributionData",
      "slug": "attributiondata",
      "docs": "Attribution data returned from the SDK",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "deeplink",
          "tags": [],
          "docs": "Optional deeplink URL",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "campaignData",
          "tags": [],
          "docs": "Optional campaign data",
          "complexTypes": [
            "CampaignData"
          ],
          "type": "CampaignData"
        }
      ]
    },
    {
      "name": "CampaignData",
      "slug": "campaigndata",
      "docs": "Campaign data from attribution",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "id",
          "tags": [],
          "docs": "Campaign identifier",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "name",
          "tags": [],
          "docs": "Campaign name",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "type",
          "tags": [],
          "docs": "Campaign type",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "adNetwork",
          "tags": [],
          "docs": "Optional ad network name",
          "complexTypes": [],
          "type": "string | null | undefined"
        },
        {
          "name": "installedAt",
          "tags": [],
          "docs": "Installation timestamp",
          "complexTypes": [],
          "type": "string"
        },
        {
          "name": "storeClickAt",
          "tags": [],
          "docs": "Optional store click timestamp",
          "complexTypes": [],
          "type": "string | null | undefined"
        },
        {
          "name": "groupName",
          "tags": [],
          "docs": "Optional campaign group name",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "assetName",
          "tags": [],
          "docs": "Optional asset name",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "assetGroupName",
          "tags": [],
          "docs": "Optional asset group name",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "SetAdditionalDataOptions",
      "slug": "setadditionaldataoptions",
      "docs": "Options for setting additional integration data",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "integrationData",
          "tags": [],
          "docs": "Required integration data",
          "complexTypes": [
            "IntegrationData"
          ],
          "type": "IntegrationData"
        }
      ]
    },
    {
      "name": "IntegrationData",
      "slug": "integrationdata",
      "docs": "Integration data for third-party platforms",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "clevertapId",
          "tags": [],
          "docs": "Optional CleverTap ID",
          "complexTypes": [],
          "type": "string | undefined"
        }
      ]
    },
    {
      "name": "EnablePIIHashingOptions",
      "slug": "enablepiihashingoptions",
      "docs": "Options for enabling PII hashing",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "enabled",
          "tags": [],
          "docs": "Flag to enable or disable PII hashing",
          "complexTypes": [],
          "type": "boolean"
        }
      ]
    },
    {
      "name": "SetPushTokenOptions",
      "slug": "setpushtokenoptions",
      "docs": "Options for setting the push notification token",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "pushToken",
          "tags": [],
          "docs": "Required push notification token (FCM on Android, APNs on iOS)",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "SetCustomerUserIdOptions",
      "slug": "setcustomeruseridoptions",
      "docs": "Options for setting the customer user ID",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "userId",
          "tags": [],
          "docs": "Required customer user ID",
          "complexTypes": [],
          "type": "string"
        }
      ]
    },
    {
      "name": "HandleDeeplinkResult",
      "slug": "handledeeplinkresult",
      "docs": "Result from handleDeeplink (native bridge shape)",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "data",
          "tags": [],
          "docs": "Deeplink data, when available",
          "complexTypes": [
            "DeeplinkData"
          ],
          "type": "DeeplinkData"
        }
      ]
    },
    {
      "name": "DeeplinkData",
      "slug": "deeplinkdata",
      "docs": "Deeplink data returned from handleDeeplink",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "isLinkrunner",
          "tags": [],
          "docs": "Whether the deeplink originated from Linkrunner",
          "complexTypes": [],
          "type": "boolean"
        },
        {
          "name": "deeplink",
          "tags": [],
          "docs": "The resolved deeplink URL",
          "complexTypes": [],
          "type": "string | undefined"
        },
        {
          "name": "processing",
          "tags": [],
          "docs": "Whether the deeplink is still being processed",
          "complexTypes": [],
          "type": "boolean | undefined"
        }
      ]
    },
    {
      "name": "HandleDeeplinkOptions",
      "slug": "handledeeplinkoptions",
      "docs": "Options for handling a deeplink",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "deeplinkUrl",
          "tags": [],
          "docs": "The full deeplink URL that opened the app",
          "complexTypes": [],
          "type": "string"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [
    {
      "name": "Record",
      "slug": "record",
      "docs": "Construct a type with a set of properties K of type T",
      "types": [
        {
          "text": "{\r\n    [P in K]: T;\r\n}",
          "complexTypes": [
            "K",
            "T"
          ]
        }
      ]
    },
    {
      "name": "PaymentType",
      "slug": "paymenttype",
      "docs": "Payment type enumeration",
      "types": [
        {
          "text": "'FIRST_PAYMENT'",
          "complexTypes": []
        },
        {
          "text": "'WALLET_TOPUP'",
          "complexTypes": []
        },
        {
          "text": "'FUNDS_WITHDRAWAL'",
          "complexTypes": []
        },
        {
          "text": "'SUBSCRIPTION_CREATED'",
          "complexTypes": []
        },
        {
          "text": "'SUBSCRIPTION_RENEWED'",
          "complexTypes": []
        },
        {
          "text": "'DEFAULT'",
          "complexTypes": []
        },
        {
          "text": "'ONE_TIME'",
          "complexTypes": []
        },
        {
          "text": "'RECURRING'",
          "complexTypes": []
        }
      ]
    },
    {
      "name": "PaymentStatus",
      "slug": "paymentstatus",
      "docs": "Payment status enumeration",
      "types": [
        {
          "text": "'PAYMENT_INITIATED'",
          "complexTypes": []
        },
        {
          "text": "'PAYMENT_COMPLETED'",
          "complexTypes": []
        },
        {
          "text": "'PAYMENT_FAILED'",
          "complexTypes": []
        },
        {
          "text": "'PAYMENT_CANCELLED'",
          "complexTypes": []
        }
      ]
    }
  ],
  "pluginConfigs": []
}