Typescript definitions for Apple API services. 

jeremy.barbet

@jeremybarbet/apple-api-types

 * Interfaces extracted from the Apple documentation

 * @link https://developer.apple.com/documentation/appstorereceipts

import { Environment } from './global.interface';

export declare const internalDataAccessErrors: number[];

     * The appAccountToken associated with this transaction. This field is only present if your app supplied an appAccountToken(_: ) or provided a UUID for the applicationUsername property when the user made the purchase.

     * The time the App Store refunded a transaction or revoked it from family sharing, in a date-time format similar to the ISO 8601. This field is present only for refunded or revoked transactions.

     * The time the App Store refunded a transaction or revoked it from family sharing, in UNIX epoch time format, in milliseconds. This field is present only for refunded or revoked transactions. Use this time format for processing dates.

     * The time the App Store refunded a transaction or revoked it from family sharing, in Pacific Standard Time. This field is present only for refunded or revoked transactions.

     * The reason for a refunded or revoked transaction. A value of 1 indicates that the customer canceled their transaction due to an actual or perceived issue within your app. A value of 0 indicates that the transaction was canceled for another reason; for example, if the customer made the purchase accidentally.

     * The time a subscription expires or when it will renew, in a date-time format similar to the ISO 8601.

     * The time a subscription expires or when it will renew, in UNIX epoch time format, in milliseconds. Use this time format for processing dates.

     * The time a subscription expires or when it will renew, in Pacific Standard Time.

     * A value that indicates whether the user is the purchaser of the product or is a family member with access to the product through Family Sharing.

    in_app_ownership_type: 'FAMILY_SHARED' | 'PURCHASED';

     * An indicator of whether an auto-renewable subscription is in the introductory price period. See is_in_intro_offer_period for more information.

    is_in_intro_offer_period: 'true' | 'false';

     * An indicator of whether a subscription is in the free trial period.

     * An indicator that a subscription has been canceled due to an upgrade. This field is only present for upgrade transactions.

     * The reference name of a subscription offer that you configured in App Store Connect. This field is present when a customer redeems a subscription offer code. For more information about offer codes, see Set Up Offer Codes, and Implementing Offer Codes in Your App.

     * The time of the original app purchase, in a date-time format similar to ISO 8601.

     * The time of the original app purchase, in UNIX epoch time format, in milliseconds. Use this time format for processing dates. For an auto-renewable subscription, this value indicates the date of the subscription’s initial purchase. The original purchase date applies to all product types and remains the same in all transactions for the same product ID. This value corresponds to the original transaction’s transactionDate property in StoreKit.

     * The time of the original app purchase, in Pacific Standard Time.

     * The transaction identifier of the original purchase.

     * The unique identifier of the product purchased. You provide this value when creating the product in App Store Connect, and it corresponds to the productIdentifier property of the SKPayment object stored in the transaction’s payment property.

     * The identifier of the subscription offer redeemed by the user.

     * The time the App Store charged the user’s account for a purchased or restored product, or the time the App Store charged the user’s account for a subscription purchase or renewal after a lapse, in a date-time format similar to ISO 8601.

Object.defineProperty(exports, "__esModule", { value: true });

exports.internalDataAccessErrors = exports.errors = exports.successes = void 0;

    21000: 'The request to the App Store was not made using the HTTP POST request method.',

    21001: 'This status code is no longer sent by the App Store.',

    21002: 'The data in the receipt-data property was malformed or the service experienced a temporary issue. Try again.',

    21003: 'The receipt could not be authenticated.',

    21004: 'The shared secret you provided does not match the shared secret on file for your account.',

    21005: 'The receipt server was temporarily unable to provide the receipt. Try again.',

    21006: `This receipt is valid but the subscription has expired. When this status code is returned to your server, the receipt data is also decoded and returned as part of the response. Only returned for iOS 6-style transaction receipts for auto-renewable subscriptions.`,

    21007: 'This receipt is from the test environment, but it was sent to the production environment for verification.',

    21008: 'This receipt is from the production environment, but it was sent to the test environment for verification.',

    21009: 'Internal data access error. Try again later.',

    21010: 'The user account cannot be found or has been deleted.',

exports.internalDataAccessErrors = [21100, 21199];

 * @link https://developer.apple.com/documentation/appstoreserverapi

import { AutoRenewStatus, ExpirationIntent, InAppOwnershipType, NotificationSubtype, NotificationType, OfferType, PriceIncreaseStatus, SubscriptionStatus, Type } from './app-store-server.enum';

 * @link https://developer.apple.com/documentation/appstoreserverapi/jwsdecodedheader

     * The algorithm used for signing the JSON Web Signature (JWS).

     * The X.509 certificate chain that corresponds to the key that the App Store used to secure the JWS.

 * @link https://developer.apple.com/documentation/appstoreserverapi/jwsrenewalinfo

export declare type JWSTransaction = string;

export declare type JWSRenewalInfo = string;

 * @link https://developer.apple.com/documentation/appstoreservernotifications/data

     * The unique identifier of the app that the notification applies to.This property is available for apps that are downloaded from the App Store; it isn’t present in the sandbox environment.

     * The version of the build that identifies an iteration of the bundle.

     * The server environment that the notification applies to, either sandbox or production.

     * Subscription renewal information signed by the App Store, in JSON Web Signature format.

     * Transaction information signed by the App Store, in JSON Web Signature format.

    signedTransactionInfo: JWSTransaction;

 * @link https://developer.apple.com/documentation/appstoreservernotifications/responsebodyv2decodedpayload

export interface ResponseBodyV2DecodedPayload {

     * The in-app purchase event for which the App Store sent this version 2 notification.

     * https://developer.apple.com/documentation/appstoreservernotifications/notificationtype

     * Additional information that identifies the notification event, or an empty string. The subtype applies only to select version 2 notifications.

     * https://developer.apple.com/documentation/appstoreservernotifications/subtype

     * A unique identifier for the notification. Use this value to identify a duplicate notification.

     * The object that contains the app metadata and signed renewal and transaction information.

     * A string that indicates the App Store Server Notification version number.

     * The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature data.

 * @link https://developer.apple.com/documentation/appstoreserverapi/jwstransactiondecodedpayload

export interface JWSTransactionDecodedPayload {

     * The UUID you created to identify the user’s in-app account when they made the purchase. If your app doesn’t provide an appAccountToken, this string is empty. For more information, see appAccountToken(_:).

     * The server environment, either sandbox or production.

  "name": "@jeremybarbet/apple-api-types",

  "description": "Typescript definitions for Apple API services.",

  "repository": "git@github.com/jeremybarbet/iap.git",

  "author": "Jérémy Barbet <jeremgraph@gmail.com>",

    "lint:tsc": "yarn tsc -p tsconfig.json --noEmit --skipLibCheck"

  "gitHead": "8565ff8418701e486147137c9f9bacf307a19c82"

  "gitHead": "f30ab6cfed448e174b2113c4092c56d32eb97787"