Class: Wallee::PaymentAppChargeAttemptUpdateRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb

Overview

The charge attempt update request allows to change the state of a charge attempt. The charge attempt must be linked with a processor that was created by the payment Web App that invokes the operation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentAppChargeAttemptUpdateRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 62

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

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

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

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

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

Instance Attribute Details

#charge_attempt_id ⇒ Object

This is the ID of the charge attempt that should be updated.



24
25
26
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 24

def charge_attempt_id
  @charge_attempt_id
end

#end_user_failure_message ⇒ Object

The end user failure message indicates to the end user (buyer) why the payment failed. The message has to be in the language of the end user. The language is provided within the payment page invocation URL.



27
28
29
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 27

def end_user_failure_message
  @end_user_failure_message
end

#failure_reason_id ⇒ Object

The failure reason indicates why the charge attempt failed. It is required when the target state is FAILED.



30
31
32
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 30

def failure_reason_id
  @failure_reason_id
end

#reference ⇒ Object

The reference identifies the charge attempt within the systems of the external service provider. It is required when the target state is SUCCESSFUL.



33
34
35
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 33

def reference
  @reference
end

#target_state ⇒ Object

The target state defines the state into which the charge attempt should be switched into. Once the charge attempt changed the state it will not be possible to change it again.



36
37
38
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 36

def target_state
  @target_state
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 39

def self.attribute_map
  {
    :'charge_attempt_id' => :'chargeAttemptId',
    :'end_user_failure_message' => :'endUserFailureMessage',
    :'failure_reason_id' => :'failureReasonId',
    :'reference' => :'reference',
    :'target_state' => :'targetState'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 50

def self.swagger_types
  {
    :'charge_attempt_id' => :'Integer',
    :'end_user_failure_message' => :'String',
    :'failure_reason_id' => :'Integer',
    :'reference' => :'String',
    :'target_state' => :'PaymentAppChargeAttemptTargetState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



134
135
136
137
138
139
140
141
142
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 134

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      charge_attempt_id == o.charge_attempt_id &&
      end_user_failure_message == o.end_user_failure_message &&
      failure_reason_id == o.failure_reason_id &&
      reference == o.reference &&
      target_state == o.target_state
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



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
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 180

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 = Wallee.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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 246

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 159

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 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


146
147
148
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 152

def hash
  [charge_attempt_id, end_user_failure_message, failure_reason_id, reference, target_state].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



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 91

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

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



226
227
228
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 226

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



232
233
234
235
236
237
238
239
240
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 232

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



220
221
222
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 220

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



106
107
108
109
110
 
# File 'lib/wallee-ruby-sdk/models/payment_app_charge_attempt_update_request.rb', line 106

def valid?
  return false if !@end_user_failure_message.nil? && @end_user_failure_message.to_s.length > 2000
  return false if !@reference.nil? && @reference.to_s.length > 100
  true
end