nimblehq/business-loyalty-ios-sdk-poc

This NimbleLoyalty SDK library allows developers to easily integrate loyalty programs into their iOS applications.

Features

Authenticate
Get reward list
Get reward detail
Redeem reward
Get reward history

Component Libraries

Moya
KeychainAccess

Requirements

iOS 14.0+
Xcode 14.0+

Installation

The iOS Loyalty SDK can be installed using CocoaPods or Swift Package Manager.

CocoaPods

To install using CocoaPods, add the following line to your Podfile:

pod 'NimbleLoyalty', '~> 0.1.0'

Swift Package Manager

To install using Swift Package Manager, add the following line to your dependencies:

.package(url: "https://github.com/nimblehq/business-loyalty-ios-sdk-poc.git", from: "0.1.0")

Usage

Authentication

Before authenticating the user, remember to set the clientId and clientSecret.

NimbleLoyalty.shared.setClientId("CLIENT_ID")
NimbleLoyalty.shared.setClientSecret("CLIENT_SECRET")

isAuthenticated()

Checks if the user is authenticated.

if NimbleLoyalty.shared.isAuthenticated() {
    // The user is authenticated, do something
} else {
    // The user is not authenticated, show a login button
}

authenticate(completion:)

Initiates the authentication flow.

NimbleLoyalty.shared.authenticate { result in
    switch result {
    case .success:
        // The user is authenticated, do something
    case .failure(let error):
    	print("Error authenticating: \(error.localizedDescription)")
    }
}

clearSession()

Remove the session, effectively logging the user out.

// Clear the user's session
NimbleLoyalty.shared.clearSession()

Get Reward List

Retrieves the list of available rewards for the authenticated user.

NimbleLoyalty.shared.getRewardList { result in
   switch result {
   case .success(let rewardList):
       // Display the list of rewards to the user
       for reward in rewardList.rewards {
           print("Reward name: \(reward.name)")
       }
   case .failure(let error):
       print("Error retrieving rewards: \(error.localizedDescription)")
   }
}

Get Reward Detail

Retrieves the detail of a specific reward.

NimbleLoyalty.shared.getRewardDetail(code: "reward_id") { result in
   switch result {
   case .success(let rewardDetail):
       // Display the reward detail to the user
   case .failure(let error):
       print("Error retrieving reward detail: \(error.localizedDescription)")
   }
}

Redeem a Reward

Redeems a reward with the given reward's code for the authenticated user.

NimbleLoyalty.shared.redeemReward(code: "ABC123") { result in
   switch result {
   case .success(let rewardList):
       print("Reward redeemed with ID: \(redeemReward.id)")
   case .failure(let error):
       print("Error redeeming reward: \(error.localizedDescription)")
   }
}

Get Reward History

Retrieves the reward history for the authenticated user.

NimbleLoyalty.shared.getRewardHistory { result in
   switch result {
   case .success(let rewardHistory):
       // Display the reward history to the user
       for reward in rewardHistory {
           print("Reward name: \(reward.name)")
       }
   case .failure(let error):
       print("Error retrieving reward history: \(error.localizedDescription)")
   }
}

Credits

This project is maintained and funded by Nimble.

License

[LICENSE]: /LICENSE

Package Metadata

Repository: nimblehq/business-loyalty-ios-sdk-poc

Default branch: main

README: README.md