Class: VitableConnect::Models::MemberListIDCardsResponse::Data::Network::Address

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

Overview

See Also:

  • VitableConnect::Models::MemberListIDCardsResponse::Data::Network#address

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(address_line_1:, address_line_2:, city:, state:, zipcode:) ⇒ Object

Shared read serializer for a postal address on public API responses.

One definition for the address block every public resource emits (employer, employee, …), so the 5-field shape isn't hand-rolled per endpoint. Read-only: it renders an already-built address value object (e.g. AddressDVO) whose attributes map 1:1 to these fields.

Parameters:

  • address_line_1 (String) —

    Primary street address.

  • address_line_2 (String, nil) —

    Secondary street address (apt, suite, etc.).

  • city (String) —

    City name.

  • state (String) —

    Two-letter state code (e.g. CA, NY).

  • zipcode (String) —

    ZIP code (5 or 9 digit).




# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 346

Instance Attribute Details

#address_line_1 ⇒ String

Primary street address.

Parameters:

  • value (String)

Returns:

  • (String) 


320
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 320

required :address_line_1, String

#address_line_2 ⇒ String?

Secondary street address (apt, suite, etc.).

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


326
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 326

required :address_line_2, String, nil?: true

#city ⇒ String

City name.

Parameters:

  • value (String)

Returns:

  • (String) 


332
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 332

required :city, String

#state ⇒ String

Two-letter state code (e.g. CA, NY).

Parameters:

  • value (String)

Returns:

  • (String) 


338
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 338

required :state, String

#zipcode ⇒ String

ZIP code (5 or 9 digit).

Parameters:

  • value (String)

Returns:

  • (String) 


344
 
# File 'lib/vitable_connect/models/member_list_id_cards_response.rb', line 344

required :zipcode, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


244
 
# File 'sig/vitable_connect/models/member_list_id_cards_response.rbs', line 244

def to_hash: -> {