#import <Foundation/Foundation.h>

NS_ASSUME_NONNULL_BEGIN

/**
 @class BTPaymentMethodNonce
 @brief BTPaymentMethodNonce is for generic tokenized payment information.

 @discussion For example, if a customer's vaulted payment methods contains a type that's not recognized or supported by the
 Braintree SDK or the client-side integration (e.g. the vault contains a PayPal account but the client-side
 integration does not include the PayPal component), this type can act as a fallback.

 The payment method nonce is a public token that acts as a placeholder for sensitive payments data that
 has been uploaded to Braintree for subsequent processing. The nonce is safe to access on the client and can be
 used on your server to reference the data in Braintree operations, such as Transaction.sale.
*/
@interface BTPaymentMethodNonce : NSObject

/**
 @brief Initialize a new Payment Method Nonce.

 @param nonce       A transactable payment method nonce.
 @param description A human-readable description.
 @param type        A string identifying the type of the payment method.
 @return A Payment Method Nonce, or `nil` if nonce is nil.
*/
- (nullable instancetype)initWithNonce:(NSString *)nonce localizedDescription:(nullable NSString *)description type:(NSString *)type;

/**
 @brief Initialize a new Payment Method Nonce.

 @param nonce       A transactable payment method nonce.
 @param description A human-readable description.
 @return A Payment Method Nonce, or `nil` if nonce is nil.
*/
- (nullable instancetype)initWithNonce:(NSString *)nonce localizedDescription:(nullable NSString *)description;

/**
 @brief Initialize a new Payment Method Nonce.

 @param nonce       A transactable payment method nonce.
 @param description A human-readable description.
 @param type        A string identifying the type of the payment method.
 @param isDefault   A boolean indicating whether this is a default payment method.
 @return A Payment Method Nonce, or `nil` if nonce is nil.
*/
- (nullable instancetype)initWithNonce:(NSString *)nonce localizedDescription:(NSString *)description type:(nonnull NSString *)type isDefault:(BOOL)isDefault;

/**
 @brief The one-time use payment method nonce
*/
@property (nonatomic, readonly, copy) NSString *nonce;

/**
 @brief A localized description of the payment info
*/
@property (nonatomic, readonly, copy) NSString *localizedDescription;

/**
 @brief The type of the tokenized data, e.g. PayPal, Venmo, MasterCard, Visa, Amex
*/
@property (nonatomic, readonly, copy) NSString *type;

/**
 @brief True if this nonce is the customer's default payment method, otherwise false.
*/
@property (nonatomic, readonly, assign) BOOL isDefault;

@end

NS_ASSUME_NONNULL_END