Class: CyberSourceMergedSpec::PullFundsRefund201Response

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

Overview

PullFundsRefund201Response 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(id: SKIP, submit_time_utc: SKIP, status: SKIP, error_information: SKIP, processor_information: SKIP, links: SKIP, additional_properties: nil) ⇒ PullFundsRefund201Response

Returns a new instance of PullFundsRefund201Response.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 88

def initialize(id: SKIP, submit_time_utc: SKIP, status: SKIP,
               error_information: SKIP, processor_information: SKIP,
               links: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @id = id unless id == SKIP
  @submit_time_utc = submit_time_utc unless submit_time_utc == SKIP
  @status = status unless status == SKIP
  @error_information = error_information unless error_information == SKIP
  @processor_information = processor_information unless processor_information == SKIP
  @links = links unless links == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#error_information ⇒ ErrorInformation31

The status of the submitted transaction. Possible values:

  • ACCEPTED
  • DECLINED
  • INVALID_REQUEST

Returns:



41
42
43
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 41

def error_information
  @error_information
end

#id ⇒ String

A unique identification number to identify the submitted request. It is also appended to the endpoint of the resource.

Returns:

  • (String) 


15
16
17
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 15

def id
  @id
end

#links ⇒ Links225

The status of the submitted transaction. Possible values:

  • ACCEPTED
  • DECLINED
  • INVALID_REQUEST

Returns:



57
58
59
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 57

def links
  @links
end

#processor_information ⇒ ProcessorInformation33

The status of the submitted transaction. Possible values:

  • ACCEPTED
  • DECLINED
  • INVALID_REQUEST

Returns:



49
50
51
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 49

def processor_information
  @processor_information
end

#status ⇒ String

The status of the submitted transaction. Possible values:

  • ACCEPTED
  • DECLINED
  • INVALID_REQUEST

Returns:

  • (String) 


33
34
35
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 33

def status
  @status
end

#submit_time_utc ⇒ String

Time of request in UTC. Format: YYYY-MM-DDThh:mm:ssZ Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.

Returns:

  • (String) 


25
26
27
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 25

def submit_time_utc
  @submit_time_utc
end

Class Method Details

.from_element(root) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 135

def self.from_element(root)
  id = XmlUtilities.from_element(root, 'id', String)
  submit_time_utc = XmlUtilities.from_element(root, 'submitTimeUtc', String)
  status = XmlUtilities.from_element(root, 'status', String)
  error_information = XmlUtilities.from_element(root, 'ErrorInformation31',
                                                ErrorInformation31)
  processor_information = XmlUtilities.from_element(
    root, 'ProcessorInformation33', ProcessorInformation33
  )
  links = XmlUtilities.from_element(root, 'Links225', Links225)

  new(id: id,
      submit_time_utc: submit_time_utc,
      status: status,
      error_information: error_information,
      processor_information: processor_information,
      links: links,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
131
132
133
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 104

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  submit_time_utc =
    hash.key?('submitTimeUtc') ? hash['submitTimeUtc'] : SKIP
  status = hash.key?('status') ? hash['status'] : SKIP
  error_information = ErrorInformation31.from_hash(hash['errorInformation']) if
    hash['errorInformation']
  processor_information = ProcessorInformation33.from_hash(hash['processorInformation']) if
    hash['processorInformation']
  links = Links225.from_hash(hash['_links']) if hash['_links']

  # 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.
  PullFundsRefund201Response.new(id: id,
                                 submit_time_utc: submit_time_utc,
                                 status: status,
                                 error_information: error_information,
                                 processor_information: processor_information,
                                 links: links,
                                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['submit_time_utc'] = 'submitTimeUtc'
  @_hash['status'] = 'status'
  @_hash['error_information'] = 'errorInformation'
  @_hash['processor_information'] = 'processorInformation'
  @_hash['links'] = '_links'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



84
85
86
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 84

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    id
    submit_time_utc
    status
    error_information
    processor_information
    links
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



183
184
185
186
187
188
189
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 183

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id.inspect}, submit_time_utc: #{@submit_time_utc.inspect}, status:"\
  " #{@status.inspect}, error_information: #{@error_information.inspect},"\
  " processor_information: #{@processor_information.inspect}, links: #{@links.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



174
175
176
177
178
179
180
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 174

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} id: #{@id}, submit_time_utc: #{@submit_time_utc}, status: #{@status},"\
  " error_information: #{@error_information}, processor_information:"\
  " #{@processor_information}, links: #{@links}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cyber_source_merged_spec/models/pull_funds_refund201_response.rb', line 155

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

  XmlUtilities.add_as_subelement(doc, root, 'id', id)
  XmlUtilities.add_as_subelement(doc, root, 'submitTimeUtc',
                                 submit_time_utc)
  XmlUtilities.add_as_subelement(doc, root, 'status', status)
  XmlUtilities.add_as_subelement(doc, root, 'ErrorInformation31',
                                 error_information)
  XmlUtilities.add_as_subelement(doc, root, 'ProcessorInformation33',
                                 processor_information)
  XmlUtilities.add_as_subelement(doc, root, 'Links225', links)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end