Class: CryptoApis::ListHDWalletXPubYPubZPubUTXOsRI

Inherits:
Object
  • Object
show all
Defined in:
lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListHDWalletXPubYPubZPubUTXOsRI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 88

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Represents the public address, which is a compressed and shortened form of a public key.



19
20
21
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 19

def address
  @address
end

#address_path ⇒ Object

Defines a data which tells a Hierarchical Deterministic wallet how to derive a specific key within a tree of keys.



22
23
24
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 22

def address_path
  @address_path
end

#amount ⇒ Object

Represents the UTXO amount value.



25
26
27
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 25

def amount
  @amount
end

#derivation ⇒ Object

The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.



28
29
30
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 28

def derivation
  @derivation
end

#index ⇒ Object

Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).



31
32
33
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 31

def index
  @index
end

#is_available ⇒ Object

Represents if the UTXO has been used from another unconfirmed transaction. If it is - the value will be "false".



34
35
36
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 34

def is_available
  @is_available
end

#is_confirmed ⇒ Object

Represents the state of the transaction whether it is confirmed or not confirmed.



37
38
39
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 37

def is_confirmed
  @is_confirmed
end

#reference_id ⇒ Object

Represents the reference id of the record. It may be used for the startingAfter pagination attribute.



40
41
42
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 40

def reference_id
  @reference_id
end

#transaction_id ⇒ Object

Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.



43
44
45
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 43

def transaction_id
  @transaction_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 61

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
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 46

def self.attribute_map
  {
    :'address' => :'address',
    :'address_path' => :'addressPath',
    :'amount' => :'amount',
    :'derivation' => :'derivation',
    :'index' => :'index',
    :'is_available' => :'isAvailable',
    :'is_confirmed' => :'isConfirmed',
    :'reference_id' => :'referenceId',
    :'transaction_id' => :'transactionId'
  }
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



227
228
229
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 227

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 66

def self.openapi_types
  {
    :'address' => :'String',
    :'address_path' => :'String',
    :'amount' => :'String',
    :'derivation' => :'String',
    :'index' => :'Integer',
    :'is_available' => :'Boolean',
    :'is_confirmed' => :'Boolean',
    :'reference_id' => :'String',
    :'transaction_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 198

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address == o.address &&
      address_path == o.address_path &&
      amount == o.amount &&
      derivation == o.derivation &&
      index == o.index &&
      is_available == o.is_available &&
      is_confirmed == o.is_confirmed &&
      reference_id == o.reference_id &&
      transaction_id == o.transaction_id
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



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
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 258

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 = CryptoApis.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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 329

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 234

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


214
215
216
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 214

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



220
221
222
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 220

def hash
  [address, address_path, amount, derivation, index, is_available, is_confirmed, reference_id, transaction_id].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



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
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  if @address.nil?
    invalid_properties.push('invalid value for "address", address cannot be nil.')
  end

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

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

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

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

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

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

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

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



305
306
307
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 311

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



299
300
301
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 299

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



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/crypto_apis/models/list_hd_wallet_x_pub_y_pub_z_pub_utxos_ri.rb', line 183

def valid?
  return false if @address.nil?
  return false if @address_path.nil?
  return false if @amount.nil?
  return false if @derivation.nil?
  return false if @index.nil?
  return false if @is_available.nil?
  return false if @is_confirmed.nil?
  return false if @reference_id.nil?
  return false if @transaction_id.nil?
  true
end