Class: PostfinancecheckoutRubySdk::TokenCreate

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokenCreate

Initializes the object



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 126

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

  if attributes.key?(:'customer_id')
    self.customer_id = attributes[:'customer_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?(:'external_id')
    self.external_id = attributes[:'external_id']
  else
    self.external_id = nil
  end

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

Instance Attribute Details

#customer_email_address ⇒ Object

The customer’s email address.



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

def customer_email_address
  @customer_email_address
end

#customer_id ⇒ Object

The unique identifier of the customer in the external system.



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

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



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

def external_id
  @external_id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#state ⇒ Object

Returns the value of attribute state.



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

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



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

def token_reference
  @token_reference
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 308

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



88
89
90
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 88

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 93

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 74

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

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 284

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



118
119
120
121
122
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 118

def self.openapi_all_of
  [
  :'AbstractTokenUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'enabled_for_one_click_payment' => :'Boolean',
    :'customer_email_address' => :'String',
    :'token_reference' => :'String',
    :'customer_id' => :'String',
    :'time_zone' => :'String',
    :'language' => :'String',
    :'external_id' => :'String',
    :'state' => :'CreationEntityState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

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 &&
      token_reference == o.token_reference &&
      customer_id == o.customer_id &&
      time_zone == o.time_zone &&
      language == o.language &&
      external_id == o.external_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



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

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

See Also:

  • `==` method


271
272
273
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



277
278
279
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 277

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

#list_invalid_properties ⇒ Object

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 177

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



355
356
357
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 355

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 361

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



349
350
351
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 349

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



202
203
204
205
206
207
208
209
 
# File 'lib/postfinancecheckout-ruby-sdk/models/token_create.rb', line 202

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]*/)
  return false if @external_id.nil?
  true
end