Class: LiteLLMClient::UpdateKeyRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/models/update_key_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateKeyRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/litellm_client/models/update_key_request.rb', line 192

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#aliases ⇒ Object

Returns the value of attribute aliases.



58
59
60
 
# File 'lib/litellm_client/models/update_key_request.rb', line 58

def aliases
  @aliases
end

#allowed_cache_controls ⇒ Object

Returns the value of attribute allowed_cache_controls.



42
43
44
 
# File 'lib/litellm_client/models/update_key_request.rb', line 42

def allowed_cache_controls
  @allowed_cache_controls
end

#allowed_routes ⇒ Object

Returns the value of attribute allowed_routes.



70
71
72
 
# File 'lib/litellm_client/models/update_key_request.rb', line 70

def allowed_routes
  @allowed_routes
end

#blocked ⇒ Object

Returns the value of attribute blocked.



56
57
58
 
# File 'lib/litellm_client/models/update_key_request.rb', line 56

def blocked
  @blocked
end

#budget_duration ⇒ Object

Returns the value of attribute budget_duration.



40
41
42
 
# File 'lib/litellm_client/models/update_key_request.rb', line 40

def budget_duration
  @budget_duration
end

#budget_id ⇒ Object

Returns the value of attribute budget_id.



64
65
66
 
# File 'lib/litellm_client/models/update_key_request.rb', line 64

def budget_id
  @budget_id
end

#config ⇒ Object

Returns the value of attribute config.



44
45
46
 
# File 'lib/litellm_client/models/update_key_request.rb', line 44

def config
  @config
end

#duration ⇒ Object

Returns the value of attribute duration.



20
21
22
 
# File 'lib/litellm_client/models/update_key_request.rb', line 20

def duration
  @duration
end

#enforced_params ⇒ Object

Returns the value of attribute enforced_params.



68
69
70
 
# File 'lib/litellm_client/models/update_key_request.rb', line 68

def enforced_params
  @enforced_params
end

#guardrails ⇒ Object

Returns the value of attribute guardrails.



54
55
56
 
# File 'lib/litellm_client/models/update_key_request.rb', line 54

def guardrails
  @guardrails
end

#key ⇒ Object

Returns the value of attribute key.



62
63
64
 
# File 'lib/litellm_client/models/update_key_request.rb', line 62

def key
  @key
end

#key_alias ⇒ Object

Returns the value of attribute key_alias.



18
19
20
 
# File 'lib/litellm_client/models/update_key_request.rb', line 18

def key_alias
  @key_alias
end

#max_budget ⇒ Object

Returns the value of attribute max_budget.



26
27
28
 
# File 'lib/litellm_client/models/update_key_request.rb', line 26

def max_budget
  @max_budget
end

#max_parallel_requests ⇒ Object

Returns the value of attribute max_parallel_requests.



32
33
34
 
# File 'lib/litellm_client/models/update_key_request.rb', line 32

def max_parallel_requests
  @max_parallel_requests
end

#metadata ⇒ Object

Returns the value of attribute metadata.



34
35
36
 
# File 'lib/litellm_client/models/update_key_request.rb', line 34

def metadata
  @metadata
end

#model_max_budget ⇒ Object

Returns the value of attribute model_max_budget.



48
49
50
 
# File 'lib/litellm_client/models/update_key_request.rb', line 48

def model_max_budget
  @model_max_budget
end

#model_rpm_limit ⇒ Object

Returns the value of attribute model_rpm_limit.



50
51
52
 
# File 'lib/litellm_client/models/update_key_request.rb', line 50

def model_rpm_limit
  @model_rpm_limit
end

#model_tpm_limit ⇒ Object

Returns the value of attribute model_tpm_limit.



52
53
54
 
# File 'lib/litellm_client/models/update_key_request.rb', line 52

def model_tpm_limit
  @model_tpm_limit
end

#models ⇒ Object

Returns the value of attribute models.



22
23
24
 
# File 'lib/litellm_client/models/update_key_request.rb', line 22

def models
  @models
end

#object_permission ⇒ Object

Returns the value of attribute object_permission.



60
61
62
 
# File 'lib/litellm_client/models/update_key_request.rb', line 60

def object_permission
  @object_permission
end

#permissions ⇒ Object

Returns the value of attribute permissions.



46
47
48
 
# File 'lib/litellm_client/models/update_key_request.rb', line 46

def permissions
  @permissions
end

#rpm_limit ⇒ Object

Returns the value of attribute rpm_limit.



38
39
40
 
# File 'lib/litellm_client/models/update_key_request.rb', line 38

def rpm_limit
  @rpm_limit
end

#spend ⇒ Object

Returns the value of attribute spend.



24
25
26
 
# File 'lib/litellm_client/models/update_key_request.rb', line 24

def spend
  @spend
end

#tags ⇒ Object

Returns the value of attribute tags.



66
67
68
 
# File 'lib/litellm_client/models/update_key_request.rb', line 66

def tags
  @tags
end

#team_id ⇒ Object

Returns the value of attribute team_id.



30
31
32
 
# File 'lib/litellm_client/models/update_key_request.rb', line 30

def team_id
  @team_id
end

#temp_budget_expiry ⇒ Object

Returns the value of attribute temp_budget_expiry.



74
75
76
 
# File 'lib/litellm_client/models/update_key_request.rb', line 74

def temp_budget_expiry
  @temp_budget_expiry
end

#temp_budget_increase ⇒ Object

Returns the value of attribute temp_budget_increase.



72
73
74
 
# File 'lib/litellm_client/models/update_key_request.rb', line 72

def temp_budget_increase
  @temp_budget_increase
end

#tpm_limit ⇒ Object

Returns the value of attribute tpm_limit.



36
37
38
 
# File 'lib/litellm_client/models/update_key_request.rb', line 36

def tpm_limit
  @tpm_limit
end

#user_id ⇒ Object

Returns the value of attribute user_id.



28
29
30
 
# File 'lib/litellm_client/models/update_key_request.rb', line 28

def user_id
  @user_id
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/litellm_client/models/update_key_request.rb', line 456

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = LiteLLMClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



112
113
114
 
# File 'lib/litellm_client/models/update_key_request.rb', line 112

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/litellm_client/models/update_key_request.rb', line 117

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
104
105
106
107
108
109
 
# File 'lib/litellm_client/models/update_key_request.rb', line 77

def self.attribute_map
  {
    :'key_alias' => :'key_alias',
    :'duration' => :'duration',
    :'models' => :'models',
    :'spend' => :'spend',
    :'max_budget' => :'max_budget',
    :'user_id' => :'user_id',
    :'team_id' => :'team_id',
    :'max_parallel_requests' => :'max_parallel_requests',
    :'metadata' => :'metadata',
    :'tpm_limit' => :'tpm_limit',
    :'rpm_limit' => :'rpm_limit',
    :'budget_duration' => :'budget_duration',
    :'allowed_cache_controls' => :'allowed_cache_controls',
    :'config' => :'config',
    :'permissions' => :'permissions',
    :'model_max_budget' => :'model_max_budget',
    :'model_rpm_limit' => :'model_rpm_limit',
    :'model_tpm_limit' => :'model_tpm_limit',
    :'guardrails' => :'guardrails',
    :'blocked' => :'blocked',
    :'aliases' => :'aliases',
    :'object_permission' => :'object_permission',
    :'key' => :'key',
    :'budget_id' => :'budget_id',
    :'tags' => :'tags',
    :'enforced_params' => :'enforced_params',
    :'allowed_routes' => :'allowed_routes',
    :'temp_budget_increase' => :'temp_budget_increase',
    :'temp_budget_expiry' => :'temp_budget_expiry'
  }
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



432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/litellm_client/models/update_key_request.rb', line 432

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



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
 
# File 'lib/litellm_client/models/update_key_request.rb', line 157

def self.openapi_nullable
  Set.new([
    :'key_alias',
    :'duration',
    :'models',
    :'spend',
    :'max_budget',
    :'user_id',
    :'team_id',
    :'max_parallel_requests',
    :'metadata',
    :'tpm_limit',
    :'rpm_limit',
    :'budget_duration',
    :'allowed_cache_controls',
    :'config',
    :'permissions',
    :'model_max_budget',
    :'model_rpm_limit',
    :'model_tpm_limit',
    :'guardrails',
    :'blocked',
    :'aliases',
    :'object_permission',
    :'budget_id',
    :'tags',
    :'enforced_params',
    :'allowed_routes',
    :'temp_budget_increase',
    :'temp_budget_expiry'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/litellm_client/models/update_key_request.rb', line 122

def self.openapi_types
  {
    :'key_alias' => :'String',
    :'duration' => :'String',
    :'models' => :'Array<Object>',
    :'spend' => :'Float',
    :'max_budget' => :'Float',
    :'user_id' => :'String',
    :'team_id' => :'String',
    :'max_parallel_requests' => :'Integer',
    :'metadata' => :'Hash<String, Object>',
    :'tpm_limit' => :'Integer',
    :'rpm_limit' => :'Integer',
    :'budget_duration' => :'String',
    :'allowed_cache_controls' => :'Array<Object>',
    :'config' => :'Hash<String, Object>',
    :'permissions' => :'Hash<String, Object>',
    :'model_max_budget' => :'Hash<String, Object>',
    :'model_rpm_limit' => :'Hash<String, Object>',
    :'model_tpm_limit' => :'Hash<String, Object>',
    :'guardrails' => :'Array<String>',
    :'blocked' => :'Boolean',
    :'aliases' => :'Hash<String, Object>',
    :'object_permission' => :'LiteLLMObjectPermissionBase',
    :'key' => :'String',
    :'budget_id' => :'String',
    :'tags' => :'Array<String>',
    :'enforced_params' => :'Array<String>',
    :'allowed_routes' => :'Array<Object>',
    :'temp_budget_increase' => :'Float',
    :'temp_budget_expiry' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/litellm_client/models/update_key_request.rb', line 383

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key_alias == o.key_alias &&
      duration == o.duration &&
      models == o.models &&
      spend == o.spend &&
      max_budget == o.max_budget &&
      user_id == o.user_id &&
      team_id == o.team_id &&
      max_parallel_requests == o.max_parallel_requests &&
      metadata == o.metadata &&
      tpm_limit == o.tpm_limit &&
      rpm_limit == o.rpm_limit &&
      budget_duration == o.budget_duration &&
      allowed_cache_controls == o.allowed_cache_controls &&
      config == o.config &&
      permissions == o.permissions &&
      model_max_budget == o.model_max_budget &&
      model_rpm_limit == o.model_rpm_limit &&
      model_tpm_limit == o.model_tpm_limit &&
      guardrails == o.guardrails &&
      blocked == o.blocked &&
      aliases == o.aliases &&
      object_permission == o.object_permission &&
      key == o.key &&
      budget_id == o.budget_id &&
      tags == o.tags &&
      enforced_params == o.enforced_params &&
      allowed_routes == o.allowed_routes &&
      temp_budget_increase == o.temp_budget_increase &&
      temp_budget_expiry == o.temp_budget_expiry
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/litellm_client/models/update_key_request.rb', line 527

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


419
420
421
 
# File 'lib/litellm_client/models/update_key_request.rb', line 419

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



425
426
427
 
# File 'lib/litellm_client/models/update_key_request.rb', line 425

def hash
  [key_alias, duration, models, spend, max_budget, user_id, team_id, max_parallel_requests, metadata, tpm_limit, rpm_limit, budget_duration, allowed_cache_controls, config, permissions, model_max_budget, model_rpm_limit, model_tpm_limit, guardrails, blocked, aliases, object_permission, key, budget_id, tags, enforced_params, allowed_routes, temp_budget_increase, temp_budget_expiry].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



353
354
355
356
357
358
359
360
361
 
# File 'lib/litellm_client/models/update_key_request.rb', line 353

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



503
504
505
 
# File 'lib/litellm_client/models/update_key_request.rb', line 503

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/litellm_client/models/update_key_request.rb', line 509

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



497
498
499
 
# File 'lib/litellm_client/models/update_key_request.rb', line 497

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



365
366
367
368
369
 
# File 'lib/litellm_client/models/update_key_request.rb', line 365

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @key.nil?
  true
end