Class: PostFinanceCheckout::Charge

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Charge

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 112

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date on which the charge was created on.



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

def created_on
  @created_on
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



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

def failure_reason
  @failure_reason
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



39
40
41
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 39

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#linked_transaction ⇒ Object

Returns the value of attribute linked_transaction.



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

def linked_transaction
  @linked_transaction
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



42
43
44
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 42

def planned_purge_date
  @planned_purge_date
end

#space_view_id ⇒ Object

Returns the value of attribute space_view_id.



45
46
47
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 45

def space_view_id
  @space_view_id
end

#state ⇒ Object

The object’s current state.



48
49
50
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 48

def state
  @state
end

#time_zone ⇒ Object

Returns the value of attribute time_zone.



51
52
53
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 51

def time_zone
  @time_zone
end

#timeout_on ⇒ Object

Returns the value of attribute timeout_on.



54
55
56
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 54

def timeout_on
  @timeout_on
end

#transaction ⇒ Object

Returns the value of attribute transaction.



57
58
59
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 57

def transaction
  @transaction
end

#type ⇒ Object

Returns the value of attribute type.



60
61
62
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 60

def type
  @type
end

#user_failure_message ⇒ Object

The failure message describes for an end user why the charge is failed in the language of the user. This is only provided when the charge is marked as failed.



63
64
65
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 63

def user_failure_message
  @user_failure_message
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



66
67
68
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 66

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 69

def self.attribute_map
  {
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'linked_transaction' => :'linkedTransaction',
    :'created_on' => :'createdOn',
    :'failure_reason' => :'failureReason',
    :'language' => :'language',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'space_view_id' => :'spaceViewId',
    :'state' => :'state',
    :'time_zone' => :'timeZone',
    :'timeout_on' => :'timeoutOn',
    :'transaction' => :'transaction',
    :'type' => :'type',
    :'user_failure_message' => :'userFailureMessage',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 90

def self.swagger_types
  {
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'linked_transaction' => :'Integer',
    :'created_on' => :'DateTime',
    :'failure_reason' => :'FailureReason',
    :'language' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'space_view_id' => :'Integer',
    :'state' => :'ChargeState',
    :'time_zone' => :'String',
    :'timeout_on' => :'DateTime',
    :'transaction' => :'Transaction',
    :'type' => :'ChargeType',
    :'user_failure_message' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      linked_transaction == o.linked_transaction &&
      created_on == o.created_on &&
      failure_reason == o.failure_reason &&
      language == o.language &&
      planned_purge_date == o.planned_purge_date &&
      space_view_id == o.space_view_id &&
      state == o.state &&
      time_zone == o.time_zone &&
      timeout_on == o.timeout_on &&
      transaction == o.transaction &&
      type == o.type &&
      user_failure_message == o.user_failure_message &&
      version == o.version
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



250
251
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
283
284
285
286
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 250

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 316

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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 229

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


216
217
218
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 216

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



222
223
224
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 222

def hash
  [id, linked_space_id, linked_transaction, created_on, failure_reason, language, planned_purge_date, space_view_id, state, time_zone, timeout_on, transaction, type, user_failure_message, version].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



181
182
183
184
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 181

def list_invalid_properties
  invalid_properties = Array.new
  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



296
297
298
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 296

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



302
303
304
305
306
307
308
309
310
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 302

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



290
291
292
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 290

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



188
189
190
 
# File 'lib/postfinancecheckout-ruby-sdk/models/charge.rb', line 188

def valid?
  true
end