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

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

@@ -0,0 +1,279 @@
+//
+//  ADYTransactionProcessorDelegate.h
+//  AdyenPOSLib
+//
+//  Created by Jeroen Koops on 4/11/13.
+//
+//
+
+#import "ADYConstants.h"  
+
+@class ADYSignatureRequest;
+@class ADYAdditionalDataRequest;
+@class ADYPrintReceiptRequest;
+@class ADYReferralRequest;
+@class ADYTransactionData;
+@class ADYDynamicCurrencyConversionData;
+
+typedef NS_ENUM(NSUInteger, ADYCardStatus) {
+
+    ADYCardStatusCardRemoved,
+    ADYCardStatusNextTransaction,
+    ADYCardStatusError,
+    ADYCardStatusNotSupported
+} ;
+
+/**
+ * Delegate used to receive updates about a transaction's progress and completion.
+ */
+@protocol ADYTransactionProcessorDelegate <NSObject>
+
+/** @name Transaction completion */
+
+/**
+ * This method is called when the transaction completes successfully. 
+ *
+ * Successful completion does *not* necessarily mean that a payment has been made - 
+ * the transaction may also have been declined or cancelled. This can be determined
+ * by examining the given `transaction`'s `status`.
+ *
+ * After this method has been called, no other methods on the delegate will be called.
+ * @param transaction a data-object containing transaction-details.
+ */
+-(void)transactionComplete:(ADYTransactionData*)transaction;
+
+/** @name Transaction-processing callbacks */
+
+/**
+ * Called when a signature must be confirmed as part of processing a transaction.
+ *
+ * After this method has been called, transaction-processing will be paused until
+ * either `submitConfirmedSignature:` or `submitUnconfirmedSignature:` has been called
+ * on the given `signatureRequest`.
+ *
+ * This method must be implemented in two different ways, depending on the presence
+ * of a printer on the payment-device (as determined by the `paymentDeviceHasPrinter`
+ * method on the Adyen class).
+ *
+ * If the device has a printer, it will first print a receipt, which must be signed 
+ * by the customer. The attendant will then compare this signature to the signature on
+ * the card, and either confirm that they are identical, or not. This method must be 
+ * implemented to show a user-interface where the attendant can choose between
+ * "Confirmed" or "Not confirmed", for example by pressing a button. Subsequently,
+ * the method must call either `submitConfirmedSignature:` or `submitUnconfirmedSignature:`
+ * on the `signatureRequest`, both with `nil` as the `signatureImage` parameter, to
+ * continue transaction processing.
+ *
+ * If the device does not have a printer, this method must be implemented to display 
+ * a user-interface on which the customer can draw a signature. The attendant must
+ * then have the choice to either confirm, or not, the drawn signature after comparing
+ * it to the signature on the card - for example,
+ * by pressing a button. Subsequently, the method must call either `submitConfirmedSignature:`
+ * or `submitUnconfirmedSignature:` on the given `signatureRequest`, both with the drawn 
+ * image as `signatureImage` parameter.
+ *
+ * Note that, instead of calling `submitConfirmedSignature:` or `submitUnconfirmedSignature:`,
+ * it is also possible to cancel the transaction at this point as usual, by 
+ * calling `[ADYTransactionRequest requestCancel]`.
+ * After a transaction has been cancelled, subsequent calls to `submitConfirmedSignature:` 
+ * or `submitUnconfirmedSignature:` will have no effect.
+ *
+ * @param signatureRequest Request-object used to continue transaction processing.
+ */
+ 
+-(void)transactionRequiresSignature:(ADYSignatureRequest*)signatureRequest;
+
+/**
+ * Called when a transaction provides additional data, for example loyalty-related data,
+ * providing the app with an opportunity to modify the amount charged based on that data.
+ *
+ * After this method has been called, transaction-processing will be paused until
+ * `continueWithUpdatedAmount:` is called on the given `additionalDataRequest`, either
+ * with an `NSNumber` to update the amount, or with `nil` to continue with the original
+ * amount.
+ *
+ * Note that, instead of calling `continueWithUpdatedAmount`, it it also possible
+ * to cancel the transaction at this point as usual, by calling `[ADYTransactionRequest requestCancel]`.
+ * After the transaction has been cancelled, subsequent calls to `continueWithUpdatedAmount:`
+ * will have no effect.
+ *
+ * @param additionalDataRequest object containing the additional data, and methods to 
+ * continue transaction-processing.
+ */
+
+-(void)transactionProvidesAdditionalData:(ADYAdditionalDataRequest*)additionalDataRequest;
+
+/**
+ * Called when a receipt must be printed out by the app.
+ *
+ * After this method has been called, transaction-processing will be paused until
+ * `confirmReceiptPrinted:` is called on the given `printReceiptRequest`.
+ *
+ * This method must be implemented to print a receipt on paper, based on the data
+ * provided in the `printReceiptRequest`.
+ *
+ * Note that, instead of calling `[ADYPrintReceiptRequest confirmReceiptPrinted:]`, it
+ * is also possible to cancel the transaction at this point by calling 
+ * `[ADYTransactionRequest requestCancel]`. If this is done, do not call `confirmReceiptPrinted:`
+ * anymore. However, it is possible that `transactionRequiresPrintedReceipt:` will be called
+ * a second time as part of the transaction-flow. If that happens, and it is not desirable to
+ * print out a receipt at that time, cancel the transaction again.
+ *
+ *
+ * @param printReceiptRequest object containing receipt-data, and methods to continue
+ * transaction-processing.
+ */
+-(void)transactionRequiresPrintedReceipt:(ADYPrintReceiptRequest*)printReceiptRequest;
+
+
+/**
+ * Called when a transaction requires referral.
+ *
+ * After this method has been called, transaction-processing will be paused until
+ * `confirmReferralWithCode:` is called on the given `referralRequest`.
+ *
+ * This method must be implemented to ask for referral authorisation code.
+ *
+ *
+ * @param referralRequest object containing referral data, and method to continue
+ * transaction processing with auth code.
+ */
+-(void)transactionRequiresReferral:(ADYReferralRequest*)referralRequest;
+
+
+@optional
+
+/**
+ * The payment device found it possible to allow the shopper to pay in their own currency
+ * using Direct Currency Conversion. The payment device is currently displaying this
+ * option to the shopper. This call is only informative, the shopper has to decide.
+ *
+ * @param data The details of the DCC option.
+ */
+- (void)transactionSuggestsDcc:(ADYDynamicCurrencyConversionData *)data;
+
+/**
+ * The shopper has entered a gratuity on the payment device. This can only occur if the
+ * `ADYTransactionOptionAskGratuity' option was passed to the ADYTransactionRequest.
+ * Setting this option triggers the payment device to ask the shopper if they would like
+ * to give a gratuity (tip) to the merchant.
+ *
+ * @param gratuityAmountMinorUnits The amount of gratuity given in minor units. The currency
+ * is the same as the transaction.
+ */
+- (void)transactionGratuityEntered:(int)gratuityAmountMinorUnits;
+
+/** @name Transaction progress */
+
+/**
+ * Indicates that an application has been selected by the user.
+ * In payment terms, an application is a manner to make a payment -
+ * for example, one single card can allow for both Maestro and Mastercard
+ * payments. After the card has been inserted, the cardholder will be prompted
+ * by the terminal to select one of the supported applications. After
+ * he's made his choice, the `transactionApplicationSelected:` callback will
+ * be called, with the name of the selected application as argument.
+ *
+ * @note Application selection events are only supported on terminals with firmware
+ * version p30 or greater.
+ */
+-(void)transactionApplicationSelected:(NSString*)application;
+
+/**
+ * Indicates that one digit of a pincode has been entered. The total number
+ * of digits entered so far is passed as an argument.
+ *
+ * Note that there's no way to know in advance of how many digits the pincode
+ * exists - it may be 4, 5, or 6 digits, or even more. However, before the
+ * the pincode is entered, `transactionStatChanged:` will be called with
+ * a `state` of `ADYTenderStateWaitingForPin`, and after the pincode has been 
+ * completed, it will be called again with a state of `ADYTenderStatePinEntered`.
+ *
+ * Note also backspaces entered by the user while entering the pincode are not 
+ * transmitted. This means that if the user enters two digits, then presses 
+ * backspace, then enters another digits, `transactionPinDigitEntered:` will
+ * be called three times: the first time with an argument of `1`, then with
+ * an argument of `2`, and finally again with an argument of `2`.
+ *
+ * @note PIN entry events are only supported on terminals with firmware
+ * version p30 or greater.
+ */
+-(void)transactionPinDigitEntered:(NSUInteger)numberOfDigitsEntered;
+
+/**
+ * After the transaction has finished, indicates whether the card 
+ * was removed. 
+ * This option is only supported by certain terminal firmware versions.
+ * Possible values of the `status` are:
+ * 
+ * - `ADYCardStatusRemoved`: the card has been removed from the terminal.
+ * - `ADYCardStatusNextTransaction`: a subsequent transaction was started 
+ * on the terminal before the card was removed. 
+ * - `ADYCardStatusError`: an error occurred communicating with the terminal
+ * before the card was removed.
+ * - `ADYCardStatusNotSupported`: card removal notification is not supported 
+ * by this version of the terminal firmware.
+ */
+-(void)transactionCardRemoved:(ADYCardStatus)status;
+
+/**
+ * If the connection with the payment device is lost during a transaction,
+ * it is no longer possible for us to get the status or send commands. The
+ * delegate will be notified of this situation through the
+ * `transactionConnectionLost` and `transactionConnectionRestored` methods.
+ * The `TransactionProcessor` will wait for the device to reconnect and try
+ * to resume the transaction until a timeout occurs.
+ *
+ * While the connection is lost, no commands will be delivered to the device
+ * and no state changes can take place. The delegate is therefor expected to
+ * respect this state and block user interaction that would trigger status
+ * changes for the transaction; example: submitting a signature.
+ *
+ * Cancelling the transaction will be instant while the connection is lost;
+ * the device won't be updated and the transaction will simply be discarded.
+ * Although the lib/iOS application can continue at this point, the device
+ * may wait for a timeout on their side. Until that point, a new transaction
+ * can not be started.
+ */
+-(void)transactionConnectionLost;
+
+/**
+ * If the connection with the payment device is lost during a transaction,
+ * it is no longer possible for us to get the status or send commands. The
+ * delegate will be notified of this situation through the
+ * `transactionConnectionLost` and `transactionConnectionRestored` methods.
+ * The `TransactionProcessor` will wait for the device to reconnect and try
+ * to resume the transaction until a timeout occurs.
+ *
+ * While the connection is lost, no commands will be delivered to the device
+ * and no state changes can take place. The delegate is therefor expected to
+ * respect this state and block user interaction that would trigger status
+ * changes for the transaction; example: submitting a signature.
+ *
+ * Cancelling the transaction will be instant while the connection is lost;
+ * the device won't be updated and the transaction will simply be discarded.
+ * Although the lib/iOS application can continue at this point, the device
+ * may wait for a timeout on their side. Until that point, a new transaction
+ * can not be started.
+ */
+-(void)transactionConnectionRestored;
+
+/**
+ * Called when the state of the transaction changes.
+ *
+ * This method can be used to reflect the progress in the user-interface.
+ *
+ * @param state the new transaction-processing state.
+ */
+-(void)transactionStateChanged:(ADYTenderState)state;
+
+
+/**
+ * This method is called when the transaction starts
+ *
+ * @param transaction a data-object containing transaction-details.
+ */
+-(void)transactionStarted:(ADYTransactionData *)transaction;
+
+
+@end

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

@@ -0,0 +1,108 @@
+//
+//  ADYTransactionRequest.h
+//  AdyenPOSLib
+//
+//  Created by Jeroen Koops on 4/12/13.
+//
+//
+
+#import <Foundation/Foundation.h>
+#import "ADYTransactionProcessorDelegate.h"
+
+@class ADYTransactionProcessor;
+@class CLLocation;
+
+/**
+Request for a payment transaction.
+ 
+Obtain a request by calling `createTransactionRequestWithReference:` on the `ADYDevice` instance of choice. Then,
+fill in all required properties. Finally, start the transaction by calling startWithDelegate:. The
+delegate will be informed of the transaction's progress, and when the transaction is complete.
+Finally, you can call `requestCancel` to request cancellation of the running transaction.
+
+As of version 1.9, no location needs to be set on the transaction using `ADYTransactionOptionLocationKey`;
+ it is fetched by the Adyen Framework itself. It is however required for the user to have Location
+ Services enabled. If this isn't the case, the transaction will not start.
+ Adyen is legally obliged to register the location, in order to be able to prove that transactions
+ are only performed in the certified area.
+
+It is possible to pass optional parameters to the transaction via the *options* dictionary.
+Use the following pre-defined constants as keys on your dictionary:
+
+- `ADYTransactionOptionReferenceKey` : the transaction reference as a NSString instance.
+- `ADYTransactionOptionLogoKey` : the merchant logo for the transaction as a UIImage instance.
+- `ADYTransactionOptionCustomReceiptLinesKey` : the additional receipt lines to be added to the receipt.
+- `ADYTransactionOptionCustomReceiptHandler` : force the receipt printing will be handled by app.
+- `ADYTransactionOptionShopperReferenceKey` : the shopper reference for the transaction as a NSString instance.
+- `ADYTransactionOptionShopperEmailKey` : the shopper email for the transaction as a NSString instance.
+- `ADYTransactionOptionShopperRecurringContractKey` : the recurring contract for the transaction. Provide none or one of the following: ADYTransactionOptionShopperRecurringContractOneClick, ADYTransactionOptionShopperRecurringContractRecurring, ADYTransactionOptionShopperRecurringContractBoth
+- `ADYTransactionOptionAdditionalDataKey` : presence of this key in transaction options will trigger an additional interaction step between POS and PED. In this step several data elements, based on the card, will be offered to the POS. This allows for amount adjustments (discounts), shopper recognition (within your Company). This option is also a required 'configuration' for Dynamic Currency Conversion (DCC).
+- `ADYTransactionOptionAskGratuity`: presence of this key in transaction options (value is irrelevant) will cause the payment device to ask for a gratuity.
+- `ADYTransactionOptionManualKeyedEntry`: presence of this key in transaction options (value is irrelevant) will cause the payment device to use manual keyed entry mode, if supported.
+- `ADYTransactionOptionAllowShopperAIDSelection`: presence of this key in transaction options (value is irrelevant) will allow shopper to select AID on terminal, if supported.
+- `ADYTransactionOptionMOTO`: presence of this key in transaction options (value is irrelevant) will trigger MOTO transaction on the terminal.
+ 
+If one wants to use the transaction details to be able to perform at a later stage a recurring
+transaction, using the transaction details of the current POS transaction, one needs to populate
+the following fields:
+- ADYTransactionOptionShopperReferenceKey
+- ADYTransactionOptionShopperEmailKey
+- ADYTransactionOptionShopperRecurringContractKey
+(see the Adyen Recurring Manual for details)
+
+ 
+*/
+@interface ADYTransactionRequest : NSObject
+
+/** A merchant-supplied reference for the transaction */
+@property (nonatomic, strong) NSString *reference;
+
+/** The type of the transaction, see `ADYTransactionType` for details. Defaults to ADYTransactionTypeGoodsServices. */
+@property (nonatomic, assign) ADYTransactionType transactionType;
+
+/** The currency to use on the transaction. */
+@property (nonatomic, strong) NSString *currency;
+
+/** The amount to process on the transaction in minor units (cents). */
+@property (nonatomic, strong) NSNumber *amount;
+
+/** Gratuity amount in cents, or `nil` if no gratuity desired. */
+@property (nonatomic, strong) NSNumber *gratuity;
+
+/** Locale of the transaction, or `nil` to use default locale. */
+@property (nonatomic, strong) NSLocale *locale;
+
+/** Store identifier. */
+@property (nonatomic, strong) NSString *store;
+
+/** 
+ Optional property to set staff name who starts a transaction. If you support staff management within your app,
+ use this property to differentiate transactions started by different staff members.
+ */
+@property (nonatomic, strong) NSString *cashregisterAgent;
+
+/** Optional dictionary with transaction options. Only NSString typed values are allowed */
+@property (nonatomic, strong) NSDictionary *options;
+
+/** Optional dictionary to specify RAW additionalData keys and values to be passed to tender */
+@property (nonatomic, strong) NSMutableDictionary *additionalData;
+
+/**
+ * Starts the transaction.
+ *
+ * @param delegate this delegate will be informed of the transaction's progress and completion.
+ * @param error if the transaction cant be started, the error will be set.
+ */
+- (BOOL)startWithDelegate:(id<ADYTransactionProcessorDelegate>)delegate error:(NSError **)error;
+
+/**
+ * Requests for the transaction to be cancelled.
+ * This is only a _request_ for cancellation. It is up to the payment device to honour this request
+ * or not. This method returns immediately, the delegate given in the call to
+ * startWithDelegate: will continue to receive updates on the transaction's status, and completion. If 
+ * cancellation is successful, the status of the completed transaction will be `FinalStateCANCELLED`,
+ * but if the transaction could not be cancelled, it will be one of the other final states.
+ */
+- (void)requestCancel;
+
+@end

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

@@ -0,0 +1,30 @@
+//
+//  ADYUIKit.h
+//  Pods
+//
+//  Created by Taras Kalapun on 1/7/16.
+//
+//
+
+#import <Foundation/Foundation.h>
+#import "ADYConstants.h"
+
+#if PLATFORM_IOS
+#import <UIKit/UIKit.h>
+#define ADYImageClassName UIImage
+#define ADYColorClassName UIColor
+#elif PLATFORM_OSX
+#define ADYImageClassName NSImage
+#define ADYColorClassName NSColor
+#endif
+
+@interface ADYUIKit : NSObject
+
++ (NSData *)pngRepresentationFromImage:(ADYImageClassName *)image;
+
+/**
+ * @param maxSize maximum resulting data-size, in kilobytes.
+ */
++ (NSData *)signatureDataFromImage:(ADYImageClassName *)image withMaxSize:(NSUInteger)maxSize;
+
+@end