diff --git a/docs/index.html b/docs/index.html index fcfbf29..22851e2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -78,6 +78,10 @@
There is an example app provided here for Swift.
When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the app_clickref
parameter stripped.
when conversion is completed.
+When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the app_clickref
parameter stripped when conversion is completed.
To return the full click object, use the following method.
+
+func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
+
+ if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
+ let click = try? Partnerize.beginConversion(userActivity.webpageURL)
+
+ let clickRef = click?.clickRef
+ let camRef = click?.camRef
+ let destination = click?.destination
+ let utmParams = click?.utmParams
+ let meta = click?.meta
+ }
+ }
+
+
+Alternatively, if just the destination URL is required, use the following method.
func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
if userActivity.activityType == NSUserActivityTypeBrowsingWeb {
@@ -166,6 +186,15 @@ Posting Conversions to Partnerize
The Click
class describes attributes and items within a click. This is returned from the method Partnerize.beginConversion(conversionUrl)
.
let clickRef = click?.clickRef
+ let camRef = click?.camRef
+ let destination = click?.destination
+ let destinationMobile = click?.destinationMobile
+ let utmParams = click?.utmParams
+ let meta = click?.meta
+
The Conversion
class describes attributes and items within a conversion. This is accessed as a property on the Partnerize
class.
Partnerize.conversion?.adRef = "myAddRef"
@@ -298,5 +327,5 @@ Keyboard Shortcuts
diff --git a/docs/search/search_index.json b/docs/search/search_index.json
index 6506366..0f641c6 100644
--- a/docs/search/search_index.json
+++ b/docs/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Introduction The iOS Mobile SDK allows you to capture in-app referrals, and easily record any sales that occur on the back of these referrals within your iOS application. It supports both Swift and Objective-C. The SDK provides two model classes; Conversion and ConversionItem . The Partnerize class is also used to provide functionality for dealing with inbound clicks, the combination of these classes enables the following features within your iOS app. Click reference retrieval from inbound requests. Conversion creation with a range of attributes including custom metadata. Conversion item support for accurate shopping basket representation. Deep linking support for Web to App and App to App. Quick Start Installation CocoaPods Add the Partnerize pod into your Podfile and run pod install . target :YourTargetName do pod 'Partnerize' end Carthage Add github \"PerformanceHorizonGroup/partnerize-mobile-sdk-ios\" to your Cartfile. Run carthage update . Go to your Xcode project's \"General\" settings. Drag Partnerize.framework from Carthage/Build/iOS to the \"Embedded Binaries\" section. Make sure \u201cCopy items if needed\u201d is selected and click Finish. After verifying your project compiles, switch over to Build Phases and add a new Run Script build phase by clicking the + in the top left of the editor. Add the following command: /usr/local/bin/carthage copy-frameworks Click the + under Input Files and add an entry for Partnerize framework: $(SRCROOT)/Carthage/Build/iOS/Partnerize.framework This build phase isn\u2019t required for your project to run. However, it\u2019s a workaround for an App Store submission bug where apps with frameworks that contain binary images for the iOS simulator are automatically rejected. The carthage copy-frameworks command strips out these extra architectures. Manual Installation Download Partnerize for iOS and extract the zip. Go to your Xcode project's \"General\" settings. Drag Partnerize.framework to the \"Embedded Binaries\" section. Make sure \"Copy items if needed\" is selected and click Finish. Create a new \u201cRun Script Phase\u201d in your app\u2019s target\u2019s \u201cBuild Phases\u201d and paste the following snippet in the script test field: bash \"${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Partnerize.framework/strip-frameworks.sh\" Example app There is an example app provided here for Swift. Handling inbound clicks When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the app_clickref parameter stripped. when conversion is completed. func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { if userActivity.activityType == NSUserActivityTypeBrowsingWeb { let url = try? Partnerize.beginConversion(with: userActivity.webpageURL) } Posting Conversions to Partnerize Once a conversion has been constructed and is ready to be recorded, it be can be sent to Partnerize using the following method. The completion block returns the status of the conversion and an error. Partnerize.completeConversion { isSuccess, error in if isSuccess { print(\"conversion logged\") } } Resources Conversion The Conversion class describes attributes and items within a conversion. This is accessed as a property on the Partnerize class. Partnerize.conversion?.adRef = \"myAddRef\" Partnerize.conversion?.pubRef = \"myPublisherRef\" Partnerize.conversion?.country = \"US\" Partnerize.conversion?.currency = \"USD\" Partnerize.conversion?.conversionRef = \"myConversionRef\" Partnerize.conversion?.custRef = \"myCustomerRef\" Partnerize.conversion?.voucher = \"25OFF\" Partnerize.conversion?.tsource = PHGAffiliateTrafficSource //\"Affiliate\" Partnerize.conversion?.customerType = .PHGNew Partnerize.conversion?.tmetric = PHGCheckoutConversionMetric // \"Checkout\" Partnerize.conversion?.metadata = [\"payment_type\" : \"crypto_currency\"] Partnerize.conversion?.items = [ConversionItem(value: \"11.99\", category: \"Shoes\", quantity: \"1\", sku: \"mySku\")] Clearing the Clickref It may be necessary to clear the click ref, this can be done with the following. Partnerize.conversion?.clearClickref() TrafficSource The PHGConversionTrafficSource constants such as PHGAffiliateTrafficSource are for used for setting the traffic source on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources. CustomerType This enum can either be CustomerType.EXISTING or CustomerType.NEW , and is used for setting the customer type on a conversion. ConversionMetric The PHGConversionMetric constants such as PHGCheckoutConversionMetric are for use for setting the conversion metric on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources. ConversionItem The ConversionItem class is a representation of an item within a Conversion to better represent a shopping basket. A ConversionItem requires a value and category for each item however additional attributes can be associated; quantity , sku as well as custom metadata similar to conversions. let conversionItems = [ ConversionItem(value: \"9.99\", category: \"Tops\"), ConversionItem(value: \"9.99\", category: \"Tops\", quantity: \"1\"), ConversionItem(value: \"9.99\", category: \"Shoes\", quantity: \"3\", sku: \"TRA-SPT-FIV\"), ] conversionItems.first?.metadata = [\"season\" : \"winter\"] Development Mode During development of your iOS app you may need to debug the requests being made. conversion.metadata = [\"development_mode\" : \"yes\"] Logging Logging may also be useful for debugging, this can help track errors when using the Partnerize SDK. This can be enabled like so. Partnerize.isLoggingEnabled = true License Apache-2.0 Release Notes Release notes can be found here","title":"Introduction"},{"location":"#introduction","text":"The iOS Mobile SDK allows you to capture in-app referrals, and easily record any sales that occur on the back of these referrals within your iOS application. It supports both Swift and Objective-C. The SDK provides two model classes; Conversion and ConversionItem . The Partnerize class is also used to provide functionality for dealing with inbound clicks, the combination of these classes enables the following features within your iOS app. Click reference retrieval from inbound requests. Conversion creation with a range of attributes including custom metadata. Conversion item support for accurate shopping basket representation. Deep linking support for Web to App and App to App.","title":"Introduction"},{"location":"#quick-start","text":"","title":"Quick Start"},{"location":"#installation","text":"","title":"Installation"},{"location":"#cocoapods","text":"Add the Partnerize pod into your Podfile and run pod install . target :YourTargetName do pod 'Partnerize' end","title":"CocoaPods"},{"location":"#carthage","text":"Add github \"PerformanceHorizonGroup/partnerize-mobile-sdk-ios\" to your Cartfile. Run carthage update . Go to your Xcode project's \"General\" settings. Drag Partnerize.framework from Carthage/Build/iOS to the \"Embedded Binaries\" section. Make sure \u201cCopy items if needed\u201d is selected and click Finish. After verifying your project compiles, switch over to Build Phases and add a new Run Script build phase by clicking the + in the top left of the editor. Add the following command: /usr/local/bin/carthage copy-frameworks Click the + under Input Files and add an entry for Partnerize framework: $(SRCROOT)/Carthage/Build/iOS/Partnerize.framework This build phase isn\u2019t required for your project to run. However, it\u2019s a workaround for an App Store submission bug where apps with frameworks that contain binary images for the iOS simulator are automatically rejected. The carthage copy-frameworks command strips out these extra architectures.","title":"Carthage"},{"location":"#manual-installation","text":"Download Partnerize for iOS and extract the zip. Go to your Xcode project's \"General\" settings. Drag Partnerize.framework to the \"Embedded Binaries\" section. Make sure \"Copy items if needed\" is selected and click Finish. Create a new \u201cRun Script Phase\u201d in your app\u2019s target\u2019s \u201cBuild Phases\u201d and paste the following snippet in the script test field: bash \"${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Partnerize.framework/strip-frameworks.sh\"","title":"Manual Installation"},{"location":"#example-app","text":"There is an example app provided here for Swift.","title":"Example app"},{"location":"#handling-inbound-clicks","text":"When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the app_clickref parameter stripped. when conversion is completed. func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { if userActivity.activityType == NSUserActivityTypeBrowsingWeb { let url = try? Partnerize.beginConversion(with: userActivity.webpageURL) }","title":"Handling inbound clicks"},{"location":"#posting-conversions-to-partnerize","text":"Once a conversion has been constructed and is ready to be recorded, it be can be sent to Partnerize using the following method. The completion block returns the status of the conversion and an error. Partnerize.completeConversion { isSuccess, error in if isSuccess { print(\"conversion logged\") } }","title":"Posting Conversions to Partnerize"},{"location":"#resources","text":"","title":"Resources"},{"location":"#conversion","text":"The Conversion class describes attributes and items within a conversion. This is accessed as a property on the Partnerize class. Partnerize.conversion?.adRef = \"myAddRef\" Partnerize.conversion?.pubRef = \"myPublisherRef\" Partnerize.conversion?.country = \"US\" Partnerize.conversion?.currency = \"USD\" Partnerize.conversion?.conversionRef = \"myConversionRef\" Partnerize.conversion?.custRef = \"myCustomerRef\" Partnerize.conversion?.voucher = \"25OFF\" Partnerize.conversion?.tsource = PHGAffiliateTrafficSource //\"Affiliate\" Partnerize.conversion?.customerType = .PHGNew Partnerize.conversion?.tmetric = PHGCheckoutConversionMetric // \"Checkout\" Partnerize.conversion?.metadata = [\"payment_type\" : \"crypto_currency\"] Partnerize.conversion?.items = [ConversionItem(value: \"11.99\", category: \"Shoes\", quantity: \"1\", sku: \"mySku\")]","title":"Conversion"},{"location":"#clearing-the-clickref","text":"It may be necessary to clear the click ref, this can be done with the following. Partnerize.conversion?.clearClickref()","title":"Clearing the Clickref"},{"location":"#trafficsource","text":"The PHGConversionTrafficSource constants such as PHGAffiliateTrafficSource are for used for setting the traffic source on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources.","title":"TrafficSource"},{"location":"#customertype","text":"This enum can either be CustomerType.EXISTING or CustomerType.NEW , and is used for setting the customer type on a conversion.","title":"CustomerType"},{"location":"#conversionmetric","text":"The PHGConversionMetric constants such as PHGCheckoutConversionMetric are for use for setting the conversion metric on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources.","title":"ConversionMetric"},{"location":"#conversionitem","text":"The ConversionItem class is a representation of an item within a Conversion to better represent a shopping basket. A ConversionItem requires a value and category for each item however additional attributes can be associated; quantity , sku as well as custom metadata similar to conversions. let conversionItems = [ ConversionItem(value: \"9.99\", category: \"Tops\"), ConversionItem(value: \"9.99\", category: \"Tops\", quantity: \"1\"), ConversionItem(value: \"9.99\", category: \"Shoes\", quantity: \"3\", sku: \"TRA-SPT-FIV\"), ] conversionItems.first?.metadata = [\"season\" : \"winter\"]","title":"ConversionItem"},{"location":"#development-mode","text":"During development of your iOS app you may need to debug the requests being made. conversion.metadata = [\"development_mode\" : \"yes\"]","title":"Development Mode"},{"location":"#logging","text":"Logging may also be useful for debugging, this can help track errors when using the Partnerize SDK. This can be enabled like so. Partnerize.isLoggingEnabled = true","title":"Logging"},{"location":"#license","text":"Apache-2.0","title":"License"},{"location":"#release-notes","text":"Release notes can be found here","title":"Release Notes"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Introduction The iOS Mobile SDK allows you to capture in-app referrals, and easily record any sales that occur on the back of these referrals within your iOS application. It supports both Swift and Objective-C. The SDK provides two model classes; Conversion and ConversionItem . The Partnerize class is also used to provide functionality for dealing with inbound clicks, the combination of these classes enables the following features within your iOS app. Click reference retrieval from inbound requests. Conversion creation with a range of attributes including custom metadata. Conversion item support for accurate shopping basket representation. Deep linking support for Web to App and App to App. Quick Start Installation CocoaPods Add the Partnerize pod into your Podfile and run pod install . target :YourTargetName do pod 'Partnerize' end Carthage Add github \"PerformanceHorizonGroup/partnerize-mobile-sdk-ios\" to your Cartfile. Run carthage update . Go to your Xcode project's \"General\" settings. Drag Partnerize.framework from Carthage/Build/iOS to the \"Embedded Binaries\" section. Make sure \u201cCopy items if needed\u201d is selected and click Finish. After verifying your project compiles, switch over to Build Phases and add a new Run Script build phase by clicking the + in the top left of the editor. Add the following command: /usr/local/bin/carthage copy-frameworks Click the + under Input Files and add an entry for Partnerize framework: $(SRCROOT)/Carthage/Build/iOS/Partnerize.framework This build phase isn\u2019t required for your project to run. However, it\u2019s a workaround for an App Store submission bug where apps with frameworks that contain binary images for the iOS simulator are automatically rejected. The carthage copy-frameworks command strips out these extra architectures. Manual Installation Download Partnerize for iOS and extract the zip. Go to your Xcode project's \"General\" settings. Drag Partnerize.framework to the \"Embedded Binaries\" section. Make sure \"Copy items if needed\" is selected and click Finish. Create a new \u201cRun Script Phase\u201d in your app\u2019s target\u2019s \u201cBuild Phases\u201d and paste the following snippet in the script test field: bash \"${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Partnerize.framework/strip-frameworks.sh\" Example app There is an example app provided here for Swift. Handling inbound clicks When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the app_clickref parameter stripped when conversion is completed. To return the full click object, use the following method. func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { if userActivity.activityType == NSUserActivityTypeBrowsingWeb { let click = try? Partnerize.beginConversion(userActivity.webpageURL) let clickRef = click?.clickRef let camRef = click?.camRef let destination = click?.destination let utmParams = click?.utmParams let meta = click?.meta } } Alternatively, if just the destination URL is required, use the following method. func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { if userActivity.activityType == NSUserActivityTypeBrowsingWeb { let url = try? Partnerize.beginConversion(with: userActivity.webpageURL) } Posting Conversions to Partnerize Once a conversion has been constructed and is ready to be recorded, it be can be sent to Partnerize using the following method. The completion block returns the status of the conversion and an error. Partnerize.completeConversion { isSuccess, error in if isSuccess { print(\"conversion logged\") } } Resources Click The Click class describes attributes and items within a click. This is returned from the method Partnerize.beginConversion(conversionUrl) . let clickRef = click?.clickRef let camRef = click?.camRef let destination = click?.destination let destinationMobile = click?.destinationMobile let utmParams = click?.utmParams let meta = click?.meta Conversion The Conversion class describes attributes and items within a conversion. This is accessed as a property on the Partnerize class. Partnerize.conversion?.adRef = \"myAddRef\" Partnerize.conversion?.pubRef = \"myPublisherRef\" Partnerize.conversion?.country = \"US\" Partnerize.conversion?.currency = \"USD\" Partnerize.conversion?.conversionRef = \"myConversionRef\" Partnerize.conversion?.custRef = \"myCustomerRef\" Partnerize.conversion?.voucher = \"25OFF\" Partnerize.conversion?.tsource = PHGAffiliateTrafficSource //\"Affiliate\" Partnerize.conversion?.customerType = .PHGNew Partnerize.conversion?.tmetric = PHGCheckoutConversionMetric // \"Checkout\" Partnerize.conversion?.metadata = [\"payment_type\" : \"crypto_currency\"] Partnerize.conversion?.items = [ConversionItem(value: \"11.99\", category: \"Shoes\", quantity: \"1\", sku: \"mySku\")] Clearing the Clickref It may be necessary to clear the click ref, this can be done with the following. Partnerize.conversion?.clearClickref() TrafficSource The PHGConversionTrafficSource constants such as PHGAffiliateTrafficSource are for used for setting the traffic source on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources. CustomerType This enum can either be CustomerType.EXISTING or CustomerType.NEW , and is used for setting the customer type on a conversion. ConversionMetric The PHGConversionMetric constants such as PHGCheckoutConversionMetric are for use for setting the conversion metric on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources. ConversionItem The ConversionItem class is a representation of an item within a Conversion to better represent a shopping basket. A ConversionItem requires a value and category for each item however additional attributes can be associated; quantity , sku as well as custom metadata similar to conversions. let conversionItems = [ ConversionItem(value: \"9.99\", category: \"Tops\"), ConversionItem(value: \"9.99\", category: \"Tops\", quantity: \"1\"), ConversionItem(value: \"9.99\", category: \"Shoes\", quantity: \"3\", sku: \"TRA-SPT-FIV\"), ] conversionItems.first?.metadata = [\"season\" : \"winter\"] Development Mode During development of your iOS app you may need to debug the requests being made. conversion.metadata = [\"development_mode\" : \"yes\"] Logging Logging may also be useful for debugging, this can help track errors when using the Partnerize SDK. This can be enabled like so. Partnerize.isLoggingEnabled = true License Apache-2.0 Release Notes Release notes can be found here","title":"Introduction"},{"location":"#introduction","text":"The iOS Mobile SDK allows you to capture in-app referrals, and easily record any sales that occur on the back of these referrals within your iOS application. It supports both Swift and Objective-C. The SDK provides two model classes; Conversion and ConversionItem . The Partnerize class is also used to provide functionality for dealing with inbound clicks, the combination of these classes enables the following features within your iOS app. Click reference retrieval from inbound requests. Conversion creation with a range of attributes including custom metadata. Conversion item support for accurate shopping basket representation. Deep linking support for Web to App and App to App.","title":"Introduction"},{"location":"#quick-start","text":"","title":"Quick Start"},{"location":"#installation","text":"","title":"Installation"},{"location":"#cocoapods","text":"Add the Partnerize pod into your Podfile and run pod install . target :YourTargetName do pod 'Partnerize' end","title":"CocoaPods"},{"location":"#carthage","text":"Add github \"PerformanceHorizonGroup/partnerize-mobile-sdk-ios\" to your Cartfile. Run carthage update . Go to your Xcode project's \"General\" settings. Drag Partnerize.framework from Carthage/Build/iOS to the \"Embedded Binaries\" section. Make sure \u201cCopy items if needed\u201d is selected and click Finish. After verifying your project compiles, switch over to Build Phases and add a new Run Script build phase by clicking the + in the top left of the editor. Add the following command: /usr/local/bin/carthage copy-frameworks Click the + under Input Files and add an entry for Partnerize framework: $(SRCROOT)/Carthage/Build/iOS/Partnerize.framework This build phase isn\u2019t required for your project to run. However, it\u2019s a workaround for an App Store submission bug where apps with frameworks that contain binary images for the iOS simulator are automatically rejected. The carthage copy-frameworks command strips out these extra architectures.","title":"Carthage"},{"location":"#manual-installation","text":"Download Partnerize for iOS and extract the zip. Go to your Xcode project's \"General\" settings. Drag Partnerize.framework to the \"Embedded Binaries\" section. Make sure \"Copy items if needed\" is selected and click Finish. Create a new \u201cRun Script Phase\u201d in your app\u2019s target\u2019s \u201cBuild Phases\u201d and paste the following snippet in the script test field: bash \"${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Partnerize.framework/strip-frameworks.sh\"","title":"Manual Installation"},{"location":"#example-app","text":"There is an example app provided here for Swift.","title":"Example app"},{"location":"#handling-inbound-clicks","text":"When an inbound intent from a mobile web browser or iOS app launches your iOS app via a deep link. This prepares an internal conversion object using Universal Link for further use and returns a new url containing original url with the app_clickref parameter stripped when conversion is completed. To return the full click object, use the following method. func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { if userActivity.activityType == NSUserActivityTypeBrowsingWeb { let click = try? Partnerize.beginConversion(userActivity.webpageURL) let clickRef = click?.clickRef let camRef = click?.camRef let destination = click?.destination let utmParams = click?.utmParams let meta = click?.meta } } Alternatively, if just the destination URL is required, use the following method. func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool { if userActivity.activityType == NSUserActivityTypeBrowsingWeb { let url = try? Partnerize.beginConversion(with: userActivity.webpageURL) }","title":"Handling inbound clicks"},{"location":"#posting-conversions-to-partnerize","text":"Once a conversion has been constructed and is ready to be recorded, it be can be sent to Partnerize using the following method. The completion block returns the status of the conversion and an error. Partnerize.completeConversion { isSuccess, error in if isSuccess { print(\"conversion logged\") } }","title":"Posting Conversions to Partnerize"},{"location":"#resources","text":"","title":"Resources"},{"location":"#click","text":"The Click class describes attributes and items within a click. This is returned from the method Partnerize.beginConversion(conversionUrl) . let clickRef = click?.clickRef let camRef = click?.camRef let destination = click?.destination let destinationMobile = click?.destinationMobile let utmParams = click?.utmParams let meta = click?.meta","title":"Click"},{"location":"#conversion","text":"The Conversion class describes attributes and items within a conversion. This is accessed as a property on the Partnerize class. Partnerize.conversion?.adRef = \"myAddRef\" Partnerize.conversion?.pubRef = \"myPublisherRef\" Partnerize.conversion?.country = \"US\" Partnerize.conversion?.currency = \"USD\" Partnerize.conversion?.conversionRef = \"myConversionRef\" Partnerize.conversion?.custRef = \"myCustomerRef\" Partnerize.conversion?.voucher = \"25OFF\" Partnerize.conversion?.tsource = PHGAffiliateTrafficSource //\"Affiliate\" Partnerize.conversion?.customerType = .PHGNew Partnerize.conversion?.tmetric = PHGCheckoutConversionMetric // \"Checkout\" Partnerize.conversion?.metadata = [\"payment_type\" : \"crypto_currency\"] Partnerize.conversion?.items = [ConversionItem(value: \"11.99\", category: \"Shoes\", quantity: \"1\", sku: \"mySku\")]","title":"Conversion"},{"location":"#clearing-the-clickref","text":"It may be necessary to clear the click ref, this can be done with the following. Partnerize.conversion?.clearClickref()","title":"Clearing the Clickref"},{"location":"#trafficsource","text":"The PHGConversionTrafficSource constants such as PHGAffiliateTrafficSource are for used for setting the traffic source on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources.","title":"TrafficSource"},{"location":"#customertype","text":"This enum can either be CustomerType.EXISTING or CustomerType.NEW , and is used for setting the customer type on a conversion.","title":"CustomerType"},{"location":"#conversionmetric","text":"The PHGConversionMetric constants such as PHGCheckoutConversionMetric are for use for setting the conversion metric on a conversion. Raw strings can also be used however, the Partnerize platform only accepts a predefined list of traffic sources.","title":"ConversionMetric"},{"location":"#conversionitem","text":"The ConversionItem class is a representation of an item within a Conversion to better represent a shopping basket. A ConversionItem requires a value and category for each item however additional attributes can be associated; quantity , sku as well as custom metadata similar to conversions. let conversionItems = [ ConversionItem(value: \"9.99\", category: \"Tops\"), ConversionItem(value: \"9.99\", category: \"Tops\", quantity: \"1\"), ConversionItem(value: \"9.99\", category: \"Shoes\", quantity: \"3\", sku: \"TRA-SPT-FIV\"), ] conversionItems.first?.metadata = [\"season\" : \"winter\"]","title":"ConversionItem"},{"location":"#development-mode","text":"During development of your iOS app you may need to debug the requests being made. conversion.metadata = [\"development_mode\" : \"yes\"]","title":"Development Mode"},{"location":"#logging","text":"Logging may also be useful for debugging, this can help track errors when using the Partnerize SDK. This can be enabled like so. Partnerize.isLoggingEnabled = true","title":"Logging"},{"location":"#license","text":"Apache-2.0","title":"License"},{"location":"#release-notes","text":"Release notes can be found here","title":"Release Notes"}]}
\ No newline at end of file
diff --git a/docs/sitemap.xml b/docs/sitemap.xml
index e80b4d9..b3c3e1b 100644
--- a/docs/sitemap.xml
+++ b/docs/sitemap.xml
@@ -2,7 +2,7 @@
None
- 2021-09-15
+ 2021-09-23
daily
\ No newline at end of file
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
index a2c04f1..170bd9a 100644
Binary files a/docs/sitemap.xml.gz and b/docs/sitemap.xml.gz differ