Class: GrowsurfRuby::Models::ReferralList::Referral

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

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:, created_at:, email:, referral_status:, referred_by:, updated_at:, first_name: nil, last_name: nil) ⇒ Object

Parameters:

  • id (String)
  • created_at (Integer)
  • email (String)
  • referral_status (Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus)
  • referred_by (String)
  • updated_at (Integer)
  • first_name (String, nil) (defaults to: nil)
  • last_name (String, nil) (defaults to: nil) 


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 39

class Referral < GrowsurfRuby::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute created_at
  #
  #   @return [Integer]
  required :created_at, Integer, api_name: :createdAt

  # @!attribute email
  #
  #   @return [String]
  required :email, String

  # @!attribute referral_status
  #
  #   @return [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus]
  required :referral_status,
           enum: -> {
             GrowsurfRuby::Campaign::ReferralStatus
           },
           api_name: :referralStatus

  # @!attribute referred_by
  #
  #   @return [String]
  required :referred_by, String, api_name: :referredBy

  # @!attribute updated_at
  #
  #   @return [Integer]
  required :updated_at, Integer, api_name: :updatedAt

  # @!attribute first_name
  #
  #   @return [String, nil]
  optional :first_name, String, api_name: :firstName, nil?: true

  # @!attribute last_name
  #
  #   @return [String, nil]
  optional :last_name, String, api_name: :lastName, nil?: true

  # @!method initialize(id:, created_at:, email:, referral_status:, referred_by:, updated_at:, first_name: nil, last_name: nil)
  #   @param id [String]
  #   @param created_at [Integer]
  #   @param email [String]
  #   @param referral_status [Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus]
  #   @param referred_by [String]
  #   @param updated_at [Integer]
  #   @param first_name [String, nil]
  #   @param last_name [String, nil]
end

Instance Attribute Details

#created_at ⇒ Integer

Returns:

  • (Integer) 


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

required :created_at, Integer, api_name: :createdAt

#email ⇒ String

Returns:

  • (String) 


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

required :email, String

#first_name ⇒ String?

Returns:

  • (String, nil) 


77
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 77

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

#id ⇒ String

Returns:

  • (String) 


43
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 43

required :id, String

#last_name ⇒ String?

Returns:

  • (String, nil) 


82
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 82

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

#referral_status ⇒ Symbol, GrowsurfRuby::Models::Campaign::ReferralStatus

Returns:



58
59
60
61
62
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 58

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

#referred_by ⇒ String

Returns:

  • (String) 


67
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 67

required :referred_by, String, api_name: :referredBy

#updated_at ⇒ Integer

Returns:

  • (Integer) 


72
 
# File 'lib/growsurf_ruby/models/referral_list.rb', line 72

required :updated_at, Integer, api_name: :updatedAt