Class: CybridApiBank::PostQuoteBankModel

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
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
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 119

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

  if attributes.key?(:'network_address')
    self.network_address = attributes[:'network_address']
  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?(:'fees')
    if (value = attributes[:'fees']).is_a?(Array)
      self.fees = value
    end
  end
end

Instance Attribute Details

#asset ⇒ Object

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



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

def asset
  @asset
end

#bank_guid ⇒ Object

The unique identifier for the bank.



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

def bank_guid
  @bank_guid
end

#customer_guid ⇒ Object

The unique identifier for the customer.



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

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.



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

def deliver_amount
  @deliver_amount
end

#fees ⇒ Object

The custom fees associated with the quote



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

def fees
  @fees
end

#network_address ⇒ Object

The network address to pay the invoice to. Populated for lightning_transfer quotes.



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

def network_address
  @network_address
end

#product_type ⇒ Object

The type of product the quote is for.



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

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.



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

def receive_amount
  @receive_amount
end

#side ⇒ Object

The direction for trade quotes: either ‘buy’ or ‘sell’. The direction for funding quotes: either ‘deposit’ or ‘withdrawal’. The direction for crypto transfer quotes: ‘withdrawal’. Book transfers do not require a side. They are all ‘deposit’s.



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

def side
  @side
end

#symbol ⇒ Object

Symbol the quote is being requested for. Format is "asset-counter_asset" in uppercase. See the Symbols API for a complete list of cryptocurrencies supported. Populated for trade quotes.



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

def symbol
  @symbol
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 71

def self.attribute_map
  {
    :'product_type' => :'product_type',
    :'bank_guid' => :'bank_guid',
    :'customer_guid' => :'customer_guid',
    :'asset' => :'asset',
    :'network_address' => :'network_address',
    :'symbol' => :'symbol',
    :'side' => :'side',
    :'receive_amount' => :'receive_amount',
    :'deliver_amount' => :'deliver_amount',
    :'fees' => :'fees'
  }
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



330
331
332
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 330

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
114
115
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 108

def self.openapi_nullable
  Set.new([
    :'bank_guid',
    :'customer_guid',
    :'network_address',
    :'side',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 92

def self.openapi_types
  {
    :'product_type' => :'String',
    :'bank_guid' => :'String',
    :'customer_guid' => :'String',
    :'asset' => :'String',
    :'network_address' => :'String',
    :'symbol' => :'String',
    :'side' => :'String',
    :'receive_amount' => :'Integer',
    :'deliver_amount' => :'Integer',
    :'fees' => :'Array<PostFeeBankModel>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      product_type == o.product_type &&
      bank_guid == o.bank_guid &&
      customer_guid == o.customer_guid &&
      asset == o.asset &&
      network_address == o.network_address &&
      symbol == o.symbol &&
      side == o.side &&
      receive_amount == o.receive_amount &&
      deliver_amount == o.deliver_amount &&
      fees == o.fees
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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 361

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 432

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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 337

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


317
318
319
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 323

def hash
  [product_type, bank_guid, customer_guid, asset, network_address, symbol, side, receive_amount, deliver_amount, fees].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



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
209
210
211
212
213
214
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  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 !@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 !@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

  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



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

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 414

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



402
403
404
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 402

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 218

def valid?
  product_type_validator = EnumAttributeValidator.new('String', ["trading", "funding", "book_transfer", "crypto_transfer", "inter_account", "lightning_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 !@asset.nil? && @asset.to_s.length > 8
  return false if !@asset.nil? && @asset.to_s.length < 1
  return false if !@symbol.nil? && @symbol.to_s.length > 16
  return false if !@symbol.nil? && @symbol.to_s.length < 1
  true
end