@adapty/capacitor 3.11.1-beta.0 → 3.15.0

package/dist/esm/adapty.d.ts

@@ -1,10 +1,18 @@
 import { LogContext } from './shared/logger';
 import type { LoggerConfig, LogScope } from './shared/logger';
-import type { AdaptyPaywall, AdaptyPaywallProduct, AdaptyOnboarding, AdaptyProfile, AdaptyPurchaseResult, AdaptyProfileParameters, RefundPreference, AdaptyInstallationStatus } from './shared/types';
-import type { ActivateParamsInput, FileLocation, LogLevel } from './shared/types/inputs';
+import type { AdaptyPaywall, AdaptyPaywallProduct, AdaptyOnboarding, AdaptyProfile, AdaptyPurchaseResult, AdaptyProfileParameters, RefundPreference, AdaptyInstallationStatus, WebPresentation } from './shared/types';
+import type { ActivateParamsInput, FileLocation, LogLevel, IdentifyParamsInput } from './shared/types/inputs';
 import { type MethodName, type MethodResponseMap } from './shared/types/method-types';
 import type { AdaptyPlugin, AddListenerFn } from './types/adapty-plugin';
 import type { GetPaywallOptions, GetPaywallForDefaultAudienceOptions, MakePurchaseOptions, GetOnboardingOptions, GetOnboardingForDefaultAudienceOptions } from './types/configs';
+/**
+ * Entry point for the Adapty SDK.
+ *
+ * @remarks
+ * This is the main Adapty class, excluding UI rendering functionality.
+ *
+ * @public
+ */
 export declare class Adapty implements AdaptyPlugin {
     private activating;
     private resolveHeldActivation?;
@@ -17,75 +25,813 @@ export declare class Adapty implements AdaptyPlugin {
     private encodeWithLogging;
     /**
      * Handle method calls through crossplatform bridge with type safety
+     * @internal
      */
     handleMethodCall<M extends MethodName>(methodName: M, args: string, ctx: LogContext, log: LogScope): Promise<MethodResponseMap[M]>;
     private isPaywallProduct;
     /**
      * Initializes the Adapty SDK.
      *
+     * @remarks
+     * This method must be called in order for the SDK to work.
+     * It is preferred to call it as early as possible in the app lifecycle,
+     * so background activities can be performed and cache can be updated.
+     *
+     * @example
+     *
+     * @example
+     * Usage with your user identifier from your system
+     * ```typescript
+     * await adapty.activate({
+     *   apiKey: 'YOUR_PUBLIC_SDK_KEY',
+     *   params: {
+     *     customerUserId: 'YOUR_USER_ID'
+     *   }
+     * });
+     * ```
+     *
      * @param options - The activation options
-     * @param options.apiKey - Your Adapty API key
-     * @param options.params - Optional activation parameters
-     * @returns Promise that resolves when the SDK is activated
-     * @throws Error if the API key is invalid or activation fails
+     * @param options.apiKey - You can find it in your app settings in Adapty Dashboard App settings > General.
+     * @param options.params - Optional activation parameters of type {@link ActivateParamsInput}.
+     * @returns A promise that resolves when the SDK is activated.
+     * @throws Error if the SDK is already activated or if the API key is invalid.
      */
     activate(options: {
         apiKey: string;
         params?: ActivateParamsInput;
     }): Promise<void>;
     private performActivation;
+    /**
+     * Checks if the Adapty SDK is activated.
+     *
+     * @returns A promise that resolves to `true` if the SDK is activated, `false` otherwise.
+     * @throws Error if an error occurs while checking activation status.
+     */
     isActivated(): Promise<boolean>;
+    /**
+     * Gets the current 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.
+     *
+     * @returns A promise that resolves with the installation status.
+     * @throws Error if an error occurs while retrieving the installation status.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * 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) {
+     *   console.error('Failed to get installation status:', error);
+     * }
+     * ```
+     */
     getCurrentInstallationStatus(): Promise<AdaptyInstallationStatus>;
+    /**
+     * Fetches the paywall by the specified placement.
+     *
+     * @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.
+     *
+     * @param options - The options for fetching the paywall
+     * @param options.placementId - The identifier of the desired placement. This is the value you specified when creating a placement in the Adapty Dashboard.
+     * @param options.locale - Optional. The identifier of the paywall localization. Default: `'en'`. See {@link https://docs.adapty.io/docs/localizations-and-locale-codes | Localizations and locale codes} for more information.
+     * @param options.params - Optional. Additional parameters for fetching the paywall, including fetch policy and load timeout.
+     * @returns A promise that resolves with the requested {@link AdaptyPaywall}.
+     * @throws Error if the paywall with the specified ID is not found or if your bundle ID does not match with your Adapty Dashboard setup.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const paywall = await adapty.getPaywall({
+     *     placementId: 'YOUR_PLACEMENT_ID',
+     *     locale: 'en',
+     *   });
+     *   console.log('Paywall fetched successfully');
+     * } catch (error) {
+     *   console.error('Failed to fetch paywall:', error);
+     * }
+     * ```
+     */
     getPaywall(options: GetPaywallOptions): Promise<AdaptyPaywall>;
+    /**
+     * Fetches the paywall of the specified placement for the **All Users** audience.
+     *
+     * @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.
+     *
+     * However, it's crucial to understand that the recommended approach is to fetch the paywall
+     * through the placement ID by the {@link getPaywall} method.
+     * The `getPaywallForDefaultAudience` method should be a last resort due to its significant drawbacks:
+     * - Potential backward compatibility issues
+     * - Loss of targeting (all users see the same paywall)
+     *
+     * See {@link https://docs.adapty.io/docs/capacitor-get-pb-paywalls#get-a-paywall-for-a-default-audience-to-fetch-it-faster | documentation} for more details.
+     *
+     * @param options - The options for fetching the paywall
+     * @param options.placementId - The identifier of the desired placement.
+     * @param options.locale - Optional. The identifier of the paywall localization. Default: `'en'`.
+     * @param options.params - Optional. Additional parameters for fetching the paywall.
+     * @returns A promise that resolves with the requested {@link AdaptyPaywall}.
+     * @throws Error if the paywall with the specified ID is not found.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const paywall = await adapty.getPaywallForDefaultAudience({
+     *     placementId: 'YOUR_PLACEMENT_ID',
+     *     locale: 'en',
+     *   });
+     * } catch (error) {
+     *   console.error('Failed to fetch paywall:', error);
+     * }
+     * ```
+     */
     getPaywallForDefaultAudience(options: GetPaywallForDefaultAudienceOptions): Promise<AdaptyPaywall>;
+    /**
+     * Fetches a list of products associated with a provided paywall.
+     *
+     * @param options - The options object
+     * @param options.paywall - A paywall to fetch products for. You can get it using {@link getPaywall} method.
+     * @returns A promise that resolves with a list of {@link AdaptyPaywallProduct} associated with a provided paywall.
+     * @throws Error if an error occurs while fetching products.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
+     *   const products = await adapty.getPaywallProducts({ paywall });
+     *   console.log('Products:', products);
+     * } catch (error) {
+     *   console.error('Failed to fetch products:', error);
+     * }
+     * ```
+     */
     getPaywallProducts(options: {
         paywall: AdaptyPaywall;
     }): Promise<AdaptyPaywallProduct[]>;
+    /**
+     * Fetches the onboarding by the specified placement.
+     *
+     * @remarks
+     * When you create an onboarding with the no-code builder, it's stored as a container with configuration
+     * that your app needs to fetch and display. This container manages the entire experience - what content appears,
+     * how it's presented, and how user interactions are processed.
+     *
+     * @param options - The options for fetching the onboarding
+     * @param options.placementId - The identifier of the desired placement.
+     * @param options.locale - Optional. The identifier of the onboarding localization. Default: `'en'`.
+     * @param options.params - Optional. Additional parameters for fetching the onboarding.
+     * @returns A promise that resolves with the requested {@link AdaptyOnboarding}.
+     * @throws Error if the onboarding with the specified ID is not found.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const onboarding = await adapty.getOnboarding({
+     *     placementId: 'YOUR_PLACEMENT_ID',
+     *     locale: 'en',
+     *     params: {
+     *       fetchPolicy: 'reload_revalidating_cache_data',
+     *       loadTimeoutMs: 5000
+     *     }
+     *   });
+     *   console.log('Onboarding fetched successfully');
+     * } catch (error) {
+     *   console.error('Failed to fetch onboarding:', error);
+     * }
+     * ```
+     */
     getOnboarding(options: GetOnboardingOptions): Promise<AdaptyOnboarding>;
+    /**
+     * Fetches the onboarding of the specified placement for the **All Users** audience.
+     *
+     * @remarks
+     * It's crucial to understand that the recommended approach is to fetch the onboarding
+     * by the {@link getOnboarding} method. The `getOnboardingForDefaultAudience` method
+     * should be used only if faster fetching outweighs the drawbacks:
+     * - Potential backward compatibility issues
+     * - Loss of personalization (no targeting based on country, attribution, or custom attributes)
+     *
+     * @param options - The options for fetching the onboarding
+     * @param options.placementId - The identifier of the desired placement.
+     * @param options.locale - Optional. The identifier of the onboarding localization. Default: `'en'`.
+     * @param options.params - Optional. Additional parameters for fetching the onboarding.
+     * @returns A promise that resolves with the requested {@link AdaptyOnboarding}.
+     * @throws Error if the onboarding with the specified ID is not found.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const onboarding = await adapty.getOnboardingForDefaultAudience({
+     *     placementId: 'YOUR_PLACEMENT_ID',
+     *     locale: 'en',
+     *   });
+     * } catch (error) {
+     *   console.error('Failed to fetch onboarding:', error);
+     * }
+     * ```
+     */
     getOnboardingForDefaultAudience(options: GetOnboardingForDefaultAudienceOptions): Promise<AdaptyOnboarding>;
+    /**
+     * Fetches a user profile.
+     *
+     * @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 {@link AdaptyProfile} cache
+     * on a regular basis, in order
+     * to keep this information as up-to-date as possible.
+     *
+     * @returns A promise that resolves with the user's {@link AdaptyProfile}.
+     * @throws Error if an error occurs while fetching the profile.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const profile = await adapty.getProfile();
+     *   const isSubscribed = profile.accessLevels['YOUR_ACCESS_LEVEL']?.isActive;
+     *   if (isSubscribed) {
+     *     console.log('User has access to premium features');
+     *   }
+     * } catch (error) {
+     *   console.error('Failed to get profile:', error);
+     * }
+     * ```
+     */
     getProfile(): Promise<AdaptyProfile>;
+    /**
+     * Logs in a user with a provided customerUserId.
+     *
+     * @remarks
+     * 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.
+     *
+     * @param options - The identification options
+     * @param options.customerUserId - A unique user identifier.
+     * @param options.params - Optional. Additional parameters for identification, including platform-specific settings.
+     * @returns A promise that resolves when identification is complete.
+     * @throws Error if an error occurs during identification.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.identify({ customerUserId: 'YOUR_USER_ID' });
+     *   console.log('User identified successfully');
+     * } catch (error) {
+     *   console.error('Failed to identify user:', error);
+     * }
+     * ```
+     */
     identify(options: {
         customerUserId: string;
+        params?: IdentifyParamsInput;
     }): Promise<void>;
+    /**
+     * Logs a paywall view event.
+     *
+     * @remarks
+     * Adapty helps you to measure the performance of the paywalls.
+     * We automatically collect all the metrics related to purchases except for custom paywall views.
+     * This is because only you know when the paywall was shown to a customer.
+     *
+     * Whenever you show a paywall to your user,
+     * call this function to log the event,
+     * and it will be accumulated in the paywall metrics.
+     *
+     * @param options - The options object
+     * @param options.paywall - The paywall object that was shown to the user.
+     * @returns A promise that resolves when the event is logged.
+     * @throws Error if an error occurs while logging the event.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
+     * // ...after opening the paywall
+     * await adapty.logShowPaywall({ paywall });
+     * ```
+     */
     logShowPaywall(options: {
         paywall: AdaptyPaywall;
     }): Promise<void>;
+    /**
+     * Opens a web paywall in the default browser.
+     *
+     * @param options - The options object
+     * @param options.paywallOrProduct - The paywall or product to open as a web paywall.
+     * @returns A promise that resolves when the web paywall is opened.
+     * @throws Error if an error occurs while opening the web paywall.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
+     *   await adapty.openWebPaywall({ paywallOrProduct: paywall });
+     * } catch (error) {
+     *   console.error('Failed to open web paywall:', error);
+     * }
+     * ```
+     */
     openWebPaywall(options: {
         paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct;
+        openIn?: WebPresentation;
     }): Promise<void>;
+    /**
+     * Creates a URL for a web paywall.
+     *
+     * @remarks
+     * This method generates a URL that can be used to open a web version of the paywall.
+     * You can use this URL in a custom web view or a browser.
+     *
+     * @param options - The options object
+     * @param options.paywallOrProduct - The paywall or product to create a URL for.
+     * @returns A promise that resolves with the web paywall URL.
+     * @throws Error if an error occurs while creating the URL.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const paywall = await adapty.getPaywall({ placementId: 'YOUR_PLACEMENT_ID' });
+     *   const url = await adapty.createWebPaywallUrl({ paywallOrProduct: paywall });
+     *   console.log('Web paywall URL:', url);
+     * } catch (error) {
+     *   console.error('Failed to create web paywall URL:', error);
+     * }
+     * ```
+     */
     createWebPaywallUrl(options: {
         paywallOrProduct: AdaptyPaywall | AdaptyPaywallProduct;
     }): Promise<string>;
+    /**
+     * Logs out the current user.
+     *
+     * @remarks
+     * You can then login the user using {@link identify} method.
+     *
+     * @returns A promise that resolves when the user is logged out.
+     * @throws Error if an error occurs during logout.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.logout();
+     *   console.log('User logged out successfully');
+     * } catch (error) {
+     *   console.error('Failed to logout user:', error);
+     * }
+     * ```
+     */
     logout(): Promise<void>;
+    /**
+     * Performs a purchase of the specified product.
+     *
+     * @remarks
+     * In paywalls built with Paywall Builder, purchases are processed automatically with no additional code.
+     *
+     * @param options - The purchase options
+     * @param options.product - The product to be purchased. You can get it using {@link getPaywallProducts} method.
+     * @param options.params - Optional. Additional parameters for the purchase, including Android subscription update params.
+     * @returns A promise that resolves with the {@link AdaptyPurchaseResult} object containing details about the purchase.
+     * If the result is `'success'`, it also includes the updated user's profile.
+     * @throws Error if an error occurs during the purchase process.
+     *
+     * @example
+     * Basic purchase
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const result = await adapty.makePurchase({ product });
+     *
+     *   if (result.type === 'success') {
+     *     const isSubscribed = result.profile?.accessLevels['YOUR_ACCESS_LEVEL']?.isActive;
+     *     if (isSubscribed) {
+     *       console.log('User is now subscribed!');
+     *     }
+     *   }
+     * } catch (error) {
+     *   console.error('Purchase failed:', error);
+     * }
+     * ```
+     */
     makePurchase(options: MakePurchaseOptions): Promise<AdaptyPurchaseResult>;
+    /**
+     * Opens a native modal screen to redeem Apple Offer Codes.
+     *
+     * @remarks
+     * iOS 14+ only. Since iOS 14.0, your users can redeem Offer Codes.
+     * To enable users to redeem offer codes, you can display the offer code redemption sheet.
+     *
+     * @returns A promise that resolves when the redemption sheet is presented.
+     * @throws Error if an error occurs or if called on Android.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.presentCodeRedemptionSheet();
+     * } catch (error) {
+     *   console.error('Failed to present code redemption sheet:', error);
+     * }
+     * ```
+     */
     presentCodeRedemptionSheet(): Promise<void>;
+    /**
+     * Sets the variation ID of the purchase.
+     *
+     * @remarks
+     * In Observer mode, Adapty SDK doesn't know where the purchase was made from.
+     * you can manually assign variation to the purchase.
+     * After doing this, you'll be able to see metrics in Adapty Dashboard.
+     *
+     * @param options - The options object
+     * @param options.transactionId - The transaction ID of the purchase.
+     * @param options.variationId - Optional. The variation ID from the {@link AdaptyPaywall}.
+     * @returns A promise that resolves when the transaction is reported.
+     * @throws Error if an error occurs while reporting the transaction.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.reportTransaction({
+     *     transactionId: 'transaction_123',
+     *     variationId: 'variation_456'
+     *   });
+     * } catch (error) {
+     *   console.error('Failed to report transaction:', error);
+     * }
+     * ```
+     */
     reportTransaction(options: {
         transactionId: string;
         variationId?: string;
     }): Promise<void>;
+    /**
+     * Restores user purchases and updates the profile.
+     *
+     * @remarks
+     * Restoring purchases allows users to regain access to previously purchased content,
+     * such as subscriptions or in-app purchases, without being charged again.
+     * This feature is especially useful for users who may have uninstalled and reinstalled the app
+     * or switched to a new device.
+     *
+     * In paywalls built with Paywall Builder, purchases are restored automatically without additional code from you.
+     *
+     * @returns A promise that resolves with the updated user's {@link AdaptyProfile}.
+     * @throws Error if an error occurs during the restore process.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const profile = await adapty.restorePurchases();
+     *   const isSubscribed = profile.accessLevels['YOUR_ACCESS_LEVEL']?.isActive;
+     *
+     *   if (isSubscribed) {
+     *     console.log('Access restored successfully!');
+     *   } else {
+     *     console.log('No active subscriptions found');
+     *   }
+     * } catch (error) {
+     *   console.error('Failed to restore purchases:', error);
+     * }
+     * ```
+     */
     restorePurchases(): Promise<AdaptyProfile>;
+    /**
+     * Sets the fallback paywalls.
+     *
+     * @remarks
+     * Fallback file will be used if the SDK fails
+     * to fetch the paywalls from the dashboard.
+     * It is not designed to be used for the offline flow,
+     * as products are not cached in Adapty.
+     *
+     * @param options - The options object
+     * @param options.fileLocation - The location of the fallback file for each platform.
+     * @returns A promise that resolves when fallback placements are saved.
+     * @throws Error if an error occurs while setting the fallback.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.setFallback({
+     *     fileLocation: {
+     *       ios: { fileName: 'fallback_paywalls.json' },
+     *       android: { relativeAssetPath: 'fallback_paywalls.json' }
+     *     }
+     *   });
+     * } catch (error) {
+     *   console.error('Failed to set fallback:', error);
+     * }
+     * ```
+     */
     setFallback(options: {
         fileLocation: FileLocation;
     }): Promise<void>;
+    /**
+     * Sets an integration identifier for the current user.
+     *
+     * @remarks
+     * Integration identifiers can be used to link Adapty profiles to external systems
+     * and track users across different platforms.
+     *
+     * @param options - The options object
+     * @param options.key - The key of the integration identifier.
+     * @param options.value - The value of the integration identifier.
+     * @returns A promise that resolves when the integration identifier is set.
+     * @throws Error if an error occurs while setting the identifier.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.setIntegrationIdentifier({
+     *     key: 'firebase_app_instance_id',
+     *     value: 'YOUR_FIREBASE_ID'
+     *   });
+     * } catch (error) {
+     *   console.error('Failed to set integration identifier:', error);
+     * }
+     * ```
+     */
     setIntegrationIdentifier(options: {
         key: string;
         value: string;
     }): Promise<void>;
+    /**
+     * Sets the preferred log level and/or custom logger configuration.
+     *
+     * @remarks
+     * By default, the log level is set to `error`.
+     *
+     * 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.
+     *
+     * @param options - The options object
+     * @param options.logLevel - Optional. The new preferred log level.
+     * @param options.logger - Optional. Custom logger configuration.
+     * @returns A promise that resolves when the log level is set.
+     * @throws Error if the log level is invalid.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * // Set log level
+     * await adapty.setLogLevel({ logLevel: 'verbose' });
+     *
+     * // Or set custom logger
+     * await adapty.setLogLevel({
+     *   logger: {
+     *     handler: (level, scope, message, data) => {
+     *       sendLogToYourServer(`[${level}] ${message}`, data);
+     *     }
+     *   }
+     * });
+     * ```
+     */
     setLogLevel(options: {
         logLevel?: LogLevel;
         logger?: LoggerConfig;
     }): Promise<void>;
+    /**
+     * Updates attribution data for the current user.
+     *
+     * @remarks
+     * Attribution data can be used to track marketing campaigns and user acquisition sources.
+     *
+     * @param options - The options object
+     * @param options.attribution - An object containing attribution data.
+     * @param options.source - The source of the attribution data (e.g., 'adjust', 'appsflyer').
+     * @returns A promise that resolves when the attribution data is updated.
+     * @throws Error if parameters are invalid or not provided.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   const attribution = {
+     *     'Adjust Adid': 'adjust_adid',
+     *     'Adjust Network': 'adjust_network',
+     *     'Adjust Campaign': 'adjust_campaign',
+     *     'Adjust Adgroup': 'adjust_adgroup',
+     *   };
+     *
+     *   await adapty.updateAttribution({ attribution, source: 'adjust' });
+     * } catch (error) {
+     *   console.error('Failed to update attribution:', error);
+     * }
+     * ```
+     */
     updateAttribution(options: {
         attribution: Record<string, any>;
         source: string;
     }): Promise<void>;
+    /**
+     * Updates the user's consent for collecting refund data.
+     *
+     * @remarks
+     * iOS only. This method has no effect on Android.
+     * Use this method to update whether the SDK should collect refund data for the user.
+     *
+     * @param options - The options object
+     * @param options.consent - Whether to collect refund data.
+     * @returns A promise that resolves when the consent is updated (or immediately on Android).
+     * @throws Error if an error occurs on iOS.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.updateCollectingRefundDataConsent({ consent: true });
+     * } catch (error) {
+     *   console.error('Failed to update consent:', error);
+     * }
+     * ```
+     */
     updateCollectingRefundDataConsent(options: {
         consent: boolean;
     }): Promise<void>;
+    /**
+     * Updates the user's refund preference.
+     *
+     * @remarks
+     * iOS only. This method has no effect on Android.
+     * Use this method to set the user's preference for handling refunds.
+     *
+     * @param options - The options object
+     * @param options.refundPreference - The refund preference setting.
+     * @returns A promise that resolves when the preference is updated (or immediately on Android).
+     * @throws Error if an error occurs on iOS.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.updateRefundPreference({ refundPreference: 'ask_to_cancel' });
+     * } catch (error) {
+     *   console.error('Failed to update refund preference:', error);
+     * }
+     * ```
+     */
     updateRefundPreference(options: {
         refundPreference: RefundPreference;
     }): Promise<void>;
+    /**
+     * Updates a profile for the current user.
+     *
+     * @remarks
+     * You can set optional attributes such as email, phone number, etc. to the user of your app.
+     * You can then use attributes to create user segments or just view them in CRM.
+     *
+     * The attributes that you've previously set won't be reset.
+     * Custom attributes can be removed by passing `null` as their values.
+     *
+     * @param options - An object of parameters to update. Partial {@link AdaptyProfileParameters}.
+     * @returns A promise that resolves when the profile is updated.
+     * @throws Error if parameters are invalid or there is a network error.
+     *
+     * @example
+     * Basic profile update
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * try {
+     *   await adapty.updateProfile({
+     *     email: 'email@email.com',
+     *     phoneNumber: '+18888888888',
+     *     firstName: 'John',
+     *     lastName: 'Appleseed',
+     *     gender: 'other',
+     *     birthday: new Date().toISOString(),
+     *   });
+     *   console.log('Profile updated successfully');
+     * } catch (error) {
+     *   console.error('Failed to update profile:', error);
+     * }
+     * ```
+     *
+     * @example
+     * Custom attributes
+     * ```typescript
+     * await adapty.updateProfile({
+     *   codableCustomAttributes: {
+     *     key_1: 'value_1',
+     *     key_2: 2,
+     *   },
+     * });
+     *
+     * // To remove keys, pass null as their values
+     * await adapty.updateProfile({
+     *   codableCustomAttributes: {
+     *     key_1: null,
+     *   },
+     * });
+     * ```
+     */
     updateProfile(options: Partial<AdaptyProfileParameters>): Promise<void>;
+    /**
+     * Adds an event listener for SDK events.
+     *
+     * @remarks
+     * You can listen to various events from the Adapty SDK such as profile updates.
+     * The listener will be called whenever the corresponding event occurs.
+     *
+     * @param eventName - The name of the event to listen to.
+     * @param listenerFunc - The function to call when the event occurs.
+     * @returns A listener handle that can be used to remove the listener.
+     *
+     * @example
+     * Listen to profile updates
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * const listener = adapty.addListener('onLatestProfileLoad', (profile) => {
+     *   console.log('Profile updated:', profile);
+     *   const isSubscribed = profile.accessLevels['YOUR_ACCESS_LEVEL']?.isActive;
+     *   if (isSubscribed) {
+     *     console.log('User has premium access');
+     *   }
+     * });
+     *
+     * // Later, remove the listener
+     * listener.remove();
+     * ```
+     */
     addListener: AddListenerFn;
+    /**
+     * Removes all attached event listeners.
+     *
+     * @remarks
+     * This method removes all event listeners that were added via {@link addListener}.
+     * It's recommended to call this method when cleaning up resources,
+     * such as when unmounting a component.
+     *
+     * @returns A promise that resolves when all listeners are removed.
+     *
+     * @example
+     * ```typescript
+     * import { adapty } from '@adapty/capacitor';
+     *
+     * // Remove all listeners
+     * await adapty.removeAllListeners();
+     * ```
+     */
     removeAllListeners(): Promise<void>;
 }