Class: Coinbase::Client::OnchainName

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

Overview

A representation of an onchain stored name from name systems i.e. ENS or Basenames

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OnchainName

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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 94

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#avatar ⇒ Object

The visual representation attached to this name



35
36
37
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 35

def avatar
  @avatar
end

#domain ⇒ Object

The readable format for the name in complete form



32
33
34
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 32

def domain
  @domain
end

#expires_at ⇒ Object

The expiration date for this name’s ownership



41
42
43
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 41

def expires_at
  @expires_at
end

#is_primary ⇒ Object

Whether this name is the primary name for the owner (This is when the ETH coin address for this name is equal to the primary_address. More info here docs.ens.domains/ensip/19)



47
48
49
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 47

def is_primary
  @is_primary
end

#manager_address ⇒ Object

The onchain address of the manager of the name



26
27
28
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 26

def manager_address
  @manager_address
end

#network_id ⇒ Object

The ID of the blockchain network



38
39
40
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 38

def network_id
  @network_id
end

#owner_address ⇒ Object

The onchain address of the owner of the name



23
24
25
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 23

def owner_address
  @owner_address
end

#primary_address ⇒ Object

The primary onchain address of the name



29
30
31
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 29

def primary_address
  @primary_address
end

#text_records ⇒ Object

The metadata attached to this name



44
45
46
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 44

def text_records
  @text_records
end

#token_id ⇒ Object

The ID for the NFT related to this name



20
21
22
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 20

def token_id
  @token_id
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 270

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



66
67
68
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 50

def self.attribute_map
  {
    :'token_id' => :'token_id',
    :'owner_address' => :'owner_address',
    :'manager_address' => :'manager_address',
    :'primary_address' => :'primary_address',
    :'domain' => :'domain',
    :'avatar' => :'avatar',
    :'network_id' => :'network_id',
    :'expires_at' => :'expires_at',
    :'text_records' => :'text_records',
    :'is_primary' => :'is_primary'
  }
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 246

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/onchain_name.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'token_id' => :'String',
    :'owner_address' => :'String',
    :'manager_address' => :'String',
    :'primary_address' => :'String',
    :'domain' => :'String',
    :'avatar' => :'String',
    :'network_id' => :'String',
    :'expires_at' => :'Time',
    :'text_records' => :'Hash<String, String>',
    :'is_primary' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 216

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      token_id == o.token_id &&
      owner_address == o.owner_address &&
      manager_address == o.manager_address &&
      primary_address == o.primary_address &&
      domain == o.domain &&
      avatar == o.avatar &&
      network_id == o.network_id &&
      expires_at == o.expires_at &&
      text_records == o.text_records &&
      is_primary == o.is_primary
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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 341

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


233
234
235
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 233

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



239
240
241
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 239

def hash
  [token_id, owner_address, manager_address, primary_address, domain, avatar, network_id, expires_at, text_records, is_primary].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



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/coinbase/client/models/onchain_name.rb', line 166

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

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

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

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

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

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

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



317
318
319
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 317

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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 323

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



311
312
313
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 311

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



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/coinbase/client/models/onchain_name.rb', line 202

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @token_id.nil?
  return false if @owner_address.nil?
  return false if @manager_address.nil?
  return false if @domain.nil?
  return false if @network_id.nil?
  return false if @expires_at.nil?
  return false if @is_primary.nil?
  true
end