Class: CybridApiBank::QuoteBankModel

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QuoteBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 140

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

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

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

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

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

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

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

  if attributes.key?(:'asset')
    self.asset = attributes[:'asset']
  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
end

Instance Attribute Details

#asset ⇒ Object

The asset code the quote was requested for. Populated for book transfer and funding quotes.



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

def asset
  @asset
end

#bank_guid ⇒ Object

The unique identifier for the bank.



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

def bank_guid
  @bank_guid
end

#customer_guid ⇒ Object

The unique identifier for the customer.



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

def customer_guid
  @customer_guid
end

#deliver_amount ⇒ Object

The amount to be delivered in base units of the currency: currency is "counter_asset" for buy and "asset" for sell for trade quotes.



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

def deliver_amount
  @deliver_amount
end

#expires_at ⇒ Object

ISO8601 datetime the quote is expiring at. Populated for trading quotes.



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

def expires_at
  @expires_at
end

#fee ⇒ Object

The fee associated with the trade. Denominated in "counter_asset" base units for trade quotes.



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

def fee
  @fee
end

#guid ⇒ Object

Auto-generated unique identifier for the quote.



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

def guid
  @guid
end

#issued_at ⇒ Object

ISO8601 datetime the quote was created at.



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

def issued_at
  @issued_at
end

#network_fee ⇒ Object

The network fee in base units of network_fee_asset. Only present on ‘crypto_transfer` quotes.



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

def network_fee
  @network_fee
end

#network_fee_asset ⇒ Object

The asset code of the network fee.



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

def network_fee_asset
  @network_fee_asset
end

#product_type ⇒ Object

The type of product the quote is for.



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

def product_type
  @product_type
end

#receive_amount ⇒ Object

The amount to be received in base units of the currency: currency is "asset" for buy and "counter_asset" for sell for trade quotes.



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

def receive_amount
  @receive_amount
end

#side ⇒ Object

The direction of the quote: either ‘buy’ or ‘sell’ for trade quotes.



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

def side
  @side
end

#symbol ⇒ Object

Symbol the quote was requested for. Format is "asset-counter_asset" in uppercase. Populated for trade quotes.



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

def symbol
  @symbol
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 83

def self.attribute_map
  {
    :'guid' => :'guid',
    :'product_type' => :'product_type',
    :'bank_guid' => :'bank_guid',
    :'customer_guid' => :'customer_guid',
    :'symbol' => :'symbol',
    :'side' => :'side',
    :'receive_amount' => :'receive_amount',
    :'deliver_amount' => :'deliver_amount',
    :'fee' => :'fee',
    :'issued_at' => :'issued_at',
    :'expires_at' => :'expires_at',
    :'asset' => :'asset',
    :'network_fee' => :'network_fee',
    :'network_fee_asset' => :'network_fee_asset'
  }
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



427
428
429
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 427

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
132
133
134
135
136
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 128

def self.openapi_nullable
  Set.new([
    :'symbol',
    :'expires_at',
    :'asset',
    :'network_fee',
    :'network_fee_asset'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 108

def self.openapi_types
  {
    :'guid' => :'String',
    :'product_type' => :'String',
    :'bank_guid' => :'String',
    :'customer_guid' => :'String',
    :'symbol' => :'String',
    :'side' => :'String',
    :'receive_amount' => :'Integer',
    :'deliver_amount' => :'Integer',
    :'fee' => :'Integer',
    :'issued_at' => :'Time',
    :'expires_at' => :'Time',
    :'asset' => :'String',
    :'network_fee' => :'Integer',
    :'network_fee_asset' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 393

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      product_type == o.product_type &&
      bank_guid == o.bank_guid &&
      customer_guid == o.customer_guid &&
      symbol == o.symbol &&
      side == o.side &&
      receive_amount == o.receive_amount &&
      deliver_amount == o.deliver_amount &&
      fee == o.fee &&
      issued_at == o.issued_at &&
      expires_at == o.expires_at &&
      asset == o.asset &&
      network_fee == o.network_fee &&
      network_fee_asset == o.network_fee_asset
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



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 458

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



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

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



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 434

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


414
415
416
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 414

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



420
421
422
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 420

def hash
  [guid, product_type, bank_guid, customer_guid, symbol, side, receive_amount, deliver_amount, fee, issued_at, expires_at, asset, network_fee, network_fee_asset].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



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

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

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

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

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



505
506
507
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 505

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



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

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



499
500
501
 
# File 'lib/cybrid_api_bank_ruby/models/quote_bank_model.rb', line 499

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



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/quote_bank_model.rb', line 267

def valid?
  return false if !@guid.nil? && @guid.to_s.length > 32
  return false if !@guid.nil? && @guid.to_s.length < 32
  product_type_validator = EnumAttributeValidator.new('String', ["trading", "funding", "book_transfer", "crypto_transfer"])
  return false unless product_type_validator.valid?(@product_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 !@symbol.nil? && @symbol.to_s.length > 16
  return false if !@symbol.nil? && @symbol.to_s.length < 1
  side_validator = EnumAttributeValidator.new('String', ["buy", "sell", "deposit", "withdrawal"])
  return false unless side_validator.valid?(@side)
  return false if !@asset.nil? && @asset.to_s.length > 8
  return false if !@asset.nil? && @asset.to_s.length < 1
  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