Class: VitableConnect::Models::EmployerUpdateParams::Address

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

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

Employer address

Parameters:

  • address_line_1 (String) —

    Primary street address

  • city (String) —

    City name

  • state (String) —

    Two-letter state code

  • zipcode (String) —

    ZIP code

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

    Secondary street address



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
 
# File 'lib/vitable_connect/models/employer_update_params.rb', line 53

class Address < VitableConnect::Internal::Type::BaseModel
  # @!attribute address_line_1
  #   Primary street address
  #
  #   @return [String]
  required :address_line_1, String

  # @!attribute city
  #   City name
  #
  #   @return [String]
  required :city, String

  # @!attribute state
  #   Two-letter state code
  #
  #   @return [String]
  required :state, String

  # @!attribute zipcode
  #   ZIP code
  #
  #   @return [String]
  required :zipcode, String

  # @!attribute address_line_2
  #   Secondary street address
  #
  #   @return [String, nil]
  optional :address_line_2, String, nil?: true

  # @!method initialize(address_line_1:, city:, state:, zipcode:, address_line_2: nil)
  #   Employer address
  #
  #   @param address_line_1 [String] Primary street address
  #
  #   @param city [String] City name
  #
  #   @param state [String] Two-letter state code
  #
  #   @param zipcode [String] ZIP code
  #
  #   @param address_line_2 [String, nil] Secondary street address
end

Instance Attribute Details

#address_line_1 ⇒ String

Primary street address

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :address_line_1, String

#address_line_2 ⇒ String?

Secondary street address

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :address_line_2, String, nil?: true

#city ⇒ String

City name

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :city, String

#state ⇒ String

Two-letter state code

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :state, String

#zipcode ⇒ String

ZIP code

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :zipcode, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


73
 
# File 'sig/vitable_connect/models/employer_update_params.rbs', line 73

def to_hash: -> {