Class: WalleeRubySdk::Token

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Token

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
198
199
200
201
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 137

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#customer_email_address ⇒ Object

The customer’s email address.



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

def customer_email_address
  @customer_email_address
end

#customer_id ⇒ Object

The unique identifier of the customer in the external system.



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

def customer_id
  @customer_id
end

#enabled_for_one_click_payment ⇒ Object

Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.



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

def enabled_for_one_click_payment
  @enabled_for_one_click_payment
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#time_zone ⇒ Object

The customer’s time zone, which affects how dates and times are formatted when communicating with the customer.



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

def time_zone
  @time_zone
end

#token_reference ⇒ Object

The reference used to identify the payment token (e.g. the customer’s ID or email address).



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

def token_reference
  @token_reference
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



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

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



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 325

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



106
107
108
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 87

def self.attribute_map
  {
    :'enabled_for_one_click_payment' => :'enabledForOneClickPayment',
    :'customer_email_address' => :'customerEmailAddress',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'external_id' => :'externalId',
    :'time_zone' => :'timeZone',
    :'language' => :'language',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'linked_space_id' => :'linkedSpaceId',
    :'token_reference' => :'tokenReference',
    :'customer_id' => :'customerId',
    :'id' => :'id',
    :'state' => :'state'
  }
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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 301

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



130
131
132
133
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 111

def self.openapi_types
  {
    :'enabled_for_one_click_payment' => :'Boolean',
    :'customer_email_address' => :'String',
    :'planned_purge_date' => :'Time',
    :'external_id' => :'String',
    :'time_zone' => :'String',
    :'language' => :'String',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'token_reference' => :'String',
    :'customer_id' => :'String',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 270

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



396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 396

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


290
291
292
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 290

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



296
297
298
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 296

def hash
  [enabled_for_one_click_payment, customer_email_address, planned_purge_date, external_id, time_zone, language, created_on, version, linked_space_id, token_reference, customer_id, id, state].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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 205

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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

  pattern = Regexp.new(/[	\x20-\x7e]*/)
  if !@token_reference.nil? && @token_reference !~ pattern
    invalid_properties.push("invalid value for \"token_reference\", must conform to the pattern #{pattern}.")
  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



372
373
374
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 372

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 378

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



366
367
368
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 366

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



226
227
228
229
230
231
232
233
 
# File 'lib/wallee-ruby-sdk/models/token.rb', line 226

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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
  pattern = Regexp.new(/[	\x20-\x7e]*/)
  return false if !@token_reference.nil? && @token_reference !~ pattern
  true
end