Class: GrowsurfRuby::Models::Campaign::CampaignParticipant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/growsurf_ruby/models/campaign/participant.rb

Overview

See Also:

Defined Under Namespace

Classes: Referrer

Instance Attribute 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:, email:, monthly_rank:, monthly_referral_count:, rank:, referral_count:, rewards:, share_url:, all_matching_fraudsters: nil, created_at: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_new: nil, is_winner: nil, last_name: nil, metadata: nil, mobile_instance_id: nil, monthly_referrals: nil, notes: nil, paypal_email_address: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, referred_by: nil, referrer: nil, share_count: nil, unique_impression_count: nil, unread_commissions_count: nil, unread_payouts_count: nil, unsubscribed: nil, vanity_keys: nil) ⇒ Object

Some parameter documentations has been truncated, see GrowsurfRuby::Models::Campaign::CampaignParticipant for more details.

Parameters:

  • id (String)
  • email (String)
  • monthly_rank (Integer)
  • monthly_referral_count (Integer)
  • rank (Integer)
  • referral_count (Integer)
  • rewards (Array<GrowsurfRuby::Models::Campaign::ParticipantReward>)
  • share_url (String)
  • all_matching_fraudsters (Array<Hash{Symbol=>Object}>) (defaults to: nil)
  • created_at (Integer) (defaults to: nil)
  • fingerprint (String, nil) (defaults to: nil)
  • first_name (String, nil) (defaults to: nil)
  • fraud_reason_code (String) (defaults to: nil)
  • fraud_risk_level (Symbol, GrowsurfRuby::Models::Campaign::FraudRiskLevel) (defaults to: nil)
  • impression_count (Integer) (defaults to: nil)
  • invite_count (Integer) (defaults to: nil)
  • ip_address (String, nil) (defaults to: nil)
  • is_new (Boolean) (defaults to: nil)
  • is_winner (Boolean) (defaults to: nil)
  • last_name (String, nil) (defaults to: nil)
  • metadata (Hash{Symbol=>Object}) (defaults to: nil) —

    Shallow custom metadata object.

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

    App-install scoped mobile identifier used for anti-fraud matching when provided

  • monthly_referrals (Array<String>) (defaults to: nil)
  • notes (String, nil) (defaults to: nil)
  • paypal_email_address (String) (defaults to: nil)
  • prev_monthly_rank (Integer) (defaults to: nil)
  • prev_monthly_referral_count (Integer) (defaults to: nil)
  • referrals (Array<String>) (defaults to: nil)
  • referral_source (Symbol, GrowsurfRuby::Models::Campaign::ReferralSource) (defaults to: nil)
  • referral_status (Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus) (defaults to: nil)
  • referred_by (String) (defaults to: nil)
  • referrer (GrowsurfRuby::Models::Campaign::CampaignParticipant::Referrer, nil) (defaults to: nil)
  • share_count (Hash{Symbol=>Integer}) (defaults to: nil)
  • unique_impression_count (Integer) (defaults to: nil)
  • unread_commissions_count (Integer) (defaults to: nil)
  • unread_payouts_count (Integer) (defaults to: nil)
  • unsubscribed (Boolean) (defaults to: nil)
  • vanity_keys (Array<String>) (defaults to: nil) 



# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 217

Instance Attribute Details

#all_matching_fraudsters ⇒ Array<Hash{Symbol=>Object}>?

Returns:

  • (Array<Hash{Symbol=>Object}>, nil) 


51
52
53
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 51

optional :all_matching_fraudsters,
GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Internal::Type::HashOf[GrowsurfRuby::Internal::Type::Unknown]],
api_name: :allMatchingFraudsters

#created_at ⇒ Integer?

Returns:

  • (Integer, nil) 


58
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 58

optional :created_at, Integer, api_name: :createdAt

#email ⇒ String

Returns:

  • (String) 


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

required :email, String

#fingerprint ⇒ String?

Returns:

  • (String, nil) 


63
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 63

optional :fingerprint, String, nil?: true

#first_name ⇒ String?

Returns:

  • (String, nil) 


68
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 68

optional :first_name, String, api_name: :firstName, nil?: true

#fraud_reason_code ⇒ String?

Returns:

  • (String, nil) 


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

optional :fraud_reason_code, String, api_name: :fraudReasonCode

#fraud_risk_level ⇒ Symbol, ...

Returns:



78
79
80
81
82
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 78

optional :fraud_risk_level,
enum: -> {
  GrowsurfRuby::Campaign::FraudRiskLevel
},
api_name: :fraudRiskLevel

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#impression_count ⇒ Integer?

Returns:

  • (Integer, nil) 


87
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 87

optional :impression_count, Integer, api_name: :impressionCount

#invite_count ⇒ Integer?

Returns:

  • (Integer, nil) 


92
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 92

optional :invite_count, Integer, api_name: :inviteCount

#ip_address ⇒ String?

Returns:

  • (String, nil) 


97
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 97

optional :ip_address, String, api_name: :ipAddress, nil?: true

#is_new ⇒ Boolean?

Returns:

  • (Boolean, nil) 


102
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 102

optional :is_new, GrowsurfRuby::Internal::Type::Boolean, api_name: :isNew

#is_winner ⇒ Boolean?

Returns:

  • (Boolean, nil) 


107
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 107

optional :is_winner, GrowsurfRuby::Internal::Type::Boolean, api_name: :isWinner

#last_name ⇒ String?

Returns:

  • (String, nil) 


112
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 112

optional :last_name, String, api_name: :lastName, nil?: true

#metadata ⇒ Hash{Symbol=>Object}?

Shallow custom metadata object.

Returns:

  • (Hash{Symbol=>Object}, nil) 


118
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 118

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

#mobile_instance_id ⇒ String?

App-install scoped mobile identifier used for anti-fraud matching when provided by native mobile apps. Not stored when strict GDPR/CCPA mode is enabled.

Returns:

  • (String, nil) 


125
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 125

optional :mobile_instance_id, String, api_name: :mobileInstanceId, nil?: true

#monthly_rank ⇒ Integer

Returns:

  • (Integer) 


21
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 21

required :monthly_rank, Integer, api_name: :monthlyRank

#monthly_referral_count ⇒ Integer

Returns:

  • (Integer) 


26
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 26

required :monthly_referral_count, Integer, api_name: :monthlyReferralCount

#monthly_referrals ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


130
131
132
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 130

optional :monthly_referrals,
GrowsurfRuby::Internal::Type::ArrayOf[String],
api_name: :monthlyReferrals

#notes ⇒ String?

Returns:

  • (String, nil) 


137
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 137

optional :notes, String, nil?: true

#paypal_email_address ⇒ String?

Returns:

  • (String, nil) 


142
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 142

optional :paypal_email_address, String, api_name: :paypalEmailAddress

#prev_monthly_rank ⇒ Integer?

Returns:

  • (Integer, nil) 


147
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 147

optional :prev_monthly_rank, Integer, api_name: :prevMonthlyRank

#prev_monthly_referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


152
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 152

optional :prev_monthly_referral_count, Integer, api_name: :prevMonthlyReferralCount

#rank ⇒ Integer

Returns:

  • (Integer) 


31
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 31

required :rank, Integer

#referral_count ⇒ Integer

Returns:

  • (Integer) 


36
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 36

required :referral_count, Integer, api_name: :referralCount

#referral_source ⇒ Symbol, ...

Returns:



162
163
164
165
166
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 162

optional :referral_source,
enum: -> {
  GrowsurfRuby::Campaign::ReferralSource
},
api_name: :referralSource

#referral_status ⇒ Symbol, ...

Returns:



171
172
173
174
175
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 171

optional :referral_status,
enum: -> {
  GrowsurfRuby::Campaign::ReferralStatus
},
api_name: :referralStatus

#referrals ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


157
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 157

optional :referrals, GrowsurfRuby::Internal::Type::ArrayOf[String]

#referred_by ⇒ String?

Returns:

  • (String, nil) 


180
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 180

optional :referred_by, String, api_name: :referredBy

#referrer ⇒ GrowsurfRuby::Models::Campaign::CampaignParticipant::Referrer?

Returns:



185
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 185

optional :referrer, -> { GrowsurfRuby::Campaign::CampaignParticipant::Referrer }, nil?: true

#rewards ⇒ Array<GrowsurfRuby::Models::Campaign::ParticipantReward>

Returns:



41
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 41

required :rewards, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::Campaign::ParticipantReward] }

#share_count ⇒ Hash{Symbol=>Integer}?

Returns:

  • (Hash{Symbol=>Integer}, nil) 


190
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 190

optional :share_count, GrowsurfRuby::Internal::Type::HashOf[Integer], api_name: :shareCount

#share_url ⇒ String

Returns:

  • (String) 


46
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 46

required :share_url, String, api_name: :shareUrl

#unique_impression_count ⇒ Integer?

Returns:

  • (Integer, nil) 


195
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 195

optional :unique_impression_count, Integer, api_name: :uniqueImpressionCount

#unread_commissions_count ⇒ Integer?

Returns:

  • (Integer, nil) 


200
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 200

optional :unread_commissions_count, Integer, api_name: :unreadCommissionsCount

#unread_payouts_count ⇒ Integer?

Returns:

  • (Integer, nil) 


205
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 205

optional :unread_payouts_count, Integer, api_name: :unreadPayoutsCount

#unsubscribed ⇒ Boolean?

Returns:

  • (Boolean, nil) 


210
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 210

optional :unsubscribed, GrowsurfRuby::Internal::Type::Boolean

#vanity_keys ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


215
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 215

optional :vanity_keys, GrowsurfRuby::Internal::Type::ArrayOf[String], api_name: :vanityKeys