Class: CybridApiBank::TransferBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransferBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 170

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The actual amount in base units of the asset.



49
50
51
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 49

def amount
  @amount
end

#asset ⇒ Object

The asset the transfer is related to, e.g., USD.



37
38
39
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 37

def asset
  @asset
end

#bank_guid ⇒ Object

The associated bank’s identifier.



25
26
27
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 25

def bank_guid
  @bank_guid
end

#created_at ⇒ Object

ISO8601 datetime the bank was created at.



73
74
75
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 73

def created_at
  @created_at
end

#customer_guid ⇒ Object

The associated customer’s identifier.



28
29
30
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 28

def customer_guid
  @customer_guid
end

#estimated_amount ⇒ Object

The estimated amount in base units of the asset.



52
53
54
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 52

def estimated_amount
  @estimated_amount
end

#estimated_network_fee ⇒ Object

The estimated network fee in base units of network_fee_asset. Only present on ‘crypto` transfers.



58
59
60
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 58

def estimated_network_fee
  @estimated_network_fee
end

#external_bank_account_guid ⇒ Object

The associated external bank account’s identifier.



34
35
36
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 34

def 
  @external_bank_account_guid
end

#failure_code ⇒ Object

The failure code for failed transfers.



46
47
48
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 46

def failure_code
  @failure_code
end

#fee ⇒ Object

The fee associated with the transfer.



55
56
57
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 55

def fee
  @fee
end

#guid ⇒ Object

Auto-generated unique identifier for the transfer.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 19

def guid
  @guid
end

#network_fee ⇒ Object

The actual network fee in base units of network_fee_asset. Only present on ‘crypto` transfers that have successfully completed.



61
62
63
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 61

def network_fee
  @network_fee
end

#network_fee_asset ⇒ Object

The asset code of the network fee. Only present on ‘crypto` transfers that have successfully completed.



64
65
66
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 64

def network_fee_asset
  @network_fee_asset
end

#network_fee_liability_amount ⇒ Object

The equivalent fiat network fee in base units of network_fee_liability_amount_asset. Only present on ‘crypto` transfers that have successfully completed.



67
68
69
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 67

def network_fee_liability_amount
  @network_fee_liability_amount
end

#network_fee_liability_amount_asset ⇒ Object

The fiat asset the network_fee_liability_amount is denominated in. Only present on ‘crypto` transfers that have successfully completed.



70
71
72
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 70

def network_fee_liability_amount_asset
  @network_fee_liability_amount_asset
end

#quote_guid ⇒ Object

The associated quote’s identifier.



31
32
33
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 31

def quote_guid
  @quote_guid
end

#side ⇒ Object

The direction of the quote: ‘deposit’ or ‘withdrawal’.



40
41
42
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 40

def side
  @side
end

#state ⇒ Object

The transfer’s state



43
44
45
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 43

def state
  @state
end

#transfer_type ⇒ Object

The type of transfer.



22
23
24
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 22

def transfer_type
  @transfer_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



123
124
125
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 123

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 98

def self.attribute_map
  {
    :'guid' => :'guid',
    :'transfer_type' => :'transfer_type',
    :'bank_guid' => :'bank_guid',
    :'customer_guid' => :'customer_guid',
    :'quote_guid' => :'quote_guid',
    :'external_bank_account_guid' => :'external_bank_account_guid',
    :'asset' => :'asset',
    :'side' => :'side',
    :'state' => :'state',
    :'failure_code' => :'failure_code',
    :'amount' => :'amount',
    :'estimated_amount' => :'estimated_amount',
    :'fee' => :'fee',
    :'estimated_network_fee' => :'estimated_network_fee',
    :'network_fee' => :'network_fee',
    :'network_fee_asset' => :'network_fee_asset',
    :'network_fee_liability_amount' => :'network_fee_liability_amount',
    :'network_fee_liability_amount_asset' => :'network_fee_liability_amount_asset',
    :'created_at' => :'created_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



494
495
496
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 494

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 153

def self.openapi_nullable
  Set.new([
    :'bank_guid',
    :'customer_guid',
    :'external_bank_account_guid',
    :'failure_code',
    :'amount',
    :'estimated_network_fee',
    :'network_fee',
    :'network_fee_asset',
    :'network_fee_liability_amount',
    :'network_fee_liability_amount_asset',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 128

def self.openapi_types
  {
    :'guid' => :'String',
    :'transfer_type' => :'String',
    :'bank_guid' => :'String',
    :'customer_guid' => :'String',
    :'quote_guid' => :'String',
    :'external_bank_account_guid' => :'String',
    :'asset' => :'String',
    :'side' => :'String',
    :'state' => :'String',
    :'failure_code' => :'String',
    :'amount' => :'Integer',
    :'estimated_amount' => :'Integer',
    :'fee' => :'Integer',
    :'estimated_network_fee' => :'Integer',
    :'network_fee' => :'Integer',
    :'network_fee_asset' => :'String',
    :'network_fee_liability_amount' => :'Integer',
    :'network_fee_liability_amount_asset' => :'String',
    :'created_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 455

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      transfer_type == o.transfer_type &&
      bank_guid == o.bank_guid &&
      customer_guid == o.customer_guid &&
      quote_guid == o.quote_guid &&
       == o. &&
      asset == o.asset &&
      side == o.side &&
      state == o.state &&
      failure_code == o.failure_code &&
      amount == o.amount &&
      estimated_amount == o.estimated_amount &&
      fee == o.fee &&
      estimated_network_fee == o.estimated_network_fee &&
      network_fee == o.network_fee &&
      network_fee_asset == o.network_fee_asset &&
      network_fee_liability_amount == o.network_fee_liability_amount &&
      network_fee_liability_amount_asset == o.network_fee_liability_amount_asset &&
      created_at == o.created_at
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



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 525

def _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 = CybridApiBank.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 596

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



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 501

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


481
482
483
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 481

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



487
488
489
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 487

def hash
  [guid, transfer_type, bank_guid, customer_guid, quote_guid, , asset, side, state, failure_code, amount, estimated_amount, fee, estimated_network_fee, network_fee, network_fee_asset, network_fee_liability_amount, network_fee_liability_amount_asset, created_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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
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
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 262

def list_invalid_properties
  invalid_properties = Array.new
  if !@guid.nil? && @guid.to_s.length > 32
    invalid_properties.push('invalid value for "guid", the character length must be smaller than or equal to 32.')
  end

  if !@guid.nil? && @guid.to_s.length < 32
    invalid_properties.push('invalid value for "guid", the character length must be great than or equal to 32.')
  end

  if !@bank_guid.nil? && @bank_guid.to_s.length > 32
    invalid_properties.push('invalid value for "bank_guid", the character length must be smaller than or equal to 32.')
  end

  if !@bank_guid.nil? && @bank_guid.to_s.length < 32
    invalid_properties.push('invalid value for "bank_guid", the character length must be great than or equal to 32.')
  end

  if !@customer_guid.nil? && @customer_guid.to_s.length > 32
    invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
  end

  if !@customer_guid.nil? && @customer_guid.to_s.length < 32
    invalid_properties.push('invalid value for "customer_guid", the character length must be great than or equal to 32.')
  end

  if !@quote_guid.nil? && @quote_guid.to_s.length > 32
    invalid_properties.push('invalid value for "quote_guid", the character length must be smaller than or equal to 32.')
  end

  if !@quote_guid.nil? && @quote_guid.to_s.length < 32
    invalid_properties.push('invalid value for "quote_guid", the character length must be great than or equal to 32.')
  end

  if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length > 32
    invalid_properties.push('invalid value for "external_bank_account_guid", the character length must be smaller than or equal to 32.')
  end

  if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length < 32
    invalid_properties.push('invalid value for "external_bank_account_guid", the character length must be great than or equal to 32.')
  end

  if !@network_fee_asset.nil? && @network_fee_asset.to_s.length > 8
    invalid_properties.push('invalid value for "network_fee_asset", the character length must be smaller than or equal to 8.')
  end

  if !@network_fee_asset.nil? && @network_fee_asset.to_s.length < 1
    invalid_properties.push('invalid value for "network_fee_asset", the character length must be great than or equal to 1.')
  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



572
573
574
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 572

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



578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 578

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



566
567
568
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 566

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb', line 317

def valid?
  return false if !@guid.nil? && @guid.to_s.length > 32
  return false if !@guid.nil? && @guid.to_s.length < 32
  transfer_type_validator = EnumAttributeValidator.new('String', ["savings", "funding", "book", "crypto", "internal_bank_rebalance", "internal_wallet_rebalance"])
  return false unless transfer_type_validator.valid?(@transfer_type)
  return false if !@bank_guid.nil? && @bank_guid.to_s.length > 32
  return false if !@bank_guid.nil? && @bank_guid.to_s.length < 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
  return false if !@quote_guid.nil? && @quote_guid.to_s.length > 32
  return false if !@quote_guid.nil? && @quote_guid.to_s.length < 32
  return false if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length > 32
  return false if !@external_bank_account_guid.nil? && @external_bank_account_guid.to_s.length < 32
  side_validator = EnumAttributeValidator.new('String', ["deposit", "withdrawal"])
  return false unless side_validator.valid?(@side)
  state_validator = EnumAttributeValidator.new('String', ["storing", "pending", "completed", "failed"])
  return false unless state_validator.valid?(@state)
  return false if !@network_fee_asset.nil? && @network_fee_asset.to_s.length > 8
  return false if !@network_fee_asset.nil? && @network_fee_asset.to_s.length < 1
  true
end