Class: OpenApiOpenAIClient::ProjectApiKey

Inherits:
ApiModelBase show all
Defined in:
lib/openapi_openai/models/project_api_key.rb

Overview

Represents an individual API key in a project.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 100

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

The Unix timestamp (in seconds) of when the API key was created



29
30
31
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 29

def created_at
  @created_at
end

#id ⇒ Object

The identifier, which can be referenced in API endpoints



32
33
34
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 32

def id
  @id
end

#name ⇒ Object

The name of the API key



26
27
28
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 26

def name
  @name
end

#object ⇒ Object

The object type, which is always organization.project.api_key



20
21
22
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 20

def object
  @object
end

#owner ⇒ Object

Returns the value of attribute owner.



34
35
36
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 34

def owner
  @owner
end

#redacted_value ⇒ Object

The redacted value of the API key



23
24
25
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 23

def redacted_value
  @redacted_value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 76

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 59

def self.attribute_map
  {
    :'object' => :'object',
    :'redacted_value' => :'redacted_value',
    :'name' => :'name',
    :'created_at' => :'created_at',
    :'id' => :'id',
    :'owner' => :'owner'
  }
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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 286

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



93
94
95
96
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 81

def self.openapi_types
  {
    :'object' => :'String',
    :'redacted_value' => :'String',
    :'name' => :'String',
    :'created_at' => :'Integer',
    :'id' => :'String',
    :'owner' => :'ProjectApiKeyOwner'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 260

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      redacted_value == o.redacted_value &&
      name == o.name &&
      created_at == o.created_at &&
      id == o.id &&
      owner == o.owner
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 279

def hash
  [object, redacted_value, name, created_at, id, owner].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



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
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 153

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

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

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

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

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

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 308

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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openapi_openai/models/project_api_key.rb', line 185

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["organization.project.api_key"])
  return false unless object_validator.valid?(@object)
  return false if @redacted_value.nil?
  return false if @name.nil?
  return false if @created_at.nil?
  return false if @id.nil?
  return false if @owner.nil?
  true
end