Class: CybridApiBank::PostInternalExchangeSettlementBankModel

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

Overview

Request body for exchange_settlement creation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostInternalExchangeSettlementBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 84

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

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

  if attributes.key?(:'automatic')
    self.automatic = attributes[:'automatic']
  else
    self.automatic = false
  end

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

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

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

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

Instance Attribute Details

#allowed_symbols ⇒ Object

The trading symbols to include in the settlement.



35
36
37
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 35

def allowed_symbols
  @allowed_symbols
end

#automatic ⇒ Object

Whether the settlement should be automatic.



26
27
28
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 26

def automatic
  @automatic
end

#denied_symbols ⇒ Object

The trading symbols to exclude from the settlement.



38
39
40
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 38

def denied_symbols
  @denied_symbols
end

#exchange_guid ⇒ Object

The exchange guid for the settlement.



23
24
25
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 23

def exchange_guid
  @exchange_guid
end

#name ⇒ Object

The name of the settlement.



20
21
22
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 20

def name
  @name
end

#trade_guids ⇒ Object

The trade guids to include in the settlement.



29
30
31
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 29

def trade_guids
  @trade_guids
end

#trades_created_at_lt ⇒ Object

Include trades created before this timestamp (exclusive).



32
33
34
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 32

def trades_created_at_lt
  @trades_created_at_lt
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 41

def self.attribute_map
  {
    :'name' => :'name',
    :'exchange_guid' => :'exchange_guid',
    :'automatic' => :'automatic',
    :'trade_guids' => :'trade_guids',
    :'trades_created_at_lt' => :'trades_created_at_lt',
    :'allowed_symbols' => :'allowed_symbols',
    :'denied_symbols' => :'denied_symbols'
  }
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



305
306
307
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 305

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
76
77
78
79
80
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 72

def self.openapi_nullable
  Set.new([
    :'automatic',
    :'trade_guids',
    :'trades_created_at_lt',
    :'allowed_symbols',
    :'denied_symbols'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 59

def self.openapi_types
  {
    :'name' => :'String',
    :'exchange_guid' => :'String',
    :'automatic' => :'Boolean',
    :'trade_guids' => :'Array<String>',
    :'trades_created_at_lt' => :'Time',
    :'allowed_symbols' => :'Array<String>',
    :'denied_symbols' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      exchange_guid == o.exchange_guid &&
      automatic == o.automatic &&
      trade_guids == o.trade_guids &&
      trades_created_at_lt == o.trades_created_at_lt &&
      allowed_symbols == o.allowed_symbols &&
      denied_symbols == o.denied_symbols
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 336

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 407

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 312

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


292
293
294
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 298

def hash
  [name, exchange_guid, automatic, trade_guids, trades_created_at_lt, allowed_symbols, denied_symbols].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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 @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 !@trade_guids.nil? && @trade_guids.length > 225
    invalid_properties.push('invalid value for "trade_guids", number of items must be less than or equal to 225.')
  end

  if !@trade_guids.nil? && @trade_guids.length < 1
    invalid_properties.push('invalid value for "trade_guids", number of items must be greater than or equal to 1.')
  end

  if !@allowed_symbols.nil? && @allowed_symbols.length > 50
    invalid_properties.push('invalid value for "allowed_symbols", number of items must be less than or equal to 50.')
  end

  if !@allowed_symbols.nil? && @allowed_symbols.length < 1
    invalid_properties.push('invalid value for "allowed_symbols", number of items must be greater than or equal to 1.')
  end

  if !@denied_symbols.nil? && @denied_symbols.length > 50
    invalid_properties.push('invalid value for "denied_symbols", number of items must be less than or equal to 50.')
  end

  if !@denied_symbols.nil? && @denied_symbols.length < 1
    invalid_properties.push('invalid value for "denied_symbols", number of items must be greater 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



383
384
385
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 389

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



377
378
379
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 377

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/cybrid_api_bank_ruby/models/post_internal_exchange_settlement_bank_model.rb', line 187

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 128
  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 !@trade_guids.nil? && @trade_guids.length > 225
  return false if !@trade_guids.nil? && @trade_guids.length < 1
  return false if !@allowed_symbols.nil? && @allowed_symbols.length > 50
  return false if !@allowed_symbols.nil? && @allowed_symbols.length < 1
  return false if !@denied_symbols.nil? && @denied_symbols.length > 50
  return false if !@denied_symbols.nil? && @denied_symbols.length < 1
  true
end