Class: OpenapiClient::Sepa

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/sepa.rb

Overview

The payment object for SEPA Local Payment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Sepa

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/openapi_client/models/sepa.rb', line 56

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Sepa` 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 `OpenapiClient::Sepa`. 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?(:'iban')
    self.iban = attributes[:'iban']
  end

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

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

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

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

Instance Attribute Details

#country ⇒ Object

Country of residence of the payer using the ISO 3166 standard.



25
26
27
 
# File 'lib/openapi_client/models/sepa.rb', line 25

def country
  @country
end

#email ⇒ Object

The email address of the payer.



28
29
30
 
# File 'lib/openapi_client/models/sepa.rb', line 28

def email
  @email
end

#iban ⇒ Object

Bank account in IBAN format.



19
20
21
 
# File 'lib/openapi_client/models/sepa.rb', line 19

def iban
  @iban
end

#mandate ⇒ Object

Returns the value of attribute mandate.



30
31
32
 
# File 'lib/openapi_client/models/sepa.rb', line 30

def mandate
  @mandate
end

#name ⇒ Object

The name of the payer.



22
23
24
 
# File 'lib/openapi_client/models/sepa.rb', line 22

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/openapi_client/models/sepa.rb', line 33

def self.attribute_map
  {
    :'iban' => :'iban',
    :'name' => :'name',
    :'country' => :'country',
    :'email' => :'email',
    :'mandate' => :'mandate'
  }
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



255
256
257
 
# File 'lib/openapi_client/models/sepa.rb', line 255

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/openapi_client/models/sepa.rb', line 44

def self.openapi_types
  {
    :'iban' => :'String',
    :'name' => :'String',
    :'country' => :'String',
    :'email' => :'String',
    :'mandate' => :'SepaMandate'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
 
# File 'lib/openapi_client/models/sepa.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      iban == o.iban &&
      name == o.name &&
      country == o.country &&
      email == o.email &&
      mandate == o.mandate
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



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
 
# File 'lib/openapi_client/models/sepa.rb', line 283

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/openapi_client/models/sepa.rb', line 357

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/openapi_client/models/sepa.rb', line 262

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


242
243
244
 
# File 'lib/openapi_client/models/sepa.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/openapi_client/models/sepa.rb', line 248

def hash
  [iban, name, country, email, mandate].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



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
134
135
136
137
138
139
140
141
142
 
# File 'lib/openapi_client/models/sepa.rb', line 92

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @iban !~ pattern
    invalid_properties.push("invalid value for \"iban\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @name !~ pattern
    invalid_properties.push("invalid value for \"name\", must conform to the pattern #{pattern}.")
  end

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

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

  pattern = Regexp.new(/^(?!\s*$).+/)
  if @country !~ pattern
    invalid_properties.push("invalid value for \"country\", must conform to the pattern #{pattern}.")
  end

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

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



333
334
335
 
# File 'lib/openapi_client/models/sepa.rb', line 333

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/openapi_client/models/sepa.rb', line 339

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



327
328
329
 
# File 'lib/openapi_client/models/sepa.rb', line 327

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/openapi_client/models/sepa.rb', line 146

def valid?
  return false if @iban.nil?
  return false if @iban.to_s.length > 34
  return false if @iban !~ Regexp.new(/^(?!\s*$).+/)
  return false if @name.nil?
  return false if @name.to_s.length > 96
  return false if @name !~ Regexp.new(/^(?!\s*$).+/)
  return false if @country.nil?
  return false if @country.to_s.length > 3
  return false if @country !~ Regexp.new(/^(?!\s*$).+/)
  return false if !@email.nil? && @email.to_s.length > 254
  return false if @mandate.nil?
  true
end