Class: CybridApiBank::InternalExchangeSettlementBankModel

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InternalExchangeSettlementBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
194
195
196
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_atObject

ISO8601 datetime the record was created at.



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

def created_at
  @created_at
end

#environmentObject

The environment that the settlement is for.



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

def environment
  @environment
end

#exchange_guidObject

The identifier of the exchange that corresponds to this settlement.



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

def exchange_guid
  @exchange_guid
end

#exchange_settlement_obligation_guidsObject

The exchange settlement’s set of obligation guids.



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

def exchange_settlement_obligation_guids
  @exchange_settlement_obligation_guids
end

#guidObject

Auto-generated unique identifier for the exchange settlement.



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

def guid
  @guid
end

#nameObject

The name of the exchange settlement.



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

def name
  @name
end

#order_amountsObject

The exchange settlement’s set of order amounts.



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

def order_amounts
  @order_amounts
end

#order_guidsObject

The exchange settlement’s set of included order guids.



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

def order_guids
  @order_guids
end

#stateObject

The exchange settlement’s state



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

def state
  @state
end

#trade_amountsObject

The exchange settlement’s set of trade amounts.



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

def trade_amounts
  @trade_amounts
end

#trade_guidsObject

The exchange settlement’s set of included trade guids.



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

def trade_guids
  @trade_guids
end

#updated_atObject

ISO8601 datetime the record was last updated at.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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/internal_exchange_settlement_bank_model.rb', line 77

def self.attribute_map
  {
    :'guid' => :'guid',
    :'environment' => :'environment',
    :'exchange_guid' => :'exchange_guid',
    :'name' => :'name',
    :'trade_guids' => :'trade_guids',
    :'trade_amounts' => :'trade_amounts',
    :'order_guids' => :'order_guids',
    :'order_amounts' => :'order_amounts',
    :'exchange_settlement_obligation_guids' => :'exchange_settlement_obligation_guids',
    :'state' => :'state',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_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



408
409
410
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 408

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

.openapi_nullableObject

List of attributes with nullable: true



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

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

.openapi_typesObject

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/internal_exchange_settlement_bank_model.rb', line 100

def self.openapi_types
  {
    :'guid' => :'String',
    :'environment' => :'String',
    :'exchange_guid' => :'String',
    :'name' => :'String',
    :'trade_guids' => :'Array<String>',
    :'trade_amounts' => :'Array<InternalExchangeSettlementTradeAmountsInnerBankModel>',
    :'order_guids' => :'Array<String>',
    :'order_amounts' => :'Array<InternalExchangeSettlementOrderAmountsInnerBankModel>',
    :'exchange_settlement_obligation_guids' => :'Array<String>',
    :'state' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 376

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      environment == o.environment &&
      exchange_guid == o.exchange_guid &&
      name == o.name &&
      trade_guids == o.trade_guids &&
      trade_amounts == o.trade_amounts &&
      order_guids == o.order_guids &&
      order_amounts == o.order_amounts &&
      exchange_settlement_obligation_guids == o.exchange_settlement_obligation_guids &&
      state == o.state &&
      created_at == o.created_at &&
      updated_at == o.updated_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



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 439

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



510
511
512
513
514
515
516
517
518
519
520
521
522
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 510

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



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

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


395
396
397
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 395

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



401
402
403
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 401

def hash
  [guid, environment, exchange_guid, name, trade_guids, trade_amounts, order_guids, order_amounts, exchange_settlement_obligation_guids, state, created_at, updated_at].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  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



486
487
488
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 486

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



492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 492

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



480
481
482
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 480

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
# File 'lib/cybrid_api_bank_ruby/models/internal_exchange_settlement_bank_model.rb', line 275

def valid?
  return false if @guid.nil?
  return false if @guid.to_s.length > 32
  return false if @guid.to_s.length < 32
  return false if @environment.nil?
  environment_validator = EnumAttributeValidator.new('String', ["sandbox", "production"])
  return false unless environment_validator.valid?(@environment)
  return false if @exchange_guid.nil?
  return false if @exchange_guid.to_s.length > 32
  return false if @exchange_guid.to_s.length < 32
  return false if @name.nil?
  return false if @name.to_s.length > 128
  return false if @name.to_s.length < 1
  return false if @trade_guids.nil?
  return false if @trade_amounts.nil?
  return false if @order_guids.nil?
  return false if @order_amounts.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["storing", "pending__created", "pending__approved", "failed_creation", "trades_completed"])
  return false unless state_validator.valid?(@state)
  return false if @created_at.nil?
  return false if @updated_at.nil?
  true
end