| Name | Type | Description | Notes |
|---|---|---|---|
| Id | Pointer to int64 | The ID of loyalty program. | |
| Created | Pointer to time.Time | The time this entity was created. | |
| Title | Pointer to string | The display title for the Loyalty Program. | |
| Description | Pointer to string | Description of our Loyalty Program. | |
| SubscribedApplications | Pointer to []int64 | A list containing the IDs of all applications that are subscribed to this Loyalty Program. | |
| DefaultValidity | Pointer to string | The default duration after which new loyalty points should expire. Can be 'unlimited' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | |
| DefaultPending | Pointer to string | The default duration of the pending time after which points should be valid. Accepted values: 'immediate', 'on_action' or a specific time. The time format is a number followed by one letter indicating the time unit, like '30s', '40m', '1h', '5D', '7W', or 10M'. These rounding suffixes are also supported: - '_D' for rounding down. Can be used as a suffix after 'D', and signifies the start of the day. - '_U' for rounding up. Can be used as a suffix after 'D', 'W', and 'M', and signifies the end of the day, week, and month. | |
| AllowSubledger | Pointer to bool | Indicates if this program supports subledgers inside the program. | |
| UsersPerCardLimit | Pointer to int64 | The max amount of user profiles with whom a card can be shared. This can be set to 0 for no limit. This property is only used when `cardBased` is `true`. | [optional] |
| Sandbox | Pointer to bool | Indicates if this program is a live or sandbox program. Programs of a given type can only be connected to Applications of the same type. | |
| ProgramJoinPolicy | Pointer to string | The policy that defines when the customer joins the loyalty program. - `not_join`: The customer does not join the loyalty program but can still earn and spend loyalty points. Note: The customer does not have a program join date. - `points_activated`: The customer joins the loyalty program only when their earned loyalty points become active for the first time. - `points_earned`: The customer joins the loyalty program when they earn loyalty points for the first time. | [optional] |
| TiersExpirationPolicy | Pointer to string | The policy that defines how tier expiration, used to reevaluate the customer's current tier, is determined. - `tier_start_date`: The tier expiration is relative to when the customer joined the current tier. - `program_join_date`: The tier expiration is relative to when the customer joined the loyalty program. - `customer_attribute`: The tier expiration is determined by a custom customer attribute. - `absolute_expiration`: The tier is reevaluated at the start of each tier cycle. For this policy, it is required to provide a `tierCycleStartDate`. | [optional] |
| TierCycleStartDate | Pointer to time.Time | Timestamp at which the tier cycle starts for all customers in the loyalty program. Note: This is only required when the tier expiration policy is set to `absolute_expiration`. | [optional] |
| TiersExpireIn | Pointer to string | The amount of time after which the tier expires and is reevaluated. The time format is an integer 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 round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. | [optional] |
| TiersDowngradePolicy | Pointer to string | The policy that defines how customer tiers are downgraded in the loyalty program after tier reevaluation. - `one_down`: If the customer doesn't have enough points to stay in the current tier, they are downgraded by one tier. - `balance_based`: The customer's tier is reevaluated based on the amount of active points they have at the moment. | [optional] |
| CardCodeSettings | Pointer to CodeGeneratorSettings | [optional] | |
| ReturnPolicy | Pointer to string | The policy that defines the rollback of points in case of a partially returned, cancelled, or reopened customer session. - `only_pending`: Only pending points can be rolled back. - `within_balance`: Available active points can be rolled back if there aren't enough pending points. The active balance of the customer cannot be negative. - `unlimited`: Allows negative balance without any limit. | [optional] |
| AccountID | Pointer to int64 | The ID of the Talon.One account that owns this program. | |
| Name | Pointer to string | The internal name for the Loyalty Program. This is an immutable value. | |
| Tiers | Pointer to []LoyaltyTier | The tiers in this loyalty program. | [optional] |
| Timezone | Pointer to string | A string containing an IANA timezone descriptor. | |
| CardBased | Pointer to bool | Defines the type of loyalty program: - `true`: the program is a card-based. - `false`: the program is profile-based. | [default to false] |
| CanUpdateTiers | Pointer to bool | `True` if the tier definitions can be updated. | [optional] [default to false] |
| CanUpdateJoinPolicy | Pointer to bool | `True` if the program join policy can be updated. | [optional] |
| CanUpdateTierExpirationPolicy | Pointer to bool | `True` if the tier expiration policy can be updated. | [optional] |
| CanUpgradeToAdvancedTiers | Pointer to bool | `True` if the program can be upgraded to use the `tiersExpireIn` and `tiersDowngradePolicy` properties. | [optional] [default to false] |
| CanUpdateSubledgers | Pointer to bool | `True` if the `allowSubledger` property can be updated in the loyalty program. | [optional] [default to false] |
func NewLoyaltyProgram(id int64, created time.Time, title string, description string, subscribedApplications []int64, defaultValidity string, defaultPending string, allowSubledger bool, sandbox bool, accountID int64, name string, timezone string, cardBased bool, ) *LoyaltyProgram
NewLoyaltyProgram instantiates a new LoyaltyProgram 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
func NewLoyaltyProgramWithDefaults() *LoyaltyProgram
NewLoyaltyProgramWithDefaults instantiates a new LoyaltyProgram 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
func (o *LoyaltyProgram) GetId() int64
GetId returns the Id field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetIdOk() (*int64, bool)
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetId(v int64)
SetId sets Id field to given value.
func (o *LoyaltyProgram) GetCreated() time.Time
GetCreated returns the Created field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCreatedOk() (*time.Time, bool)
GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCreated(v time.Time)
SetCreated sets Created field to given value.
func (o *LoyaltyProgram) GetTitle() string
GetTitle returns the Title field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) 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.
func (o *LoyaltyProgram) SetTitle(v string)
SetTitle sets Title field to given value.
func (o *LoyaltyProgram) GetDescription() string
GetDescription returns the Description field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) 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.
func (o *LoyaltyProgram) SetDescription(v string)
SetDescription sets Description field to given value.
func (o *LoyaltyProgram) GetSubscribedApplications() []int64
GetSubscribedApplications returns the SubscribedApplications field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetSubscribedApplicationsOk() (*[]int64, bool)
GetSubscribedApplicationsOk returns a tuple with the SubscribedApplications field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetSubscribedApplications(v []int64)
SetSubscribedApplications sets SubscribedApplications field to given value.
func (o *LoyaltyProgram) GetDefaultValidity() string
GetDefaultValidity returns the DefaultValidity field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetDefaultValidityOk() (*string, bool)
GetDefaultValidityOk returns a tuple with the DefaultValidity field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetDefaultValidity(v string)
SetDefaultValidity sets DefaultValidity field to given value.
func (o *LoyaltyProgram) GetDefaultPending() string
GetDefaultPending returns the DefaultPending field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetDefaultPendingOk() (*string, bool)
GetDefaultPendingOk returns a tuple with the DefaultPending field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetDefaultPending(v string)
SetDefaultPending sets DefaultPending field to given value.
func (o *LoyaltyProgram) GetAllowSubledger() bool
GetAllowSubledger returns the AllowSubledger field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetAllowSubledgerOk() (*bool, bool)
GetAllowSubledgerOk returns a tuple with the AllowSubledger field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetAllowSubledger(v bool)
SetAllowSubledger sets AllowSubledger field to given value.
func (o *LoyaltyProgram) GetUsersPerCardLimit() int64
GetUsersPerCardLimit returns the UsersPerCardLimit field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetUsersPerCardLimitOk() (*int64, bool)
GetUsersPerCardLimitOk returns a tuple with the UsersPerCardLimit field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetUsersPerCardLimit(v int64)
SetUsersPerCardLimit sets UsersPerCardLimit field to given value.
func (o *LoyaltyProgram) HasUsersPerCardLimit() bool
HasUsersPerCardLimit returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetSandbox() bool
GetSandbox returns the Sandbox field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetSandboxOk() (*bool, bool)
GetSandboxOk returns a tuple with the Sandbox field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetSandbox(v bool)
SetSandbox sets Sandbox field to given value.
func (o *LoyaltyProgram) GetProgramJoinPolicy() string
GetProgramJoinPolicy returns the ProgramJoinPolicy field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetProgramJoinPolicyOk() (*string, bool)
GetProgramJoinPolicyOk returns a tuple with the ProgramJoinPolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetProgramJoinPolicy(v string)
SetProgramJoinPolicy sets ProgramJoinPolicy field to given value.
func (o *LoyaltyProgram) HasProgramJoinPolicy() bool
HasProgramJoinPolicy returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetTiersExpirationPolicy() string
GetTiersExpirationPolicy returns the TiersExpirationPolicy field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetTiersExpirationPolicyOk() (*string, bool)
GetTiersExpirationPolicyOk returns a tuple with the TiersExpirationPolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetTiersExpirationPolicy(v string)
SetTiersExpirationPolicy sets TiersExpirationPolicy field to given value.
func (o *LoyaltyProgram) HasTiersExpirationPolicy() bool
HasTiersExpirationPolicy returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetTierCycleStartDate() time.Time
GetTierCycleStartDate returns the TierCycleStartDate field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetTierCycleStartDateOk() (*time.Time, bool)
GetTierCycleStartDateOk returns a tuple with the TierCycleStartDate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetTierCycleStartDate(v time.Time)
SetTierCycleStartDate sets TierCycleStartDate field to given value.
func (o *LoyaltyProgram) HasTierCycleStartDate() bool
HasTierCycleStartDate returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetTiersExpireIn() string
GetTiersExpireIn returns the TiersExpireIn field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetTiersExpireInOk() (*string, bool)
GetTiersExpireInOk returns a tuple with the TiersExpireIn field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetTiersExpireIn(v string)
SetTiersExpireIn sets TiersExpireIn field to given value.
func (o *LoyaltyProgram) HasTiersExpireIn() bool
HasTiersExpireIn returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetTiersDowngradePolicy() string
GetTiersDowngradePolicy returns the TiersDowngradePolicy field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetTiersDowngradePolicyOk() (*string, bool)
GetTiersDowngradePolicyOk returns a tuple with the TiersDowngradePolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetTiersDowngradePolicy(v string)
SetTiersDowngradePolicy sets TiersDowngradePolicy field to given value.
func (o *LoyaltyProgram) HasTiersDowngradePolicy() bool
HasTiersDowngradePolicy returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetCardCodeSettings() CodeGeneratorSettings
GetCardCodeSettings returns the CardCodeSettings field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCardCodeSettingsOk() (*CodeGeneratorSettings, bool)
GetCardCodeSettingsOk returns a tuple with the CardCodeSettings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCardCodeSettings(v CodeGeneratorSettings)
SetCardCodeSettings sets CardCodeSettings field to given value.
func (o *LoyaltyProgram) HasCardCodeSettings() bool
HasCardCodeSettings returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetReturnPolicy() string
GetReturnPolicy returns the ReturnPolicy field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetReturnPolicyOk() (*string, bool)
GetReturnPolicyOk returns a tuple with the ReturnPolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetReturnPolicy(v string)
SetReturnPolicy sets ReturnPolicy field to given value.
func (o *LoyaltyProgram) HasReturnPolicy() bool
HasReturnPolicy returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetAccountID() int64
GetAccountID returns the AccountID field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetAccountIDOk() (*int64, bool)
GetAccountIDOk returns a tuple with the AccountID field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetAccountID(v int64)
SetAccountID sets AccountID field to given value.
func (o *LoyaltyProgram) GetName() string
GetName returns the Name field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) 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.
func (o *LoyaltyProgram) SetName(v string)
SetName sets Name field to given value.
func (o *LoyaltyProgram) GetTiers() []LoyaltyTier
GetTiers returns the Tiers field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetTiersOk() (*[]LoyaltyTier, bool)
GetTiersOk returns a tuple with the Tiers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetTiers(v []LoyaltyTier)
SetTiers sets Tiers field to given value.
func (o *LoyaltyProgram) HasTiers() bool
HasTiers returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetTimezone() string
GetTimezone returns the Timezone field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetTimezoneOk() (*string, bool)
GetTimezoneOk returns a tuple with the Timezone field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetTimezone(v string)
SetTimezone sets Timezone field to given value.
func (o *LoyaltyProgram) GetCardBased() bool
GetCardBased returns the CardBased field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCardBasedOk() (*bool, bool)
GetCardBasedOk returns a tuple with the CardBased field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCardBased(v bool)
SetCardBased sets CardBased field to given value.
func (o *LoyaltyProgram) GetCanUpdateTiers() bool
GetCanUpdateTiers returns the CanUpdateTiers field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCanUpdateTiersOk() (*bool, bool)
GetCanUpdateTiersOk returns a tuple with the CanUpdateTiers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCanUpdateTiers(v bool)
SetCanUpdateTiers sets CanUpdateTiers field to given value.
func (o *LoyaltyProgram) HasCanUpdateTiers() bool
HasCanUpdateTiers returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetCanUpdateJoinPolicy() bool
GetCanUpdateJoinPolicy returns the CanUpdateJoinPolicy field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCanUpdateJoinPolicyOk() (*bool, bool)
GetCanUpdateJoinPolicyOk returns a tuple with the CanUpdateJoinPolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCanUpdateJoinPolicy(v bool)
SetCanUpdateJoinPolicy sets CanUpdateJoinPolicy field to given value.
func (o *LoyaltyProgram) HasCanUpdateJoinPolicy() bool
HasCanUpdateJoinPolicy returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetCanUpdateTierExpirationPolicy() bool
GetCanUpdateTierExpirationPolicy returns the CanUpdateTierExpirationPolicy field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCanUpdateTierExpirationPolicyOk() (*bool, bool)
GetCanUpdateTierExpirationPolicyOk returns a tuple with the CanUpdateTierExpirationPolicy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCanUpdateTierExpirationPolicy(v bool)
SetCanUpdateTierExpirationPolicy sets CanUpdateTierExpirationPolicy field to given value.
func (o *LoyaltyProgram) HasCanUpdateTierExpirationPolicy() bool
HasCanUpdateTierExpirationPolicy returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetCanUpgradeToAdvancedTiers() bool
GetCanUpgradeToAdvancedTiers returns the CanUpgradeToAdvancedTiers field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCanUpgradeToAdvancedTiersOk() (*bool, bool)
GetCanUpgradeToAdvancedTiersOk returns a tuple with the CanUpgradeToAdvancedTiers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCanUpgradeToAdvancedTiers(v bool)
SetCanUpgradeToAdvancedTiers sets CanUpgradeToAdvancedTiers field to given value.
func (o *LoyaltyProgram) HasCanUpgradeToAdvancedTiers() bool
HasCanUpgradeToAdvancedTiers returns a boolean if a field has been set.
func (o *LoyaltyProgram) GetCanUpdateSubledgers() bool
GetCanUpdateSubledgers returns the CanUpdateSubledgers field if non-nil, zero value otherwise.
func (o *LoyaltyProgram) GetCanUpdateSubledgersOk() (*bool, bool)
GetCanUpdateSubledgersOk returns a tuple with the CanUpdateSubledgers field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *LoyaltyProgram) SetCanUpdateSubledgers(v bool)
SetCanUpdateSubledgers sets CanUpdateSubledgers field to given value.
func (o *LoyaltyProgram) HasCanUpdateSubledgers() bool
HasCanUpdateSubledgers returns a boolean if a field has been set.