Class: CybridApiBank::PostQuoteBankModel

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

Overview

Request body for quote creation.

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



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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 150

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset ⇒ Object

The asset code the quote was requested for. Required when product_type is lightning_transfer, product_type is book_transfer, product_type is funding, product_type is crypto_transfer, or product_type is inter_account.



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

def asset
  @asset
end

#bank_guid ⇒ Object

The unique identifier for the bank.



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

def bank_guid
  @bank_guid
end

#customer_guid ⇒ Object

The unique identifier for the customer.



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

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.



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

def deliver_amount
  @deliver_amount
end

#destination_account_guid ⇒ Object

The destination account’s identifier. Required when product_type is inter_account.



59
60
61
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 59

def 
  @destination_account_guid
end

#destination_accounts ⇒ Object

Destination accounts for batch transactions Optional when product_type is crypto_transfer.



50
51
52
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 50

def destination_accounts
  @destination_accounts
end

#fees ⇒ Object

The custom fees associated with the quote Optional when product_type is lightning_transfer, product_type is funding, product_type is trading, product_type is crypto_transfer, or product_type is trading_exit.



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

def fees
  @fees
end

#network_address ⇒ Object

The network address to pay the invoice to. Required when product_type is lightning_transfer.



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

def network_address
  @network_address
end

#product_type ⇒ Object

The type of product the quote is for.



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

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.



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

def receive_amount
  @receive_amount
end

#reference_trade_guid ⇒ Object

The guid of the related trade. Only present on ‘exit` trades. Required when product_type is trading_exit.



53
54
55
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 53

def reference_trade_guid
  @reference_trade_guid
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. Required when product_type is funding, product_type is trading, or product_type is crypto_transfer.



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

def side
  @side
end

#source_account_guid ⇒ Object

The source account’s identifier. Required when product_type is inter_account.



56
57
58
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 56

def 
  @source_account_guid
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. Required when product_type is trading.



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

def symbol
  @symbol
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 104

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



530
531
532
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 530

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 129

def self.openapi_nullable
  Set.new([
    :'product_type',
    :'bank_guid',
    :'customer_guid',
    :'receive_amount',
    :'deliver_amount',
    :'asset',
    :'network_address',
    :'fees',
    :'side',
    :'symbol',
    :'destination_accounts',
    :'reference_trade_guid',
    :'source_account_guid',
    :'destination_account_guid'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 496

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 &&
      receive_amount == o.receive_amount &&
      deliver_amount == o.deliver_amount &&
      asset == o.asset &&
      network_address == o.network_address &&
      fees == o.fees &&
      side == o.side &&
      symbol == o.symbol &&
      destination_accounts == o.destination_accounts &&
      reference_trade_guid == o.reference_trade_guid &&
       == o. &&
       == o.
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



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 561

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



632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 632

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



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 537

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


517
518
519
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 517

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



523
524
525
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 523

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



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
276
277
278
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_quote_bank_model.rb', line 228

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

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

  if !@fees.nil? && @fees.length < 0
    invalid_properties.push('invalid value for "fees", number of items must be greater than or equal to 0.')
  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 !@destination_accounts.nil? && @destination_accounts.length > 20
    invalid_properties.push('invalid value for "destination_accounts", number of items must be less than or equal to 20.')
  end

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

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

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

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

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

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

  if !@destination_account_guid.nil? && @destination_account_guid.to_s.length < 32
    invalid_properties.push('invalid value for "destination_account_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



608
609
610
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 608

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



614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 614

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



602
603
604
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 602

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb', line 311

def valid?
  product_type_validator = EnumAttributeValidator.new('String', ["trading", "trading_exit", "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 !@network_address.nil? && @network_address.to_s.length > 512
  return false if !@fees.nil? && @fees.length > 2
  return false if !@fees.nil? && @fees.length < 0
  side_validator = EnumAttributeValidator.new('String', ["deposit", "withdrawal", "buy", "sell"])
  return false unless side_validator.valid?(@side)
  return false if !@symbol.nil? && @symbol.to_s.length > 16
  return false if !@symbol.nil? && @symbol.to_s.length < 1
  return false if !@destination_accounts.nil? && @destination_accounts.length > 20
  return false if !@destination_accounts.nil? && @destination_accounts.length < 1
  return false if !@reference_trade_guid.nil? && @reference_trade_guid.to_s.length > 32
  return false if !@reference_trade_guid.nil? && @reference_trade_guid.to_s.length < 32
  return false if !@source_account_guid.nil? && @source_account_guid.to_s.length > 32
  return false if !@source_account_guid.nil? && @source_account_guid.to_s.length < 32
  return false if !@destination_account_guid.nil? && @destination_account_guid.to_s.length > 32
  return false if !@destination_account_guid.nil? && @destination_account_guid.to_s.length < 32
  true
end