Class: Weft::EnrolledResource

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

Overview

The :created view of a ghost resource. Adds stats, the single-use claim_token, and the claim_url to the base resource shape. The claim fields appear ONLY on this enrollment response — never in list or read views.

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 = {}) ⇒ EnrolledResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
199
200
201
202
203
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 110

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#category ⇒ Object

Legacy v3 taxonomy field. Returns a string only for agent-kind resources that carry a category in their metadata; null for all other kinds and for agents without one. Always null on enrollment (category is a post-claim concern).



35
36
37
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 35

def category
  @category
end

#claim_token ⇒ Object

Single-use token for the magic claim URL. Surfaced only on enrollment.



47
48
49
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 47

def claim_token
  @claim_token
end

#claim_url ⇒ Object

Dashboard path the agent hands to its human to claim the resource.



50
51
52
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 50

def claim_url
  @claim_url
end

#claimed ⇒ Object

True once the resource has an owning provider. Always false at enrollment.



40
41
42
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 40

def claimed
  @claimed
end

#created_at ⇒ Object

Returns the value of attribute created_at.



42
43
44
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 42

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#kind ⇒ Object

Returns the value of attribute kind.



27
28
29
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 27

def kind
  @kind
end

#name ⇒ Object

Returns the value of attribute name.



21
22
23
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 21

def name
  @name
end

#slug ⇒ Object

Returns the value of attribute slug.



23
24
25
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 23

def slug
  @slug
end

#stats ⇒ Object

Returns the value of attribute stats.



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

def stats
  @stats
end

#verified ⇒ Object

Returns the value of attribute verified.



37
38
39
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 37

def verified
  @verified
end

#visibility ⇒ Object

Returns the value of attribute visibility.



29
30
31
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 29

def visibility
  @visibility
end

#wallet_address ⇒ Object

Declared wallet address, or null if none was provided.



32
33
34
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 32

def wallet_address
  @wallet_address
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



73
74
75
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 73

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



78
79
80
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 78

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 53

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'slug' => :'slug',
    :'description' => :'description',
    :'kind' => :'kind',
    :'visibility' => :'visibility',
    :'wallet_address' => :'wallet_address',
    :'category' => :'category',
    :'verified' => :'verified',
    :'claimed' => :'claimed',
    :'created_at' => :'created_at',
    :'stats' => :'stats',
    :'claim_token' => :'claim_token',
    :'claim_url' => :'claim_url'
  }
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



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 436

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



103
104
105
106
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 83

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'slug' => :'String',
    :'description' => :'String',
    :'kind' => :'String',
    :'visibility' => :'String',
    :'wallet_address' => :'String',
    :'category' => :'String',
    :'verified' => :'Boolean',
    :'claimed' => :'Boolean',
    :'created_at' => :'Time',
    :'stats' => :'ResourceStats',
    :'claim_token' => :'String',
    :'claim_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 402

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      slug == o.slug &&
      description == o.description &&
      kind == o.kind &&
      visibility == o.visibility &&
      wallet_address == o.wallet_address &&
      category == o.category &&
      verified == o.verified &&
      claimed == o.claimed &&
      created_at == o.created_at &&
      stats == o.stats &&
      claim_token == o.claim_token &&
      claim_url == o.claim_url
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


423
424
425
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 423

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



429
430
431
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 429

def hash
  [id, name, slug, description, kind, visibility, wallet_address, category, verified, claimed, created_at, stats, claim_token, claim_url].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



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

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

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

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

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

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

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

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

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

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

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

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

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



458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 458

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/weft/generated/models/enrolled_resource.rb', line 263

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @name.nil?
  return false if @slug.nil?
  return false if @kind.nil?
  return false if @visibility.nil?
  return false if @category.nil?
  return false if @verified.nil?
  return false if @claimed.nil?
  return false if @created_at.nil?
  return false if @stats.nil?
  return false if @claim_token.nil?
  return false if @claim_url.nil?
  true
end