Class: CryptoApis::GetOmniTransactionDetailsByTransactionIDTxidRI

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetOmniTransactionDetailsByTransactionIDTxidRI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 112

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Defines the amount of the sent tokens.



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

def amount
  @amount
end

#divisible ⇒ Object

Defines whether the attribute can be divisible or not, as boolean. E.g., if it is "true", the attribute is divisible.



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

def divisible
  @divisible
end

#fee ⇒ Object

Returns the value of attribute fee.



57
58
59
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 57

def fee
  @fee
end

#mined_in_block_hash ⇒ Object

Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.



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

def mined_in_block_hash
  @mined_in_block_hash
end

#mined_in_block_height ⇒ Object

Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.



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

def mined_in_block_height
  @mined_in_block_height
end

#property_id ⇒ Object

Represents the identifier of the tokens to send.



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

def property_id
  @property_id
end

#recipients ⇒ Object

Represents an object of addresses that receive the transactions.



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

def recipients
  @recipients
end

#senders ⇒ Object

Represents an object of addresses that provide the funds.



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

def senders
  @senders
end

#timestamp ⇒ Object

Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.



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

def timestamp
  @timestamp
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/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 43

def transaction_id
  @transaction_id
end

#type ⇒ Object

Defines the type of the transaction as a string.



46
47
48
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 46

def type
  @type
end

#type_int ⇒ Object

Defines the type of the transaction as a number.



49
50
51
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 49

def type_int
  @type_int
end

#valid ⇒ Object

Defines whether the transaction is valid or not, as boolean. E.g. if set to "true", it means the transaction is valid.



52
53
54
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 52

def valid
  @valid
end

#version ⇒ Object

Defines the specific version.



55
56
57
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 55

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 60

def self.attribute_map
  {
    :'amount' => :'amount',
    :'divisible' => :'divisible',
    :'mined_in_block_hash' => :'minedInBlockHash',
    :'mined_in_block_height' => :'minedInBlockHeight',
    :'property_id' => :'propertyId',
    :'recipients' => :'recipients',
    :'senders' => :'senders',
    :'timestamp' => :'timestamp',
    :'transaction_id' => :'transactionId',
    :'type' => :'type',
    :'type_int' => :'typeInt',
    :'valid' => :'valid',
    :'version' => :'version',
    :'fee' => :'fee'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



105
106
107
108
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'amount' => :'String',
    :'divisible' => :'Boolean',
    :'mined_in_block_hash' => :'String',
    :'mined_in_block_height' => :'Integer',
    :'property_id' => :'Integer',
    :'recipients' => :'Array<ListOmniTransactionsByAddressRIRecipients>',
    :'senders' => :'Array<GetOmniTransactionDetailsByTransactionIDTxidRISenders>',
    :'timestamp' => :'Integer',
    :'transaction_id' => :'String',
    :'type' => :'String',
    :'type_int' => :'Integer',
    :'valid' => :'Boolean',
    :'version' => :'Integer',
    :'fee' => :'ListUnconfirmedOmniTransactionsByAddressRIFee'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 271

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      divisible == o.divisible &&
      mined_in_block_hash == o.mined_in_block_hash &&
      mined_in_block_height == o.mined_in_block_height &&
      property_id == o.property_id &&
      recipients == o.recipients &&
      senders == o.senders &&
      timestamp == o.timestamp &&
      transaction_id == o.transaction_id &&
      type == o.type &&
      type_int == o.type_int &&
      valid == o.valid &&
      version == o.version &&
      fee == o.fee
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 336

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 407

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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 312

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


292
293
294
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



298
299
300
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 298

def hash
  [amount, divisible, mined_in_block_hash, mined_in_block_height, property_id, recipients, senders, timestamp, transaction_id, type, type_int, valid, version, fee].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



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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 188

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

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

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

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

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

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

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

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

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

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

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

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

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

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



383
384
385
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 389

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



377
378
379
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 377

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/crypto_apis/models/get_omni_transaction_details_by_transaction_id_txid_ri.rb', line 251

def valid?
  return false if @amount.nil?
  return false if @divisible.nil?
  return false if @mined_in_block_hash.nil?
  return false if @mined_in_block_height.nil?
  return false if @property_id.nil?
  return false if @recipients.nil?
  return false if @senders.nil?
  return false if @timestamp.nil?
  return false if @transaction_id.nil?
  return false if @type.nil?
  return false if @type_int.nil?
  return false if @valid.nil?
  return false if @version.nil?
  return false if @fee.nil?
  true
end