spotny-sdk 0.2.2 → 0.2.3

package/SpotnySdk.podspec

@@ -16,9 +16,8 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift,cpp}"
   s.private_header_files = "ios/**/*.h"
 
-  # NOTE: KontaktSDK must be added to the consumer app via Swift Package Manager.
-  # SPM URL: https://github.com/kontaktio/kontakt-ios-sdk
-  # KontaktSDK's SPM transitive dependencies (CBORCoding, HALF) are resolved automatically.
+  # KontaktSDK 6.2.1 pre-built XCFramework — bundled so consumers need no extra setup
+  s.vendored_frameworks = "ios/Frameworks/KontaktSDK.xcframework"
 
   s.pod_target_xcconfig = {
     "SWIFT_VERSION" => "5.0"

package/ios/Frameworks/KontaktSDK.xcframework/Info.plist

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

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/CLBeacon+Kontakt.h

@@ -0,0 +1,37 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2016 Kontakt.io. All rights reserved.
+//
+
+@import CoreLocation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - CLBeacon (Kontakt)
+@interface CLBeacon (Kontakt)
+
+#pragma mark - Kontakt Secure Shuffling Properties
+///--------------------------------------------------------------------
+/// @name Kontakt Secure Shuffling Properties
+///--------------------------------------------------------------------
+
+/**
+*  Proximity identifier associated with the beacon.
+*/
+@property (nonatomic, strong, readonly) NSUUID * ktk_proximityUUID;
+
+/**
+ *  Most significant value associated with the beacon.
+ */
+@property (nonatomic, strong, readonly) NSNumber * ktk_major;
+
+/**
+ *  Least significant value associated with the beacon.
+ */
+@property (nonatomic, strong, readonly) NSNumber * ktk_minor;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKAction.h

@@ -0,0 +1,90 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2015 Kontakt.io. All rights reserved.
+//
+
+@import CoreLocation;
+
+#import "KTKCloudModel.h"
+#import "KTKActionContent.h"
+#import "KTKCloudDefinitions.h"
+
+#if TARGET_OS_IOS
+typedef CLProximity Proximity;
+#else
+typedef KTKProximity Proximity;
+#endif
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Action type.
+ */
+typedef NS_ENUM(NSInteger, KTKActionType) {
+    /**
+     *  Action type is invalid.
+     */
+    KTKActionTypeInvalid = -1,
+    /**
+     *  Content action type.
+     */
+    KTKActionTypeContent = 1,
+    /**
+     *  Browser/URL action type.
+     */
+    KTKActionTypeBrowser = 2,
+};
+
+#pragma mark - KTKAction (Interface)
+@interface KTKAction : NSObject <KTKCloudModel>
+
+#pragma mark - Content Properties
+///--------------------------------------------------------------------
+/// @name Content Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Action identifier. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *actionID;
+
+/**
+ *  Type of the action. (read-only)
+ */
+@property (nonatomic, assign, readonly) KTKActionType type;
+
+/**
+ *  The proximity on which action should be triggered. (read-only)
+ */
+@property (nonatomic, assign, readonly) Proximity proximity;
+
+/**
+ *  An array of devices unique identifiers assigned to the action. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSArray <NSString*>* _Nullable devicesUniqueID;
+
+#pragma mark - Action Type URL
+///--------------------------------------------------------------------
+/// @name Action Type URL
+///--------------------------------------------------------------------
+
+/**
+ *  A url of the action. Nil when action type is equal to <code><KTKActionTypeContent></code> (read-only)
+ */
+@property (nonatomic, strong, readonly) NSURL * _Nullable url;
+
+#pragma mark - Action Type Content
+///--------------------------------------------------------------------
+/// @name Action Type Content
+///--------------------------------------------------------------------
+
+/**
+ *  A content object of the action. Nil when action type is equal to <code><KTKActionTypeBrowser></code> (read-only)
+ */
+@property (nonatomic, strong, readonly) KTKActionContent * _Nullable content;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKActionContent.h

@@ -0,0 +1,80 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Action content type.
+ */
+typedef NS_ENUM(NSInteger, KTKActionContentType) {
+    /**
+     *  Content type is invalid.
+     */
+    KTKActionContentTypeInvalid = -1,
+    /**
+     *  Image content type.
+     */
+    KTKActionContentTypeImage   = 1,
+    /**
+     *  Video content type.
+     */
+    KTKActionContentTypeVideo   = 2,
+    /**
+     *  Audio content type.
+     */
+    KTKActionContentTypeAudio   = 3,
+    /**
+     *  Text file content type.
+     */
+    KTKActionContentTypeText    = 4
+};
+
+#pragma mark - KTKActionContent (Interface)
+@interface KTKActionContent : NSObject <NSObject, NSCopying, NSSecureCoding>
+
+#pragma mark - Content Properties
+///--------------------------------------------------------------------
+/// @name Content Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Action content's type. (read-only)
+ */
+@property (nonatomic, assign, readonly) KTKActionContentType type;
+
+/**
+ *  Specific mime type of the content. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *mimeType;
+
+/**
+ *  A boolean flag indicating whether content file is being converted now. (read-only)
+ */
+@property (nonatomic, assign, readonly, getter=isConverting) BOOL converting;
+
+/**
+ *  The URL object of content data. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSURL * _Nullable contentURL;
+
+#pragma mark - Model Methods
+///--------------------------------------------------------------------
+/// @name Model Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Downloads the action's content data.
+ *
+ *  @param completion A block object to be executed when a download process finishes.
+ */
+- (void)downloadContentDataWithCompletion:(void(^)( NSData * _Nullable, NSError * _Nullable ))completion;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKBeaconManager.h

@@ -0,0 +1,326 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+@import CoreLocation;
+
+#import "KTKBeaconRegion.h"
+#import "KTKSecureBeaconRegion.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - External Helpers
+extern NSUUID * KTKKontaktProximityUUID(void);
+
+#pragma mark -
+@protocol KTKBeaconManagerDelegate;
+
+#pragma mark - KTKBeaconManager (Interface)
+@interface KTKBeaconManager : NSObject 
+
+#pragma mark - Other Properties
+///--------------------------------------------------------------------
+/// @name Other Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The delegate object to receive update events.
+ *
+ *  @see KTKBeaconManagerDelegate
+ */
+@property (nonatomic, weak, readwrite) id<KTKBeaconManagerDelegate> _Nullable delegate;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a beacon manager object with the specified delegate.
+ *
+ *  @param delegate The delegate object to receive update events.
+ *
+ *  @return An initialized beacon manager object.
+ *
+ *  @see KTKBeaconManagerDelegate
+ */
+- (instancetype)initWithDelegate:(id<KTKBeaconManagerDelegate> _Nullable)delegate;
+
+#pragma mark - Core Location Authorization
+///--------------------------------------------------------------------
+/// @name Core Location Authorization
+///--------------------------------------------------------------------
+
+/**
+ *  Requests permission to use location services whenever the app is running.
+ *
+ */
+- (void)requestLocationAlwaysAuthorization;
+
+/**
+ *  Requests permission to use location services while the app is in the foreground.
+ *
+ */
+- (void)requestLocationWhenInUseAuthorization;
+
+/**
+ *  Returns the app’s authorization status for using location services.
+ *
+ *  @return  A value indicating whether the app is authorized to use location services.
+ */
++ (CLAuthorizationStatus)locationAuthorizationStatus;
+
+#pragma mark - Monitoring Beacon Regions
+///--------------------------------------------------------------------
+/// @name Monitoring Beacon Regions
+///--------------------------------------------------------------------
+
+/**
+ *  Returns a Boolean indicating whether the device supports monitoring for region.
+ *
+ *  @return <code>YES</code> if the device is capable of monitoring regions or <code>NO</code> if it is not.
+ */
++ (BOOL)isMonitoringAvailable;
+
+/**
+ *  The set of regions currently being monitored. (read-only)
+ *
+ *  @see KTKBeaconRegion
+ *  @see KTKSecureBeaconRegion
+ */
+@property (nonatomic, copy, readonly, nonnull) NSSet<__kindof KTKBeaconRegion*>* monitoredRegions;
+
+/**
+ *  Starts monitoring the specified region.
+ *
+ *  For more details read Apple Documentation for startMonitoringForRegion: <http://apple.co/1KbW5cY>
+ *
+ *  @param region The region object that defines the boundary to monitor. This parameter must not be nil.
+ *
+ *  @see KTKBeaconManagerDelegate
+ *  @see KTKBeaconRegion
+ *  @see KTKSecureBeaconRegion
+ *  @see [[CLLocationManager startMonitoringForRegion:]](http://apple.co/1KbW5cY)
+ */
+- (void)startMonitoringForRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Stops monitoring the specified region.
+ *
+ *  If the specified region object is not currently being monitored, this method has no effect.
+ *  For more details read Apple Documentation for stopMonitoringForRegion: <http://apple.co/1ODGt3L>
+ *
+ *  @param region The region object currently being monitored. This parameter must not be nil.
+ *
+ *  @see KTKBeaconManagerDelegate
+ *  @see KTKBeaconRegion
+ *  @see KTKSecureBeaconRegion
+ *  @see [[CLLocationManager stopMonitoringForRegion:]](http://apple.co/1ODGt3L)
+ */
+- (void)stopMonitoringForRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Stops monitoring for all regions.
+ *
+ *  If any regions are monitored directly by an instance of CLLocationManager they will also be stopped
+ *  as monitoredRegions property is shared between instances of CLLocationManager.
+ *
+ *  @see KTKBeaconManagerDelegate
+ */
+- (void)stopMonitoringForAllRegions;
+
+/**
+ *  Retrieves the state of a region asynchronously.
+ *
+ *  @param region The region whose state you want to know.
+ *
+ *  @see KTKBeaconManagerDelegate
+ *  @see [[CLLocationManager requestStateForRegion:]](http://apple.co/1MWG5NO)
+ */
+- (void)requestStateForRegion:(__kindof KTKBeaconRegion*)region;
+
+#pragma mark - Ranging Beacons
+///--------------------------------------------------------------------
+/// @name Ranging Beacons
+///--------------------------------------------------------------------
+
+/**
+ *  The set of regions currently being tracked using ranging. (read-only)
+ *
+ *  @see KTKBeaconRegion
+ *  @see KTKSecureBeaconRegion
+ */
+@property (nonatomic, copy, readonly, nonnull) NSSet<__kindof KTKBeaconRegion*>* rangedRegions;
+
+/**
+ *  Returns a Boolean indicating whether the device supports ranging of beacons.
+ *
+ *  @return <code>YES</code> if the device supports ranging or <code>NO</code> if it does not
+ */
++ (BOOL)isRangingAvailable;
+
+/**
+ *  Starts the delivery of notifications for beacons in the specified region.
+ *
+ *  @param region The region object that defines the identifying information for the targeted beacons. This parameter must not be nil.
+ *
+ *  @see KTKBeaconRegion
+ *  @see KTKSecureBeaconRegion
+ *  @see KTKBeaconManagerDelegate
+ *  @see [[CLLocationManager startRangingBeaconsInRegion:]](http://apple.co/1GWUWp6)
+ */
+- (void)startRangingBeaconsInRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Stops the delivery of notifications for the specified beacon region.
+ *
+ *  @param region The region that identifies the beacons. This parameter must not be nil.
+ *
+ *  @see KTKBeaconRegion
+ *  @see KTKSecureBeaconRegion
+ *  @see KTKBeaconManagerDelegate
+ *  @see [[CLLocationManager stopRangingBeaconsInRegion:]](http://apple.co/1Lab3uq)
+ */
+- (void)stopRangingBeaconsInRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Stops the delivery of notifications for all the beacon regions.
+ *
+ *  @see KTKBeaconManagerDelegate
+ */
+- (void)stopRangingBeaconsInAllRegions;
+
+@end
+
+#pragma mark - KTKBeaconManagerDelegate
+/**
+ *  The delegate of a KTKBeaconManager object must adopt the KTKBeaconManagerDelegate protocol.
+ */
+@protocol KTKBeaconManagerDelegate <NSObject>
+
+@optional
+
+#pragma mark - Core Location Authorization
+///--------------------------------------------------------------------
+/// @name Core Location Authorization
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that the authorization status for the application changed.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param status  The new authorization status for the application.
+ *
+ *  @see [KTKBeaconManager requestLocationAlwaysAuthorization]
+ *  @see [KTKBeaconManager requestLocationWhenInUseAuthorization]
+ *  @see [KTKBeaconManager locationAuthorizationStatus]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager didChangeLocationAuthorizationStatus:(CLAuthorizationStatus)status;
+
+/**
+ *  Tells the delegate that the authorization status for the application changed iOS 14.0+.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *
+ *  @see [KTKBeaconManager accuracyAuthorization]
+ */
+- (void)locationManagerDidChangeAuthorization:(CLLocationManager *)manager;
+
+#pragma mark - Monitoring Beacon Regions Reporting
+///--------------------------------------------------------------------
+/// @name Monitoring Beacon Regions Reporting
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that a new region is being monitored.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param region The region that is being monitored.
+ *
+ *  @see [KTKBeaconManager startMonitoringForRegion:]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager didStartMonitoringForRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Tells the delegate that a region monitoring error occurred.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param region  The region for which the error occurred.
+ *  @param error   An error object containing the error code that indicates why region monitoring failed.
+ *
+ *  @see [KTKBeaconManager startMonitoringForRegion:]
+ *  @see [KTKBeaconManager stopMonitoringForRegion:]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager monitoringDidFailForRegion:(__kindof KTKBeaconRegion* _Nullable)region withError:(NSError* _Nullable)error;
+
+/**
+ *  Tells the delegate that the user entered the specified region.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param region  An object containing information about the region that was entered.
+ *
+ *  @see [KTKBeaconManager startMonitoringForRegion:]
+ *  @see [KTKBeaconManager stopMonitoringForRegion:]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager didEnterRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Tells the delegate that the user left the specified region.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param region  An object containing information about the region that was exited.
+ *
+ *  @see [KTKBeaconManager startMonitoringForRegion:]
+ *  @see [KTKBeaconManager stopMonitoringForRegion:]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager didExitRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Tells the delegate about the state of the specified region. (required)
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param state   The state of the specified region. For a list of possible values, see the CLRegionState type.
+ *  @param region  The region whose state was determined.
+ *
+ *  @see [KTKBeaconManager requestStateForRegion:]
+ *  @see [CLRegionState](http://apple.co/1PCibWE)
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager didDetermineState:(CLRegionState)state forRegion:(__kindof KTKBeaconRegion*)region;
+
+#pragma mark - Ranging Beacons Reporting
+///--------------------------------------------------------------------
+/// @name Ranging Beacons
+///--------------------------------------------------------------------
+
+/**
+ *  Tells the delegate that one or more beacons are in range.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param beacons  An array of CLBeacon objects representing the beacons currently in range.
+ *                  If beacons is empty, you can assume that no beacons matching the specified region are in range.
+ *                  When a specific beacon is no longer in beacons, that beacon is no longer received by the device.
+ *  @param region  The region object containing the parameters that were used to range the beacons.
+ *
+ *  @see [KTKBeaconManager startRangingBeaconsInRegion:]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager didRangeBeacons:(NSArray <CLBeacon *>*)beacons inRegion:(__kindof KTKBeaconRegion*)region;
+
+/**
+ *  Tells the delegate that a region monitoring error occurred.
+ *
+ *  @param manager The beacon manager object reporting the event.
+ *  @param region  The region for which the error occurred.
+ *  @param error   An error object containing the error code that indicates why region monitoring failed.
+ *
+ *  @see [KTKBeaconManager startRangingBeaconsInRegion:]
+ *  @see [KTKBeaconManager stopRangingBeaconsInRegion:]
+ */
+- (void)beaconManager:(KTKBeaconManager*)manager rangingBeaconsDidFailForRegion:(__kindof KTKBeaconRegion* _Nullable)region withError:(NSError* _Nullable)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64/KontaktSDK.framework/Headers/KTKBeaconRegion.h

@@ -0,0 +1,102 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+@import CoreLocation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKBeaconRegion (Interface)
+@interface KTKBeaconRegion : NSObject <NSCopying, NSSecureCoding>
+
+#pragma mark - Region Properties
+///--------------------------------------------------------------------
+/// @name Region Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The proximity ID of the beacons being targeted. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *proximityUUID;
+
+/**
+ *  The value identifying a group of beacons. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable major;
+
+/**
+ *  The value identifying a specific beacon within a group. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable minor;
+
+/**
+ *  A unique identifier to associate with the region object. You use this identifier to differentiate regions within your application. (read-only)
+ */
+@property (nonatomic, copy, readonly) NSString *identifier;
+
+/**
+ *  A Boolean indicating whether beacon notifications are sent when the device’s display is on.
+ */
+@property (nonatomic, assign) BOOL notifyEntryStateOnDisplay;
+
+/**
+ *  A Boolean indicating that notifications are generated upon entry into the region.
+ */
+@property (nonatomic, assign) BOOL notifyOnEntry;
+
+/**
+ *  A Boolean indicating that notifications are generated upon exit from the region.
+ */
+@property (nonatomic, assign) BOOL notifyOnExit;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a region object that targets a beacon with the specified proximity ID.
+ *
+ *  @param proximityUUID  The proximity ID of the beacons being targeted. This value must not be nil.
+ *  @param identifier     A unique identifier to associate with the returned region object. You use this identifier to differentiate regions within your application. This value must not be nil.
+ *
+ *  @return An initialized beacon region object.
+ */
+- (instancetype)initWithProximityUUID:(NSUUID*)proximityUUID
+                           identifier:(NSString *)identifier;;
+
+/**
+ *  Initializes and returns a region object that targets a beacon with the specified proximity ID and major value.
+ *
+ *  @param proximityUUID The proximity ID of the beacons being targeted. This value must not be nil.
+ *  @param major         The major value that you use to identify one or more beacons.
+ *  @param identifier    A unique identifier to associate with the returned region object. You use this identifier to differentiate regions within your application. This value must not be nil.
+ *
+ *  @return An initialized beacon region object.
+ */
+- (instancetype)initWithProximityUUID:(NSUUID*)proximityUUID
+                                major:(CLBeaconMajorValue)major
+                           identifier:(NSString *)identifier;
+
+/**
+ *  Initializes and returns a region object that targets a beacon with the specified proximity ID, major value, and minor value.
+ *
+ *  @param proximityUUID The proximity ID of the beacons being targeted. This value must not be nil.
+ *  @param major         The major value that you use to identify one or more beacons.
+ *  @param minor         The minor value that you use to identify a specific beacon.
+ *  @param identifier    A unique identifier to associate with the returned region object. You use this identifier to differentiate regions within your application. This value must not be nil.
+ *
+ *  @return An initialized beacon region object.
+ */
+- (instancetype)initWithProximityUUID:(NSUUID*)proximityUUID
+                                major:(CLBeaconMajorValue)major
+                                minor:(CLBeaconMinorValue)minor
+                           identifier:(NSString *)identifier;
+
+@end
+
+NS_ASSUME_NONNULL_END