Class: PostFinanceCheckout::Token

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

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



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 102

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date and time when the object was created.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 24

def created_on
  @created_on
end

#customer_email_address ⇒ Object

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



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

def customer_email_address
  @customer_email_address
end

#customer_id ⇒ Object

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.



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

def customer_id
  @customer_id
end

#enabled_for_one_click_payment ⇒ Object

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.



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

def enabled_for_one_click_payment
  @enabled_for_one_click_payment
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#time_zone ⇒ Object

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.



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

def time_zone
  @time_zone
end

#token_reference ⇒ Object

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



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

def token_reference
  @token_reference
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 63

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

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 82

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



260
261
262
263
264
265
266
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 260

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 326

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 239

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


226
227
228
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



232
233
234
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 232

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



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 163

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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



306
307
308
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 306

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



312
313
314
315
316
317
318
319
320
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 312

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



300
301
302
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 300

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



178
179
180
181
182
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 178

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