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

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

Overview

See Also:

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 437

Instance Attribute Details

#created_at ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :created_at, Integer, api_name: :createdAt

#email ⇒ String?

Returns:

  • (String, nil) 


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

optional :email, String

#fingerprint ⇒ String?

Returns:

  • (String, nil) 


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

optional :fingerprint, String, nil?: true

#first_name ⇒ String?

Returns:

  • (String, nil) 


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

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

#fraud_reason_code ⇒ String?

Returns:

  • (String, nil) 


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

optional :fraud_reason_code, String, api_name: :fraudReasonCode

#fraud_risk_level ⇒ Symbol, ...

Returns:



320
321
322
323
324
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 320

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

#id ⇒ String?

Returns:

  • (String, nil) 


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

optional :id, String

#impression_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :impression_count, Integer, api_name: :impressionCount

#invite_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :invite_count, Integer, api_name: :inviteCount

#ip_address ⇒ String?

Returns:

  • (String, nil) 


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

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

#is_winner ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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

#last_name ⇒ String?

Returns:

  • (String, nil) 


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

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

#metadata ⇒ Hash{Symbol=>Object}?

Shallow custom metadata object.

Returns:

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


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

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

#monthly_rank ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :monthly_rank, Integer, api_name: :monthlyRank

#monthly_referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :monthly_referral_count, Integer, api_name: :monthlyReferralCount

#monthly_referrals ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


370
371
372
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 370

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

#prev_monthly_rank ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :prev_monthly_rank, Integer, api_name: :prevMonthlyRank

#prev_monthly_referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :prev_monthly_referral_count, Integer, api_name: :prevMonthlyReferralCount

#rank ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :rank, Integer

#referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :referral_count, Integer, api_name: :referralCount

#referral_source ⇒ Symbol, ...

Returns:



402
403
404
405
406
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 402

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

#referral_status ⇒ Symbol, ...

Returns:



411
412
413
414
415
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 411

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

#referrals ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#share_count ⇒ Hash{Symbol=>Integer}?

Returns:

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


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

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

#share_url ⇒ String?

Returns:

  • (String, nil) 


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

optional :share_url, String, api_name: :shareUrl

#unique_impression_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :unique_impression_count, Integer, api_name: :uniqueImpressionCount

#unsubscribed ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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