Class: PostFinanceCheckout::SpaceAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/space_address.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SpaceAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 112

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'city')
    self.city = attributes[:'city']
  end

  if attributes.has_key?(:'country')
    self.country = attributes[:'country']
  end

  if attributes.has_key?(:'dependentLocality')
    self.dependent_locality = attributes[:'dependentLocality']
  end

  if attributes.has_key?(:'emailAddress')
    self.email_address = attributes[:'emailAddress']
  end

  if attributes.has_key?(:'familyName')
    self.family_name = attributes[:'familyName']
  end

  if attributes.has_key?(:'givenName')
    self.given_name = attributes[:'givenName']
  end

  if attributes.has_key?(:'mobilePhoneNumber')
    self.mobile_phone_number = attributes[:'mobilePhoneNumber']
  end

  if attributes.has_key?(:'organizationName')
    self.organization_name = attributes[:'organizationName']
  end

  if attributes.has_key?(:'phoneNumber')
    self.phone_number = attributes[:'phoneNumber']
  end

  if attributes.has_key?(:'postalState')
    self.postal_state = attributes[:'postalState']
  end

  if attributes.has_key?(:'postcode')
    self.postcode = attributes[:'postcode']
  end

  if attributes.has_key?(:'salesTaxNumber')
    self.sales_tax_number = attributes[:'salesTaxNumber']
  end

  if attributes.has_key?(:'salutation')
    self.salutation = attributes[:'salutation']
  end

  if attributes.has_key?(:'sortingCode')
    self.sorting_code = attributes[:'sortingCode']
  end

  if attributes.has_key?(:'street')
    self.street = attributes[:'street']
  end
end

Instance Attribute Details

#city ⇒ Object

The city, town or village.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 24

def city
  @city
end

#country ⇒ Object

The two-letter country code (ISO 3166 format).



27
28
29
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 27

def country
  @country
end

#dependent_locality ⇒ Object

The dependent locality which is a sub-division of the state.



30
31
32
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 30

def dependent_locality
  @dependent_locality
end

#email_address ⇒ Object

The email address used for communication with clients.



33
34
35
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 33

def email_address
  @email_address
end

#family_name ⇒ Object

The family or last name.



36
37
38
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 36

def family_name
  @family_name
end

#given_name ⇒ Object

The given or first name.



39
40
41
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 39

def given_name
  @given_name
end

#mobile_phone_number ⇒ Object

The phone number of a mobile phone.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 42

def mobile_phone_number
  @mobile_phone_number
end

#organization_name ⇒ Object

The organization’s name.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 45

def organization_name
  @organization_name
end

#phone_number ⇒ Object

The phone number.



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 48

def phone_number
  @phone_number
end

#postal_state ⇒ Object

The name of the region, typically a state, county, province or prefecture.



51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 51

def postal_state
  @postal_state
end

#postcode ⇒ Object

The postal code, also known as ZIP, postcode, etc.



54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 54

def postcode
  @postcode
end

#sales_tax_number ⇒ Object

The sales tax number of the organization.



57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 57

def sales_tax_number
  @sales_tax_number
end

#salutation ⇒ Object

The salutation e.g. Mrs, Mr, Dr.



60
61
62
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 60

def salutation
  @salutation
end

#sorting_code ⇒ Object

The sorting code identifying the post office where the PO Box is located.



63
64
65
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 63

def sorting_code
  @sorting_code
end

#street ⇒ Object

The street or PO Box.



66
67
68
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 66

def street
  @street
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 69

def self.attribute_map
  {
    :'city' => :'city',
    :'country' => :'country',
    :'dependent_locality' => :'dependentLocality',
    :'email_address' => :'emailAddress',
    :'family_name' => :'familyName',
    :'given_name' => :'givenName',
    :'mobile_phone_number' => :'mobilePhoneNumber',
    :'organization_name' => :'organizationName',
    :'phone_number' => :'phoneNumber',
    :'postal_state' => :'postalState',
    :'postcode' => :'postcode',
    :'sales_tax_number' => :'salesTaxNumber',
    :'salutation' => :'salutation',
    :'sorting_code' => :'sortingCode',
    :'street' => :'street'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 90

def self.swagger_types
  {
    :'city' => :'String',
    :'country' => :'String',
    :'dependent_locality' => :'String',
    :'email_address' => :'String',
    :'family_name' => :'String',
    :'given_name' => :'String',
    :'mobile_phone_number' => :'String',
    :'organization_name' => :'String',
    :'phone_number' => :'String',
    :'postal_state' => :'String',
    :'postcode' => :'String',
    :'sales_tax_number' => :'String',
    :'salutation' => :'String',
    :'sorting_code' => :'String',
    :'street' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 329

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      city == o.city &&
      country == o.country &&
      dependent_locality == o.dependent_locality &&
      email_address == o.email_address &&
      family_name == o.family_name &&
      given_name == o.given_name &&
      mobile_phone_number == o.mobile_phone_number &&
      organization_name == o.organization_name &&
      phone_number == o.phone_number &&
      postal_state == o.postal_state &&
      postcode == o.postcode &&
      sales_tax_number == o.sales_tax_number &&
      salutation == o.salutation &&
      sorting_code == o.sorting_code &&
      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



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 385

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
    temp_model = PostFinanceCheckout.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



451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 451

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 364

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[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


351
352
353
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



357
358
359
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 357

def hash
  [city, country, dependent_locality, email_address, family_name, given_name, mobile_phone_number, organization_name, phone_number, postal_state, postcode, sales_tax_number, salutation, sorting_code, 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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 181

def list_invalid_properties
  invalid_properties = Array.new
  if !@dependent_locality.nil? && @dependent_locality.to_s.length > 100
    invalid_properties.push('invalid value for "dependent_locality", the character length must be smaller than or equal to 100.')
  end

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

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

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

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

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

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

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

  if !@sorting_code.nil? && @sorting_code.to_s.length > 100
    invalid_properties.push('invalid value for "sorting_code", the character length must be smaller than or equal to 100.')
  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



431
432
433
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 431

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



437
438
439
440
441
442
443
444
445
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 437

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



425
426
427
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 425

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



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space_address.rb', line 224

def valid?
  return false if !@dependent_locality.nil? && @dependent_locality.to_s.length > 100
  return false if !@family_name.nil? && @family_name.to_s.length > 100
  return false if !@given_name.nil? && @given_name.to_s.length > 100
  return false if !@mobile_phone_number.nil? && @mobile_phone_number.to_s.length > 100
  return false if !@organization_name.nil? && @organization_name.to_s.length > 100
  return false if !@phone_number.nil? && @phone_number.to_s.length > 100
  return false if !@sales_tax_number.nil? && @sales_tax_number.to_s.length > 100
  return false if !@salutation.nil? && @salutation.to_s.length > 20
  return false if !@sorting_code.nil? && @sorting_code.to_s.length > 100
  true
end