Class: Weft::FetchBalanceSnapshot

Inherits:
ApiModelBase show all
Defined in:
lib/weft/generated/models/fetch_balance_snapshot.rb

Overview

Compact balance snapshot returned inside FetchErrorResponse. Less rich than BalanceResponse — just the fields a CLI needs to explain why a fetch failed.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ FetchBalanceSnapshot

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 72

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Weft::FetchBalanceSnapshot` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Weft::FetchBalanceSnapshot`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

Instance Attribute Details

#promo_usd ⇒ Object

Returns the value of attribute promo_usd.



19
20
21
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 19

def promo_usd
  @promo_usd
end

#spent_today_usd ⇒ Object

Returns the value of attribute spent_today_usd.



30
31
32
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 30

def spent_today_usd
  @spent_today_usd
end

#tempo_usd ⇒ Object

Aggregated USD of allowlisted Tempo dollar tokens, 2dp. null when UNKNOWN (RPC read failed or no token allowlisted for the paired chain) — never "0.00" for an unread component.



25
26
27
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 25

def tempo_usd
  @tempo_usd
end

#total_usd ⇒ Object

Aggregated USD balance = Base USDC + Tempo dollar tokens, 2dp. Equals wallet_usdc alone when tempo_usd is null. Null when the Base USDC provider is unreachable.



28
29
30
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 28

def total_usd
  @total_usd
end

#wallet_usdc ⇒ Object

Live Base USDC balance.



22
23
24
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 22

def wallet_usdc
  @wallet_usdc
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



44
45
46
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 44

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 49

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 33

def self.attribute_map
  {
    :'promo_usd' => :'promo_usd',
    :'wallet_usdc' => :'wallet_usdc',
    :'tempo_usd' => :'tempo_usd',
    :'total_usd' => :'total_usd',
    :'spent_today_usd' => :'spent_today_usd'
  }
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/weft/generated/models/fetch_balance_snapshot.rb', line 234

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



65
66
67
68
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 54

def self.openapi_types
  {
    :'promo_usd' => :'String',
    :'wallet_usdc' => :'String',
    :'tempo_usd' => :'String',
    :'total_usd' => :'String',
    :'spent_today_usd' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



209
210
211
212
213
214
215
216
217
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 209

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      promo_usd == o.promo_usd &&
      wallet_usdc == o.wallet_usdc &&
      tempo_usd == o.tempo_usd &&
      total_usd == o.total_usd &&
      spent_today_usd == o.spent_today_usd
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


221
222
223
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 227

def hash
  [promo_usd, wallet_usdc, tempo_usd, total_usd, spent_today_usd].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



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
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 119

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @promo_usd.nil?
    invalid_properties.push('invalid value for "promo_usd", promo_usd cannot be nil.')
  end

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 256

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



147
148
149
150
151
152
153
154
155
 
# File 'lib/weft/generated/models/fetch_balance_snapshot.rb', line 147

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @promo_usd.nil?
  return false if @wallet_usdc.nil?
  return false if @tempo_usd.nil?
  return false if @total_usd.nil?
  return false if @spent_today_usd.nil?
  true
end