Class: CyberSourceMergedSpec::PayoutsOptions1

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

Overview

PayoutsOptions1 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(retrieval_reference_number: SKIP, additional_properties: nil) ⇒ PayoutsOptions1

Returns a new instance of PayoutsOptions1.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 41

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

  unless retrieval_reference_number == SKIP
    @retrieval_reference_number =
      retrieval_reference_number
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#retrieval_reference_number ⇒ String

This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. Recommended format: ydddhhnnnnnn Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant.

Returns:

  • (String) 


20
21
22
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 20

def retrieval_reference_number
  @retrieval_reference_number
end

Class Method Details

.from_element(root) ⇒ Object 



72
73
74
75
76
77
78
79
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 72

def self.from_element(root)
  retrieval_reference_number = XmlUtilities.from_element(
    root, 'retrievalReferenceNumber', String
  )

  new(retrieval_reference_number: retrieval_reference_number,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 53

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  retrieval_reference_number =
    hash.key?('retrievalReferenceNumber') ? hash['retrievalReferenceNumber'] : 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.
  PayoutsOptions1.new(retrieval_reference_number: retrieval_reference_number,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 23

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['retrieval_reference_number'] = 'retrievalReferenceNumber'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
33
34
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 30

def self.optionals
  %w[
    retrieval_reference_number
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



100
101
102
103
104
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 100

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



93
94
95
96
97
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 93

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

#to_xml_element(doc, root_name) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/cyber_source_merged_spec/models/payouts_options1.rb', line 81

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

  XmlUtilities.add_as_subelement(doc, root, 'retrievalReferenceNumber',
                                 retrieval_reference_number)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end