Class Adapty

Entry point for the Adapty SDK. All Adapty methods are available through this class.

Constructors

constructor

new Adapty(): Adapty
Returns Adapty

Methods

activate

activate(apiKey: string, params?: ActivateParamsInput): Promise<void>
Initializes the Adapty SDK.
Parameters
- apiKey: string
  You can find it in your app settings in Adapty Dashboard App settings > General.
- params: ActivateParamsInput = {}
  Optional parameters of type ActivateParamsInput.
Returns Promise<void>
A promise that resolves when the SDK is initialized.
Remarks
This method must be called in order for the SDK to work. It is preffered to call it as early as possible in the app lifecycle, so background activities can be performed and cache can be updated.
Example
Basic usage in your app's entry point
```
 adapty.activate('YOUR_API_KEY'); // <-- pass your API key here (required)
```
Usage with your user identifier from your system
```
adapty.activate('YOUR_API_KEY', { // <-- pass your API key here (required)
  customerUserId: 'YOUR_USER_ID'  // <-- pass your user identifier here (optional)
});
```
Throws
AdaptyError Usually throws if the SDK is already activated or if the API key is invalid.
- Defined in src/adapty-handler.ts:204

addEventListener

addEventListener(
event: "onLatestProfileLoad",
callback: (data: AdaptyProfile) => void | Promise<void>,
): EmitterSubscription
Adds an event listener for the latest profile load event.
Parameters
- event: "onLatestProfileLoad"
- callback: (data: AdaptyProfile) => void | Promise<void>
Returns EmitterSubscription
- Defined in src/adapty-handler.ts:99
addEventListener(
event: "onInstallationDetailsSuccess",
callback: (data: AdaptyInstallationDetails) => void | Promise<void>,
): EmitterSubscription
Adds an event listener for successful installation details retrieval.
Parameters
- event: "onInstallationDetailsSuccess"
- callback: (data: AdaptyInstallationDetails) => void | Promise<void>
Returns EmitterSubscription
- Defined in src/adapty-handler.ts:107
addEventListener(
event: "onInstallationDetailsFail",
callback: (data: AdaptyError) => void | Promise<void>,
): EmitterSubscription
Adds an event listener for installation details retrieval failures.
Parameters
- event: "onInstallationDetailsFail"
- callback: (data: AdaptyError) => void | Promise<void>
Returns EmitterSubscription
- Defined in src/adapty-handler.ts:115

createWebPaywallUrl

createWebPaywallUrl(
paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct,
): Promise<string>
Parameters
- paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct
Returns Promise<string>
- Defined in src/adapty-handler.ts:704

enableMock

enableMock(mockConfig?: AdaptyMockConfig): void
Enables mock mode.
Parameters
- OptionalmockConfig: AdaptyMockConfig
  Optional mock configuration
Returns void
Remarks
This method should be called before activate() if you want to test SDK methods without full activation (e.g., isActivated()). If bridge is already initialized, this method does nothing.

Important: Mock mode cannot be disabled at runtime. To switch back to production mode, you need to restart the app.
Example
```
adapty.enableMock({ profile: { ... } });
const isActivated = await adapty.isActivated(); // false
await adapty.activate('api_key');
```
- Defined in src/adapty-handler.ts:169

getCurrentInstallationStatus

getCurrentInstallationStatus(): Promise<AdaptyInstallationStatus>
Gets the current installation status.

Returns Promise<AdaptyInstallationStatus>
A promise that resolves with the installation status.
Remarks
Installation status provides information about when the app was installed, how many times it has been launched, and other installation-related details. The status can be "not_available", "not_determined", or "determined" with details.

Throws
AdaptyError If an error occurs while retrieving the installation status.
Example
```
try {
  const status = await adapty.getCurrentInstallationStatus();
  if (status.status === 'determined') {
    console.log('Install time:', status.details.installTime);
    console.log('Launch count:', status.details.appLaunchCount);
  }
} catch (error) {
  // handle error
}
```
- Defined in src/adapty-handler.ts:1196

getOnboarding

getOnboarding(
    placementId: string,
    locale?: string,
    params?: GetPlacementParamsInput,
): Promise<AdaptyOnboarding>
Parameters
- placementId: string
- Optionallocale: string
- params: GetPlacementParamsInput = ...
Returns Promise<AdaptyOnboarding>
- Defined in src/adapty-handler.ts:464

getOnboardingForDefaultAudience

getOnboardingForDefaultAudience(
    placementId: string,
    locale?: string,
    params?: GetPlacementParamsInput,
): Promise<AdaptyOnboarding>
Parameters
- placementId: string
- Optionallocale: string
- params: GetPlacementParamsInput = ...
Returns Promise<AdaptyOnboarding>
- Defined in src/adapty-handler.ts:511

getPaywall

getPaywall(
    placementId: string,
    locale?: string,
    params?: GetPlacementParamsInput,
): Promise<AdaptyPaywall>
Fetches the paywall by the specified placement.
Parameters
- placementId: string
  The identifier of the desired placement. This is the value you specified when you created the placement in the Adapty Dashboard.
- Optionallocale: string
  The locale of the desired paywall.
- Optionalparams: GetPlacementParamsInput = ...
  Additional parameters for retrieving paywall.
Returns Promise<AdaptyPaywall>
A promise that resolves with a requested paywall.
Remarks
With Adapty, you can remotely configure the products and offers in your app by simply adding them to paywalls – no need for hardcoding them. The only thing you hardcode is the placement ID. This flexibility allows you to easily update paywalls, products, and offers, or run A/B tests, all without the need for a new app release.
Throws
AdaptyError Throws an error:
1. if the paywall with the specified ID is not found
2. if your bundle ID does not match with your Adapty Dashboard setup
- Defined in src/adapty-handler.ts:302

getPaywallForDefaultAudience

getPaywallForDefaultAudience(
    placementId: string,
    locale?: string,
    params?: GetPlacementForDefaultAudienceParamsInput,
): Promise<AdaptyPaywall>
Fetches the paywall of the specified placement for the All Users audience.
Parameters
- placementId: string
  The identifier of the desired placement. This is the value you specified when you created the placement in the Adapty Dashboard.
- Optionallocale: string
  The locale of the desired paywall.
- Optionalparams: GetPlacementForDefaultAudienceParamsInput = ...
  Additional parameters for retrieving paywall.
Returns Promise<AdaptyPaywall>
A promise that resolves with a requested paywall.
Remarks
With Adapty, you can remotely configure the products and offers in your app by simply adding them to paywalls – no need for hardcoding them. The only thing you hardcode is the placement ID. This flexibility allows you to easily update paywalls, products, and offers, or run A/B tests, all without the need for a new app release.

However, it’s crucial to understand that the recommended approach is to fetch the paywall through the placement ID by the getPaywall method. The getPaywallForDefaultAudience method should be a last resort due to its significant drawbacks. See docs for more details
Throws
AdaptyError Throws an error:
1. if the paywall with the specified ID is not found
2. if your bundle ID does not match with your Adapty Dashboard setup
- Defined in src/adapty-handler.ts:377

getPaywallProducts

getPaywallProducts(paywall: AdaptyPaywall): Promise<AdaptyPaywallProduct[]>
Fetches a list of products associated with a provided paywall.
Parameters
- paywall: AdaptyPaywall
  a paywall to fetch products for. You can get it using Adapty.getPaywall method.
Returns Promise<AdaptyPaywallProduct[]>
A promise that resolves with a list of Model.AdaptyPaywallProduct associated with a provided paywall.
Example
```
const paywall = await adapty.getPaywall('paywall_id');
const products = await adapty.getPaywallProducts(paywall);
```
Throws
AdaptyError
- Defined in src/adapty-handler.ts:436

getProfile

getProfile(): Promise<AdaptyProfile>
Fetches a user profile.

Allows you to define the level of access, as well as other parameters.

Returns Promise<AdaptyProfile>
Remarks
The getProfile method provides the most up-to-date result as it always tries to query the API. If for some reason (e.g. no internet connection), the Adapty SDK fails to retrieve information from the server, the data from cache will be returned. It is also important to note that the Adapty SDK updates Model.AdaptyProfile cache on a regular basis, in order to keep this information as up-to-date as possible.

Throws
AdaptyError
- Defined in src/adapty-handler.ts:577

handle

handle<T>(
    method:
        | "activate"
        | "adapty_ui_activate"
        | "adapty_ui_create_paywall_view"
        | "adapty_ui_dismiss_paywall_view"
        | "adapty_ui_present_paywall_view"
        | "adapty_ui_show_dialog"
        | "adapty_ui_create_onboarding_view"
        | "adapty_ui_dismiss_onboarding_view"
        | "adapty_ui_present_onboarding_view"
        | "create_web_paywall_url"
        | "get_current_installation_status"
        | "is_activated"
        | "get_paywall"
        | "get_paywall_for_default_audience"
        | "get_paywall_products"
        | "get_onboarding"
        | "get_onboarding_for_default_audience"
        | "get_profile"
        | "identify"
        | "log_show_paywall"
        | "logout"
        | "make_purchase"
        | "open_web_paywall"
        | "present_code_redemption_sheet"
        | "report_transaction"
        | "restore_purchases"
        | "set_fallback"
        | "set_integration_identifiers"
        | "set_log_level"
        | "update_attribution_data"
        | "update_collecting_refund_data_consent"
        | "update_profile"
        | "update_refund_preference",
    params: string,
    resultType:
        | "AdaptyError"
        | "AdaptyPaywall"
        | "AdaptyRemoteConfig"
        | "AdaptyProfile"
        | "AdaptyPurchaseResult"
        | "AdaptyOnboarding"
        | "AdaptyInstallationStatus"
        | "AdaptyInstallationDetails"
        | "AdaptyPaywallProduct"
        | "AdaptyPaywallBuilder"
        | "AdaptyUiView"
        | "AdaptyUiDialogActionType"
        | "AdaptyUiOnboardingMeta"
        | "AdaptyUiOnboardingStateParams"
        | "AdaptyUiOnboardingStateUpdatedAction"
        | "Array<AdaptyPaywallProduct>"
        | "BridgeError"
        | "String"
        | "Boolean"
        | "Void",
    ctx: LogContext,
    log: LogScope,
): Promise<T>
Type Parameters
- T
Parameters
- method:
      | "activate"
      | "adapty_ui_activate"
      | "adapty_ui_create_paywall_view"
      | "adapty_ui_dismiss_paywall_view"
      | "adapty_ui_present_paywall_view"
      | "adapty_ui_show_dialog"
      | "adapty_ui_create_onboarding_view"
      | "adapty_ui_dismiss_onboarding_view"
      | "adapty_ui_present_onboarding_view"
      | "create_web_paywall_url"
      | "get_current_installation_status"
      | "is_activated"
      | "get_paywall"
      | "get_paywall_for_default_audience"
      | "get_paywall_products"
      | "get_onboarding"
      | "get_onboarding_for_default_audience"
      | "get_profile"
      | "identify"
      | "log_show_paywall"
      | "logout"
      | "make_purchase"
      | "open_web_paywall"
      | "present_code_redemption_sheet"
      | "report_transaction"
      | "restore_purchases"
      | "set_fallback"
      | "set_integration_identifiers"
      | "set_log_level"
      | "update_attribution_data"
      | "update_collecting_refund_data_consent"
      | "update_profile"
      | "update_refund_preference"
- params: string
- resultType:
      | "AdaptyError"
      | "AdaptyPaywall"
      | "AdaptyRemoteConfig"
      | "AdaptyProfile"
      | "AdaptyPurchaseResult"
      | "AdaptyOnboarding"
      | "AdaptyInstallationStatus"
      | "AdaptyInstallationDetails"
      | "AdaptyPaywallProduct"
      | "AdaptyPaywallBuilder"
      | "AdaptyUiView"
      | "AdaptyUiDialogActionType"
      | "AdaptyUiOnboardingMeta"
      | "AdaptyUiOnboardingStateParams"
      | "AdaptyUiOnboardingStateUpdatedAction"
      | "Array<AdaptyPaywallProduct>"
      | "BridgeError"
      | "String"
      | "Boolean"
      | "Void"
- ctx: LogContext
- log: LogScope
Returns Promise<T>
- Defined in src/adapty-handler.ts:45

identify

identify(customerUserId: string, params?: IdentifyParamsInput): Promise<void>
Logs in a user with a provided customerUserId.

If you don't have a user id on SDK initialization, you can set it later at any time with this method. The most common cases are after registration/authorization when the user switches from being an anonymous user to an authenticated user.
Parameters
- customerUserId: string
  unique user id
- Optionalparams: IdentifyParamsInput
  Additional parameters for identification
Returns Promise<void>
Throws
AdaptyError
- Defined in src/adapty-handler.ts:611

isActivated

isActivated(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/adapty-handler.ts:1150

logout

logout(): Promise<void>
Logs out the current user. You can then login the user using Adapty.identify method.

Returns Promise<void>
Throws
AdaptyError
- Defined in src/adapty-handler.ts:739

logShowPaywall

logShowPaywall(paywall: AdaptyPaywall): Promise<void>
Logs a paywall view event.

Adapty helps you to measure the performance of the paywalls. We automatically collect all the metrics related to purchases except for paywall views. This is because only you know when the paywall was shown to a customer.
Parameters
- paywall: AdaptyPaywall
  object that was shown to the user.
Returns Promise<void>
resolves when the event is logged
Remarks
Whenever you show a paywall to your user, call this function to log the event, and it will be accumulated in the paywall metrics.
Example
```
const paywall = await adapty.getPaywall('paywall_id');
// ...after opening the paywall
adapty.logShowPaywall(paywall);
```
- Defined in src/adapty-handler.ts:659

makePurchase

makePurchase(
product: AdaptyPaywallProduct,
params?: MakePurchaseParamsInput,
): Promise<AdaptyPurchaseResult>
Performs a purchase of the specified product.

All available promotions will be applied automatically.
Parameters
- product: AdaptyPaywallProduct
  The product to be purchased. You can get the product using Adapty.getPaywallProducts method.
- Optionalparams: MakePurchaseParamsInput = {}
  Additional parameters for the purchase.
Returns Promise<AdaptyPurchaseResult>
A Promise that resolves to the Model.AdaptyPurchaseResult object containing details about the purchase. If the result is 'success', it also includes the updated user's profile.
Remarks
Successful purchase will also result in a call to the 'onLatestProfileLoad' listener. You can use Adapty.addEventListener to subscribe to this event and handle the purchase result outside of this thread.

Throws
If an error occurs during the purchase process or while decoding the response from the native SDK.
Example
```
try {
  const paywall = await adapty.getPaywall('onboarding');
  const products = await adapty.getPaywallProducts(paywall);
  const product = products[0];

  const profile = await adapty.makePurchase(product);
  // successful, canceled, or pending purchase
} catch (error) {
  // handle error
}
```
- Defined in src/adapty-handler.ts:787

openWebPaywall

openWebPaywall(
paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct,
openIn?: WebPresentation,
): Promise<void>
Parameters
- paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct
- openIn: WebPresentation = WebPresentation.BrowserOutApp
Returns Promise<void>
- Defined in src/adapty-handler.ts:679

presentCodeRedemptionSheet

presentCodeRedemptionSheet(): Promise<void>
Opens a native modal screen to redeem Apple Offer Codes.

Returns Promise<void>
Remarks
iOS 14+ only.
- Defined in src/adapty-handler.ts:832

removeAllListeners

removeAllListeners(): void
Removes all attached event listeners

Returns void
- Defined in src/adapty-handler.ts:145

reportTransaction

reportTransaction(transactionId: string, variationId?: string): Promise<void>
Sets the variation ID of the purchase.

In Observer mode, Adapty SDK doesn't know, where the purchase was made from. If you display products using our Paywalls or A/B Tests, you can manually assign variation to the purchase. After doing this, you'll be able to see metrics in Adapty Dashboard.
Parameters
- transactionId: string
  transactionId property of Model.AdaptySubscription
- OptionalvariationId: string
  variationId property of Model.AdaptyPaywall
Returns Promise<void>
Throws
AdaptyError
- Defined in src/adapty-handler.ts:863

restorePurchases

restorePurchases(): Promise<AdaptyProfile>
Restores user purchases and updates the profile.

Returns Promise<AdaptyProfile>
resolves with the updated profile

Throws
AdaptyError if an error occurs during the restore process or while decoding the response
- Defined in src/adapty-handler.ts:895

setFallback

setFallback(fileLocation: FileLocation): Promise<void>
Sets the fallback paywalls.

Fallback file will be used if the SDK fails to fetch the paywalls or onboardings from the dashboard. It is not designed to be used for the offline flow, as products are not cached in Adapty.
Parameters
- fileLocation: FileLocation
Returns Promise<void>
resolves when fallback placements are saved
- Defined in src/adapty-handler.ts:927

setFallbackPaywalls

setFallbackPaywalls(paywallsLocation: FileLocation): Promise<void>
Parameters
- paywallsLocation: FileLocation
Returns Promise<void>
Deprecated
use setFallback
- Defined in src/adapty-handler.ts:955

setIntegrationIdentifier

setIntegrationIdentifier(key: string, value: string): Promise<void>
Parameters
- key: string
- value: string
Returns Promise<void>
- Defined in src/adapty-handler.ts:961

setLogLevel

setLogLevel(logLevel: LogLevel): Promise<void>
Sets the preferred log level.

By default, the log level is set to error.
Parameters
- logLevel: LogLevel
  new preferred log level
Returns Promise<void>
resolves when the log level is set

Remarks
There are four levels available: error: only errors will be logged warn: messages from the SDK that do not cause critical errors, but are worth paying attention to info: various information messages, such as those that log the lifecycle of various modules verbose: any additional information that may be useful during debugging, such as function calls, API queries, etc.

Throws
AdaptyError if the log level is invalid
- Defined in src/adapty-handler.ts:998

updateAttribution

updateAttribution(
attribution: Record<string, any>,
source: string,
): Promise<void>
Updates an attribution data for the current user.
Parameters
- attribution: Record<string, any>
  An object containing attribution data.
- source: string
  The source of the attribution data.
Returns Promise<void>
A promise that resolves when the attribution data is updated.
Example
```
const attribution = {
  'Adjust Adid': 'adjust_adid',
  'Adjust Network': 'adjust_network',
  'Adjust Campaign': 'adjust_campaign',
  'Adjust Adgroup': 'adjust_adgroup',
};

adapty.updateAttribution(attribution, 'adjust');
```
Throws
AdaptyError Throws if parameters are invalid or not provided.
- Defined in src/adapty-handler.ts:1040

updateCollectingRefundDataConsent

updateCollectingRefundDataConsent(consent: boolean): Promise<void>
Parameters
- consent: boolean
Returns Promise<void>
- Defined in src/adapty-handler.ts:1062

updateProfile

updateProfile(params: Partial<AdaptyProfileParameters>): Promise<void>
Updates a profile for the current user.
Parameters
- params: Partial<AdaptyProfileParameters>
  — an object of parameters to update
Returns Promise<void>
Throws
AdaptyError If parameters are invalid or there is a network error.
Example
```
const profile = {
 email: '[email protected]',
phone: '+1234567890',
};

await adapty.updateProfile(profile);
```
- Defined in src/adapty-handler.ts:1128

updateRefundPreference

updateRefundPreference(refundPreference: RefundPreference): Promise<void>
Parameters
- refundPreference: RefundPreference
Returns Promise<void>
- Defined in src/adapty-handler.ts:1088

Class Adapty

Index

Constructors

Methods

Constructors

constructor

Returns Adapty

Methods

activate

Parameters

Returns Promise<void>

Remarks

Example

Basic usage in your app's entry point

Usage with your user identifier from your system

Throws

addEventListener

Parameters

Returns EmitterSubscription

Parameters

Returns EmitterSubscription

Parameters

Returns EmitterSubscription

createWebPaywallUrl

Parameters

Returns Promise<string>

enableMock

Parameters

Returns void

Remarks

Example

getCurrentInstallationStatus

Returns Promise<AdaptyInstallationStatus>

Remarks

Throws

Example

getOnboarding

Parameters

Returns Promise<AdaptyOnboarding>

getOnboardingForDefaultAudience

Parameters

Returns Promise<AdaptyOnboarding>

getPaywall

Parameters

Returns Promise<AdaptyPaywall>

Remarks

Throws

getPaywallForDefaultAudience

Parameters

Returns Promise<AdaptyPaywall>

Remarks

Throws

getPaywallProducts

Parameters

Returns Promise<AdaptyPaywallProduct[]>

Example

Throws

getProfile

Returns Promise<AdaptyProfile>

Remarks

Throws

handle

Type Parameters

Parameters

Returns Promise<T>

identify

Parameters

Returns Promise<void>

Throws

isActivated

Returns Promise<boolean>

logout

Returns Promise<void>

Throws

logShowPaywall

Parameters

Returns Promise<void>

Remarks

Example

makePurchase