Class: GrowsurfRuby::Models::Campaign::Reward

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/campaign/reward.rb,
sig/growsurf_ruby/models/campaign/reward.rbs

Overview

See Also:

  • GrowsurfRuby::Resources::Campaign::Rewards#create

Defined Under Namespace

Modules: Event, LimitDuration, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_visible: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil) ⇒ Object

Parameters:

  • id (String)
  • is_unlimited (Boolean)
  • metadata (Hash{Symbol=>Object}) —

    Shallow custom metadata object.

  • type (Symbol, GrowsurfRuby::Models::Campaign::Reward::Type)
  • commission_structure (GrowsurfRuby::Models::CommissionStructure, nil) (defaults to: nil)
  • conversions_required (Integer, nil) (defaults to: nil)
  • coupon_code (String, nil) (defaults to: nil) —

    Legacy static coupon code shown to the referrer in the reward-won email and web

  • description (String, nil) (defaults to: nil)
  • event (Symbol, GrowsurfRuby::Models::Campaign::Reward::Event, nil) (defaults to: nil) —

    The referral event that earns this Campaign Reward.

  • image_url (String, nil) (defaults to: nil)
  • is_visible (Boolean) (defaults to: nil) —

    Whether the reward is enabled. When false the reward is disabled: hidden from

  • limit (Integer, nil) (defaults to: nil) —

    -1 represents an unlimited reward in REST responses.

  • limit_duration (Symbol, GrowsurfRuby::Models::Campaign::Reward::LimitDuration, nil) (defaults to: nil)
  • next_milestone_prefix (String, nil) (defaults to: nil) —

    Text shown before a participant's referral count in milestone-progress copy. App

  • next_milestone_suffix (String, nil) (defaults to: nil) —

    Text shown after a participant's referral count in milestone-progress copy. Appl

  • number_of_winners (Integer, nil) (defaults to: nil) —

    The number of winners (LEADERBOARD rewards only). With limitDuration `PER_MO

  • order (Integer, nil) (defaults to: nil)
  • referral_coupon_code (String, nil) (defaults to: nil) —

    Legacy static coupon code shown to the referred friend (double-sided rewards) in

  • referral_description (String, nil) (defaults to: nil)
  • referred_reward_upfront (Boolean) (defaults to: nil)
  • referred_value (GrowsurfRuby::Models::RewardTaxValuation, nil) (defaults to: nil) —

    Tax treatment override for the referred friend's side of a double-sided reward.

  • title (String, nil) (defaults to: nil) —

    The reward title (internal label).

  • value (GrowsurfRuby::Models::RewardTaxValuation, nil) (defaults to: nil) —

    Tax valuation for the reward (the referrer's side of a double-sided reward).




# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 156

Instance Attribute Details

#commission_structure ⇒ GrowsurfRuby::Models::CommissionStructure?

Parameters:

Returns:



32
33
34
35
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 32

optional :commission_structure,
-> { GrowsurfRuby::CommissionStructure },
api_name: :commissionStructure,
nil?: true

#conversions_required ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


40
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 40

optional :conversions_required, Integer, api_name: :conversionsRequired, nil?: true

#coupon_code ⇒ String?

Legacy static coupon code shown to the referrer in the reward-won email and webhook. Display text only; superseded by a connected billing integration's issued coupon when one exists.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


48
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 48

optional :coupon_code, String, api_name: :couponCode, nil?: true

#description ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


53
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 53

optional :description, String, nil?: true

#event ⇒ Symbol, ...

The referral event that earns this Campaign Reward. Present only for SINGLE_SIDED, DOUBLE_SIDED, and MILESTONE rewards. Legacy Campaign Rewards return CONVERSION.

Parameters:

  • value (GrowsurfRuby::Models::Campaign::Reward::event, nil)

Returns:



61
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 61

optional :event, enum: -> { GrowsurfRuby::Campaign::Reward::Event }, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 11

required :id, String

#image_url ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


66
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 66

optional :image_url, String, api_name: :imageUrl, nil?: true

#is_unlimited ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


16
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 16

required :is_unlimited, GrowsurfRuby::Internal::Type::Boolean, api_name: :isUnlimited

#is_visible ⇒ Boolean?

Whether the reward is enabled. When false the reward is disabled: hidden from participants and no longer awarded, including those who already earned it.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


73
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 73

optional :is_visible, GrowsurfRuby::Internal::Type::Boolean, api_name: :isVisible

#limit ⇒ Integer?

-1 represents an unlimited reward in REST responses.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


79
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 79

optional :limit, Integer, nil?: true

#limit_duration ⇒ Symbol, ...

Parameters:

  • value (GrowsurfRuby::Models::Campaign::Reward::limit_duration, nil)

Returns:



84
85
86
87
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 84

optional :limit_duration,
enum: -> { GrowsurfRuby::Campaign::Reward::LimitDuration },
api_name: :limitDuration,
nil?: true

#metadata ⇒ Hash{Symbol=>Object}

Shallow custom metadata object.

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


22
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 22

required :metadata, GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]

#next_milestone_prefix ⇒ String?

Text shown before a participant's referral count in milestone-progress copy. Applies to MILESTONE rewards.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


94
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 94

optional :next_milestone_prefix, String, api_name: :nextMilestonePrefix, nil?: true

#next_milestone_suffix ⇒ String?

Text shown after a participant's referral count in milestone-progress copy. Applies to MILESTONE rewards.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


101
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 101

optional :next_milestone_suffix, String, api_name: :nextMilestoneSuffix, nil?: true

#number_of_winners ⇒ Integer?

The number of winners (LEADERBOARD rewards only). With limitDuration PER_MONTH this many win each month, otherwise this many win in total.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


108
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 108

optional :number_of_winners, Integer, api_name: :numberOfWinners, nil?: true

#order ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


113
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 113

optional :order, Integer, nil?: true

#referral_coupon_code ⇒ String?

Legacy static coupon code shown to the referred friend (double-sided rewards) in the reward-won email and webhook. Display text only; superseded by a connected billing integration's issued coupon when one exists.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


121
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 121

optional :referral_coupon_code, String, api_name: :referralCouponCode, nil?: true

#referral_description ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


126
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 126

optional :referral_description, String, api_name: :referralDescription, nil?: true

#referred_reward_upfront ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


131
132
133
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 131

optional :referred_reward_upfront,
GrowsurfRuby::Internal::Type::Boolean,
api_name: :referredRewardUpfront

#referred_value ⇒ GrowsurfRuby::Models::RewardTaxValuation?

Tax treatment override for the referred friend's side of a double-sided reward.

Parameters:

Returns:



139
140
141
142
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 139

optional :referred_value,
-> { GrowsurfRuby::RewardTaxValuation },
api_name: :referredValue,
nil?: true

#title ⇒ String?

The reward title (internal label).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


148
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 148

optional :title, String, nil?: true

#type ⇒ Symbol, GrowsurfRuby::Models::Campaign::Reward::Type

Parameters:

  • value (GrowsurfRuby::Models::Campaign::Reward::type_)

Returns:



27
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 27

required :type, enum: -> { GrowsurfRuby::Campaign::Reward::Type }

#value ⇒ GrowsurfRuby::Models::RewardTaxValuation?

Tax valuation for the reward (the referrer's side of a double-sided reward).

Parameters:

Returns:



154
 
# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 154

optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/growsurf_ruby/models/campaign/reward.rb', line 213

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


108
 
# File 'sig/growsurf_ruby/models/campaign/reward.rbs', line 108

def to_hash: -> {