Class: WalleeRubySdk::CustomerPostalAddress

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerPostalAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash



171
172
173
174
175
176
177
178
179
180
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
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
255
256
257
258
259
260
261
262
263
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 171

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::CustomerPostalAddress` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::CustomerPostalAddress`. 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?(:'country')
    self.country = attributes[:'country']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#city ⇒ Object

The city, town or village.



38
39
40
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 38

def city
  @city
end

#commercial_register_number ⇒ Object

The commercial registration number of the organization.



41
42
43
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 41

def commercial_register_number
  @commercial_register_number
end

#country ⇒ Object

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



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

def country
  @country
end

#date_of_birth ⇒ Object

The date of birth.



58
59
60
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 58

def date_of_birth
  @date_of_birth
end

#dependent_locality ⇒ Object

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



61
62
63
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 61

def dependent_locality
  @dependent_locality
end

#email_address ⇒ Object

The email address.



64
65
66
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 64

def email_address
  @email_address
end

#family_name ⇒ Object

The family or last name.



76
77
78
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 76

def family_name
  @family_name
end

#gender ⇒ Object

Returns the value of attribute gender.



32
33
34
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 32

def gender
  @gender
end

#given_name ⇒ Object

The given or first name.



47
48
49
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 47

def given_name
  @given_name
end

#legal_organization_form ⇒ Object

Returns the value of attribute legal_organization_form.



52
53
54
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 52

def legal_organization_form
  @legal_organization_form
end

#mobile_phone_number ⇒ Object

The phone number of a mobile phone.



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

def mobile_phone_number
  @mobile_phone_number
end

#organization_name ⇒ Object

The organization’s name.



35
36
37
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 35

def organization_name
  @organization_name
end

#phone_number ⇒ Object

The phone number.



67
68
69
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 67

def phone_number
  @phone_number
end

#postal_state ⇒ Object

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



79
80
81
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 79

def postal_state
  @postal_state
end

#postcode ⇒ Object

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



50
51
52
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 50

def postcode
  @postcode
end

#sales_tax_number ⇒ Object

The sales tax number of the organization.



55
56
57
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 55

def sales_tax_number
  @sales_tax_number
end

#salutation ⇒ Object

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



82
83
84
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 82

def salutation
  @salutation
end

#social_security_number ⇒ Object

The social security number.



44
45
46
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 44

def social_security_number
  @social_security_number
end

#sorting_code ⇒ Object

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



70
71
72
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 70

def sorting_code
  @sorting_code
end

#street ⇒ Object

The street or PO Box.



73
74
75
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 73

def street
  @street
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



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 629

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 = WalleeRubySdk.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



133
134
135
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 133

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 107

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

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 605

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



164
165
166
167
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 164

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

.openapi_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 138

def self.openapi_types
  {
    :'country' => :'String',
    :'mobile_phone_number' => :'String',
    :'gender' => :'Gender',
    :'organization_name' => :'String',
    :'city' => :'String',
    :'commercial_register_number' => :'String',
    :'social_security_number' => :'String',
    :'given_name' => :'String',
    :'postcode' => :'String',
    :'legal_organization_form' => :'LegalOrganizationForm',
    :'sales_tax_number' => :'String',
    :'date_of_birth' => :'Date',
    :'dependent_locality' => :'String',
    :'email_address' => :'String',
    :'phone_number' => :'String',
    :'sorting_code' => :'String',
    :'street' => :'String',
    :'family_name' => :'String',
    :'postal_state' => :'String',
    :'salutation' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 567

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



700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 700

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


594
595
596
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 594

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



600
601
602
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 600

def hash
  [country, mobile_phone_number, gender, organization_name, city, commercial_register_number, social_security_number, given_name, postcode, legal_organization_form, sales_tax_number, date_of_birth, dependent_locality, email_address, phone_number, sorting_code, street, family_name, postal_state, salutation].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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 267

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 !@city.nil? && @city.to_s.length > 100
    invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 100.')
  end

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

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

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

  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



676
677
678
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 676

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



682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 682

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



670
671
672
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 670

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/wallee-ruby-sdk/models/customer_postal_address.rb', line 335

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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 !@city.nil? && @city.to_s.length > 100
  return false if !@commercial_register_number.nil? && @commercial_register_number.to_s.length > 100
  return false if !@social_security_number.nil? && @social_security_number.to_s.length > 100
  return false if !@given_name.nil? && @given_name.to_s.length > 100
  return false if !@postcode.nil? && @postcode.to_s.length > 40
  return false if !@sales_tax_number.nil? && @sales_tax_number.to_s.length > 100
  return false if !@dependent_locality.nil? && @dependent_locality.to_s.length > 100
  return false if !@email_address.nil? && @email_address.to_s.length > 254
  return false if !@phone_number.nil? && @phone_number.to_s.length > 100
  return false if !@sorting_code.nil? && @sorting_code.to_s.length > 100
  return false if !@street.nil? && @street.to_s.length > 300
  return false if !@family_name.nil? && @family_name.to_s.length > 100
  return false if !@salutation.nil? && @salutation.to_s.length > 20
  true
end