Class: TreezorClient::Payout

Inherits:
Object
  • Object
show all
Defined in:
lib/treezor_client/models/payout.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Payout

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
203
204
205
206
207
208
209
210
211
212
213
214
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
# File 'lib/treezor_client/models/payout.rb', line 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'label')
    self.label = attributes[:'label']
  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?(:'partnerFee')
    self.partner_fee = attributes[:'partnerFee']
  end

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

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

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

Instance Attribute Details

#amountObject

Returns the value of attribute amount.


52
53
54
# File 'lib/treezor_client/models/payout.rb', line 52

def amount
  @amount
end

#bankaccount_ibanObject

Returns the value of attribute bankaccount_iban.


48
49
50
# File 'lib/treezor_client/models/payout.rb', line 48

def bankaccount_iban
  @bankaccount_iban
end

#bankaccount_idObject

Returns the value of attribute bankaccount_id.


42
43
44
# File 'lib/treezor_client/models/payout.rb', line 42

def bankaccount_id
  @bankaccount_id
end

#beneficiary_idObject

Returns the value of attribute beneficiary_id.


44
45
46
# File 'lib/treezor_client/models/payout.rb', line 44

def beneficiary_id
  @beneficiary_id
end

#created_dateObject

Date YYYY-MM-DD HH:MM:SS


59
60
61
# File 'lib/treezor_client/models/payout.rb', line 59

def created_date
  @created_date
end

#currencyObject

Returns the value of attribute currency.


54
55
56
# File 'lib/treezor_client/models/payout.rb', line 54

def currency
  @currency
end

#labelObject

Returns the value of attribute label.


50
51
52
# File 'lib/treezor_client/models/payout.rb', line 50

def label
  @label
end

#modified_dateObject

Date YYYY-MM-DD HH:MM:SS


62
63
64
# File 'lib/treezor_client/models/payout.rb', line 62

def modified_date
  @modified_date
end

#partner_feeObject

Returns the value of attribute partner_fee.


56
57
58
# File 'lib/treezor_client/models/payout.rb', line 56

def partner_fee
  @partner_fee
end

#payout_dateObject

Date YYYY-MM-DD


30
31
32
# File 'lib/treezor_client/models/payout.rb', line 30

def payout_date
  @payout_date
end

#payout_idObject

Returns the value of attribute payout_id.


17
18
19
# File 'lib/treezor_client/models/payout.rb', line 17

def payout_id
  @payout_id
end

#payout_statusObject

Returns the value of attribute payout_status.


21
22
23
# File 'lib/treezor_client/models/payout.rb', line 21

def payout_status
  @payout_status
end

#payout_tagObject

Returns the value of attribute payout_tag.


19
20
21
# File 'lib/treezor_client/models/payout.rb', line 19

def payout_tag
  @payout_tag
end

#payout_typeObject

Returns the value of attribute payout_type.


25
26
27
# File 'lib/treezor_client/models/payout.rb', line 25

def payout_type
  @payout_type
end

#payout_type_idObject

Returns the value of attribute payout_type_id.


23
24
25
# File 'lib/treezor_client/models/payout.rb', line 23

def payout_type_id
  @payout_type_id
end

#total_rowsObject

Returns the value of attribute total_rows.


64
65
66
# File 'lib/treezor_client/models/payout.rb', line 64

def total_rows
  @total_rows
end

#unique_mandate_referenceObject

Returns the value of attribute unique_mandate_reference.


46
47
48
# File 'lib/treezor_client/models/payout.rb', line 46

def unique_mandate_reference
  @unique_mandate_reference
end

#user_firstnameObject

Returns the value of attribute user_firstname.


36
37
38
# File 'lib/treezor_client/models/payout.rb', line 36

def user_firstname
  @user_firstname
end

#user_idObject

Returns the value of attribute user_id.


40
41
42
# File 'lib/treezor_client/models/payout.rb', line 40

def user_id
  @user_id
end

#user_lastnameObject

Returns the value of attribute user_lastname.


38
39
40
# File 'lib/treezor_client/models/payout.rb', line 38

def user_lastname
  @user_lastname
end

#wallet_aliasObject

Returns the value of attribute wallet_alias.


34
35
36
# File 'lib/treezor_client/models/payout.rb', line 34

def wallet_alias
  @wallet_alias
end

#wallet_event_nameObject

Returns the value of attribute wallet_event_name.


32
33
34
# File 'lib/treezor_client/models/payout.rb', line 32

def wallet_event_name
  @wallet_event_name
end

#wallet_idObject

Returns the value of attribute wallet_id.


27
28
29
# File 'lib/treezor_client/models/payout.rb', line 27

def wallet_id
  @wallet_id
end

Class Method Details

.attribute_mapObject

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


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
# File 'lib/treezor_client/models/payout.rb', line 89

def self.attribute_map
  {
    :'payout_id' => :'payoutId',
    :'payout_tag' => :'payoutTag',
    :'payout_status' => :'payoutStatus',
    :'payout_type_id' => :'payoutTypeId',
    :'payout_type' => :'payoutType',
    :'wallet_id' => :'walletId',
    :'payout_date' => :'payoutDate',
    :'wallet_event_name' => :'walletEventName',
    :'wallet_alias' => :'walletAlias',
    :'user_firstname' => :'userFirstname',
    :'user_lastname' => :'userLastname',
    :'user_id' => :'userId',
    :'bankaccount_id' => :'bankaccountId',
    :'beneficiary_id' => :'beneficiaryId',
    :'unique_mandate_reference' => :'uniqueMandateReference',
    :'bankaccount_iban' => :'bankaccountIBAN',
    :'label' => :'label',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'partner_fee' => :'partnerFee',
    :'created_date' => :'createdDate',
    :'modified_date' => :'modifiedDate',
    :'total_rows' => :'totalRows'
  }
end

.swagger_typesObject

Attribute type mapping.


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
# File 'lib/treezor_client/models/payout.rb', line 118

def self.swagger_types
  {
    :'payout_id' => :'Integer',
    :'payout_tag' => :'String',
    :'payout_status' => :'String',
    :'payout_type_id' => :'Integer',
    :'payout_type' => :'String',
    :'wallet_id' => :'Integer',
    :'payout_date' => :'String',
    :'wallet_event_name' => :'String',
    :'wallet_alias' => :'String',
    :'user_firstname' => :'String',
    :'user_lastname' => :'String',
    :'user_id' => :'Integer',
    :'bankaccount_id' => :'Integer',
    :'beneficiary_id' => :'Integer',
    :'unique_mandate_reference' => :'String',
    :'bankaccount_iban' => :'String',
    :'label' => :'String',
    :'amount' => :'String',
    :'currency' => :'String',
    :'partner_fee' => :'String',
    :'created_date' => :'String',
    :'modified_date' => :'String',
    :'total_rows' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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
# File 'lib/treezor_client/models/payout.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      payout_id == o.payout_id &&
      payout_tag == o.payout_tag &&
      payout_status == o.payout_status &&
      payout_type_id == o.payout_type_id &&
      payout_type == o.payout_type &&
      wallet_id == o.wallet_id &&
      payout_date == o.payout_date &&
      wallet_event_name == o.wallet_event_name &&
      wallet_alias == o.wallet_alias &&
      user_firstname == o.user_firstname &&
      user_lastname == o.user_lastname &&
      user_id == o.user_id &&
      bankaccount_id == o.bankaccount_id &&
      beneficiary_id == o.beneficiary_id &&
      unique_mandate_reference == o.unique_mandate_reference &&
      bankaccount_iban == o.bankaccount_iban &&
      label == o.label &&
      amount == o.amount &&
      currency == o.currency &&
      partner_fee == o.partner_fee &&
      created_date == o.created_date &&
      modified_date == o.modified_date &&
      total_rows == o.total_rows
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


350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/treezor_client/models/payout.rb', line 350

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


416
417
418
419
420
421
422
423
424
425
426
427
428
# File 'lib/treezor_client/models/payout.rb', line 416

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


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/treezor_client/models/payout.rb', line 329

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

316
317
318
# File 'lib/treezor_client/models/payout.rb', line 316

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


322
323
324
# File 'lib/treezor_client/models/payout.rb', line 322

def hash
  [payout_id, payout_tag, payout_status, payout_type_id, payout_type, wallet_id, payout_date, wallet_event_name, wallet_alias, user_firstname, user_lastname, user_id, bankaccount_id, beneficiary_id, unique_mandate_reference, bankaccount_iban, label, amount, currency, partner_fee, created_date, modified_date, total_rows].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


249
250
251
252
# File 'lib/treezor_client/models/payout.rb', line 249

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


396
397
398
# File 'lib/treezor_client/models/payout.rb', line 396

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


402
403
404
405
406
407
408
409
410
# File 'lib/treezor_client/models/payout.rb', line 402

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


390
391
392
# File 'lib/treezor_client/models/payout.rb', line 390

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


256
257
258
259
260
261
262
# File 'lib/treezor_client/models/payout.rb', line 256

def valid?
  payout_status_validator = EnumAttributeValidator.new('String', ['PENDING', 'CANCELED', 'VALIDATED'])
  return false unless payout_status_validator.valid?(@payout_status)
  payout_type_validator = EnumAttributeValidator.new('String', ['Credit Transfer', 'Direct Debit'])
  return false unless payout_type_validator.valid?(@payout_type)
  true
end