Class: PCPServerSDK::CardPaymentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/PCP-server-Ruby-SDK/models/card_payment_details.rb

Overview

Information for card payments realized at a POS.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardPaymentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
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
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PCPServerSDK::CardPaymentDetails` 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|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PCPServerSDK::CardPaymentDetails`. 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?(:'masked_card_number')
    self.masked_card_number = attributes[:'masked_card_number']
  end

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

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

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

Instance Attribute Details

#card_authorization_id ⇒ Object

Identifier for a successful authorization, reversal or refund. Usually provided by the issuer system. Only provided for card payments.



29
30
31
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 29

def card_authorization_id
  @card_authorization_id
end

#masked_card_number ⇒ Object

Reference to the card of the transaction.



20
21
22
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 20

def masked_card_number
  @masked_card_number
end

#payment_processing_token ⇒ Object

ID of the token. This property is populated when the payment was done with a token.



23
24
25
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 23

def payment_processing_token
  @payment_processing_token
end

#reporting_token ⇒ Object

Token to identify the card in the reporting.



26
27
28
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 26

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 235

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



42
43
44
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 32

def self.attribute_map
  {
    :'masked_card_number' => :'maskedCardNumber',
    :'payment_processing_token' => :'paymentProcessingToken',
    :'reporting_token' => :'reportingToken',
    :'card_authorization_id' => :'cardAuthorizationId'
  }
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 211

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



57
58
59
60
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 47

def self.openapi_types
  {
    :'masked_card_number' => :'String',
    :'payment_processing_token' => :'String',
    :'reporting_token' => :'String',
    :'card_authorization_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



187
188
189
190
191
192
193
194
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 187

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      masked_card_number == o.masked_card_number &&
      payment_processing_token == o.payment_processing_token &&
      reporting_token == o.reporting_token &&
      card_authorization_id == o.card_authorization_id
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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 306

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


198
199
200
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 204

def hash
  [masked_card_number, payment_processing_token, reporting_token, card_authorization_id].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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 96

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@masked_card_number.nil? && @masked_card_number.to_s.length > 40
    invalid_properties.push('invalid value for "masked_card_number", the character length must be smaller than or equal to 40.')
  end

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

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

  if !@card_authorization_id.nil? && @card_authorization_id.to_s.length > 8
    invalid_properties.push('invalid value for "card_authorization_id", the character length must be smaller than or equal to 8.')
  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



282
283
284
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 288

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



276
277
278
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 276

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



120
121
122
123
124
125
126
127
 
# File 'lib/PCP-server-Ruby-SDK/models/card_payment_details.rb', line 120

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@masked_card_number.nil? && @masked_card_number.to_s.length > 40
  return false if !@payment_processing_token.nil? && @payment_processing_token.to_s.length > 40
  return false if !@reporting_token.nil? && @reporting_token.to_s.length > 40
  return false if !@card_authorization_id.nil? && @card_authorization_id.to_s.length > 8
  true
end