TenjinSDK.h

//
// Created by Tenjin on 2016-05-20.
//  Version 1.19.0

//  Copyright (c) 2016 Tenjin. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <StoreKit/StoreKit.h>

@class TenjinPurchasesManager;
@class TJNUserProfileData;

@interface TenjinSDK : NSObject

#pragma mark Initialization

- (instancetype)init NS_UNAVAILABLE;

// initialize the Tenjin SDK
+ (TenjinSDK *)init:(NSString *)apiToken __deprecated_msg("use `initialize`");

//initialize the Tenjin SDK with shared secret
+ (TenjinSDK *)init:(NSString *)apiToken
    andSharedSecret:(NSString *)secret __deprecated_msg("use `initialize`");

//initialize the Tenjin SDK with app subversion
+ (TenjinSDK *)init:(NSString *)apiToken
   andAppSubversion:(NSNumber *)subversion __deprecated_msg("use `initialize`");

//initialize the Tenjin SDK with shared secret and app subversion
+ (TenjinSDK *)init:(NSString *)apiToken
    andSharedSecret:(NSString *)secret
   andAppSubversion:(NSNumber *)subversion __deprecated_msg("use `initialize`");

// initialize the Tenjin SDK
+ (TenjinSDK *)initialize:(NSString *)apiToken;

//initialize the Tenjin SDK with shared secret
+ (TenjinSDK *)initialize:(NSString *)apiToken
          andSharedSecret:(NSString *)secret;

//initialize the Tenjin SDK with app subversion
+ (TenjinSDK *)initialize:(NSString *)apiToken
         andAppSubversion:(NSNumber *)subversion;

//initialize the Tenjin SDK with shared secret and app subversion
+ (TenjinSDK *)initialize:(NSString *)apiToken
          andSharedSecret:(NSString *)secret
         andAppSubversion:(NSNumber *)subversion;

- (id)initWithToken:(NSString *)apiToken
    andSharedSecret:(NSString *)secret
   andAppSubversion:(NSNumber *)subversion
andDeferredDeeplink:(NSURL *)url
               ping:(BOOL)ping NS_DESIGNATED_INITIALIZER;

#pragma mark Singleton access

// initialize the Tenjin SDK
+ (TenjinSDK *)getInstance:(NSString *)apiToken;

//initialize the Tenjin SDK with shared secret
+ (TenjinSDK *)getInstance:(NSString *)apiToken
           andSharedSecret:(NSString *)secret;

//initialize the Tenjin SDK with app subversion
+ (TenjinSDK *)getInstance:(NSString *)apiToken
          andAppSubversion:(NSNumber *)subversion;

//initialize the Tenjin SDK with shared secret and app subversion
+ (TenjinSDK *)getInstance:(NSString *)apiToken
           andSharedSecret:(NSString *)secret
          andAppSubversion:(NSNumber *)subversion;

//initialize the Tenjin SDK + connect
+ (TenjinSDK *)sharedInstanceWithToken:(NSString *)apiToken __deprecated_msg("use `init` and `connect`");

//initialize the Tenjin SDK + connect with a third party deeplink
+ (TenjinSDK *)sharedInstanceWithToken:(NSString *)apiToken
                   andDeferredDeeplink:(NSURL *)url __deprecated_msg("use `init` and `connectWithDeferredDeeplink`");

//returns the shared Tenjin SDK instance
+ (TenjinSDK *)sharedInstance;

//returns the shared Purchases Manager instance for StoreKit 2 on-demand tracking
+ (TenjinPurchasesManager *)purchasesManager;

#pragma mark - Functionality

//use connect to send connect call. sharedInstanceWithToken automatically does a connect
+ (void)connect;

//use connect to send connect call. sharedInstanceWithToken automatically does a connect
+ (void)connectWithDeferredDeeplink:(NSURL *)url;

//report the deeplink URL the app was opened with for re-engagement attribution.
//call from application:openURL:options: and continueUserActivity:, or the UISceneDelegate
//equivalents (scene:openURLContexts:, scene:continueUserActivity: and, for cold starts,
//connectionOptions in scene:willConnectToSession:options:). AppDelegate-only apps also get
//cold launches captured automatically; scene-based apps must forward all cases.
+ (void)handleOpenURL:(NSURL *)url NS_SWIFT_NAME(handleOpenURL(_:));

//raw-string variant of handleOpenURL for plugin wrappers (Unity, Flutter, React Native).
//safe to call before initialization - the URL is cached and sent with the first connect
+ (void)handleOpenURLString:(NSString *)urlString NS_SWIFT_NAME(handleOpenURLString(_:));

//use sendEventWithName for custom event names
+ (void)sendEventWithName:(NSString *)eventName;

//This method is deprecated in favor of [sendEventWithName: andValue:], so you can pass an integer directly
+ (void)sendEventWithName:(NSString *)eventName
            andEventValue:(NSString *)eventValue __deprecated_msg("use `sendEventWithName: andValue:` instead");

//Use this method to send custom events with values
+ (void)sendEventWithName:(NSString *)eventName
            andValue:(NSInteger)eventValue;

//This method is deprecated in favor of [transaction: andReceipt:], so Tenjin can verify your transactions
+ (void)transaction:(SKPaymentTransaction *)transaction __attribute__((deprecated));

//Use this method to submit a transaction to Tenjin, we will also attempt to verify it for our records
+ (void)transaction:(SKPaymentTransaction *)transaction
         andReceipt:(NSData *)receipt;

//use transactionWithProductName... when you don't use Apple's SKPaymentTransaction and need to pass revenue directly
+ (void)transactionWithProductName:(NSString *)productName
                   andCurrencyCode:(NSString *)currencyCode
                       andQuantity:(NSInteger)quantity
                      andUnitPrice:(NSDecimalNumber *)price;

//use transactionWithProductName...when you don't use Apple's SKPaymentTransaction and need to pass revenue directly with a NSData binary receipt
+ (void)transactionWithProductName:(NSString *)productName
                   andCurrencyCode:(NSString *)currencyCode
                       andQuantity:(NSInteger)quantity
                      andUnitPrice:(NSDecimalNumber *)price
                  andTransactionId:(NSString *)transactionId
                        andReceipt:(NSData *)receipt;

//use this method when you want to pass in a base64 receipt instead of a NSData receipt
+ (void)transactionWithProductName:(NSString *)productName
                   andCurrencyCode:(NSString *)currencyCode
                       andQuantity:(NSInteger)quantity
                      andUnitPrice:(NSDecimalNumber *)price
                  andTransactionId:(NSString *)transactionId
                  andBase64Receipt:(NSString *)receipt;

//use this method to register the attribution callback
- (void)registerDeepLinkHandler:(void (^)(NSDictionary *params, NSError *error))deeplinkHandler;

//notify Tenjin of a new subscription purchase
- (void)handleSubscriptionPurchase:(SKPaymentTransaction *)transaction;

//track subscription with manual parameters (useful for plugins like Flutter, Unity, etc.)
+ (void)subscriptionWithProductName:(NSString *)productName
                   andCurrencyCode:(NSString *)currencyCode
                      andUnitPrice:(NSDecimalNumber *)price
                  andTransactionId:(NSString *)transactionId
         andOriginalTransactionId:(NSString *)originalTransactionId
                  andBase64Receipt:(NSString *)receipt
                 andSKTransaction:(NSString *)skTransaction;

//track subscription by fetching the latest SK2 transaction natively
//recommended for IAP libraries that don't expose SK2 data (e.g., RevenueCat)
+ (void)subscriptionWithStoreKitForProductId:(NSString *)productId
                            andCurrencyCode:(NSString *)currencyCode
                               andUnitPrice:(NSDecimalNumber *)price API_AVAILABLE(ios(16.0));

// GDPR opt-out
+ (void)optOut;

// GDPR opt-in
+ (void)optIn;

// GDPR opt-out of list of params
+ (void)optOutParams:(NSArray *)params;

// GDPR opt-in with list of params
+ (void)optInParams:(NSArray *)params;

// GDPR opt-in/opt-out through CMP consents
+ (bool)optInOutUsingCMP;

// Opt out from Google DMA parameters (opted in by default)
+ (void)optOutGoogleDMA;

// Opt out from Google DMA parameters
+ (void)optInGoogleDMA;

// Appends app subversion to app version
+ (void)appendAppSubversion:(NSNumber *)subversion;

// deprecated
+ (void)updateSkAdNetworkConversionValue:(int)conversionValue __deprecated_msg("use `updatePostbackConversionValue:`");

//deprecated
+ (void)updateConversionValue:(int)conversionValue __deprecated_msg("use `updatePostbackConversionValue:`");

// Update conversion value
+ (void)updatePostbackConversionValue:(int)conversionValue;

// Update conversion value and coarse value (iOS 16.1+)
+ (void)updatePostbackConversionValue:(int)conversionValue
                          coarseValue:(NSString*)coarseValue;

// Update conversion value, coarse value and lock window (iOS 16.1+)
+ (void)updatePostbackConversionValue:(int)conversionValue
                          coarseValue:(NSString*)coarseValue
                           lockWindow:(BOOL)lockWindow;

// Set customer user id to send as parameter on each event request
+ (void)setCustomerUserId:(NSString *)userId;

// Get customer user id saved on the device
+ (NSString *)getCustomerUserId;

// Set the setting to enable/disable cache events and retrying, it's false by default
+ (void)setCacheEventSetting:(BOOL)isCacheEventsEnabled;

// Set the setting to enable/disable ecrypting requests, it's false by default
+ (void)setEncryptRequestsSetting:(BOOL)isEncryptRequestsEnabled;

// Get cached analytics_installation_id
+ (NSString*)getAnalyticsInstallationId;

#pragma mark User Profile

+ (TJNUserProfileData *)getUserProfile;

+ (NSDictionary *)getUserProfileAsDictionary;

+ (void)resetUserProfile;

#pragma mark Util

+ (void)verboseLogs;

+ (void)debugLogs;

+ (void)setLogHandler:(void (^)(NSString *))handler;

+ (NSString *)sdkVersion;

+ (void)setWrapperVersion:(NSString *)wrapperVersion;

+ (void)setPluginVersion:(NSString *)plugin version:(NSString *)version;

+ (void)setValue:(NSString *)value
          forKey:(NSString *)key;

//deprecated
+ (void)registerAppForAdNetworkAttribution __deprecated_msg("use `updatePostbackConversionValue:`");

+ (void)requestTrackingAuthorizationWithCompletionHandler:(void (^)(NSUInteger status))completion;

- (void)getAttributionInfo:(void (^)(NSDictionary *attributionInfo, NSError *error))completionHandler;

- (void)setGoogleDMAParametersWithAdPersonalization:(BOOL)adPersonalization adUserData:(BOOL)adUserData;

@end

//
// Created by Tenjin
// Copyright (c) 2022 Tenjin. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "TenjinSDK.h"

@interface TenjinSDK (TopOnILRD)
+ (void)topOnImpressionFromDict:(NSDictionary *)adImpression;
+ (void)topOnImpressionFromJSON:(NSString *)jsonString;
@end

//
// Created by Tenjin
// Copyright (c) 2022 Tenjin. All rights reserved.
//

#import "TenjinSDK.h"
#import <Foundation/Foundation.h>

@interface TenjinSDK (AppLovinILRD)
+ (void)subscribeAppLovinImpressions;
+ (void)appLovinImpressionFromJSON:(NSString *)jsonString;
@end

//
// Created by Tenjin
// Copyright (c) 2022 Tenjin. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "TenjinSDK.h"

@interface TenjinSDK (HyperBidILRD)
+ (void)hyperBidImpressionFromDict:(NSDictionary *)adImpression;
+ (void)hyperBidImpressionFromJSON:(NSString *)jsonString;
@end

//
// Created by Tenjin
// Copyright (c) 2022 Tenjin. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "TenjinSDK.h"

@class GADAdValue;

@interface TenjinSDK (AdMobILRD)
+ (void)handleAdMobILRD:(NSObject *)adView :(GADAdValue *)adValue;
+ (void)adMobImpressionFromJSON:(NSString *)jsonString;
@end

//
// Created by Tenjin
// Copyright (c) 2022 Tenjin. All rights reserved.
//

#import "TenjinSDK.h"
#import <Foundation/Foundation.h>

@interface TenjinSDK (IronSourceILRD)
+ (void)subscribeIronSourceImpressions;
+ (void)ironSourceImpressionFromJSON:(NSString *)jsonString;
@end

//
// Created by Tenjin
// Copyright (c) 2023 Tenjin. All rights reserved.
//

#import "TenjinSDK.h"
#import <Foundation/Foundation.h>

@interface TenjinSDK (CASILRD)
+ (void)subscribeCASBannerImpressions;
+ (void)casImpressionFromJSON:(NSString *)jsonString;
+ (void)handleCASILRD:(id)adImpression;
@end

//
// Created by Tenjin
// Copyright (c) 2023 Tenjin. All rights reserved.
//

#import "TenjinSDK.h"
#import <Foundation/Foundation.h>

@interface TenjinSDK (TradPlusILRD)
+ (void)subscribeTradPlusImpressions;
+ (void)tradPlusImpressionFromJSON:(NSString *)jsonString;
+ (void)handleTradPlusILRD:(NSDictionary *)adInfo;
@end

//
// Created by Tenjin
// Copyright (c) 2025 Tenjin. All rights reserved.
//

#import "TenjinSDK.h"
#import <Foundation/Foundation.h>

@interface TenjinSDK (CloudXILRD)
+ (void)handleCloudXILRD:(id)adImpression;
+ (void)cloudXImpressionFromJSON:(NSString *)jsonString;
@end

//
// Created by Tenjin
// Copyright (c) 2026 Tenjin. All rights reserved.
//

#import "TenjinSDK.h"
#import <Foundation/Foundation.h>

@interface TenjinSDK (CustomILRD)

+ (void)customImpressionFromJSON:(NSString *)jsonString;

@end