spotny-sdk 1.0.0

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

@@ -0,0 +1,33 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+#import "KTKEddystoneFrame.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKEddystoneURL (Interface)
+@interface KTKEddystoneURL : NSObject <KTKEddystoneFrame, NSCopying, NSSecureCoding>
+
+#pragma mark - URL Frame Properties
+///--------------------------------------------------------------------
+/// @name URL Frame Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Machine to machine flag. (read-only)
+ */
+@property (nonatomic, assign, readonly, getter=isMachineToMachine) BOOL machineToMachine;
+
+/**
+ *  URL object. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSURL * _Nullable url;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,13 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#pragma mark - KTKEddystoneURLValueTransformer (Interface)
+@interface KTKEddystoneURLValueTransformer : NSValueTransformer
+
+@end

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

@@ -0,0 +1,98 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2015 Kontakt.io. All rights reserved.
+//
+
+#import "KTKCloudModel.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef NS_ENUM(NSInteger, KTKFirmwareType) {
+    KTKFirmwareTypeInvalid = -1,
+    KTKFirmwareTypeDefault = 0,
+    KTKFirmwareTypeArchive = 1
+};
+
+#pragma mark - KTKFirmware (Interface)
+@interface KTKFirmware : NSObject <KTKCloudModel>
+
+#pragma mark - Firmware Properties
+///--------------------------------------------------------------------
+/// @name Firmware Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The firmware ID.
+ */
+@property (nonatomic, strong, readonly) NSString *firmwareID;
+
+/**
+ *  The firmware version string.
+ */
+@property (nonatomic, strong, readonly) NSString *firmwareVersion;
+
+/**
+ *  Description text.
+ */
+@property (nonatomic, strong, readonly) NSString * _Nullable firmwareDescription;
+
+/**
+ *  An array of firmware versions which can be updated to this firmware version.
+ */
+@property (nonatomic, strong, readonly) NSArray <NSString*> *validVersions;
+
+/**
+ *  An array of devices unique IDs which can be updated to this firmware version.
+ */
+@property (nonatomic, strong, readonly) NSArray <NSString*> * _Nullable devicesUniqueID;
+
+/**
+ *  A Boolean indicating whether firmware can be applied or not.
+ *
+ *  It's possible that latest firmware release can require administrator confirmation through the web panel.
+ *  Before the administrator allows this version to be installed on the devices this flag will be set to <code>NO</code>.
+ *  Only the latest firmware where <code>scheduled</code> value is <code>YES</code> should be used to update devices.
+ */
+@property (nonatomic, assign, readonly, getter=isScheduled) BOOL scheduled;
+
+
+/**
+ *  A Boolean indicating whether the firmware is important release or not.
+ */
+@property (nonatomic, assign, readonly, getter=isImportant) BOOL important;
+
+/**
+ *  A Boolean indicating whether the firmware is optional or not.
+ */
+@property (nonatomic, assign, readonly, getter=isOptional) BOOL optional;
+
+/**
+ *  The firmware type.
+ */
+@property (nonatomic, assign, readonly) KTKFirmwareType type;
+
+#pragma mark - Model Methods
+///--------------------------------------------------------------------
+/// @name Model Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Downloads the firmware data. You can store
+ *
+ *  @param completion A block object to be executed when a download process finishes.
+ */
+- (void)downloadWithCompletion:(void(^)(NSData * _Nullable, NSError * _Nullable))completion;
+
+/**
+ *  Gets a firmware objects for the specified kontakt unique IDs.
+ *
+ *  @param uniqueIDs  An array of kontakt unique identifiers.
+ *  @param completion A block object to be executed when the request finishes.
+ */
++ (void)getFirmwaresForUniqueIDs:(NSArray*)uniqueIDs completion:(void(^)(NSArray<KTKFirmware*> * _Nullable, NSError * _Nullable))completion;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,100 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+#import "KTKOperation.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKGroupOperation (Interface)
+@interface KTKGroupOperation : KTKOperation
+
+#pragma mark - Operation Properties
+///--------------------------------------------------------------------
+/// @name Operation Properties
+///--------------------------------------------------------------------
+
+/**
+ *  A Boolean indicating whether the internal operation queue is currently suspended.
+ */
+@property (nonatomic, assign, readonly, getter=isSuspended) BOOL suspended;
+
+/**
+ *  A Boolean indicating whether the operations should be called in serial or concurrent mode.
+ */
+@property (nonatomic, assign, readonly, getter=isSerial) BOOL serial;
+
+/**
+ *  A block object to be executed when the group operation finishes.
+ */
+@property (nonatomic, copy, readwrite) void (^groupCompletion)(NSArray<NSError*>* _Nullable);
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns an operation object with the specified opertations group.
+ *
+ *  @param operations The operations array to be added to the group operation.
+ *
+ *  @return An initialized operation object.
+ */
+- (instancetype)initWithOperations:(NSArray <__kindof NSOperation*>* _Nullable)operations;
+
+/**
+ *  Initializes and returns an operation object with the specified opertations group.
+ *
+ *  @param operations    The operations array to be added to the group operation.
+ *  @param maxConcurrent The number of max concurrent operations.
+ *
+ *  @return An initialized operation object.
+ */
+- (instancetype)initWithOperations:(NSArray <__kindof NSOperation*>* _Nullable)operations maxConcurrent:(NSUInteger)maxConcurrent;
+
+/**
+ *  Initializes and returns an operation object with the specified opertations group.
+ *
+ *  @param operations    The operations array to be added to the group operation.
+ *  @param maxConcurrent The number of max concurrent operations.
+ *  @param serial        A Boolean indicating whether the operations should be called in serial or concurrent mode.
+ *
+ *  @return An initialized operation object.
+ */
+- (instancetype)initWithOperations:(NSArray <__kindof NSOperation*>* _Nullable)operations maxConcurrent:(NSUInteger)maxConcurrent serial:(BOOL)serial;
+
+#pragma mark - Operation Methods
+///--------------------------------------------------------------------
+/// @name Operation Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Adds the specified operation object to the group operation.
+ *
+ *  @param operation The operation object to be added to the group operation.
+ */
+- (void)addOperation:(__kindof NSOperation*)operation;
+
+/**
+ *  Adds the specified operation object to the group operation.
+ *
+ *  @param operation  The operation object to be added to the group operation.
+ *  @param updateLast A Boolean indicating whether the operation should become last operation.
+ */
+- (void)addOperation:(__kindof NSOperation*)operation
+          updateLast:(BOOL)updateLast;
+
+/**
+ *  Gets a current progress of the finished operations.
+ *
+ *  @return A current progress of the finished operations.
+ */
+- (double)currentProgress;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,85 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+@class KTKKontaktResponse;
+
+/**
+ *  A block object to be executed when the cloud API request finishes.
+ *
+ *  @param response The cloud API response object.
+ *  @param error    An error object.
+ */
+typedef void (^KTKKontaktResponseCompletionBlock)(KTKKontaktResponse * _Nullable response, NSError * _Nullable error);
+
+
+#pragma mark - KTKKontaktResponse (Interface)
+@interface KTKKontaktResponse: NSObject
+
+#pragma mark - Properties
+///--------------------------------------------------------------------
+/// @name Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The index of which the result objects start from.
+ */
+@property (nonatomic, assign, readonly) NSUInteger startIndex;
+
+/**
+ *  The limit of the objects in the response.
+ */
+@property (nonatomic, assign, readonly) NSUInteger maxResult;
+
+/**
+ *  The count of the all objects.
+ */
+@property (nonatomic, assign, readonly) NSUInteger allCount;
+
+/**
+ *  The count of the received objects.
+ */
+@property (nonatomic, assign, readonly) NSUInteger objectsCount;
+
+/**
+ *  The array of the objects received from the cloud API.
+ */
+@property (nonatomic, strong, readonly) NSArray * _Nullable objects;
+
+/**
+ *  The URL of the previous result set.
+ */
+@property (nonatomic, strong, readwrite) NSURL * _Nullable previousResultsURL;
+
+/**
+ *  The URL of the next result set.
+ */
+@property (nonatomic, strong, readwrite) NSURL * _Nullable nextResultsURL;
+
+/**
+ *  An HTTP status code of the response.
+ */
+@property (nonatomic, strong, readonly) NSNumber * _Nullable statusCode;
+
+/**
+ *  An ETag HTTP header value of the response.
+ */
+@property (nonatomic, strong, readonly) NSString * _Nullable ETag;
+
+/**
+ *  A raw object of the response. 
+ *
+ *  When objects property is nil its worth checking raw response.
+ */
+@property (nonatomic, strong, readonly) id _Nullable rawResponse;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,121 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+#import "KTKCloudModel.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ *  Manager roles
+ *
+ *  @see https://support.kontakt.io/hc/en-gb/articles/204897781-6-User-types-roles-Managers
+ */
+typedef NS_ENUM(NSUInteger, KTKManagerRole) {
+    /**
+     *  Unknown Role
+     */
+    KTKManagerRoleUnknown,
+    /**
+     *  Superuser Role
+     */
+    KTKManagerRoleSuperuser,
+    /**
+     *  Administrator Role
+     */
+    KTKManagerRoleAdmin,
+    /**
+     *  Operator Role
+     */
+    KTKManagerRoleOperator,
+};
+
+/**
+ *  Subscription Plans
+ */
+typedef NS_OPTIONS(NSUInteger, KTKManagerSubscriptionPlan) {
+    /**
+     *  Not Applicable
+     */
+    KTKManagerSubscriptionPlanNotApplicable     = 0,
+    /**
+     *  None
+     */
+    KTKManagerSubscriptionPlanNone              = 1 << 0,
+    /**
+     *  Legacy
+     */
+    KTKManagerSubscriptionPlanLegacy            = 1 << 1,
+    /**
+     *  Management
+     */
+    KTKManagerSubscriptionPlanManagement        = 1 << 2,
+    /**
+     *  Location Engine
+     */
+    KTKManagerSubscriptionPlanLocationEngine    = 1 << 3,
+};
+
+#pragma mark - KTKManager (Interface)
+@interface KTKManager : NSObject <KTKCloudModel>
+
+#pragma mark - Manager Properties
+///--------------------------------------------------------------------
+/// @name Manager Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The manager ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *managerID;
+
+/**
+ *  The company ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID *companyID;
+
+/**
+ *  The manager's supervisor ID. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSUUID * _Nullable supervisorID;
+
+/**
+ *  The manager's first name. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *firstName;
+
+/**
+ *  The manager's last name. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *lastName;
+
+/**
+ *  An email address. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString *email;
+
+/**
+ *  The manager's API Key. (read-only)
+ */
+@property (nonatomic, strong, readonly) NSString * _Nullable apiKey;
+
+/**
+ *  The manager's user role. (read-only)
+ *
+ *  @see KTKManagerRole
+ */
+@property (nonatomic, assign, readonly) KTKManagerRole role;
+
+/**
+ *  The manager's company subscription plan. (read-only)
+ *
+ *  @see KTKManagerSubscriptionPlan
+ */
+@property (nonatomic, assign, readonly) KTKManagerSubscriptionPlan subscriptionPlan;
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -0,0 +1,135 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+@import CoreBluetooth;
+
+#import "KTKDeviceDefinitions.h"
+#import "KTKNearbyDeviceTelemetry.h"
+#import "KTKKontaktResponse.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - KTKNearbyDevice (Interface)
+@interface KTKNearbyDevice : NSObject <NSCopying>
+
+#pragma mark - Nearby Device Properties
+///--------------------------------------------------------------------
+/// @name Nearby Device Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Advertised device name. (read-only)
+ */
+@property (nonatomic, readonly, copy) NSString * _Nullable name;
+
+/**
+ *  Kontakt unique identifier. (read-only)
+ */
+@property (nonatomic, readonly, copy) NSString * _Nullable uniqueID;
+
+/**
+ *  Device firmware version. (read-only)
+ */
+@property (nonatomic, readonly, strong) NSString *firmwareVersion;
+
+/**
+ *  Battery level percentage. (read-only)
+ */
+@property (nonatomic, readonly, assign) NSUInteger batteryLevel;
+
+/**
+ *  A Boolean indicating whether the device is powered with battery or power supply. (read-only)
+ */
+@property (nonatomic, readonly, assign, getter=isBatteryPowered) BOOL batteryPowered;
+
+/**
+ *  Transmission power. (read-only)
+ *  
+ *  @see KTKDeviceTransmissionPower
+ */
+@property (nonatomic, readonly, assign) KTKDeviceTransmissionPower transmissionPower;
+
+/**
+ *  A Boolean indicating whether the device has configuration profile ( Kontakt.io Secure Communication ). (read-only)
+ *  All Kontakt.io's devices with firmware >= 4.0 and all devices since Beacon Pro support configuration profile.
+ *
+ *  @see https://kontakt.io/products-and-solutions/complete-beacon-security/
+ */
+@property (nonatomic, readonly, assign) BOOL hasConfigurationProfile;
+
+/**
+ *  A Boolean indicating whether the device has Kontakt rtc timer.
+ */
+@property (nonatomic, readonly, assign) BOOL hasKontaktRTC;
+
+/**
+ *  A Boolean indicating whether the device is currently in Shuffle mode. (read-only)
+ *  
+ *  @see http://kontakt.io/blog/beacon-security/
+ */
+@property (nonatomic, readonly, assign, getter=isShuffled) BOOL shuffled;
+
+/**
+ *  A Boolean indicating whether the device is locked/non-connectable mode. (read-only)
+ */
+@property (nonatomic, readonly, assign, getter=isLocked) BOOL locked;
+
+/**
+ *  Nearby device telemetry informations object. (read-only)
+ *
+ *  @see KTKNearbyDeviceTelemetry
+ */
+@property (nonatomic, readonly, strong) KTKNearbyDeviceTelemetry * _Nullable telemetry;
+
+/**
+ *  Block called when new telemetry is set.
+ */
+@property (nonatomic, copy, nullable) void (^onTelemetryChange)(KTKNearbyDeviceTelemetry *newTelemetry);
+
+
+/**
+ *  Current advertising profile. (read-only)
+ *
+ *  @warning *Important:* advertisingProfile property is not compatible with firmware 4.1 as devices can advertise multiple packets at the same time.
+ *  advertisingProfile will return `KTKDeviceAdvertisingProfileInvalid` when nearby device's firmware is >= 4.1.
+ *  Please note advertisingProfile most probably will soon be removed in favor of packets. Please keep it in mind when planing future projects.
+ *
+ *  @see KTKDeviceAdvertisingProfile
+ */
+@property (nonatomic, readonly, assign) KTKDeviceAdvertisingProfile advertisingProfile;
+
+/**
+ *  Nearby device model. (read-only)
+ *
+ *  @warning *Important:* Only devices advertising using Kontakt.io's Secure Profile (UUID: 0xFE6A) (Basically NONE of the devices prior to Beacon Pro model) will provide model information.
+ *  In all other cases `model` property will be set to KTKDeviceModelUnknown or KTKDeviceModelInvalid.
+ *
+ *  @see KTKDeviceModel
+ */
+@property (nonatomic, readonly, assign) KTKDeviceModel model;
+
+/**
+ *  CoreBluetooth Peripheral object associated with the device. (read-only)
+ */
+@property (nonatomic, readonly, strong) CBPeripheral *peripheral;
+
+/**
+ *  Current RSSI value for the device. (read-only)
+ */
+@property (nonatomic, readonly, copy) NSNumber *RSSI;
+
+/**
+ *  Last discovery update timestamp. (read-only) 
+ */
+@property (nonatomic, readonly, assign) double updatedAt;
+
+@end
+
+
+
+NS_ASSUME_NONNULL_END