Class: Coinbase::Client::FundQuote

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/models/fund_quote.rb

Overview

A quote for a fund operation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FundQuote

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
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
133
134
135
136
137
138
139
140
141
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 81

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

  if attributes.key?(:'network_id')
    self.network_id = attributes[:'network_id']
  else
    self.network_id = nil
  end

  if attributes.key?(:'wallet_id')
    self.wallet_id = attributes[:'wallet_id']
  else
    self.wallet_id = nil
  end

  if attributes.key?(:'address_id')
    self.address_id = attributes[:'address_id']
  else
    self.address_id = nil
  end

  if attributes.key?(:'crypto_amount')
    self.crypto_amount = attributes[:'crypto_amount']
  else
    self.crypto_amount = nil
  end

  if attributes.key?(:'fiat_amount')
    self.fiat_amount = attributes[:'fiat_amount']
  else
    self.fiat_amount = nil
  end

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

  if attributes.key?(:'fees')
    self.fees = attributes[:'fees']
  else
    self.fees = nil
  end
end

Instance Attribute Details

#address_id ⇒ Object

The ID of the address that will receive the crypto



29
30
31
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 29

def address_id
  @address_id
end

#crypto_amount ⇒ Object

Returns the value of attribute crypto_amount.



31
32
33
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 31

def crypto_amount
  @crypto_amount
end

#expires_at ⇒ Object

The time at which the quote expires



36
37
38
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 36

def expires_at
  @expires_at
end

#fees ⇒ Object

Returns the value of attribute fees.



38
39
40
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 38

def fees
  @fees
end

#fiat_amount ⇒ Object

Returns the value of attribute fiat_amount.



33
34
35
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 33

def fiat_amount
  @fiat_amount
end

#fund_quote_id ⇒ Object

The ID of the fund quote



20
21
22
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 20

def fund_quote_id
  @fund_quote_id
end

#network_id ⇒ Object

The ID of the blockchain network



23
24
25
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 23

def network_id
  @network_id
end

#wallet_id ⇒ Object

The ID of the wallet that will receive the crypto



26
27
28
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 26

def wallet_id
  @wallet_id
end

Class Method Details

._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



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
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 252

def self._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 = Coinbase::Client.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



55
56
57
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 55

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
52
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 41

def self.attribute_map
  {
    :'fund_quote_id' => :'fund_quote_id',
    :'network_id' => :'network_id',
    :'wallet_id' => :'wallet_id',
    :'address_id' => :'address_id',
    :'crypto_amount' => :'crypto_amount',
    :'fiat_amount' => :'fiat_amount',
    :'expires_at' => :'expires_at',
    :'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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 228

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 74

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 60

def self.openapi_types
  {
    :'fund_quote_id' => :'String',
    :'network_id' => :'String',
    :'wallet_id' => :'String',
    :'address_id' => :'String',
    :'crypto_amount' => :'CryptoAmount',
    :'fiat_amount' => :'FiatAmount',
    :'expires_at' => :'Time',
    :'fees' => :'FundOperationFees'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      fund_quote_id == o.fund_quote_id &&
      network_id == o.network_id &&
      wallet_id == o.wallet_id &&
      address_id == o.address_id &&
      crypto_amount == o.crypto_amount &&
      fiat_amount == o.fiat_amount &&
      expires_at == o.expires_at &&
      fees == o.fees
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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 323

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


215
216
217
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 221

def hash
  [fund_quote_id, network_id, wallet_id, address_id, crypto_amount, fiat_amount, expires_at, 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



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
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 145

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @fund_quote_id.nil?
    invalid_properties.push('invalid value for "fund_quote_id", fund_quote_id cannot be nil.')
  end

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

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

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

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

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

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

  if @fees.nil?
    invalid_properties.push('invalid value for "fees", fees cannot be nil.')
  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



299
300
301
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 305

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



293
294
295
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 293

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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/coinbase/client/models/fund_quote.rb', line 185

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @fund_quote_id.nil?
  return false if @network_id.nil?
  return false if @wallet_id.nil?
  return false if @address_id.nil?
  return false if @crypto_amount.nil?
  return false if @fiat_amount.nil?
  return false if @expires_at.nil?
  return false if @fees.nil?
  true
end