react-native-hyperpay-sdk 0.16.0 → 0.18.0

package/OPPWAMobile.xcframework/Info.plist

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>AvailableLibraries</key>
+	<array>
+		<dict>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64_armv7</string>
+			<key>LibraryPath</key>
+			<string>OPPWAMobile.framework</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+				<string>armv7</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+		</dict>
+		<dict>
+			<key>LibraryIdentifier</key>
+			<string>ios-arm64_i386_x86_64-simulator</string>
+			<key>LibraryPath</key>
+			<string>OPPWAMobile.framework</string>
+			<key>SupportedArchitectures</key>
+			<array>
+				<string>arm64</string>
+				<string>i386</string>
+				<string>x86_64</string>
+			</array>
+			<key>SupportedPlatform</key>
+			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
+		</dict>
+	</array>
+	<key>CFBundlePackageType</key>
+	<string>XFWK</string>
+	<key>XCFrameworkFormatVersion</key>
+	<string>1.0</string>
+</dict>
+</plist>

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPApplePayPaymentParams.h

@@ -0,0 +1,64 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/**
+ Class to encapsulate all necessary transaction parameters for performing an Apple Pay transaction.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPApplePayPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing an Apple Pay transaction.
+
+ @param checkoutID The checkout ID of the transaction. Must be not nil or empty.
+ @param tokenData UTF-8 encoded JSON dictionary of encrypted payment data.
+ @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 an Apple Pay transaction, and nil if parameters are invalid.
+*/
++ (nullable instancetype)applePayPaymentParamsWithCheckoutID:(NSString *)checkoutID tokenData:(NSData *)tokenData error:(NSError **)error;
+
+/**
+ Creates an object representing an Apple Pay transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not nil or empty.
+ @param tokenData UTF-8 encoded JSON dictionary of encrypted payment data.
+ @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 an Apple Pay transaction, and nil if parameters are invalid.
+ */
+- (nullable instancetype)initWithCheckoutID:(NSString *)checkoutID tokenData:(NSData *)tokenData error:(NSError **)error NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/**
+ UTF-8 encoded JSON dictionary of encrypted payment data.  Ready for transmission to merchant's e-commerce backend for decryption and submission to a payment processor's gateway.
+ */
+@property (nonatomic, copy, readonly) NSData *tokenData;
+
+/// @name Validation methods
+/**
+ Checks if the token data is valid to perform a transaction.
+ 
+ @param tokenData UTF-8 encoded JSON dictionary of encrypted payment data.
+ @return `YES` if the token data is not empty.
+ */
++ (BOOL)isTokenDataValid:(NSData *)tokenData;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPApplePayRequestStatus.h

@@ -0,0 +1,117 @@
+//
+// Copyright (c) $$year$$ 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;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ Class that reports the status code and errors that you return when a payment is authorized.
+ */
+@interface OPPApplePayRequestAuthorizationResult : NSObject
+
+/// @name Initialization
+
+/**
+ Initializes the result with the status code and list of errors.
+ @param status Payment authorization general status.
+ @param errors List of errors in the Apple Pay form (available for iOS 11 and higher).
+ */
+- (instancetype)initWithStatus:(PKPaymentAuthorizationStatus)status
+                        errors:(nullable NSArray<NSError *> *)errors NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/**
+ Payment authorization general status.
+ */
+@property (nonatomic) PKPaymentAuthorizationStatus status;
+
+/**
+ Any errors that applied. These errors will be displayed to the user to correct (available for iOS 11 and higher).
+ Errors should be ordered from most to least serious.
+ See `PKError` for specific `NSError` keys to use to enable rich error handling.
+ */
+@property (null_resettable, nonatomic, copy) NSArray<NSError *> *errors;
+
+@end
+
+
+/**
+ Base class for updating the payment request after the shopper makes changes on the payment form.
+ */
+@interface OPPApplePayRequestUpdate : NSObject
+
+/// @name Initialization
+
+/**
+ Initializes a payment request update with the given list of summary items.
+ @param paymentSummaryItems The new payment summary items to update the payment request with.
+*/
+- (instancetype)initWithPaymentSummaryItems:(NSArray<PKPaymentSummaryItem *> *)paymentSummaryItems NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/**
+ The status of the payment request update.
+ Set `PKPaymentAuthorizationStatusSuccess` for a successful update, and `PKPaymentAuthorizationStatusFailure` if you were unable to process the required changes.
+ `PKPaymentAuthorizationStatusSuccess` by default.
+*/
+@property (nonatomic) PKPaymentAuthorizationStatus status;
+
+/**
+ The new payment summary items to update the payment request with.
+ */
+@property (nonatomic, copy) NSArray<PKPaymentSummaryItem *> *paymentSummaryItems;
+
+@end
+
+/**
+ Class for updating the payment request after the shipping contact information changed.
+ */
+@interface OPPApplePayRequestShippingContactUpdate : OPPApplePayRequestUpdate
+
+/// @name Initialization
+
+/**
+ Initializes a payment request update with provided errors, payment summary items and shipping methods.
+ @param errors List of errors in the shipping contact information (available for iOS 11 and higher). See `PKError` for specific `NSError` keys to use.
+ @param paymentSummaryItems The new payment summary items to update the payment request with.
+ @param shippingMethods The new shipping methods to update the payment request with.
+ */
+- (instancetype)initWithErrors:(nullable NSArray<NSError *> *)errors
+           paymentSummaryItems:(NSArray<PKPaymentSummaryItem *> *)paymentSummaryItems
+               shippingMethods:(NSArray<PKShippingMethod *> *)shippingMethods NS_DESIGNATED_INITIALIZER;
+
+/// @name Properties
+
+/**
+ The new shipping methods to update the payment request with.
+ */
+@property (nonatomic, copy) NSArray<PKShippingMethod *> *shippingMethods;
+
+/**
+ List of errors in the shipping contact information (available for iOS 11 and higher).
+ See `PKError` for specific `NSError` keys to use.
+ */
+@property (null_resettable, nonatomic, copy) NSArray<NSError *> *errors;
+
+@end
+
+/**
+ Class for updating the payment request after the shipping method changed.
+ */
+@interface OPPApplePayRequestShippingMethodUpdate : OPPApplePayRequestUpdate
+
+@end
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPBankAccount.h

@@ -0,0 +1,58 @@
+//
+// Copyright (c) $$year$$ 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 to encapsulate shopper’s bank account details that have been tokenized.
+ */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPBankAccount : NSObject
+
+/// @name Properties
+
+/** The name of the bank account holder. */
+@property (nonatomic, copy) NSString *holder;
+
+/** The IBAN (International Bank Account Number) associated with the bank account. */
+@property (nonatomic, copy) NSString *IBAN;
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+/**
+ Creates an `OPPBankAccount` object from the JSON.
+ @param JSON A dictionary with parameters received from the Server.
+ @return Returns an `OPPBankAccount` object, or `nil` if JSON contains invalid values.
+ */
++ (nullable instancetype)bankAccountFromJSON:(NSDictionary *)JSON;
+
+/**
+ Creates an `OPPBankAccount` object with the provided values.
+ @param holder The name of the bank account holder.
+ @param IBAN The IBAN (International Bank Account Number) associated with the bank account.
+ @return Returns an `OPPBankAccount` object, or `nil` if parameters are empty.
+ */
++ (nullable instancetype)bankAccountWithHolder:(NSString *)holder IBAN:(NSString *)IBAN;
+
+/**
+ Creates an `OPPBankAccount` object with the provided values.
+ @param holder The name of the bank account holder.
+ @param IBAN The IBAN (International Bank Account Number) associated with the bank account.
+ @return Returns an `OPPBankAccount` object, or `nil` if parameters are empty.
+ */
+- (nullable instancetype)initWithHolder:(NSString *)holder IBAN:(NSString *)IBAN NS_DESIGNATED_INITIALIZER;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPBankAccountPaymentParams.h

@@ -0,0 +1,167 @@
+//
+// Copyright (c) $$year$$ 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 "OPPPaymentParams.h"
+
+/** Class to encapsulate all necessary transaction parameters for performing a bank transfer transaction. */
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPBankAccountPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID paymentBrand:(NSString *)paymentBrand error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/**
+ Creates an object representing a SEPA direct debit transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param holder The name of the bank account holder.
+ @param IBAN The IBAN (International Bank Account Number) associated with the bank account.
+ @param tokenizationEnabled If `YES`, the payment information will be stored for future use.
+ @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 SEPA direct debit transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)directDebitSEPAPaymentParamsWithCheckoutID:(NSString *)checkoutID holder:(NSString *)holder IBAN:(NSString *)IBAN tokenizationEnabled:(BOOL)tokenizationEnabled error:(NSError **)error;
+
+/**
+ Creates an object representing a SOFORT banking transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param country The country code of the bank account (ISO 3166-1).
+ @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 SOFORT banking transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)sofortBankingPaymentParamsWithCheckoutID:(NSString *)checkoutID country:(NSString *)country error:(NSError **)error;
+
+/**
+ Creates an object representing an IDEAL transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param bankName The name of the bank which holds the account.
+ @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 an IDEAL transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)idealPaymentParamsWithCheckoutID:(NSString *)checkoutID bankName:(NSString *)bankName error:(NSError **)error;
+
+/**
+ Creates an object representing a Giropay transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @param BIC The BIC (Bank Identifier Code (SWIFT)) number of the bank account. Either the bankCode or the BIC are required.
+ @param bankCode The code associated with the bank account. Either the bankCode or the BIC are required.
+ @param IBAN The IBAN (International Bank Account Number) associated with the bank account.
+ @param accountNumber The account number of the bank account.
+ @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 Giropay transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)giropayPaymentParamsWithCheckoutID:(NSString *)checkoutID BIC:(nullable NSString *)BIC bankCode:(nullable NSString *)bankCode IBAN:(nullable NSString *)IBAN accountNumber:(nullable NSString *)accountNumber error:(NSError **)error;
+
+/**
+ Creates an object representing a Paytrail transaction.
+ 
+ @param checkoutID The checkout ID of the transaction. Must be not `nil` or empty.
+ @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 Paytrail transaction, and `nil` if parameters are invalid.
+ */
++ (nullable instancetype)paytrailPaymentParamsWithCheckoutID:(NSString *)checkoutID error:(NSError **)error;
+
+
+/// @name Properties
+
+/** The name of the bank account holder. */
+@property (nonatomic, copy, readonly, nullable) NSString *holder;
+
+/** The IBAN (International Bank Account Number) associated with the bank account. */
+@property (nonatomic, copy, readonly, nullable) NSString *IBAN;
+
+/** The account number of the bank account. Either the account number or the IBAN are required. */
+@property (nonatomic, copy, readonly, nullable) NSString *accountNumber;
+
+/** The country code of the bank account (ISO 3166-1). */
+@property (nonatomic, copy, readonly, nullable) NSString *country;
+
+/** The name of the bank which holds the account. */
+@property (nonatomic, copy, readonly, nullable) NSString *bankName;
+
+/** The BIC (Bank Identifier Code (SWIFT)) number of the bank account. Either the bankCode or the BIC are required. */
+@property (nonatomic, copy, readonly, nullable) NSString *BIC;
+
+/** The code associated with the bank account. Either the bankCode or the BIC are required. */
+@property (nonatomic, copy, readonly, nullable) NSString *bankCode;
+
+/** Default is `NO`. If `YES`, the payment information will be stored for future use. */
+@property (nonatomic, readonly, getter=isTokenizationEnabled) BOOL tokenizationEnabled;
+
+/// @name Validation methods
+
+/**
+ Checks if the bank account holder name is filled with sufficient data to perform a transaction.
+ 
+ @param holder The name of the bank account holder.
+ @return `YES` if the holder name contains more than 4 characters, up to 128 characters.
+ */
++ (BOOL)isHolderValid:(NSString *)holder;
+
+/**
+ Checks if the IBAN is valid.
+ The first two 2 characters specify the country code as of ISO 3166-1 alpha-2. Only letters.
+ The next 2 characters specify the check digits for a sanity check. Only digits.
+ The remaining characters up to 27 characters specify the Basic Bank Account Number (“BBAN”). Both letters & digits allowed.
+ 
+ @param IBAN International Bank Account Number.
+ @return `YES` if the IBAN meets the criteria described above.
+ */
++ (BOOL)isIBANValid:(NSString *)IBAN;
+
+/**
+ Checks if the account number is valid.
+ 
+ @param accountNumber The account number of the bank account.
+ @return `YES` if the account number is valid.
+ */
++ (BOOL)isAccountNumberValid:(NSString *)accountNumber;
+
+/**
+ Checks if the country code matches ISO 3166-1 two-letter standard.
+ 
+ @param country The country of the bank account.
+ @return `YES` if the country code matches ISO 3166-1 two-letter standard.
+ */
++ (BOOL)isCountryValid:(NSString *)country;
+
+/**
+ Checks if the name of the bank is valid.
+ 
+ @param bankName The name of the bank which holds the account.
+ @return `YES` if the name of the bank is valid.
+ */
++ (BOOL)isBankNameValid:(NSString *)bankName;
+
+/**
+ Checks if the BIC is valid.
+ 
+ @param BIC The BIC (Bank Identifier Code (SWIFT)) number of the bank account.
+ @return `YES` if the BIC is valid.
+ */
++ (BOOL)isBICValid:(NSString *)BIC;
+
+/**
+ Checks if the bank code is valid.
+ 
+ @param bankCode The code associated with the bank account.
+ @return `YES` if the bank code is valid.
+ */
++ (BOOL)isBankCodeValid:(NSString *)bankCode;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPBaseCardPaymentParams.h

@@ -0,0 +1,48 @@
+//
+// Copyright (c) $$year$$ 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 base parameters for common and tokenized cards.
+*/
+
+NS_ASSUME_NONNULL_BEGIN
+@interface OPPBaseCardPaymentParams : OPPPaymentParams
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)initWithCheckoutID:(NSString *)checkoutID
+                      paymentBrand:(NSString *)paymentBrand
+                             error:(NSError * _Nullable __autoreleasing *)error NS_UNAVAILABLE;
+
+/** The CVV code found on the card. Property should be set, if CVV check is required for transaction processing. */
+@property (nonatomic, copy, readonly, nullable) NSString *CVV;
+
+/** The number of installments the payment should be split into. */
+@property (nonatomic, copy, nullable) NSNumber *numberOfInstallments;
+
+/** The params needed for 3-D Secure 2 authentication request. */
+@property (nonatomic, copy, nullable) NSString *threeDS2AuthParams;
+
+/**
+ 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
+
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPBillingAddress.h

@@ -0,0 +1,88 @@
+//
+// Copyright (c) $$year$$ 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>
+
+NS_ASSUME_NONNULL_BEGIN
+/**
+ Class to hold billing address of the customer.
+ */
+@interface OPPBillingAddress : NSObject
+
+/// @name Properties
+
+/** The country of the billing address. */
+@property (nonatomic, copy, nullable, readonly) NSString *country;
+
+/** The county, state or region of the billing address. */
+@property (nonatomic, copy, nullable, readonly) NSString *state;
+
+/** The city of the billing address. */
+@property (nonatomic, copy, nullable, readonly) NSString *city;
+
+/** The postal code or zip code of the billing address. */
+@property (nonatomic, copy, nullable, readonly) NSString *postCode;
+
+/**
+ The door number, floor, building number, building name, and/or street name of the billing address.
+ Mandatory for 3D Secure v2.
+ */
+@property (nonatomic, copy, nullable, readonly) NSString *street1;
+
+/**
+ The adjoining road or locality (if required) of the billing address.
+ The combination of street1 and street2 can't contain numbers only, it should also include characters.
+*/
+@property (nonatomic, copy, nullable, readonly) NSString *street2;
+
+/**
+ A flag that specifies if country is required.
+ Default is `YES`.
+*/
+@property (nonatomic, readonly, getter=isCountryRequired) BOOL countryRequired;
+
+/**
+ A flag that specifies if state is required.
+ Default is `YES`.
+*/
+@property (nonatomic, readonly, getter=isStateRequired) BOOL stateRequired;
+
+/**
+ A flag that specifies if city is required.
+ Default is `YES`.
+*/
+@property (nonatomic, readonly, getter=isCityRequired) BOOL cityRequired;
+
+/**
+ A flag that specifies if post code is required.
+ Default is `YES`.
+*/
+@property (nonatomic, readonly, getter=isPostCodeRequired) BOOL postCodeRequired;
+
+/**
+ A flag that specifies if street1 is required.
+ Default is `YES`.
+*/
+@property (nonatomic, readonly, getter=isStreet1Required) BOOL street1Required;
+
+/**
+ A flag that specifies if street1 is required.
+ Default is `YES`.
+*/
+@property (nonatomic, readonly, getter=isStreet2Required) BOOL street2Required;
+
+/// @name Initialization
+
+/// :nodoc:
+- (instancetype)init NS_UNAVAILABLE;
+
+@end
+NS_ASSUME_NONNULL_END

package/OPPWAMobile.xcframework/ios-arm64_armv7/OPPWAMobile.framework/Headers/OPPBillingAddressBuilder.h

@@ -0,0 +1,106 @@
+//
+// Copyright (c) $$year$$ 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>
+
+NS_ASSUME_NONNULL_BEGIN
+/**
+ Builder class for costructing billing address object.
+ */
+@interface OPPBillingAddressBuilder : NSObject
+
+/**
+ Set billing address country.
+ @param country The country of the billing address.
+ @return self.
+ */
+- (instancetype)withCountry:(nonnull NSString *)country;
+
+/**
+ Set billing address state.
+ @param state the county, state or region of the billing address.
+ @return self.
+ */
+- (instancetype)withState:(nonnull NSString *)state;
+
+/**
+ Set billing address city.
+ @param city The town, district or city of the billing address.
+ @return self.
+ */
+- (instancetype)withCity:(nonnull NSString *)city;
+
+/**
+ Set billing address post code.
+ @param postCode The postal code or zip code of the billing address.
+ @return self.
+ */
+- (instancetype)withPostCode:(nonnull NSString *)postCode;
+
+/**
+ Set billing address street1.
+ @param street1Required The door number, floor, building number, building name, and/or street name of the billing address.
+ @return self.
+*/
+- (instancetype)withStreet1:(nonnull NSString *)street1;
+
+/**
+ Set billing address street2.
+ @param street2Required The adjoining road or locality (if required) of the billing address.
+ @return self.
+ */
+- (instancetype)withStreet2:(nonnull NSString *)street2;
+
+/**
+ Update billing address country required flag.
+ Default is `YES`.
+ */
+- (nonnull instancetype)withCountryRequired:(BOOL)countryRequired;
+
+/**
+ Update billing address state required flag.
+ Default is `YES`.
+ */
+- (instancetype)withStateRequired:(BOOL)stateRequired;
+
+/**
+ Update billing address city required flag.
+ Default is `YES`.
+ */
+- (instancetype)withCityRequired:(BOOL)cityRequired;
+
+/**
+ Update billing address post code required flag.
+ Default is `YES`.
+ */
+- (instancetype)withPostCodeRequired:(BOOL)postCodeRequired;
+
+/**
+ Update billing address street1 required flag.
+ Default is `YES`.
+ */
+- (instancetype)withStreet1Required:(BOOL)street1Required;
+
+/**
+ Update billing address street2 required flag.
+ Default is `YES`.
+ */
+- (instancetype)withStreet2Required:(BOOL)street2Required;
+
+/**
+ Creates a new billing address.
+ @param error The error that occured while building billing address object.
+ @return the billing address.
+ */
+- (OPPBillingAddress *)build;
+
+@end
+NS_ASSUME_NONNULL_END