Class: CryptoApis::TokensForwardingSuccessDataItem

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

Overview

Defines an ‘item` as one result.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TokensForwardingSuccessDataItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#blockchain ⇒ Object

Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.



20
21
22
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 20

def blockchain
  @blockchain
end

#forwarding_transaction_id ⇒ Object

Defines the unique Transaction ID that forwarded the tokens.



41
42
43
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 41

def forwarding_transaction_id
  @forwarding_transaction_id
end

#from_address ⇒ Object

Represents the hash of the address that provides the tokens.



26
27
28
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 26

def from_address
  @from_address
end

#network ⇒ Object

Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.



23
24
25
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 23

def network
  @network
end

#spent_fees_amount ⇒ Object

Represents the amount of the fee spent for the tokens to be forwarded.



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

def spent_fees_amount
  @spent_fees_amount
end

#spent_fees_unit ⇒ Object

Represents the unit of the fee spent for the tokens to be forwarded, e.g. BTC.



35
36
37
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 35

def spent_fees_unit
  @spent_fees_unit
end

#to_address ⇒ Object

Represents the hash of the address to forward the tokens to.



29
30
31
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 29

def to_address
  @to_address
end

#token ⇒ Object

Returns the value of attribute token.



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

def token
  @token
end

#token_type ⇒ Object

Defines the type of token sent with the transaction, e.g. ERC 20.



44
45
46
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 44

def token_type
  @token_type
end

#trigger_transaction_id ⇒ Object

Defines the unique Transaction ID that triggered the token forwarding.



38
39
40
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 38

def trigger_transaction_id
  @trigger_transaction_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 71

def self.attribute_map
  {
    :'blockchain' => :'blockchain',
    :'network' => :'network',
    :'from_address' => :'fromAddress',
    :'to_address' => :'toAddress',
    :'spent_fees_amount' => :'spentFeesAmount',
    :'spent_fees_unit' => :'spentFeesUnit',
    :'trigger_transaction_id' => :'triggerTransactionId',
    :'forwarding_transaction_id' => :'forwardingTransactionId',
    :'token_type' => :'tokenType',
    :'token' => :'token'
  }
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



276
277
278
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 276

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 92

def self.openapi_types
  {
    :'blockchain' => :'String',
    :'network' => :'String',
    :'from_address' => :'String',
    :'to_address' => :'String',
    :'spent_fees_amount' => :'String',
    :'spent_fees_unit' => :'String',
    :'trigger_transaction_id' => :'String',
    :'forwarding_transaction_id' => :'String',
    :'token_type' => :'String',
    :'token' => :'TokensForwardingSuccessToken'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      blockchain == o.blockchain &&
      network == o.network &&
      from_address == o.from_address &&
      to_address == o.to_address &&
      spent_fees_amount == o.spent_fees_amount &&
      spent_fees_unit == o.spent_fees_unit &&
      trigger_transaction_id == o.trigger_transaction_id &&
      forwarding_transaction_id == o.forwarding_transaction_id &&
      token_type == o.token_type &&
      token == o.token
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 307

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 378

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



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

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


263
264
265
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 263

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



269
270
271
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 269

def hash
  [blockchain, network, from_address, to_address, spent_fees_amount, spent_fees_unit, trigger_transaction_id, forwarding_transaction_id, token_type, token].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



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
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 171

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

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

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

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

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

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

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

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

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

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



354
355
356
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 360

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



348
349
350
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 348

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/crypto_apis/models/tokens_forwarding_success_data_item.rb', line 218

def valid?
  return false if @blockchain.nil?
  return false if @network.nil?
  return false if @from_address.nil?
  return false if @to_address.nil?
  return false if @spent_fees_amount.nil?
  return false if @spent_fees_unit.nil?
  return false if @trigger_transaction_id.nil?
  return false if @forwarding_transaction_id.nil?
  return false if @token_type.nil?
  token_type_validator = EnumAttributeValidator.new('String', ["ERC-20", "ERC-721", "OMNI"])
  return false unless token_type_validator.valid?(@token_type)
  return false if @token.nil?
  true
end