Class: VitableConnect::Models::MemberRetrieveResponse::Data

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

Overview

See Also:

  • VitableConnect::Models::MemberRetrieveResponse#data

Defined Under Namespace

Modules: Status Classes: Address

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(id:, age:, date_of_birth:, first_name:, last_name:, name:, status:, address: nil, email: nil, phone: nil, preferred_language: nil, sex_at_birth: nil, tobacco_status: nil) ⇒ Object

A member's profile: identity, contact details, address, demographics, and onboarding status.

Parameters:

  • id (String) —

    Unique member identifier with 'mbr_' prefix

  • age (Integer) —

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

  • date_of_birth (Date) —

    Date of birth (YYYY-MM-DD)

  • first_name (String) —

    Member's legal first name

  • last_name (String) —

    Member's legal last name

  • name (String) —

    Member's full name

  • status (Symbol, VitableConnect::Models::MemberRetrieveResponse::Data::Status) —

    Member profile status (onboarded or pending onboarding)

  • address (VitableConnect::Models::MemberRetrieveResponse::Data::Address, nil) (defaults to: nil) —

    Member's residential address

  • email (String, nil) (defaults to: nil) —

    Email address

  • phone (String, nil) (defaults to: nil) —

    Phone number (10-digit US domestic string)

  • preferred_language (String, nil) (defaults to: nil) —

    Member's preferred language code (e.g., en, es)

  • sex_at_birth (String, nil) (defaults to: nil) —

    Sex assigned at birth, if provided

  • tobacco_status (Boolean, nil) (defaults to: nil) —

    Whether the member uses tobacco, if known




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

Instance Attribute Details

#address ⇒ VitableConnect::Models::MemberRetrieveResponse::Data::Address?

Member's residential address

Parameters:

Returns:



52
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 52

optional :address, -> { VitableConnect::Models::MemberRetrieveResponse::Data::Address }, nil?: true

#age ⇒ Integer

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

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


28
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 28

required :age, Integer

#date_of_birth ⇒ Date

Date of birth (YYYY-MM-DD)

Parameters:

  • value (Date)

Returns:

  • (Date) 


34
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 34

required :date_of_birth, Date

#email ⇒ String?

Email address

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


58
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 58

optional :email, String, nil?: true

#first_name ⇒ String

Member's legal first name

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 40

required :first_name, String

#id ⇒ String

Returns the value of attribute id.

Returns:

  • (String) 


55
56
57
 
# File 'sig/vitable_connect/models/member_retrieve_response.rbs', line 55

def id
  @id
end

#last_name ⇒ String

Member's legal last name

Parameters:

  • value (String)

Returns:

  • (String) 


46
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 46

required :last_name, String

#name ⇒ String

Returns the value of attribute name.

Returns:

  • (String) 


57
58
59
 
# File 'sig/vitable_connect/models/member_retrieve_response.rbs', line 57

def name
  @name
end

#phone ⇒ String?

Phone number (10-digit US domestic string)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


64
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 64

optional :phone, String, nil?: true

#preferred_language ⇒ String?

Member's preferred language code (e.g., en, es)

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


70
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 70

optional :preferred_language, String, nil?: true

#sex_at_birth ⇒ String?

Sex assigned at birth, if provided

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


76
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 76

optional :sex_at_birth, String, nil?: true

#status ⇒ VitableConnect::Models::MemberRetrieveResponse::Data::status

Returns the value of attribute status.

Returns:

  • (VitableConnect::Models::MemberRetrieveResponse::Data::status) 


59
60
61
 
# File 'sig/vitable_connect/models/member_retrieve_response.rbs', line 59

def status
  @status
end

#tobacco_status ⇒ Boolean?

Whether the member uses tobacco, if known

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


82
 
# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 82

optional :tobacco_status, VitableConnect::Internal::Type::Boolean, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/vitable_connect/models/member_retrieve_response.rb', line 143

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


77
 
# File 'sig/vitable_connect/models/member_retrieve_response.rbs', line 77

def to_hash: -> {