@thegrizzlylabs/react-native-genius-scan 5.0.0-beta6 → 5.0.0-beta8

package/ios/GSSDK/GSSDK.xcframework/ios-arm64_x86_64-simulator/GSSDK.framework/Headers/GSSDK-Swift.h

@@ -306,6 +306,19 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 
 
 
+/// The type of document detected by the document finder.
+typedef SWIFT_ENUM(NSInteger, GSKDocumentFinderImageType, closed) {
+/// No document present in the image
+  GSKDocumentFinderImageTypeNoDocument = 0,
+/// A document present in the image, but no crop, perspective correction have been applied
+  GSKDocumentFinderImageTypeUnwarped = 1,
+/// A document present in the image, and crop, perspective correction have been applied
+  GSKDocumentFinderImageTypeWarped = 2,
+/// A document present in the image, crop/perspective correction and
+/// enhanced have been applied.
+  GSKDocumentFinderImageTypeEnhanced = 3,
+};
+
 @class GSKPDFDocument;
 @class GSKDocumentGeneratorConfiguration;
 
@@ -406,7 +419,7 @@ SWIFT_CLASS("_TtC5GSSDK12GSKOCRResult")
 @property (nonatomic, readonly, copy) NSString * _Nonnull text;
 /// The recognized text, as a structured text layout.
 @property (nonatomic, readonly, strong) GSKTextLayout * _Nonnull textLayout;
-- (nonnull instancetype)initWithText:(NSString * _Nonnull)text textLayout:(GSKTextLayout * _Nonnull)textLayout OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)initWithText:(NSString * _Nonnull)text textLayout:(GSKTextLayout * _Nonnull)textLayout;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
@@ -629,6 +642,7 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
+
 @interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
 /// Create a configuration from a dictionary.
 /// This is particularly useful for interfacing with React Native but shouldn’t
@@ -637,7 +651,6 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
-
 /// Enum that defines various errors that can occur during a scan flow.
 typedef SWIFT_ENUM(NSInteger, GSKScanFlowError, open) {
 /// User has canceled the scan flow
@@ -770,29 +783,29 @@ typedef SWIFT_ENUM(NSUInteger, GSKScanFlowSource, open) {
   GSKScanFlowSourceLibrary = 2,
 };
 
-@class GSKScanFlowStructuredDataResultBankDetails;
-@class GSKScanFlowStructuredDataResultContact;
-@class GSKScanFlowStructuredDataResultReceipt;
+@class GSKStructuredDataBankDetails;
+@class GSKStructuredDataContact;
+@class GSKStructuredDataReceipt;
 
 /// The result of a structured data extraction.
 SWIFT_CLASS("_TtC5GSSDK31GSKScanFlowStructuredDataResult")
 @interface GSKScanFlowStructuredDataResult : NSObject
 /// Present if bank details extraction was requested, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultBankDetails * _Nullable bankDetails;
+@property (nonatomic, strong) GSKStructuredDataBankDetails * _Nullable bankDetails;
 /// Present if business card contact extraction was requested and a contact was
 /// succcessfully extracted, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultContact * _Nullable businessCardContact;
+@property (nonatomic, strong) GSKStructuredDataContact * _Nullable businessCardContact;
 /// Present if receipt extraction was requested and a receipt/invoice was
 /// succcessfully extracted, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultReceipt * _Nullable receipt;
+@property (nonatomic, strong) GSKStructuredDataReceipt * _Nullable receipt;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
 
 
 /// Address data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultAddress")
-@interface GSKScanFlowStructuredDataResultAddress : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataAddress")
+@interface GSKStructuredDataAddress : NSObject
 /// The city component of the address.
 @property (nonatomic, readonly, copy) NSString * _Nullable city;
 /// The postal/zip code component of the address.
@@ -810,30 +823,31 @@ SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultAddress")
 
 
 /// The bank details extracted from a document through OCR.
-SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultBankDetails")
-@interface GSKScanFlowStructuredDataResultBankDetails : NSObject
+SWIFT_CLASS("_TtC5GSSDK28GSKStructuredDataBankDetails")
+@interface GSKStructuredDataBankDetails : NSObject
 /// The IBAN if successfully extracted, otherwise is <code>nil</code>.
 @property (nonatomic, copy) NSString * _Nullable iban;
 /// The BIC code if successfully extracted, otherwise is <code>nil</code>.
 @property (nonatomic, copy) NSString * _Nullable bic;
-- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
-@class GSKScanFlowStructuredDataResultPhoneNumber;
+@class GSKStructuredDataPhoneNumber;
 @class CNContact;
 
 /// Contact data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultContact")
-@interface GSKScanFlowStructuredDataResultContact : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataContact")
+@interface GSKStructuredDataContact : NSObject
 /// Any name that appears on the business card. Contains the full name, including all components.
 @property (nonatomic, readonly, copy) NSString * _Nullable name;
 /// Any organization that appears on the business card.
 @property (nonatomic, readonly, copy) NSString * _Nullable organization;
 /// Any address that appears on the business card.
-@property (nonatomic, readonly, strong) GSKScanFlowStructuredDataResultAddress * _Nullable address;
+@property (nonatomic, readonly, strong) GSKStructuredDataAddress * _Nullable address;
 /// The phone numbers that appear on the business card.
-@property (nonatomic, readonly, copy) NSArray<GSKScanFlowStructuredDataResultPhoneNumber *> * _Nonnull phoneNumbers;
+@property (nonatomic, readonly, copy) NSArray<GSKStructuredDataPhoneNumber *> * _Nonnull phoneNumbers;
 /// The links/URLs that appear on the business card.
 @property (nonatomic, readonly, copy) NSArray<NSURL *> * _Nonnull links;
 /// The email addresses that appear on the business card.
@@ -846,9 +860,46 @@ SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultContact")
 
 
 
+/// Class that enables structured data to be extracted from
+/// scanned documents.
+SWIFT_CLASS("_TtC5GSSDK26GSKStructuredDataExtractor")
+@interface GSKStructuredDataExtractor : NSObject
+- (nonnull instancetype)init;
+@end
+
+
+
+@interface GSKStructuredDataExtractor (SWIFT_EXTENSION(GSSDK))
+/// Extract any bank details that were found in a given document by
+/// passing in the result of performing OCR on that document. Use
+/// <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)bankDetailsFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataBankDetails * _Nullable, NSError * _Nullable))completionHandler;
+/// Extract any business card contact that was found in a given document
+/// by passing in the result of performing OCR on that document. Use
+/// <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)businessCardContactFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataContact * _Nullable, NSError * _Nullable))completionHandler;
+/// Extract any receipt/invoice information that was found in a given
+/// document by passing in the result of performing OCR on that document.
+/// Use <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)receiptFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataReceipt * _Nullable, NSError * _Nullable))completionHandler;
+@end
+
+/// Enum defining errors that can be thrown by <code>GSKStructuredDataExtractor</code>.
+/// Note that thrown errors will be wrapped in <code>NSError</code> containers.
+typedef SWIFT_ENUM(NSInteger, GSKStructuredDataExtractorError, open) {
+  GSKStructuredDataExtractorErrorMissingRequiredOCRMetadata = -1,
+};
+
+
 /// Phone number data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultPhoneNumber")
-@interface GSKScanFlowStructuredDataResultPhoneNumber : NSObject
+SWIFT_CLASS("_TtC5GSSDK28GSKStructuredDataPhoneNumber")
+@interface GSKStructuredDataPhoneNumber : NSObject
 /// The label of the phone number. For example “Main”, “Office”, etc.
 @property (nonatomic, readonly, copy) NSString * _Nonnull label;
 /// A string representation of the phone number itself.
@@ -861,8 +912,8 @@ SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultPhoneNumber")
 @class NSLocale;
 
 /// Receipt/invoice details extracted from a document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultReceipt")
-@interface GSKScanFlowStructuredDataResultReceipt : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataReceipt")
+@interface GSKStructuredDataReceipt : NSObject
 /// The locale that the receipt is in, if successfully extracted, otherwise <code>nil</code>.
 @property (nonatomic, readonly, copy) NSLocale * _Nullable locale;
 /// The merchant that the receipt is from, if successfully extracted, otherwise <code>nil</code>.
@@ -918,12 +969,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIBackgro
 @end
 
 
-
 @interface GSKView (SWIFT_EXTENSION(GSSDK))
 - (void)startSnapAnimationWithDuration:(NSTimeInterval)duration;
 - (void)endSnapAnimation;
 @end
 
+
 @class NSBundle;
 
 SWIFT_CLASS("_TtC5GSSDK14GSSDKResources")
@@ -1269,6 +1320,19 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 
 
 
+/// The type of document detected by the document finder.
+typedef SWIFT_ENUM(NSInteger, GSKDocumentFinderImageType, closed) {
+/// No document present in the image
+  GSKDocumentFinderImageTypeNoDocument = 0,
+/// A document present in the image, but no crop, perspective correction have been applied
+  GSKDocumentFinderImageTypeUnwarped = 1,
+/// A document present in the image, and crop, perspective correction have been applied
+  GSKDocumentFinderImageTypeWarped = 2,
+/// A document present in the image, crop/perspective correction and
+/// enhanced have been applied.
+  GSKDocumentFinderImageTypeEnhanced = 3,
+};
+
 @class GSKPDFDocument;
 @class GSKDocumentGeneratorConfiguration;
 
@@ -1369,7 +1433,7 @@ SWIFT_CLASS("_TtC5GSSDK12GSKOCRResult")
 @property (nonatomic, readonly, copy) NSString * _Nonnull text;
 /// The recognized text, as a structured text layout.
 @property (nonatomic, readonly, strong) GSKTextLayout * _Nonnull textLayout;
-- (nonnull instancetype)initWithText:(NSString * _Nonnull)text textLayout:(GSKTextLayout * _Nonnull)textLayout OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)initWithText:(NSString * _Nonnull)text textLayout:(GSKTextLayout * _Nonnull)textLayout;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
@@ -1592,6 +1656,7 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
+
 @interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
 /// Create a configuration from a dictionary.
 /// This is particularly useful for interfacing with React Native but shouldn’t
@@ -1600,7 +1665,6 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
-
 /// Enum that defines various errors that can occur during a scan flow.
 typedef SWIFT_ENUM(NSInteger, GSKScanFlowError, open) {
 /// User has canceled the scan flow
@@ -1733,29 +1797,29 @@ typedef SWIFT_ENUM(NSUInteger, GSKScanFlowSource, open) {
   GSKScanFlowSourceLibrary = 2,
 };
 
-@class GSKScanFlowStructuredDataResultBankDetails;
-@class GSKScanFlowStructuredDataResultContact;
-@class GSKScanFlowStructuredDataResultReceipt;
+@class GSKStructuredDataBankDetails;
+@class GSKStructuredDataContact;
+@class GSKStructuredDataReceipt;
 
 /// The result of a structured data extraction.
 SWIFT_CLASS("_TtC5GSSDK31GSKScanFlowStructuredDataResult")
 @interface GSKScanFlowStructuredDataResult : NSObject
 /// Present if bank details extraction was requested, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultBankDetails * _Nullable bankDetails;
+@property (nonatomic, strong) GSKStructuredDataBankDetails * _Nullable bankDetails;
 /// Present if business card contact extraction was requested and a contact was
 /// succcessfully extracted, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultContact * _Nullable businessCardContact;
+@property (nonatomic, strong) GSKStructuredDataContact * _Nullable businessCardContact;
 /// Present if receipt extraction was requested and a receipt/invoice was
 /// succcessfully extracted, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultReceipt * _Nullable receipt;
+@property (nonatomic, strong) GSKStructuredDataReceipt * _Nullable receipt;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
 
 
 /// Address data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultAddress")
-@interface GSKScanFlowStructuredDataResultAddress : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataAddress")
+@interface GSKStructuredDataAddress : NSObject
 /// The city component of the address.
 @property (nonatomic, readonly, copy) NSString * _Nullable city;
 /// The postal/zip code component of the address.
@@ -1773,30 +1837,31 @@ SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultAddress")
 
 
 /// The bank details extracted from a document through OCR.
-SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultBankDetails")
-@interface GSKScanFlowStructuredDataResultBankDetails : NSObject
+SWIFT_CLASS("_TtC5GSSDK28GSKStructuredDataBankDetails")
+@interface GSKStructuredDataBankDetails : NSObject
 /// The IBAN if successfully extracted, otherwise is <code>nil</code>.
 @property (nonatomic, copy) NSString * _Nullable iban;
 /// The BIC code if successfully extracted, otherwise is <code>nil</code>.
 @property (nonatomic, copy) NSString * _Nullable bic;
-- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
-@class GSKScanFlowStructuredDataResultPhoneNumber;
+@class GSKStructuredDataPhoneNumber;
 @class CNContact;
 
 /// Contact data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultContact")
-@interface GSKScanFlowStructuredDataResultContact : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataContact")
+@interface GSKStructuredDataContact : NSObject
 /// Any name that appears on the business card. Contains the full name, including all components.
 @property (nonatomic, readonly, copy) NSString * _Nullable name;
 /// Any organization that appears on the business card.
 @property (nonatomic, readonly, copy) NSString * _Nullable organization;
 /// Any address that appears on the business card.
-@property (nonatomic, readonly, strong) GSKScanFlowStructuredDataResultAddress * _Nullable address;
+@property (nonatomic, readonly, strong) GSKStructuredDataAddress * _Nullable address;
 /// The phone numbers that appear on the business card.
-@property (nonatomic, readonly, copy) NSArray<GSKScanFlowStructuredDataResultPhoneNumber *> * _Nonnull phoneNumbers;
+@property (nonatomic, readonly, copy) NSArray<GSKStructuredDataPhoneNumber *> * _Nonnull phoneNumbers;
 /// The links/URLs that appear on the business card.
 @property (nonatomic, readonly, copy) NSArray<NSURL *> * _Nonnull links;
 /// The email addresses that appear on the business card.
@@ -1809,9 +1874,46 @@ SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultContact")
 
 
 
+/// Class that enables structured data to be extracted from
+/// scanned documents.
+SWIFT_CLASS("_TtC5GSSDK26GSKStructuredDataExtractor")
+@interface GSKStructuredDataExtractor : NSObject
+- (nonnull instancetype)init;
+@end
+
+
+
+@interface GSKStructuredDataExtractor (SWIFT_EXTENSION(GSSDK))
+/// Extract any bank details that were found in a given document by
+/// passing in the result of performing OCR on that document. Use
+/// <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)bankDetailsFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataBankDetails * _Nullable, NSError * _Nullable))completionHandler;
+/// Extract any business card contact that was found in a given document
+/// by passing in the result of performing OCR on that document. Use
+/// <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)businessCardContactFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataContact * _Nullable, NSError * _Nullable))completionHandler;
+/// Extract any receipt/invoice information that was found in a given
+/// document by passing in the result of performing OCR on that document.
+/// Use <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)receiptFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataReceipt * _Nullable, NSError * _Nullable))completionHandler;
+@end
+
+/// Enum defining errors that can be thrown by <code>GSKStructuredDataExtractor</code>.
+/// Note that thrown errors will be wrapped in <code>NSError</code> containers.
+typedef SWIFT_ENUM(NSInteger, GSKStructuredDataExtractorError, open) {
+  GSKStructuredDataExtractorErrorMissingRequiredOCRMetadata = -1,
+};
+
+
 /// Phone number data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultPhoneNumber")
-@interface GSKScanFlowStructuredDataResultPhoneNumber : NSObject
+SWIFT_CLASS("_TtC5GSSDK28GSKStructuredDataPhoneNumber")
+@interface GSKStructuredDataPhoneNumber : NSObject
 /// The label of the phone number. For example “Main”, “Office”, etc.
 @property (nonatomic, readonly, copy) NSString * _Nonnull label;
 /// A string representation of the phone number itself.
@@ -1824,8 +1926,8 @@ SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultPhoneNumber")
 @class NSLocale;
 
 /// Receipt/invoice details extracted from a document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultReceipt")
-@interface GSKScanFlowStructuredDataResultReceipt : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataReceipt")
+@interface GSKStructuredDataReceipt : NSObject
 /// The locale that the receipt is in, if successfully extracted, otherwise <code>nil</code>.
 @property (nonatomic, readonly, copy) NSLocale * _Nullable locale;
 /// The merchant that the receipt is from, if successfully extracted, otherwise <code>nil</code>.
@@ -1881,12 +1983,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIBackgro
 @end
 
 
-
 @interface GSKView (SWIFT_EXTENSION(GSSDK))
 - (void)startSnapAnimationWithDuration:(NSTimeInterval)duration;
 - (void)endSnapAnimation;
 @end
 
+
 @class NSBundle;
 
 SWIFT_CLASS("_TtC5GSSDK14GSSDKResources")