Class: CyberSource::Ptsv2creditsPointOfSaleInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2creditsPointOfSaleInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 78

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

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

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

  if attributes.has_key?(:'cardholderVerificationMethod')
    if (value = attributes[:'cardholderVerificationMethod']).is_a?(Array)
      self.cardholder_verification_method = value
    end
  end

  if attributes.has_key?(:'terminalInputCapability')
    if (value = attributes[:'terminalInputCapability']).is_a?(Array)
      self.terminal_input_capability = value
    end
  end

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

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

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

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

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

Instance Attribute Details

#cardholder_verification_method ⇒ Object

Returns the value of attribute cardholder_verification_method.



25
26
27
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 25

def cardholder_verification_method
  @cardholder_verification_method
end

#device_id ⇒ Object

Value created by the client software that uniquely identifies the POS device. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX.



42
43
44
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 42

def device_id
  @device_id
end

#emv ⇒ Object

Returns the value of attribute emv.



17
18
19
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 17

def emv
  @emv
end

#partner_sdk_version ⇒ Object

Version of the software installed on the POS terminal. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX.



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 20

def partner_sdk_version
  @partner_sdk_version
end

#store_and_forward_indicator ⇒ Object

When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. Possible values: - Y: Transaction was stored and then forwarded. - N (default): Transaction was not stored and then forwarded. This field is supported only on American Express Direct, FDC Nashville Global, and SIX.



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 23

def store_and_forward_indicator
  @store_and_forward_indicator
end

#terminal_card_capture_capability ⇒ Object

Indicates whether the terminal can capture the card. Possible values: - 1: Terminal can capture card. - 0: Terminal cannot capture card. This field is supported only on American Express Direct.



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 33

def terminal_card_capture_capability
  @terminal_card_capture_capability
end

#terminal_input_capability ⇒ Object

Returns the value of attribute terminal_input_capability.



27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 27

def terminal_input_capability
  @terminal_input_capability
end

#terminal_output_capability ⇒ Object

Indicates whether the terminal can print or display messages. Possible values: - 1: Neither - 2: Print only - 3: Display only - 4: Print and display This field is supported only on American Express Direct.



36
37
38
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 36

def terminal_output_capability
  @terminal_output_capability
end

#terminal_pin_capability ⇒ Object

Maximum PIN length that the terminal can capture. Possible values: - 0: No PIN capture capability - 1: PIN capture capability unknown - 4: Four characters - 5: Five characters - 6: Six characters - 7: Seven characters - 8: Eight characters - 9: Nine characters - 10: Ten characters - 11: Eleven characters - 12: Twelve characters This field is supported only on American Express Direct and SIX.



39
40
41
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 39

def terminal_pin_capability
  @terminal_pin_capability
end

#terminal_serial_number ⇒ Object

Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. For details, see the ‘terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



30
31
32
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 30

def terminal_serial_number
  @terminal_serial_number
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 45

def self.attribute_map
  {
    :'emv' => :'emv',
    :'partner_sdk_version' => :'partnerSdkVersion',
    :'store_and_forward_indicator' => :'storeAndForwardIndicator',
    :'cardholder_verification_method' => :'cardholderVerificationMethod',
    :'terminal_input_capability' => :'terminalInputCapability',
    :'terminal_serial_number' => :'terminalSerialNumber',
    :'terminal_card_capture_capability' => :'terminalCardCaptureCapability',
    :'terminal_output_capability' => :'terminalOutputCapability',
    :'terminal_pin_capability' => :'terminalPinCapability',
    :'device_id' => :'deviceId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 61

def self.swagger_types
  {
    :'emv' => :'Ptsv2creditsPointOfSaleInformationEmv',
    :'partner_sdk_version' => :'String',
    :'store_and_forward_indicator' => :'String',
    :'cardholder_verification_method' => :'Array<String>',
    :'terminal_input_capability' => :'Array<String>',
    :'terminal_serial_number' => :'String',
    :'terminal_card_capture_capability' => :'String',
    :'terminal_output_capability' => :'String',
    :'terminal_pin_capability' => :'Integer',
    :'device_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      emv == o.emv &&
      partner_sdk_version == o.partner_sdk_version &&
      store_and_forward_indicator == o.store_and_forward_indicator &&
      cardholder_verification_method == o.cardholder_verification_method &&
      terminal_input_capability == o.terminal_input_capability &&
      terminal_serial_number == o.terminal_serial_number &&
      terminal_card_capture_capability == o.terminal_card_capture_capability &&
      terminal_output_capability == o.terminal_output_capability &&
      terminal_pin_capability == o.terminal_pin_capability &&
      device_id == o.device_id
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 285

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 351

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 264

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


251
252
253
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 257

def hash
  [emv, partner_sdk_version, store_and_forward_indicator, cardholder_verification_method, terminal_input_capability, terminal_serial_number, terminal_card_capture_capability, terminal_output_capability, terminal_pin_capability, device_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



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
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  if !@partner_sdk_version.nil? && @partner_sdk_version.to_s.length > 32
    invalid_properties.push('invalid value for "partner_sdk_version", the character length must be smaller than or equal to 32.')
  end

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

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

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

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

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



331
332
333
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 331

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



337
338
339
340
341
342
343
344
345
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 337

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



325
326
327
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 325

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



162
163
164
165
166
167
168
169
170
 
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb', line 162

def valid?
  return false if !@partner_sdk_version.nil? && @partner_sdk_version.to_s.length > 32
  return false if !@store_and_forward_indicator.nil? && @store_and_forward_indicator.to_s.length > 1
  return false if !@terminal_serial_number.nil? && @terminal_serial_number.to_s.length > 32
  return false if !@terminal_card_capture_capability.nil? && @terminal_card_capture_capability.to_s.length > 1
  return false if !@terminal_output_capability.nil? && @terminal_output_capability.to_s.length > 1
  return false if !@device_id.nil? && @device_id.to_s.length > 32
  true
end