@chargebee/react-native-chargebee/lib/typescript/Chargebee.d.ts

Package for Chargebee In-App Purchases

import { type ChargebeeConfig, type Product, type Purchase, type SubscriptionsRequest, type Subscription, type AuthenticationDetail, type ProductIdentifiersRequest, type Customer, type RestoredSubscription, type Entitlement, type EntitlementsRequest, ProductType, type OneTimePurchase } from './Purchases';
export default class Chargebee {
    /**
     * Sets up Chargebee SDK with site, API key and SDK IDs for Android and iOS.
     *
     * @param {String} site Chargebee site.
     * Example: If the Chargebee domain url is https://mobile-test.chargebee.com, then the site value is 'mobile-test'
     * @param {String} publishableApiKey Publishable API key generated for your Chargebee Site. Refer: https://www.chargebee.com/docs/2.0/api_keys.html#types-of-api-keys_publishable-key
     * @param {String} androidSdkKey Android SDK key. Refer: https://www.chargebee.com/docs/1.0/mobile-playstore-notifications.html#app-id
     * @param {String} iOsSdkKey iOS SDK key. Refer: https://www.chargebee.com/docs/1.0/mobile-app-store-product-iap.html#connection-keys_app-id
     */
    static configure({ site, publishableApiKey, androidSdkKey, iOsSdkKey, }: ChargebeeConfig): Promise<AuthenticationDetail>;
    /**
     * Retrieves available product identifiers.
     *
     * @param {Object} productIdentitifiersRequest. Product Identifiers Request object.
     * Example: {limit : '100', offset : '1'}
     * @returns {Promise<Array<string>>} Array of product identifiers
     */
    static retrieveProductIdentifiers(productIdentitifiersRequest: ProductIdentifiersRequest): Promise<Array<string>>;
    /**
     * Retrieves products for give product identifiers.
     *
     * @param {Array} productIds Array of product identifiers
     * @returns {Promise<Array<Product>>} Array of products
     */
    static retrieveProducts(productIds: Array<string>): Promise<Array<Product>>;
    /**
     * Purchase product for the customer.
     *
     * @param {string} productId Product identifier
     * @param {Object} customer Optional. Customer object.
     * If the `id` is not passed in the customer's details, then the value of customerId will be the same as the SubscriptionId created in Chargebee.
     * @returns {Promise<Purchase>} Purchase result
     */
    static purchaseProduct(productId: string, customer: Customer | null): Promise<Purchase>;
    /**
     * Purchase one time product for the customer.
     *
     * @param {string} productId Product identifier
     * @param {Object} productType One Time Product Type.
     * @param {Object} customer Optional. Customer object.
     * If the `id` is not passed in the customer's details, then the value of customerId will be the same as the SubscriptionId created in Chargebee.
     * @returns {Promise<OneTimePurchase>} Purchase result
     */
    static purchaseNonSubscriptionProduct(productId: string, productType: ProductType, customer: Customer | null): Promise<OneTimePurchase>;
    /**
     * Retrieves the subscriptions by customer_id or subscription_id.
     *
     * @param {Object} subscriptionRequest. Subscription Request object.
     * Example: {customer_id : '<customer_id>', subscription_id : '<subscription_id>', status: 'active'}
     * @returns {Promise<Array<Subscription>>} Array of subscriptions
     */
    static retrieveSubscriptions(subscriptionRequest: SubscriptionsRequest): Promise<Array<Subscription>>;
    /**
     * Restores the subscriptions for the user logged in the device.
     *
     * @param {Boolean} includeInactivePurchases When set to true, the inactive purchases are also synced to Chargebee.
     * @param {Object} customer Optional. Customer object.
     * Please use the same customer id which was used during the initial purchase
     * @returns {Promise<Array<RestoredSubscription>>} Array of subscriptions
     */
    static restorePurchases(includeInactivePurchases: boolean, customer: Customer | null): Promise<Array<RestoredSubscription>>;
    /**
     * Validates the receipt of the given Product ID and Customer.
     * This method can be used to retry sync with Chargebee, when sync fails after a successful purchase.
     *
     * @param {string} productId Product identifier
     * @param {Object} customer Optional. Customer object.
     * If the `id` is not passed in the customer's details, then the value of customerId will be the same as the SubscriptionId created in Chargebee.
     * @returns {Promise<Purchase>} Purchase result
     */
    static validateReceipt(productId: string, customer: Customer | null): Promise<Purchase>;
    /**
     * This method will be used to validate the receipt of One Time Purchase with Chargebee,
     * when syncing with Chargebee fails after the successful purchase.
     *
     * @param {string} productId Product identifier.
     * @param {Object} productType One Time Product Type.
     * @param {Object} customer Optional. Customer object.
     * If the `id` is not passed in the customer's details, then the value of customerId will be the same as the SubscriptionId created in Chargebee.
     * @returns {Promise<OneTimePurchase>} Purchase result
     */
    static validateReceiptForNonSubscriptions(productId: string, productType: ProductType, customer: Customer | null): Promise<OneTimePurchase>;
    /**
     * Retrieves the entitlements for a given subscription id
     *
     * @param {string} subscriptionId Subscription identifier
     * @returns {Promise<Array<Entitlement>>} Array of Entitlments
     */
    static retrieveEntitlements(entitlementsRequest: EntitlementsRequest): Promise<Array<Entitlement>>;
}
//# sourceMappingURL=Chargebee.d.ts.map