purchases-ios/Sources/Generated/ErrorCode.swift

// @generated
//
//  Copyright RevenueCat Inc. All Rights Reserved.
//
//  Licensed under the MIT License (the "License");
//  you may not use this file except in compliance with the License.
//  You may obtain a copy of the License at
//
//      https://opensource.org/licenses/MIT
//
//  ErrorCode.swift — DO NOT EDIT — generated from https://github.com/RevenueCat/purchases-error-codes
//
// swiftlint:disable line_length missing_docs

import Foundation

@objc(RCPurchasesErrorCode) public enum ErrorCode: Int, Error {
    @objc(RCUnknownError) case unknownError = 0
    @objc(RCPurchaseCancelledError) case purchaseCancelledError = 1
    @objc(RCStoreProblemError) case storeProblemError = 2
    @objc(RCPurchaseNotAllowedError) case purchaseNotAllowedError = 3
    @objc(RCPurchaseInvalidError) case purchaseInvalidError = 4
    @objc(RCProductNotAvailableForPurchaseError) case productNotAvailableForPurchaseError = 5
    @objc(RCProductAlreadyPurchasedError) case productAlreadyPurchasedError = 6
    @objc(RCReceiptAlreadyInUseError) case receiptAlreadyInUseError = 7
    @objc(RCInvalidReceiptError) case invalidReceiptError = 8
    @objc(RCMissingReceiptFileError) case missingReceiptFileError = 9
    @objc(RCNetworkError) case networkError = 10
    @objc(RCInvalidCredentialsError) case invalidCredentialsError = 11
    @objc(RCUnexpectedBackendResponseError) case unexpectedBackendResponseError = 12
    @objc(RCReceiptInUseByOtherSubscriberError) case receiptInUseByOtherSubscriberError = 13
    @objc(RCInvalidAppUserIdError) case invalidAppUserIdError = 14
    @objc(RCOperationAlreadyInProgressForProductError) case operationAlreadyInProgressForProductError = 15
    @objc(RCUnknownBackendError) case unknownBackendError = 16
    @objc(RCInvalidAppleSubscriptionKeyError) case invalidAppleSubscriptionKeyError = 17
    @objc(RCIneligibleError) case ineligibleError = 18
    @objc(RCInsufficientPermissionsError) case insufficientPermissionsError = 19
    @objc(RCPaymentPendingError) case paymentPendingError = 20
    @objc(RCInvalidSubscriberAttributesError) case invalidSubscriberAttributesError = 21
    @objc(RCLogOutAnonymousUserError) case logOutAnonymousUserError = 22
    @objc(RCConfigurationError) case configurationError = 23
    @objc(RCUnsupportedError) case unsupportedError = 24
    @objc(RCEmptySubscriberAttributesError) case emptySubscriberAttributes = 25
    @objc(RCProductDiscountMissingIdentifierError) case productDiscountMissingIdentifierError = 26
    @objc(RCProductDiscountMissingSubscriptionGroupIdentifierError) case productDiscountMissingSubscriptionGroupIdentifierError = 28
    @objc(RCCustomerInfoError) case customerInfoError = 29
    @objc(RCSystemInfoError) case systemInfoError = 30
    @objc(RCBeginRefundRequestError) case beginRefundRequestError = 31
    @objc(RCProductRequestTimedOut) case productRequestTimedOut = 32
    @objc(RCAPIEndpointBlocked) case apiEndpointBlockedError = 33
    @objc(RCInvalidPromotionalOfferError) case invalidPromotionalOfferError = 34
    @objc(RCOfflineConnectionError) case offlineConnectionError = 35
    @objc(RCFeatureNotAvailableInCustomEntitlementsComputationMode) case featureNotAvailableInCustomEntitlementsComputationMode = 36
    @objc(RCSignatureVerificationFailed) case signatureVerificationFailed = 37
    @objc(RCFeatureNotSupportedWithStoreKit1) case featureNotSupportedWithStoreKit1 = 38
    @objc(RCInvalidWebPurchaseToken) case invalidWebPurchaseToken = 39
    @objc(RCPurchaseBelongsToOtherUser) case purchaseBelongsToOtherUser = 40
    @objc(RCExpiredWebPurchaseToken) case expiredWebPurchaseToken = 41
    @objc(RCTestStoreSimulatedPurchaseError) case testStoreSimulatedPurchaseError = 42
}

extension ErrorCode: CaseIterable {}

extension ErrorCode: CustomStringConvertible {
    public var description: String {
        switch self {
        case .unknownError:
            return "Unknown error."
        case .purchaseCancelledError:
            return "Purchase was cancelled."
        case .storeProblemError:
        #if os(macOS) || targetEnvironment(macCatalyst)
            return "There was a problem with the App Store. This could also indicate the purchase dialog was cancelled."
        #else
            return "There was a problem with the App Store."
        #endif
        case .purchaseNotAllowedError:
            return "The device or user is not allowed to make the purchase."
        case .purchaseInvalidError:
            return "One or more of the arguments provided are invalid."
        case .productNotAvailableForPurchaseError:
            return "The product is not available for purchase."
        case .productAlreadyPurchasedError:
            return "This product is already active for the user."
        case .receiptAlreadyInUseError:
            return "There is already another active subscriber using the same receipt."
        case .invalidReceiptError:
            return "The receipt is not valid."
        case .missingReceiptFileError:
            return "The receipt is missing."
        case .networkError:
            return "A network error has occurred."
        case .invalidCredentialsError:
            return "There was a credentials issue. Check the underlying error for more details."
        case .unexpectedBackendResponseError:
            return "Received malformed response from the backend."
        case .receiptInUseByOtherSubscriberError:
            return "The receipt is in use by another subscriber."
        case .invalidAppUserIdError:
            return "The app user ID is not valid."
        case .operationAlreadyInProgressForProductError:
            return "The operation is already in progress for this product."
        case .unknownBackendError:
            return "There was an unknown backend error."
        case .invalidAppleSubscriptionKeyError:
            return "Apple In-App Purchase Key is invalid or not present. You must configure an In-App Purchase Key.\nPlease see https://rev.cat/in-app-purchase-key-configuration for more info."
        case .ineligibleError:
            return "The User is ineligible for that action."
        case .insufficientPermissionsError:
            return "App does not have sufficient permissions to make purchases."
        case .paymentPendingError:
            return "The payment is pending."
        case .invalidSubscriberAttributesError:
            return "One or more of the attributes sent could not be saved."
        case .logOutAnonymousUserError:
            return "LogOut was called but the current user is anonymous."
        case .configurationError:
            return "There is an issue with your configuration. Check the underlying error for more details.\nMore information: https://rev.cat/sdk-troubleshooting"
        case .unsupportedError:
            return "There was a problem with the operation. Looks like we don't support that yet. Check the underlying error for more details."
        case .emptySubscriberAttributes:
            return "A request for subscriber attributes returned none."
        case .productDiscountMissingIdentifierError:
            return "The SKProductDiscount or Product.SubscriptionOffer wrapped by StoreProductDiscount is missing an identifier. This is a required property and likely an AppStore quirk that it is missing."
        case .productDiscountMissingSubscriptionGroupIdentifierError:
            return "Unable to create a discount offer, the product is missing a subscriptionGroupIdentifier."
        case .customerInfoError:
            return "There was a problem related to the customer info."
        case .systemInfoError:
            return "There was a problem related to the system info."
        case .beginRefundRequestError:
            return "Error when trying to begin refund request."
        case .productRequestTimedOut:
            return "SKProductsRequest took too long to complete."
        case .apiEndpointBlockedError:
            return "Requests to RevenueCat are being blocked. See: https://rev.cat/dnsBlocking for more info."
        case .invalidPromotionalOfferError:
            return "The information associated with this PromotionalOffer is not valid. See https://rev.cat/ios-subscription-offers for more info."
        case .offlineConnectionError:
            return "Error performing request because the internet connection appears to be offline."
        case .featureNotAvailableInCustomEntitlementsComputationMode:
            return "This feature is not available when utilizing the customEntitlementsComputation dangerousSetting."
        case .signatureVerificationFailed:
            return "Request failed signature verification. Please see https://rev.cat/trusted-entitlements for more info."
        case .featureNotSupportedWithStoreKit1:
            return "This feature is not supported when using StoreKit 1. Configure the SDK to use StoreKit 2 to use this feature."
        case .invalidWebPurchaseToken:
            return "The link you provided does not contain a valid purchase token."
        case .purchaseBelongsToOtherUser:
            return "The web purchase already belongs to another user."
        case .expiredWebPurchaseToken:
            return "The link you provided has expired. A new one will be sent to the email used to make the purchase."
        case .testStoreSimulatedPurchaseError:
            return "Purchase failure simulated successfully in Test Store."
        }
    }
}

extension ErrorCode {
    var codeName: String {
        switch self {
        case .unknownError:
            return "UNKNOWN"
        case .purchaseCancelledError:
            return "PURCHASE_CANCELLED"
        case .storeProblemError:
            return "STORE_PROBLEM"
        case .purchaseNotAllowedError:
            return "PURCHASE_NOT_ALLOWED"
        case .purchaseInvalidError:
            return "PURCHASE_INVALID"
        case .productNotAvailableForPurchaseError:
            return "PRODUCT_NOT_AVAILABLE_FOR_PURCHASE"
        case .productAlreadyPurchasedError:
            return "PRODUCT_ALREADY_PURCHASED"
        case .receiptAlreadyInUseError:
            return "RECEIPT_ALREADY_IN_USE"
        case .invalidReceiptError:
            return "INVALID_RECEIPT"
        case .missingReceiptFileError:
            return "MISSING_RECEIPT_FILE"
        case .networkError:
            return "NETWORK_ERROR"
        case .invalidCredentialsError:
            return "INVALID_CREDENTIALS"
        case .unexpectedBackendResponseError:
            return "UNEXPECTED_BACKEND_RESPONSE_ERROR"
        case .receiptInUseByOtherSubscriberError:
            return "RECEIPT_IN_USE_BY_OTHER_SUBSCRIBER"
        case .invalidAppUserIdError:
            return "INVALID_APP_USER_ID"
        case .operationAlreadyInProgressForProductError:
            return "OPERATION_ALREADY_IN_PROGRESS_FOR_PRODUCT_ERROR"
        case .unknownBackendError:
            return "UNKNOWN_BACKEND_ERROR"
        case .invalidAppleSubscriptionKeyError:
            return "INVALID_APPLE_SUBSCRIPTION_KEY"
        case .ineligibleError:
            return "INELIGIBLE_ERROR"
        case .insufficientPermissionsError:
            return "INSUFFICIENT_PERMISSIONS_ERROR"
        case .paymentPendingError:
            return "PAYMENT_PENDING_ERROR"
        case .invalidSubscriberAttributesError:
            return "INVALID_SUBSCRIBER_ATTRIBUTES"
        case .logOutAnonymousUserError:
            return "LOGOUT_CALLED_WITH_ANONYMOUS_USER"
        case .configurationError:
            return "CONFIGURATION_ERROR"
        case .unsupportedError:
            return "UNSUPPORTED_ERROR"
        case .emptySubscriberAttributes:
            return "EMPTY_SUBSCRIBER_ATTRIBUTES"
        case .productDiscountMissingIdentifierError:
            return "PRODUCT_DISCOUNT_MISSING_IDENTIFIER_ERROR"
        case .productDiscountMissingSubscriptionGroupIdentifierError:
            return "PRODUCT_DISCOUNT_MISSING_SUBSCRIPTION_GROUP_IDENTIFIER_ERROR"
        case .customerInfoError:
            return "CUSTOMER_INFO_ERROR"
        case .systemInfoError:
            return "SYSTEM_INFO_ERROR"
        case .beginRefundRequestError:
            return "BEGIN_REFUND_REQUEST_ERROR"
        case .productRequestTimedOut:
            return "PRODUCT_REQUEST_TIMED_OUT_ERROR"
        case .apiEndpointBlockedError:
            return "API_ENDPOINT_BLOCKED_ERROR"
        case .invalidPromotionalOfferError:
            return "INVALID_PROMOTIONAL_OFFER_ERROR"
        case .offlineConnectionError:
            return "OFFLINE_CONNECTION_ERROR"
        case .featureNotAvailableInCustomEntitlementsComputationMode:
            return "FEATURE_NOT_AVAILABLE_IN_CUSTOM_ENTITLEMENTS_COMPUTATION_MODE_ERROR"
        case .signatureVerificationFailed:
            return "SIGNATURE_VERIFICATION_FAILED"
        case .featureNotSupportedWithStoreKit1:
            return "FEATURE_NOT_SUPPORTED_WITH_STOREKIT1"
        case .invalidWebPurchaseToken:
            return "INVALID_WEB_PURCHASE_TOKEN"
        case .purchaseBelongsToOtherUser:
            return "ALREADY_REDEEMED_WEB_PURCHASE_TOKEN"
        case .expiredWebPurchaseToken:
            return "EXPIRED_WEB_PURCHASE_TOKEN"
        case .testStoreSimulatedPurchaseError:
            return "TEST_STORE_SIMULATED_PURCHASE_ERROR"
        }
    }
}

extension ErrorCode: CustomNSError {

    // swiftlint:disable:next missing_docs
    public var errorUserInfo: [String: Any] {
        return [
            NSDebugDescriptionErrorKey: self.description,
            "rc_code_name": self.codeName
        ]
    }

}