@aptos-scp/scp-component-rn-device-services 0.3.0 → 0.4.0

package/ios/Frameworks/Adyen/AdyenToolkit.framework/Headers/ADYCurrency.h

@@ -0,0 +1,33 @@
+//
+// Created by Jeroen Bouma on 10/11/13.
+//
+
+
+#import <Foundation/Foundation.h>
+
+
+@interface ADYCurrency : NSObject
+
+/*
+ The short notation of the name of the currency, like EUR for Euros, USD for
+ United States Dollars and JPY for Japanese Yen
+ */
+@property (nonatomic, readonly) NSString* abbreviation;
+
+/*
+ The symbol for this currency, like $ for Dollars, € for Euros and ¥ for
+ both the Chinese Yuan and Japanese Yen
+ */
+@property (nonatomic, readonly) NSString* symbol;
+
+/*
+ The number of decimal digits this currency has. For example: Euros have
+ two fractional digits called cents; EUR 1.887,95. Other currencies like the
+ Hungarian HUF have no fractional digits ( HUF 1.887 ) and some have three.
+ */
+@property (nonatomic, readonly) NSUInteger numFractionalDigits;
+
+// used by lib to initialize object
+- (instancetype)initWithAbbreviation:(NSString*)abbr symbol:(NSString*)sym numFractionalDigits:(NSUInteger)decimals;
+
+@end

package/ios/Frameworks/Adyen/AdyenToolkit.framework/Headers/ADYDevice.h

@@ -0,0 +1,308 @@
+//
+//  ADYDevice.h
+//  AdyenPOSLib
+//
+//  Created by Jeroen Koops on 4/26/13.
+//
+//
+
+#import <Foundation/Foundation.h>
+
+@class ADYDeviceData;
+@class ADYTransactionRequest;
+@class ADYGiftCardBalanceRequest;
+@protocol ADYDeviceManagerDelegate;
+@class ADYDeviceRegistry;
+@class ADYReceipt;
+@class ADYGiftCardLoadRequest;
+@class ADYGiftCard;
+@class ADYTransactionDetails;
+@class ADYSpecialTransactionRequest;
+@class ADYDevice;
+
+typedef NS_ENUM(NSUInteger, ADYDeviceConnectionType) {
+    ADYDeviceConnectionTypeMFI,
+    ADYDeviceConnectionTypeWifi,
+};
+
+typedef NS_ENUM(NSUInteger, ADYDeviceStatus) {
+    ADYDeviceStatusInitializing,
+    ADYDeviceStatusInitialized,
+    ADYDeviceStatusNotBoarded,
+    ADYDeviceStatusError,
+    ADYDeviceStatusStopped,
+    ADYDeviceStatusGone
+};
+
+@protocol ADYDeviceDelegate <NSObject>
+
+/**
+ * Called to indicate that the status of this device has changed.
+ * @param device device that changed status.
+ * @param status new device status. Check `ADYDeviceStatus` for all possible values.
+ */
+- (void)device:(ADYDevice*)device didChangeStatus:(ADYDeviceStatus)status;
+
+@end
+
+@interface ADYDevice : NSObject
+
+/** ADYDevice Delegate. Set this property for receiving status changes callbacks. **/
+@property (nonatomic, weak) id<ADYDeviceDelegate> delegate;
+
+/** Name of the device. */
+@property (nonatomic, readonly) NSString *name;
+
+/** Hostname or IP address used to connect to a Wifi device. Not used for Bluetooth */
+@property (nonatomic, readonly) NSString *hostname;
+
+/** Type of the connection to the device */
+@property (nonatomic, readonly) ADYDeviceConnectionType connectionType;
+
+/** 
+ * Current status of the device.
+ * This status has one of the following values:
+ *
+ * - `ADYDeviceStatusInitializing`: The device is being initialized. In this status, it is 
+ * not possible to perform payment-transactions with the device.
+ * - `ADYDeviceStatusInitialized`: The device is ready for payment-transactions.
+ * - `ADYDeviceStatusNotBoarded`: The device is ready, but not configured for use by the merchant
+ * that is currently logged in. Use `boardDeviceWithDelegate:` to
+ * attempt to configure the device.
+ * - `ADYDeviceStatusError`: There was an error communicating with the device. Use
+ * `retryConnection` to attempt to re-establish communication
+ * with the device.
+ * - `ADYDeviceStatusStopped`: The device was stopped because the merchant was logged out.
+ * - `ADYDeviceStatusGone`: The device has disconnected. Devices with this status will
+ * not appear on the `devices` list of the `ADYDeviceRegistry` anymore.
+ * However, if you keep a reference to an `ADYDevice` with status `ADYDeviceStatusGone`,
+ * the `ADYDevice` object will remain valid. If the device re-connects at a later
+ * moment, the status of the `ADYDevice` will change back to `ADYDeviceStatusInitializing`
+ * and finally `ADYDeviceStatusInitialized`, and be ready for use once more.
+ */
+@property (nonatomic, readonly) ADYDeviceStatus status;
+
+/**
+   Object containing additional data about the device. 
+   This data is only set when the device's status is
+   `ADYDeviceStatusInitialized` or `ADYDeviceStatusNotBoarded`.
+ */
+@property (nonatomic, readonly) ADYDeviceData *deviceData;
+
+/**
+   Error-object containing error-information about the device. This
+   property is only set when the device's status is
+   `ADYDeviceStatusError`.
+ */
+@property (nonatomic, readonly) NSError *error;
+
+/**
+   Creates an `ADYTransactionRequest`, which is the start of executing
+   a payment-transaction with this device.
+ 
+   After creating the `ADYTransactionRequest`, set all of its relevant properties,
+   and then call `startWithDelegate:` to start the payment-transaction.
+
+   @param reference a merchant-supplied reference for the transaction, as an `NSString`.
+   @param error pointer to an `NSError`, which will be set if the transaction cannot
+   be created for some reason.
+ 
+   @warning When an `ADYTransactionRequest` is created, the `ADYDevice` will _not_
+   keep a reference to it. Therefore, to prevent it from being deallocated, it is important
+   that you keep a reference to it until after the transaction, started with
+   [ADYTransactionRequest startWithDelegate:], has been finished.
+ */
+- (ADYTransactionRequest *)createTransactionRequestWithReference:(NSString *)reference
+                                                           error:(NSError **)error;
+
+/**
+ Creates an `ADYSpecialTransactionRequest`, which is the start of executing
+ a special transaction with this device.
+ 
+ After creating the `ADYSpecialTransactionRequest`, set all of its relevant properties,
+ and then call `startWithDelegate:` to start the payment-transaction.
+ 
+ @param reference a merchant-supplied reference for the transaction, as an `NSString`.
+ @param error pointer to an `NSError`, which will be set if the transaction cannot
+ be created for some reason.
+ 
+ @warning When an `ADYSpecialTransactionRequest` is created, the `ADYDevice` will _not_
+ keep a reference to it. Therefore, to prevent it from being deallocated, it is important
+ that you keep a reference to it until after the transaction, started with
+ [ADYSpecialTransactionRequest startWithDelegate:], has been finished.
+ */
+- (ADYSpecialTransactionRequest *)createSpecialTransactionRequestWithReference:(NSString *)reference
+                                                                         error:(NSError **)error;
+
+/**
+ 
+ Fetches details for the last transactions saved on a payment device.
+ 
+ @param completion A block that is called when transaction details are available or when an error
+ occurs. The block takes two parameters: transactions, which contains an array of transaction
+ details, and error, which contains an error, if one occurred.
+ 
+ */
+- (void)fetchLastTransactionsWithCompletion:(void (^)(NSArray<ADYTransactionDetails *> *transactions, NSError *error))completion;
+
+/**
+ 
+ Fetches details for the specified number of transactions saved on a payment device.
+ 
+ @param count A maximum count of transactions to be fetched.
+ 
+ @param completion A block that is called when transactions details are available or when an error
+ occurs. The block takes two parameters: transactions, which contains an array of transaction
+ details, and error, which contains an error, if one occurred.
+ 
+ */
+- (void)fetchLastTransactionsWithCount:(NSUInteger)count completion:(void (^)(NSArray<ADYTransactionDetails *> *transactions, NSError *error))completion;
+
+/**
+ 
+ Fetches transaction details for the specified tender reference.
+ 
+ @param tenderReference A tender reference used to fetch transaction details.
+ 
+ @param completion A block that is called when transaction details are available or when an error
+ occurs. The block takes two parameters: transaction, which contains transaction details, and
+ error, which contains an error, if one occurred.
+ 
+ */
+- (void)fetchTransactionWithTenderReference:(NSString *)tenderReference completion:(void (^)(ADYTransactionDetails *transaction, NSError *error))completion;
+
+/**
+ 
+ Creates an `ADYGiftCardBalanceRequest`, which is the start of requesting a balance and relevant additional data from a card.
+ 
+ @param error pointer to an `NSError`, which will be set if the transaction cannot be created for some reason.
+ 
+  */
+- (ADYGiftCardBalanceRequest *)createGiftCardBalanceRequestWithError:(NSError **)error;
+
+/**
+ Creates an `ADYGiftCardLoadRequest`, which is the start of loading a cash balance to a card.
+ 
+ @param error pointer to an `NSError`, which will be set if the transaction cannot be created for some reason.
+ */
+- (ADYGiftCardLoadRequest *)createGiftCardLoadRequestWithError:(NSError **)error;
+
+/**
+ Creates an `ADYTransactionRequest`, which is the start of executing a gift card payment transaction with this device.
+ 
+ @param reference a merchant-supplied reference for the transaction, as an `NSString`.
+ @param card a reference for the shopper's gift card
+ @param error pointer to an `NSError`, which will be set if the transaction cannot be created for some reason.
+ 
+  @warning When an `ADYTransactionRequest` is created, the `ADYDevice` will _not_
+   keep a reference to it. Therefore, to prevent it from being deallocated, it is important
+   that you keep a reference to it until after the transaction, started with
+   [ADYTransactionRequest startWithDelegate:], has been finished.
+ 
+ */
+- (ADYTransactionRequest *)createGiftCardTransactionRequestWithReference:(NSString *)reference
+                                                                    card:(ADYGiftCard *)card
+                                                                   error:(NSError **)error;
+
+/**
+ * Creates an `ADYTransactionRequest`.
+ *
+ * @deprecated Use `createTransactionRequestWithReference:error:` instead. If
+ * you _must_ use `createTransactionRequestWithError:`, you _have_ to manually
+ * set a merchant reference by setting option `ADYTransactionOptionReferenceKey`
+ * in the `options` dictionary, or else the transaction will fail.
+ */
+- (ADYTransactionRequest *)createTransactionRequestWithError:(NSError **)error __attribute__((deprecated));
+
+/**
+   Starts an attempt to board the device.
+ 
+   This method will return immediately, the boarding process will proceed asynchronously.
+ 
+   @param delegate a delegate that will be kept informed about the boarding process' progress
+   and outcome.
+ */
+- (void)boardDeviceWithDelegate:(id<ADYDeviceManagerDelegate>)delegate;
+
+/**
+   Re-attempt to identify the payment device. Used this when the status of
+   the device is `ADYDeviceStatusError` and you want to retry the connection.
+   This will (normally) only be useful if something is first changed on either
+   the server (uncouple terminal from Merchant) or on the terminal (delete
+   settings). Otherwise, the device will keep going to status error.
+ */
+- (void)retryConnection;
+
+/**
+ Re-attempt to identify the payment device and update the Device Data
+ 
+ @param completion a completion handler block that will be triggered once device data will be updated or error will be triggered
+ 
+*/
+ - (void)getDeviceDataWithCompletion:(void (^)(ADYDeviceData *, NSError *))completion;
+
+/**
+   DEPRECATED
+
+   Instructs the device to synchronize with the backend immediately.
+ 
+   Normally, the device performs synchronization with the backend at 
+   its own discretion. Call this method to do it right now.
+ 
+   This method returns straight away; communication with the device, and
+   the actual synchronization happens in the background. When synchronization
+   is complete, or an error occurs, the supplied completion-block is called.
+ 
+   @param completion block that is called when synchronization is complete,
+   or an error occurs. In the latter case, the given `NSError` is non-`nil`.
+
+   @deprecated This method is no longer required
+ */
+- (void)synchronizeNowWithCompletion:(void (^)(NSError *))completion;
+
+/**
+   DEPRECATED
+
+   Instructs the device to prompt the user for permission to install
+   a new firmware-version, if a new firmware-version is available.
+ 
+   The device is aware of the availabiliy of a new firmware-version by a
+   prior call to `synchronizeNowWithCompletion:`, or a synchronization performed
+   on its own initiative.
+ 
+   This method returns straight away; communication with the device happens
+   in the background. As soon as communication is finished, or an error occurs,
+   the supplied completion-block is called.
+ 
+   @param completion block that is called when synchronization is complete, or an error
+   occurs. In the latter case the given `NSError` is non-`nil`. Note that the operation
+   is considered complete when the device shows a prompt to the user. This doesn't
+   necessarily mean that the user agrees to install the update, or that installing the update
+   will succeed.
+
+   @deprecated This method is no longer required
+ */
+
+- (void)installUpdateWhenAvailableWithCompletion:(void (^)(NSError *))completion;
+
+// TODO: WithCompletion:(void (^)(NSError *))completion;
+- (void)printReceipt:(ADYReceipt *)receipt withCompletion:(void (^)(NSError *))completion;
+
+/**
+   Description of the device, for debug-purposes only.
+ */
+- (NSString *)description;
+- (NSDictionary *)dictionaryRepresentation;
+
+- (void)ping;
+
+/**
+ *  List of all supported MFi protocol names
+ */
++ (NSArray *)supportedAccessoryProtocolNames;
+
+- (void)restartAccessoryConnection;
+
+- (NSString *)statusAsString;
+
+@end

package/ios/Frameworks/Adyen/AdyenToolkit.framework/Headers/ADYDeviceData.h

@@ -0,0 +1,52 @@
+//
+//  ADYDeviceData.h
+//  AdyenPOSLib
+//
+//  Created by Jeroen Koops on 4/10/13.
+//
+//
+
+#import <Foundation/Foundation.h>
+
+@interface ADYDeviceData : NSObject <NSCopying>
+
+@property (nonatomic, strong) NSString *terminalId;
+@property (nonatomic, strong) NSString *terminalMacAddress;
+@property (nonatomic, strong) NSString *terminalConfiguredName;
+@property (nonatomic, strong) NSString *terminalBrand;
+@property (nonatomic, strong) NSString *terminalType;
+@property (nonatomic, strong) NSString *terminalSerialNumber;
+@property (nonatomic, strong) NSString *terminalApiVersion;
+@property (nonatomic, strong) NSString *terminalApiVersionUpgrade;
+@property (nonatomic, strong) NSString *upgradeLastReceivedInstallOrder;
+@property (nonatomic, strong) NSString *upgradeLastInstallOrderToSend;
+@property (nonatomic, strong) NSString *upgradeBytesReceived;
+@property (nonatomic, assign) BOOL updateAvailable;
+@property (nonatomic, strong) NSString *terminalOsVersion;
+@property (nonatomic, strong) NSString *terminalHardwareVersion;
+@property (nonatomic, strong) NSNumber *batteryPercentage;
+@property (nonatomic, strong) NSNumber *printerWidthInPixels;
+@property (nonatomic, assign) NSUInteger terminalUnconfirmedBatches;
+@property (nonatomic, strong) NSArray *terminalMerchantAccounts;
+@property (nonatomic, assign) BOOL isBoarded;
+@property (nonatomic, assign) BOOL hasDUKPT;
+@property (nonatomic, readonly) BOOL hasPrinter;
+@property (nonatomic, readonly) BOOL hasPINDigitNotification;
+@property (nonatomic, readonly) BOOL hasCardInsertionRemovalNotification;
+
+@property (nonatomic, assign) BOOL readyForTender;
+
+@property (nonatomic, assign) BOOL live;
+@property (nonatomic, readonly) BOOL supportsLiveProperty;
+
+/** `nil` if interface-version is unknown, a version-string if it is known. */
+@property (nonatomic, strong) NSString *interfaceVersion;
+@property (nonatomic, readonly) NSNumber *interfaceVersionNumber;
+
+/**
+ *  Provides a string with list of few properties
+ *
+ */
+- (NSString *)shortInfo;
+
+@end

package/ios/Frameworks/Adyen/AdyenToolkit.framework/Headers/ADYDeviceManagerDelegate.h

@@ -0,0 +1,66 @@
+//
+//  ADYDeviceManagerDelegate.h
+//  AdyenPOSLib
+//
+//  Created by Jeroen Koops on 4/11/13.
+//
+//
+
+#ifndef AdyenPOSLib_ADYEMVDeviceManagerDelegate_h
+#define AdyenPOSLib_ADYEMVDeviceManagerDelegate_h
+
+/**
+ * Delegate used by [Adyen boardDeviceWithDelegate:] to keep the caller
+ * informed about the configuration's progress and completion.
+ * 
+ * Configuring a device consists of 5 steps. These are represented by the
+ * enum `ADYEMVDeviceManagerStep`, with possible values:
+ *
+ * 1. `ADYEMVDeviceManagerStepIdentifyPaymentDevice`: query the payment device about its identity.
+ * 2. `ADYEMVDeviceManagerStepRegisterPaymentDevice`: register the payment device with the backend.
+ * 3. `ADYEMVDeviceManagerStepLoadConfiguration`: load the device's configuration from the backend.
+ * 4. `ADYEMVDeviceManagerStepStoreConfiguration`: store the new configuration on the device.
+ * 5. `ADYEMVDeviceManagerStepCheckConfiguration`:  check that the new configuration has been installed successfully.
+ */
+
+// Documenting enums is not supported by appledoc, hence the kludge
+typedef NS_ENUM(NSUInteger, ADYEMVDeviceManagerStep) {
+    ADYEMVDeviceManagerStepIdentifyPaymentDevice,
+    ADYEMVDeviceManagerStepRegisterPaymentDevice,
+    ADYEMVDeviceManagerStepLoadConfiguration,
+    ADYEMVDeviceManagerStepStoreConfiguration,
+    ADYEMVDeviceManagerStepCheckConfiguration
+};
+
+
+@protocol ADYDeviceManagerDelegate
+
+/**
+ * Called to indicate that the given configuration-step will be executed.
+ * @param step step that will be executed
+ */
+-(void)deviceManagerWillBeginStep:(ADYEMVDeviceManagerStep)step;
+
+/**
+ * Called to indicate that the given configuration-step has been executed successfully
+ * @param step step that has been executed
+ */
+-(void)deviceManagerDidCompleteStep:(ADYEMVDeviceManagerStep)step;
+
+/**
+ * Called to indicate that the given configuration-step failed to execute. After this
+ * method has been called, configuration is terminated and no more methods will be called
+ * on the delegate.
+ * @param step step that failed to executed
+ */
+-(void)deviceManagerDidFailStep:(ADYEMVDeviceManagerStep)step withError:(NSError*)error;
+
+/**
+ * Called to indicate that configuration was successful. After this method has been called,
+ * no more methods will be called on the delegate.
+ */
+-(void)deviceManagerDidComplete;
+
+@end
+
+#endif

package/ios/Frameworks/Adyen/AdyenToolkit.framework/Headers/ADYDeviceRegistry.h

@@ -0,0 +1,125 @@
+//
+//  ADYDeviceRegistry.h
+//  AdyenPOSLib
+//
+//  Created by Jeroen Koops on 4/24/13.
+//
+//
+
+#import <Foundation/Foundation.h>
+
+@class ADYDevice;
+
+@protocol ADYDeviceRegistryDelegate <NSObject>
+
+@optional
+
+/**
+ * Called to indicate that a device was added to devices list.
+ * @param device `ADYDevice` that was added.
+ */
+- (void)deviceRegistryDidAddDevice:(ADYDevice *)device;
+
+/**
+ * Called to indicate that a device was removed from devices list.
+ * @param device `ADYDevice` that was removed.
+ */
+- (void)deviceRegistryDidRemoveDevice:(ADYDevice *)device;
+
+@end
+
+@interface ADYDeviceRegistry : NSObject
+
+/**
+   List of currently connected devices.
+ 
+   When new devices
+   become connected, they will be added to this list, and
+   when devices go away, they'll be taken out of this list.
+ 
+   This list is fully KVO-compliant. This means that if you
+   add an observer like this:
+  
+       [deviceRegistry addObserver:observer
+                        forKeyPath:@"devices"
+                           options:NSKeyValueObservingOptionsInitial|
+                                   NSKeyValueObservingOptionsOld|
+                                   NSKeyValueObservingOptionsNew
+                           context:NULL];
+  
+   ..., then your observer will be notified immediately of the
+   devices present, and after that of any change.
+
+   @note when a device disconnects, the corresponding `ADYDevice` will be removed
+   from the `devices` array. If you still have a reference to the `ADYDevice` instance,
+   however, you can keep using it. Its status will be set to `ADYDeviceStatusGone` to 
+   indicate that it's no longer connected. If the device reconnects at some later moment,
+   the same `ADYDevice` instance will be reused, and its status will be updated to reflect
+   the fact that it is now, once again, connected.
+
+   @return a list of currently connected devices
+ */
+
+@property (nonatomic, readonly) NSMutableArray *devices;
+
+/** ADYDeviceRegistry Delegate.
+ * Set this property for receiving notifications when devices are added/removed.
+ */
+@property (nonatomic, weak) id<ADYDeviceRegistryDelegate> delegate;
+
+/**
+ * Finds a bluetooth `ADYDevice` with the given name.
+ *
+ * Note that, if `name` is not `nil`, this method will _always_ 
+ * return an `ADYDevice`,
+ * even when a bluetooth device by that name is not currently
+ * connected. In that case, the state of the returned device
+ * will be `ADYDeviceStatusGone`. If a bluetooth-device with
+ * the given name is connected later, the state of the 
+ * returned `ADYDevice` will change first to `ADYDeviceStatusInitializing`
+ * and then to `ADYDeviceStatusInitialized`, and it will have become
+ * an `ADYDevice` usable for transactions.
+ *
+ * What this means is that, if you know the name of the device to be
+ * used (because you stored it in the `NSUserDefaults`, for example) you
+ * can simply call `findDeviceByName:` to get an `ADYDevice`, and then
+ * observe its `status` using key-value observing to be notified when
+ * it becomes available or unavailable.
+ *
+ * @return an `ADYDevice` representing the bluetoothdevice with the given
+ * name, or `nil` if `name` is `nil`.
+ */
+- (ADYDevice *)findDeviceByName:(NSString *)name;
+
+/**
+ * Adds a WiFi `ADYDevice` with the given hostname/ip address.
+ *
+ * Just like `findDeviceByName:`, this method will _always_
+ * return an `ADYDevice` if hostname is not `nil`.
+ *
+ * The `ADYDeviceRegistry` will attempt to connect to the device
+ * and after connecting it will periodically check if the device
+ * is still online. The `state` of the returned device will be updated
+ * accordingly.
+ *
+ * Overall, Wifi devices will behave very similar to bluetooth
+ * devices. The only difference is that WiFi devices will _always_ be
+ * present in the `devices` array, even if they are not connected/online.
+ */
+- (ADYDevice *)addDeviceWithHostname:(NSString *)hostname;
+
+/**
+ * Removes `ADYDevice`s that were added using `addDeviceWithHostname:`.
+ */
+- (void)removeDeviceWithHostname:(NSString *)hostname;
+
+
+/// Bonjour
+//- (void)startPolling;
+//- (void)stopPolling;
+
+// Dictionary of conncted devices with their name, terminalId and status
+- (NSArray *)devicesWithTerminalIdAndStatus;
+- (ADYDevice *)deviceByTerminalId:(NSString *)terminalId;
+
+@end

package/ios/Frameworks/Adyen/AdyenToolkit.framework/Headers/ADYDynamicCurrencyConversionData.h

@@ -0,0 +1,22 @@
+//
+// Created by Jeroen Bouma on 17/03/14.
+//
+
+#import <Foundation/Foundation.h>
+
+
+@interface ADYDynamicCurrencyConversionData : NSObject
+
+@property (readonly) NSString *originalAmountCurrency;
+@property (readonly) NSNumber *originalAmountValue;         //minor units (fraction depends on currency)
+
+@property (readonly) NSString *convertedAmountCurrency;
+@property (readonly) NSNumber *convertedAmountValue;        //minor units (fraction depends on currency)
+
+@property (readonly) NSNumber *exchangeRate;
+
+@property (readonly) NSString *source;
+@property (readonly) NSNumber *commissionFee; //currency = ?
+@property (readonly) NSNumber *markup; //in base points
+
+@end