--- updatedAt: 2026-06-18T13:02:40.000Z agentTools: projectIndex: https://docs.zetaglobal.com/llms.txt --- # API Reference A feature-grouped index of every public type the SDK exposes. Each entry links to the page where the type is used in context. This page is a feature-grouped index of every public type the SDK exposes. ## Client & configuration | Symbol | Description | | ------------------ | --------------------------------------------------------------------------- | | `ZetaClient` | Singleton entry point for the SDK. | | `ZTConfig` | Configuration object passed to `ZetaClient.shared.initialize(config:)`. | | `ZTRegion` | Enum of supported ZMP regions (`.US`, `.EU`). | | `ZTAppEnvironment` | Enum representing the app environment for APNs (`.PRODUCTION`, `.SANDBOX`). | See [Getting Started](https://docs.zetaglobal.com/docs/ios-sdk-getting-started). ## User & contacts | Symbol | Description | | ----------------------------- | ----------------------------------------------------------------------- | | `ZTUserManagable` | Protocol exposed via `ZetaClient.shared.user` for user operations. | | `ZTUser` | User model passed to `updateUser(_:)` or built via the builder pattern. | | `ZTUserEmail` | Email contact with optional `ZTContactAdditionalInfo`. | | `ZTUserPhone` | Phone contact with optional `ZTContactAdditionalInfo`. | | `ZTContactAdditionalInfo` | Preferences, subscription status, and custom properties for a contact. | | `ZTContactSubscriptionStatus` | Enum of subscription states (`new`, `active`, `inactive`, `none`). | | `ZTLocation` | Latitude/longitude plus foreground/background flag attached to events. | See [Contact Management](https://docs.zetaglobal.com/docs/ios-sdk-contact-management). ## Events | Symbol | Description | | ---------------------------------------------- | ------------------------- | | `ZetaClient.shared.event` | Event tracking namespace. | | `trackScreenName(screen:deeplink:properties:)` | Track screen navigation. | | `send(name:properties:)` | Send a custom event. | See [Contact Management](https://docs.zetaglobal.com/docs/ios-sdk-contact-management). ## Push notifications | Symbol | Description | | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ZetaClient.shared.push` | Push notification namespace. | | `ZTDeeplinkDelegate` | Delegate for receiving deeplinks carried by Zeta notifications. Implement `onZetaNotificationClicked(deeplink:extraInfo:)` — `deeplink` is the target URL/deep link from the campaign, and `extraInfo` is the dictionary of **Additional Values** configured in ZMP (pass-through key-value pairs). | | `userNotificationCenter(_:didReceive:withCompletionHandler:)` | SDK-managed click tracking helper for `UNUserNotificationCenterDelegate`. | | `trackNotificationClicked(response:)` | Manual click tracking. | See [Push Notifications](https://docs.zetaglobal.com/docs/ios-sdk-push-notifications). ## Notification Service Extension | Symbol | Description | | ------------------------------------------- | ---------------------------------------------------------------- | | `ZTNotificationService` | Rich notification rendering and delivery tracking inside an NSE. | | `canHandle(_:)` | Detects whether an incoming request is a Zeta notification. | | `trackNotificationDelivered(_:appGroupId:)` | Reports notification delivery to the SDK. | | `handleNotification(_:withContentHandler:)` | Entry point for Pattern 2 (non-subclass) integrations. | See [Push Notifications / NSE](https://docs.zetaglobal.com/docs/ios-sdk-push-notifications#notification-service-extension). ## In-App Messaging | Symbol | Description | | ----------------------------- | ---------------------------------------------------------------------- | | `ZetaClient.shared.inApp` | In-app messaging namespace (`start()` / `stop()`). | | `ZTInAppMessage` | The message model passed to lifecycle delegate callbacks. | | `ZTInAppMessageDelegate` | Delegate for `willAppear` / `didAppear` / `onClicked` / `onDismissed`. | | `ZTInAppMessageFormDataModel` | Data returned by in-app email collection forms. | See [In-App Messaging](https://docs.zetaglobal.com/docs/ios-sdk-in-app-messaging). ## App Inbox | Symbol | Description | | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ZTAppInboxManagable` | Protocol exposed via `ZetaClient.shared.inbox`. | | `ZTAppInboxMessage` | A single inbox entry. Key fields: `messageId`, `title`, `body`, `mediaUrl`, `status`, `expirationTimestamp`, `actionList`, `templateId`. `additionalData` — a `[String: String]` dictionary of **Additional Values** configured in the ZMP campaign builder; use these for custom routing or display logic in your inbox UI. | | `ZTAppInboxMessageStatus` | Read / unread / deleted state. | | `ZTAppInboxMessageStatusHelper` | Converts between `ZTAppInboxMessageStatus` and its string representation. | | `ZTCtaAction` | A call-to-action button attached to an inbox message. | See [App Inbox](https://docs.zetaglobal.com/docs/ios-sdk-app-inbox). ## Logging | Symbol | Description | | -------------- | -------------------------------------------------------------------------------- | | `ZTLogger` | Static namespace for all logging APIs. | | `ZTLogLevel` | Enum of log severities (`verbose`, `debug`, `info`, `warning`, `error`, `none`). | | `ZTLogPrivacy` | Enum of log visibility policies (`private`, `public`). | See [Advanced / Logging](https://docs.zetaglobal.com/docs/ios-sdk-logging). ## See also * [Changelog](https://docs.zetaglobal.com/docs/ios-sdk-changelog) — complete Added / Changed / Deprecated / Removed log for every version. * [Migration Guide](https://gitlab.com/zeta-crm/zetakit-swift/-/tree/main/migration) — breaking changes between versions.