Class: PostfinancecheckoutRubySdk::Token

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-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



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
202
203
204
205
206
207
208
209
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 144

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



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

def created_on
  @created_on
end

#customer_email_address ⇒ Object

The customer’s email address.



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

def customer_email_address
  @customer_email_address
end

#customer_id ⇒ Object

The unique identifier of the customer in the external system.



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

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.



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

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.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

Returns the value of attribute state.



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

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.



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

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).



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

def token_reference
  @token_reference
end

#version ⇒ Object

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



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

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



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
363
364
365
366
367
368
369
370
371
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 334

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



108
109
110
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 108

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 113

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



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

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



137
138
139
140
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 137

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

.openapi_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 118

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 277

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 405

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 303

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 213

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



381
382
383
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 381

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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 387

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



375
376
377
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 375

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



234
235
236
237
238
239
240
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token.rb', line 234

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
  return false if !@token_reference.nil? && @token_reference !~ Regexp.new(/[	\x20-\x7e]*/)
  true
end