app-store-server-api/dist/types/Models.d.ts

A client for the App Store Server API

/**
 * https://developer.apple.com/documentation/appstoreserverapi/environment
 */
export declare enum Environment {
    Production = "Production",
    Sandbox = "Sandbox"
}
/**
 * UNIX timestamp in milliseconds
 */
export type Timestamp = number;
/**
 * ISO 3166-1 Alpha-3 country code
 * https://developer.apple.com/documentation/appstoreservernotifications/storefrontcountrycode
 */
export type StorefrontCountryCode = string;
export declare enum SortParameter {
    Ascending = "ASCENDING",
    Descending = "DESCENDING"
}
export declare enum ProductTypeParameter {
    AutoRenewable = "AUTO_RENEWABLE",
    NonRenewable = "NON_RENEWABLE",
    Consumable = "CONSUMABLE",
    NonConsumable = "NON_CONSUMABLE"
}
/**
 * The query parameters that can be passed to the history endpoint
 * to filter results and change sort order.
 * https://developer.apple.com/documentation/appstoreserverapi/get_transaction_history
 */
export interface TransactionHistoryQuery {
    revision?: string;
    sort?: SortParameter;
    startDate?: Timestamp;
    endDate?: Timestamp;
    productType?: ProductTypeParameter;
    productId?: string;
    subscriptionGroupIdentifier?: string;
    inAppOwnershipType?: OwnershipType;
    /** @deprecated */
    revoked?: boolean;
}
export declare enum TransactionHistoryVersion {
    /** @deprecated */
    v1 = "v1",
    v2 = "v2"
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/historyresponse
 */
export interface HistoryResponse {
    appAppleId: string;
    bundleId: string;
    environment: Environment;
    hasMore: boolean;
    revision: string;
    signedTransactions: JWSTransaction[];
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/transactioninforesponse
 */
export interface TransactionInfoResponse {
    signedTransactionInfo: JWSTransaction;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/jwstransaction
 */
export type JWSTransaction = string;
/**
 * https://developer.apple.com/documentation/appstoreserverapi/jwsdecodedheader
 */
export interface JWSDecodedHeader {
    alg: string;
    kid: string;
    x5c: string[];
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/jwstransactiondecodedpayload
 */
export interface JWSTransactionDecodedPayload {
    appAccountToken?: string;
    appTransactionId?: string;
    bundleId: string;
    currency: string;
    environment: Environment;
    expiresDate?: Timestamp;
    inAppOwnershipType: OwnershipType;
    isUpgraded?: boolean;
    offerDiscountType?: OfferDiscountType;
    offerIdentifier?: string;
    offerPeriod?: string;
    offerType?: OfferType;
    originalPurchaseDate: Timestamp;
    originalTransactionId: string;
    price: number;
    productId: string;
    purchaseDate: Timestamp;
    quantity: number;
    revocationDate?: Timestamp;
    revocationReason?: number;
    signedDate: Timestamp;
    storefront: StorefrontCountryCode;
    storefrontId: string;
    subscriptionGroupIdentifier?: string;
    transactionId: string;
    transactionReason: TransactionReason;
    type: TransactionType;
    webOrderLineItemId: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/offerdiscounttype
 */
export declare enum OfferDiscountType {
    FreeTrial = "FREE_TRIAL",
    PayAsYouGo = "PAY_AS_YOU_GO",
    PayUpFront = "PAY_UP_FRONT"
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/inappownershiptype
 */
export declare enum OwnershipType {
    Purchased = "PURCHASED",
    FamilyShared = "FAMILY_SHARED"
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/type
 */
export declare enum TransactionType {
    AutoRenewableSubscription = "Auto-Renewable Subscription",
    NonConsumable = "Non-Consumable",
    Consumable = "Consumable",
    NonRenewingSubscription = "Non-Renewing Subscription"
}
/**
 * https://developer.apple.com/documentation/appstoreservernotifications/transactionreason
 */
export declare enum TransactionReason {
    Purchase = "PURCHASE",
    Renewal = "RENEWAL"
}
export interface SubscriptionStatusesQuery {
    status?: SubscriptionStatus[];
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/statusresponse
 */
export interface StatusResponse {
    data: SubscriptionGroupIdentifierItem[];
    environment: Environment;
    appAppleId: string;
    bundleId: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/subscriptiongroupidentifieritem
 */
export interface SubscriptionGroupIdentifierItem {
    subscriptionGroupIdentifier: string;
    lastTransactions: LastTransactionsItem[];
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/lasttransactionsitem
 */
export interface LastTransactionsItem {
    originalTransactionId: string;
    status: SubscriptionStatus;
    signedRenewalInfo: JWSRenewalInfo;
    signedTransactionInfo: JWSTransaction;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/jwsrenewalinfo
 */
export type JWSRenewalInfo = string;
/**
 * https://developer.apple.com/documentation/appstoreserverapi/status
 */
export declare enum SubscriptionStatus {
    Active = 1,
    Expired = 2,
    InBillingRetry = 3,
    InBillingGracePeriod = 4,
    Revoked = 5
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/jwsrenewalinfodecodedpayload
 */
export interface JWSRenewalInfoDecodedPayload {
    appAccountToken?: string;
    appTransactionId?: string;
    autoRenewProductId: string;
    autoRenewStatus: AutoRenewStatus;
    environment: Environment;
    expirationIntent?: ExpirationIntent;
    gracePeriodExpiresDate?: Timestamp;
    isInBillingRetryPeriod?: boolean;
    offerIdentifier?: string;
    offerPeriod?: string;
    offerType?: OfferType;
    originalTransactionId: string;
    priceIncreaseStatus?: PriceIncreaseStatus;
    productId: string;
    recentSubscriptionStartDate: Timestamp;
    renewalDate: Timestamp;
    currency?: string;
    renewalPrice?: number;
    offerDiscountType?: OfferDiscountType;
    eligibleWinBackOfferIds?: string[];
    signedDate: Timestamp;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/autorenewstatus
 */
export declare enum AutoRenewStatus {
    Off = 0,
    On = 1
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/expirationintent
 */
export declare enum ExpirationIntent {
    Canceled = 1,
    BillingError = 2,
    RejectedPriceIncrease = 3,
    ProductUnavailable = 4
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/offertype
 */
export declare enum OfferType {
    Introductory = 1,
    Promotional = 2,
    SubscriptionOfferCode = 3,
    WinBackOffer = 4
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/priceincreasestatus
 */
export declare enum PriceIncreaseStatus {
    NoResponse = 0,
    Consented = 1
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/orderlookupresponse
 */
export interface OrderLookupResponse {
    status: OrderLookupStatus;
    signedTransactions: JWSTransaction[];
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/orderlookupstatus
 */
export declare enum OrderLookupStatus {
    Valid = 0,
    Invalid = 1
}
/**
 * https://developer.apple.com/documentation/appstoreservernotifications/responsebodyv2decodedpayload
 */
interface DecodedNotificationBasePayload {
    notificationType: NotificationType;
    subtype?: NotificationSubtype;
    notificationUUID: string;
    version: string;
    signedDate: Timestamp;
}
export interface DecodedNotificationDataPayload extends DecodedNotificationBasePayload {
    data: NotificationData;
    summary?: never;
}
export interface DecodedNotificationSummaryPayload extends DecodedNotificationBasePayload {
    data?: never;
    summary: NotificationSummary;
}
export type DecodedNotificationPayload = DecodedNotificationDataPayload | DecodedNotificationSummaryPayload;
export declare function isDecodedNotificationDataPayload(decodedNotificationPayload: DecodedNotificationPayload): decodedNotificationPayload is DecodedNotificationDataPayload;
export declare function isDecodedNotificationSummaryPayload(decodedNotificationPayload: DecodedNotificationPayload): decodedNotificationPayload is DecodedNotificationSummaryPayload;
/**
 * https://developer.apple.com/documentation/appstoreservernotifications/data
 */
export interface NotificationData {
    appAppleId: number;
    bundleId: string;
    bundleVersion: string;
    environment: Environment;
    signedRenewalInfo?: JWSRenewalInfo;
    signedTransactionInfo: JWSTransaction;
    status?: SubscriptionStatus;
}
/**
 * https://developer.apple.com/documentation/appstoreservernotifications/summary
 */
export interface NotificationSummary {
    requestIdentifier: string;
    environment: Environment;
    appAppleId: string;
    bundleId: string;
    productId: string;
    storefrontCountryCodes?: StorefrontCountryCode[];
    failedCount: number;
    succeededCount: number;
}
/**
 * https://developer.apple.com/documentation/appstoreservernotifications/notificationtype
 */
export declare enum NotificationType {
    ConsumptionRequest = "CONSUMPTION_REQUEST",
    DidChangeRenewalPref = "DID_CHANGE_RENEWAL_PREF",
    DidChangeRenewalStatus = "DID_CHANGE_RENEWAL_STATUS",
    DidFailToRenew = "DID_FAIL_TO_RENEW",
    DidRenew = "DID_RENEW",
    Expired = "EXPIRED",
    ExternalPurchaseToken = "EXTERNAL_PURCHASE_TOKEN",
    GracePeriodExpired = "GRACE_PERIOD_EXPIRED",
    OfferRedeemed = "OFFER_REDEEMED",
    OneTimeCharge = "ONE_TIME_CHARGE",
    PriceIncrease = "PRICE_INCREASE",
    Refund = "REFUND",
    RefundDeclined = "REFUND_DECLINED",
    RefundReversed = "REFUND_REVERSED",
    RenewalExtended = "RENEWAL_EXTENDED",
    RenewalExtension = "RENEWAL_EXTENSION",
    Revoke = "REVOKE",
    Subscribed = "SUBSCRIBED",
    Test = "TEST"
}
/**
 * https://developer.apple.com/documentation/appstoreservernotifications/subtype
 */
export declare enum NotificationSubtype {
    InitialBuy = "INITIAL_BUY",
    Resubscribe = "RESUBSCRIBE",
    Downgrade = "DOWNGRADE",
    Upgrade = "UPGRADE",
    AutoRenewEnabled = "AUTO_RENEW_ENABLED",
    AutoRenewDisabled = "AUTO_RENEW_DISABLED",
    Voluntary = "VOLUNTARY",
    BillingRetry = "BILLING_RETRY",
    PriceIncrease = "PRICE_INCREASE",
    ProductNotForSale = "PRODUCT_NOT_FOR_SALE",
    GracePeriod = "GRACE_PERIOD",
    BillingRecovery = "BILLING_RECOVERY",
    Pending = "PENDING",
    Accepted = "ACCEPTED",
    Summary = "SUMMARY",
    Failure = "FAILURE"
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/sendtestnotificationresponse
 */
export interface SendTestNotificationResponse {
    testNotificationToken: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/checktestnotificationresponse
 */
export interface CheckTestNotificationResponse {
    sendAttempts: SendAttempt[];
    signedPayload: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/sendattemptitem
 */
export interface SendAttempt {
    attemptDate: Timestamp;
    sendAttemptResult: SendAttemptResult;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/sendattemptresult
 */
export declare enum SendAttemptResult {
    Success = "SUCCESS",
    TimedOut = "TIMED_OUT",
    TlsIssue = "TLS_ISSUE",
    CircularRedirect = "CIRCULAR_REDIRECT",
    NoResponse = "NO_RESPONSE",
    SocketIssue = "SOCKET_ISSUE",
    UnsupportedCharset = "UNSUPPORTED_CHARSET",
    InvalidResponse = "INVALID_RESPONSE",
    PrematureClose = "PREMATURE_CLOSE",
    Other = "OTHER"
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/get_notification_history
 */
export interface NotificationHistoryQuery {
    paginationToken?: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/notificationhistoryrequest
 */
export interface NotificationHistoryRequest {
    startDate: Timestamp;
    endDate: Timestamp;
    notificationType?: NotificationType;
    notificationSubtype?: NotificationSubtype;
    onlyFailures?: boolean;
    transactionId?: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/notificationhistoryresponse
 */
export interface NotificationHistoryResponse {
    notificationHistory: NotificationHistoryResponseItem[];
    hasMore: boolean;
    paginationToken: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/notificationhistoryresponseitem
 */
export interface NotificationHistoryResponseItem {
    sendAttempts: SendAttempt[];
    signedPayload: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/extendreasoncode
 */
export declare enum ExtendReasonCode {
    UNDECLARED = 0,
    CUSTOMER_SATISFACTION = 1,
    OTHER_REASON = 2,
    SERVICE_ISSUE = 3
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/extendrenewaldaterequest
 */
export interface ExtendRenewalDateRequest {
    extendByDays: number;
    extendReasonCode: ExtendReasonCode;
    requestIdentifier: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/extendrenewaldateresponse
 */
export interface ExtendRenewalDateResponse {
    effectiveDate: Timestamp;
    originalTransactionId: string;
    success: boolean;
    webOrderLineItemId: string;
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/accounttenure
 */
export declare enum AccountTenure {
    Undeclared = 0,
    Between0_3Days = 1,
    Between3_10Days = 2,
    Between10_30Days = 3,
    Between30_90Days = 4,
    Between90_180Days = 5,
    Between180_365Days = 6,
    Over365Days = 7
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/consumptionstatus
 */
export declare enum ConsumptionStatus {
    Undeclared = 0,
    NotConsumed = 1,
    PartiallyConsumed = 2,
    FullyConsumed = 3
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/deliverystatus
 */
export declare enum DeliveryStatus {
    DeliveredAndWorkingProperly = 0,
    DidntDeliverDueToQualityIssue = 1,
    DeliveredWrongItem = 2,
    DidntDeliverDueToServerOutage = 3,
    DidntDeliverDueToInGameCurrencyChange = 4,
    DidntDeliverDueToOtherReason = 5
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/lifetimedollarspurchased
 */
export declare enum LifetimeDollarsPurchased {
    Undeclared = 0,
    ZeroUSD = 1,
    Between_0_01_And_49_99USD = 2,
    Between_50_And_99_99USD = 3,
    Between_100_And_499_99USD = 4,
    Between_500_And_999_99USD = 5,
    Between_1000_And_1999_99USD = 6,
    Over_2000USD = 7
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/lifetimedollarsrefunded
 */
export declare enum LifetimeDollarsRefunded {
    Undeclared = 0,
    ZeroUSD = 1,
    Between_0_01_And_49_99USD = 2,
    Between_50_And_99_99USD = 3,
    Between_100_And_499_99USD = 4,
    Between_500_And_999_99USD = 5,
    Between_1000_And_1999_99USD = 6,
    Over_2000USD = 7
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/platform
 */
export declare enum Platform {
    Undeclared = 0,
    Apple = 1,
    NonApple = 2
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/playtime
 */
export declare enum PlayTime {
    Undeclared = 0,
    Between0_5Minutes = 1,
    Between5_60Minutes = 2,
    Between1_6Hours = 3,
    Between6_24Hours = 4,
    Between1_4Days = 5,
    Between4_16Days = 6,
    Over16Days = 7
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/refundpreference
 */
export declare enum RefundPreference {
    Undeclared = 0,
    PreferAppleGrantsRefund = 1,
    PreferAppleDeclinesRefund = 2,
    NoPreference = 3
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/userstatus
 */
export declare enum UserStatus {
    Undeclared = 0,
    AccountIsActive = 1,
    AccountIsSuspended = 2,
    AccountIsTerminated = 3,
    AccountHasLimitedAccess = 4
}
/**
 * https://developer.apple.com/documentation/appstoreserverapi/consumptionrequest
 */
export interface ConsumptionRequest {
    accountTenure: AccountTenure;
    appAccountToken: string;
    consumptionStatus: ConsumptionStatus;
    customerConsented: boolean;
    deliveryStatus: DeliveryStatus;
    lifetimeDollarsPurchased: LifetimeDollarsPurchased;
    lifetimeDollarsRefunded: LifetimeDollarsRefunded;
    platform: Platform;
    playTime: PlayTime;
    refundPreference?: RefundPreference;
    sampleContentProvided: boolean;
    userStatus: UserStatus;
}
export {};