Class: VitableConnect::Models::MemberListResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::MemberListResponse

Defined in:

lib/vitable_connect/models/member_list_response.rb,
sig/vitable_connect/models/member_list_response.rbs

Overview

See Also:

• VitableConnect::Resources::Members#list

Defined Under Namespace

Classes: Address

Instance Attribute Summary

• #address ⇒ VitableConnect::Models::MemberListResponse::Address^?

  Member's residential address.

• #email ⇒ String^?

  Email address.

• #first_name ⇒ String

  Member's legal first name.

• #id ⇒ String

  Returns the value of attribute id.

• #last_name ⇒ String

  Member's legal last name.

• #phone ⇒ String^?

  Phone number (10-digit US domestic string).

Instance Method Summary

• #initialize(id:, first_name:, last_name:, address: nil, email: nil, phone: nil) ⇒ Object constructor

  A member in the organization's directory: identity, contact details, address, and join date.

• #to_hash ⇒ {

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:, first_name:, last_name:, address: nil, email: nil, phone: nil) ⇒ Object

A member in the organization's directory: identity, contact details, address, and join date.

Parameters:

• id (String) —

  Unique member identifier with 'mbr_' prefix

• first_name (String) —

  Member's legal first name

• last_name (String) —

  Member's legal last name

• address (VitableConnect::Models::MemberListResponse::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)

# File 'lib/vitable_connect/models/member_list_response.rb', line 45

Instance Attribute Details

#address ⇒ VitableConnect::Models::MemberListResponse::Address^?

Member's residential address

Parameters:

• value (VitableConnect::Models::MemberListResponse::Address, nil)

Returns:

• (VitableConnect::Models::MemberListResponse::Address, nil)

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

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

#email ⇒ String^?

Email address

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :email, String, nil?: true

#first_name ⇒ String

Member's legal first name

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/member_list_response.rb', line 11

required :first_name, String

#id ⇒ String

Returns the value of attribute id.

Returns:

• (String)

# File 'sig/vitable_connect/models/member_list_response.rbs', line 24

def id
  @id
end

#last_name ⇒ String

Member's legal last name

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/vitable_connect/models/member_list_response.rb', line 17

required :last_name, String

#phone ⇒ String^?

Phone number (10-digit US domestic string)

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :phone, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/vitable_connect/models/member_list_response.rbs', line 35

def to_hash: -> {