Class: CyberSourceMergedSpec::RiskV1DecisionsPost201Response

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

Overview

RiskV1DecisionsPost201Response 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(links: SKIP, id: SKIP, submit_time_utc: SKIP, submit_time_local: SKIP, status: SKIP, risk_information: SKIP, payment_information: SKIP, client_reference_information: SKIP, order_information: SKIP, consumer_authentication_information: SKIP, watchlist_screening_information: SKIP, error_information: SKIP, additional_properties: nil) ⇒ RiskV1DecisionsPost201Response

Returns a new instance of RiskV1DecisionsPost201Response.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
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/risk_v1_decisions_post201_response.rb', line 121

def initialize(links: SKIP, id: SKIP, submit_time_utc: SKIP,
               submit_time_local: SKIP, status: SKIP,
               risk_information: SKIP, payment_information: SKIP,
               client_reference_information: SKIP, order_information: SKIP,
               consumer_authentication_information: SKIP,
               watchlist_screening_information: SKIP,
               error_information: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @links = links unless links == SKIP
  @id = id unless id == SKIP
  @submit_time_utc = submit_time_utc unless submit_time_utc == SKIP
  @submit_time_local = submit_time_local unless submit_time_local == SKIP
  @status = status unless status == SKIP
  @risk_information = risk_information unless risk_information == SKIP
  @payment_information = payment_information unless payment_information == SKIP
  unless client_reference_information == SKIP
    @client_reference_information =
      client_reference_information
  end
  @order_information = order_information unless order_information == SKIP
  unless consumer_authentication_information == SKIP
    @consumer_authentication_information =
      consumer_authentication_information
  end
  unless watchlist_screening_information == SKIP
    @watchlist_screening_information =
      watchlist_screening_information
  end
  @error_information = error_information unless error_information == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_reference_information ⇒ ClientReferenceInformation49

Contains response information about the payment.

Returns:



60
61
62
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 60

def client_reference_information
  @client_reference_information
end

#consumer_authentication_information ⇒ ConsumerAuthenticationInformation5

Contains response information about the payment.

Returns:



68
69
70
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 68

def consumer_authentication_information
  @consumer_authentication_information
end

#error_information ⇒ ErrorInformation23

Contains response information about the payment.

Returns:



76
77
78
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 76

def error_information
  @error_information
end

#id ⇒ String

An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response.

Returns:

  • (String) 


22
23
24
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 22

def id
  @id
end

#links ⇒ Links

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 14

def links
  @links
end

#order_information ⇒ OrderInformation36

Contains response information about the payment.

Returns:



64
65
66
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 64

def order_information
  @order_information
end

#payment_information ⇒ PaymentInformation32

Contains response information about the payment.

Returns:



56
57
58
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 56

def payment_information
  @payment_information
end

#risk_information ⇒ RiskInformation1

Contains the result of risk assessment.

Returns:



52
53
54
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 52

def risk_information
  @risk_information
end

#status ⇒ String

The status of the submitted transaction. Possible values:

- `ACCEPTED`
- `REJECTED`
- `PENDING_REVIEW`
- `DECLINED`
- `PENDING_AUTHENTICATION`
- `INVALID_REQUEST`
- `AUTHENTICATION_FAILED`
- `CHALLENGE`

Returns:

  • (String) 


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

def status
  @status
end

#submit_time_local ⇒ String

Time that the transaction was submitted in local time. Generated by Cybersource.

Returns:

  • (String) 


35
36
37
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 35

def submit_time_local
  @submit_time_local
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. Returned by Cybersource for all services.

Returns:

  • (String) 


30
31
32
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 30

def submit_time_utc
  @submit_time_utc
end

#watchlist_screening_information ⇒ WatchlistScreeningInformation1

Contains response information about the payment.

Returns:



72
73
74
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 72

def watchlist_screening_information
  @watchlist_screening_information
end

Class Method Details

.from_element(root) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
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
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 208

def self.from_element(root)
  links = XmlUtilities.from_element(root, 'Links', Links)
  id = XmlUtilities.from_element(root, 'id', String)
  submit_time_utc = XmlUtilities.from_element(root, 'submitTimeUtc', String)
  submit_time_local = XmlUtilities.from_element(root, 'submitTimeLocal',
                                                String)
  status = XmlUtilities.from_element(root, 'status', String)
  risk_information = XmlUtilities.from_element(root, 'RiskInformation1',
                                               RiskInformation1)
  payment_information = XmlUtilities.from_element(root,
                                                  'PaymentInformation32',
                                                  PaymentInformation32)
  client_reference_information = XmlUtilities.from_element(
    root, 'ClientReferenceInformation49',
    ClientReferenceInformation49
  )
  order_information = XmlUtilities.from_element(root, 'OrderInformation36',
                                                OrderInformation36)
  consumer_authentication_information = XmlUtilities.from_element(
    root, 'ConsumerAuthenticationInformation5',
    ConsumerAuthenticationInformation5
  )
  watchlist_screening_information = XmlUtilities.from_element(
    root, 'WatchlistScreeningInformation1',
    WatchlistScreeningInformation1
  )
  error_information = XmlUtilities.from_element(root, 'ErrorInformation23',
                                                ErrorInformation23)

  new(links: links,
      id: id,
      submit_time_utc: submit_time_utc,
      submit_time_local: submit_time_local,
      status: status,
      risk_information: risk_information,
      payment_information: payment_information,
      client_reference_information: client_reference_information,
      order_information: order_information,
      consumer_authentication_information: consumer_authentication_information,
      watchlist_screening_information: watchlist_screening_information,
      error_information: error_information,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 156

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  links = Links.from_hash(hash['_links']) if hash['_links']
  id = hash.key?('id') ? hash['id'] : SKIP
  submit_time_utc =
    hash.key?('submitTimeUtc') ? hash['submitTimeUtc'] : SKIP
  submit_time_local =
    hash.key?('submitTimeLocal') ? hash['submitTimeLocal'] : SKIP
  status = hash.key?('status') ? hash['status'] : SKIP
  risk_information = RiskInformation1.from_hash(hash['riskInformation']) if
    hash['riskInformation']
  payment_information = PaymentInformation32.from_hash(hash['paymentInformation']) if
    hash['paymentInformation']
  if hash['clientReferenceInformation']
    client_reference_information = ClientReferenceInformation49.from_hash(hash['clientReferenceInformation'])
  end
  order_information = OrderInformation36.from_hash(hash['orderInformation']) if
    hash['orderInformation']
  if hash['consumerAuthenticationInformation']
    consumer_authentication_information = ConsumerAuthenticationInformation5.from_hash(hash['consumerAuthenticationInformation'])
  end
  if hash['watchlistScreeningInformation']
    watchlist_screening_information = WatchlistScreeningInformation1.from_hash(hash['watchlistScreeningInformation'])
  end
  error_information = ErrorInformation23.from_hash(hash['errorInformation']) if
    hash['errorInformation']

  # 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.
  RiskV1DecisionsPost201Response.new(links: links,
                                     id: id,
                                     submit_time_utc: submit_time_utc,
                                     submit_time_local: submit_time_local,
                                     status: status,
                                     risk_information: risk_information,
                                     payment_information: payment_information,
                                     client_reference_information: client_reference_information,
                                     order_information: order_information,
                                     consumer_authentication_information: consumer_authentication_information,
                                     watchlist_screening_information: watchlist_screening_information,
                                     error_information: error_information,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 79

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['links'] = '_links'
  @_hash['id'] = 'id'
  @_hash['submit_time_utc'] = 'submitTimeUtc'
  @_hash['submit_time_local'] = 'submitTimeLocal'
  @_hash['status'] = 'status'
  @_hash['risk_information'] = 'riskInformation'
  @_hash['payment_information'] = 'paymentInformation'
  @_hash['client_reference_information'] = 'clientReferenceInformation'
  @_hash['order_information'] = 'orderInformation'
  @_hash['consumer_authentication_information'] =
    'consumerAuthenticationInformation'
  @_hash['watchlist_screening_information'] =
    'watchlistScreeningInformation'
  @_hash['error_information'] = 'errorInformation'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



117
118
119
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 117

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 99

def self.optionals
  %w[
    links
    id
    submit_time_utc
    submit_time_local
    status
    risk_information
    payment_information
    client_reference_information
    order_information
    consumer_authentication_information
    watchlist_screening_information
    error_information
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 298

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} links: #{@links.inspect}, id: #{@id.inspect}, submit_time_utc:"\
  " #{@submit_time_utc.inspect}, submit_time_local: #{@submit_time_local.inspect}, status:"\
  " #{@status.inspect}, risk_information: #{@risk_information.inspect}, payment_information:"\
  " #{@payment_information.inspect}, client_reference_information:"\
  " #{@client_reference_information.inspect}, order_information:"\
  " #{@order_information.inspect}, consumer_authentication_information:"\
  " #{@consumer_authentication_information.inspect}, watchlist_screening_information:"\
  " #{@watchlist_screening_information.inspect}, error_information:"\
  " #{@error_information.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 285

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} links: #{@links}, id: #{@id}, submit_time_utc: #{@submit_time_utc},"\
  " submit_time_local: #{@submit_time_local}, status: #{@status}, risk_information:"\
  " #{@risk_information}, payment_information: #{@payment_information},"\
  " client_reference_information: #{@client_reference_information}, order_information:"\
  " #{@order_information}, consumer_authentication_information:"\
  " #{@consumer_authentication_information}, watchlist_screening_information:"\
  " #{@watchlist_screening_information}, error_information: #{@error_information},"\
  " additional_properties: #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/cyber_source_merged_spec/models/risk_v1_decisions_post201_response.rb', line 252

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

  XmlUtilities.add_as_subelement(doc, root, 'Links', links)
  XmlUtilities.add_as_subelement(doc, root, 'id', id)
  XmlUtilities.add_as_subelement(doc, root, 'submitTimeUtc',
                                 submit_time_utc)
  XmlUtilities.add_as_subelement(doc, root, 'submitTimeLocal',
                                 submit_time_local)
  XmlUtilities.add_as_subelement(doc, root, 'status', status)
  XmlUtilities.add_as_subelement(doc, root, 'RiskInformation1',
                                 risk_information)
  XmlUtilities.add_as_subelement(doc, root, 'PaymentInformation32',
                                 payment_information)
  XmlUtilities.add_as_subelement(doc, root, 'ClientReferenceInformation49',
                                 client_reference_information)
  XmlUtilities.add_as_subelement(doc, root, 'OrderInformation36',
                                 order_information)
  XmlUtilities.add_as_subelement(doc, root,
                                 'ConsumerAuthenticationInformation5',
                                 consumer_authentication_information)
  XmlUtilities.add_as_subelement(doc, root,
                                 'WatchlistScreeningInformation1',
                                 watchlist_screening_information)
  XmlUtilities.add_as_subelement(doc, root, 'ErrorInformation23',
                                 error_information)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end