Class: TransferZero::Transaction

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

Overview

The template of transactions are the following: “‘JSON { "input_currency": // currency to pay in, "sender":{ // details of the sender }, "recipients":[ { "requested_amount": // the amount to pay out, "requested_currency": // the currency of the amount, "payout_method":{ "type": // method of the payout, "details":{ // details of the recipient } } } ], "metadata": // optional metadata } “`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 108

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::Transaction` 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::Transaction`. 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?(:'input_currency')
    self.input_currency = attributes[:'input_currency']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

The time the transaction was created



49
50
51
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 49

def created_at
  @created_at
end

#due_amount ⇒ Object

The amount needed to be paid in for the transaction to get funded



46
47
48
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 46

def due_amount
  @due_amount
end

#errors ⇒ Object

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



60
61
62
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 60

def errors
  @errors
end

#expires_at ⇒ Object

The latest time when the transaction has to be funded, otherwise it will be cancelled



52
53
54
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 52

def expires_at
  @expires_at
end

#external_id ⇒ Object

Optional ID that is supplied by partner linking it to the partner’s own Sender ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not.



55
56
57
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 55

def external_id
  @external_id
end

#id ⇒ Object

Returns the value of attribute id.



57
58
59
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 57

def id
  @id
end

#input_amount ⇒ Object

The amount that was requested in the input currency



37
38
39
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 37

def input_amount
  @input_amount
end

#input_currency ⇒ Object

The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR.



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

def input_currency
  @input_currency
end

#metadata ⇒ Object

Additional metadata to store on the transaction. If you widh to store your local transaction ID, you should add it here inside a ‘sendRef` field, and we will return this value back to you in the daily transaction reports.



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

def metadata
  @metadata
end

The amount that was already paid in to the transaction



43
44
45
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 43

def paid_amount
  @paid_amount
end

#payin_methods ⇒ Object

Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance. For more information please see [Collections from senders](github.com/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation



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

def payin_methods
  @payin_methods
end

#payin_reference ⇒ Object

The reference number that has to be provided in case the transaction is not funded through account balance



40
41
42
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 40

def payin_reference
  @payin_reference
end

#recipients ⇒ Object

The details of where the payment should go. although transactions can support paying out multiple recipients, usually one is provided.



30
31
32
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 30

def recipients
  @recipients
end

#sender ⇒ Object

Returns the value of attribute sender.



27
28
29
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 27

def sender
  @sender
end

#state ⇒ Object

Returns the value of attribute state.



34
35
36
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 34

def state
  @state
end

#traits ⇒ Object

Returns the value of attribute traits.



32
33
34
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 32

def traits
  @traits
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'input_currency' => :'input_currency',
    :'payin_methods' => :'payin_methods',
    :'metadata' => :'metadata',
    :'sender' => :'sender',
    :'recipients' => :'recipients',
    :'traits' => :'traits',
    :'state' => :'state',
    :'input_amount' => :'input_amount',
    :'payin_reference' => :'payin_reference',
    :'paid_amount' => :'paid_amount',
    :'due_amount' => :'due_amount',
    :'created_at' => :'created_at',
    :'expires_at' => :'expires_at',
    :'external_id' => :'external_id',
    :'id' => :'id',
    :'errors' => :'errors'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 85

def self.openapi_types
  {
    :'input_currency' => :'String',
    :'payin_methods' => :'Array<PayinMethod>',
    :'metadata' => :'Object',
    :'sender' => :'Sender',
    :'recipients' => :'Array<Recipient>',
    :'traits' => :'TransactionTraits',
    :'state' => :'TransactionState',
    :'input_amount' => :'Float',
    :'payin_reference' => :'String',
    :'paid_amount' => :'Float',
    :'due_amount' => :'Float',
    :'created_at' => :'DateTime',
    :'expires_at' => :'DateTime',
    :'external_id' => :'String',
    :'id' => :'String',
    :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      input_currency == o.input_currency &&
      payin_methods == o.payin_methods &&
      metadata == o.metadata &&
      sender == o.sender &&
      recipients == o.recipients &&
      traits == o.traits &&
      state == o.state &&
      input_amount == o.input_amount &&
      payin_reference == o.payin_reference &&
      paid_amount == o.paid_amount &&
      due_amount == o.due_amount &&
      created_at == o.created_at &&
      expires_at == o.expires_at &&
      external_id == o.external_id &&
      id == o.id &&
      errors == o.errors
end

#[](key) ⇒ Object 



343
344
345
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 343

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



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/transferzero-sdk/models/transaction.rb', line 281

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



355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 355

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 260

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 



347
348
349
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 347

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 251

def hash
  [input_currency, payin_methods, metadata, sender, recipients, traits, state, input_amount, payin_reference, paid_amount, due_amount, created_at, expires_at, external_id, id, 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



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

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

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

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



327
328
329
 
# File 'lib/transferzero-sdk/models/transaction.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
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 333

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



321
322
323
 
# File 'lib/transferzero-sdk/models/transaction.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



213
214
215
216
217
218
 
# File 'lib/transferzero-sdk/models/transaction.rb', line 213

def valid?
  return false if @input_currency.nil?
  return false if @sender.nil?
  return false if @recipients.nil?
  true
end