Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 3.06 KB

AddLoyaltyPoints.md

File metadata and controls

31 lines (24 loc) · 3.06 KB

TalonOne::AddLoyaltyPoints

Properties

Name Type Description Notes
points Float Amount of loyalty points.
name String Name / reason for the point addition. [optional]
validity_duration String The time format is either: - `immediate` or, - an integer followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. If passed, `validUntil` should be omitted. [optional]
valid_until DateTime Date and time when points should expire. The value should be provided in RFC 3339 format. If passed, `validityDuration` should be omitted. [optional]
pending_duration String The amount of time before the points are considered valid. The time format is either: - `immediate` or, - an integer followed by one letter indicating the time unit. Examples: `immediate`, `30s`, `40m`, `1h`, `5D`, `7W`, `10M`, `15Y`. Available units: - `s`: seconds - `m`: minutes - `h`: hours - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. [optional]
pending_until DateTime Date and time after the points are considered valid. The value should be provided in RFC 3339 format. If passed, `pendingDuration` should be omitted. [optional]
subledger_id String ID of the subledger the points are added to. If there is no existing subledger with this ID, the subledger is created automatically. [optional]
application_id Integer ID of the Application that is connected to the loyalty program. It is displayed in your Talon.One deployment URL. [optional]

Code Sample

require 'TalonOne'

instance = TalonOne::AddLoyaltyPoints.new(points: 300.0,
                                 name: Compensation,
                                 validity_duration: 5D,
                                 valid_until: 2021-07-20T22:00Z,
                                 pending_duration: 12h,
                                 pending_until: 2021-07-20T22:00Z,
                                 subledger_id: sub-123,
                                 application_id: 322)