Release of version 4.13.0

CHANGELOG.md

@@ -3,6 +3,21 @@ All notable changes to this project will be documented in this file.
 
 Note that Objective-C class names are prefixed by `SNR`. In the changelog below, these are names used in Swift, without the prefix.
 
+## [4.13.0] - 2023-05-24
+
+### Added
+- We added a new `Content.generateDocument(slug:success:failure:)` method. It's analogous to `Content.getDocument(slug:success:failure:)`. The old method is deprecated. The new method generates the document that is defined for the provided slug.
+- We added a new `Content.getRecommendationsV2(options:success:failure:)` method. It's analogous to `Content.getRecommendations(options:success:failure:)`. The old method is deprecated. The new method gets recommendations that are defined for the options provided.
+- We added a new `Content.generateScreenView(feedSlug:success:failure:)` method. It's analogous to `Content.getScreenView(success:failure:)`. The old method is deprecated. The new method generates a customer's highest-priority screen view campaign that is defined for the provided slug.
+- We added models correlating with new methods: `ScreenView`, `Document`.
+
+### Changed
+- `Content.getDocument(slug:success:failure:)` is deprecated now.
+- `Content.getDocuments(apiQuery:success:failure:)` is deprecated now.
+- `Content.getRecommendations(options:success:failure:)` is deprecated now.
+- `Content.getScreenView(success:failure:)` is deprecated now.
+
+
 ## [4.12.2] - 2023-05-15
 
 ### Changed

README.md

@@ -1,9 +1,9 @@
-# Synerise iOS SDK (v4.12.2) - User documentation
+# Synerise iOS SDK (v4.13.0) - User documentation
 
 [![Platform](https://img.shields.io/badge/platform-iOS-orange.svg)](https://github.com/synerise/ios-sdk)
 [![Languages](https://img.shields.io/badge/language-Objective--C%20%7C%20Swift-orange.svg)](https://github.com/synerise/ios-sdk)
 [![GitHub release](https://img.shields.io/github/release/Synerise/ios-sdk.svg?style=flat-square)](https://github.com/Synerise/ios-sdk/releases) 
-[![CocoaPods](https://img.shields.io/badge/pod-v4.12.2-green.svg)](https://cocoapods.org/pods/SyneriseSDK)
+[![CocoaPods](https://img.shields.io/badge/pod-v4.13.0-green.svg)](https://cocoapods.org/pods/SyneriseSDK)
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 [![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat-square)](https://help.synerise.com/)
 

SDK/Framework/SyneriseSDK.framework.dSYM/Contents/Info.plist

@@ -13,7 +13,7 @@
 		<key>CFBundleSignature</key>
 		<string>????</string>
 		<key>CFBundleShortVersionString</key>
-		<string>4.12.2</string>
+		<string>4.13.0</string>
 		<key>CFBundleVersion</key>
 		<string>1</string>
 	</dict>

SDK/Framework/SyneriseSDK.framework/Headers/SNRContent.h

@@ -6,10 +6,12 @@
 //  Copyright (c) 2023 Synerise. All rights reserved.
 //
 
+@class SNRDocument;
 @class SNRDocumentsApiQuery;
 @class SNRRecommendationOptions;
 @class SNRRecommendationResponse;
 @class SNRScreenViewResponse;
+@class SNRScreenView;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -29,41 +31,83 @@ NS_SWIFT_NAME(Content)
  * @param slug Identifies a specific document.
  * @param success A block object to be executed when the operation finishes successfully.
  * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ * 
+ * @deprecated Deprecated in version 4.13.0
  */
 + (void)getDocument:(NSString *)slug
             success:(void (^)(NSDictionary *document))success
-            failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getDocument(slug:success:failure:));
+            failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getDocument(slug:success:failure:)) DEPRECATED_MSG_ATTRIBUTE("Use `Content.generateDocument(slug:success:failure:)` instead.");
+
+/**
+ * Generates the document that is defined for the provided slug.
+ *
+ * @param slug Identifies a specific document.
+ * @param success A block object to be executed when the operation finishes successfully.
+ * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ */
++ (void)generateDocument:(NSString *)slug
+                 success:(void (^)(SNRDocument *document))success
+                 failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(generateDocument(slug:success:failure:));
+
 
 /**
  * Gets documents that are defined for parameters provided in the query object.
  *
  * @param apiQuery `SNRDocumentsApiQuery` object responsible for storing all query parameters.
  * @param success A block object to be executed when the operation finishes successfully.
  * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ *
+ * @deprecated Deprecated in version 4.13.0
  */
 + (void)getDocumentsWithApiQuery:(SNRDocumentsApiQuery *)apiQuery
-                          success:(void (^)(NSArray *documents))success
-                          failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getDocuments(apiQuery:success:failure:));
+                         success:(void (^)(NSArray *documents))success
+                         failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getDocuments(apiQuery:success:failure:)) DEPRECATED_MSG_ATTRIBUTE("This method is deprecated.");
 
 /**
  * Gets recommendations that are defined for the options provided.
  *
  * @param options `SNRRecommendationOptions` object providing parameters for recommendations.
  * @param success A block object to be executed when the operation finishes successfully.
  * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ *
+ * @deprecated Deprecated in version 4.13.0
  */
 + (void)getRecommendations:(SNRRecommendationOptions *)options
-            success:(void (^)(SNRRecommendationResponse *recommendationResponse))success
-            failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getRecommendations(options:success:failure:));
+                   success:(void (^)(SNRRecommendationResponse *recommendationResponse))success
+                   failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getRecommendations(options:success:failure:)) DEPRECATED_MSG_ATTRIBUTE("Use `Content.getRecommendationsV2(options:success:failure:)` instead.");
+
+/**
+ * Gets recommendations that are defined for the options provided.
+ *
+ * @param options `SNRRecommendationOptions` object providing parameters for recommendations.
+ * @param success A block object to be executed when the operation finishes successfully.
+ * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ */
++ (void)getRecommendationsV2:(SNRRecommendationOptions *)options
+                     success:(void (^)(SNRRecommendationResponse *recommendationResponse))success
+                     failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getRecommendationsV2(options:success:failure:));
 
 /**
  * Gets customer's highest-priority screen view campaign.
  *
  * @param success A block object to be executed when the operation finishes successfully.
  * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ *
+ * @deprecated Deprecated in version 4.13.0
  */
 + (void)getScreenViewWithSuccess:(void (^)(SNRScreenViewResponse *screenViewResponse))success
-                         failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getScreenView(success:failure:));
+                         failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(getScreenView(success:failure:)) DEPRECATED_MSG_ATTRIBUTE("Use `Content.generateScreenView(slug:success:failure:)` instead.");
+
+/**
+ * Generates customer's highest-priority screen view campaign that is defined for the provided slug.
+ *
+ * @param feedSlug Identifies a specific screen view.
+ * @param success A block object to be executed when the operation finishes successfully.
+ * @param failure A block object to be executed when the operation finishes unsuccessfully.
+ */
++ (void)generateScreenView:(NSString *)feedSlug
+                   success:(void (^)(SNRScreenView *screenView))success
+                   failure:(void (^)(SNRApiError *error))failure NS_SWIFT_NAME(generateScreenView(feedSlug:success:failure:));
 
 @end
 

SDK/Framework/SyneriseSDK.framework/Headers/SNRDocument.h

@@ -0,0 +1,28 @@
+//
+//  SNRDocument.h
+//  SyneriseSDK
+//
+//  Created by Synerise
+//  Copyright (c) 2023 Synerise. All rights reserved.
+//
+
+#import <SyneriseSDK/SNRBaseModel.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * @class SNRDocument
+ *
+ */
+
+NS_SWIFT_NAME(Document)
+@interface SNRDocument : SNRBaseModel
+
+@property (copy, nonatomic, nonnull, readonly) NSString *identifier;
+@property (copy, nonatomic, nonnull, readonly) NSString *slug;
+@property (copy, nonatomic, nonnull, readonly) NSString *schema;
+@property (copy, nonatomic, nullable, readonly) NSDictionary *content;
+
+@end
+
+NS_ASSUME_NONNULL_END

SDK/Framework/SyneriseSDK.framework/Headers/SNRScreenView.h

@@ -0,0 +1,35 @@
+//
+//  SNRScreenView.h
+//  SyneriseSDK
+//
+//  Created by Synerise
+//  Copyright (c) 2023 Synerise. All rights reserved.
+//
+
+#import <SyneriseSDK/SNRBaseModel.h>
+#import <SyneriseSDK/SNRScreenViewAudienceInfo.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * @class SNRScreenView
+ */
+
+NS_SWIFT_NAME(ScreenView)
+@interface SNRScreenView : SNRBaseModel
+
+@property (copy, nonatomic, nonnull, readonly) NSString *identifier;
+@property (copy, nonatomic, nonnull, readonly) NSString *name;
+@property (copy, nonatomic, nonnull, readonly) NSString *hashString;
+@property (copy, nonatomic, nonnull, readonly) NSString *path;
+@property (assign, nonatomic, readonly) NSInteger priority;
+@property (copy, nonatomic, nullable, readonly) SNRScreenViewAudienceInfo *audience;
+
+@property (copy, nonatomic, nullable, readonly) id data;
+
+@property (copy, nonatomic, nonnull, readonly) NSDate *createdAt;
+@property (copy, nonatomic, nonnull, readonly) NSDate *updatedAt;
+
+@end
+
+NS_ASSUME_NONNULL_END

SDK/Framework/SyneriseSDK.framework/Headers/SNRScreenViewAudienceInfo.h

@@ -0,0 +1,26 @@
+//
+//  SNRScreenViewAudienceInfo.h
+//  SyneriseSDK
+//
+//  Created by Synerise
+//  Copyright (c) 2023 Synerise. All rights reserved.
+//
+
+#import <SyneriseSDK/SNRBaseModel.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * @class SNRScreenViewAudienceInfo
+ */
+
+NS_SWIFT_NAME(ScreenViewAudienceInfo)
+@interface SNRScreenViewAudienceInfo : SNRBaseModel
+
+@property (copy, nonatomic, nullable, readonly) NSArray<NSString *> *segments;
+@property (copy, nonatomic, nullable, readonly) NSString *query;
+@property (copy, nonatomic, nullable, readonly) NSString *targetType;
+
+@end
+
+NS_ASSUME_NONNULL_END

SDK/Framework/SyneriseSDK.framework/Headers/SyneriseSDK.h

@@ -32,11 +32,12 @@
 #import <SyneriseSDK/SNRInjector.h>
 #import <SyneriseSDK/SNRPromotions.h>
 
-// API Queries
+// API Queries & Options
 #import <SyneriseSDK/SNRApiQuerySortingOrder.h>
 #import <SyneriseSDK/SNRClientEventsApiQuery.h>
 #import <SyneriseSDK/SNRPromotionsApiQuery.h>
 #import <SyneriseSDK/SNRDocumentsApiQuery.h>
+#import <SyneriseSDK/SNRRecommendationOptions.h>
 
 // Exceptions
 #import <SyneriseSDK/SNRExceptionHandler.h>
@@ -131,13 +132,15 @@
 #import <SyneriseSDK/SNRAssignVoucherData.h>
 #import <SyneriseSDK/SNRVoucherCodesResponse.h>
 #import <SyneriseSDK/SNRVoucherCodesData.h>
-#import <SyneriseSDK/SNRRecommendationOptions.h>
+#import <SyneriseSDK/SNRDocument.h>
 #import <SyneriseSDK/SNRRecommendationResponse.h>
 #import <SyneriseSDK/SNRRecommendationResponseExtras.h>
 #import <SyneriseSDK/SNRRecommendationResponseExtrasSlot.h>
 #import <SyneriseSDK/SNRRecommendation.h>
 #import <SyneriseSDK/SNRScreenViewResponse.h>
 #import <SyneriseSDK/SNRScreenViewAudience.h>
+#import <SyneriseSDK/SNRScreenView.h>
+#import <SyneriseSDK/SNRScreenViewAudienceInfo.h>
 #import <SyneriseSDK/SNRInAppMessageData.h>
 
 // Content Widget