Class: SmplkitGeneratedClient::App::ApiKey

Inherits:
ApiModelBase show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb

Overview

An API key used by SDKs, scripts, and other programmatic clients to authenticate with the smplkit API on behalf of the account. The full key value is returned in plaintext on the create response and is otherwise unavailable — record it somewhere safe immediately after creation.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 128

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

When the key was created.



44
45
46
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 44

def created_at
  @created_at
end

#created_by ⇒ Object

UUID of the user who created the key.



35
36
37
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 35

def created_by
  @created_by
end

#expires_at ⇒ Object

Optional expiry timestamp. After this time, the key is rejected. Omit for keys that do not expire.



38
39
40
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 38

def expires_at
  @expires_at
end

#key ⇒ Object

The bearer token value. Returned in plaintext on the create response so the caller can capture it; subsequent reads return the same value for round-tripping.



29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 29

def key
  @key
end

#kind ⇒ Object

Credential class of the key, set at creation and immutable. PRIVATE (the default) keys carry full API access and must be kept secret — never expose one in a browser or client application. PUBLIC keys are browser-safe, read-only credentials for reading feature flags and configuration from client-side code; they must be scoped to exactly one environment with permissions: [\"read\"]. Accepted case-insensitively.



23
24
25
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 23

def kind
  @kind
end

#last_used_at ⇒ Object

When the key was most recently used to authenticate.



41
42
43
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 41

def last_used_at
  @last_used_at
end

#name ⇒ Object

Human-readable name for the key.



20
21
22
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 20

def name
  @name
end

#scopes ⇒ Object

Scope restrictions applied to the key, as a JSON object mapping dimension names to arrays of allowed values. An empty object (the default) grants unrestricted access. The environments dimension lists the environment keys the key may operate in (for example {\"environments\": [\"production\"]}); a request's environment must be one of them. A dimension that is absent or set to an empty array is unrestricted in that dimension.



32
33
34
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 32

def scopes
  @scopes
end

#status ⇒ Object

Lifecycle state of the key. ACTIVE keys may be used to authenticate; REVOKED keys are rejected.



26
27
28
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 26

def status
  @status
end

#updated_at ⇒ Object

When the key was last modified.



47
48
49
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 47

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



88
89
90
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.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/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.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/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 72

def self.attribute_map
  {
    :'name' => :'name',
    :'kind' => :'kind',
    :'status' => :'status',
    :'key' => :'key',
    :'scopes' => :'scopes',
    :'created_by' => :'created_by',
    :'expires_at' => :'expires_at',
    :'last_used_at' => :'last_used_at',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 272

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
124
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 114

def self.openapi_nullable
  Set.new([
    :'status',
    :'key',
    :'created_by',
    :'expires_at',
    :'last_used_at',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 98

def self.openapi_types
  {
    :'name' => :'String',
    :'kind' => :'String',
    :'status' => :'String',
    :'key' => :'String',
    :'scopes' => :'Hash<String, Object>',
    :'created_by' => :'String',
    :'expires_at' => :'Time',
    :'last_used_at' => :'Time',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      kind == o.kind &&
      status == o.status &&
      key == o.key &&
      scopes == o.scopes &&
      created_by == o.created_by &&
      expires_at == o.expires_at &&
      last_used_at == o.last_used_at &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


259
260
261
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 265

def hash
  [name, kind, status, key, scopes, created_by, expires_at, last_used_at, created_at, updated_at].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



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 191

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

  if @name.to_s.length > 255
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
  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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 294

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



207
208
209
210
211
212
213
214
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb', line 207

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 255
  kind_validator = EnumAttributeValidator.new('String', ["PUBLIC", "PRIVATE"])
  return false unless kind_validator.valid?(@kind)
  true
end