spotny-sdk 1.0.0

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKCloudClient.h

@@ -0,0 +1,241 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+@import UIKit;
+
+#import "KTKKontaktResponse.h"
+
+@protocol KTKCloudModel;
+@class KTKTelemetryEventPacket;
+@class KTKCloudClientSessionManager;
+
+NS_ASSUME_NONNULL_BEGIN
+
+#pragma mark - External Helper
+extern NSDictionary * _Nullable KTKCloudErrorFromError(NSError * _Nullable error);
+
+/**
+ *  Returns the telemetry API URL string.
+ *
+ *  @return The telemetry API URL string.
+ */
+extern NSString * kKontaktAPITelemetryURL(void);
+
+#pragma mark - KTKCloudClient (Interface)
+@interface KTKCloudClient : NSObject
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  A shared instance of Cloud client, used by the low-level SDK methods, and suitable for use directly for any ad-hoc requests.
+ *
+ *  @return A shared instance of a Cloud client.
+ */
++ (nonnull instancetype)sharedInstance;
+
+/**
+ *  Initializes and returns a cloud client object with the specified session configuration.
+ *
+ *  @param configuration A configuration object that specifies certain behaviors, such as caching policies, timeouts, proxies, pipelining, TLS versions to support, cookie policies, and credential storage.
+ *
+ *  @return An initialized cloud client object.
+ */
+- (instancetype)initWithSessionConfiguration:(NSURLSessionConfiguration*)configuration;
+
+#pragma mark - API Request Methods
+///--------------------------------------------------------------------
+/// @name API Request Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Runs a cloud API call with a GET request.
+ *
+ *  @param endpoint   The cloud API endpoint/resource.
+ *  @param dictionary The parameters to be serialized for the request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ */
+- (void)GET:(NSString*)endpoint parameters:(NSDictionary* _Nullable)dictionary completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+/**
+ *  Runs a cloud API call with a GET request for the specified url object.
+ *  
+ *  This method is the best candicate for calling next or previous results url.
+ *  Please note <code>url</code> must be withing kontakt.io domain.
+ *
+ *  @param url        The url object for the GET request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ *  @see [KTKKontaktResponse previousResultsURL]
+ *  @see [KTKKontaktResponse nextResultsURL]
+ */
+- (void)GET:(NSURL*)url completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+/**
+ *  Runs a cloud API call with a POST request.
+ *
+ *  @param endpoint   The cloud API endpoint/resource.
+ *  @param dictionary The parameters to be serialized for the request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ */
+- (void)POST:(NSString*)endpoint parameters:(NSDictionary* _Nullable)dictionary completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+/**
+ *  Runs a cloud API call with a POST request.
+ *
+ *  @param endpoint   The cloud API endpoint/resource.
+ *  @param url        The cloud API url.
+ *  @param dictionary The parameters to be serialized for the request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ */
+- (void)POST:(NSString*)endpoint url:(NSURL*)url parameters:(NSDictionary* _Nullable)dictionary completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+/**
+ *  Runs a cloud API call with a POST request encoded for JSON payload.
+ *
+ *  @param endpoint   The cloud API endpoint/resource.
+ *  @param dictionary The parameters to be serialized for the request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ */
+- (void)JSON:(NSString*)endpoint parameters:(NSDictionary* _Nullable)dictionary completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+/**
+ *  Runs a cloud API call with a POST request encoded for JSON payload.
+ *
+ *  @param endpoint   The cloud API endpoint/resource.
+ *  @param url        The cloud API url.
+ *  @param dictionary The parameters to be serialized for the request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ */
+- (void)JSON:(NSString*)endpoint url:(NSURL*)url parameters:(NSDictionary* _Nullable)dictionary completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+/**
+ *  Runs a telemetry cloud API call with a POST request encoded for JSON payload.
+ *
+ *  @param endpoint   The telemetry cloud API endpoint/resource.
+ *  @param dictionary The parameters to be serialized for the request.
+ *  @param completion A block object to be executed when the request finishes.
+ *
+ *  @see KTKKontaktResponseCompletionBlock
+ *  @see KTKKontaktResponse
+ */
+- (void)JSONTelemetry:(NSString*)endpoint parameters:(NSDictionary* _Nullable)parameters completion:(KTKKontaktResponseCompletionBlock _Nullable)completion;
+
+#pragma mark - Objects Request Methods
+///--------------------------------------------------------------------
+/// @name Objects Request Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Gets an objects from the cloud API with the specified Class and parameters object.
+ *
+ *  @param objectClass The Class of an objects to get.
+ *  @param parameters  The parameters to be serialized for the request.
+ *  @param completion  A block object to be executed when the request finishes.
+ */
+- (void)getObjects:(Class<KTKCloudModel>)objectClass parameters:(NSDictionary * _Nullable)parameters completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Gets an objects from the cloud API with the specified Class.
+ *
+ *  @param objectClass The Class of an objects to get.
+ *  @param completion  A block object to be executed when the request finishes.
+ */
+- (void)getObjects:(Class<KTKCloudModel>)objectClass completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Gets an object from the cloud API with the specified Class and primary key value.
+ *
+ *  @param objectClass The Class of an object to get.
+ *  @param value       The primary key value of an object to get.
+ *  @param completion  A block object to be executed when the request finishes.
+ */
+- (void)getObject:(Class<KTKCloudModel>)objectClass primaryKey:(id)value completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Creates specified object in the cloud API.
+ *
+ *  @param object     The object to be created in the cloud API.
+ *  @param completion A block object to be executed when the request finishes.
+ */
+- (void)createObject:(id<KTKCloudModel>)object completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Updates specified object in the cloud API.
+ *
+ *  @param object     The object to be updated in the cloud API.
+ *  @param completion A block object to be executed when the request finishes.
+ */
+- (void)updateObject:(id<KTKCloudModel>)object completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Deletes specified object in the cloud API.
+ *
+ *  @param object     The object to be deleted in the cloud API.
+ *  @param completion A block object to be executed when the request finishes.
+ */
+- (void)deleteObject:(id<KTKCloudModel>)object completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Deletes an object in the cloud API with the specified Class and primary key value.
+ *
+ *  @param objectClass The Class of an object to delete.
+ *  @param value       The primary key value of an object to delete.
+ *  @param completion  A block object to be executed when the request finishes.
+ */
+- (void)deleteObject:(Class<KTKCloudModel>)objectClass primaryKey:(id)value completion:(KTKKontaktResponseCompletionBlock)completion;
+
+/**
+ *  Collects telemetry data by sending it to the telemetry endpoint.
+ *
+ *  @param packet A telemetry event packet containing the telemetry data to be collected.
+ */
+- (void)collectTelemetry:(KTKTelemetryEventPacket *)packet;
+
+#pragma mark - Telemetry Support Properties
+///--------------------------------------------------------------------
+/// @name Telemetry Support Properties
+///--------------------------------------------------------------------
+
+/**
+ *  Cloud Client session manager.
+ */
+@property (nonatomic, strong, readonly) KTKCloudClientSessionManager *manager;
+
+/**
+ *  Authentication headers.
+ */
+@property (nonatomic, strong, readonly) NSDictionary *authHeaders;
+
+/**
+ *  Prints error messages for debugging.
+ */
+- (void)printError:(NSString *)message;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKCloudClientJSONResponseSerializer.h

@@ -0,0 +1,20 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+#import "KTKCloudClientResponseSerializer.h"
+
+#pragma mark - External Constants
+extern NSString * const KTKResponseSerializerErrorDomain;
+extern NSString * const KTKResponseSerializerFailingURLResponseErrorKey;
+extern NSString * const KTKResponseSerializerFailingURLResponseDataErrorKey;
+extern NSString * const KTKResponseSerializerFailingURLResponseServerErrorKey;
+
+#pragma mark - KTKCloudClientJSONResponseSerializer (Interface)
+@interface KTKCloudClientJSONResponseSerializer : NSObject <KTKCloudClientResponseSerializer>
+
+@end

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKCloudClientResponseSerializer.h

@@ -0,0 +1,35 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#pragma mark - KTKCloudClientResponseSerializer Protocol
+@protocol KTKCloudClientResponseSerializer <NSObject>
+
+#pragma mark - Parsing Methods
+///--------------------------------------------------------------------
+/// @name Parsing Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Serializes response with the specified URL response object, data object and error.
+ *
+ *  @param response The URL response from the cloud API.
+ *  @param data     The data object received from the cloud API.
+ *  @param error    An error pointer.
+ *
+ *  @return A serialized response object.
+ */
+@required
+- (id)responseObjectForResponse:(NSURLResponse *)response
+                           data:(NSData *)data
+                          error:(NSError **)error;
+
+- (id)responseObjectForResponse:(NSURLResponse *)response
+                          error:(NSError **)error;
+
+@end

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKCloudClientSessionManager.h

@@ -0,0 +1,207 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright (c) 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+#import "NSURLRequest+Kontakt.h"
+#import "KTKCloudClientResponseSerializer.h"
+#import "KTKCloudClientJSONResponseSerializer.h"
+
+/**
+ *  A block object to be executed when the data task finishes.
+ *
+ *  @param responseObject The response object.
+ *  @param error          An error object.
+ */
+typedef void (^KTKCloudClientSessionManagerDefaultCompletionBlock)(id responseObject, NSError *error);
+
+/**
+ *  A block object to be executed when the download task finishes.
+ *
+ *  @param data  The downloaded data object.
+ *  @param error An error object.
+ */
+typedef void (^KTKCloudClientSessionManagerDownloadCompletionBlock)(NSData *data, NSError *error);
+
+#pragma mark - KTKCloudClientSessionManager (Interface)
+@interface KTKCloudClientSessionManager : NSObject
+
+#pragma mark - Session Manager Properties
+///--------------------------------------------------------------------
+/// @name Session Manager Properties
+///--------------------------------------------------------------------
+
+/**
+ *  The base URL for the HTTP client.
+ */
+@property (nonatomic, strong, readwrite) NSURL *baseURL;
+
+/**
+ *  The URL session object.
+ */
+@property (nonatomic, strong, readonly) NSURLSession *URLSession;
+
+/**
+ *  Dispatch queue on which delegate call will be executed.
+ */
+@property (nonatomic, strong, readonly) NSOperationQueue *sessionDelegateQueue;
+
+/**
+ *  The response serializer.
+ * 
+ *  @see KTKCloudClientResponseSerializer
+ */
+@property (nonatomic, strong, readwrite) id<KTKCloudClientResponseSerializer> responseSerializer;
+
+/**
+ *  The array of the current tasks.
+ */
+@property (nonatomic, strong, readonly) NSArray *tasks;
+
+#pragma mark - Initialization Methods
+///--------------------------------------------------------------------
+/// @name Initialization Methods
+///--------------------------------------------------------------------
+
+/**
+ *  Initializes and returns a session manager object with the specified base URL and session configuration object.
+ *
+ *  @param baseURL       The base URL for the HTTP client.
+ *  @param configuration The configuration used to create the managed session.
+ *
+ *  @return An initialized session manager object.
+ */
+- (instancetype)initWithBaseURL:(NSURL*)baseURL
+                  configuration:(NSURLSessionConfiguration *)configuration;
+
+#pragma mark - Sending Requests
+///--------------------------------------------------------------------
+/// @name Sending Requests
+///--------------------------------------------------------------------
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a <code>POST</code> request.
+ *
+ *  @param path       The URL path used to create the request. Relative to the <code>baseURL</code>.
+ *  @param parameters The parameters to be encoded according to the client request serializer.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+- (NSURLSessionDataTask*)POST:(NSString*)path
+                   parameters:(NSDictionary*)parameters
+            completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a <code>POST</code> request.
+ *
+ *  @param path       The URL path used to create the request. Relative to the <code>url</code>.
+ *  @param url        The URL set baseURL
+ *  @param parameters The parameters to be encoded according to the client request serializer.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+- (NSURLSessionDataTask*)POST:(NSString*)path
+                          url:(NSURL*)url
+                   parameters:(NSDictionary*)parameters
+            completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a <code>POST</code> request encoded for JSON payload.
+ *
+ *  @param path       The URL path used to create the request. Relative to the <code>baseURL</code>.
+ *  @param parameters The parameters to be encoded according to the client request serializer.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+
+- (NSURLSessionDataTask*)JSON:(NSString*)path
+                   parameters:(NSDictionary*)parameters
+            completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a <code>POST</code> request encoded for JSON payload.
+ *
+ *  @param path       The URL path used to create the request.
+ *  @param url        The URL set baseURL
+ *  @param parameters The parameters to be encoded according to the client request serializer.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+
+- (NSURLSessionDataTask*)JSON:(NSString*)path
+                          url:(NSURL*)url
+                   parameters:(NSDictionary*)parameters
+            completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a <code>GET</code> request.
+ *
+ *  @param path       The URL path used to create the request. Relative to the <code>baseURL</code>.
+ *  @param parameters The parameters to be encoded according to the client request serializer.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+- (NSURLSessionDataTask*)GET:(NSString*)path
+                  parameters:(NSDictionary*)parameters
+           completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a specified method request.
+ *
+ *  @param method     The HTTP method used to create the request.
+ *  @param path       The URL path used to create the request. Relative to the baseURL.
+ *  @param parameters The parameters to be encoded according to the client request serializer.
+ *  @param encoder    The encoder to use for request encoding.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+- (NSURLSessionDataTask*)dataTaskWithMethod:(NSString*)method
+                                       path:(NSString*)path
+                                 parameters:(NSDictionary*)parameters
+                                    encoder:(KTKCloudClientRequestEncoder)encoder
+                          completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a specified URL request object.
+ *
+ *  @param request    The request to be used with the task.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+- (NSURLSessionDataTask*)dataTaskWithRequest:(NSURLRequest*)request
+                           completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion;
+
+/**
+ *  Creates an <code>NSURLSessionDataTask</code> with a specified URL request object.
+ *
+ *  @param request    The request to be used with the task.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized data task object.
+ */
+- (NSURLSessionDataTask*)dataTaskWithRequest:(NSURLRequest*)request
+                           completionHandler:(KTKCloudClientSessionManagerDefaultCompletionBlock)completion
+                                 shouldRetry:(BOOL)shouldRetry;
+
+/**
+ *  Creates an <code>NSURLSessionDownloadTask</code> with a specified URL request object.
+ *
+ *  @param request    The request to be used with the task.
+ *  @param completion A block object to be executed when the task finishes.
+ *
+ *  @return An initialized download task object.
+ */
+- (NSURLSessionDownloadTask*)downloadTaskWithRequest:(NSURLRequest*)request
+                                   completionHandler:(KTKCloudClientSessionManagerDownloadCompletionBlock)completion;
+@end

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKCloudDefinitions.h

@@ -0,0 +1,13 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2017 Kontakt.io. All rights reserved.
+//
+
+typedef NS_ENUM(NSInteger, KTKProximity) {
+    KTKProximityUnknown,
+    KTKProximityImmediate,
+    KTKProximityNear,
+    KTKProximityFar
+};

package/ios/Frameworks/KontaktSDK.xcframework/ios-arm64_x86_64-simulator/KontaktSDK.framework/Headers/KTKCloudModel.h

@@ -0,0 +1,36 @@
+//
+//  KontaktSDK
+//  Version: 6.2.1
+//
+//  Copyright © 2015 Kontakt.io. All rights reserved.
+//
+
+@import Foundation;
+
+typedef NS_ENUM(NSInteger, KTKCloudModelRequests) {
+    KTKCloudModelRequestGet    = 1 << 1,
+    KTKCloudModelRequestCreate = 1 << 2,
+    KTKCloudModelRequestUpdate = 1 << 3,
+    KTKCloudModelRequestDelete = 1 << 4,
+};
+
+#pragma mark - KTKCloudModel protocol
+@protocol KTKCloudModel <NSObject, NSCopying, NSSecureCoding>
+
+/**
+ *  Returns a key path for the object's primary key.
+ *
+ *  @return A key path string object.
+ */
+@required
++ (NSString*)primaryKey;
+
+/**
+ *  Returns the allowed actions options.
+ *
+ *  @return An allowed actions options.
+ */
+@required
++ (KTKCloudModelRequests)availableRequests;
+
+@end