Class: LiteLLMClient::CredentialManagementApi

Inherits:
Object
  • Object
show all
Defined in:
lib/litellm_client/api/credential_management_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CredentialManagementApi

Returns a new instance of CredentialManagementApi.



19
20
21
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_credential_credentials_post(create_credential_item, opts = {}) ⇒ Object

Create Credential

BETA

endpoint. This might change unexpectedly. Stores credential in DB. Reloads credentials in memory.

Parameters:

  • create_credential_item (CreateCredentialItem)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 27

def create_credential_credentials_post(create_credential_item, opts = {})
  data, _status_code, _headers = create_credential_credentials_post_with_http_info(create_credential_item, opts)
  data
end

#create_credential_credentials_post_with_http_info(create_credential_item, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Create Credential

BETA

endpoint. This might change unexpectedly. Stores credential in DB. Reloads credentials in memory.

Parameters:

  • create_credential_item (CreateCredentialItem)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 37

def create_credential_credentials_post_with_http_info(create_credential_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialManagementApi.create_credential_credentials_post ...'
  end
  # verify the required parameter 'create_credential_item' is set
  if @api_client.config.client_side_validation && create_credential_item.nil?
    fail ArgumentError, "Missing the required parameter 'create_credential_item' when calling CredentialManagementApi.create_credential_credentials_post"
  end
  # resource path
  local_var_path = '/credentials'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_credential_item)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"CredentialManagementApi.create_credential_credentials_post",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialManagementApi#create_credential_credentials_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_credential_credentials_credential_name_delete(credential_name, opts = {}) ⇒ Object

Delete Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

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

    the optional parameters

Returns:

  • (Object) 


95
96
97
98
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 95

def delete_credential_credentials_credential_name_delete(credential_name, opts = {})
  data, _status_code, _headers = delete_credential_credentials_credential_name_delete_with_http_info(credential_name, opts)
  data
end

#delete_credential_credentials_credential_name_delete_with_http_info(credential_name, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
150
151
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 105

def delete_credential_credentials_credential_name_delete_with_http_info(credential_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialManagementApi.delete_credential_credentials_credential_name_delete ...'
  end
  # verify the required parameter 'credential_name' is set
  if @api_client.config.client_side_validation && credential_name.nil?
    fail ArgumentError, "Missing the required parameter 'credential_name' when calling CredentialManagementApi.delete_credential_credentials_credential_name_delete"
  end
  # resource path
  local_var_path = '/credentials/{credential_name}'.sub('{' + 'credential_name' + '}', CGI.escape(credential_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"CredentialManagementApi.delete_credential_credentials_credential_name_delete",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialManagementApi#delete_credential_credentials_credential_name_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credential_credentials_by_model_model_id_get(credential_name, model_id, opts = {}) ⇒ CredentialItem

Get Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

  • model_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



159
160
161
162
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 159

def get_credential_credentials_by_model_model_id_get(credential_name, model_id, opts = {})
  data, _status_code, _headers = get_credential_credentials_by_model_model_id_get_with_http_info(credential_name, model_id, opts)
  data
end

#get_credential_credentials_by_model_model_id_get_with_http_info(credential_name, model_id, opts = {}) ⇒ Array<(CredentialItem, Integer, Hash)>

Get Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

  • model_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CredentialItem, Integer, Hash)>) —

    CredentialItem data, response status code and response headers



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 170

def get_credential_credentials_by_model_model_id_get_with_http_info(credential_name, model_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialManagementApi.get_credential_credentials_by_model_model_id_get ...'
  end
  # verify the required parameter 'credential_name' is set
  if @api_client.config.client_side_validation && credential_name.nil?
    fail ArgumentError, "Missing the required parameter 'credential_name' when calling CredentialManagementApi.get_credential_credentials_by_model_model_id_get"
  end
  # resource path
  local_var_path = '/credentials/by_model/{model_id}'.sub('{' + 'credential_name' + '}', CGI.escape(credential_name.to_s)).sub('{' + 'model_id' + '}', CGI.escape(model_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CredentialItem'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"CredentialManagementApi.get_credential_credentials_by_model_model_id_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialManagementApi#get_credential_credentials_by_model_model_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credential_credentials_by_name_credential_name_get(credential_name, opts = {}) ⇒ CredentialItem

Get Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

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

    the optional parameters

Options Hash (opts):

  • :model_id (String)

Returns:



224
225
226
227
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 224

def get_credential_credentials_by_name_credential_name_get(credential_name, opts = {})
  data, _status_code, _headers = get_credential_credentials_by_name_credential_name_get_with_http_info(credential_name, opts)
  data
end

#get_credential_credentials_by_name_credential_name_get_with_http_info(credential_name, opts = {}) ⇒ Array<(CredentialItem, Integer, Hash)>

Get Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

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

    the optional parameters

Options Hash (opts):

  • :model_id (String)

Returns:

  • (Array<(CredentialItem, Integer, Hash)>) —

    CredentialItem data, response status code and response headers



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
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 235

def get_credential_credentials_by_name_credential_name_get_with_http_info(credential_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialManagementApi.get_credential_credentials_by_name_credential_name_get ...'
  end
  # verify the required parameter 'credential_name' is set
  if @api_client.config.client_side_validation && credential_name.nil?
    fail ArgumentError, "Missing the required parameter 'credential_name' when calling CredentialManagementApi.get_credential_credentials_by_name_credential_name_get"
  end
  # resource path
  local_var_path = '/credentials/by_name/{credential_name}'.sub('{' + 'credential_name' + '}', CGI.escape(credential_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'model_id'] = opts[:'model_id'] if !opts[:'model_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CredentialItem'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"CredentialManagementApi.get_credential_credentials_by_name_credential_name_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialManagementApi#get_credential_credentials_by_name_credential_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_credentials_credentials_get(opts = {}) ⇒ Object

Get Credentials

BETA

endpoint. This might change unexpectedly.

Parameters:

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

    the optional parameters

Returns:

  • (Object) 


288
289
290
291
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 288

def get_credentials_credentials_get(opts = {})
  data, _status_code, _headers = get_credentials_credentials_get_with_http_info(opts)
  data
end

#get_credentials_credentials_get_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Credentials

BETA

endpoint. This might change unexpectedly.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



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
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 297

def get_credentials_credentials_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialManagementApi.get_credentials_credentials_get ...'
  end
  # resource path
  local_var_path = '/credentials'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"CredentialManagementApi.get_credentials_credentials_get",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialManagementApi#get_credentials_credentials_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_credential_credentials_credential_name_patch(credential_name, credential_item, opts = {}) ⇒ Object

Update Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

  • credential_item (CredentialItem)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


347
348
349
350
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 347

def update_credential_credentials_credential_name_patch(credential_name, credential_item, opts = {})
  data, _status_code, _headers = update_credential_credentials_credential_name_patch_with_http_info(credential_name, credential_item, opts)
  data
end

#update_credential_credentials_credential_name_patch_with_http_info(credential_name, credential_item, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Update Credential

BETA

endpoint. This might change unexpectedly.

Parameters:

  • credential_name (String) —

    The credential name, percent-decoded; may contain slashes

  • credential_item (CredentialItem)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
 
# File 'lib/litellm_client/api/credential_management_api.rb', line 358

def update_credential_credentials_credential_name_patch_with_http_info(credential_name, credential_item, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CredentialManagementApi.update_credential_credentials_credential_name_patch ...'
  end
  # verify the required parameter 'credential_name' is set
  if @api_client.config.client_side_validation && credential_name.nil?
    fail ArgumentError, "Missing the required parameter 'credential_name' when calling CredentialManagementApi.update_credential_credentials_credential_name_patch"
  end
  # verify the required parameter 'credential_item' is set
  if @api_client.config.client_side_validation && credential_item.nil?
    fail ArgumentError, "Missing the required parameter 'credential_item' when calling CredentialManagementApi.update_credential_credentials_credential_name_patch"
  end
  # resource path
  local_var_path = '/credentials/{credential_name}'.sub('{' + 'credential_name' + '}', CGI.escape(credential_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credential_item)

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['APIKeyHeader']

  new_options = opts.merge(
    :operation => :"CredentialManagementApi.update_credential_credentials_credential_name_patch",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CredentialManagementApi#update_credential_credentials_credential_name_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end