Class: CybridApiBank::PostTransferBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/post_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 = {}) ⇒ PostTransferBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 122

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#beneficiary_memo ⇒ Object

The memo to send to the counterparty.



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

def beneficiary_memo
  @beneficiary_memo
end

#customer_guid ⇒ Object

The customer’s identifier.



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

def customer_guid
  @customer_guid
end

#destination_account_guid ⇒ Object

The destination account’s identifier. Required for book transfers.



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

def 
  @destination_account_guid
end

#external_bank_account_guid ⇒ Object

The customer’s ‘plaid’ or ‘plaid_processor_token’ external bank account’s identifier.



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

def 
  @external_bank_account_guid
end

#external_wallet_guid ⇒ Object

The customer’s external wallet’s identifier.



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

def external_wallet_guid
  @external_wallet_guid
end

#labels ⇒ Object

The labels associated with the transfer.



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

def labels
  @labels
end

#network_fee_account_guid ⇒ Object

The network fee account’s identifier. Required for network fee transfers. Must be the identifier for the customer’s or bank’s fiat account. For customer’s to pay the network fees, include the customer’s fiat account guid. For bank’s to pay the network fees, include the bank’s fiat account guid.



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

def 
  @network_fee_account_guid
end

#payment_rail ⇒ Object

The desired payment rail to initiate the transfer for. Valid values are: ach, eft, wire. Valid for funding transfers only.



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

def payment_rail
  @payment_rail
end

#quote_guid ⇒ Object

The associated quote’s identifier.



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

def quote_guid
  @quote_guid
end

#source_account_guid ⇒ Object

The source account’s identifier. Required for book transfers.



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

def 
  @source_account_guid
end

#transfer_type ⇒ Object

The type of transfer.



22
23
24
 
# File 'lib/cybrid_api_bank_ruby/models/post_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



91
92
93
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 74

def self.attribute_map
  {
    :'quote_guid' => :'quote_guid',
    :'transfer_type' => :'transfer_type',
    :'customer_guid' => :'customer_guid',
    :'source_account_guid' => :'source_account_guid',
    :'destination_account_guid' => :'destination_account_guid',
    :'external_wallet_guid' => :'external_wallet_guid',
    :'external_bank_account_guid' => :'external_bank_account_guid',
    :'network_fee_account_guid' => :'network_fee_account_guid',
    :'payment_rail' => :'payment_rail',
    :'beneficiary_memo' => :'beneficiary_memo',
    :'labels' => :'labels'
  }
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



446
447
448
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 446

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



113
114
115
116
117
118
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 113

def self.openapi_nullable
  Set.new([
    :'beneficiary_memo',
    :'labels'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 96

def self.openapi_types
  {
    :'quote_guid' => :'String',
    :'transfer_type' => :'String',
    :'customer_guid' => :'String',
    :'source_account_guid' => :'String',
    :'destination_account_guid' => :'String',
    :'external_wallet_guid' => :'String',
    :'external_bank_account_guid' => :'String',
    :'network_fee_account_guid' => :'String',
    :'payment_rail' => :'String',
    :'beneficiary_memo' => :'String',
    :'labels' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 415

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      quote_guid == o.quote_guid &&
      transfer_type == o.transfer_type &&
      customer_guid == o.customer_guid &&
       == o. &&
       == o. &&
      external_wallet_guid == o.external_wallet_guid &&
       == o. &&
       == o. &&
      payment_rail == o.payment_rail &&
      beneficiary_memo == o.beneficiary_memo &&
      labels == o.labels
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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 477

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



548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 548

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



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 453

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


433
434
435
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 433

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



439
440
441
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 439

def hash
  [quote_guid, transfer_type, customer_guid, , , external_wallet_guid, , , payment_rail, beneficiary_memo, labels].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



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
259
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 184

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

  if @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.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 @transfer_type.nil?
    invalid_properties.push('invalid value for "transfer_type", transfer_type cannot be nil.')
  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 !@source_account_guid.nil? && @source_account_guid.to_s.length > 32
    invalid_properties.push('invalid value for "source_account_guid", the character length must be smaller than or equal to 32.')
  end

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

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

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

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

  if !@external_wallet_guid.nil? && @external_wallet_guid.to_s.length < 32
    invalid_properties.push('invalid value for "external_wallet_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_account_guid.nil? && @network_fee_account_guid.to_s.length > 32
    invalid_properties.push('invalid value for "network_fee_account_guid", the character length must be smaller than or equal to 32.')
  end

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

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

  if !@beneficiary_memo.nil? && @beneficiary_memo.to_s.length < 1
    invalid_properties.push('invalid value for "beneficiary_memo", 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



524
525
526
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 524

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 530

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



518
519
520
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 518

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb', line 263

def valid?
  return false if @quote_guid.nil?
  return false if @quote_guid.to_s.length > 32
  return false if @quote_guid.to_s.length < 32
  return false if @transfer_type.nil?
  transfer_type_validator = EnumAttributeValidator.new('String', ["funding", "book", "crypto", "instant_funding", "inter_account", "lightning"])
  return false unless transfer_type_validator.valid?(@transfer_type)
  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 !@source_account_guid.nil? && @source_account_guid.to_s.length > 32
  return false if !@source_account_guid.nil? && @source_account_guid.to_s.length < 32
  return false if !@destination_account_guid.nil? && @destination_account_guid.to_s.length > 32
  return false if !@destination_account_guid.nil? && @destination_account_guid.to_s.length < 32
  return false if !@external_wallet_guid.nil? && @external_wallet_guid.to_s.length > 32
  return false if !@external_wallet_guid.nil? && @external_wallet_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
  return false if !@network_fee_account_guid.nil? && @network_fee_account_guid.to_s.length > 32
  return false if !@network_fee_account_guid.nil? && @network_fee_account_guid.to_s.length < 32
  return false if !@beneficiary_memo.nil? && @beneficiary_memo.to_s.length > 128
  return false if !@beneficiary_memo.nil? && @beneficiary_memo.to_s.length < 1
  true
end