Synerise iOS SDK

https://github.com/synerise/synerise-ios-sdk
Admin
Synerise iOS SDK is a mobile SDK for iOS applications that enables integration with the Synerise...
Tokens:111,067
Snippets:630
Trust Score:8.8
License:Apache-2.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Synerise SDK via Carthage

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Command to build and install the SDK using Carthage.

```bash
carthage update --use-xcframeworks --platform ios
```

--------------------------------

### Content Widget Mapping and Action Button Example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

Non-trivial example showing how to map a recommendation to a ContentWidgetRecommendationDataModel and configure an action button for the content widget.

```APIDOC
## Content Widget Mapping and Action Button Example

### Description
Non-trivial example showing how to map a recommendation to a ContentWidgetRecommendationDataModel and configure an action button for the content widget.

### Code Example
```swift
let options = ContentWidgetRecommendationsOptions()
options.slug = "product-grid"
options.recommendationEventType = .view
options.mapping = { (recommendation: Recommendation) -> ContentWidgetRecommendationDataModel? in
    guard let title = recommendation.getAttributeSetForKey("name") as! String? else { return nil }
    guard let price = recommendation.getAttributeSetForKey("price") as! NSNumber? else { return nil }
    let imageURL = URL(string: recommendation.getAttributeSetForKey("image") as! String)!
    guard let model = ContentWidgetRecommendationDataModel(imageURL: imageURL, title: title, priceCurrency: "PLN", price: price, salePrice: nil) else { return nil }
    model.badge = ContentWidgetBadgeDataModel(backgroundColor: .red, textColor: .white, text: "SALE")
    return model
}

let actionButton = ContentWidgetImageButtonCustomAction()
actionButton.isSelectable = true
actionButton.onReceiveClick = { (model: BaseModel?, isSelected: Bool) in
    print("like state: \(isSelected)")
}
// options/actionButton are then wired to item layout and widget
```
```

--------------------------------

### Install Synerise SDK via CocoaPods

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Command to install the SDK after configuring the Podfile.

```bash
pod install
```

--------------------------------

### Install Carthage

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Command to install the Carthage dependency manager.

```bash
brew install carthage
```

--------------------------------

### Register and Activate Account Example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Demonstrates creating a registration context and chaining the registration and activation requests.

```swift
let context = ClientRegisterAccountContext(email: "john@example.com", password: "S3cure-pass!")
context.firstName = "John"
context.agreements = ClientAgreements()   // email/sms/push/... flags

Client.registerAccount(context: context, success: { _ in
    Client.requestAccountActivation(email: "john@example.com", success: { _ in
        print("activation email sent")
    }, failure: { error in ... })
}, failure: { error in ... })
```

--------------------------------

### Basic ContentWidget Initialization in Swift

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

Example of configuring options and layout before initializing and loading a ContentWidget.

```swift
let options = ContentWidgetRecommendationsOptions()
options.slug = "product-carousel"
options.recommendationEventType = .view

let layout = ContentWidgetHorizontalSliderLayout()
layout.itemSize = CGSize(width: 120, height: 160)
layout.itemSpacing = 8

let itemLayout = ContentWidgetBasicProductItemLayout()
// configure fonts, colors, insets...

let widget = ContentWidget(options: options, appearance: ContentWidgetAppearance(widgetLayout: layout, itemLayout: itemLayout))
widget.delegate = self
widget.load()
```

--------------------------------

### Example - Full Cart Event Flow

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Example showing how to create and send a ProductAddedToCartEvent using the Tracker.

```APIDOC
## Example - Full Cart Event Flow

### Description
Example showing how to create and send a ProductAddedToCartEvent using the Tracker.

### Code
```swift
let finalPrice = UnitPrice(amount: 29.99, locale: Locale("en_US"))
let regularPrice = finalPrice.copy() as! UnitPrice

let event = ProductAddedToCartEvent(label: "added \(product.name) to cart",
                                    sku: product.sku,
                                    finalPrice: finalPrice,
                                    quantity: cartItem.quantity)
event.setName(product.name)
event.setCategory(product.category)
event.setProducer(product.brand)
event.setURL(URL(string: "syne://product?sku=" + product.sku)!)
event.setOffline(false)
event.setRegularPrice(regularPrice)
event.setDiscountedPrice(finalPrice)

Tracker.send(event)
```

```

--------------------------------

### Install CocoaPods

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Command to install the CocoaPods dependency manager.

```bash
gem install cocoapods
```

--------------------------------

### Conditional OAuth Authentication Example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Example usage of conditional sign-in, demonstrating how to handle specific authentication statuses like activation requirements.

```swift
let context = ClientAuthenticationContext()
let authResult = Client.signInConditionally(email: email, password: password, success: { result in
    if result.status == .activationRequired {
        // direct user to activation
    }
}, failure: { error in
    print("\(error.code) \(error.localizedDescription)")
})
```

--------------------------------

### InitializationConfig usage example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/configuration.md

Shows how to create an InitializationConfig, set initialDoNotTrack to true and requestValidationSalt to a string, then pass it to Synerise.initialize with an apiKey and nil baseUrl.

```swift
let config = InitializationConfig()
config.initialDoNotTrack = true
config.requestValidationSalt = "my-salt"
Synerise.initialize(apiKey: apiKey, baseUrl: nil, config: config)
```

--------------------------------

### load()

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

Starts fetching data and creates the view structure for the widget. Progress is reported through the delegate.

```APIDOC
## load()

### Description
Starts fetching data and creates the view structure for the widget. Progress is reported through the delegate.

### Method
load

### Parameters
None

### Request Example
```swift
widget.load()
```

### Response
No return value.
```

--------------------------------

### Client.registerForPush sample-app pattern

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Example implementation of push registration using the mobilePushAgreement parameter.

```swift
Client.registerForPush(registrationToken: token, mobilePushAgreement: true, success: { _ in
    DebugUtils.print("Synerise push registration success")
}, failure: { error in
    DebugUtils.print("Synerise push registration failure: \(error.localizedDescription)")
})
```

--------------------------------

### Basic Injector setup (Swift)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/injector.md

Sets delegates for overlay and inline in-app messages, sets the in-app context, and notifies context change.

```swift
Injector.setInAppMessageDelegate(self)
Injector.setInlineInAppMessageDelegate(self)
Injector.inAppContext = ["user": "john@example.com"]
Injector.notifyInAppContextChange()
```

--------------------------------

### NotificationServiceExtension Usage Example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/notifications.md

Example of configuring the notification delegate, setting fallback content, and handling notification requests within the service extension.

```swift
NotificationServiceExtension.setNotificationDelegate(self)
NotificationServiceExtension.setDecryptionFallbackNotificationTitleAndBody(title: "New message", body: "Open the app to read it")

// inside the notification service extension receive hook:
NotificationServiceExtension.didReceiveNotificationExtensionRequest(request: request, withMutableNotificationContent: content)
```

--------------------------------

### Host Notification Handler Example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/notifications.md

Example implementation of a notification service handler that checks for Synerise notifications and handles decryption if necessary.

```swift
func notificationService(_ notificationService: NotificationService, didReceiveNotification notification: NotificationService.Notification) {
    let userInfo = notification.userInfo
    if Synerise.isSyneriseNotification(userInfo) {
        Synerise.handleNotification(userInfo)
    } else if Synerise.isNotificationEncrypted(userInfo) {
        let decrypted = Synerise.decryptNotification(userInfo)
        // render or ignore payload
    }
}
```

--------------------------------

### Mapping and Action Button Configuration

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

A Swift example demonstrating how to map recommendation attributes to the data model and configure a custom action button for user interactions.

```swift
let options = ContentWidgetRecommendationsOptions()
options.slug = "product-grid"
options.recommendationEventType = .view
options.mapping = { (recommendation: Recommendation) -> ContentWidgetRecommendationDataModel? in
    guard let title = recommendation.getAttributeSetForKey("name") as! String? else { return nil }
    guard let price = recommendation.getAttributeSetForKey("price") as! NSNumber? else { return nil }
    let imageURL = URL(string: recommendation.getAttributeSetForKey("image") as! String)!
    guard let model = ContentWidgetRecommendationDataModel(imageURL: imageURL, title: title, priceCurrency: "PLN", price: price, salePrice: nil) else { return nil }
    model.badge = ContentWidgetBadgeDataModel(backgroundColor: .red, textColor: .white, text: "SALE")
    return model
}

let actionButton = ContentWidgetImageButtonCustomAction()
actionButton.isSelectable = true
actionButton.onReceiveClick = { (model: BaseModel?, isSelected: Bool) in
    print("like state: \(isSelected)")
}
// options/actionButton are then wired to item layout and widget
```

--------------------------------

### Sample SyneriseDelegate implementation (SyneriseManager.swift)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/synerise.md

Example extension on SyneriseManager conforming to SyneriseDelegate from the sample app. Implements push registration and opens URLs/deep links via UIApplication.open; uses the non-origin overloads for URL/deep-link actions.

```swift
extension SyneriseManager: SyneriseDelegate {
    func snr_initialized() {}

    func snr_registerForPushNotificationsIsNeeded() {
        executePushRegistration()
    }

    func snr_handledAction(url: URL) {
        UIApplication.shared.open(url, options: [:], completionHandler: nil)
    }

    func snr_handledAction(deepLink: String) {
        UIApplication.shared.open(URL(string: deepLink)!, options: [:], completionHandler: nil)
    }
}
```

--------------------------------

### ProductAddedToCartEvent usage example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Demonstrates the full flow for creating and sending a ProductAddedToCartEvent, including setting product details and prices.

```swift
let finalPrice = UnitPrice(amount: 29.99, locale: Locale("en_US"))
let regularPrice = finalPrice.copy() as! UnitPrice

let event = ProductAddedToCartEvent(label: "added \(product.name) to cart",
                                    sku: product.sku,
                                    finalPrice: finalPrice,
                                    quantity: cartItem.quantity)
event.setName(product.name)
event.setCategory(product.category)
event.setProducer(product.brand)
event.setURL(URL(string: "syne://product?sku=" + product.sku)!)
event.setOffline(false)
event.setRegularPrice(regularPrice)
event.setDiscountedPrice(finalPrice)

Tracker.send(event)
```

--------------------------------

### Basic Recommendation Retrieval

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content.md

A simple example of fetching recommendations using a slug and iterating through the returned items.

```swift
Content.getRecommendationsV2(apiQuery: RecommendationApiQuery(slug: "product-recommendations"), success: { response in
    for recommendation in response.items {
        print(recommendation.itemID)
    }
}, failure: { error in ... })
```

--------------------------------

### Get promotions (basic)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Fetches all available promotions for the customer and prints the total count and each promotion's name and status. The success callback receives a PromotionResponse; the failure callback receives an error.

```swift
Promotions.getPromotions(success: { response in
    print("\(response.metadata?.totalCount ?? 0) promotions")
    for promotion in response.items {
        print("\(promotion.name) \(promotion.status)")
    }
}, failure: { error in
    print("\(error.localizedDescription)")
})
```

--------------------------------

### Custom method completion example

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/injector.md

Example implementation of snr_inAppMessageHandledCustomMethod that resolves the pending JS Promise. It checks the method name, looks up a profile, and calls completion.failure or completion.success accordingly.

```swift
func snr_inAppMessageHandledCustomMethod(data: InAppMessageData, name: String, parameters: [AnyHashable: Any], completion: InAppCustomMethodCompletion) {
    // name == "fetchUserProfile"
    guard let profile = lookupProfile(parameters["userId"] as! String) else {
        completion.failure("profile not found")
        return
    }
    completion.success(profile.toDictionary())
}
```

--------------------------------

### Send event and force flush with completion handler

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Example of sending a screen visit event and forcing an immediate flush of the event queue, with a completion handler to confirm when finished.

```swift
Tracker.send(VisitedScreenEvent(label: "screen.checkout"))
Tracker.flushEvents(completionHandler: { _ in
    print("events flushed")
})
```

--------------------------------

### handleNotification(_:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/synerise.md

Handles a notification payload (userInfo must contain "issuer" = "Synerise") and starts the matching activity.

```APIDOC
## handleNotification(_:)

### Description
Handles a notification payload (userInfo must contain "issuer" = "Synerise") and starts the matching activity.

### Method
handleNotification

### Parameters
- **userInfo** ([AnyHashable : Any]) - Required - The notification payload.

### Request Example
```swift
let userInfo = notification.userInfo
if Synerise.isSyneriseNotification(userInfo) {
    Synerise.handleNotification(userInfo)
}
```

### Response
No return value.
```

--------------------------------

### Sending a CustomEvent

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Example of how to send a custom event using the Tracker utility.

```swift
Tracker.send(CustomEvent(label: "custom.action", action: "custom.action.performed"))
```

--------------------------------

### Send a basic custom event

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Example of sending a basic custom event using the Tracker.send method.

```swift
Tracker.send(CustomEvent(label: "custom.action.performed"))
```

--------------------------------

### handleNotification(_:actionIdentifier:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/synerise.md

Handles a notification payload (userInfo must contain "issuer" = "Synerise") and starts the matching activity, with an action identifier for user interactions from a notification response.

```APIDOC
## handleNotification(_:actionIdentifier:)

### Description
Handles a notification payload (userInfo must contain "issuer" = "Synerise") and starts the matching activity, with an action identifier for user interactions from a notification response.

### Method
handleNotification

### Parameters
- **userInfo** ([AnyHashable : Any]) - Required - The notification payload.
- **actionIdentifier** (String) - Required - The action identifier from a notification response.

### Request Example
```swift
let userInfo = notification.userInfo
if Synerise.isSyneriseNotification(userInfo) {
    Synerise.handleNotification(userInfo, actionIdentifier: response.actionIdentifier)
}
```

### Response
No return value.
```

--------------------------------

### init(options:appearance:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

Creates a new ContentWidget instance with the provided options and appearance. The default init and new methods are unavailable, so this is the only way to instantiate the widget.

```APIDOC
## init(options:appearance:)

### Description
Creates a ContentWidget instance with the given business-logic options and appearance parameters. This is the designated initializer; default init and new are unavailable.

### Method
init

### Parameters
#### Parameters
- **options** (ContentWidgetOptions) - Required - Business-logic parameters for the widget.
- **appearance** (ContentWidgetAppearance) - Required - Appearance parameters for the widget.

### Request Example
```swift
let options = ContentWidgetRecommendationsOptions()
options.slug = "product-carousel"
options.recommendationEventType = .view

let layout = ContentWidgetHorizontalSliderLayout()
layout.itemSize = CGSize(width: 120, height: 160)
layout.itemSpacing = 8

let itemLayout = ContentWidgetBasicProductItemLayout()
// configure fonts, colors, insets...

let widget = ContentWidget(options: options, appearance: ContentWidgetAppearance(widgetLayout: layout, itemLayout: itemLayout))
```

### Response
#### Success Response
Returns a ContentWidget instance.

#### Response Example
```swift
let widget = ContentWidget(options: options, appearance: ContentWidgetAppearance(widgetLayout: layout, itemLayout: itemLayout))
```
```

--------------------------------

### getOrAssignVoucher(poolUUID:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Gets or assigns a voucher from a voucher pool.

```APIDOC
## getOrAssignVoucher(poolUUID:success:failure:)

### Description
Gets or assigns a voucher from a voucher pool.

### Method
Static method on Promotions class

### Parameters
- **poolUUID** (String) - Required - The UUID of the voucher pool.
- **success** (closure) - Required - Completion handler called on success with an AssignVoucherResponse object.
- **failure** (closure) - Required - Completion handler called on failure with an SNRApiError object.

### Response
#### Success Response
- **AssignVoucherResponse** - The assigned voucher details.

#### Error Response
- **SNRApiError** - Error details.
```

--------------------------------

### Initialize Synerise SDK

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Initialize the SDK in the application delegate using your Profile API Key.

```swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
    let apiKey = "YOUR_PROFILE_API_KEY"

    Synerise.initialize(apiKey: apiKey)
}
```

```objective-c
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    static NSString *apiKey = @"YOUR_PROFILE_API_KEY";

    [SNRSynerise initializeWithApiKey:apiKey];
}
```

--------------------------------

### Account Registration and Activation Methods

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Available static methods for registering new accounts and managing the activation flow.

```swift
@objc(registerAccount:success:failure:) public static func registerAccount(context: SyneriseSDK.ClientRegisterAccountContext, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(requestAccountActivationWithEmail:success:failure:) public static func requestAccountActivation(email: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(confirmAccountActivationByToken:success:failure:) public static func confirmAccountActivation(token: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(requestAccountActivationByPinWithEmail:success:failure:) public static func requestAccountActivationByPin(email: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(confirmAccountActivationByPin:email:success:failure:) public static func confirmAccountActivationByPin(pinCode: Swift.String, email: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
```

--------------------------------

### NotificationDelegate snr_notificationDidReceive Implementation

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/notifications.md

Example implementation of the snr_notificationDidReceive method for handling successfully decrypted and validated notifications.

```swift
func snr_notificationDidReceive(notificationInfo: NotificationInfo) {
    // notification was already decrypted and validated by the SDK; update UI state
}
```

--------------------------------

### Import Synerise SDK

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Import the SDK header into your files.

```swift
import SyneriseSDK
```

```objective-c
<SyneriseSDK/SyneriseSDK.h>
```

--------------------------------

### Initialize Synerise SDK in Swift

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/index.md

Use this code to initialize the Synerise SDK using your profile API key in a Swift project.

```swift
import SyneriseSDK

Synerise.initialize(apiKey: "YOUR_PROFILE_API_KEY")
```

--------------------------------

### ContentWidgetHorizontalSliderLayout

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

A concrete layout that arranges items in a horizontal slider. Provides item spacing and a method to get the content size.

```APIDOC
## ContentWidgetHorizontalSliderLayout

### Description
A concrete layout that arranges items in a horizontal slider. Provides item spacing and a method to get the content size.

### Properties
- `itemSpacing` (CGFloat) - Spacing between items.

### Methods
- `getSize()` -> CGSize - Returns the content size of the widget.
```

--------------------------------

### Configure Podfile

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Add the SyneriseSDK dependency to your project's Podfile.

```ruby
platform :ios, '13.0'
use_frameworks!

target YOUR_PROJECT_TARGET do
  pod 'SyneriseSDK'
end
```

--------------------------------

### ContentWidgetGridLayout

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

A concrete layout that arranges items in a grid. Provides horizontal and vertical spacing and a method to get the content size for a preferred width.

```APIDOC
## ContentWidgetGridLayout

### Description
A concrete layout that arranges items in a grid. Provides horizontal and vertical spacing and a method to get the content size for a preferred width.

### Properties
- `itemHorizontalSpacing` (CGFloat) - Horizontal spacing between items.
- `itemVerticalSpacing` (CGFloat) - Vertical spacing between items.

### Methods
- `getSize(preferredWidth:)` -> CGSize - Returns the content size for a given preferred width.
```

--------------------------------

### Query promotions and activate with points

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Builds a PromotionsApiQuery to filter active general promotions, sorts by priority descending, limits to 20, includes vouchers, then fetches matching promotions. Activates the first result using PromotionActivationOptions with pointsToUse = 500, handling errors like insufficient points or HTTP 401 for re-authentication.

```swift
let query = PromotionsApiQuery()
query.statuses = [.active]
query.types = [.general]
query.sorting = [[.priority: .desc]]
query.limit = 20
query.includeVouchers = true

Promotions.getPromotions(apiQuery: query, success: { response in
    guard let promotion = response.items.first else { return }
    let options = PromotionActivationOptions(identifier: PromotionIdentifier(uuid: promotion.uuid))
    options.pointsToUse = 500
    Promotions.activatePromotion(options: options, success: { activated in
        print("activated: \(activated.code)")
    }, failure: { error in
        // e.g. insufficient points, already redeemed
    })
}, failure: { error in
    if error.httpCode == 401 { /* re-auth */ }
})
```

--------------------------------

### Injector.inAppContext (static var)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/injector.md

Gets or sets the context dictionary that is passed to the JavaScript bridge via SRInApp.onContextFromApp(context). The context is cleared when the API key changes.

```APIDOC
## inAppContext (static var)

### Description
Gets or sets the context dictionary that is passed to the JavaScript bridge via SRInApp.onContextFromApp(context). The context is cleared when the API key changes.

### Type
[String : Any]

### Example
```swift
Injector.inAppContext = ["user": "john@example.com"]
```
```

--------------------------------

### Synerise.initialize

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/synerise.md

Initializes the Synerise SDK with the required API key and optional base URL and configuration. Must be called before any other SDK method and only once during the application lifecycle.

```APIDOC
## Synerise.initialize

### Description
Initializes the Synerise SDK with the required API key and optional base URL and configuration. Must be called before any other SDK method and only once during the application lifecycle. Completion is reported asynchronously through `SyneriseDelegate.snr_initialized()` / `snr_initializationError(error:)`.

### Method
initialize

### Signature
```swift
@objc(initializeWithApiKey:) public static func initialize(apiKey: Swift.String)
@objc(initializeWithApiKey:andBaseUrl:) public static func initialize(apiKey: Swift.String, baseUrl: Swift.String?)
@objc(initializeWithApiKey:andBaseUrl:config:) public static func initialize(apiKey: Swift.String, baseUrl: Swift.String?, config: SyneriseSDK.InitializationConfig?)
```

### Parameters
- **apiKey** (Swift.String) - Required - Synerise Profile (formerly Client) API key, generated at https://app.synerise.com/settings/apikeys for the Profile audience
- **baseUrl** (Swift.String?) - Optional - Custom Synerise API environment base URL. Default: nil (production)
- **config** (SyneriseSDK.InitializationConfig?) - Optional - Optional configuration, see configuration.md

### Request Example
```swift
import SyneriseSDK

Synerise.initialize(apiKey: "YOUR_PROFILE_API_KEY")
```

### Response
#### Success Response
- **snr_initialized()** - Called when initialization succeeds

#### Error Response
- **snr_initializationError(error:)** - Called when initialization fails, with an NSError object

### Response Example
```swift
Synerise.setDelegate(self)   // self implements SyneriseDelegate

extension MyApp: SyneriseDelegate {
    func snr_initialized() {
        print("Synerise SDK ready")
    }
    func snr_initializationError(error: NSError) {
        print("initialization failed: \(error.localizedDescription)")
    }
}
```
```

--------------------------------

### Get or assign voucher from pool

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Returns the already assigned voucher for the profile or assigns one from the specified pool. The same code is returned on subsequent calls; HTTP 416 indicates the pool is empty.

```swift
Promotions.getOrAssignVoucher(poolUUID: "pool-uuid-123", success: { response in
    print(response.assignVoucherData.code)   // stable per profile
}, failure: { error in
    if error.httpCode == 416 {   // pool empty
        print("voucher pool exhausted")
    }
})
```

--------------------------------

### Initialize Synerise SDK in Objective-C

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/index.md

Use this code to initialize the Synerise SDK using your profile API key in an Objective-C project.

```objc
#import <SyneriseSDK/SyneriseSDK.h>

[SNRSynerise initializeWithApiKey:@"YOUR_PROFILE_API_KEY"];
```

--------------------------------

### Configure Cartfile

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/README.md

Add the Synerise SDK repository to your Cartfile.

```text
github "synerise/synerise-ios-sdk"
```

--------------------------------

### GeneralSettings (Synerise.settings.sdk)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/configuration.md

General settings of the SDK, including master switch, tracking behavior, app group identifiers, token refresh interval, SSL pinning, session destruction on API key change, and localized strings.

```APIDOC
## GeneralSettings (Synerise.settings.sdk)

### Description
General settings of the SDK, including master switch, tracking behavior, app group identifiers, token refresh interval, SSL pinning, session destruction on API key change, and localized strings.

### Properties
- **enabled** (Bool) - Master switch of the SDK
- **doNotTrack** (Bool) - When true, tracking and requests are blocked (see error requestBlockedByIncognitoModeApiError -109)
- **appGroupIdentifier** (String?) - App group identifier (sample: "group.com.synerise.sdk.sample-swift")
- **keychainGroupIdentifier** (String?) - Keychain group identifier for secure storage
- **minTokenRefreshInterval** (TimeInterval) - Minimum interval between token refreshes
- **SSLPinningPinset** ([String]?) - SSL certificate pinning pinset
- **shouldDestroySessionOnApiKeyChange** (Bool) - Whether the current session is destroyed when Synerise.changeApiKey is called
- **localizable** ([SNRLocalizableStringKey : String]?) - Localized strings keyed by SyneriseLocalizable.OK / .CANCEL
```

--------------------------------

### activatePromotion(options:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Activates a promotion with additional options.

```APIDOC
## activatePromotion(options:success:failure:)

### Description
Activates a promotion with additional options.

### Method
Static method on Promotions class

### Parameters
- **options** (PromotionActivationOptions) - Required - Options for activation.
- **success** (closure) - Required - Completion handler called on success with a Promotion object.
- **failure** (closure) - Required - Completion handler called on failure with an SNRApiError object.

### Response
#### Success Response
- **Promotion** - The activated promotion.

#### Error Response
- **SNRApiError** - Error details.
```

--------------------------------

### Inspect and handle Synerise notification payloads

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/synerise.md

These static methods check the notification type, encryption status, decrypt payloads, and handle notifications. The handleNotification methods require userInfo to contain "issuer" = "Synerise" and start the matching activity; the actionIdentifier overload handles user interactions.

```swift
@objc(isSyneriseNotification:) public static func isSyneriseNotification(_ userInfo: [Swift.AnyHashable : Any]) -> Swift.Bool
@objc(isSyneriseSimplePush:) public static func isSyneriseSimplePush(_ userInfo: [Swift.AnyHashable : Any]) -> Swift.Bool
@objc(isSyneriseSilentCommand:) public static func isSyneriseSilentCommand(_ userInfo: [Swift.AnyHashable : Any]) -> Swift.Bool
@objc(isSyneriseSilentSDKCommand:) public static func isSyneriseSilentSDKCommand(_ userInfo: [Swift.AnyHashable : Any]) -> Swift.Bool
@objc(isNotificationEncrypted:) public static func isNotificationEncrypted(_ userInfo: [Swift.AnyHashable : Any]) -> Swift.Bool
@objc(decryptNotification:) public static func decryptNotification(_ userInfo: [Swift.AnyHashable : Any]) -> [Swift.AnyHashable : Any]?
@objc(handleNotification:) public static func handleNotification(_ userInfo: [Swift.AnyHashable : Any])
@objc(handleNotification:actionIdentifier:) public static func handleNotification(_ userInfo: [Swift.AnyHashable : Any], actionIdentifier: Swift.String)
```

--------------------------------

### authenticate(token:clientIdentityProvider:authID:context:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Authenticates with an OAuth/Facebook/Google/Apple/Synerise token; creates the account if it does not exist and the provider is not Synerise.

```APIDOC
## authenticate(token:clientIdentityProvider:authID:context:success:failure:)

### Description
Authenticates with an OAuth/Facebook/Google/Apple/Synerise token; creates the account if it does not exist and the provider is not Synerise.

### Method Signature
```swift
@objc(authenticateWithToken:clientIdentityProvider:authID:context:success:failure:) public static func authenticate(token: Any, clientIdentityProvider: SyneriseSDK.ClientIdentityProvider, authID: Swift.String?, context: SyneriseSDK.ClientAuthenticationContext?, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
```

### Parameters
- **token** (Any) - Required - The authentication token.
- **clientIdentityProvider** (ClientIdentityProvider) - Required - The identity provider.
- **authID** (String?) - Optional - The authentication ID.
- **context** (ClientAuthenticationContext?) - Optional - The authentication context.
- **success** (() -> Void) - Required - Closure called on success.
- **failure** ((SNRApiError) -> Void) - Required - Closure called on failure with an error.

### Response
#### Success Response
No return value; success closure is invoked.

#### Error Response
Failure closure with SNRApiError.
```

--------------------------------

### registerAccount(context:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Registers a new customer account with email, password, and optional data. The account may require activation depending on backend configuration.

```APIDOC
## registerAccount(context:success:failure:)

### Description
Registers a new customer account with email, password, and optional data. The account may require activation depending on backend configuration.

### Method Signature
```swift
@objc(registerAccount:success:failure:) public static func registerAccount(context: SyneriseSDK.ClientRegisterAccountContext, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
```

### Parameters
- **context** (ClientRegisterAccountContext) - Required - Registration context containing email, password, and optional fields (e.g., firstName, agreements).
- **success** (() -> Void) - Required - Closure called on successful registration.
- **failure** ((SNRApiError) -> Void) - Required - Closure called on failure with an SNRApiError.

### Example
```swift
let context = ClientRegisterAccountContext(email: "john@example.com", password: "S3cure-pass!")
context.firstName = "John"
context.agreements = ClientAgreements()   // email/sms/push/... flags

Client.registerAccount(context: context, success: { _ in
    Client.requestAccountActivation(email: "john@example.com", success: { _ in
        print("activation email sent")
    }, failure: { error in ... })
}, failure: { error in ... })
```
```

--------------------------------

### Sending a Custom Event with TrackerParams

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Demonstrates how to build event parameters using TrackerParams.make and send a custom event via Tracker.send.

```swift
let params = TrackerParams.make(with: { builder in
    builder.setString("sku", forKey: "productSku")
    builder.setDouble(4.5, forKey: "rating")
    builder.setBool(true, forKey: "inStock")
})
Tracker.send(CustomEvent(label: "product.rated", params: params))
```

--------------------------------

### PromotionActivationOptions

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Options for activating a promotion. Use it to specify the promotion identifier and the number of points to use.

```APIDOC
## PromotionActivationOptions

### Description
Options for activating a promotion. Use it to specify the promotion identifier and the number of points to use.

### Properties
- **pointsToUse** (Int) - Number of points to use for activation

### Initializer
- **init(identifier:)** - Creates options with the given promotion identifier

### Example
```swift
let identifier = PromotionIdentifier(uuid: "...")
let options = PromotionActivationOptions(identifier: identifier)
options.pointsToUse = 100
```
```

--------------------------------

### TrackerParams.make(with:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Builds a TrackerParams instance by running a handler against a fresh TrackerParamsBuilder. This is the primary way to create a TrackerParams object.

```APIDOC
## TrackerParams.make(with:)

### Description
Builds a TrackerParams by running the provided handler against a fresh TrackerParamsBuilder. The builder is used to set key-value pairs that will be included in the resulting TrackerParams.

### Method
make(with handler: (TrackerParamsBuilder) -> Void) -> TrackerParams

### Parameters
- **handler** (closure) - Required - A closure that receives a TrackerParamsBuilder instance to configure the parameters.

### Return Value
- **TrackerParams** - The constructed immutable parameter bag.

### Example
```swift
let params = TrackerParams.make(with: { builder in
    builder.setString("sku", forKey: "productSku")
    builder.setDouble(4.5, forKey: "rating")
    builder.setBool(true, forKey: "inStock")
})
```
```

--------------------------------

### Synerise Class

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/synerise.md

The Synerise class is the SDK entry point. It is a final class with static members only and must be initialized once before any other SDK method is called.

```APIDOC
## Synerise Class

### Description
The Synerise class is the SDK entry point. It is a final class with static members only and must be initialized once before any other SDK method is called.

### Declaration
```swift
@_inheritsConvenienceInitializers @objc(SNRSynerise) final public class Synerise : ObjectiveC.NSObject {
  @objc public static var settings: SyneriseSDK.Settings { @objc get }
}
```

### Properties
- **settings** (SyneriseSDK.Settings) - The SDK settings.
```

--------------------------------

### ClientRegisterAccountContext Model

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/types.md

Defines the context for registering a new client account, requiring email and password.

```swift
@objc(SNRClientRegisterAccountContext) public class ClientRegisterAccountContext : SyneriseSDK.BaseModel {
  @objc final public let email: Swift.String          // required
  @objc final public let password: Swift.String       // required
  @objc public var customId: Swift.String?
  @objc public var firstName: Swift.String?
  @objc public var lastName: Swift.String?
  @objc public var phone: Swift.String?
  @objc public var sex: SyneriseSDK.ClientSex { get set }
  @objc public var company: Swift.String?
  @objc public var address: Swift.String?
  @objc public var city: Swift.String?
  @objc public var province: Swift.String?
  @objc public var zipCode: Swift.String?
  @objc public var countryCode: Swift.String?
  @objc public var agreements: SyneriseSDK.ClientAgreements?
  @objc public var attributes: [Swift.String : Any]?
  @objc(initWithEmail:andPassword:) public init(email: Swift.String, password: Swift.String)
}
```

--------------------------------

### activatePromotion(options:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Activates a promotion with options, optionally spending loyalty points.

```APIDOC
## activatePromotion(options:success:failure:)

### Description
Activates a promotion with options, optionally spending loyalty points.

### Method
SDK Method

### Parameters
- `options` (PromotionActivationOptions) - Required - Options for activation, including `pointsToUse` to spend loyalty points.

### Success Payload
`Promotion`

### Example
```swift
let options = PromotionActivationOptions(identifier: PromotionIdentifier(uuid: promotion.uuid))
options.pointsToUse = 500
Promotions.activatePromotion(options: options, success: { activated in
    print("activated: \(activated.code)")
}, failure: { error in
    // e.g. insufficient points, already redeemed
})
```
```

--------------------------------

### PromotionsApiQuery

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Configuration object for querying promotions. Use it to set filters, sorting, pagination, and inclusion flags before making a promotions request.

```APIDOC
## PromotionsApiQuery

### Description
Configuration object for querying promotions. Use it to set filters, sorting, pagination, and inclusion flags before making a promotions request.

### Properties
- **statuses** ([SNRPromotionStatusString]) - Filter by status strings — use PromotionStatusString constants (none, active, assigned, redeemed)
- **types** ([SNRPromotionTypeString]) - Filter by type strings — PromotionTypeString constants
- **presentOnly** (Bool) - Only currently-valid promotions
- **checkGlobalActivationLimits** (Bool) - Apply global activation limits
- **sorting** ([[SNRPromotionSortingKey : SNRApiQuerySortingOrderString]]?) - Sort keys with per-key ascending/descending order — see string-key enums below
- **limit** (Int) - Pagination limit
- **page** (Int) - Pagination page
- **includeVouchers** (Bool) - Include voucher payloads
- **includeMeta** (Bool) - Include response metadata

### Example
```swift
let query = PromotionsApiQuery()
query.statuses = [.active]
query.types = [.discount]
query.presentOnly = true
query.limit = 20
query.page = 1
```
```

--------------------------------

### ProductViewedEvent

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/tracker.md

Event for tracking product views. Provides initializers with label, product name, product ID, and optional parameters, plus setters for recommendation status, category, and URL.

```APIDOC
## ProductViewedEvent

### Description
Event for tracking product views. Provides initializers with label, product name, product ID, and optional parameters, plus setters for recommendation status, category, and URL.

### Initializers
- `init(label: String, productName: String, productId: String)`
- `init(label: String, productName: String, productId: String, params: TrackerParams?)`

### Methods
- `setIsRecommended(_ isRecommended: Bool)`
- `setCategory(_ category: String)`
- `setURL(_ url: URL)`

```

--------------------------------

### Injector.createInlineInAppView(placementKey:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/injector.md

Creates an inline in-app message view for the given placement key. Returns nil if creation fails.

```APIDOC
## createInlineInAppView(placementKey:)

### Description
Creates an inline in-app message view for the given placement key. Returns nil if creation fails.

### Method
createInlineInAppView

### Parameters
- **placementKey** (String) - Required - The placement key that identifies the inline message slot.

### Returns
InlineInAppView? - The created view, or nil if creation fails.

### Example
```swift
guard let view = Injector.createInlineInAppView(placementKey: "product-page-1") else { return }
view.delegate = self
view.render()
```
```

--------------------------------

### Client Authentication Methods

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Available static methods for user authentication, including standard sign-in, conditional sign-in, and various token-based authentication approaches.

```swift
@objc(signInWithEmail:password:success:failure:) public static func signIn(email: Swift.String, password: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(signInConditionallyWithEmail:password:success:failure:) public static func signInConditionally(email: Swift.String, password: Swift.String, success: @escaping (SyneriseSDK.ClientConditionalAuthResult) -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(authenticateWithToken:clientIdentityProvider:authID:context:success:failure:) public static func authenticate(token: Any, clientIdentityProvider: SyneriseSDK.ClientIdentityProvider, authID: Swift.String?, context: SyneriseSDK.ClientAuthenticationContext?, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(authenticateConditionallyWithToken:clientIdentityProvider:authID:context:success:failure:) public static func authenticateConditionally(token: Any, clientIdentityProvider: SyneriseSDK.ClientIdentityProvider, authID: Swift.String?, context: SyneriseSDK.ClientConditionalAuthenticationContext?, success: @escaping (SyneriseSDK.ClientConditionalAuthResult) -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(authenticateWithTokenPayload:authID:success:failure:) public static func authenticate(tokenPayload: SyneriseSDK.TokenPayload, authID: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
@objc(simpleAuthentication:authID:success:failure:) public static func simpleAuthentication(data: SyneriseSDK.ClientSimpleAuthenticationData, authID: Swift.String, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)
```

--------------------------------

### getPromotions(success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Retrieves all available promotions defined for the customer.

```APIDOC
## getPromotions(success:failure:)

### Description
Retrieves all available promotions defined for the customer.

### Method
SDK Method

### Parameters
None

### Success Payload
`PromotionResponse`

### Example
```swift
Promotions.getPromotions(success: { response in
    print("\(response.metadata?.totalCount ?? 0) promotions")
    for promotion in response.items {
        print("\(promotion.name) \(promotion.status)")
    }
}, failure: { error in
    print("\(error.localizedDescription)")
})
```
```

--------------------------------

### activatePromotion(uuid:success:failure:) / activatePromotion(code:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Activates a promotion by UUID or code.

```APIDOC
## activatePromotion(uuid:success:failure:) / activatePromotion(code:success:failure:)

### Description
Activates a promotion by UUID or code.

### Method
SDK Method

### Parameters
- `uuid` (String) - Required (if using UUID) - The UUID of the promotion.
- `code` (String) - Required (if using code) - The code of the promotion.

### Success Payload
None
```

--------------------------------

### getPromotion(code:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Fetches a single promotion by its code.

```APIDOC
## getPromotion(code:success:failure:)

### Description
Fetches a single promotion by its code.

### Method
Static method on Promotions class

### Parameters
- **code** (String) - Required - The code of the promotion.
- **success** (closure) - Required - Completion handler called on success with a Promotion object.
- **failure** (closure) - Required - Completion handler called on failure with an SNRApiError object.

### Response
#### Success Response
- **Promotion** - The requested promotion.

#### Error Response
- **SNRApiError** - Error details.
```

--------------------------------

### signOut(mode:fromAllDevices:success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/client.md

Signs out with a specified mode and optional all-devices sign-out. Provides success and failure callbacks.

```APIDOC
## signOut(mode:fromAllDevices:success:failure:)

### Description
Signs out with a specified mode and optional all-devices sign-out. Provides success and failure callbacks.

### Method Signature
`@objc(signOutWithMode:fromAllDevices:success:failure:) public static func signOut(mode: SyneriseSDK.ClientSignOutMode, fromAllDevices: Swift.Bool, success: @escaping () -> Swift.Void, failure: @escaping (SyneriseSDK.SNRApiError) -> Swift.Void)`

### Parameters
- **mode** (ClientSignOutMode) - Required - The sign-out mode: `signOut` or `signOutWithSessionDestroy`.
- **fromAllDevices** (Bool) - Required - Whether to sign out from all devices.
- **success** (() -> Void) - Required - Callback invoked on successful sign-out.
- **failure** ((SNRApiError) -> Void) - Required - Callback invoked on failure with an error.

### Returns
None.

### Example
```swift
Client.signOut(mode: .signOut, fromAllDevices: false, success: {
    print("signed out")
}, failure: { error in
    print("sign-out failed: \(error.localizedDescription)")
})
```
```

--------------------------------

### getPromotions(success:failure:)

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/promotions.md

Fetches all promotions defined for the customer profile. This method returns a PromotionResponse object on success.

```APIDOC
## getPromotions(success:failure:)

### Description
Fetches all promotions defined for the customer profile.

### Method
Static method on Promotions class

### Parameters
- **success** (closure) - Required - Completion handler called on success with a PromotionResponse object.
- **failure** (closure) - Required - Completion handler called on failure with an SNRApiError object.

### Response
#### Success Response
- **PromotionResponse** - The list of promotions.

#### Error Response
- **SNRApiError** - Error details.
```

--------------------------------

### getView()

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content-widget.md

Returns the root view of the widget's view structure. The default size is zero, so the host must set the size or add layout constraints.

```APIDOC
## getView()

### Description
Returns the root view of the whole widget view structure. The default size is zero (width and height), so the host must set the size or add layout constraints; the structure is flexible.

### Method
getView

### Parameters
None

### Request Example
```swift
if let rootView = widget.getView() {
    addSubview(rootView)
    // then size/layout it
}
```

### Response
#### Success Response
Returns a UIView object representing the root view of the widget.

#### Response Example
```swift
let rootView = widget.getView()
```
```

--------------------------------

### ScreenViewApiQuery

Source: https://github.com/synerise/synerise-ios-sdk/blob/master/_autodocs/api-reference/content.md

Query object for screen view recommendations. Use it to configure a screen view recommendation request.

```APIDOC
## ScreenViewApiQuery

### Description
Query object for screen view recommendations. Use it to configure a screen view recommendation request.

### Initializer
`init(feedSlug: String)`

### Properties
- **feedSlug** (String, required, read-only) - Feed slug
- **productID** (String?) - Product ID for context
- **params** ([String: Any]?) - Additional parameters

### Example
```swift
let query = ScreenViewApiQuery(feedSlug: "feed-slug")
query.productID = "product-123"
```
```
Tokens:
Raw