Class: CyberSource::Ptsv2paymentsClientReferenceInformationPartner

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsClientReferenceInformationPartner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 51

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

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

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

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

Instance Attribute Details

#developer_id ⇒ Object

Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. Note When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 21

def developer_id
  @developer_id
end

#original_transaction_id ⇒ Object

Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal’s software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal’s software. 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 these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field.



18
19
20
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 18

def original_transaction_id
  @original_transaction_id
end

#solution_id ⇒ Object

Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. Note When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 24

def solution_id
  @solution_id
end

#third_party_certification_number ⇒ Object

Value that identifies the application vendor and application version for a third party gateway. CyberSource provides you with this value during testing and validation. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization, Authorization Reversal, Capture, Credit, Incremental Authorization, and Void** Optional field. #### PIN debit Required field for PIN debit credit, PIN debit purchase, or PIN debit reversal request.



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

def third_party_certification_number
  @third_party_certification_number
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 30

def self.attribute_map
  {
    :'original_transaction_id' => :'originalTransactionId',
    :'developer_id' => :'developerId',
    :'solution_id' => :'solutionId',
    :'third_party_certification_number' => :'thirdPartyCertificationNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 40

def self.swagger_types
  {
    :'original_transaction_id' => :'String',
    :'developer_id' => :'String',
    :'solution_id' => :'String',
    :'third_party_certification_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      original_transaction_id == o.original_transaction_id &&
      developer_id == o.developer_id &&
      solution_id == o.solution_id &&
      third_party_certification_number == o.third_party_certification_number
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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 194

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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 260

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 173

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


160
161
162
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 166

def hash
  [original_transaction_id, developer_id, solution_id, third_party_certification_number].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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 76

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

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

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

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



240
241
242
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 240

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



246
247
248
249
250
251
252
253
254
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 246

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



234
235
236
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 234

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



99
100
101
102
103
104
105
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb', line 99

def valid?
  return false if !@original_transaction_id.nil? && @original_transaction_id.to_s.length > 32
  return false if !@developer_id.nil? && @developer_id.to_s.length > 8
  return false if !@solution_id.nil? && @solution_id.to_s.length > 8
  return false if !@third_party_certification_number.nil? && @third_party_certification_number.to_s.length > 12
  true
end