Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 3.43 KB

AchievementBase.md

File metadata and controls

35 lines (28 loc) · 3.43 KB

TalonOne::AchievementBase

Properties

Name Type Description Notes
name String The internal name of the achievement used in API requests. Note: The name should start with a letter. This cannot be changed after the achievement has been created. [optional]
title String The display name for the achievement in the Campaign Manager. [optional]
description String A description of the achievement. [optional]
target Float The required number of actions or the transactional milestone to complete the achievement. [optional]
period String The relative duration after which the achievement ends and resets for a particular customer profile. Note: The `period` does not start when the achievement is created. The period is a positive real number followed by one letter indicating the time unit. Examples: `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 also round certain units down to the beginning of period and up to the end of period.: - `_D` for rounding down days only. Signifies the start of the day. Example: `30D_D` - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. Example: `23W_U` Note: You can either use the round down and round up option or set an absolute period. [optional]
period_end_override TimePoint [optional]
recurrence_policy String The policy that determines if and how the achievement recurs. - `no_recurrence`: The achievement can be completed only once. - `on_expiration`: The achievement resets after it expires and becomes available again. [optional]
activation_policy String The policy that determines how the achievement starts, ends, or resets. - `user_action`: The achievement ends or resets relative to when the customer started the achievement. - `fixed_schedule`: The achievement starts, ends, or resets for all customers following a fixed schedule. [optional]
fixed_start_date DateTime The achievement's start date when `activationPolicy` is set to `fixed_schedule`. Note: It must be an RFC3339 timestamp string. [optional]
end_date DateTime The achievement's end date. If defined, customers cannot participate in the achievement after this date. Note: It must be an RFC3339 timestamp string. [optional]

Code Sample

require 'TalonOne'

instance = TalonOne::AchievementBase.new(name: Order50Discount,
                                 title: 50% off on 50th purchase.,
                                 description: 50% off for every 50th purchase in a year.,
                                 target: 50.0,
                                 period: 1Y,
                                 period_end_override: null,
                                 recurrence_policy: no_recurrence,
                                 activation_policy: fixed_schedule,
                                 fixed_start_date: null,
                                 end_date: null)