Class: VitableConnect::Models::MemberListDependentsResponse::Data

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

Defined Under Namespace

Modules: Relationship, SexAtBirth

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(age:, date_of_birth:, first_name:, last_name:, member_id:, primary_member_id:, relationship:, sex_at_birth: nil) ⇒ Object

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

Wire serializer for :class:MemberLegalDependentDTO (one legal-dependent row).

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
126
127
128
129
 
# File 'lib/vitable_connect/models/member_list_dependents_response.rb', line 18

class Data < VitableConnect::Internal::Type::BaseModel
  # @!attribute age
  #   Dependent's age in years, derived from date of birth
  #
  #   @return [Integer]
  required :age, Integer

  # @!attribute date_of_birth
  #   Date of birth (YYYY-MM-DD)
  #
  #   @return [Date]
  required :date_of_birth, Date

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

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

  # @!attribute relationship
  #   - `Spouse` - Spouse
  #   - `Child` - Child
  #
  #   @return [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::Relationship]
  required :relationship,
           enum: -> { VitableConnect::Models::MemberListDependentsResponse::Data::Relationship }

  # @!attribute sex_at_birth
  #   - `Male` - Male
  #   - `Female` - Female
  #   - `Other` - Other
  #   - `Unknown` - Unknown
  #
  #   @return [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth, nil]
  optional :sex_at_birth,
           enum: -> { VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth },
           nil?: true

  response_only do
    # @!attribute member_id
    #   The dependent's own member identifier with 'mbr\_' prefix
    #
    #   @return [String]
    required :member_id, String

    # @!attribute primary_member_id
    #   The primary member's identifier with 'mbr\_' prefix
    #
    #   @return [String]
    required :primary_member_id, String
  end

  # @!method initialize(age:, date_of_birth:, first_name:, last_name:, member_id:, primary_member_id:, relationship:, sex_at_birth: nil)
  #   Some parameter documentations has been truncated, see
  #   {VitableConnect::Models::MemberListDependentsResponse::Data} for more details.
  #
  #   Wire serializer for :class:`MemberLegalDependentDTO` (one legal-dependent row).
  #
  #   @param age [Integer] Dependent's age in years, derived from date of birth
  #
  #   @param date_of_birth [Date] Date of birth (YYYY-MM-DD)
  #
  #   @param first_name [String] Dependent's first name
  #
  #   @param last_name [String] Dependent's last name
  #
  #   @param member_id [String] The dependent's own member identifier with 'mbr\_' prefix
  #
  #   @param primary_member_id [String] The primary member's identifier with 'mbr\_' prefix
  #
  #   @param relationship [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::Relationship] - `Spouse` - Spouse
  #
  #   @param sex_at_birth [Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth, nil] - `Male` - Male

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

    SPOUSE = :Spouse
    CHILD = :Child

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

  # - `Male` - Male
  # - `Female` - Female
  # - `Other` - Other
  # - `Unknown` - Unknown
  #
  # @see VitableConnect::Models::MemberListDependentsResponse::Data#sex_at_birth
  module SexAtBirth
    extend VitableConnect::Internal::Type::Enum

    MALE = :Male
    FEMALE = :Female
    OTHER = :Other
    UNKNOWN = :Unknown

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

Instance Attribute Details

#age ⇒ Integer

Dependent's age in years, derived from date of birth

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :age, Integer

#date_of_birth ⇒ Date

Date of birth (YYYY-MM-DD)

Parameters:

  • value (Date)

Returns:

  • (Date) 


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

required :date_of_birth, Date

#first_name ⇒ String

Dependent's first name

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :first_name, String

#last_name ⇒ String

Dependent's last name

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :last_name, String

#member_id ⇒ String

Returns the value of attribute member_id.

Returns:

  • (String) 


44
45
46
 
# File 'sig/vitable_connect/models/member_list_dependents_response.rbs', line 44

def member_id
  @member_id
end

#primary_member_id ⇒ String

Returns the value of attribute primary_member_id.

Returns:

  • (String) 


46
47
48
 
# File 'sig/vitable_connect/models/member_list_dependents_response.rbs', line 46

def primary_member_id
  @primary_member_id
end

#relationship ⇒ Symbol, VitableConnect::Models::MemberListDependentsResponse::Data::Relationship

  • Spouse - Spouse
  • Child - Child

Parameters:

  • value (VitableConnect::Models::MemberListDependentsResponse::Data::relationship)

Returns:



48
49
 
# File 'lib/vitable_connect/models/member_list_dependents_response.rb', line 48

required :relationship,
enum: -> { VitableConnect::Models::MemberListDependentsResponse::Data::Relationship }

#sex_at_birth ⇒ Symbol, ...

  • Male - Male
  • Female - Female
  • Other - Other
  • Unknown - Unknown

Parameters:

  • value (VitableConnect::Models::MemberListDependentsResponse::Data::sex_at_birth, nil)

Returns:



58
59
60
 
# File 'lib/vitable_connect/models/member_list_dependents_response.rb', line 58

optional :sex_at_birth,
enum: -> { VitableConnect::Models::MemberListDependentsResponse::Data::SexAtBirth },
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/member_list_dependents_response.rb', line 108

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/vitable_connect/models/member_list_dependents_response.rbs', line 59

def to_hash: -> {