Class: CyberSourceMergedSpec::ClientReferenceInformation62

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/client_reference_information62.rb

Overview

ClientReferenceInformation62 Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(code: SKIP, application_name: SKIP, application_version: SKIP, application_user: SKIP, additional_properties: nil) ⇒ ClientReferenceInformation62

Returns a new instance of ClientReferenceInformation62.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 75

def initialize(code: SKIP, application_name: SKIP,
               application_version: SKIP, application_user: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @code = code unless code == SKIP
  @application_name = application_name unless application_name == SKIP
  @application_version = application_version unless application_version == SKIP
  @application_user = application_user unless application_user == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#application_name ⇒ String

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.

Returns:

  • (String) 


37
38
39
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 37

def application_name
  @application_name
end

#application_user ⇒ String

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.

Returns:

  • (String) 


48
49
50
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 48

def application_user
  @application_user
end

#application_version ⇒ String

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 42

def application_version
  @application_version
end

#code ⇒ String

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.

Returns:

  • (String) 


31
32
33
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 31

def code
  @code
end

Class Method Details

.from_element(root) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 116

def self.from_element(root)
  code = XmlUtilities.from_element(root, 'code', String)
  application_name = XmlUtilities.from_element(root, 'applicationName',
                                               String)
  application_version = XmlUtilities.from_element(root,
                                                  'applicationVersion',
                                                  String)
  application_user = XmlUtilities.from_element(root, 'applicationUser',
                                               String)

  new(code: code,
      application_name: application_name,
      application_version: application_version,
      application_user: application_user,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a 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
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 89

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  code = hash.key?('code') ? hash['code'] : SKIP
  application_name =
    hash.key?('applicationName') ? hash['applicationName'] : SKIP
  application_version =
    hash.key?('applicationVersion') ? hash['applicationVersion'] : SKIP
  application_user =
    hash.key?('applicationUser') ? hash['applicationUser'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ClientReferenceInformation62.new(code: code,
                                   application_name: application_name,
                                   application_version: application_version,
                                   application_user: application_user,
                                   additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



51
52
53
54
55
56
57
58
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 51

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['code'] = 'code'
  @_hash['application_name'] = 'applicationName'
  @_hash['application_version'] = 'applicationVersion'
  @_hash['application_user'] = 'applicationUser'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



71
72
73
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 71

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



61
62
63
64
65
66
67
68
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 61

def self.optionals
  %w[
    code
    application_name
    application_version
    application_user
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



158
159
160
161
162
163
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 158

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} code: #{@code.inspect}, application_name: #{@application_name.inspect},"\
  " application_version: #{@application_version.inspect}, application_user:"\
  " #{@application_user.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



150
151
152
153
154
155
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 150

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} code: #{@code}, application_name: #{@application_name},"\
  " application_version: #{@application_version}, application_user: #{@application_user},"\
  " additional_properties: #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/cyber_source_merged_spec/models/client_reference_information62.rb', line 133

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_as_subelement(doc, root, 'code', code)
  XmlUtilities.add_as_subelement(doc, root, 'applicationName',
                                 application_name)
  XmlUtilities.add_as_subelement(doc, root, 'applicationVersion',
                                 application_version)
  XmlUtilities.add_as_subelement(doc, root, 'applicationUser',
                                 application_user)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end