Class: CyberSource::PtsV2PayoutsPost201Response

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PayoutsPost201Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 101

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

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

  if attributes.has_key?(:'submitTimeUtc')
    self.submit_time_utc = attributes[:'submitTimeUtc']
  end

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

  if attributes.has_key?(:'reconciliationId')
    self.reconciliation_id = attributes[:'reconciliationId']
  end

  if attributes.has_key?(:'errorInformation')
    self.error_information = attributes[:'errorInformation']
  end

  if attributes.has_key?(:'clientReferenceInformation')
    self.client_reference_information = attributes[:'clientReferenceInformation']
  end

  if attributes.has_key?(:'merchantInformation')
    self.merchant_information = attributes[:'merchantInformation']
  end

  if attributes.has_key?(:'orderInformation')
    self.order_information = attributes[:'orderInformation']
  end

  if attributes.has_key?(:'processorInformation')
    self.processor_information = attributes[:'processorInformation']
  end

  if attributes.has_key?(:'recipientInformation')
    self.recipient_information = attributes[:'recipientInformation']
  end
end

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



17
18
19
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 17

def _links
  @_links
end

#client_reference_information ⇒ Object

Returns the value of attribute client_reference_information.



33
34
35
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 33

def client_reference_information
  @client_reference_information
end

#error_information ⇒ Object

Returns the value of attribute error_information.



31
32
33
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 31

def error_information
  @error_information
end

#id ⇒ Object

An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.



20
21
22
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 20

def id
  @id
end

#merchant_information ⇒ Object

Returns the value of attribute merchant_information.



35
36
37
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 35

def merchant_information
  @merchant_information
end

#order_information ⇒ Object

Returns the value of attribute order_information.



37
38
39
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 37

def order_information
  @order_information
end

#processor_information ⇒ Object

Returns the value of attribute processor_information.



39
40
41
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 39

def processor_information
  @processor_information
end

#recipient_information ⇒ Object

Returns the value of attribute recipient_information.



41
42
43
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 41

def recipient_information
  @recipient_information
end

#reconciliation_id ⇒ Object

Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is This value is used for reconciliation purposes.



29
30
31
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 29

def reconciliation_id
  @reconciliation_id
end

#status ⇒ Object

The status of the submitted transaction. Possible values: - ACCEPTED - DECLINED - INVALID_REQUEST



26
27
28
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 26

def status
  @status
end

#submit_time_utc ⇒ Object

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.



23
24
25
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 23

def submit_time_utc
  @submit_time_utc
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 66

def self.attribute_map
  {
    :'_links' => :'_links',
    :'id' => :'id',
    :'submit_time_utc' => :'submitTimeUtc',
    :'status' => :'status',
    :'reconciliation_id' => :'reconciliationId',
    :'error_information' => :'errorInformation',
    :'client_reference_information' => :'clientReferenceInformation',
    :'merchant_information' => :'merchantInformation',
    :'order_information' => :'orderInformation',
    :'processor_information' => :'processorInformation',
    :'recipient_information' => :'recipientInformation'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 83

def self.swagger_types
  {
    :'_links' => :'PtsV2PaymentsReversalsPost201ResponseLinks',
    :'id' => :'String',
    :'submit_time_utc' => :'String',
    :'status' => :'String',
    :'reconciliation_id' => :'String',
    :'error_information' => :'PtsV2PayoutsPost201ResponseErrorInformation',
    :'client_reference_information' => :'PtsV2PaymentsPost201ResponseClientReferenceInformation',
    :'merchant_information' => :'PtsV2PayoutsPost201ResponseMerchantInformation',
    :'order_information' => :'PtsV2PayoutsPost201ResponseOrderInformation',
    :'processor_information' => :'PtsV2PayoutsPost201ResponseProcessorInformation',
    :'recipient_information' => :'PtsV2PayoutsPost201ResponseRecipientInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      id == o.id &&
      submit_time_utc == o.submit_time_utc &&
      status == o.status &&
      reconciliation_id == o.reconciliation_id &&
      error_information == o.error_information &&
      client_reference_information == o.client_reference_information &&
      merchant_information == o.merchant_information &&
      order_information == o.order_information &&
      processor_information == o.processor_information &&
      recipient_information == o.recipient_information
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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 261

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 327

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 240

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


227
228
229
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 233

def hash
  [_links, id, submit_time_utc, status, reconciliation_id, error_information, client_reference_information, merchant_information, order_information, processor_information, recipient_information].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



154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 154

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

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



307
308
309
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 307

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



313
314
315
316
317
318
319
320
321
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 313

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



301
302
303
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 301

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



169
170
171
172
173
174
175
 
# File 'lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb', line 169

def valid?
  return false if !@id.nil? && @id.to_s.length > 26
  status_validator = EnumAttributeValidator.new('String', ['ACCEPTED', 'DECLINED', 'INVALID_REQUEST'])
  return false unless status_validator.valid?(@status)
  return false if !@reconciliation_id.nil? && @reconciliation_id.to_s.length > 25
  true
end