//
//    Copyright (c) 2018-present, Square, Inc. All rights reserved.
//
//    Your use of this software is subject to the Square Developer Terms of
//    Service (https://squareup.com/legal/developers). This copyright notice shall
//    be included in all copies or substantial portions of the software.
//
//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//    THE SOFTWARE.
//

#import <Foundation/Foundation.h>

#import <SquareInAppPaymentsSDK/SQIPCardBrand.h>
#import <SquareInAppPaymentsSDK/SQIPCardPrepaidType.h>
#import <SquareInAppPaymentsSDK/SQIPCardType.h>

/**
 Represents a payment card.
 */
@interface SQIPCard : NSObject <NSCopying>

/**
 The card brand (for example, Visa).
 */
@property (nonatomic, assign, readonly) SQIPCardBrand brand;

/**
 The last 4 digits of the card number.
 */
@property (nonatomic, strong, readonly, nonnull) NSString *lastFourDigits;

/**
 The expiration month of the card. Ranges between 1 and 12.
 */
@property (nonatomic, assign, readonly) NSUInteger expirationMonth;

/**
 The 4-digit expiration year of the card.
 */
@property (nonatomic, assign, readonly) NSUInteger expirationYear;

/**
 The billing postal code associated with the card, if available.
 */
@property (nonatomic, strong, readonly, nullable) NSString *postalCode;

/**
 The type of card (for example, Credit or Debit)
 Note: This property is experimental and will always return `unknown`
 */
@property (nonatomic, assign, readonly) SQIPCardType type;

/**
 The prepaid type of the credit card (for example, a Prepaid Gift Card)
 Note: This property is experimental and will always return `unknown`
 */
@property (nonatomic, assign, readonly) SQIPCardPrepaidType prepaidType;

/**
 :nodoc:
 `init` is unavailable.
 */
- (nonnull instancetype)init NS_UNAVAILABLE;

/**
 :nodoc:
 `new` is unavailable.
 */
+ (nonnull instancetype) new NS_UNAVAILABLE;

@end