docs/CreateAchievement.md in talon_one-6.0.0 vs docs/CreateAchievement.md in talon_one-7.0.0
- old
+ new
@@ -8,10 +8,14 @@
**title** | **String** | The display name for the achievement in the Campaign Manager. |
**description** | **String** | A description of the achievement. |
**target** | **Float** | The required number of actions or the transactional milestone to complete the achievement. |
**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. |
**period_end_override** | [**TimePoint**](TimePoint.md) | | [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
```ruby
require 'TalonOne'
@@ -19,9 +23,13 @@
instance = TalonOne::CreateAchievement.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)
+ period_end_override: null,
+ recurrence_policy: no_recurrence,
+ activation_policy: fixed_schedule,
+ fixed_start_date: null,
+ end_date: null)
```