LoyaltyManagement Namespace
The LoyaltyManagement namespace provides Apex classes and methods to run the Loyalty Management actions.
Use the developer console to invoke these classes and methods. For more information, see Open the Developer Console.
You can also choose to use the classes and methods of the Invocable namespace to call the Loyalty Management invocable actions from Apex.
The following are the classes in the LoyaltyManagement namespace.
-
CdpBasedLoyaltyPromotionInput Class
Use this class to retrieve promotions that are eligible for a member based on the member’s market segment. This class receives the input parameter values for the Data Cloud based Loyalty Promotion action.
-
CdpBasedLoyaltyPromotionInputBuilder Class
Contains methods to build an instance of the
LoyaltyManagement.CdpBasedLoyaltyPromotionInputclass. -
CdpBasedLoyaltyPromotionOutput Class
Represents the promotion records that the member is eligible for based on the member’s Data Cloud market segment.
-
Use this class to change the tier for a given loyalty program member. This class receives the input parameter values for the Change Tier action.
-
Contains methods to build an instance of the
LoyaltyManagement.ChangeTierInputclass. -
Represents the changed tier details for a loyalty program member.
-
Represents the details of points credited to a loyalty program member’s balance.
-
Represents the details of points debited from a loyalty program member’s balance.
-
GetMemberActiveSegmentsInput Class
Use this class to retrieve active Data Cloud market segments that a loyalty program member is part of. This class receives the input parameter values for the Get Member’s Active Segments action.
-
GetMemberActiveSegmentsInputBuilder Class
Contains methods to build an instance of the
LoyaltyManagement.GetMemberActiveSegmentsInputclass. -
GetMemberActiveSegmentsOutput Class
Represents the ist of the active segment IDs that the specified loyalty program member is a part of.
-
Use this class to issue a voucher to a loyalty program member. This class receives the input parameter values for the Issue Voucher action.
-
IssueVoucherInputBuilder Class
Contains methods to build an instance of the
LoyaltyManagement.IssueVoucherInputclass. -
Represents the voucher ID issued to a loyalty program member.
-
A class that contains the errors related to the execution of a Loyalty Management action.
-
A class that contains the result returned by a loyalty action.
-
Use this class to retrieve active promotions that are eligible for a transaction journal. The action can process accrual or redemption transactions. This class receives the input parameter values for the Loyalty Promotion action.
-
LoyaltyPromotionInputBuilder Class
Contains methods to build an instance of the
LoyaltyManagement.LoyaltyPromotionInputclass. -
Represents the active promotions based on the specified transaction journal.
-
A class that executes a loyalty action and returns a result. Takes the input classes as input and returns the objects of output classes.
-
Use this class to retrieve loyalty points balance for a given loyalty program member. This class receives the input parameter values for the Get Member Points action.
-
MemberPointBalanceInputBuilder Class
Contains methods to build an instance of the
LoyaltyManagement.MemberPointsBalanceInputclass. -
MemberPointBalanceOutput Class
Represents the loyalty points balance for a specified loyalty program member.
-
Use this class to retrieve the current tier for a specified loyalty program member. This class receives the input parameter values for the Get Member Tier action.
-
Contains methods to build an instance of the
LoyaltyManagement.MemberTierInputclass. -
Represents the tier details for a specified loyalty program member.
-
Use this class to credit loyalty points to a loyalty program member’s balance or debit loyalty points from a loyalty program member’s balance. This class receives the input parameter values for the Credit and Debit point actions.
-
Contains methods to build an instance of the
LoyaltyManagement.PointsInputclass. -
TransferMemberPointsToGroupsInput Class
Use this class to transfer points from an individual member or a corporate member to the member’s associated group. This class receives the input parameter values for the Transfer Member Points To Groups action.
-
TransferMemberPointsToGroupsInputBuilder Class
Contains methods to build an instance of the
LoyaltyManagement.TransferMemberPointsToGroupsInputclass. -
UpdateCumulativeUsageCompletedInput Class
Use this class to update the progress made by a loyalty program member towards attaining a Cumulative type promotion. The action creates a Loyalty Program Member Promotion record if the promotion isn’t associated with the member. This class receives the input parameter values for the Update Cumulative Usage Completed action.
-
UpdateCumulativeUsageCompletedOutput Class
Represents the details of the progress made by a loyalty program member towards attaining a Cumulative type promotion.