Class: ConstantContactClient::AccountPhysicalAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/constant_contact_client/models/account_physical_address.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountPhysicalAddress

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 83

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ConstantContactClient::AccountPhysicalAddress` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `ConstantContactClient::AccountPhysicalAddress`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'address_line1')
    self.address_line1 = attributes[:'address_line1']
  else
    self.address_line1 = nil
  end

  if attributes.key?(:'address_line2')
    self.address_line2 = attributes[:'address_line2']
  end

  if attributes.key?(:'address_line3')
    self.address_line3 = attributes[:'address_line3']
  end

  if attributes.key?(:'city')
    self.city = attributes[:'city']
  else
    self.city = nil
  end

  if attributes.key?(:'state_code')
    self.state_code = attributes[:'state_code']
  end

  if attributes.key?(:'state_name')
    self.state_name = attributes[:'state_name']
  end

  if attributes.key?(:'postal_code')
    self.postal_code = attributes[:'postal_code']
  end

  if attributes.key?(:'country_code')
    self.country_code = attributes[:'country_code']
  else
    self.country_code = nil
  end
end

Instance Attribute Details

#address_line1 ⇒ Object

Line 1 of the organization’s street address.



19
20
21
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 19

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Line 2 of the organization’s street address.



22
23
24
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 22

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

Line 3 of the organization’s street address.



25
26
27
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 25

def address_line3
  @address_line3
end

#city ⇒ Object

The city where the organization is located.



28
29
30
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 28

def city
  @city
end

#country_code ⇒ Object

The two letter <a href=‘en.wikipedia.org/wiki/ISO_3166-1’ target=‘_blank’>ISO 3166-1 code</a> for the organization’s country.



40
41
42
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 40

def country_code
  @country_code
end

#postal_code ⇒ Object

The postal code address (ZIP code) of the organization. This property is required if the state_code is US or CA, otherwise exclude this property from the request body.



37
38
39
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 37

def postal_code
  @postal_code
end

#state_code ⇒ Object

The two letter ISO 3166-1 code for the organization’s state and only used if the country_code is US or CA. If not, exclude this property from the request body.



31
32
33
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 31

def state_code
  @state_code
end

#state_name ⇒ Object

Use if the state where the organization is physically located is not in the United States or Canada. If country_code is US or CA, exclude this property from the request body.



34
35
36
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 34

def state_name
  @state_name
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 322

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = ConstantContactClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 57

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 43

def self.attribute_map
  {
    :'address_line1' => :'address_line1',
    :'address_line2' => :'address_line2',
    :'address_line3' => :'address_line3',
    :'city' => :'city',
    :'state_code' => :'state_code',
    :'state_name' => :'state_name',
    :'postal_code' => :'postal_code',
    :'country_code' => :'country_code'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 298

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 76

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 62

def self.openapi_types
  {
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'address_line3' => :'String',
    :'city' => :'String',
    :'state_code' => :'String',
    :'state_name' => :'String',
    :'postal_code' => :'String',
    :'country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_line3 == o.address_line3 &&
      city == o.city &&
      state_code == o.state_code &&
      state_name == o.state_name &&
      postal_code == o.postal_code &&
      country_code == o.country_code
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 393

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


285
286
287
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



291
292
293
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 291

def hash
  [address_line1, address_line2, address_line3, city, state_code, state_name, postal_code, country_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 137

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @address_line1.nil?
    invalid_properties.push('invalid value for "address_line1", address_line1 cannot be nil.')
  end

  if @address_line1.to_s.length > 80
    invalid_properties.push('invalid value for "address_line1", the character length must be smaller than or equal to 80.')
  end

  if @address_line1.to_s.length < 1
    invalid_properties.push('invalid value for "address_line1", the character length must be great than or equal to 1.')
  end

  if !@address_line2.nil? && @address_line2.to_s.length > 80
    invalid_properties.push('invalid value for "address_line2", the character length must be smaller than or equal to 80.')
  end

  if !@address_line2.nil? && @address_line2.to_s.length < 1
    invalid_properties.push('invalid value for "address_line2", the character length must be great than or equal to 1.')
  end

  if !@address_line3.nil? && @address_line3.to_s.length > 80
    invalid_properties.push('invalid value for "address_line3", the character length must be smaller than or equal to 80.')
  end

  if !@address_line3.nil? && @address_line3.to_s.length < 1
    invalid_properties.push('invalid value for "address_line3", the character length must be great than or equal to 1.')
  end

  if @city.nil?
    invalid_properties.push('invalid value for "city", city cannot be nil.')
  end

  if !@state_code.nil? && @state_code.to_s.length > 2
    invalid_properties.push('invalid value for "state_code", the character length must be smaller than or equal to 2.')
  end

  if @country_code.nil?
    invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



369
370
371
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 369

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 375

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



363
364
365
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 363

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/constant_contact_client/models/account_physical_address.rb', line 185

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @address_line1.nil?
  return false if @address_line1.to_s.length > 80
  return false if @address_line1.to_s.length < 1
  return false if !@address_line2.nil? && @address_line2.to_s.length > 80
  return false if !@address_line2.nil? && @address_line2.to_s.length < 1
  return false if !@address_line3.nil? && @address_line3.to_s.length > 80
  return false if !@address_line3.nil? && @address_line3.to_s.length < 1
  return false if @city.nil?
  return false if !@state_code.nil? && @state_code.to_s.length > 2
  return false if @country_code.nil?
  true
end