Personalisation Client API Changelog

New endpoint to get a paged response of point periods for a member.

New endpoint to get a list of transactions for an order across all programs

New endpoint to get a list of all the memberships a customer has

Added list of current rewards to the response from /v1/current-level-summaries. When capping is reached, capping reward is returned.

Added endpoint for getting the reward ladder for membership a personalisation program. The reward ladder is a list of levels that the given member can achieve in the program, including details about rewards and requirements for each level.

Added CappingStatus to PointDefinitionStatus in CurrentLevelSummary. The field is null if the point definition does not have any capping, and otherwise contains information if the customer has reached the capping limit or not, and what the capping limit is.

Update Transaction amount to be decimal to better support money_spent being decimals than rounded up

Added travel info the travel legs to SingleTravellerEntitlementsQuery and TravellerEntitlementsQuery. Used for limiting possible rewards based on the travel info.

Moved transaction endpoints to be scoped under the member resource.

Added memberId to CurrentLevelSummary. Can be used to look up more information about the member in the program.

Added validFrom on Transaction. This field indicates when the transaction starts to be valid.

Added programReference to CurrentLevelSummary.programReference can be used to match with a specific program (for example programReference == "my_program").It is better than using programId, since the programId might not be the same in different environments (staging/prod).

Added infoLink to Program. A string, for instance an URL, for reading more information about the program.

Added endpoint to manually trigger effects. Up until now, effects could only be triggered based on Kafka events. This version adds a new API endpoint for manually triggering effects.A typical usage of this could be to manually enroll users into a program.

Added reference to PointDefinition. This reference is unique to the point definition in the program and enables clients to identify the point definition semantically,in order to augment the presentation of the point with their own data, such as an icon or more descriptive text.The reference is also included as part of the CurrentLevelSummary, in pointDefinitionStatuses, as a new field pointDefinitionReference.pointDefinitionStatuses also also been extended to always return all point definitions in the program, even if the member has no points of it.

Added suspensionStatuses to CurrentLevelSummary. Contains information about the currently active suspensions for the member

Added referenceId to Transaction. A unique id that points back to the event that created the transaction.

Added SuspensionPeriod as a new resource under member. Returns when the member is suspended from for example getting points, or discounts

Removed "programId" from Member and Transaction. The programId is already known from the path.