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 449

Instance Attribute Details

#created_at ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :created_at, Integer, api_name: :createdAt

#email ⇒ String?

Returns:

  • (String, nil) 


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

optional :email, String

#fingerprint ⇒ String?

Returns:

  • (String, nil) 


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

optional :fingerprint, String, nil?: true

#first_name ⇒ String?

Returns:

  • (String, nil) 


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

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

#fraud_reason_code ⇒ String?

Returns:

  • (String, nil) 


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

optional :fraud_reason_code, String, api_name: :fraudReasonCode

#fraud_risk_level ⇒ Symbol, ...

Returns:



332
333
334
335
336
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 332

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

#id ⇒ String?

Returns:

  • (String, nil) 


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

optional :id, String

#impression_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :impression_count, Integer, api_name: :impressionCount

#invite_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :invite_count, Integer, api_name: :inviteCount

#ip_address ⇒ String?

Returns:

  • (String, nil) 


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

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

#is_winner ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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

#last_name ⇒ String?

Returns:

  • (String, nil) 


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

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

#metadata ⇒ Hash{Symbol=>Object}?

Shallow custom metadata object.

Returns:

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


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

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

#monthly_rank ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :monthly_rank, Integer, api_name: :monthlyRank

#monthly_referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :monthly_referral_count, Integer, api_name: :monthlyReferralCount

#monthly_referrals ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#prev_monthly_rank ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :prev_monthly_rank, Integer, api_name: :prevMonthlyRank

#prev_monthly_referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :prev_monthly_referral_count, Integer, api_name: :prevMonthlyReferralCount

#rank ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :rank, Integer

#referral_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :referral_count, Integer, api_name: :referralCount

#referral_source ⇒ Symbol, ...

Returns:



414
415
416
417
418
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 414

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

#referral_status ⇒ Symbol, ...

Returns:



423
424
425
426
427
 
# File 'lib/growsurf_ruby/models/campaign/participant.rb', line 423

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

#referrals ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


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

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

#share_count ⇒ Hash{Symbol=>Integer}?

Returns:

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


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

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

#share_url ⇒ String?

Returns:

  • (String, nil) 


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

optional :share_url, String, api_name: :shareUrl

#unique_impression_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :unique_impression_count, Integer, api_name: :uniqueImpressionCount

#unsubscribed ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

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