Class: VitableConnect::Models::MemberRetrieveHouseholdResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/vitable_connect/models/member_retrieve_household_response.rb,
sig/vitable_connect/models/member_retrieve_household_response.rbs

Defined Under Namespace

Modules: MemberType, Relationship

Instance Attribute Summary collapse

Class Method 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(date_of_birth:, first_name:, household_admin_in:, last_name:, member_id:, member_type:, relationship: nil) ⇒ Object

Some parameter documentations has been truncated, see VitableConnect::Models::MemberRetrieveHouseholdResponse::Data for more details.

Wire serializer for :class:HouseholdMemberDTO (one household participant).

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 18

class Data < VitableConnect::Internal::Type::BaseModel
  # @!attribute date_of_birth
  #   Date of birth (YYYY-MM-DD)
  #
  #   @return [Date]
  required :date_of_birth, Date

  # @!attribute first_name
  #   Household member's first name
  #
  #   @return [String]
  required :first_name, String

  # @!attribute household_admin_in
  #   Whether this participant is a household admin (the account holder always is)
  #
  #   @return [Boolean]
  required :household_admin_in, VitableConnect::Internal::Type::Boolean

  # @!attribute last_name
  #   Household member's last name
  #
  #   @return [String]
  required :last_name, String

  # @!attribute member_type
  #   - `Account Holder` - Account Holder
  #   - `Dependent` - Dependent
  #   - `Inactive` - Inactive
  #
  #   @return [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType]
  required :member_type,
           enum: -> { VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType }

  # @!attribute relationship
  #   - `Child` - Child
  #   - `Spouse` - Spouse
  #   - `Roommate` - Roommate
  #   - `Other` - Other
  #
  #   @return [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship, nil]
  optional :relationship,
           enum: -> { VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship },
           nil?: true

  response_only do
    # @!attribute member_id
    #   Member identifier with 'mbr\_' prefix
    #
    #   @return [String]
    required :member_id, String
  end

  # @!method initialize(date_of_birth:, first_name:, household_admin_in:, last_name:, member_id:, member_type:, relationship: nil)
  #   Some parameter documentations has been truncated, see
  #   {VitableConnect::Models::MemberRetrieveHouseholdResponse::Data} for more
  #   details.
  #
  #   Wire serializer for :class:`HouseholdMemberDTO` (one household participant).
  #
  #   @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
  #
  #   @param first_name [String] Household member's first name
  #
  #   @param household_admin_in [Boolean] Whether this participant is a household admin (the account holder always is)
  #
  #   @param last_name [String] Household member's last name
  #
  #   @param member_id [String] Member identifier with 'mbr\_' prefix
  #
  #   @param member_type [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType] - `Account Holder` - Account Holder
  #
  #   @param relationship [Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship, nil] - `Child` - Child

  # - `Account Holder` - Account Holder
  # - `Dependent` - Dependent
  # - `Inactive` - Inactive
  #
  # @see VitableConnect::Models::MemberRetrieveHouseholdResponse::Data#member_type
  module MemberType
    extend VitableConnect::Internal::Type::Enum

    ACCOUNT_HOLDER = :"Account Holder"
    DEPENDENT = :Dependent
    INACTIVE = :Inactive

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # - `Child` - Child
  # - `Spouse` - Spouse
  # - `Roommate` - Roommate
  # - `Other` - Other
  #
  # @see VitableConnect::Models::MemberRetrieveHouseholdResponse::Data#relationship
  module Relationship
    extend VitableConnect::Internal::Type::Enum

    CHILD = :Child
    SPOUSE = :Spouse
    ROOMMATE = :Roommate
    OTHER = :Other

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#date_of_birth ⇒ Date

Date of birth (YYYY-MM-DD)

Parameters:

  • value (Date)

Returns:

  • (Date) 


23
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 23

required :date_of_birth, Date

#first_name ⇒ String

Household member's first name

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 29

required :first_name, String

#household_admin_in ⇒ Boolean

Whether this participant is a household admin (the account holder always is)

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


35
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 35

required :household_admin_in, VitableConnect::Internal::Type::Boolean

#last_name ⇒ String

Household member's last name

Parameters:

  • value (String)

Returns:

  • (String) 


41
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 41

required :last_name, String

#member_id ⇒ String

Returns the value of attribute member_id.

Returns:

  • (String) 


43
44
45
 
# File 'sig/vitable_connect/models/member_retrieve_household_response.rbs', line 43

def member_id
  @member_id
end

#member_type ⇒ Symbol, VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType

  • Account Holder - Account Holder
  • Dependent - Dependent
  • Inactive - Inactive

Parameters:

  • value (VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::member_type)

Returns:



49
50
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 49

required :member_type,
enum: -> { VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::MemberType }

#relationship ⇒ Symbol, ...

  • Child - Child
  • Spouse - Spouse
  • Roommate - Roommate
  • Other - Other

Parameters:

  • value (VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::relationship, nil)

Returns:



59
60
61
 
# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 59

optional :relationship,
enum: -> { VitableConnect::Models::MemberRetrieveHouseholdResponse::Data::Relationship },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/member_retrieve_household_response.rb', line 104

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/vitable_connect/models/member_retrieve_household_response.rbs', line 55

def to_hash: -> {