Skip to content

Latest commit

 

History

History
316 lines (171 loc) · 11.1 KB

File metadata and controls

316 lines (171 loc) · 11.1 KB

AchievementBase

Properties

Name Type Description Notes
Name Pointer to 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 Pointer to string The display name for the achievement in the Campaign Manager. [optional]
Description Pointer to string A description of the achievement. [optional]
Target Pointer to float32 The required number of actions or the transactional milestone to complete the achievement. [optional]
Period Pointer to 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]
PeriodEndOverride Pointer to TimePoint [optional]
RecurrencePolicy Pointer to 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. - `on_completion`: When the customer progress status reaches `completed`, the achievement resets and becomes available again. [optional]
ActivationPolicy Pointer to 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]
FixedStartDate Pointer to time.Time The achievement's start date when `activationPolicy` is set to `fixed_schedule`. Note: It must be an RFC3339 timestamp string. [optional]
EndDate Pointer to time.Time 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]
AllowRollbackAfterCompletion Pointer to bool When `true`, customer progress can be rolled back in completed achievements. [optional]

Methods

NewAchievementBase

func NewAchievementBase() *AchievementBase

NewAchievementBase instantiates a new AchievementBase object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewAchievementBaseWithDefaults

func NewAchievementBaseWithDefaults() *AchievementBase

NewAchievementBaseWithDefaults instantiates a new AchievementBase object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetName

func (o *AchievementBase) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *AchievementBase) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *AchievementBase) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *AchievementBase) HasName() bool

HasName returns a boolean if a field has been set.

GetTitle

func (o *AchievementBase) GetTitle() string

GetTitle returns the Title field if non-nil, zero value otherwise.

GetTitleOk

func (o *AchievementBase) GetTitleOk() (*string, bool)

GetTitleOk returns a tuple with the Title field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTitle

func (o *AchievementBase) SetTitle(v string)

SetTitle sets Title field to given value.

HasTitle

func (o *AchievementBase) HasTitle() bool

HasTitle returns a boolean if a field has been set.

GetDescription

func (o *AchievementBase) GetDescription() string

GetDescription returns the Description field if non-nil, zero value otherwise.

GetDescriptionOk

func (o *AchievementBase) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDescription

func (o *AchievementBase) SetDescription(v string)

SetDescription sets Description field to given value.

HasDescription

func (o *AchievementBase) HasDescription() bool

HasDescription returns a boolean if a field has been set.

GetTarget

func (o *AchievementBase) GetTarget() float32

GetTarget returns the Target field if non-nil, zero value otherwise.

GetTargetOk

func (o *AchievementBase) GetTargetOk() (*float32, bool)

GetTargetOk returns a tuple with the Target field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTarget

func (o *AchievementBase) SetTarget(v float32)

SetTarget sets Target field to given value.

HasTarget

func (o *AchievementBase) HasTarget() bool

HasTarget returns a boolean if a field has been set.

GetPeriod

func (o *AchievementBase) GetPeriod() string

GetPeriod returns the Period field if non-nil, zero value otherwise.

GetPeriodOk

func (o *AchievementBase) GetPeriodOk() (*string, bool)

GetPeriodOk returns a tuple with the Period field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPeriod

func (o *AchievementBase) SetPeriod(v string)

SetPeriod sets Period field to given value.

HasPeriod

func (o *AchievementBase) HasPeriod() bool

HasPeriod returns a boolean if a field has been set.

GetPeriodEndOverride

func (o *AchievementBase) GetPeriodEndOverride() TimePoint

GetPeriodEndOverride returns the PeriodEndOverride field if non-nil, zero value otherwise.

GetPeriodEndOverrideOk

func (o *AchievementBase) GetPeriodEndOverrideOk() (*TimePoint, bool)

GetPeriodEndOverrideOk returns a tuple with the PeriodEndOverride field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPeriodEndOverride

func (o *AchievementBase) SetPeriodEndOverride(v TimePoint)

SetPeriodEndOverride sets PeriodEndOverride field to given value.

HasPeriodEndOverride

func (o *AchievementBase) HasPeriodEndOverride() bool

HasPeriodEndOverride returns a boolean if a field has been set.

GetRecurrencePolicy

func (o *AchievementBase) GetRecurrencePolicy() string

GetRecurrencePolicy returns the RecurrencePolicy field if non-nil, zero value otherwise.

GetRecurrencePolicyOk

func (o *AchievementBase) GetRecurrencePolicyOk() (*string, bool)

GetRecurrencePolicyOk returns a tuple with the RecurrencePolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRecurrencePolicy

func (o *AchievementBase) SetRecurrencePolicy(v string)

SetRecurrencePolicy sets RecurrencePolicy field to given value.

HasRecurrencePolicy

func (o *AchievementBase) HasRecurrencePolicy() bool

HasRecurrencePolicy returns a boolean if a field has been set.

GetActivationPolicy

func (o *AchievementBase) GetActivationPolicy() string

GetActivationPolicy returns the ActivationPolicy field if non-nil, zero value otherwise.

GetActivationPolicyOk

func (o *AchievementBase) GetActivationPolicyOk() (*string, bool)

GetActivationPolicyOk returns a tuple with the ActivationPolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetActivationPolicy

func (o *AchievementBase) SetActivationPolicy(v string)

SetActivationPolicy sets ActivationPolicy field to given value.

HasActivationPolicy

func (o *AchievementBase) HasActivationPolicy() bool

HasActivationPolicy returns a boolean if a field has been set.

GetFixedStartDate

func (o *AchievementBase) GetFixedStartDate() time.Time

GetFixedStartDate returns the FixedStartDate field if non-nil, zero value otherwise.

GetFixedStartDateOk

func (o *AchievementBase) GetFixedStartDateOk() (*time.Time, bool)

GetFixedStartDateOk returns a tuple with the FixedStartDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFixedStartDate

func (o *AchievementBase) SetFixedStartDate(v time.Time)

SetFixedStartDate sets FixedStartDate field to given value.

HasFixedStartDate

func (o *AchievementBase) HasFixedStartDate() bool

HasFixedStartDate returns a boolean if a field has been set.

GetEndDate

func (o *AchievementBase) GetEndDate() time.Time

GetEndDate returns the EndDate field if non-nil, zero value otherwise.

GetEndDateOk

func (o *AchievementBase) GetEndDateOk() (*time.Time, bool)

GetEndDateOk returns a tuple with the EndDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEndDate

func (o *AchievementBase) SetEndDate(v time.Time)

SetEndDate sets EndDate field to given value.

HasEndDate

func (o *AchievementBase) HasEndDate() bool

HasEndDate returns a boolean if a field has been set.

GetAllowRollbackAfterCompletion

func (o *AchievementBase) GetAllowRollbackAfterCompletion() bool

GetAllowRollbackAfterCompletion returns the AllowRollbackAfterCompletion field if non-nil, zero value otherwise.

GetAllowRollbackAfterCompletionOk

func (o *AchievementBase) GetAllowRollbackAfterCompletionOk() (*bool, bool)

GetAllowRollbackAfterCompletionOk returns a tuple with the AllowRollbackAfterCompletion field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAllowRollbackAfterCompletion

func (o *AchievementBase) SetAllowRollbackAfterCompletion(v bool)

SetAllowRollbackAfterCompletion sets AllowRollbackAfterCompletion field to given value.

HasAllowRollbackAfterCompletion

func (o *AchievementBase) HasAllowRollbackAfterCompletion() bool

HasAllowRollbackAfterCompletion returns a boolean if a field has been set.

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