react-native-payengine 2.0.17 → 2.0.18-alpha.1

package/ios/PayEngineSDK.xcframework/ios-arm64/PayEngineSDK.framework/Headers/PayEngineSDK-Swift.h

@@ -285,11 +285,8 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 @import ObjectiveC;
 @import PassKit;
 @import UIKit;
-@import WebKit;
 #endif
 
-#import <PayEngineSDK/PayEngineSDK.h>
-
 #endif
 #pragma clang diagnostic ignored "-Wproperty-attribute-mismatch"
 #pragma clang diagnostic ignored "-Wduplicate-method-arg"
@@ -309,7 +306,9 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 #endif
 
 #if defined(__OBJC__)
+/// Represents the supported Apple Pay payment networks.
 typedef SWIFT_ENUM(NSInteger, ApplePayPaymentNetwork, open) {
+/// Supported Apple Pay payment networks.
   ApplePayPaymentNetworkAmex = 0,
   ApplePayPaymentNetworkCartesBancaires = 1,
   ApplePayPaymentNetworkDiscover = 2,
@@ -333,114 +332,234 @@ typedef SWIFT_ENUM(NSInteger, ApplePayPaymentNetwork, open) {
 @class NSString;
 @class PKShippingMethod;
 
+/// A class that represents an Apple Pay payment request.
 SWIFT_CLASS("_TtC12PayEngineSDK22ApplePayPaymentRequest")
 @interface ApplePayPaymentRequest : NSObject
-/// Creates a Apple Pay request that can be used afterards to make an apple pay request
-/// <ul>
-///   <li>
-///   </li>
-/// </ul>
-/// \param currencyCode The currency code the transaction has default .USD
+/// Configures the <code>ApplePayPaymentRequest</code> object to prepare for an Apple Pay transaction.
+/// Use this method to set up the necessary details for an Apple Pay request, including the payment items, total amount, currency, and required contact fields.
+/// This method initializes the payment details and configures the Apple Pay request accordingly.
+/// \param paymentItems An array of <code>PKPaymentSummaryItem</code> representing the items to be displayed in the Apple Pay sheet. Defaults to an empty array.
 ///
-/// \param var paymentItems What are the items you want to show in the apple pay sheet default  []
+/// \param paymentAmount The total amount to be collected in the transaction.
 ///
-/// \param paymentAmount The total amount you want to collect
+/// \param currencyCode The currency code for the transaction. Defaults to <code>"USD"</code>.
+///
+/// \param requiredBillingContactFields A set of <code>PKContactField</code> values specifying the required billing contact fields. Defaults to an empty set.
+///
+/// \param requiredShippingContactFields A set of <code>PKContactField</code> values specifying the required shipping contact fields. Defaults to an empty set.
+///
+/// \param shippingMethods An array of <code>PKShippingMethod</code> representing the available shipping options. Defaults to an empty array .
 ///
 - (void)buildWithPaymentItems:(NSArray<PKPaymentSummaryItem *> * _Nonnull)paymentItems paymentAmount:(double)paymentAmount currencyCode:(NSString * _Nonnull)currencyCode requiredBillingContactFields:(NSSet<PKContactField> * _Nonnull)requiredBillingContactFields requiredShippingContactFields:(NSSet<PKContactField> * _Nonnull)requiredShippingContactFields shippingMethods:(NSArray<PKShippingMethod *> * _Nonnull)shippingMethods;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
+/// Represents the Apple Pay eligibility status for the current device and user.
 typedef SWIFT_ENUM(NSInteger, ApplePayStatus, open) {
-/// This means the current device/user has Apple pay activated and a card belongs to the given payment networks
+/// The current device/user has Apple pay activated and a card belongs to the given payment networks
   ApplePayStatusEligible = 0,
-/// This means the current device/user has Apple pay activated but has no card belongs to the given payment networks
+/// The current device/user has Apple pay activated but has no card belongs to the given payment networks
   ApplePayStatusNeedSetup = 1,
-/// This means the current device/user cannot use Apple pay from Apple
+/// The current device/user cannot use Apple pay from Apple
   ApplePayStatusNotEligible = 2,
 };
 
 
+/// Represents the details of a bank account.
+/// This class stores essential bank account information such as routing number,
+/// last four digits of the account number, and the account holder’s name.
 SWIFT_CLASS("_TtC12PayEngineSDK15BankAccountData")
 @interface BankAccountData : NSObject
-@property (nonatomic, copy) NSString * _Nonnull routingNumber;
-@property (nonatomic, copy) NSString * _Nonnull last4;
-@property (nonatomic, copy) NSString * _Nonnull firstName;
-@property (nonatomic, copy) NSString * _Nonnull lastName;
-- (nullable instancetype)initWithRoutingNumber:(NSString * _Nonnull)routingNumber last4:(NSString * _Nonnull)last4 firstName:(NSString * _Nonnull)firstName lastName:(NSString * _Nonnull)lastName error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
-- (nonnull instancetype)init SWIFT_UNAVAILABLE;
-+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
-@end
-
-@class PEBankAccount;
-
-SWIFT_CLASS("_TtC12PayEngineSDK19BankAccountResponse")
-@interface BankAccountResponse : NSObject
-- (nullable instancetype)initWithMessage:(NSString * _Nonnull)message data:(PEBankAccount * _Nonnull)data error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
-- (nonnull instancetype)init SWIFT_UNAVAILABLE;
-+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
-@end
-
-
-SWIFT_CLASS("_TtC12PayEngineSDK24BankAccountResponseError")
-@interface BankAccountResponseError : NSObject
-- (nullable instancetype)initWithError:(BOOL)error message:(NSString * _Nonnull)message error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
+/// The bank’s routing number.
+@property (nonatomic, readonly, copy) NSString * _Nonnull routingNumber;
+/// The last four digits of the bank account number.
+@property (nonatomic, readonly, copy) NSString * _Nonnull last4;
+/// The first name of the account holder.
+@property (nonatomic, readonly, copy) NSString * _Nonnull firstName;
+/// The last name of the account holder.
+@property (nonatomic, readonly, copy) NSString * _Nonnull lastName;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
+/// Represents the details of a payment card.
+/// This class stores essential card information such as brand, last four digits,
+/// expiration date, and the cardholder’s name.
 SWIFT_CLASS("_TtC12PayEngineSDK8CardData")
 @interface CardData : NSObject
-@property (nonatomic, copy) NSString * _Nonnull id;
-@property (nonatomic, copy) NSString * _Nonnull brand;
-@property (nonatomic, copy) NSString * _Nonnull last4;
-@property (nonatomic) NSInteger expMonth;
-@property (nonatomic) NSInteger expYear;
-@property (nonatomic, copy) NSString * _Nonnull name;
-@property (nonatomic, copy) NSString * _Nullable addressZip;
-- (nullable instancetype)initWithId:(NSString * _Nonnull)id brand:(NSString * _Nonnull)brand last4:(NSString * _Nonnull)last4 expMonth:(NSInteger)expMonth expYear:(NSInteger)expYear name:(NSString * _Nonnull)name addressZip:(NSString * _Nullable)addressZip error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
-- (nonnull instancetype)init SWIFT_UNAVAILABLE;
-+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
-@end
-
-@class PECard;
-
-SWIFT_CLASS("_TtC12PayEngineSDK12CardResponse")
-@interface CardResponse : NSObject
-- (nullable instancetype)initWithMessage:(NSString * _Nonnull)message data:(PECard * _Nonnull)data error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
-- (nonnull instancetype)init SWIFT_UNAVAILABLE;
-+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
-@end
-
-
-SWIFT_CLASS("_TtC12PayEngineSDK17CardResponseError")
-@interface CardResponseError : NSObject
-- (nullable instancetype)initWithError:(BOOL)error message:(NSString * _Nonnull)message error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
+/// The unique identifier for the card.
+@property (nonatomic, readonly, copy) NSString * _Nonnull id;
+/// The brand of the card (e.g., Visa, MasterCard).
+@property (nonatomic, readonly, copy) NSString * _Nonnull brand;
+/// The last four digits of the card number.
+@property (nonatomic, readonly, copy) NSString * _Nonnull last4;
+/// The expiration month of the card.
+@property (nonatomic, readonly) NSInteger expMonth;
+/// The expiration year of the card.
+@property (nonatomic, readonly) NSInteger expYear;
+/// The name of the cardholder.
+@property (nonatomic, readonly, copy) NSString * _Nonnull name;
+/// The ZIP code associated with the card’s billing address (optional).
+@property (nonatomic, readonly, copy) NSString * _Nullable addressZip;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
-@class NSBundle;
+@class PEBankAccount;
 @class NSCoder;
 
-SWIFT_CLASS("_TtC12PayEngineSDK28FraudAnalyticsViewController")
-@interface FraudAnalyticsViewController : KountAnalyticsViewController
-- (nonnull instancetype)initWithNibName:(NSString * _Nullable)nibNameOrNil bundle:(NSBundle * _Nullable)nibBundleOrNil OBJC_DESIGNATED_INITIALIZER;
-- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)coder OBJC_DESIGNATED_INITIALIZER;
-@end
-
-
+/// A secure view for entering a customer’s bank account information safely.
+/// This view displays input fields required to securely collect bank account details.
+/// It also provides methods to validate the provided information and saving a customer’s bank acount by securely storing the information in PayEngine’s system.
+/// This view complies with PCI standards and does not store data locally.
+/// Instead, it forwards the information to a PCI-compliant third party, which encrypts and transfers the bank account details to PayEngine’s system.
+/// In addition to the required fields that the view sets up for you, you can also pass additional fields and specify whether they are required.
+/// <h2>How It Works</h2>
+/// Call the <code>PayEngine/createBankAccountView(additionalFields:completion:)-3gn3i</code> method on the <code>PayEngine</code> object to obtain an instance of <code>IBankAccountView</code>. You can also include additional fields if needed.
+/// Use the <code>validate()</code> method to check if all fields pass validation.
+/// Once all fields are valid, call the <code>createBankAccount(merchantId:completion:)</code> method to save the bank account in the PayEngine system.
+/// <h2>Usage Example</h2>
+/// \code
+/// payengine.createBankAccountView(additionalFields: []) { [unowned self] result in
+///     switch result {
+///     case .success(let view): // This is where you get the `IBankAccountView` instance
+///         DispatchQueue.main.async {
+///             self.secureField = view
+///             self.stackView.spacing = 20
+///             self.stackView.addArrangedSubview(self.secureField)
+///
+///             let button = UIButton(type: .system)
+///             button.setTitle("Create Bank Account", for: .normal)
+///
+///             // Register tap action, which will send the createBankAccount request
+///             button.addTarget(self, action: #selector(self.onButtonTap), for: .touchUpInside)
+///
+///             self.stackView.addArrangedSubview(button)
+///         }
+///
+///     case .failure(let error):
+///         debugPrint("Error: \(error)")
+///     }
+/// }
+///
+/// @objc func onButtonTap() {
+///     secureField.createBankAccount(merchantId: MERCHANT_ID) { [unowned self] result in
+///         switch result {
+///         case .success(let data):
+///             let alert = UIAlertController(
+///                 title: "Bank Account Created",
+///                 message: data.token,
+///                 preferredStyle: .alert
+///             )
+///             alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
+///             self.present(alert, animated: true, completion: nil)
+///
+///         case .failure(let error):
+///             debugPrint("Error: \(error)")
+///         }
+///     }
+/// }
+///
+/// \endcode
 SWIFT_CLASS("_TtC12PayEngineSDK16IBankAccountView")
 @interface IBankAccountView : UIStackView
+/// After the user has entered and validated their bank accoount information, this method can be called to save the bank account in the PayEngine system.
+/// \param merchantId Your merchant’s ID.
+///
+/// \param additionalData Additional data to be included along with the bank account information.
+///
+/// \param completion Callback that provides an instance of the newly created <code>PEBankAccount</code> object.
+///
+/// \param failure Callback that returns an error if the request fails.
+///
 - (void)createBankAccountWithMerchantId:(NSString * _Nullable)merchantId additionalData:(NSDictionary<NSString *, id> * _Nonnull)additionalData completion:(void (^ _Nonnull)(PEBankAccount * _Nonnull))completion failure:(void (^ _Nonnull)(NSError * _Nonnull))failure;
 - (nonnull instancetype)initWithFrame:(CGRect)frame OBJC_DESIGNATED_INITIALIZER;
 - (nonnull instancetype)initWithCoder:(NSCoder * _Nonnull)coder OBJC_DESIGNATED_INITIALIZER;
 @end
 
+@class PECard;
 
+/// A secure view for entering a customer’s payment card information safely.
+/// This view displays input fields required to securely collect payment card details.
+/// It also provides methods to validate the provided information and saving a customer’s card by securely storing the information in PayEngine’s system.
+/// This view complies with PCI standards and does not store data locally.
+/// Instead, it forwards the information to a PCI-compliant third party, which encrypts and transfers the card details to PayEngine’s system.
+/// In addition to the required fields that the view sets up for you, you can also pass additional fields and specify whether they are required.
+/// <h2>How It Works</h2>
+/// Call the <code>PayEngine/createSecureView(additionalFields:completion:)-5x9ky</code> method on the <code>PayEngine</code> object to obtain an instance of <code>ICardNumberView</code>. You can also include additional fields if needed.
+/// Use the <code>validate()</code> method to check if all fields pass validation.
+/// Once all fields are valid, call the <code>createCard(merchantId:completion:)</code> method to save the card in the PayEngine system.
+/// <h2>Usage Example</h2>
+/// \code
+/// let zipField = PEField(
+///     name: "address_zip",
+///     type: "text",
+///     placeholder: "Zip code",
+///     isRequired: true,
+///     keyboardType: .alphabet,
+///     pattern: #"^(?:\d{5}(?:-\d{4})?|[ABCEGHJKLMNPRSTVXY]\d[A-Z] ?\d[A-Z]\d)$"#
+/// )
+///
+/// payengine.createSecureView(additionalFields: [zipField]) { [unowned self] result in
+///     switch result {
+///     case .success(let view): // This is where you get the `ICardNumberView` instance
+///         DispatchQueue.main.async {
+///             self.secureField = view
+///             self.stackView.spacing = 20
+///             self.stackView.addArrangedSubview(self.secureField)
+///
+///             let button = UIButton(type: .system)
+///             button.setTitle("Create Card", for: .normal)
+///
+///             // Register tap action, which will send the createCard request
+///             button.addTarget(self, action: #selector(self.onButtonTap), for: .touchUpInside)
+///             self.stackView.addArrangedSubview(button)
+///         }
+///
+///     case .failure(let error):
+///         debugPrint("Error: \(error)")
+///     }
+/// }
+///
+/// @objc func onButtonTap() {
+///     let additionalData = ["test_data": true]
+///
+///     secureField.createCard(merchantId: MERCHANT_ID, additionalData: additionalData) { [unowned self] result in
+///         switch result {
+///         case .success(let data):
+///             let alert = UIAlertController(
+///                 title: "Card Created",
+///                 message: data.token,
+///                 preferredStyle: .alert
+///             )
+///             alert.addAction(UIAlertAction(title: "OK", style: .default, handler: nil))
+///
+///             self.present(alert, animated: true, completion: nil)
+///             self.cardToken = data.token
+///
+///             debugPrint("Card token: \(data.token)")
+///             self.saleButton.isHidden = false
+///
+///         case .failure(let error):
+///             debugPrint("Error: \(error)")
+///         }
+///     }
+/// }
+///
+/// \endcode
 SWIFT_CLASS("_TtC12PayEngineSDK15ICardNumberView")
 @interface ICardNumberView : UIStackView
+/// After the user has entered and validated their card information, this method can be called to save the card in the PayEngine system.
+/// \param merchantId Your merchant’s ID.
+///
+/// \param additionalData Additional data to be included along with the card information.
+///
+/// \param completion Callback that provides an instance of the newly created <code>PECard</code> object.
+///
+/// \param failure Callback that returns an error if the request fails.
+///
 - (void)createCardWithMerchantId:(NSString * _Nullable)merchantId additionalData:(NSDictionary<NSString *, id> * _Nonnull)additionalData completion:(void (^ _Nonnull)(PECard * _Nonnull))completion failure:(void (^ _Nonnull)(NSError * _Nonnull))failure;
 - (nonnull instancetype)initWithFrame:(CGRect)frame OBJC_DESIGNATED_INITIALIZER;
 - (nonnull instancetype)initWithCoder:(NSCoder * _Nonnull)coder OBJC_DESIGNATED_INITIALIZER;
@@ -449,12 +568,62 @@ SWIFT_CLASS("_TtC12PayEngineSDK15ICardNumberView")
 @protocol PEApplePayDelegate;
 @class UIButton;
 
+/// A class that facilitates Apple Pay transactions.
+/// <blockquote>
+/// Important: Making the object for this class is not allowed. The shared instance of this class provides methods to configure and initiate Apple Pay payments. The shared instance is managed internally and you don’t need to access it directly.
+///
+/// </blockquote>
+/// When you call the <code>PayEngine/setupApplePay(merchantId:completion:)</code> the shared instance gets returned to you in a completion callback.
+/// Once you get the shared instance call this method <code>setupApplePayButton(for:type:style:)</code> to get a <code>UIButton</code> that triggers the Apple Pay payment flow when tapped.
+/// <h2>Usage Example</h2>
+/// \code
+/// // The payengineSDK instance
+/// let payengine = PayEngine(config: CONFIG)
+/// payengine.setupApplePay(merchantId: "Your merchant's id") { result in
+///     switch result {
+///     case .success(let applePay): // This is where you get the singleton instance of `PEApplePay`
+///         applePay.delegate = self
+///
+///         let request = ApplePayPaymentRequest()
+///         request.build(
+///             paymentItems: [],
+///             paymentAmount: 1.0,
+///             currencyCode: "USD",
+///             requiredBillingContactFields: [.name, .postalAddress],
+///             requiredShippingContactFields: [.name, .emailAddress, .postalAddress],
+///             shippingMethods: shippingMethods
+///         )
+///
+///         DispatchQueue.main.async {
+///             if let applePayButton = applePay.setupApplePayButton(for: request, type: .checkout) {
+///                 // Add this button to your view hierarchy.
+///                 // When tapped, it will automatically start the Apple Pay payment flow.
+///             }
+///         }
+///
+///     case .failure(let error):
+///         print("Unable to setup Apple Pay: \(error)")
+///     }
+/// }
+///
+/// \endcode
 SWIFT_CLASS("_TtC12PayEngineSDK10PEApplePay")
 @interface PEApplePay : NSObject
+/// A delegate conforming to the <code>PEApplePayDelegate</code> protocol that handles Apple Pay events.
 @property (nonatomic, strong) id <PEApplePayDelegate> _Nullable delegate;
+/// Creates and returns a <code>UIButton</code> styled as an Apple Pay button.
+/// When the button is tapped, it initiates the Apple Pay authorization flow. Depending on the supported payment network,
+/// the button may direct users to set up Apple Pay or proceed with a payment.
+/// \param paymentRequest An <code>ApplePayPaymentRequest</code> containing details of the payment request.
+///
+/// \param type The type of Apple Pay button (e.g., <code>.checkout</code>, <code>.book</code>). Default is <code>.checkout</code>.
+///
+/// \param style The style of the button (e.g., <code>.black</code>, <code>.white</code>). Default is <code>.black</code>.
+///
+///
+/// returns:
+/// A <code>UIButton</code> configured for Apple Pay, or <code>nil</code> if Apple Pay is not available.
 - (UIButton * _Nullable)setupApplePayButtonFor:(ApplePayPaymentRequest * _Nonnull)paymentRequest type:(PKPaymentButtonType)type style:(PKPaymentButtonStyle)style SWIFT_WARN_UNUSED_RESULT;
-- (BOOL)startApplePayPaymentAndReturnError:(NSError * _Nullable * _Nullable)error;
-- (void)startApplePaySetup;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
@@ -477,158 +646,270 @@ SWIFT_CLASS("_TtC12PayEngineSDK10PEApplePay")
 
 enum PEApplePayResult : NSInteger;
 
+/// A delegate protocol that provides callbacks for various events during the Apple Pay transaction process.
+/// This protocol notifies the conforming delegate about errors, UI status updates, payment token retrieval,
+/// and optional user interactions such as selecting shipping or payment methods.
 SWIFT_PROTOCOL("_TtP12PayEngineSDK18PEApplePayDelegate_")
 @protocol PEApplePayDelegate
+/// Called when an error occurs during the Apple Pay transaction.
+/// \param error The error that occurred.
+///
 - (void)paymentErrorWithError:(NSError * _Nonnull)error;
+/// Called when the Apple Pay payment sheet is dismissed.
+/// This can occur when the user cancels the payment request or when the payment is successfully completed.
 - (void)paymentSheetDidMDismiss;
+/// Called when a payment token is successfully received after Apple Pay authorization.
+/// \param token The payment token received from Apple Pay.
+///
+/// \param metadata Additional metadata related to the transaction, if available.
+///
+/// \param billingContact The user’s billing contact information.
+///
+/// \param shippingContact The user’s shipping contact information.
+///
+/// \param completion A completion handler that must be called with a <code>PEApplePayResult</code> value.
+///
 - (void)paymentTokenDidReturnWithToken:(NSString * _Nonnull)token metadata:(NSDictionary<NSString *, id> * _Nullable)metadata billingContact:(PKContact * _Nullable)billingContact shippingContact:(PKContact * _Nullable)shippingContact completion:(void (^ _Nonnull)(enum PEApplePayResult))completion;
+/// Called when a payment token is unavailable due to an error during token exchange.
+/// \param error The error that occurred, if available.
+///
 - (void)paymentTokenNotAvailableWithError:(NSError * _Nullable)error;
 @optional
+/// Called when the user selects a shipping contact during checkout.
+/// \param contact The selected shipping contact.
+///
+/// \param completion A handler that must be called with a <code>PKPaymentRequestShippingContactUpdate</code> to update the shipping details.
+///
 - (void)didSelectShippingContact:(PKContact * _Nonnull)contact handler:(void (^ _Nonnull)(PKPaymentRequestShippingContactUpdate * _Nonnull))completion SWIFT_AVAILABILITY(ios,introduced=11.0);
+/// Called when the user selects a shipping method.
+/// \param shippingMethod The selected shipping method.
+///
+/// \param completion A handler that must be called with a <code>PKPaymentRequestShippingMethodUpdate</code> to update the shipping method details.
+///
 - (void)didSelectShippingMethod:(PKShippingMethod * _Nonnull)shippingMethod handler:(void (^ _Nonnull)(PKPaymentRequestShippingMethodUpdate * _Nonnull))completion SWIFT_AVAILABILITY(ios,introduced=11.0);
+/// Called when the user selects a payment method.
+/// \param paymentMethod The selected payment method.
+///
+/// \param completion A handler that must be called with a <code>PKPaymentRequestPaymentMethodUpdate</code> to update the payment method details.
+///
 - (void)didSelectPaymentMethod:(PKPaymentMethod * _Nonnull)paymentMethod handler:(void (^ _Nonnull)(PKPaymentRequestPaymentMethodUpdate * _Nonnull))completion SWIFT_AVAILABILITY(ios,introduced=11.0);
 @end
 
+/// An enum representing the Apple Payment Result’s success or failure.
 typedef SWIFT_ENUM(NSInteger, PEApplePayResult, open) {
+/// Success if the payment was successful..
   PEApplePayResultSuccess = 0,
+/// Failiure if the payment was not successful.
   PEApplePayResultFailure = 1,
 };
 
 
-/// PayEngine Card object
+/// A PayEngine bank account object.
+/// This class represents a bank account stored within PayEngine, containing a secure token
+/// and account details.
 SWIFT_CLASS("_TtC12PayEngineSDK13PEBankAccount")
 @interface PEBankAccount : NSObject
-@property (nonatomic, copy) NSString * _Nonnull token;
-@property (nonatomic, strong) BankAccountData * _Nonnull bankAccountData;
-- (nullable instancetype)initWithToken:(NSString * _Nonnull)token bankAccountData:(BankAccountData * _Nonnull)bankAccountData error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
+/// A unique token representing the bank account.
+@property (nonatomic, readonly, copy) NSString * _Nonnull token;
+/// The associated bank account details.
+@property (nonatomic, readonly, strong) BankAccountData * _Nonnull bankAccountData;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
-SWIFT_CLASS("_TtC12PayEngineSDK17PEBankAccountView")
-@interface PEBankAccountView : IBankAccountView
-- (nonnull instancetype)initWithFrame:(CGRect)frame SWIFT_UNAVAILABLE;
-- (nonnull instancetype)initWithCoder:(NSCoder * _Nonnull)coder SWIFT_UNAVAILABLE;
-- (void)didMoveToSuperview;
-- (void)layoutSubviews;
-@end
-
-
-/// PayEngine Card object
+/// A PayEngine card object.
+/// This class represents a payment card stored with PayEngine, containing a secure token
+/// and associated card details.
 SWIFT_CLASS("_TtC12PayEngineSDK6PECard")
 @interface PECard : NSObject
-@property (nonatomic, copy) NSString * _Nonnull token;
-@property (nonatomic, strong) CardData * _Nonnull cardData;
-- (nullable instancetype)initWithToken:(NSString * _Nonnull)token cardData:(CardData * _Nonnull)cardData error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
+/// A unique token representing the card.
+@property (nonatomic, readonly, copy) NSString * _Nonnull token;
+/// The associated card details.
+@property (nonatomic, readonly, strong) CardData * _Nonnull cardData;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
-@class PEConfig;
-@class WKUserContentController;
-@class WKScriptMessage;
-
-/// PEComponent
-SWIFT_CLASS("_TtC12PayEngineSDK11PEComponent")
-@interface PEComponent : UIView <WKScriptMessageHandler>
-- (nonnull instancetype)initWithFrame:(CGRect)frame SWIFT_UNAVAILABLE;
-- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)coder SWIFT_UNAVAILABLE;
-- (void)didMoveToSuperview;
-- (void)setupWithConfig:(PEConfig * _Nonnull)config componentName:(NSString * _Nonnull)componentName props:(NSDictionary<NSString *, NSString *> * _Nonnull)props;
-- (void)pinToView:(UIView * _Nonnull)view;
-- (void)registerEventWithName:(NSString * _Nonnull)name handler:(void (^ _Nonnull)(id _Nonnull))handler;
-- (void)removeEventWithName:(NSString * _Nonnull)name;
-- (void)userContentController:(WKUserContentController * _Nonnull)userContentController didReceiveScriptMessage:(WKScriptMessage * _Nonnull)message;
-@end
 
-
-/// PayEngine configuration
+/// A class that is used to configure the <code>PayEngine</code> object.
+/// This class stores the authentication key that is generated by PayEngine. It also defines the PayEngine’s backend environement which the <code>PayEngine</code> object will interact with.
 SWIFT_CLASS("_TtC12PayEngineSDK8PEConfig")
 @interface PEConfig : NSObject
+/// Constructor for the <code>PEConfig</code> class
+/// \param publicKey PayEngine public key.
+///
+/// \param baseURL Base URL for your custom environemnt. Default is <code>nil</code>. If set as <code>nil</code> the object will setup the environment based on the value of the <code>publicKey</code>.
+///
 - (nonnull instancetype)initWithPublicKey:(NSString * _Nonnull)publicKey baseURL:(NSString * _Nullable)baseURL OBJC_DESIGNATED_INITIALIZER;
+/// Returns the base url with which the <code>PayEngine</code> object interacts with.
+///
+/// returns:
+/// A Base URL. If no url was provided when constructing the object, then this method will return a url based on the <code>publicKey</code> provided in the <code>init(publicKey:baseURL:)</code>
 - (NSString * _Nonnull)getBaseURL SWIFT_WARN_UNUSED_RESULT;
+/// To check if the environment is set as production.
+///
+/// returns:
+/// Returns <code>true</code> if the environment is set as live. Returns <code>false</code> otherwise.
 - (BOOL)isProduction SWIFT_WARN_UNUSED_RESULT;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
+/// A type that represents an input field.
+/// This class defines an input field with properties that determine its behavior, such as its name, type, placeholder,
+/// whether it is required, keyboard type, and optional validation pattern.
+/// Internal UI components use this type to create input fields that adhere to the specified input criteria.
 SWIFT_CLASS("_TtC12PayEngineSDK7PEField")
 @interface PEField : NSObject
+/// The name of the field.
+@property (nonatomic, copy) NSString * _Nonnull name;
+/// The type of the field.
+@property (nonatomic, copy) NSString * _Nonnull type;
+/// The placeholder text displayed when the field is empty.
+@property (nonatomic, copy) NSString * _Nonnull placeholder;
+/// A Boolean value indicating whether the field is required.
+/// If <code>true</code>, the field must contain a value before submission.
+@property (nonatomic) BOOL isRequired;
+/// A regular expression pattern used to validate the field’s input.
+/// If <code>nil</code>, no validation is performed.
+@property (nonatomic, copy) NSString * _Nullable pattern;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
-
-/// PEPaymentView
-SWIFT_CLASS("_TtC12PayEngineSDK13PEPaymentView")
-@interface PEPaymentView : ICardNumberView
-- (nonnull instancetype)initWithFrame:(CGRect)frame SWIFT_UNAVAILABLE;
-- (nonnull instancetype)initWithCoder:(NSCoder * _Nonnull)coder SWIFT_UNAVAILABLE;
-- (void)didMoveToSuperview;
-- (void)layoutSubviews;
-- (void)setupWithVaultId:(NSString * _Nonnull)vaultId env:(NSString * _Nonnull)env hostname:(NSString * _Nonnull)hostname publicKey:(NSString * _Nonnull)publicKey additionalFields:(NSArray<PEField *> * _Nonnull)additionalFields;
-- (BOOL)validate SWIFT_WARN_UNUSED_RESULT;
-- (void)showKeyboard;
-@end
-
+/// Color Theme for the SDK.
 typedef SWIFT_ENUM(NSInteger, PEThemeMode, open) {
   PEThemeModeSystem = 0,
   PEThemeModeDark = 1,
   PEThemeModeLight = 2,
 };
 
+@class UIView;
 @class ThreeDSResult;
 
-/// PayEngine Main Class
+/// <code>PayEngine</code> is the main entry point for integrating PayEngine’s payment processing features.
+/// This class provides a centralized interface for:
+/// <ul>
+///   <li>
+///     Secure card and bank account entry
+///   </li>
+///   <li>
+///     Apple Pay integration
+///   </li>
+///   <li>
+///     Fraud monitoring and 3D Secure authentication
+///   </li>
+/// </ul>
+/// <h2>Key Features</h2>
+/// <h3>Secure Payment Views</h3>
+/// <ul>
+///   <li>
+///     Supports secure card entry via <code>createSecureView(additionalFields:completion:)</code>
+///   </li>
+///   <li>
+///     Supports secure bank account entry via <code>createBankAccountView(additionalFields:completion:)</code>
+///   </li>
+///   <li>
+///     PCI-compliant data handling with external encryption and tokenization
+///   </li>
+/// </ul>
+/// <h3>Apple Pay Integration</h3>
+/// <ul>
+///   <li>
+///     Detects Apple Pay availability
+///   </li>
+///   <li>
+///     Provides Apple Pay button creation
+///   </li>
+///   <li>
+///     Manages Apple Pay transaction processing
+///   </li>
+/// </ul>
+/// <h3>Fraud Monitoring & 3D Secure</h3>
+/// <ul>
+///   <li>
+///     Creates fraud monitoring sessions via <code>createFraudMonitorSession(merchantId:completion:)</code>
+///   </li>
+///   <li>
+///     Supports 3D Secure authentication via <code>perform3DSFlow(view:threeDSData:handler:)</code>
+///   </li>
+/// </ul>
+/// <h2>Usage Example</h2>
+/// \code
+/// // Initialize PayEngine
+/// let payEngine = PayEngine(config: config)
+///
+/// // Create a secure card entry view
+/// payEngine.createSecureView(additionalFields: []) { result in
+///     switch result {
+///     case .success(let view):
+///         self.view.addSubview(view)
+///     case .failure(let error):
+///         print("Error: \(error)")
+///     }
+/// }
+///
+/// \endcodeseealso:
+/// <code>ICardNumberView</code>, <code>IBankAccountView</code>, <code>PEApplePay</code>
 SWIFT_CLASS("_TtC12PayEngineSDK9PayEngine")
 @interface PayEngine : NSObject
-/// Constructor
-/// \param config PayEngine configuration
+/// Initializes the <code>PayEngine</code> with the given configuration.
+/// \param config The configuration object <code>PEConfig</code> containing necessary settings.
 ///
 - (nonnull instancetype)initWithConfig:(PEConfig * _Nonnull)config OBJC_DESIGNATED_INITIALIZER;
+/// Sets the theme mode for the PayEngine UI components.
+/// \param themeMode The desired theme mode <code>PEThemeMode</code>.
+///
 + (void)setThemeMode:(enum PEThemeMode)themMode;
-- (PEComponent * _Nonnull)createComponentWithName:(NSString * _Nonnull)name props:(NSDictionary<NSString *, NSString *> * _Nonnull)props SWIFT_WARN_UNUSED_RESULT;
+/// Creates a secure card entry view for collecting payment details.
+/// \param additionalFields Optional additional fields to be included of type <code>PEField</code>.
+///
+/// \param completion A closure returning the <code>ICardNumberView</code> instance.
+///
 - (void)createSecureViewWithAdditionalFields:(NSArray<PEField *> * _Nullable)additionalFields completion:(void (^ _Nonnull)(ICardNumberView * _Nonnull))completion;
+/// Creates a secure bank account entry view.
+/// \param additionalFields Optional additional fields to be included.
+///
+/// \param completion A closure returning the <code>IBankAccountView</code> instance.
+///
 - (void)createBankAccountViewWithAdditionalFields:(NSArray<PEField *> * _Nullable)additionalFields completion:(void (^ _Nonnull)(IBankAccountView * _Nonnull))completion;
+/// Retrieves browser-related information.
+/// \param view The UI view in which the web view is embedded.
+///
+/// \param handler A closure returning browser details as a <code>String</code>.
+///
 - (void)getBrowserInfoWithView:(UIView * _Nonnull)view handler:(void (^ _Nonnull)(NSString * _Nonnull))handler;
+/// Initiates a 3D Secure authentication process.
+/// \param view The UI view in which the 3D Secure flow should be presented.
+///
+/// \param threeDSData The authentication data required for 3D Secure.
+///
+/// \param handler A closure returning the <code>ThreeDSResult</code> upon completion.
+///
 - (void)perform3DSFlowWithView:(UIView * _Nonnull)view threeDSData:(NSString * _Nonnull)threeDSData handler:(void (^ _Nonnull)(ThreeDSResult * _Nonnull))handler;
+/// Creates a fraud monitoring session.
+/// \param merchantId The merchant’s unique identifier.
+///
+/// \param completion A closure returning the fraud monitoring session ID as a <code>String</code>.
+///
 - (void)createFraudMonitorSessionWithMerchantId:(NSString * _Nonnull)merchantId completion:(void (^ _Nonnull)(NSString * _Nonnull))completion;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
-SWIFT_CLASS("_TtC12PayEngineSDK14ThreeDSMessage")
-@interface ThreeDSMessage : NSObject
-- (nullable instancetype)initWithType:(NSString * _Nonnull)type subtype:(NSString * _Nonnull)subtype data:(ThreeDSResult * _Nullable)data error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
-- (nonnull instancetype)init SWIFT_UNAVAILABLE;
-+ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
-@end
-
-@class WKWebView;
-@class WKNavigationAction;
-@class WKNavigation;
-
-SWIFT_CLASS("_TtC12PayEngineSDK12ThreeDSModal")
-@interface ThreeDSModal : UIView <WKNavigationDelegate, WKScriptMessageHandler>
-- (nonnull instancetype)initWithFrame:(CGRect)frame OBJC_DESIGNATED_INITIALIZER;
-- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)coder SWIFT_UNAVAILABLE;
-- (void)setupWithConfig:(PEConfig * _Nonnull)config threeDSData:(NSString * _Nonnull)threeDSData handler:(void (^ _Nonnull)(ThreeDSResult * _Nonnull))handler;
-- (void)setupWebView;
-- (void)webView:(WKWebView * _Nonnull)webView decidePolicyForNavigationAction:(WKNavigationAction * _Nonnull)navigationAction decisionHandler:(void (^ _Nonnull)(WKNavigationActionPolicy))decisionHandler;
-- (void)webView:(WKWebView * _Nonnull)webView didFinishNavigation:(WKNavigation * _Null_unspecified)navigation;
-- (void)userContentController:(WKUserContentController * _Nonnull)userContentController didReceiveScriptMessage:(WKScriptMessage * _Nonnull)message;
-@end
-
 
+/// Type that represents the result for the ThreeDS process
 SWIFT_CLASS("_TtC12PayEngineSDK13ThreeDSResult")
 @interface ThreeDSResult : NSObject
-@property (nonatomic, copy) NSString * _Nullable message;
-@property (nonatomic) BOOL success;
-@property (nonatomic, copy) NSString * _Nullable transactionId;
-- (nullable instancetype)initWithMessage:(NSString * _Nullable)message success:(BOOL)success transactionId:(NSString * _Nullable)transactionId error:(NSError * _Nullable * _Nullable)error OBJC_DESIGNATED_INITIALIZER;
+/// The message for the result
+@property (nonatomic, readonly, copy) NSString * _Nullable message;
+/// Bool indicating whether the transaction was successful or not
+@property (nonatomic, readonly) BOOL success;
+/// Transaction ID resulting after the ThreeDS Flow completion
+@property (nonatomic, readonly, copy) NSString * _Nullable transactionId;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end