Class: Shipeasy::Admin::Generated::KeyRecord

Inherits:
ApiModelBase show all
Defined in:
lib/shipeasy_admin/models/key_record.rb

Overview

A single API key as returned by the list endpoint. Response fields are snake_case. The raw token is never returned here — only its last4 tail. last4 and the typed scopes may be null for keys minted before those columns existed.

Defined Under Namespace

Classes: EnumAttributeValidator

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 127

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

ISO-8601 timestamp the key was minted.



29
30
31
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 29

def created_at
  @created_at
end

#created_by_email ⇒ Object

Email of the human or actor that minted the key, or null when not attributable (e.g. CLI device-flow).



38
39
40
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 38

def created_by_email
  @created_by_email
end

#env ⇒ Object

Environment the key is bound to. The worker derives the read env from the key, so this is the isolation boundary. admin/ops keys are env-agnostic and pinned to prod.



26
27
28
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 26

def env
  @env
end

#expires_at ⇒ Object

ISO-8601 expiry, or null for a key that never expires. admin keys are fixed at 90 days; ops keys use a short sliding window.



35
36
37
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 35

def expires_at
  @expires_at
end

#id ⇒ Object

Stable opaque key id (UUID). Use it to revoke the key.



20
21
22
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 20

def id
  @id
end

#last4 ⇒ Object

Last 4 characters of the raw token, so the dashboard mask is matchable against the held key. null for keys minted before this column.



47
48
49
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 47

def last4
  @last4
end

#name ⇒ Object

Human label for the key. null for unnamed dashboard mints; programmatic mints auto-name themselves.



41
42
43
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 41

def name
  @name
end

#revoked_at ⇒ Object

ISO-8601 timestamp the key was revoked, or null while the key is active.



32
33
34
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 32

def revoked_at
  @revoked_at
end

#scopes ⇒ Object

Permission strings recorded on the key for audit/display, or null when none were set.



44
45
46
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 44

def scopes
  @scopes
end

#type ⇒ Object

Key kind. server (back-end, full SDK auth), client (public, browser-embeddable), admin (CLI/devtools auth token), ops (restricted unattended-trigger credential).



23
24
25
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 23

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



88
89
90
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 88

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 93

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 72

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'env' => :'env',
    :'created_at' => :'created_at',
    :'revoked_at' => :'revoked_at',
    :'expires_at' => :'expires_at',
    :'created_by_email' => :'created_by_email',
    :'name' => :'name',
    :'scopes' => :'scopes',
    :'last4' => :'last4'
  }
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 315

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



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 114

def self.openapi_nullable
  Set.new([
    :'revoked_at',
    :'expires_at',
    :'created_by_email',
    :'name',
    :'scopes',
    :'last4'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 98

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'env' => :'String',
    :'created_at' => :'String',
    :'revoked_at' => :'String',
    :'expires_at' => :'String',
    :'created_by_email' => :'String',
    :'name' => :'String',
    :'scopes' => :'Array<String>',
    :'last4' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      env == o.env &&
      created_at == o.created_at &&
      revoked_at == o.revoked_at &&
      expires_at == o.expires_at &&
      created_by_email == o.created_by_email &&
      name == o.name &&
      scopes == o.scopes &&
      last4 == o.last4
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


302
303
304
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 302

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



308
309
310
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 308

def hash
  [id, type, env, created_at, revoked_at, expires_at, created_by_email, name, scopes, last4].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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 206

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 @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

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

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 337

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



230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/shipeasy_admin/models/key_record.rb', line 230

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @id.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["server", "client", "admin", "ops"])
  return false unless type_validator.valid?(@type)
  return false if @env.nil?
  env_validator = EnumAttributeValidator.new('String', ["dev", "staging", "prod"])
  return false unless env_validator.valid?(@env)
  return false if @created_at.nil?
  true
end