Class: Wallee::AbstractTokenUpdate

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AbstractTokenUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 66

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?(:'customerEmailAddress')
    self.customer_email_address = attributes[:'customerEmailAddress']
  end

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

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

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

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

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

Instance Attribute Details

#customer_email_addressObject

The customer email address is the email address of the customer.



23
24
25
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 23

def customer_email_address
  @customer_email_address
end

#customer_idObject

The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.



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

def customer_id
  @customer_id
end

#enabled_for_one_click_paymentObject

When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.



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

def enabled_for_one_click_payment
  @enabled_for_one_click_payment
end

#languageObject

The language that is linked to the object.



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

def language
  @language
end

#time_zoneObject

The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.



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

def time_zone
  @time_zone
end

#token_referenceObject

Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).



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

def token_reference
  @token_reference
end

Class Method Details

.attribute_mapObject

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



41
42
43
44
45
46
47
48
49
50
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 41

def self.attribute_map
  {
    :'customer_email_address' => :'customerEmailAddress',
    :'customer_id' => :'customerId',
    :'enabled_for_one_click_payment' => :'enabledForOneClickPayment',
    :'language' => :'language',
    :'time_zone' => :'timeZone',
    :'token_reference' => :'tokenReference'
  }
end

.swagger_typesObject

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 53

def self.swagger_types
  {
    :'customer_email_address' => :'String',
    :'customer_id' => :'String',
    :'enabled_for_one_click_payment' => :'BOOLEAN',
    :'language' => :'String',
    :'time_zone' => :'String',
    :'token_reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



142
143
144
145
146
147
148
149
150
151
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 142

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer_email_address == o.customer_email_address &&
      customer_id == o.customer_id &&
      enabled_for_one_click_payment == o.enabled_for_one_click_payment &&
      language == o.language &&
      time_zone == o.time_zone &&
      token_reference == o.token_reference
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



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
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 189

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



255
256
257
258
259
260
261
262
263
264
265
266
267
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 255

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 168

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


155
156
157
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 155

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



161
162
163
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 161

def hash
  [customer_email_address, customer_id, enabled_for_one_click_payment, language, time_zone, token_reference].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 99

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



235
236
237
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 235

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 241

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



229
230
231
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 229

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



114
115
116
117
118
# File 'lib/wallee-ruby-sdk/models/abstract_token_update.rb', line 114

def valid?
  return false if !@customer_email_address.nil? && @customer_email_address.to_s.length > 150
  return false if !@token_reference.nil? && @token_reference.to_s.length > 100
  true
end