Class: AsposeEmailCloud::PostalAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-email-cloud/models/postal_address.rb

Overview

A postal address

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address: nil, category: nil, city: nil, country: nil, country_code: nil, is_mailing_address: nil, postal_code: nil, post_office_box: nil, preferred: nil, state_or_province: nil, street: nil) ⇒ PostalAddress

Initializes the object

Parameters:

  • address (String) (defaults to: nil) —

    Address.

  • category (EnumWithCustomOfPostalAddressCategory) (defaults to: nil) —

    Address category.

  • city (String) (defaults to: nil) —

    Address’s city.

  • country (String) (defaults to: nil) —

    Address’s country.

  • country_code (String) (defaults to: nil) —

    Country code.

  • is_mailing_address (BOOLEAN) (defaults to: nil) —

    Defines whether address may be used for mailing.

  • postal_code (String) (defaults to: nil) —

    Postal code.

  • post_office_box (String) (defaults to: nil) —

    Post Office box.

  • preferred (BOOLEAN) (defaults to: nil) —

    Defines whether postal address is preferred.

  • state_or_province (String) (defaults to: nil) —

    Address’s region.

  • street (String) (defaults to: nil) —

    Address’s street.



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/aspose-email-cloud/models/postal_address.rb', line 110

def initialize(
  address: nil,
  category: nil,
  city: nil,
  country: nil,
  country_code: nil,
  is_mailing_address: nil,
  postal_code: nil,
  post_office_box: nil,
  preferred: nil,
  state_or_province: nil,
  street: nil)
  self.address = address if address
  self.category = category if category
  self.city = city if city
  self.country = country if country
  self.country_code = country_code if country_code
  self.is_mailing_address = is_mailing_address if is_mailing_address
  self.postal_code = postal_code if postal_code
  self.post_office_box = post_office_box if post_office_box
  self.preferred = preferred if preferred
  self.state_or_province = state_or_province if state_or_province
  self.street = street if street
end

Instance Attribute Details

#address ⇒ String

Address.

Returns:

  • (String) 


33
34
35
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 33

def address
  @address
end

#category ⇒ EnumWithCustomOfPostalAddressCategory

Address category.

Returns:



36
37
38
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 36

def category
  @category
end

#city ⇒ String

Address’s city.

Returns:

  • (String) 


39
40
41
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 39

def city
  @city
end

#country ⇒ String

Address’s country.

Returns:

  • (String) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 42

def country
  @country
end

#country_code ⇒ String

Country code.

Returns:

  • (String) 


45
46
47
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 45

def country_code
  @country_code
end

#is_mailing_address ⇒ BOOLEAN

Defines whether address may be used for mailing.

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 48

def is_mailing_address
  @is_mailing_address
end

#post_office_box ⇒ String

Post Office box.

Returns:

  • (String) 


54
55
56
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 54

def post_office_box
  @post_office_box
end

#postal_code ⇒ String

Postal code.

Returns:

  • (String) 


51
52
53
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 51

def postal_code
  @postal_code
end

#preferred ⇒ BOOLEAN

Defines whether postal address is preferred.

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 57

def preferred
  @preferred
end

#state_or_province ⇒ String

Address’s region.

Returns:

  • (String) 


60
61
62
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 60

def state_or_province
  @state_or_province
end

#street ⇒ String

Address’s street.

Returns:

  • (String) 


63
64
65
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 63

def street
  @street
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 65

def self.attribute_map
  {
    :'address' => :'address',
    :'category' => :'category',
    :'city' => :'city',
    :'country' => :'country',
    :'country_code' => :'countryCode',
    :'is_mailing_address' => :'isMailingAddress',
    :'postal_code' => :'postalCode',
    :'post_office_box' => :'postOfficeBox',
    :'preferred' => :'preferred',
    :'state_or_province' => :'stateOrProvince',
    :'street' => :'street'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 82

def self.swagger_types
  {
    :'address' => :'String',
    :'category' => :'EnumWithCustomOfPostalAddressCategory',
    :'city' => :'String',
    :'country' => :'String',
    :'country_code' => :'String',
    :'is_mailing_address' => :'BOOLEAN',
    :'postal_code' => :'String',
    :'post_office_box' => :'String',
    :'preferred' => :'BOOLEAN',
    :'state_or_province' => :'String',
    :'street' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 160

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      category == o.category &&
      city == o.city &&
      country == o.country &&
      country_code == o.country_code &&
      is_mailing_address == o.is_mailing_address &&
      postal_code == o.postal_code &&
      post_office_box == o.post_office_box &&
      preferred == o.preferred &&
      state_or_province == o.state_or_province &&
      street == o.street
end

#_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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 214

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 284

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

#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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 191

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


178
179
180
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 178

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



184
185
186
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 184

def hash
  [address, category, city, country, country_code, is_mailing_address, postal_code, post_office_box, preferred, state_or_province, street].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
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 137

def list_invalid_properties
  invalid_properties = Array.new
  if @is_mailing_address.nil?
    invalid_properties.push('invalid value for "is_mailing_address", is_mailing_address cannot be nil.')
  end

  if @preferred.nil?
    invalid_properties.push('invalid value for "preferred", preferred 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



264
265
266
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 264

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



270
271
272
273
274
275
276
277
278
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 270

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



258
259
260
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 258

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



152
153
154
155
156
 
# File 'lib/aspose-email-cloud/models/postal_address.rb', line 152

def valid?
  return false if @is_mailing_address.nil?
  return false if @preferred.nil?
  true
end