Class: TransferZero::Debit

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/models/debit.rb

Overview

Debits are used to fund transactions from your internal TransferZero balance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Debit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
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
135
 
# File 'lib/transferzero-sdk/models/debit.rb', line 81

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Hash)
      self.errors = value
    end
  end
end

Instance Attribute Details

#amount ⇒ Object

The amount to be debited from your account. The "amount" parameter is optional - - if included, it must equal the amount required to fund the transaction. - if omitted, it will default to the amount required to fund the transaction.



19
20
21
 
# File 'lib/transferzero-sdk/models/debit.rb', line 19

def amount
  @amount
end

#created_at ⇒ Object

Date and time that the debit was created



36
37
38
 
# File 'lib/transferzero-sdk/models/debit.rb', line 36

def created_at
  @created_at
end

#currency ⇒ Object

The currency of the amount in 3-character alpha ISO 4217 currency format. The "currency" parameter is optional - if omitted, it will default to the payin currency of the transaction. - it can be added in as an additional check to ensure that the expected currency is used. (an error will be given back if it does not match up with the payin currency of the transaction)



22
23
24
 
# File 'lib/transferzero-sdk/models/debit.rb', line 22

def currency
  @currency
end

#errors ⇒ Object

The fields that have some problems and don’t pass validation



45
46
47
 
# File 'lib/transferzero-sdk/models/debit.rb', line 45

def errors
  @errors
end

#id ⇒ Object

Returns the value of attribute id.



33
34
35
 
# File 'lib/transferzero-sdk/models/debit.rb', line 33

def id
  @id
end

#metadata ⇒ Object

Metadata of account debit



31
32
33
 
# File 'lib/transferzero-sdk/models/debit.rb', line 31

def metadata
  @metadata
end

#running_balance ⇒ Object

The total amount remaining in your account after the debit call



42
43
44
 
# File 'lib/transferzero-sdk/models/debit.rb', line 42

def running_balance
  @running_balance
end

#to_id ⇒ Object

The ID of the resource the debit is funding



28
29
30
 
# File 'lib/transferzero-sdk/models/debit.rb', line 28

def to_id
  @to_id
end

#to_type ⇒ Object

Describes what the debit is funding



25
26
27
 
# File 'lib/transferzero-sdk/models/debit.rb', line 25

def to_type
  @to_type
end

#usd_amount ⇒ Object

The amount to be debited from your account converted to USD



39
40
41
 
# File 'lib/transferzero-sdk/models/debit.rb', line 39

def usd_amount
  @usd_amount
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/transferzero-sdk/models/debit.rb', line 48

def self.attribute_map
  {
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'to_type' => :'to_type',
    :'to_id' => :'to_id',
    :'metadata' => :'metadata',
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'usd_amount' => :'usd_amount',
    :'running_balance' => :'running_balance',
    :'errors' => :'errors'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/transferzero-sdk/models/debit.rb', line 64

def self.openapi_types
  {
    :'amount' => :'Float',
    :'currency' => :'String',
    :'to_type' => :'String',
    :'to_id' => :'String',
    :'metadata' => :'Object',
    :'id' => :'String',
    :'created_at' => :'DateTime',
    :'usd_amount' => :'Float',
    :'running_balance' => :'Float',
    :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/transferzero-sdk/models/debit.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      currency == o.currency &&
      to_type == o.to_type &&
      to_id == o.to_id &&
      metadata == o.metadata &&
      id == o.id &&
      created_at == o.created_at &&
      usd_amount == o.usd_amount &&
      running_balance == o.running_balance &&
      errors == o.errors
end

#[](key) ⇒ Object 



277
278
279
 
# File 'lib/transferzero-sdk/models/debit.rb', line 277

def [](key)
  to_hash[key]
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/transferzero-sdk/models/debit.rb', line 215

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/transferzero-sdk/models/debit.rb', line 289

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

Returns the model itself

Returns:

  • (Object) —

    Returns the model itself



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/transferzero-sdk/models/debit.rb', line 194

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

#dig(*args) ⇒ Object 



281
282
283
 
# File 'lib/transferzero-sdk/models/debit.rb', line 281

def dig(*args)
  to_hash.dig(*args)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


179
180
181
 
# File 'lib/transferzero-sdk/models/debit.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



185
186
187
 
# File 'lib/transferzero-sdk/models/debit.rb', line 185

def hash
  [amount, currency, to_type, to_id, metadata, id, created_at, usd_amount, running_balance, errors].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



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/transferzero-sdk/models/debit.rb', line 139

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

  if @to_id.nil?
    invalid_properties.push('invalid value for "to_id", to_id cannot be nil.')
  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



261
262
263
 
# File 'lib/transferzero-sdk/models/debit.rb', line 261

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



267
268
269
270
271
272
273
274
275
 
# File 'lib/transferzero-sdk/models/debit.rb', line 267

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
  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



255
256
257
 
# File 'lib/transferzero-sdk/models/debit.rb', line 255

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



154
155
156
157
158
 
# File 'lib/transferzero-sdk/models/debit.rb', line 154

def valid?
  return false if @to_type.nil?
  return false if @to_id.nil?
  true
end