Class: Tremendous::Topup

Inherits:
Object
  • Object
show all
Defined in:
lib/tremendous/models/topup.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Topup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/tremendous/models/topup.rb', line 129

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::Topup` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Tremendous::Topup`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

  if attributes.key?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

  if attributes.key?(:'processing_fee')
    self.processing_fee = attributes[:'processing_fee']
  end

  if attributes.key?(:'funding_source_id')
    self.funding_source_id = attributes[:'funding_source_id']
  end

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

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'fully_credited_at')
    self.fully_credited_at = attributes[:'fully_credited_at']
  end

  if attributes.key?(:'rejected_at')
    self.rejected_at = attributes[:'rejected_at']
  end

  if attributes.key?(:'reversed_at')
    self.reversed_at = attributes[:'reversed_at']
  end

  if attributes.key?(:'reversed_reason')
    self.reversed_reason = attributes[:'reversed_reason']
  end

  if attributes.key?(:'idempotency_key')
    self.idempotency_key = attributes[:'idempotency_key']
  end

  if attributes.key?(:'instant_credit_amount')
    self.instant_credit_amount = attributes[:'instant_credit_amount']
  end

  if attributes.key?(:'settled_amount')
    self.settled_amount = attributes[:'settled_amount']
  end

  if attributes.key?(:'expected_settlement_at')
    self.expected_settlement_at = attributes[:'expected_settlement_at']
  end
end

Instance Attribute Details

#amount ⇒ Object

Amount to add to your organization’s balance, denominated in ‘currency_code`.



22
23
24
 
# File 'lib/tremendous/models/topup.rb', line 22

def amount
  @amount
end

#created_at ⇒ Object

Timestamp indicating when the topup object was created (when the request was made).



37
38
39
 
# File 'lib/tremendous/models/topup.rb', line 37

def created_at
  @created_at
end

#currency_code ⇒ Object

Currency of the topup amount. Always matches the organization’s currency.



25
26
27
 
# File 'lib/tremendous/models/topup.rb', line 25

def currency_code
  @currency_code
end

#expected_settlement_at ⇒ Object

Timestamp indicating when the pending amount will be credited to the balance. Null if the topup was fully credited immediately.



61
62
63
 
# File 'lib/tremendous/models/topup.rb', line 61

def expected_settlement_at
  @expected_settlement_at
end

#fully_credited_at ⇒ Object

Timestamp indicating when the topup amount was fully credited to the balance.



40
41
42
 
# File 'lib/tremendous/models/topup.rb', line 40

def fully_credited_at
  @fully_credited_at
end

#funding_source_id ⇒ Object

ID of the funding_source object used for this topup.



31
32
33
 
# File 'lib/tremendous/models/topup.rb', line 31

def funding_source_id
  @funding_source_id
end

#id ⇒ Object

Unique identifier for the topup request.



19
20
21
 
# File 'lib/tremendous/models/topup.rb', line 19

def id
  @id
end

#idempotency_key ⇒ Object

Idempotency key to prevent duplicate requests.



52
53
54
 
# File 'lib/tremendous/models/topup.rb', line 52

def idempotency_key
  @idempotency_key
end

#instant_credit_amount ⇒ Object

Amount credited to the balance immediately. Equals ‘amount` for non-ACH topups or ACH debits fully within instant funding limits. Can be 0 if nothing was credited instantly.



55
56
57
 
# File 'lib/tremendous/models/topup.rb', line 55

def instant_credit_amount
  @instant_credit_amount
end

#processing_fee ⇒ Object

Amount of the processing fee for the topup (typically reserved for credit card topups).



28
29
30
 
# File 'lib/tremendous/models/topup.rb', line 28

def processing_fee
  @processing_fee
end

#rejected_at ⇒ Object

Timestamp indicating when the topup was rejected.



43
44
45
 
# File 'lib/tremendous/models/topup.rb', line 43

def rejected_at
  @rejected_at
end

#reversed_at ⇒ Object

Timestamp indicating when the topup was reversed.



46
47
48
 
# File 'lib/tremendous/models/topup.rb', line 46

def reversed_at
  @reversed_at
end

#reversed_reason ⇒ Object

A sentence explaining why the topup was reversed.



49
50
51
 
# File 'lib/tremendous/models/topup.rb', line 49

def reversed_reason
  @reversed_reason
end

#settled_amount ⇒ Object

Amount that will be available once the settlement period elapses. 0 if nothing is settling.



58
59
60
 
# File 'lib/tremendous/models/topup.rb', line 58

def settled_amount
  @settled_amount
end

#status ⇒ Object

Status of the topup <table> <thead> <tr> <th> Status </th> <th> Description </th> </tr> </thead> <tbody> <tr> <td> created </td> <td> The topup is processing (and may be under review). </td> </tr> <tr> <td> partially_credited </td> <td> Some funds have been credited to the balance. The remainder will be credited by expected_settlement_at. </td> </tr> <tr> <td> fully_credited </td> <td> All funds have been added to the balance. </td> </tr> <tr> <td> reversed </td> <td> The topup was credited, but then reversed due to a chargeback or ACH return. </td> </tr> <tr> <td> rejected </td> <td> The topup was rejected by an admin. </td> </tr> </tbody> </table>



34
35
36
 
# File 'lib/tremendous/models/topup.rb', line 34

def status
  @status
end

Class Method Details

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



280
281
282
283
284
285
286
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
 
# File 'lib/tremendous/models/topup.rb', line 280

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Tremendous.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



85
86
87
 
# File 'lib/tremendous/models/topup.rb', line 85

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/tremendous/models/topup.rb', line 90

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/tremendous/models/topup.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'amount' => :'amount',
    :'currency_code' => :'currency_code',
    :'processing_fee' => :'processing_fee',
    :'funding_source_id' => :'funding_source_id',
    :'status' => :'status',
    :'created_at' => :'created_at',
    :'fully_credited_at' => :'fully_credited_at',
    :'rejected_at' => :'rejected_at',
    :'reversed_at' => :'reversed_at',
    :'reversed_reason' => :'reversed_reason',
    :'idempotency_key' => :'idempotency_key',
    :'instant_credit_amount' => :'instant_credit_amount',
    :'settled_amount' => :'settled_amount',
    :'expected_settlement_at' => :'expected_settlement_at'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/tremendous/models/topup.rb', line 256

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/tremendous/models/topup.rb', line 116

def self.openapi_nullable
  Set.new([
    :'fully_credited_at',
    :'rejected_at',
    :'reversed_at',
    :'reversed_reason',
    :'idempotency_key',
    :'expected_settlement_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/tremendous/models/topup.rb', line 95

def self.openapi_types
  {
    :'id' => :'String',
    :'amount' => :'Float',
    :'currency_code' => :'String',
    :'processing_fee' => :'Float',
    :'funding_source_id' => :'String',
    :'status' => :'String',
    :'created_at' => :'Time',
    :'fully_credited_at' => :'Time',
    :'rejected_at' => :'Time',
    :'reversed_at' => :'Time',
    :'reversed_reason' => :'String',
    :'idempotency_key' => :'String',
    :'instant_credit_amount' => :'Float',
    :'settled_amount' => :'Float',
    :'expected_settlement_at' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/tremendous/models/topup.rb', line 221

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      amount == o.amount &&
      currency_code == o.currency_code &&
      processing_fee == o.processing_fee &&
      funding_source_id == o.funding_source_id &&
      status == o.status &&
      created_at == o.created_at &&
      fully_credited_at == o.fully_credited_at &&
      rejected_at == o.rejected_at &&
      reversed_at == o.reversed_at &&
      reversed_reason == o.reversed_reason &&
      idempotency_key == o.idempotency_key &&
      instant_credit_amount == o.instant_credit_amount &&
      settled_amount == o.settled_amount &&
      expected_settlement_at == o.expected_settlement_at
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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/tremendous/models/topup.rb', line 351

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/tremendous/models/topup.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/tremendous/models/topup.rb', line 249

def hash
  [id, amount, currency_code, processing_fee, funding_source_id, status, created_at, fully_credited_at, rejected_at, reversed_at, reversed_reason, idempotency_key, instant_credit_amount, settled_amount, expected_settlement_at].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



206
207
208
209
210
 
# File 'lib/tremendous/models/topup.rb', line 206

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



327
328
329
 
# File 'lib/tremendous/models/topup.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/tremendous/models/topup.rb', line 333

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



321
322
323
 
# File 'lib/tremendous/models/topup.rb', line 321

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



214
215
216
217
 
# File 'lib/tremendous/models/topup.rb', line 214

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end