Class Adapty

constructor

• new Adapty(): Adapty

  Returns Adapty

addListener

activate

• activate(
      options: { apiKey: string; params?: ActivateParamsInput },
  ): Promise<void>

  Initializes the Adapty SDK.

  Parameters

  • options: { apiKey: string; params?: ActivateParamsInput }

    The activation options

    • apiKey: string

      Your Adapty API key

    • Optionalparams?: ActivateParamsInput

      Optional activation parameters

  Returns Promise<void>

  Promise that resolves when the SDK is activated

  Throws

  Error if the API key is invalid or activation fails

createWebPaywallUrl

• createWebPaywallUrl(
      options: { paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct },
  ): Promise<string>

  Creates a URL for web paywall.

  Parameters

  • options: { paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct }

  Returns Promise<string>

getCurrentInstallationStatus

• getCurrentInstallationStatus(): Promise<AdaptyInstallationStatus>

  Gets the current installation status.

  Returns Promise<AdaptyInstallationStatus>

getOnboarding

• getOnboarding(options: GetOnboardingOptions): Promise<AdaptyOnboarding>

  Gets an onboarding by placement ID.

  Parameters

  • options: GetOnboardingOptions

  Returns Promise<AdaptyOnboarding>

getOnboardingForDefaultAudience

• getOnboardingForDefaultAudience(
      options: GetOnboardingForDefaultAudienceOptions,
  ): Promise<AdaptyOnboarding>

  Gets an onboarding for default audience by placement ID.

  Parameters

  • options: GetOnboardingForDefaultAudienceOptions

  Returns Promise<AdaptyOnboarding>

getPaywall

• getPaywall(options: GetPaywallOptions): Promise<AdaptyPaywall>

  Gets a paywall by placement ID.

  Parameters

  • options: GetPaywallOptions

  Returns Promise<AdaptyPaywall>

getPaywallForDefaultAudience

• getPaywallForDefaultAudience(
      options: GetPaywallForDefaultAudienceOptions,
  ): Promise<AdaptyPaywall>

  Gets a paywall for default audience by placement ID.

  Parameters

  • options: GetPaywallForDefaultAudienceOptions

  Returns Promise<AdaptyPaywall>

getPaywallProducts

• getPaywallProducts(
      options: { paywall: AdaptyPaywall },
  ): Promise<AdaptyPaywallProduct[]>

  Gets products for a specific paywall.

  Parameters

  • options: { paywall: AdaptyPaywall }

  Returns Promise<AdaptyPaywallProduct[]>

getProfile

• getProfile(): Promise<AdaptyProfile>

  Gets the current user profile.

  Returns Promise<AdaptyProfile>

handleMethodCall

• handleMethodCall<M extends MethodName>(
      methodName: M,
      args: string,
      ctx: LogContext,
      log: LogScope,
  ): Promise<MethodResponseMap[M]>

  Handle method calls through crossplatform bridge with type safety

  Type Parameters

  • M extends MethodName

  Parameters

  • methodName: M
  • args: string
  • ctx: LogContext
  • log: LogScope

  Returns Promise<MethodResponseMap[M]>

identify

• identify(options: { customerUserId: string }): Promise<void>

  Identifies the user with a customer user ID.

  Parameters

  • options: { customerUserId: string }

  Returns Promise<void>

isActivated

• isActivated(): Promise<boolean>

  Checks if the SDK is activated.

  Returns Promise<boolean>

logout

• logout(): Promise<void>

  Logs out the current user.

  Returns Promise<void>

logShowPaywall

• logShowPaywall(options: { paywall: AdaptyPaywall }): Promise<void>

  Logs that a paywall was shown to the user.

  Parameters

  • options: { paywall: AdaptyPaywall }

  Returns Promise<void>

makePurchase

• makePurchase(options: MakePurchaseOptions): Promise<AdaptyPurchaseResult>

  Makes a purchase of a product.

  Parameters

  • options: MakePurchaseOptions

  Returns Promise<AdaptyPurchaseResult>

openWebPaywall

• openWebPaywall(
      options: { paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct },
  ): Promise<void>

  Opens a web paywall.

  Parameters

  • options: { paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct }

  Returns Promise<void>

presentCodeRedemptionSheet

• presentCodeRedemptionSheet(): Promise<void>

  Presents the code redemption sheet (iOS only).

  Returns Promise<void>

removeAllListeners

• removeAllListeners(): Promise<void>

  Removes all listeners.

  Returns Promise<void>

reportTransaction

• reportTransaction(
      options: { transactionId: string; variationId?: string },
  ): Promise<void>

  Reports a transaction to Adapty.

  Parameters

  • options: { transactionId: string; variationId?: string }

  Returns Promise<void>

restorePurchases

• restorePurchases(): Promise<AdaptyProfile>

  Restores user purchases.

  Returns Promise<AdaptyProfile>

setFallback

• setFallback(options: { fileLocation: FileLocation }): Promise<void>

  Sets fallback paywalls from a file.

  Parameters

  • options: { fileLocation: FileLocation }

  Returns Promise<void>

setIntegrationIdentifier

• setIntegrationIdentifier(options: { key: string; value: string }): Promise<void>

  Sets an integration identifier.

  Parameters

  • options: { key: string; value: string }

  Returns Promise<void>

setLogLevel

• setLogLevel(
      options: { logger?: LoggerConfig; logLevel?: LogLevel },
  ): Promise<void>

  Sets the log level for the SDK or configures JS logger sinks.

  Parameters

  • options: { logger?: LoggerConfig; logLevel?: LogLevel }

  Returns Promise<void>

updateAttribution

• updateAttribution(
      options: { attribution: Record<string, any>; source: string },
  ): Promise<void>

  Updates attribution data for the current user.

  Parameters

  • options: { attribution: Record<string, any>; source: string }

  Returns Promise<void>

updateCollectingRefundDataConsent

• updateCollectingRefundDataConsent(options: { consent: boolean }): Promise<void>

  Updates collecting refund data consent (iOS only).

  Parameters

  • options: { consent: boolean }

  Returns Promise<void>

updateProfile

• updateProfile(options: Partial<AdaptyProfileParameters>): Promise<void>

  Updates the user profile.

  Parameters

  • options: Partial<AdaptyProfileParameters>

  Returns Promise<void>

updateRefundPreference

• updateRefundPreference(
      options: { refundPreference: RefundPreference },
  ): Promise<void>

  Updates refund preference (iOS only).

  Parameters

  • options: { refundPreference: RefundPreference }

  Returns Promise<void>