litellm_client 1.0.0

data/docs/CustomerManagementApi.md

@@ -0,0 +1,508 @@
+# LiteLLMClient::CustomerManagementApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**block_user_customer_block_post**](CustomerManagementApi.md#block_user_customer_block_post) | **POST** /customer/block | Block User |
+| [**delete_end_user_customer_delete_post**](CustomerManagementApi.md#delete_end_user_customer_delete_post) | **POST** /customer/delete | Delete End User |
+| [**end_user_info_customer_info_get**](CustomerManagementApi.md#end_user_info_customer_info_get) | **GET** /customer/info | End User Info |
+| [**list_end_user_customer_list_get**](CustomerManagementApi.md#list_end_user_customer_list_get) | **GET** /customer/list | List End User |
+| [**new_end_user_customer_new_post**](CustomerManagementApi.md#new_end_user_customer_new_post) | **POST** /customer/new | New End User |
+| [**unblock_user_customer_unblock_post**](CustomerManagementApi.md#unblock_user_customer_unblock_post) | **POST** /customer/unblock | Unblock User |
+| [**update_end_user_customer_update_post**](CustomerManagementApi.md#update_end_user_customer_update_post) | **POST** /customer/update | Update End User |
+
+
+## block_user_customer_block_post
+
+> Object block_user_customer_block_post(block_users)
+
+Block User
+
+[BETA] Reject calls with this end-user id  Parameters: - user_ids (List[str], required): The unique `user_id`s for the users to block      (any /chat/completion call with this user={end-user-id} param, will be rejected.)      ```     curl -X POST \"http://0.0.0.0:8000/user/block\"     -H \"Authorization: Bearer sk-1234\"     -d '{     \"user_ids\": [<user_id>, ...]     }'     ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+block_users = LiteLLMClient::BlockUsers.new({user_ids: ['user_ids_example']}) # BlockUsers | 
+
+begin
+  # Block User
+  result = api_instance.block_user_customer_block_post(block_users)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->block_user_customer_block_post: #{e}"
+end
+```
+
+#### Using the block_user_customer_block_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> block_user_customer_block_post_with_http_info(block_users)
+
+```ruby
+begin
+  # Block User
+  data, status_code, headers = api_instance.block_user_customer_block_post_with_http_info(block_users)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->block_user_customer_block_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **block_users** | [**BlockUsers**](BlockUsers.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_end_user_customer_delete_post
+
+> Object delete_end_user_customer_delete_post(delete_customer_request)
+
+Delete End User
+
+Delete multiple end-users.  Parameters: - user_ids (List[str], required): The unique `user_id`s for the users to delete  Example curl: ``` curl --location 'http://0.0.0.0:4000/customer/delete'         --header 'Authorization: Bearer sk-1234'         --header 'Content-Type: application/json'         --data '{         \"user_ids\" :[\"ishaan-jaff-5\"] }'  See below for all params  ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+delete_customer_request = LiteLLMClient::DeleteCustomerRequest.new({user_ids: ['user_ids_example']}) # DeleteCustomerRequest | 
+
+begin
+  # Delete End User
+  result = api_instance.delete_end_user_customer_delete_post(delete_customer_request)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->delete_end_user_customer_delete_post: #{e}"
+end
+```
+
+#### Using the delete_end_user_customer_delete_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_end_user_customer_delete_post_with_http_info(delete_customer_request)
+
+```ruby
+begin
+  # Delete End User
+  data, status_code, headers = api_instance.delete_end_user_customer_delete_post_with_http_info(delete_customer_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->delete_end_user_customer_delete_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **delete_customer_request** | [**DeleteCustomerRequest**](DeleteCustomerRequest.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## end_user_info_customer_info_get
+
+> <LiteLLMEndUserTable> end_user_info_customer_info_get(end_user_id)
+
+End User Info
+
+Get information about an end-user. An `end_user` is a customer (external user) of the proxy.  Parameters: - end_user_id (str, required): The unique identifier for the end-user  Example curl: ``` curl -X GET 'http://localhost:4000/customer/info?end_user_id=test-litellm-user-4'         -H 'Authorization: Bearer sk-1234' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+end_user_id = 'end_user_id_example' # String | End User ID in the request parameters
+
+begin
+  # End User Info
+  result = api_instance.end_user_info_customer_info_get(end_user_id)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->end_user_info_customer_info_get: #{e}"
+end
+```
+
+#### Using the end_user_info_customer_info_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LiteLLMEndUserTable>, Integer, Hash)> end_user_info_customer_info_get_with_http_info(end_user_id)
+
+```ruby
+begin
+  # End User Info
+  data, status_code, headers = api_instance.end_user_info_customer_info_get_with_http_info(end_user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LiteLLMEndUserTable>
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->end_user_info_customer_info_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **end_user_id** | **String** | End User ID in the request parameters |  |
+
+### Return type
+
+[**LiteLLMEndUserTable**](LiteLLMEndUserTable.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_end_user_customer_list_get
+
+> <Array<LiteLLMEndUserTable>> list_end_user_customer_list_get
+
+List End User
+
+[Admin-only] List all available customers  Example curl: ``` curl --location --request GET 'http://0.0.0.0:4000/customer/list'         --header 'Authorization: Bearer sk-1234' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+
+begin
+  # List End User
+  result = api_instance.list_end_user_customer_list_get
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->list_end_user_customer_list_get: #{e}"
+end
+```
+
+#### Using the list_end_user_customer_list_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<LiteLLMEndUserTable>>, Integer, Hash)> list_end_user_customer_list_get_with_http_info
+
+```ruby
+begin
+  # List End User
+  data, status_code, headers = api_instance.list_end_user_customer_list_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<LiteLLMEndUserTable>>
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->list_end_user_customer_list_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;LiteLLMEndUserTable&gt;**](LiteLLMEndUserTable.md)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## new_end_user_customer_new_post
+
+> Object new_end_user_customer_new_post(new_customer_request)
+
+New End User
+
+Allow creating a new Customer    Parameters: - user_id: str - The unique identifier for the user. - alias: Optional[str] - A human-friendly alias for the user. - blocked: bool - Flag to allow or disallow requests for this end-user. Default is False. - max_budget: Optional[float] - The maximum budget allocated to the user. Either 'max_budget' or 'budget_id' should be provided, not both. - budget_id: Optional[str] - The identifier for an existing budget allocated to the user. Either 'max_budget' or 'budget_id' should be provided, not both. - allowed_model_region: Optional[Union[Literal[\"eu\"], Literal[\"us\"]]] - Require all user requests to use models in this specific region. - default_model: Optional[str] - If no equivalent model in the allowed region, default all requests to this model. - metadata: Optional[dict] = Metadata for customer, store information for customer. Example metadata = {\"data_training_opt_out\": True} - budget_duration: Optional[str] - Budget is reset at the end of specified duration. If not set, budget is never reset. You can set duration as seconds (\"30s\"), minutes (\"30m\"), hours (\"30h\"), days (\"30d\"). - tpm_limit: Optional[int] - [Not Implemented Yet] Specify tpm limit for a given customer (Tokens per minute) - rpm_limit: Optional[int] - [Not Implemented Yet] Specify rpm limit for a given customer (Requests per minute) - model_max_budget: Optional[dict] - [Not Implemented Yet] Specify max budget for a given model. Example: {\"openai/gpt-4o-mini\": {\"max_budget\": 100.0, \"budget_duration\": \"1d\"}} - max_parallel_requests: Optional[int] - [Not Implemented Yet] Specify max parallel requests for a given customer. - soft_budget: Optional[float] - [Not Implemented Yet] Get alerts when customer crosses given budget, doesn't block requests. - spend: Optional[float] - Specify initial spend for a given customer. - budget_reset_at: Optional[str] - Specify the date and time when the budget should be reset.   - Allow specifying allowed regions  - Allow specifying default model  Example curl: ``` curl --location 'http://0.0.0.0:4000/customer/new'         --header 'Authorization: Bearer sk-1234'         --header 'Content-Type: application/json'         --data '{         \"user_id\" : \"ishaan-jaff-3\",         \"allowed_region\": \"eu\",         \"budget_id\": \"free_tier\",         \"default_model\": \"azure/gpt-3.5-turbo-eu\" <- all calls from this user, use this model?      }'      # return end-user object ```  NOTE: This used to be called `/end_user/new`, we will still be maintaining compatibility for /end_user/XXX for these endpoints
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+new_customer_request = LiteLLMClient::NewCustomerRequest.new({user_id: 'user_id_example'}) # NewCustomerRequest | 
+
+begin
+  # New End User
+  result = api_instance.new_end_user_customer_new_post(new_customer_request)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->new_end_user_customer_new_post: #{e}"
+end
+```
+
+#### Using the new_end_user_customer_new_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> new_end_user_customer_new_post_with_http_info(new_customer_request)
+
+```ruby
+begin
+  # New End User
+  data, status_code, headers = api_instance.new_end_user_customer_new_post_with_http_info(new_customer_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->new_end_user_customer_new_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **new_customer_request** | [**NewCustomerRequest**](NewCustomerRequest.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## unblock_user_customer_unblock_post
+
+> Object unblock_user_customer_unblock_post(block_users)
+
+Unblock User
+
+[BETA] Unblock calls with this user id  Example ``` curl -X POST \"http://0.0.0.0:8000/user/unblock\" -H \"Authorization: Bearer sk-1234\" -d '{ \"user_ids\": [<user_id>, ...] }' ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+block_users = LiteLLMClient::BlockUsers.new({user_ids: ['user_ids_example']}) # BlockUsers | 
+
+begin
+  # Unblock User
+  result = api_instance.unblock_user_customer_unblock_post(block_users)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->unblock_user_customer_unblock_post: #{e}"
+end
+```
+
+#### Using the unblock_user_customer_unblock_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> unblock_user_customer_unblock_post_with_http_info(block_users)
+
+```ruby
+begin
+  # Unblock User
+  data, status_code, headers = api_instance.unblock_user_customer_unblock_post_with_http_info(block_users)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->unblock_user_customer_unblock_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **block_users** | [**BlockUsers**](BlockUsers.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_end_user_customer_update_post
+
+> Object update_end_user_customer_update_post(update_customer_request)
+
+Update End User
+
+Example curl   Parameters: - user_id: str - alias: Optional[str] = None  # human-friendly alias - blocked: bool = False  # allow/disallow requests for this end-user - max_budget: Optional[float] = None - budget_id: Optional[str] = None  # give either a budget_id or max_budget - allowed_model_region: Optional[AllowedModelRegion] = (     None  # require all user requests to use models in this specific region ) - default_model: Optional[str] = (     None  # if no equivalent model in allowed region - default all requests to this model )  Example curl: ``` curl --location 'http://0.0.0.0:4000/customer/update'     --header 'Authorization: Bearer sk-1234'     --header 'Content-Type: application/json'     --data '{     \"user_id\": \"test-litellm-user-4\",     \"budget_id\": \"paid_tier\" }'  See below for all params  ```
+
+### Examples
+
+```ruby
+require 'time'
+require 'litellm_client'
+# setup authorization
+LiteLLMClient.configure do |config|
+  # Configure API key authorization: APIKeyHeader
+  config.api_key['x-litellm-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-litellm-api-key'] = 'Bearer'
+end
+
+api_instance = LiteLLMClient::CustomerManagementApi.new
+update_customer_request = LiteLLMClient::UpdateCustomerRequest.new({user_id: 'user_id_example'}) # UpdateCustomerRequest | 
+
+begin
+  # Update End User
+  result = api_instance.update_end_user_customer_update_post(update_customer_request)
+  p result
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->update_end_user_customer_update_post: #{e}"
+end
+```
+
+#### Using the update_end_user_customer_update_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> update_end_user_customer_update_post_with_http_info(update_customer_request)
+
+```ruby
+begin
+  # Update End User
+  data, status_code, headers = api_instance.update_end_user_customer_update_post_with_http_info(update_customer_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue LiteLLMClient::ApiError => e
+  puts "Error when calling CustomerManagementApi->update_end_user_customer_update_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_customer_request** | [**UpdateCustomerRequest**](UpdateCustomerRequest.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DailySpendData.md

@@ -0,0 +1,22 @@
+# LiteLLMClient::DailySpendData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** |  |  |
+| **metrics** | [**SpendMetrics**](SpendMetrics.md) |  |  |
+| **breakdown** | [**BreakdownMetrics**](BreakdownMetrics.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::DailySpendData.new(
+  date: null,
+  metrics: null,
+  breakdown: null
+)
+```
+

data/docs/DailySpendMetadata.md

@@ -0,0 +1,40 @@
+# LiteLLMClient::DailySpendMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_spend** | **Float** |  | [optional][default to 0.0] |
+| **total_prompt_tokens** | **Integer** |  | [optional][default to 0] |
+| **total_completion_tokens** | **Integer** |  | [optional][default to 0] |
+| **total_tokens** | **Integer** |  | [optional][default to 0] |
+| **total_api_requests** | **Integer** |  | [optional][default to 0] |
+| **total_successful_requests** | **Integer** |  | [optional][default to 0] |
+| **total_failed_requests** | **Integer** |  | [optional][default to 0] |
+| **total_cache_read_input_tokens** | **Integer** |  | [optional][default to 0] |
+| **total_cache_creation_input_tokens** | **Integer** |  | [optional][default to 0] |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **total_pages** | **Integer** |  | [optional][default to 1] |
+| **has_more** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'litellm_client'
+
+instance = LiteLLMClient::DailySpendMetadata.new(
+  total_spend: null,
+  total_prompt_tokens: null,
+  total_completion_tokens: null,
+  total_tokens: null,
+  total_api_requests: null,
+  total_successful_requests: null,
+  total_failed_requests: null,
+  total_cache_read_input_tokens: null,
+  total_cache_creation_input_tokens: null,
+  page: null,
+  total_pages: null,
+  has_more: null
+)
+```
+