|
| 1 | + |
| 2 | + |
| 3 | +# AchievementV2 |
| 4 | + |
| 5 | +## Properties |
| 6 | + |
| 7 | +Name | Type | Description | Notes |
| 8 | +------------ | ------------- | ------------- | ------------- |
| 9 | +**id** | **Long** | The internal ID of this entity. | |
| 10 | +**created** | [**OffsetDateTime**](OffsetDateTime.md) | The time this entity was created. | |
| 11 | +**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. | |
| 12 | +**title** | **String** | The display name for the achievement in the Campaign Manager. | |
| 13 | +**description** | **String** | A description of the achievement. | |
| 14 | +**target** | [**BigDecimal**](BigDecimal.md) | The required number of actions or the transactional milestone to complete the achievement. | |
| 15 | +**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] |
| 16 | +**recurrencePolicy** | [**RecurrencePolicyEnum**](#RecurrencePolicyEnum) | 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. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. | |
| 17 | +**activationPolicy** | [**ActivationPolicyEnum**](#ActivationPolicyEnum) | 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. | |
| 18 | +**fixedStartDate** | [**OffsetDateTime**](OffsetDateTime.md) | The achievement's start date when `activationPolicy` is set to `fixed_schedule`. **Note:** It must be an RFC3339 timestamp string. | [optional] |
| 19 | +**endDate** | [**OffsetDateTime**](OffsetDateTime.md) | 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] |
| 20 | +**allowRollbackAfterCompletion** | **Boolean** | When `true`, customer progress can be rolled back in completed achievements. | [optional] |
| 21 | +**sandbox** | **Boolean** | Indicates if this achievement is a live or sandbox achievement. Achievements of a given type can only be connected to Applications of the same type. | |
| 22 | +**subscribedApplications** | **List<Long>** | A list containing the IDs of all applications that are subscribed to A list containing the IDs of all Applications that are connected to this achievement. | |
| 23 | +**timezone** | **String** | A string containing an IANA timezone descriptor. | |
| 24 | +**userId** | **Long** | The ID of the user that created this achievement. | |
| 25 | +**createdBy** | **String** | Name of the user that created the achievement. **Note**: This is not available if the user has been deleted. | [optional] |
| 26 | +**hasProgress** | **Boolean** | Indicates if a customer has made progress in the achievement. | [optional] |
| 27 | +**status** | [**StatusEnum**](#StatusEnum) | The status of the achievement. | [optional] |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | +## Enum: RecurrencePolicyEnum |
| 32 | + |
| 33 | +Name | Value |
| 34 | +---- | ----- |
| 35 | +NO_RECURRENCE | "no_recurrence" |
| 36 | +ON_EXPIRATION | "on_expiration" |
| 37 | +ON_COMPLETION | "on_completion" |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +## Enum: ActivationPolicyEnum |
| 42 | + |
| 43 | +Name | Value |
| 44 | +---- | ----- |
| 45 | +USER_ACTION | "user_action" |
| 46 | +FIXED_SCHEDULE | "fixed_schedule" |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +## Enum: StatusEnum |
| 51 | + |
| 52 | +Name | Value |
| 53 | +---- | ----- |
| 54 | +INPROGRESS | "inprogress" |
| 55 | +EXPIRED | "expired" |
| 56 | +NOT_STARTED | "not_started" |
| 57 | +COMPLETED | "completed" |
| 58 | + |
| 59 | + |
| 60 | + |
0 commit comments