AchievementProgressWithDefinition.md

AchievementProgressWithDefinition

Properties

Name	Type	Description	Notes
status	str	The status of the achievement.
progress	float	The current progress of the customer in the achievement.
start_date	datetime	Timestamp at which the customer started the achievement.	[optional]
completion_date	datetime	Timestamp at which point the customer completed the achievement.	[optional]
end_date	datetime	Timestamp at which point the achievement ends and resets for the customer.	[optional]
achievement_id	int	The internal ID of the achievement.
name	str	The internal name of the achievement used in API requests.
title	str	The display name of the achievement in the Campaign Manager.
description	str	The description of the achievement in the Campaign Manager.
campaign_id	int	The ID of the campaign the achievement belongs to.
target	float	The required number of actions or the transactional milestone to complete the achievement.	[optional]
achievement_recurrence_policy	str	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.
achievement_activation_policy	str	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.
achievement_fixed_start_date	datetime	The achievement's start date when `achievementActivationPolicy` is equal to `fixed_schedule`. Note: It is an RFC3339 timestamp string.	[optional]
achievement_end_date	datetime	The achievement's end date. If defined, customers cannot participate in the achievement after this date. Note: It is an RFC3339 timestamp string.	[optional]
achievement_allow_rollback_after_completion	bool	When `true`, customer progress can be rolled back in completed achievements.	[optional]

Example

from talon_one.models.achievement_progress_with_definition import AchievementProgressWithDefinition

# TODO update the JSON string below
json = "{}"
# create an instance of AchievementProgressWithDefinition from a JSON string
achievement_progress_with_definition_instance = AchievementProgressWithDefinition.from_json(json)
# print the JSON string representation of the object
print(AchievementProgressWithDefinition.to_json())

# convert the object into a dict
achievement_progress_with_definition_dict = achievement_progress_with_definition_instance.to_dict()
# create an instance of AchievementProgressWithDefinition from a dict
achievement_progress_with_definition_from_dict = AchievementProgressWithDefinition.from_dict(achievement_progress_with_definition_dict)

[Back to Model list] [Back to API list] [Back to README]