LoyaltyAPIManager

Define Authentication

Create an instance of ForceAuthenticator for authentication by using this resource and signature.

auth

public var auth: ForceAuthenticator

Create a Loyalty Program Name

Create a loyalty program name variable by using this resource and signature.

loyaltyProgramName

public var loyaltyProgramName: String

Create an Instance URL

Provide the base URL of the loyalty program API by using this resource and signature. Base URL is the root address of your Salesforce instance. For example, if the URL in your browser’s address bar is https://na35.salesforce.com/home/home.jsp, your base URL is https://na35.salesforce.com.

instanceURL

public var instanceURL: String

Initialize the LoyaltyAPIManager Class

Initialize a LoyaltyAPIManager that contains the necessary parameters such as auth, loyalty program name, instance URL, and forceclient by using this resource and signature.

init(auth:loyaltyProgramName:instanceURL:forceClient:)

public init(auth: ForceAuthenticator, loyaltyProgramName: String, instanceURL: String, forceClient: ForceClient)

Sort Requests

Sort the requests by a specific field by using this resource and signature.

SortBy

public init(auth: ForceAuthenticator, loyaltyProgramName: String, instanceURL: String, forceClient: ForceClient)

Use the parameters in this table to create a sort request.

Sort Results

Specify if you want to view the sort results in ascending or descending order by using this resource and signature.

public enum SortOrder : String

Use the parameters in this table to create a sort order request.

Define Voucher Status

Define the possible statuses of a voucher by using this resource and signature.

VoucherStatus

public enum VoucherStatus : String

Use the parameters in this table to define the voucher statuses.

Identify Resource Type

Identify the type of resource to request by using this resource and signature. Use these resources to create secure and scalable mobile applications.

Resource

public enum Resource

Use the methods in this table to get resources for a loyalty program.

individualEnrollment(programName:version:)

Get API Resource Path

Get the path for the API resource by using this resource and signature. The function uses a resource parameter as input and returns the URL path of the resource as a string.

getPath(for:)

public func getPath(for resource: Resource) -> String

Get Member Benefits

Retrieve the benefits associated with a loyalty program member for the specified API version, while asynchronously requesting data from the Member Benefits API. Use this resource and signature to get member benefits.

getMemberBenefits(for:version:devMode:)

public func getMemberBenefits(
    for memberId: String,
    version: String = LoyaltyAPIVersion.defaultVersion,
    devMode: Bool = false) async throws -> [BenefitModel]

The getMemberBenefits method takes three parameters: memberId, which represents the unique identifier of the member whose benefits are being retrieved, version, which represents the API version, and the devMode parameter, which determines if the request is run in developer mode.

Get Member Profile

Get the profile details of a loyalty program member, while asynchronously requesting data from the Member Profile API. Use this resource and signature to get member profile details.

getMemberProfile(for:version:devMode:)

public func getMemberProfile(
    for memberId: String,
    version: String = LoyaltyAPIVersion.defaultVersion,
    devMode: Bool = false) async throws -> ProfileModel

The getMemberProfile method takes three parameters:memberId , which represents the unique identifier of the member whose profile is being retrieved, version, which represents the API version, and the devMode parameter, which determines if the request is run in developer mode.

Get Community Member Profile

Retrieve the Experience Cloud user profile associated with a loyalty program member for the specified API version, while asynchronously requesting data from Salesforce. Use this resource and signature to get the Experience Cloud user profile details.

getCommunityMemberProfile(version:devMode:)

public func getCommunityMemberProfile(
    version: String = LoyaltyAPIVersion.defaultVersion,
    devMode: Bool = false) async throws -> ProfileModel

The getCommunityMemberProfile method takes two parameters: version, which represents the default version of the mobile SDK, and the devMode parameter, which determines if the request is run in developer mode.

Enroll a Member

Enroll a member to a loyalty program, while asynchronously sending data to the Individual Member Enrollments API. Use this resource and signature to enroll a member.

postEnrollment(membershipNumber:firstName:lastName:email:phone:emailNotification:version:)

public func postEnrollment(
    membershipNumber: String,
    firstName: String,
    lastName: String,
    email: String, phone: String,
    emailNotification: Bool,
    version: String = LoyaltyAPIVersion.defaultVersion) async throws -> EnrollmentOutputModel

This table shows the parameters in the method.

After the enrollment, the request returns the membership number and program member ID.

Opt In For a Promotion

Enroll a loyalty member to a promotion, while asynchronously sending data to the Enroll for Promotions API. Use this resource and signature to enroll a member.

enrollIn(promotion:for:version:)

public func enrollIn(
    promotion promotionName: String,
    for membershipNumber: String,
    version: String = LoyaltyAPIVersion.defaultVersion) async throws

The enrollIn method takes three parameters:promotionName , which represents the promotion name the member is being enrolled to, membershipNumber, which represents the membership number of the member being enrolled, and version, which represents the API version

Use Promotion ID to Opt Out of a Promotion

Opt out a loyalty member from a promotion by using the promotion ID. Use this resource and signature to opt out of a promotion.

unenroll(promotionId:for:version:devMode:)

public final func unenroll(
       promotionId: String,
       for membershipNumber: String,
       version: String = LoyaltyAPIVersion.defaultVersion,
       devMode: Bool = false) async throws

The unenroll method takes two parameters: promotionID, which represents the promotion ID from which the member is being unenrolled, membershipNumber, which represents the membership number of the member being unenrolled, and version, which represents the API version.

Use Promotion Name to Opt Out of a Promotion

Opt out a loyalty member from a promotion by using the promotion name. Use this resource and signature to opt out of a promotion.

unenroll(promotionName:for:version:devMode:)

public final func unenroll(
       promotionName: String,
       for membershipNumber: String,
       version: String = LoyaltyAPIVersion.defaultVersion,
       devMode: Bool = false) async throws

This table shows the parameters in the unenroll method.

Use Member ID to Get Enrolled Promotions

Get the promotions that the member is enrolled to, by using the loyalty program member ID while asynchronously requesting data from the Enroll for Promotions API. Use this resource and signature to get the enrolled promotions.

getPromotions(memberId:version:devMode:)

public func getPromotions(
    memberId: String,
    version: String = LoyaltyAPIVersion.defaultVersion,
    devMode: Bool = false) async throws -> PromotionModel

The getPromotions method takes three parameters: memberID, which represents the unique identifier of the member whose promotions are being retrieved, version, which represents the default API version, and devMode, which determines if the request is run in developer mode.

Use Membership Number to Get Enrolled Promotions

Get the promotions that the member is enrolled to, by using the loyalty program membership number while asynchronously requesting data from the Enroll for Promotions API. Use this resource and signature to get the enrolled promotions.

getPromotions(membershipNumber:version:devMode:)

public func getPromotions(
    membershipNumber: String,
    version: String = LoyaltyAPIVersion.defaultVersion,
    devMode: Bool = false) async throws -> PromotionModel

The getPromotions method takes three parameters: membershipNumber, which represents the membership number of the member whose promotions are being retrieved, version, which represents the default API version, and devMode, which determines if the request is run in developer mode.

Get Transaction Journals

Get transaction journals of a loyalty member. Obtain either accrual or redemption transaction journal records. Use this resource and signature to get transactions.

getTransactions(for:pageNumber:journalTypeName:journalSubTypeName:periodStartDate:periodEndDate:version:devMode:)

public func getTransactions(
    for membershipNumber: String,
    pageNumber: Int? = nil,
    journalTypeName: String? = nil,
    journalSubTypeName: String? = nil,
    periodStartDate: String? = nil,
    periodEndDate: String? = nil,
    version: String = LoyaltyAPIVersion.defaultVersion,
    devMode: Bool = false) async throws -> [TransactionJournal]

The getTransactions method takes the pageNumber parameter that represents the number of the page you want returned. If you don’t specify a value, the first page is returned. Each page contains 200 transaction journals and the transaction journals are sorted based on the activity date.

Get Vouchers

Retrieve the vouchers issued to a loyalty member by using this resource and signature.

getVouchers(membershipNumber:voucherStatus:pageNumber:productId:productCategoryId:productName:productCategoryName:sortBy:sortOrder:version:devMode:)

public func getVouchers(
       membershipNumber: String,
       voucherStatus: [VoucherStatus]? = nil,
       pageNumber: Int? = nil,
       productId: [String]? = nil,
       productCategoryId: [String]? = nil,
       productName: [String]? = nil,
       productCategoryName: [String]? = nil,
       sortBy: SortBy? = nil,
       sortOrder: SortOrder? = nil,
       version: String = LoyaltyAPIVersion.defaultVersion,
       devMode: Bool = false) async throws -> [VoucherModel]

This table shows the parameters in the getVouchers method.