Class: ZipMoney::Charge

Inherits:
Object
  • Object
show all
Defined in:
lib/zip_money/models/charge.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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



88
89
90
91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/zip_money/models/charge.rb', line 88

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#amount ⇒ Object

Returns the value of attribute amount.



15
16
17
 
# File 'lib/zip_money/models/charge.rb', line 15

def amount
  @amount
end

#captured_amount ⇒ Object

Returns the value of attribute captured_amount.



21
22
23
 
# File 'lib/zip_money/models/charge.rb', line 21

def captured_amount
  @captured_amount
end

#created_date ⇒ Object

Returns the value of attribute created_date.



26
27
28
 
# File 'lib/zip_money/models/charge.rb', line 26

def created_date
  @created_date
end

#currency ⇒ Object

Returns the value of attribute currency.



17
18
19
 
# File 'lib/zip_money/models/charge.rb', line 17

def currency
  @currency
end

#id ⇒ Object

Returns the value of attribute id.



11
12
13
 
# File 'lib/zip_money/models/charge.rb', line 11

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



30
31
32
 
# File 'lib/zip_money/models/charge.rb', line 30

def metadata
  @metadata
end

#order ⇒ Object

Returns the value of attribute order.



28
29
30
 
# File 'lib/zip_money/models/charge.rb', line 28

def order
  @order
end

#reference ⇒ Object

Returns the value of attribute reference.



13
14
15
 
# File 'lib/zip_money/models/charge.rb', line 13

def reference
  @reference
end

#refunded_amount ⇒ Object

The amount of the charge that has been refunded



24
25
26
 
# File 'lib/zip_money/models/charge.rb', line 24

def refunded_amount
  @refunded_amount
end

#state ⇒ Object

Returns the value of attribute state.



19
20
21
 
# File 'lib/zip_money/models/charge.rb', line 19

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/zip_money/models/charge.rb', line 55

def self.attribute_map
  {
    :'id' => :'id',
    :'reference' => :'reference',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'state' => :'state',
    :'captured_amount' => :'captured_amount',
    :'refunded_amount' => :'refunded_amount',
    :'created_date' => :'created_date',
    :'order' => :'order',
    :'metadata' => :'metadata'
  }
end

.zip_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/zip_money/models/charge.rb', line 71

def self.zip_types
  {
    :'id' => :'String',
    :'reference' => :'String',
    :'amount' => :'Float',
    :'currency' => :'String',
    :'state' => :'String',
    :'captured_amount' => :'Float',
    :'refunded_amount' => :'Float',
    :'created_date' => :'DateTime',
    :'order' => :'ChargeOrder',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/zip_money/models/charge.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      reference == o.reference &&
      amount == o.amount &&
      currency == o.currency &&
      state == o.state &&
      captured_amount == o.captured_amount &&
      refunded_amount == o.refunded_amount &&
      created_date == o.created_date &&
      order == o.order &&
      metadata == o.metadata
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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/zip_money/models/charge.rb', line 287

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/zip_money/models/charge.rb', line 353

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/zip_money/models/charge.rb', line 266

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.zip_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


253
254
255
 
# File 'lib/zip_money/models/charge.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/zip_money/models/charge.rb', line 259

def hash
  [id, reference, amount, currency, state, captured_amount, refunded_amount, created_date, order, metadata].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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/zip_money/models/charge.rb', line 138

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @amount.nil?
    invalid_properties.push("invalid value for 'amount', amount cannot be nil.")
  end

  if @currency.nil?
    invalid_properties.push("invalid value for 'currency', currency cannot be nil.")
  end

  if @state.nil?
    invalid_properties.push("invalid value for 'state', state cannot be nil.")
  end

  if @captured_amount.nil?
    invalid_properties.push("invalid value for 'captured_amount', captured_amount cannot be nil.")
  end

  if @captured_amount < 0
    invalid_properties.push("invalid value for 'captured_amount', must be greater than or equal to 0.")
  end

  if @refunded_amount.nil?
    invalid_properties.push("invalid value for 'refunded_amount', refunded_amount cannot be nil.")
  end

  if @refunded_amount < 0
    invalid_properties.push("invalid value for 'refunded_amount', must be greater than or equal to 0.")
  end

  if @created_date.nil?
    invalid_properties.push("invalid value for 'created_date', created_date cannot be nil.")
  end

  return 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



333
334
335
 
# File 'lib/zip_money/models/charge.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/zip_money/models/charge.rb', line 339

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



327
328
329
 
# File 'lib/zip_money/models/charge.rb', line 327

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/zip_money/models/charge.rb', line 181

def valid?
  return false if @id.nil?
  return false if @amount.nil?
  return false if @currency.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["authorised", "captured", "cancelled", "refunded"])
  return false unless state_validator.valid?(@state)
  return false if @captured_amount.nil?
  return false if @captured_amount < 0
  return false if @refunded_amount.nil?
  return false if @refunded_amount < 0
  return false if @created_date.nil?
  return true
end