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

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

Overview

See Also:

  • GrowsurfRuby::Models::Campaign::CampaignParticipant#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: nil, created_at: nil, email: nil, fingerprint: nil, first_name: nil, fraud_reason_code: nil, fraud_risk_level: nil, impression_count: nil, invite_count: nil, ip_address: nil, is_winner: nil, last_name: nil, metadata: nil, monthly_rank: nil, monthly_referral_count: nil, monthly_referrals: nil, prev_monthly_rank: nil, prev_monthly_referral_count: nil, rank: nil, referral_count: nil, referrals: nil, referral_source: nil, referral_status: nil, share_count: nil, share_url: nil, unique_impression_count: nil, unsubscribed: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: nil)
  • created_at (Integer) (defaults to: nil)
  • email (String) (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_winner (Boolean) (defaults to: nil)
  • last_name (String, nil) (defaults to: nil)
  • metadata (Hash{Symbol=>Object}) (defaults to: nil) —

    Shallow custom metadata object.

  • monthly_rank (Integer) (defaults to: nil)
  • monthly_referral_count (Integer) (defaults to: nil)
  • monthly_referrals (Array<String>) (defaults to: nil)
  • prev_monthly_rank (Integer) (defaults to: nil)
  • prev_monthly_referral_count (Integer) (defaults to: nil)
  • rank (Integer) (defaults to: nil)
  • 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)
  • share_count (Hash{Symbol=>Integer}) (defaults to: nil)
  • share_url (String) (defaults to: nil)
  • unique_impression_count (Integer) (defaults to: nil)
  • unsubscribed (Boolean) (defaults to: nil) 



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

Instance Attribute Details

#created_at ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :created_at, Integer, api_name: :createdAt

#email ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :email, String

#fingerprint ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :fingerprint, String, nil?: true

#first_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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

#fraud_reason_code ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :fraud_reason_code, String, api_name: :fraudReasonCode

#fraud_risk_level ⇒ Symbol, ...

Returns:



408
409
410
411
412
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 408

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

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :id, String

#impression_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :impression_count, Integer, api_name: :impressionCount

#invite_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :invite_count, Integer, api_name: :inviteCount

#ip_address ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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

#is_winner ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

#last_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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

#metadata ⇒ Hash{Symbol=>Object}?

Shallow custom metadata object.

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


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

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

#monthly_rank ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :monthly_rank, Integer, api_name: :monthlyRank

#monthly_referral_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :monthly_referral_count, Integer, api_name: :monthlyReferralCount

#monthly_referrals ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


458
459
460
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 458

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

#prev_monthly_rank ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :prev_monthly_rank, Integer, api_name: :prevMonthlyRank

#prev_monthly_referral_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :prev_monthly_referral_count, Integer, api_name: :prevMonthlyReferralCount

#rank ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :rank, Integer

#referral_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :referral_count, Integer, api_name: :referralCount

#referral_source ⇒ Symbol, ...

Returns:



490
491
492
493
494
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 490

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

#referral_status ⇒ Symbol, ...

Returns:



499
500
501
502
503
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 499

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

#referrals ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

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

#share_count ⇒ Hash{Symbol=>Integer}?

Parameters:

  • (::Hash[Symbol, Integer])

Returns:

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


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

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

#share_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :share_url, String, api_name: :shareUrl

#unique_impression_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :unique_impression_count, Integer, api_name: :uniqueImpressionCount

#unsubscribed ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


487
 
# File 'sig/growsurf_ruby/models/campaign/participant.rbs', line 487

def to_hash: -> {