react-native-hyperpay-sdk 0.13.0 → 0.15.0

package/OPPWAMobile.framework/Headers/OPPCardPaymentParams.h

@@ -1,251 +0,0 @@
-//
-// Copyright (c) 2019 by ACI Worldwide, Inc.
-// All rights reserved.
-//
-// This software is the confidential and proprietary information
-// of ACI Worldwide Inc ("Confidential Information"). You shall
-// not disclose such Confidential Information and shall use it
-// only in accordance with the terms of the license agreement
-// you entered with ACI Worldwide Inc.
-//
-
-@import Foundation;
-#import "OPPPaymentParams.h"
-
-/**
- Class to represent a set of card parameters needed for performing an e-commerce card transaction.
-
- It offers сonvenience methods for checking if the number is valid, i.e. if it passes the Luhn check and can be assigned to one of the major card companies.
- 
- After getting an authorization for the transaction the parameters are masked in accordance to PCI PA DSS requirements.
- */
-
-NS_ASSUME_NONNULL_BEGIN
-@interface OPPCardPaymentParams : OPPPaymentParams
-
-/// @name Initialization
-
-/// :nodoc:
-- (instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
-
-/**
- Creates an object representing a card transaction.
-
- @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
- @param paymentBrand The payment brand of the card.
- @param holder The name of the card holder.
- @param number The card number of the transaction.
- @param expiryYear The expiration year. It is expected in the format `YYYY`.
- @param expiryMonth The expiration month of the card. It is expected in the format `MM`.
- @param CVV The CVV code associated with the card. Set to `nil` if CVV is not required.
- @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
- @return Returns an object representing a card transaction, and `nil` if parameters are invalid.
-*/
-+ (nullable instancetype)cardPaymentParamsWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand holder:(nullable NSString *)holder number:(NSString *)number expiryMonth:(nullable NSString *)expiryMonth expiryYear:(nullable NSString *)expiryYear CVV:(nullable NSString *)CVV error:(NSError * _Nullable *)error;
-
-/**
- Creates an object representing a card transaction without specifying a brand.
- Use it only with BIP settings 'automatic brand detection' activated.
- 
- @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
- @param holder The name of the card holder.
- @param number The card number of the transaction.
- @param expiryYear The expiration year. It is expected in the format `YYYY`.
- @param expiryMonth The expiration month of the card. It is expected in the format `MM`.
- @param CVV The CVV code associated with the card. Set to `nil` if CVV is not required.
- @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
- @return Returns an object representing a card transaction, and `nil` if parameters are invalid.
- */
-+ (nullable instancetype)cardPaymentParamsWithCheckoutID:(NSString *)checkoutID holder:(nullable NSString *)holder number:(NSString *)number expiryMonth:(nullable NSString *)expiryMonth expiryYear:(nullable NSString *)expiryYear CVV:(nullable NSString *)CVV error:(NSError * _Nullable *)error;
-
-/**
- Creates an object representing a card transaction.
- @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
- @param paymentBrand The payment brand of the card.
- @param holder The name of the cardholder.
- @param number The card number of the transaction.
- @param expiryYear The expiration year. It is expected in the format `YYYY`.
- @param expiryMonth The expiration month of the card. It is expected in the format `MM`.
- @param CVV The CVV code associated with the card. Set to `nil` if CVV is not required.
- @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
- @return Returns an object representing a card transaction, and `nil` if parameters are invalid.
- */
-- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand holder:(nullable NSString *)holder number:(NSString *)number expiryMonth:(nullable NSString *)expiryMonth expiryYear:(nullable NSString *)expiryYear CVV:(nullable NSString *)CVV error:(NSError * _Nullable *)error NS_DESIGNATED_INITIALIZER;
-
-/// @name Properties
-
-/** Holder of the card account. The length must be greater than 3 characters and less then 128 character. */
-@property (nonatomic, copy, readonly) NSString *holder;
-
-/** The card number. It may contain spaces `" "` and dashes `"-"`. */
-@property (nonatomic, copy, readonly) NSString *number;
-
-/** The card expiry month in the format `MM`. */
-@property (nonatomic, copy, readonly) NSString *expiryMonth;
-
-/** The card expiry year in the format `YYYY`. */
-@property (nonatomic, copy, readonly) NSString *expiryYear;
-
-/** The CVV code found on the card. This is needed for e-commerce transactions. */
-@property (nonatomic, copy, readonly) NSString *CVV;
-
-/** The customer's country code. */
-@property (nonatomic, copy) NSString *countryCode;
-
-/** The customer's mobile number. */
-@property (nonatomic, copy) NSString *mobilePhone;
-
-/** Default is `NO`. If `YES`, the payment information will be stored for future use. */
-@property (nonatomic, getter=isTokenizationEnabled) BOOL tokenizationEnabled;
-
-/** The number of installments the payment should be split into. */
-@property (nonatomic, copy) NSNumber *numberOfInstallments;
-
-/// @name Parameter Checks
-
-/**
- Checks if the holder name is filled with sufficient data to perform a transaction.
- 
- @param holder Holder of the card account.
- @return `YES` if the holder name length greater than 3 characters and less than 128 character.
- */
-+ (BOOL)isHolderValid:(NSString *)holder;
-
-/**
- Checks if the card number is filled with sufficient data to perform a transaction.
- 
- @param number Card number.
- @param luhnCheck Set to `YES` if number should pass Luhn test http://en.wikipedia.org/wiki/Luhn_algorithm.
- @return `YES` if the number consists of 10-19 digits and passes luhn test, `NO` if it doesn't.
- */
-+ (BOOL)isNumberValid:(NSString *)number luhnCheck:(BOOL)luhnCheck;
-
-/**
- Checks if the card expiry month is filled with sufficient data to perform a transaction.
- 
- @param expiryMonth The expiry month of the card.
- @return `YES` if the card expiry month is in the format `MM`.
- */
-+ (BOOL)isExpiryMonthValid:(NSString *)expiryMonth;
-
-/**
- Checks if the card expiry year is filled with sufficient data to perform a transaction.
- 
- @param expiryYear The expiry year of the card.
- @return `YES` if the card expiry year is in the format `YYYY`.
- */
-+ (BOOL)isExpiryYearValid:(NSString *)expiryYear;
-
-/**
- Checks if the country code is filled with sufficient data to perform a transaction.
- 
- @param countryCode The country code.
- @return `YES` if the country code contains digits only.
- */
-+ (BOOL)isCountryCodeValid:(NSString *)countryCode;
-
-/**
- Checks if the mobile phone is filled with sufficient data to perform a transaction.
- 
- @param mobilePhone The mobile phone number.
- @return `YES` if the mobile phone number contains digits only.
- */
-+ (BOOL)isMobilePhoneValid:(NSString *)mobilePhone;
-
-/**
- Checks if the month and year have been set and whether or not card is expired.
- 
- @param month The expiry month of the card.
- @param year The expiry year of the card.
- @return `YES` if the month or the year is expired. `NO` if the card is not expired yet.
- */
-+ (BOOL)isExpiredWithExpiryMonth:(NSString *)month andYear:(NSString *)year;
-
-/**
- Checks if the card CVV is filled with sufficient data to perform a transaction.
- 
- @param CVV The card security code or CVV.
- @return `YES` if 3,4-digit number is provided.
- */
-+ (BOOL)isCvvValid:(NSString *)CVV;
-
-@end
-
-/// Deprecated methods
-@interface OPPCardPaymentParams (Deprecated)
-
-/**
- Creates an object representing a card transaction.
- 
- @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
- @param brand The brand of the card.
- @param holder The name of the card holder.
- @param number The card number of the transaction.
- @param expiryYear The expiration year. It is expected in the format `YYYY`.
- @param expiryMonth The expiration month of the card. It is expected in the format `MM`.
- @param CVV The CVV code associated with the card. Set to `nil` if CVV is not required.
- @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
- @return Returns an object representing a card transaction, and `nil` if parameters are invalid.
- @warning **Deprecated:** Use `+cardPaymentParamsWithCheckoutID:paymentBrand:holder:number:expiryMonth:expiryYear:CVV:error:` instead.
- */
-+ (nullable instancetype)cardPaymentParamsWithCheckoutID:(NSString *)checkoutID brand:(OPPPaymentParamsBrand)brand holder:(NSString *)holder number:(NSString *)number expiryMonth:(NSString *)expiryMonth expiryYear:(NSString *)expiryYear CVV:(nullable NSString *)CVV error:(NSError **)error DEPRECATED_MSG_ATTRIBUTE("- Use +cardPaymentParamsWithCheckoutID:paymentBrand:holder:number:expiryMonth:expiryYear:CVV:error: instead.");
-
-/**
- Creates an object representing a card transaction.
- 
- @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
- @param brand The brand of the card.
- @param holder The name of the cardholder.
- @param number The card number of the transaction.
- @param expiryYear The expiration year. It is expected in the format `YYYY`.
- @param expiryMonth The expiration month of the card. It is expected in the format `MM`.
- @param CVV The CVV code associated with the card. Set to `nil` if CVV is not required.
- @param error The error that occurred while validating payment parameters. See code attribute (`OPPErrorCode`) and `NSLocalizedDescription` to identify the reason of failure.
- @return Returns an object representing a card transaction, and `nil` if parameters are invalid.
- @warning **Deprecated:** Use `-initWithCheckoutID:paymentBrand:holder:number:expiryMonth:expiryYear:CVV:error:` instead.
- */
-- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID brand:(OPPPaymentParamsBrand)brand holder:(NSString *)holder number:(NSString *)number expiryMonth:(NSString *)expiryMonth expiryYear:(NSString *)expiryYear CVV:(nullable NSString *)CVV error:(NSError **)error DEPRECATED_MSG_ATTRIBUTE("- Use -initWithCheckoutID:paymentBrand:holder:number:expiryMonth:expiryYear:CVV:error: instead.");
-
-/**
- Checks if the number passes the Luhn Test http://en.wikipedia.org/wiki/Luhn_algorithm.
- 
- @param number Card number.
- @param brand The brand of the card.
- @return `YES` if the number passes the Luhn test and brand check, `NO` if it doesn't.
- @warning **Deprecated:** Use `+isNumberValid:luhnCheck:` instead.
- */
-+ (BOOL)isNumberValid:(nonnull NSString *)number forBrand:(OPPPaymentParamsBrand)brand DEPRECATED_MSG_ATTRIBUTE("- Use +isNumberValid:luhnCheck: instead.");
-
-/**
- Checks if the card CVV is filled with sufficient data to perform a transaction.
- 
- @param CVV The card security code or CVV.
- @param brand The brand of the card.
- @return `YES` if the card CVV length greater than 3 characters and less than 4 characters depends on card brand.
- @warning **Deprecated:** Use `+isCvvValid:` instead.
- */
-+ (BOOL)isCvvValid:(NSString *)CVV forBrand:(OPPPaymentParamsBrand)brand DEPRECATED_MSG_ATTRIBUTE("- Use +isCvvValid: instead.");
-
-/**
- Checks if the card CVV is filled with sufficient data to perform a transaction.
- 
- @param CVV The card security code or CVV.
- @param paymentBrand The payment brand of the card.
- @return `YES` if the card CVV length greater than 3 characters and less than 4 characters depends on card brand.
- @warning **Deprecated:** Use `+isCvvValid:` instead.
- */
-+ (BOOL)isCvvValid:(NSString *)CVV forPaymentBrand:(NSString *)paymentBrand DEPRECATED_MSG_ATTRIBUTE("- Use +isCvvValid: instead.");
-
-/**
- Checks if the number passes the Luhn Test http://en.wikipedia.org/wiki/Luhn_algorithm
- 
- @param number Card number.
- @param paymentBrand The payment brand of the card.
- @return `YES` if the number passes the Luhn test and brand check, `NO` if it doesn't.
- @warning **Deprecated:** Use `+isNumberValid:luhnCheck:` instead.
- */
-+ (BOOL)isNumberValid:(NSString *)number forPaymentBrand:(NSString *)paymentBrand DEPRECATED_MSG_ATTRIBUTE("- Use +isNumberValid:luhnCheck: instead.");
-
-
-@end
-NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPCheckoutInfo.h

@@ -1,130 +0,0 @@
-//
-// Copyright (c) 2019 by ACI Worldwide, Inc.
-// All rights reserved.
-//
-// This software is the confidential and proprietary information
-// of ACI Worldwide Inc ("Confidential Information"). You shall
-// not disclose such Confidential Information and shall use it
-// only in accordance with the terms of the license agreement
-// you entered with ACI Worldwide Inc.
-//
-
-#import <Foundation/Foundation.h>
-@class OPPToken;
-@class OPPPaymentBrandsConfig;
-
-/** Class to encapsulate the parameters related to the checkout. */
-
-NS_ASSUME_NONNULL_BEGIN
-@interface OPPCheckoutInfo : NSObject
-
-/// @name Properties
-
-/** The amount of the transaction in the specified currency. */
-@property (nonatomic) NSDecimalNumber *amount;
-
-/** ISO 4217 currency code. */
-@property (nonatomic, copy) NSString *currencyCode;
-
-/** Tokens related to the checkout. */
-@property (nonatomic, copy, nullable) NSArray<OPPToken *> *tokens;
-
-/** Brand configuration parameters from the Server. */
-@property (nonatomic, nullable) OPPPaymentBrandsConfig *paymentBrandsConfig;
-
-/** The endpoint where the transaction will be sent to. */
-@property (nonatomic, copy) NSString *endpoint;
-
-/** Relative path to get status of transaction. */
-@property (nonatomic, copy) NSString *resourcePath;
-
-/** The merchant IDs related to Klarna Invoice and Klarna Installments. */
-@property (nonatomic, copy, nullable) NSArray<NSString *> *klarnaMerchantIDs;
-
-/** Shows if ReD Shield Device Id collecting is enabled or disabled. */
-@property (nonatomic) BOOL collectRedShieldDeviceId;
-
-/// @name Initialization
-
-/**
- Creates checkout info object from the JSON that can be received from the Server by checkout ID.
- @param JSON A dictionary with parameters received from the Server.
- @param error An error if JSON is invalid.
- @return Returns an `OPPCheckoutInfo` object, or `nil` if JSON is invalid.
- */
-+ (nullable instancetype)checkoutInfoFromJSON:(NSDictionary *)JSON error:(NSError * _Nullable *)error;
-
-/**
- Creates checkout info object with the provided values.
- @param amount The amount of the transaction in the specified currency.
- @param currencyCode ISO 4217 currency code.
- @param tokens Tokens related to the checkout.
- @param paymentBrandsConfig Brand configuration parameters from the Server.
- @param klarnaMerchantIDs Klarna merchant IDs.
- @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
- */
-+ (nullable instancetype)checkoutInfoWithAmount:(NSDecimalNumber *)amount
-                                   currencyCode:(NSString *)currencyCode
-                                         tokens:(nullable NSArray<OPPToken *> *)tokens
-                            paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig
-                              klarnaMerchantIDs:(nullable NSArray<NSString *> *)klarnaMerchantIDs;
-
-/**
- Creates checkout info object with the provided values.
- @param amount The amount of the transaction in the specified currency.
- @param currencyCode ISO 4217 currency code.
- @param tokens Tokens related to the checkout.
- @param paymentBrandsConfig Brand configuration parameters from the Server.
- @param klarnaMerchantIDs Klarna merchant IDs.
- @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
- */
-- (nullable instancetype)initWithAmount:(NSDecimalNumber *)amount
-                           currencyCode:(NSString *)currencyCode
-                                 tokens:(nullable NSArray<OPPToken *> *)tokens
-                    paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig
-                      klarnaMerchantIDs:(nullable NSArray<NSString *> *)klarnaMerchantIDs;
-
-@end
-
-/// Deprecated methods
-@interface OPPCheckoutInfo (Deprecated)
-
-/**
- Creates checkout info object with the provided values.
- @param amount The amount of the transaction in the specified currency.
- @param currencyCode ISO 4217 currency code.
- @param tokens Tokens related to the checkout.
- @param paymentBrandsConfig Brand configuration parameters from the Server.
- @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
- 
- @warning **Deprecated:** Use `+checkoutInfoWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs:` instead.
- */
-+ (nullable instancetype)checkoutInfoWithAmount:(NSDecimalNumber *)amount
-                                   currencyCode:(NSString *)currencyCode
-                                         tokens:(nullable NSArray<OPPToken *> *)tokens
-                            paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig DEPRECATED_MSG_ATTRIBUTE("- Use +checkoutInfoWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs: instead.");
-
-/**
- Creates checkout info object with the provided values.
- @param amount The amount of the transaction in the specified currency.
- @param currencyCode ISO 4217 currency code.
- @param tokens Tokens related to the checkout.
- @param paymentBrandsConfig Brand configuration parameters from the Server.
- @return an `OPPCheckoutInfo` object, or `nil` if parameters are invalid.
- @warning **Deprecated:** Use `-initWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs:` instead.
- */
-- (nullable instancetype)initWithAmount:(NSDecimalNumber *)amount
-                           currencyCode:(NSString *)currencyCode
-                                 tokens:(nullable NSArray<OPPToken *> *)tokens
-                    paymentBrandsConfig:(nullable OPPPaymentBrandsConfig *)paymentBrandsConfig DEPRECATED_MSG_ATTRIBUTE("- Use -initWithAmount:currencyCode:tokens:paymentBrandsConfig:klarnaMerchantIDs: instead.");
-
-/**
- Creates checkout info object from the JSON that can be received from the Server by checkout ID.
- @param JSON A dictionary with parameters received from the Server.
- @return Returns an `OPPCheckoutInfo` object, or `nil` if JSON is invalid.
- @warning **Deprecated:** Use `+checkoutInfoFromJSON:error:` instead
- */
-+ (nullable instancetype)checkoutInfoFromJSON:(NSDictionary *)JSON DEPRECATED_MSG_ATTRIBUTE("- Use +checkoutInfoFromJSON:error: instead.");
-
-@end
-NS_ASSUME_NONNULL_END

package/OPPWAMobile.framework/Headers/OPPCheckoutPaymentMethod.h

@@ -1,51 +0,0 @@
-//
-// Copyright (c) 2019 by ACI Worldwide, Inc.
-// All rights reserved.
-//
-// This software is the confidential and proprietary information
-// of ACI Worldwide Inc ("Confidential Information"). You shall
-// not disclose such Confidential Information and shall use it
-// only in accordance with the terms of the license agreement
-// you entered with ACI Worldwide Inc.
-//
-
-__deprecated_msg("The OPPCheckoutPaymentMethod class is formally deprecated. Use string values for the payment brands.")
-/**
- An enumeration for the possible payment methods.
- 
- @warning **Deprecated:** The `OPPCheckoutPaymentMethod` class is formally deprecated. Use string values for the payment brands.
- */
-typedef NS_ENUM(NSInteger, OPPCheckoutPaymentMethod) {
-    /// VISA payment system.
-    OPPCheckoutPaymentMethodVISA __deprecated_enum_msg("The attribute is no longer used. Please use string value \"VISA\" instead of."),
-    /// MasterCard payment system.
-    OPPCheckoutPaymentMethodMasterCard __deprecated_enum_msg("The attribute is no longer used. Please use string value \"MASTER\" instead of."),
-    /// AMEX payment system.
-    OPPCheckoutPaymentMethodAMEX __deprecated_enum_msg("The attribute is no longer used. Please use string value \"AMEX\" instead of."),
-    /// Diners Club payment system.
-    OPPCheckoutPaymentMethodDinersClub __deprecated_enum_msg("The attribute is no longer used. Please use string value \"DINERS\" instead of."),
-    /// Discover payment system.
-    OPPCheckoutPaymentMethodDiscover __deprecated_enum_msg("The attribute is no longer used. Please use string value \"DISCOVER\" instead of."),
-    /// UnionPay payment system.
-    OPPCheckoutPaymentMethodUnionPay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"UNIONPAY\" instead of."),
-    /// JCB payment system.
-    OPPCheckoutPaymentMethodJCB __deprecated_enum_msg("The attribute is no longer used. Please use string value \"JCB\" instead of."),
-    /// SEPA Direct Debit payment system.
-    OPPCheckoutPaymentMethodDirectDebitSEPA __deprecated_enum_msg("The attribute is no longer used. Please use string value \"DIRECTDEBIT_SEPA\" instead of."),
-    /// BOLETO payment system.
-    OPPCheckoutPaymentMethodBOLETO __deprecated_enum_msg("The attribute is no longer used. Please use string value \"BOLETO\" instead of."),
-    /// Apple Pay payment system.
-    OPPCheckoutPaymentMethodApplePay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"APPLEPAY\" instead of."),
-    /// SOFORT Banking payment system.
-    OPPCheckoutPaymentMethodSOFORTBanking __deprecated_enum_msg("The attribute is no longer used. Please use string value \"SOFORTUEBERWEISUNG\" instead of."),
-    /// PayPal payment system.
-    OPPCheckoutPaymentMethodPayPal __deprecated_enum_msg("The attribute is no longer used. Please use string value \"PAYPAL\" instead of."),
-    /// Alipay payment system.
-    OPPCheckoutPaymentMethodAlipay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"ALIPAY\" instead of."),
-    /// China UnionPay (UPOP) payment system.
-    OPPCheckoutPaymentMethodChinaUnionPay __deprecated_enum_msg("The attribute is no longer used. Please use string value \"CHINAUNIONPAY\" instead of."),
-    /// IDEAL payment system.
-    OPPCheckoutPaymentMethodIDEAL __deprecated_enum_msg("The attribute is no longer used. Please use string value \"IDEAL\" instead of."),
-    /// Unsupported payment system.
-    OPPCheckoutPaymentMethodUnsupported __deprecated_enum_msg("The attribute is no longer used.")
-};

package/OPPWAMobile.framework/Headers/OPPCheckoutProvider.h

@@ -1,197 +0,0 @@
-//
-// Copyright (c) 2019 by ACI Worldwide, Inc.
-// All rights reserved.
-//
-// This software is the confidential and proprietary information
-// of ACI Worldwide Inc ("Confidential Information"). You shall
-// not disclose such Confidential Information and shall use it
-// only in accordance with the terms of the license agreement
-// you entered with ACI Worldwide Inc.
-//
-
-@import Foundation;
-@import PassKit;
-@class OPPPaymentProvider;
-@class OPPTransaction;
-@class OPPCheckoutSettings;
-@class OPPCheckoutProvider;
-@class OPPApplePayRequestAuthorizationResult;
-@class OPPApplePayRequestShippingContactUpdate;
-@class OPPApplePayRequestShippingMethodUpdate;
-@protocol OPPCheckoutProviderDelegate;
-#import "OPPCheckoutPaymentMethod.h"
-
-NS_ASSUME_NONNULL_BEGIN
-
-/**
- A protocol for additional checkout callbacks.
- */
-@protocol OPPCheckoutProviderDelegate <NSObject>
-@optional
-
-/// @name Validation methods
-
-/**
- Called before submitting a transaction to the Server.
- Use this callback to recreate checkout for specific payment brand or abort transaction.
- @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
- @param transaction The transaction with masked sensitive data.
- @param completion The completion block you should call to continue submitting transaction or abort it. In case of abortion checkout will be closed with error `OPPErrorCodeTransactionAborted`.
- */
-- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider continueSubmitting:(OPPTransaction *)transaction completion:(void (^)(NSString * _Nullable checkoutID, BOOL abort))completion;
-
-/**
- Called when card holder text field was changed or pressed Pay button on the payment detail view.
- Use this callback to override the internal card holder validation.
- @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
- @param cardHolder The card holder value.
- @return `YES` if the card holder is valid, otherwise `NO`.
- */
-- (BOOL)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider validateCardHolder:(nullable NSString *)cardHolder;
-
-/// @name Safari services methods
-
-/**
- Called when the user taps the 'Done' button on SFSafariViewController.
- @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
- */
-- (void)checkoutProviderDidFinishSafariViewController:(OPPCheckoutProvider *)checkoutProvider;
-
-/// @name Apple Pay methods
-
-/**
- Called when a new shipping method was selected.
- The delegate must invoke the completion block with an updated array of `PKPaymentSummaryItem` objects.
- @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
- @param shippingMethod The shipping method for this transaction.
- @param completion The completion block you should call to update the shipping costs based on the shipping method.
-*/
-- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider applePayDidSelectShippingMethod:(PKShippingMethod *)shippingMethod handler:(void (^)(OPPApplePayRequestShippingMethodUpdate *update))completion;
-
-/**
- Called when a new shipping address was selected.
- The delegate must invoke the completion block with an updated array of `PKPaymentSummaryItem` objects.
- @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
- @param contact The contact information needed for shipping.
- @param completion The completion block you should call to update the shipping address.
- */
-- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider applePayDidSelectShippingContact:(PKContact *)contact handler:(void (^)(OPPApplePayRequestShippingContactUpdate *update))completion;
-
-
-/**
- Called when the payment request was authorized.
- The delegate must invoke the completion block with an appropriate authorization status.
- @param checkoutProvider The instance of `OPPCheckoutProvider` that is calling delegate method.
- @param payment The result of authorizing a payment request and contains payment information, encrypted in the payment token.
- @param completion The completion block you should call with an appropriate authorization status.
- */
-- (void)checkoutProvider:(OPPCheckoutProvider *)checkoutProvider applePayDidAuthorizePayment:(PKPayment *)payment handler:(void (^)(OPPApplePayRequestAuthorizationResult *result))completion;
-
-@end
-
-
-/**
- Abstract class for displaying an in-App payment page.
- */
-@interface OPPCheckoutProvider : NSObject
-
-/// @name Properties
-
-/**
- Checkout provider delegate.
- */
-@property (nonatomic, weak) id<OPPCheckoutProviderDelegate> delegate;
-
-/// @name Initialization
-
-/**
- Factory method to generate an `OPPCheckoutProvider` used for displaying an in-App payment pages.
- @param provider The OPPPaymentProvider which is used for performing the transaction once all the data from the user is collected.
- @param checkoutID The checkout Id of the transaction. Must be not `nil` or empty.
- @param settings The `OPPCheckoutSettings` used for these payment pages. These settings are provided to customize the appearance and functionality of the payment pages. If `nil`, default settings will be created.
-
- @return Returns an `OPPCheckoutProvider` for displaying in-App payment pages. Returns `nil` if `provider` or `checkoutID` are not set.
- */
-+ (nullable instancetype)checkoutProviderWithPaymentProvider:(OPPPaymentProvider *)provider checkoutID:(NSString *)checkoutID settings:(nullable OPPCheckoutSettings *)settings;
-
-/**
- Designated initializer method to generate an `OPPCheckoutProvider` used for displaying an in-App payment pages.
- @param provider The OPPPaymentProvider which is used for performing the transaction once all the data from the user is collected.
- @param checkoutID The checkout Id of the transaction. Must be not `nil` or empty.
- @param settings The `OPPCheckoutSettings` used for these payment pages. These settings are provided to customize the appearance and functionality of the payment pages. If `nil`, default settings will be created.
- @return Returns an `OPPCheckoutProvider` for displaying in-App payment pages. Returns `nil` if `provider` or `checkoutID` are not set.
- */
-- (nullable instancetype)initWithPaymentProvider:(OPPPaymentProvider *)provider checkoutID:(NSString *)checkoutID settings:(nullable OPPCheckoutSettings *)settings;
-
-/// @name Presenting checkout
-
-/**
- Opens an in-App payment page for collecting user input and submitting a transaction. First the list of payment methods from the checkout settings will be displayed.
- @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
- @param cancelHandler A block executed if the user closes the payment page prematurely.
- */
-- (void)presentCheckoutForSubmittingTransactionCompletionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
-                                                   cancelHandler:(void (^ _Nullable )(void))cancelHandler;
-
-/**
- Opens an in-App payment page for collecting user input and submitting a transaction.
- Payment form for the choosen payment method will be opened. If no user input is required in app (e.g. PayPal), shopper will be redirected directly to the issuer web page.
- @param paymentBrand The payment brand for transaction.
- @param loadingHandler A block executed whenever SDK sends request to the server or receives the response. You can start or stop loading animation based on `inProgress` parameter.
- @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
- @param cancelHandler A block executed if the user closes the payment page prematurely.
- */
-- (void)presentCheckoutWithPaymentBrand:(NSString *)paymentBrand
-                         loadingHandler:(void (^ _Nullable )(BOOL inProgress))loadingHandler
-                      completionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
-                          cancelHandler:(void (^ _Nullable )(void))cancelHandler;
-
-/**
- Closes the in-App payment page. The delegate is not informed if this method is being called.
- @param animated Specifies whether the payment page should be dismissed using an animation or immediately without an animation.
- @param completion The completion handler, if provided, will be invoked after the checkout screen will be dismissed.
- */
-- (void)dismissCheckoutAnimated:(BOOL)animated completion: (void (^ __nullable)(void))completion;
-
-@end
-
-/// Deprecated methods
-@interface OPPCheckoutProvider (Deprecated)
-
-/**
- Opens an in-App payment page for collecting user input and submitting a transaction. First the list of payment methods from the checkout settings will be displayed.
- @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
- @param paymentBrandSelectedHandler A block executed when the shopper selected payment brand. You need to obtain a new checkout Id if the selected payment brand requires another payment type and return the value to SDK or `nil` in case of error using completion block.
- @param cancelHandler A block executed if the user closes the payment page prematurely.
- @warning **Deprecated:** Use `-presentCheckoutForSubmittingTransactionCompletionHandler:cancelHandler:` instead. Use `-[OPPCheckoutProviderDelegate checkoutProvider:continueSubmitting:completion:]` instead of implementing `paymentBrandSelectedHandler`.
- */
-- (void)presentCheckoutForSubmittingTransactionCompletionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
-                                     paymentBrandSelectedHandler:(void (^ _Nullable )(NSString * _Nonnull paymentBrand, void (^completion)(NSString * _Nullable checkoutID)))paymentBrandSelectedHandler
-                                                   cancelHandler:(void (^ _Nullable )(void))cancelHandler DEPRECATED_MSG_ATTRIBUTE("- Use -presentCheckoutForSubmittingTransactionCompletionHandler:cancelHandler: instead.");
-
-/**
- Opens an in-App payment page for collecting user input and submitting a transaction. First the list of payment methods from the checkout settings will be displayed.
- @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
- @param paymentMethodSelectedHandler A block executed when the shopper selected payment brand. You need to obtain a new checkout Id if the selected payment brand requires another payment type and return the value to SDK or `nil` in case of error using completion block.
- @param cancelHandler A block executed if the user closes the payment page prematurely.
- @warning **Deprecated:** Use `-presentCheckoutForSubmittingTransactionCompletionHandler:paymentBrandSelectedHandler:cancelHandler:` instead
- */
-- (void)presentCheckoutForSubmittingTransactionCompletionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
-                                    paymentMethodSelectedHandler:(void (^ _Nullable )(OPPCheckoutPaymentMethod paymentMethod, void (^completion)(NSString * _Nullable checkoutID)))paymentMethodSelectedHandler
-                                                   cancelHandler:(void (^ _Nullable )(void))cancelHandler DEPRECATED_MSG_ATTRIBUTE("- Use -presentCheckoutForSubmittingTransactionCompletionHandler:paymentBrandSelectedHandler:cancelHandler: instead.");
-
-/**
- Opens an in-App payment page for collecting user input and submitting a transaction.
- Payment form for the choosen payment method will be opened. If no user input is required in app (e.g. PayPal), shopper will be redirected directly to the issuer web page.
- @param paymentMethod The payment method for transaction.
- @param loadingHandler A block executed whenever SDK sends request to the server or receives the response. You can start or stop loading animation based on inProgress parameter.
- @param completionHandler A block executed when the transaction is completed. You need to send the request to your server to get the transaction status.
- @param cancelHandler A block executed if the user closes the payment page prematurely.
- @warning **Deprecated:** Use `-presentCheckoutWithPaymentBrand:loadingHandler:completionHandler:cancelHandler:` instead
- */
-- (void)presentCheckoutWithPaymentMethod:(OPPCheckoutPaymentMethod)paymentMethod
-                          loadingHandler:(void (^ _Nullable )(BOOL inProgress))loadingHandler
-                       completionHandler:(void (^)(OPPTransaction * _Nullable transaction, NSError * _Nullable error))completionHandler
-                           cancelHandler:(void (^ _Nullable )(void))cancelHandler DEPRECATED_MSG_ATTRIBUTE("- Use -presentCheckoutWithPaymentBrand:loadingHandler:completionHandler:cancelHandler: instead.");
-@end
-NS_ASSUME_NONNULL_END