Class: Gusto::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/fern_gusto/types/address.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(street1: OMIT, street2: OMIT, city: OMIT, state: OMIT, zip: OMIT, country: OMIT, active: OMIT, version: OMIT, additional_properties: nil) ⇒ Gusto::Address

Parameters:

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/fern_gusto/types/address.rb', line 47

def initialize(street1: OMIT, street2: OMIT, city: OMIT, state: OMIT, zip: OMIT, country: OMIT, active: OMIT, version: OMIT, additional_properties: nil)
  @street1 = street1 if street1 != OMIT
  @street2 = street2 if street2 != OMIT
  @city = city if city != OMIT
  @state = state if state != OMIT
  @zip = zip if zip != OMIT
  @country = country if country != OMIT
  @active = active if active != OMIT
  @version = version if version != OMIT
  @additional_properties = additional_properties
  @_field_set = { "street_1": street1, "street_2": street2, "city": city, "state": state, "zip": zip, "country": country, "active": active, "version": version }.reject do | _k, v |
  v == OMIT
end
end

Instance Attribute Details

#active ⇒ Object (readonly)

have historical data associated with them.



21
22
23
 
# File 'lib/fern_gusto/types/address.rb', line 21

def active
  @active
end

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



27
28
29
 
# File 'lib/fern_gusto/types/address.rb', line 27

def additional_properties
  @additional_properties
end

#city ⇒ String (readonly)

Returns:

  • (String) 


12
13
14
 
# File 'lib/fern_gusto/types/address.rb', line 12

def city
  @city
end

#country ⇒ String (readonly)

Returns:

  • (String) 


18
19
20
 
# File 'lib/fern_gusto/types/address.rb', line 18

def country
  @country
end

#state ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/fern_gusto/types/address.rb', line 14

def state
  @state
end

#street1 ⇒ String (readonly)

Returns:

  • (String) 


8
9
10
 
# File 'lib/fern_gusto/types/address.rb', line 8

def street1
  @street1
end

#street2 ⇒ String (readonly)

Returns:

  • (String) 


10
11
12
 
# File 'lib/fern_gusto/types/address.rb', line 10

def street2
  @street2
end

#version ⇒ Object (readonly)

on how to use this field.



25
26
27
 
# File 'lib/fern_gusto/types/address.rb', line 25

def version
  @version
end

#zip ⇒ String (readonly)

Returns:

  • (String) 


16
17
18
 
# File 'lib/fern_gusto/types/address.rb', line 16

def zip
  @zip
end

Class Method Details

.from_json(json_object:) ⇒ Gusto::Address

Parameters:

  • json_object (String)

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/fern_gusto/types/address.rb', line 65

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  street1 = parsed_json["street_1"]
  street2 = parsed_json["street_2"]
  city = parsed_json["city"]
  state = parsed_json["state"]
  zip = parsed_json["zip"]
  country = parsed_json["country"]
  active = parsed_json["active"]
  version = parsed_json["version"]
  new(
    street1: street1,
    street2: street2,
    city: city,
    state: state,
    zip: zip,
    country: country,
    active: active,
    version: version,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Parameters:

  • obj (Object)

Returns:

  • (Void) 


100
101
102
103
104
105
106
107
108
109
 
# File 'lib/fern_gusto/types/address.rb', line 100

def self.validate_raw(obj:)
  obj.street1&.is_a?(String) != false || raise("Passed value for field obj.street1 is not the expected type, validation failed.")
  obj.street2&.is_a?(String) != false || raise("Passed value for field obj.street2 is not the expected type, validation failed.")
  obj.city&.is_a?(String) != false || raise("Passed value for field obj.city is not the expected type, validation failed.")
  obj.state&.is_a?(String) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
  obj.zip&.is_a?(String) != false || raise("Passed value for field obj.zip is not the expected type, validation failed.")
  obj.country&.is_a?(String) != false || raise("Passed value for field obj.country is not the expected type, validation failed.")
  obj.active&.is_a?(Boolean) != false || raise("Passed value for field obj.active is not the expected type, validation failed.")
  obj.version&.is_a?(String) != false || raise("Passed value for field obj.version is not the expected type, validation failed.")
end

Instance Method Details

#to_json ⇒ String

Returns:

  • (String) 


91
92
93
 
# File 'lib/fern_gusto/types/address.rb', line 91

def to_json
  @_field_set&.to_json
end