Class: Coinbase::Client::Trade

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

Overview

A trade of an asset to another asset

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Trade

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/coinbase/client/models/trade.rb', line 90

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

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

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

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

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

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

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

Instance Attribute Details

#address_id ⇒ Object

The onchain address of the sender



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

def address_id
  @address_id
end

#approve_transaction ⇒ Object

Returns the value of attribute approve_transaction.



43
44
45
 
# File 'lib/coinbase/client/models/trade.rb', line 43

def approve_transaction
  @approve_transaction
end

#from_amount ⇒ Object

The amount of the from asset to be traded (in atomic units of the from asset)



32
33
34
 
# File 'lib/coinbase/client/models/trade.rb', line 32

def from_amount
  @from_amount
end

#from_asset ⇒ Object

Returns the value of attribute from_asset.



34
35
36
 
# File 'lib/coinbase/client/models/trade.rb', line 34

def from_asset
  @from_asset
end

#network_id ⇒ Object

The ID of the blockchain network



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

def network_id
  @network_id
end

#to_amount ⇒ Object

The amount of the to asset that will be received (in atomic units of the to asset)



37
38
39
 
# File 'lib/coinbase/client/models/trade.rb', line 37

def to_amount
  @to_amount
end

#to_asset ⇒ Object

Returns the value of attribute to_asset.



39
40
41
 
# File 'lib/coinbase/client/models/trade.rb', line 39

def to_asset
  @to_asset
end

#trade_id ⇒ Object

The ID of the trade



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

def trade_id
  @trade_id
end

#transaction ⇒ Object

Returns the value of attribute transaction.



41
42
43
 
# File 'lib/coinbase/client/models/trade.rb', line 41

def transaction
  @transaction
end

#wallet_id ⇒ Object

The ID of the wallet that owns the from address



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

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



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
308
309
310
311
312
313
314
315
 
# File 'lib/coinbase/client/models/trade.rb', line 278

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



62
63
64
 
# File 'lib/coinbase/client/models/trade.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/coinbase/client/models/trade.rb', line 46

def self.attribute_map
  {
    :'network_id' => :'network_id',
    :'wallet_id' => :'wallet_id',
    :'address_id' => :'address_id',
    :'trade_id' => :'trade_id',
    :'from_amount' => :'from_amount',
    :'from_asset' => :'from_asset',
    :'to_amount' => :'to_amount',
    :'to_asset' => :'to_asset',
    :'transaction' => :'transaction',
    :'approve_transaction' => :'approve_transaction'
  }
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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/coinbase/client/models/trade.rb', line 254

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



83
84
85
86
 
# File 'lib/coinbase/client/models/trade.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/coinbase/client/models/trade.rb', line 67

def self.openapi_types
  {
    :'network_id' => :'String',
    :'wallet_id' => :'String',
    :'address_id' => :'String',
    :'trade_id' => :'String',
    :'from_amount' => :'String',
    :'from_asset' => :'Asset',
    :'to_amount' => :'String',
    :'to_asset' => :'Asset',
    :'transaction' => :'Transaction',
    :'approve_transaction' => :'Transaction'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/coinbase/client/models/trade.rb', line 224

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_id == o.network_id &&
      wallet_id == o.wallet_id &&
      address_id == o.address_id &&
      trade_id == o.trade_id &&
      from_amount == o.from_amount &&
      from_asset == o.from_asset &&
      to_amount == o.to_amount &&
      to_asset == o.to_asset &&
      transaction == o.transaction &&
      approve_transaction == o.approve_transaction
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



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/coinbase/client/models/trade.rb', line 349

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


241
242
243
 
# File 'lib/coinbase/client/models/trade.rb', line 241

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



247
248
249
 
# File 'lib/coinbase/client/models/trade.rb', line 247

def hash
  [network_id, wallet_id, address_id, trade_id, from_amount, from_asset, to_amount, to_asset, transaction, approve_transaction].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 @trade_id.nil?
    invalid_properties.push('invalid value for "trade_id", trade_id cannot be nil.')
  end

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

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

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

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

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



325
326
327
 
# File 'lib/coinbase/client/models/trade.rb', line 325

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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/coinbase/client/models/trade.rb', line 331

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



319
320
321
 
# File 'lib/coinbase/client/models/trade.rb', line 319

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



208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/coinbase/client/models/trade.rb', line 208

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @network_id.nil?
  return false if @wallet_id.nil?
  return false if @address_id.nil?
  return false if @trade_id.nil?
  return false if @from_amount.nil?
  return false if @from_asset.nil?
  return false if @to_amount.nil?
  return false if @to_asset.nil?
  return false if @transaction.nil?
  true
end