iap-apple/lib/shared/index.d.ts

Integration with Apples InAppPurchases in Typescript, available for NodeJS environments.

import { IIAPAppleConfig, IVerifyReceiptResponseBody, PurchasedItem } from '../../types';
/**
 * It takes a receipt data and a config object, and returns a promise that resolves to a validated receipt object or
 * rejects with an error
 * @param {string} receipt - The receipt data.
 * @param {IIAPAppleConfig} config - IIAPAppleConfig
 * @returns a promise.
 */
export declare function verify(receipt: string, config: IIAPAppleConfig): Promise<IVerifyReceiptResponseBody>;
/**
 * It checks if the receipt is valid.
 * @param {IVerifyReceiptResponseBody | null} verifyReceiptResponse - IVerifyReceiptResponseBody | null
 * @returns A boolean
 */
export declare const isVerifiedReceipt: (verifyReceiptResponse: IVerifyReceiptResponseBody | null) => boolean;
/**
 * If the purchased item has been cancelled or if the expiration date has passed, then it has expired
 * @param {PurchasedItem | null} purchasedItem - PurchasedItem | null
 * @returns A boolean
 */
export declare const isPurchasedItemExpired: (purchasedItem: PurchasedItem | null) => boolean;
/**
 * If the purchased item has a cancellation date, then it's canceled.
 * @param {PurchasedItem} purchasedItem - PurchasedItem - this is the purchased item object that you get from the
 * getPurchasedItems() method.
 * @returns A boolean value.
 */
export declare const isPurchasedItemCanceled: (purchasedItem: PurchasedItem) => boolean;
/**
 * It takes a response from the Apple App Store and returns an array of PurchasedItem objects sorted by their purchase date in descending order,
 * the latest purchase comes first.
 * @param {IVerifyReceiptResponseBody | null} verifyReceiptResponse - IVerifyReceiptResponseBody | null
 * @returns An array of PurchasedItem objects.
 */
export declare const getPurchasedItems: (verifyReceiptResponse: IVerifyReceiptResponseBody | null) => PurchasedItem[];