Class: OpenApiOpenAIClient::ApiKeyList

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/openapi_openai/models/api_key_list.rb', line 68

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

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

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

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

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

Instance Attribute Details

#dataObject

Returns the value of attribute data.



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

def data
  @data
end

#first_idObject

Returns the value of attribute first_id.



24
25
26
# File 'lib/openapi_openai/models/api_key_list.rb', line 24

def first_id
  @first_id
end

#has_moreObject

Returns the value of attribute has_more.



22
23
24
# File 'lib/openapi_openai/models/api_key_list.rb', line 22

def has_more
  @has_more
end

#last_idObject

Returns the value of attribute last_id.



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

def last_id
  @last_id
end

#objectObject

Returns the value of attribute object.



18
19
20
# File 'lib/openapi_openai/models/api_key_list.rb', line 18

def object
  @object
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



40
41
42
# File 'lib/openapi_openai/models/api_key_list.rb', line 40

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



45
46
47
# File 'lib/openapi_openai/models/api_key_list.rb', line 45

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



29
30
31
32
33
34
35
36
37
# File 'lib/openapi_openai/models/api_key_list.rb', line 29

def self.attribute_map
  {
    :'object' => :'object',
    :'data' => :'data',
    :'has_more' => :'has_more',
    :'first_id' => :'first_id',
    :'last_id' => :'last_id'
  }
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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/openapi_openai/models/api_key_list.rb', line 147

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_nullableObject

List of attributes with nullable: true



61
62
63
64
# File 'lib/openapi_openai/models/api_key_list.rb', line 61

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

.openapi_typesObject

Attribute type mapping.



50
51
52
53
54
55
56
57
58
# File 'lib/openapi_openai/models/api_key_list.rb', line 50

def self.openapi_types
  {
    :'object' => :'String',
    :'data' => :'Array<AdminApiKey>',
    :'has_more' => :'Boolean',
    :'first_id' => :'String',
    :'last_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



122
123
124
125
126
127
128
129
130
# File 'lib/openapi_openai/models/api_key_list.rb', line 122

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      data == o.data &&
      has_more == o.has_more &&
      first_id == o.first_id &&
      last_id == o.last_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


134
135
136
# File 'lib/openapi_openai/models/api_key_list.rb', line 134

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



140
141
142
# File 'lib/openapi_openai/models/api_key_list.rb', line 140

def hash
  [object, data, has_more, first_id, last_id].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



107
108
109
110
111
# File 'lib/openapi_openai/models/api_key_list.rb', line 107

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/openapi_openai/models/api_key_list.rb', line 169

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



115
116
117
118
# File 'lib/openapi_openai/models/api_key_list.rb', line 115

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end