Class: CybridApiBank::PostInternalExchangeSettlementPaymentOrderBankModel

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostInternalExchangeSettlementPaymentOrderBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#exchange_settlement_guid ⇒ Object

The identifier of the exchange settlement that this payment is associated with.



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

def exchange_settlement_guid
  @exchange_settlement_guid
end

#exchange_settlement_obligation_guid ⇒ Object

The identifier of the exchange settlement obligation that this payment is associated with.



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

def exchange_settlement_obligation_guid
  @exchange_settlement_obligation_guid
end

#expected_state ⇒ Object

The expected state of the underlying money transfer for the payment order (sandbox only)



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

def expected_state
  @expected_state
end

#external_account_guid ⇒ Object

The identifier of the external account that is expected to receive the payment.



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

def 
  @external_account_guid
end

#external_account_type ⇒ Object

The type of the external account that is expected to receive the payment.



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

def 
  @external_account_type
end

#internal_account_guid ⇒ Object

The identifier of the internal account that is expected to originate the payment.



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

def 
  @internal_account_guid
end

#internal_account_type ⇒ Object

The type of the internal account that is expected to originate the payment.



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

def 
  @internal_account_type
end

#internal_network_fee_wallet_guid ⇒ Object

The identifier of the cash network fee account that has the network fee.



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

def internal_network_fee_wallet_guid
  @internal_network_fee_wallet_guid
end

#network_fee ⇒ Object

The network fee for the payment. Only required for crypto payments.



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

def network_fee
  @network_fee
end

#network_fee_account_guid ⇒ Object

The identifier of the liability network fee account that has the network fee.



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

def 
  @network_fee_account_guid
end

#payment_amount ⇒ Object

The amount expected to be received as part of this payment.



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

def payment_amount
  @payment_amount
end

#sequence_number ⇒ Object

The sequence number of the payment order



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

def sequence_number
  @sequence_number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 77

def self.attribute_map
  {
    :'exchange_settlement_guid' => :'exchange_settlement_guid',
    :'exchange_settlement_obligation_guid' => :'exchange_settlement_obligation_guid',
    :'sequence_number' => :'sequence_number',
    :'payment_amount' => :'payment_amount',
    :'network_fee' => :'network_fee',
    :'expected_state' => :'expected_state',
    :'internal_account_guid' => :'internal_account_guid',
    :'internal_account_type' => :'internal_account_type',
    :'external_account_guid' => :'external_account_guid',
    :'external_account_type' => :'external_account_type',
    :'network_fee_account_guid' => :'network_fee_account_guid',
    :'internal_network_fee_wallet_guid' => :'internal_network_fee_wallet_guid'
  }
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



473
474
475
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 473

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
123
124
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 118

def self.openapi_nullable
  Set.new([
    :'network_fee',
    :'network_fee_account_guid',
    :'internal_network_fee_wallet_guid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 100

def self.openapi_types
  {
    :'exchange_settlement_guid' => :'String',
    :'exchange_settlement_obligation_guid' => :'String',
    :'sequence_number' => :'Integer',
    :'payment_amount' => :'Integer',
    :'network_fee' => :'Integer',
    :'expected_state' => :'String',
    :'internal_account_guid' => :'String',
    :'internal_account_type' => :'String',
    :'external_account_guid' => :'String',
    :'external_account_type' => :'String',
    :'network_fee_account_guid' => :'String',
    :'internal_network_fee_wallet_guid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 441

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      exchange_settlement_guid == o.exchange_settlement_guid &&
      exchange_settlement_obligation_guid == o.exchange_settlement_obligation_guid &&
      sequence_number == o.sequence_number &&
      payment_amount == o.payment_amount &&
      network_fee == o.network_fee &&
      expected_state == o.expected_state &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
       == o. &&
      internal_network_fee_wallet_guid == o.internal_network_fee_wallet_guid
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



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 504

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



575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 575

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



480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 480

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


460
461
462
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 460

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



466
467
468
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 466

def hash
  [exchange_settlement_guid, exchange_settlement_obligation_guid, sequence_number, payment_amount, network_fee, expected_state, , , , , , internal_network_fee_wallet_guid].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



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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 192

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



551
552
553
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 551

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



557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 557

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



545
546
547
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_payment_order_bank_model.rb', line 545

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



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

def valid?
  return false if @exchange_settlement_guid.nil?
  return false if @exchange_settlement_guid.to_s.length > 32
  return false if @exchange_settlement_guid.to_s.length < 32
  return false if @exchange_settlement_obligation_guid.nil?
  return false if @exchange_settlement_obligation_guid.to_s.length > 32
  return false if @exchange_settlement_obligation_guid.to_s.length < 32
  return false if @sequence_number.nil?
  return false if @payment_amount.nil?
  expected_state_validator = EnumAttributeValidator.new('String', ["pending", "in_progress", "completed", "failed", "cancelled", "manual_intervention"])
  return false unless expected_state_validator.valid?(@expected_state)
  return false if @internal_account_guid.nil?
  return false if @internal_account_guid.to_s.length > 32
  return false if @internal_account_guid.to_s.length < 32
  return false if @internal_account_type.nil?
   = EnumAttributeValidator.new('String', ["internal_wallet", "internal_bank_account"])
  return false unless .valid?(@internal_account_type)
  return false if @external_account_guid.nil?
  return false if @external_account_guid.to_s.length > 32
  return false if @external_account_guid.to_s.length < 32
  return false if @external_account_type.nil?
   = EnumAttributeValidator.new('String', ["external_wallet", "external_bank_account"])
  return false unless .valid?(@external_account_type)
  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 !@internal_network_fee_wallet_guid.nil? && @internal_network_fee_wallet_guid.to_s.length > 32
  return false if !@internal_network_fee_wallet_guid.nil? && @internal_network_fee_wallet_guid.to_s.length < 32
  true
end