# Migrate from PinchSDK v2 to Kettle v1

This page describes how to migrate your application from using PinchSDK v2 to Kettle.

# Before you begin

This guide assumes that you fullfill the requirements to implement PinchSDK. iOS target has been increased from 9.0 to 11.0 due to versions below 11.0 being marked obsolete by Apple.

Requirements:

# iOS

# Step 1: Replace existing reference to pod

In your app's Podfile, remove the following pods:

PinchSDK
PinchSDKLegacy
PinchSDKLegacyBluetooth

Add the following pod:

pod 'KettleKit', '1.0.0'

# Step 2: Replace imports

Replace all instances of:

import PinchSDK

with

/// swift
import KettleKit

/// objc
#import <KettleKit/KettleKit-Swift.h>

# Step 3: Replace API calls

# PinchSDK.initialize(with: launchOptions, apiKey: "")

let config = KettleConfig.default()
config.productionApiKey = "PRODUCTION-API-KEY"
config.developmentApiKey = "DEVELOPMENT-API-KEY"

Kettle.prepare(config, launchOptions: launchOptions)

Additionally, config has the following fields and method available:

inProduction: Production status for the application. This value is used by Kettle to determine if the application is in production. If this value is not set, Kettle will set this value based on the application build scheme.

developmentLogLevel: Log level used for development apps.

productionLogLevel: Log level used for production apps.

validate(): Used to validate the config.

# Consents

/// PinchSDK.Consent.surveys
KettleConsent.surveys

/// PinchSDK.Consent.analytics
KettleConsent.analytics

/// PinchSDK.Consent.campaigns
 KettleConsent.campaigns

/// PinchSDK.Consent.ads
KettleConsent.ads

# PinchSDK.grant(consents: [.ads, .analytics, ...]) { success in ... }

Kettle.shared.grant(consents: [.ads, .analytics, ...])

# PinchSDK.revoke(consents: [.ads, .analytics, ...]) { success in ... }

Kettle.shared.revoke(consents: [.ads, .analytics, ...])

# PinchSDK.grantedConsents

Kettle.shared.grantedConsents

# PinchSDK.adid

This method is obsolete and removed.

# PinchSDK.start(providers: [.bluetooth, .location, .motion])

Kettle.shared.start(with: [.bluetooth, .location, .activity])

# PinchSDK.stop(providers: [.bluetooth, .location, .motion])

Kettle.shared.stop(with: [.bluetooth, .location, .activity])

# PinchSDK.isTracking { sdkStarted in ... }

let started: Bool = Kettle.shared.started

# PinchSDK.messagingId

This method was used to either retrieve the internal identifier assigned by Pinch or set an external identifier or send push tokens. This method is now obsolete and has been replaced by three variables, responsible for each part.

// send push token
Kettle.shared.pushToken = "push-token"

// your identifier for the user
Kettle.shared.externalId = "your-identifier"

// retrieve our identifier
let identifier: String = Kettle.shared.identifier

# PinchSDK.sendDemographicProfile(with: DemographicProfile) { success in ... }

Currently no migration path.

# PinchSDK.setMetadata(type: type, json: json) { success in ... }

Currently no migration path.

# PinchSDK.addCustomData(type: type, json: json) { success in ... }

Currently no migration path.

# PinchSDK.privacyTermsUrl

let privacyTermsUrl: String = Kettle.shared.privacyTermsUrl

# PinchSDK.getPrivacyDashboardUrl(for: .analytics)

let privacyDashboardUrl: String = Kettle.shared.privacyDashboardUrl

# PinchSDK.deleteCollectedData() { success in ... }

Kettle.shared.deleteCollectedData() { dataDeleted in 
    if dataDeleted {
        ...
    }
}

# PinchSDK.requestBluetoothPermission()

Kettle.shared.requestBluetoothPermission()

# PinchSDK.getGender(for: name) { gender in ... }

Currently no migration path.