Class: CryptoApis::GetXRPRippleTransactionDetailsByTransactionIDRI

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetXRPRippleTransactionDetailsByTransactionIDRI

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 118

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_data ⇒ Object

Represents additional data that may be needed.



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

def additional_data
  @additional_data
end

#destination_tag ⇒ Object

Returns the value of attribute destination_tag.



21
22
23
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 21

def destination_tag
  @destination_tag
end

#fee ⇒ Object

Returns the value of attribute fee.



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

def fee
  @fee
end

#index ⇒ Object

Defines the index of the transaction, i.e. the consecutive place it takes in the blockchain.



24
25
26
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 24

def index
  @index
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.



27
28
29
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 27

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.



30
31
32
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 30

def mined_in_block_height
  @mined_in_block_height
end

#offer ⇒ Object

Returns the value of attribute offer.



32
33
34
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 32

def offer
  @offer
end

#receive ⇒ Object

Returns the value of attribute receive.



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

def receive
  @receive
end

#recipients ⇒ Object

Represents an object of addresses that receive the transactions.



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

def recipients
  @recipients
end

#senders ⇒ Object

Represents an object of addresses that provide the funds.



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

def senders
  @senders
end

#sequence ⇒ Object

Defines the transaction input’s sequence as an integer, which is is used when transactions are replaced with newer versions before LockTime.



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

def sequence
  @sequence
end

#status ⇒ Object

Defines the status of the transaction.



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

def status
  @status
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.



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

def timestamp
  @timestamp
end

#transaction_hash ⇒ Object

Represents the same as ‘transactionId` for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols `hash` is different from `transactionId` for SegWit transactions.



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

def transaction_hash
  @transaction_hash
end

#type ⇒ Object

Defines the type of the transaction.



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

def type
  @type
end

#value ⇒ Object

Returns the value of attribute value.



59
60
61
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 59

def value
  @value
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 84

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 62

def self.attribute_map
  {
    :'additional_data' => :'additionalData',
    :'destination_tag' => :'destinationTag',
    :'index' => :'index',
    :'mined_in_block_hash' => :'minedInBlockHash',
    :'mined_in_block_height' => :'minedInBlockHeight',
    :'offer' => :'offer',
    :'receive' => :'receive',
    :'recipients' => :'recipients',
    :'senders' => :'senders',
    :'sequence' => :'sequence',
    :'status' => :'status',
    :'timestamp' => :'timestamp',
    :'transaction_hash' => :'transactionHash',
    :'type' => :'type',
    :'fee' => :'fee',
    :'value' => :'value'
  }
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



321
322
323
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 321

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



111
112
113
114
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 111

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 89

def self.openapi_types
  {
    :'additional_data' => :'String',
    :'destination_tag' => :'Integer',
    :'index' => :'String',
    :'mined_in_block_hash' => :'String',
    :'mined_in_block_height' => :'String',
    :'offer' => :'GetXRPRippleTransactionDetailsByTransactionIDRIOffer',
    :'receive' => :'GetXRPRippleTransactionDetailsByTransactionIDRIReceive',
    :'recipients' => :'Array<GetXRPRippleTransactionDetailsByTransactionIDRIRecipients>',
    :'senders' => :'Array<GetXRPRippleTransactionDetailsByTransactionIDRISenders>',
    :'sequence' => :'Integer',
    :'status' => :'String',
    :'timestamp' => :'Integer',
    :'transaction_hash' => :'String',
    :'type' => :'String',
    :'fee' => :'GetXRPRippleTransactionDetailsByTransactionIDRIFee',
    :'value' => :'GetXRPRippleTransactionDetailsByTransactionIDRIValue'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      additional_data == o.additional_data &&
      destination_tag == o.destination_tag &&
      index == o.index &&
      mined_in_block_hash == o.mined_in_block_hash &&
      mined_in_block_height == o.mined_in_block_height &&
      offer == o.offer &&
      receive == o.receive &&
      recipients == o.recipients &&
      senders == o.senders &&
      sequence == o.sequence &&
      status == o.status &&
      timestamp == o.timestamp &&
      transaction_hash == o.transaction_hash &&
      type == o.type &&
      fee == o.fee &&
      value == o.value
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



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 352

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



423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 423

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 328

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


308
309
310
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



314
315
316
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 314

def hash
  [additional_data, destination_tag, index, mined_in_block_hash, mined_in_block_height, offer, receive, recipients, senders, sequence, status, timestamp, transaction_hash, type, fee, value].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



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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 202

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

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

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

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

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

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

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

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



399
400
401
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 399

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



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 405

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



393
394
395
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 393

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/crypto_apis/models/get_xrp_ripple_transaction_details_by_transaction_idri.rb', line 265

def valid?
  return false if @additional_data.nil?
  return false if @index.nil?
  return false if @mined_in_block_hash.nil?
  return false if @mined_in_block_height.nil?
  return false if @offer.nil?
  return false if @receive.nil?
  return false if @recipients.nil?
  return false if @senders.nil?
  return false if @sequence.nil?
  return false if @timestamp.nil?
  return false if @transaction_hash.nil?
  return false if @type.nil?
  return false if @fee.nil?
  return false if @value.nil?
  true
end