Class: PostfinancecheckoutRubySdk::PaymentTerminalAddress

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentTerminalAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 128

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

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::PaymentTerminalAddress`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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?(:'organization_name')
    self.organization_name = attributes[:'organization_name']
  end

  if attributes.key?(:'city')
    self.city = attributes[:'city']
  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?(:'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/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 38

def city
  @city
end

#country ⇒ Object

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



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

def country
  @country
end

#dependent_locality ⇒ Object

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



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

def dependent_locality
  @dependent_locality
end

#email_address ⇒ Object

The email address.



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

def email_address
  @email_address
end

#family_name ⇒ Object

The family or last name.



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

def family_name
  @family_name
end

#given_name ⇒ Object

The given or first name.



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

def given_name
  @given_name
end

#mobile_phone_number ⇒ Object

The phone number of a mobile phone.



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

def mobile_phone_number
  @mobile_phone_number
end

#organization_name ⇒ Object

The organization’s name.



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

def organization_name
  @organization_name
end

#phone_number ⇒ Object

The phone number.



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

def phone_number
  @phone_number
end

#postal_state ⇒ Object

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



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

def postal_state
  @postal_state
end

#postcode ⇒ Object

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



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

def postcode
  @postcode
end

#salutation ⇒ Object

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



68
69
70
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 68

def salutation
  @salutation
end

#sorting_code ⇒ Object

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



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

def sorting_code
  @sorting_code
end

#street ⇒ Object

The street or PO Box.



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

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



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 369

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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



91
92
93
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 91

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 96

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'country' => :'country',
    :'mobile_phone_number' => :'mobilePhoneNumber',
    :'organization_name' => :'organizationName',
    :'city' => :'city',
    :'given_name' => :'givenName',
    :'postcode' => :'postcode',
    :'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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 345

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



121
122
123
124
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 101

def self.openapi_types
  {
    :'country' => :'String',
    :'mobile_phone_number' => :'String',
    :'organization_name' => :'String',
    :'city' => :'String',
    :'given_name' => :'String',
    :'postcode' => :'String',
    :'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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      country == o.country &&
      mobile_phone_number == o.mobile_phone_number &&
      organization_name == o.organization_name &&
      city == o.city &&
      given_name == o.given_name &&
      postcode == o.postcode &&
      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



440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 440

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


332
333
334
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 332

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



338
339
340
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 338

def hash
  [country, mobile_phone_number, organization_name, city, given_name, postcode, 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



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 201

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 !@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 !@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 !@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



416
417
418
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 416

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



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 422

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



410
411
412
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 410

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



229
230
231
232
233
234
235
236
237
 
# File 'lib/postfinancecheckout-ruby-sdk/models/payment_terminal_address.rb', line 229

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 !@dependent_locality.nil? && @dependent_locality.to_s.length > 100
  return false if !@email_address.nil? && @email_address.to_s.length > 254
  return false if !@sorting_code.nil? && @sorting_code.to_s.length > 100
  return false if !@salutation.nil? && @salutation.to_s.length > 20
  true
end