Class: CyberSource::Ptsv2paymentsidreversalsClientReferenceInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsidreversalsClientReferenceInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 89

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#application_name ⇒ Object

The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.



28
29
30
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 28

def application_name
  @application_name
end

#application_user ⇒ Object

The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.



34
35
36
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 34

def application_user
  @application_user
end

#application_version ⇒ Object

Version of the CyberSource application or integration used for a transaction.



31
32
33
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 31

def application_version
  @application_version
end

#code ⇒ Object

Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by Authorization Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.



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

def code
  @code
end

#comments ⇒ Object

Brief description of the order or any comment you wish to add to the order.



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

def comments
  @comments
end

#partner ⇒ Object

Returns the value of attribute partner.



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

def partner
  @partner
end

#paused_request_id ⇒ Object

Used to resume a transaction that was paused for an order modification rule to allow for payer authentication to complete. To resume and continue with the authorization/decision service flow, call the services and include the request id from the prior decision call.



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

def paused_request_id
  @paused_request_id
end

#reconciliation_id ⇒ Object

Reference number for the transaction. Depending on how your Cybersource account is configured, this value could either be provided in the API request or generated by CyberSource. The actual value used in the request to the processor is provided back to you by Cybersource in the response.



37
38
39
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 37

def reconciliation_id
  @reconciliation_id
end

#transaction_id ⇒ Object

Identifier that you assign to the transaction. Normally generated by a client server to identify a unique API request. Note Use this field only if you want to support merchant-initiated reversal and void operations. #### Used by **Authorization, Authorization Reversal, Capture, Credit, and Void** Optional field. #### PIN Debit For a PIN debit reversal, your request must include a request ID or a merchant transaction identifier. Optional field for PIN debit purchase or credit requests.



40
41
42
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 40

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 43

def self.attribute_map
  {
    :'code' => :'code',
    :'paused_request_id' => :'pausedRequestId',
    :'comments' => :'comments',
    :'partner' => :'partner',
    :'application_name' => :'applicationName',
    :'application_version' => :'applicationVersion',
    :'application_user' => :'applicationUser',
    :'reconciliation_id' => :'reconciliationId',
    :'transaction_id' => :'transactionId'
  }
end

.json_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 58

def self.json_map
  {
    :'code' => :'code',
    :'paused_request_id' => :'paused_request_id',
    :'comments' => :'comments',
    :'partner' => :'partner',
    :'application_name' => :'application_name',
    :'application_version' => :'application_version',
    :'application_user' => :'application_user',
    :'reconciliation_id' => :'reconciliation_id',
    :'transaction_id' => :'transaction_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 73

def self.swagger_types
  {
    :'code' => :'String',
    :'paused_request_id' => :'String',
    :'comments' => :'String',
    :'partner' => :'Ptsv2paymentsidreversalsClientReferenceInformationPartner',
    :'application_name' => :'String',
    :'application_version' => :'String',
    :'application_user' => :'String',
    :'reconciliation_id' => :'String',
    :'transaction_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      paused_request_id == o.paused_request_id &&
      comments == o.comments &&
      partner == o.partner &&
      application_name == o.application_name &&
      application_version == o.application_version &&
      application_user == o.application_user &&
      reconciliation_id == o.reconciliation_id &&
      transaction_id == o.transaction_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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 221

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



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 287

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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 200

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


187
188
189
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



193
194
195
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 193

def hash
  [code, paused_request_id, comments, partner, application_name, application_version, application_user, reconciliation_id, transaction_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



134
135
136
137
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 134

def list_invalid_properties
  invalid_properties = Array.new
  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



267
268
269
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 267

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



273
274
275
276
277
278
279
280
281
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 273

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



261
262
263
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 261

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



141
142
143
 
# File 'lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb', line 141

def valid?
  true
end