Class: Coinbase::Client::FetchStakingRewardsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/coinbase/client/models/fetch_staking_rewards_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FetchStakingRewardsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 94

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

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

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

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

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

  if attributes.key?(:'format')
    self.format = attributes[:'format']
  else
    self.format = 'usd'
  end
end

Instance Attribute Details

#address_ids ⇒ Object

The onchain addresses for which the staking rewards are being fetched



25
26
27
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 25

def address_ids
  @address_ids
end

#asset_id ⇒ Object

The ID of the asset for which the staking rewards are being fetched



22
23
24
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 22

def asset_id
  @asset_id
end

#end_time ⇒ Object

The end time of this reward period



31
32
33
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 31

def end_time
  @end_time
end

#format ⇒ Object

Returns the value of attribute format.



33
34
35
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 33

def format
  @format
end

#network_id ⇒ Object

The ID of the blockchain network



19
20
21
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 19

def network_id
  @network_id
end

#start_time ⇒ Object

The start time of this reward period



28
29
30
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 28

def start_time
  @start_time
end

Class Method Details

._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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 243

def self._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 = Coinbase::Client.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 58

def self.attribute_map
  {
    :'network_id' => :'network_id',
    :'asset_id' => :'asset_id',
    :'address_ids' => :'address_ids',
    :'start_time' => :'start_time',
    :'end_time' => :'end_time',
    :'format' => :'format'
  }
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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 219

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



87
88
89
90
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 75

def self.openapi_types
  {
    :'network_id' => :'String',
    :'asset_id' => :'String',
    :'address_ids' => :'Array<String>',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'format' => :'StakingRewardFormat'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      network_id == o.network_id &&
      asset_id == o.asset_id &&
      address_ids == o.address_ids &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      format == o.format
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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 314

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


206
207
208
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 206

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



212
213
214
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 212

def hash
  [network_id, asset_id, address_ids, start_time, end_time, format].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



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
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 148

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

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

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

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

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

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



290
291
292
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 296

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



284
285
286
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 284

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



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/coinbase/client/models/fetch_staking_rewards_request.rb', line 180

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @network_id.nil?
  return false if @asset_id.nil?
  return false if @address_ids.nil?
  return false if @start_time.nil?
  return false if @end_time.nil?
  return false if @format.nil?
  true
end