litellm_client 1.0.0

data/lib/litellm_client/api/internal_user_management_api.rb

@@ -0,0 +1,472 @@
+=begin
+#LiteLLM API
+
+#Proxy Server to call 100+ LLMs in the OpenAI format. [**Customize Swagger Docs**](https://docs.litellm.ai/docs/proxy/enterprise#swagger-docs---custom-routes--branding)  👉 [```LiteLLM Admin Panel on /ui```](/ui/). Create, Edit Keys with SSO  💸 [```LiteLLM Model Cost Map```](https://models.litellm.ai/).
+
+The version of the OpenAPI document: 1.72.6
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module LiteLLMClient
+  class InternalUserManagementApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete User
+    # delete user and associated user keys  ``` curl --location 'http://0.0.0.0:4000/user/delete'  --header 'Authorization: Bearer sk-1234'  --header 'Content-Type: application/json'  --data-raw '{     \"user_ids\": [\"45e3e396-ee08-4a61-a88e-16b3ce7e0849\"] }' ```  Parameters: - user_ids: List[str] - The list of user id's to be deleted.
+    # @param delete_user_request [DeleteUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :litellm_changed_by The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
+    # @return [Object]
+    def delete_user_user_delete_post(delete_user_request, opts = {})
+      data, _status_code, _headers = delete_user_user_delete_post_with_http_info(delete_user_request, opts)
+      data
+    end
+
+    # Delete User
+    # delete user and associated user keys  ``` curl --location 'http://0.0.0.0:4000/user/delete'  --header 'Authorization: Bearer sk-1234'  --header 'Content-Type: application/json'  --data-raw '{     \"user_ids\": [\"45e3e396-ee08-4a61-a88e-16b3ce7e0849\"] }' ```  Parameters: - user_ids: List[str] - The list of user id's to be deleted.
+    # @param delete_user_request [DeleteUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :litellm_changed_by The litellm-changed-by header enables tracking of actions performed by authorized users on behalf of other users, providing an audit trail for accountability
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def delete_user_user_delete_post_with_http_info(delete_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InternalUserManagementApi.delete_user_user_delete_post ...'
+      end
+      # verify the required parameter 'delete_user_request' is set
+      if @api_client.config.client_side_validation && delete_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'delete_user_request' when calling InternalUserManagementApi.delete_user_user_delete_post"
+      end
+      # resource path
+      local_var_path = '/user/delete'
+
+      # 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
+      header_params[:'litellm-changed-by'] = opts[:'litellm_changed_by'] if !opts[:'litellm_changed_by'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['APIKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"InternalUserManagementApi.delete_user_user_delete_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: InternalUserManagementApi#delete_user_user_delete_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get User Daily Activity
+    # [BETA] This is a beta endpoint. It will change.  Meant to optimize querying spend data for analytics for a user.  Returns: (by date) - spend - prompt_tokens - completion_tokens - cache_read_input_tokens - cache_creation_input_tokens - total_tokens - api_requests - breakdown by model, api_key, provider
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :start_date Start date in YYYY-MM-DD format
+    # @option opts [String] :end_date End date in YYYY-MM-DD format
+    # @option opts [String] :model Filter by specific model
+    # @option opts [String] :api_key Filter by specific API key
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Integer] :page_size Items per page (default to 50)
+    # @return [SpendAnalyticsPaginatedResponse]
+    def get_user_daily_activity_user_daily_activity_get(opts = {})
+      data, _status_code, _headers = get_user_daily_activity_user_daily_activity_get_with_http_info(opts)
+      data
+    end
+
+    # Get User Daily Activity
+    # [BETA] This is a beta endpoint. It will change.  Meant to optimize querying spend data for analytics for a user.  Returns: (by date) - spend - prompt_tokens - completion_tokens - cache_read_input_tokens - cache_creation_input_tokens - total_tokens - api_requests - breakdown by model, api_key, provider
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :start_date Start date in YYYY-MM-DD format
+    # @option opts [String] :end_date End date in YYYY-MM-DD format
+    # @option opts [String] :model Filter by specific model
+    # @option opts [String] :api_key Filter by specific API key
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Integer] :page_size Items per page (default to 50)
+    # @return [Array<(SpendAnalyticsPaginatedResponse, Integer, Hash)>] SpendAnalyticsPaginatedResponse data, response status code and response headers
+    def get_user_daily_activity_user_daily_activity_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InternalUserManagementApi.get_user_daily_activity_user_daily_activity_get ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InternalUserManagementApi.get_user_daily_activity_user_daily_activity_get, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling InternalUserManagementApi.get_user_daily_activity_user_daily_activity_get, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling InternalUserManagementApi.get_user_daily_activity_user_daily_activity_get, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/user/daily/activity'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'model'] = opts[:'model'] if !opts[:'model'].nil?
+      query_params[:'api_key'] = opts[:'api_key'] if !opts[:'api_key'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'SpendAnalyticsPaginatedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['APIKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"InternalUserManagementApi.get_user_daily_activity_user_daily_activity_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: InternalUserManagementApi#get_user_daily_activity_user_daily_activity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Users
+    # Get a paginated list of users with filtering and sorting options.  Parameters:     role: Optional[str]         Filter users by role. Can be one of:         - proxy_admin         - proxy_admin_viewer         - internal_user         - internal_user_viewer     user_ids: Optional[str]         Get list of users by user_ids. Comma separated list of user_ids.     sso_ids: Optional[str]         Get list of users by sso_ids. Comma separated list of sso_ids.     user_email: Optional[str]         Filter users by partial email match     team: Optional[str]         Filter users by team id. Will match if user has this team in their teams array.     page: int         The page number to return     page_size: int         The number of items per page     sort_by: Optional[str]         Column to sort by (e.g. 'user_id', 'user_email', 'created_at', 'spend')     sort_order: Optional[str]         Sort order ('asc' or 'desc')
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :role Filter users by role
+    # @option opts [String] :user_ids Get list of users by user_ids
+    # @option opts [String] :sso_user_ids Get list of users by sso_user_id
+    # @option opts [String] :user_email Filter users by partial email match
+    # @option opts [String] :team Filter users by team id
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :page_size Number of items per page (default to 25)
+    # @option opts [String] :sort_by Column to sort by (e.g. &#39;user_id&#39;, &#39;user_email&#39;, &#39;created_at&#39;, &#39;spend&#39;)
+    # @option opts [String] :sort_order Sort order (&#39;asc&#39; or &#39;desc&#39;) (default to 'asc')
+    # @return [UserListResponse]
+    def get_users_user_list_get(opts = {})
+      data, _status_code, _headers = get_users_user_list_get_with_http_info(opts)
+      data
+    end
+
+    # Get Users
+    # Get a paginated list of users with filtering and sorting options.  Parameters:     role: Optional[str]         Filter users by role. Can be one of:         - proxy_admin         - proxy_admin_viewer         - internal_user         - internal_user_viewer     user_ids: Optional[str]         Get list of users by user_ids. Comma separated list of user_ids.     sso_ids: Optional[str]         Get list of users by sso_ids. Comma separated list of sso_ids.     user_email: Optional[str]         Filter users by partial email match     team: Optional[str]         Filter users by team id. Will match if user has this team in their teams array.     page: int         The page number to return     page_size: int         The number of items per page     sort_by: Optional[str]         Column to sort by (e.g. &#39;user_id&#39;, &#39;user_email&#39;, &#39;created_at&#39;, &#39;spend&#39;)     sort_order: Optional[str]         Sort order (&#39;asc&#39; or &#39;desc&#39;)
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :role Filter users by role
+    # @option opts [String] :user_ids Get list of users by user_ids
+    # @option opts [String] :sso_user_ids Get list of users by sso_user_id
+    # @option opts [String] :user_email Filter users by partial email match
+    # @option opts [String] :team Filter users by team id
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :page_size Number of items per page (default to 25)
+    # @option opts [String] :sort_by Column to sort by (e.g. &#39;user_id&#39;, &#39;user_email&#39;, &#39;created_at&#39;, &#39;spend&#39;)
+    # @option opts [String] :sort_order Sort order (&#39;asc&#39; or &#39;desc&#39;) (default to 'asc')
+    # @return [Array<(UserListResponse, Integer, Hash)>] UserListResponse data, response status code and response headers
+    def get_users_user_list_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InternalUserManagementApi.get_users_user_list_get ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InternalUserManagementApi.get_users_user_list_get, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling InternalUserManagementApi.get_users_user_list_get, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling InternalUserManagementApi.get_users_user_list_get, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/user/list'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
+      query_params[:'user_ids'] = opts[:'user_ids'] if !opts[:'user_ids'].nil?
+      query_params[:'sso_user_ids'] = opts[:'sso_user_ids'] if !opts[:'sso_user_ids'].nil?
+      query_params[:'user_email'] = opts[:'user_email'] if !opts[:'user_email'].nil?
+      query_params[:'team'] = opts[:'team'] if !opts[:'team'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'sort_by'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
+      query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].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] || 'UserListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['APIKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"InternalUserManagementApi.get_users_user_list_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: InternalUserManagementApi#get_users_user_list_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # New User
+    # Use this to create a new INTERNAL user with a budget. Internal Users can access LiteLLM Admin UI to make keys, request access to models. This creates a new user and generates a new api key for the new user. The new api key is returned.  Returns user id, budget + new key.  Parameters: - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated. - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to. - teams: Optional[list] - specify a list of team id's a user belongs to. - user_email: Optional[str] - Specify a user email. - send_invite_email: Optional[bool] - Specify if an invite email should be sent. - user_role: Optional[str] - Specify a user role - \"proxy_admin\", \"proxy_admin_viewer\", \"internal_user\", \"internal_user_viewer\", \"team\", \"customer\". Info about each role here: `https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20` - max_budget: Optional[float] - Specify max budget for a given user. - 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\"), months (\"1mo\"). - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models). Set to ['no-default-models'] to block all model access. Restricting user to only team-based model access. - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute) - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute) - auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases) - config: Optional[dict] - [DEPRECATED PARAM] User-specific config. - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - [\"no-cache\", \"no-store\"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request- - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked. - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking. - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {\"team\": \"core-infra\", \"app\": \"app2\", \"email\": \"ishaan@berri.ai\" } - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x. - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests. - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys) - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds (\"30s\"), minutes (\"30m\"), hours (\"30h\"), days (\"30d\"), months (\"1mo\"). - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.  - duration: Optional[str] - Duration for the key auto-created on `/user/new`. Default is None. - key_alias: Optional[str] - Alias for the key auto-created on `/user/new`. Default is None. - sso_user_id: Optional[str] - The id of the user in the SSO provider. - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {\"vector_stores\": [\"vector_store_1\", \"vector_store_2\"]}. IF null or {} then no object permission. - organizations: List[str] - List of organization id's the user is a member of Returns: - key: (str) The generated api key for the user - expires: (datetime) Datetime object for when key expires. - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id. - max_budget: (float|None) Max budget for given user.  Usage Example   ```shell  curl -X POST \"http://localhost:4000/user/new\"      -H \"Content-Type: application/json\"      -H \"Authorization: Bearer sk-1234\"      -d '{      \"username\": \"new_user\",      \"email\": \"new_user@example.com\"  }' ```
+    # @param new_user_request [NewUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [NewUserResponse]
+    def new_user_user_new_post(new_user_request, opts = {})
+      data, _status_code, _headers = new_user_user_new_post_with_http_info(new_user_request, opts)
+      data
+    end
+
+    # New User
+    # Use this to create a new INTERNAL user with a budget. Internal Users can access LiteLLM Admin UI to make keys, request access to models. This creates a new user and generates a new api key for the new user. The new api key is returned.  Returns user id, budget + new key.  Parameters: - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated. - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to. - teams: Optional[list] - specify a list of team id&#39;s a user belongs to. - user_email: Optional[str] - Specify a user email. - send_invite_email: Optional[bool] - Specify if an invite email should be sent. - user_role: Optional[str] - Specify a user role - \&quot;proxy_admin\&quot;, \&quot;proxy_admin_viewer\&quot;, \&quot;internal_user\&quot;, \&quot;internal_user_viewer\&quot;, \&quot;team\&quot;, \&quot;customer\&quot;. Info about each role here: &#x60;https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20&#x60; - max_budget: Optional[float] - Specify max budget for a given user. - 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 (\&quot;30s\&quot;), minutes (\&quot;30m\&quot;), hours (\&quot;30h\&quot;), days (\&quot;30d\&quot;), months (\&quot;1mo\&quot;). - models: Optional[list] - Model_name&#39;s a user is allowed to call. (if empty, key is allowed to call all models). Set to [&#39;no-default-models&#39;] to block all model access. Restricting user to only team-based model access. - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute) - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute) - auto_create_key: bool - Default&#x3D;True. Flag used for returning a key as part of the /user/new response - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases) - config: Optional[dict] - [DEPRECATED PARAM] User-specific config. - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - [\&quot;no-cache\&quot;, \&quot;no-store\&quot;]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request- - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked. - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking. - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata &#x3D; {\&quot;team\&quot;: \&quot;core-infra\&quot;, \&quot;app\&quot;: \&quot;app2\&quot;, \&quot;email\&quot;: \&quot;ishaan@berri.ai\&quot; } - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user&#39;s parallel requests &gt; x. - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn&#39;t block requests. - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys) - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys) - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds (\&quot;30s\&quot;), minutes (\&quot;30m\&quot;), hours (\&quot;30h\&quot;), days (\&quot;30d\&quot;), months (\&quot;1mo\&quot;). - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.  - duration: Optional[str] - Duration for the key auto-created on &#x60;/user/new&#x60;. Default is None. - key_alias: Optional[str] - Alias for the key auto-created on &#x60;/user/new&#x60;. Default is None. - sso_user_id: Optional[str] - The id of the user in the SSO provider. - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {\&quot;vector_stores\&quot;: [\&quot;vector_store_1\&quot;, \&quot;vector_store_2\&quot;]}. IF null or {} then no object permission. - organizations: List[str] - List of organization id&#39;s the user is a member of Returns: - key: (str) The generated api key for the user - expires: (datetime) Datetime object for when key expires. - user_id: (str) Unique user id - used for tracking spend across multiple keys for same user id. - max_budget: (float|None) Max budget for given user.  Usage Example   &#x60;&#x60;&#x60;shell  curl -X POST \&quot;http://localhost:4000/user/new\&quot;      -H \&quot;Content-Type: application/json\&quot;      -H \&quot;Authorization: Bearer sk-1234\&quot;      -d &#39;{      \&quot;username\&quot;: \&quot;new_user\&quot;,      \&quot;email\&quot;: \&quot;new_user@example.com\&quot;  }&#39; &#x60;&#x60;&#x60;
+    # @param new_user_request [NewUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NewUserResponse, Integer, Hash)>] NewUserResponse data, response status code and response headers
+    def new_user_user_new_post_with_http_info(new_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InternalUserManagementApi.new_user_user_new_post ...'
+      end
+      # verify the required parameter 'new_user_request' is set
+      if @api_client.config.client_side_validation && new_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'new_user_request' when calling InternalUserManagementApi.new_user_user_new_post"
+      end
+      # resource path
+      local_var_path = '/user/new'
+
+      # 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(new_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NewUserResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['APIKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"InternalUserManagementApi.new_user_user_new_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: InternalUserManagementApi#new_user_user_new_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # User Info
+    # [10/07/2024] Note: To get all users (+pagination), use `/user/list` endpoint.   Use this to get user information. (user row + all user key info)  Example request ``` curl -X GET 'http://localhost:4000/user/info?user_id=krrish7%40berri.ai'     --header 'Authorization: Bearer sk-1234' ```
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_id User ID in the request parameters
+    # @return [Object]
+    def user_info_user_info_get(opts = {})
+      data, _status_code, _headers = user_info_user_info_get_with_http_info(opts)
+      data
+    end
+
+    # User Info
+    # [10/07/2024] Note: To get all users (+pagination), use &#x60;/user/list&#x60; endpoint.   Use this to get user information. (user row + all user key info)  Example request &#x60;&#x60;&#x60; curl -X GET &#39;http://localhost:4000/user/info?user_id&#x3D;krrish7%40berri.ai&#39;     --header &#39;Authorization: Bearer sk-1234&#39; &#x60;&#x60;&#x60;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :user_id User ID in the request parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def user_info_user_info_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InternalUserManagementApi.user_info_user_info_get ...'
+      end
+      # resource path
+      local_var_path = '/user/info'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_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] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['APIKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"InternalUserManagementApi.user_info_user_info_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: InternalUserManagementApi#user_info_user_info_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # User Update
+    # Example curl   ``` curl --location 'http://0.0.0.0:4000/user/update'     --header 'Authorization: Bearer sk-1234'     --header 'Content-Type: application/json'     --data '{     \"user_id\": \"test-litellm-user-4\",     \"user_role\": \"proxy_admin_viewer\" }' ```  Parameters:     - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated.     - user_email: Optional[str] - Specify a user email.     - password: Optional[str] - Specify a user password.     - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to.     - teams: Optional[list] - specify a list of team id's a user belongs to.     - send_invite_email: Optional[bool] - Specify if an invite email should be sent.     - user_role: Optional[str] - Specify a user role - \"proxy_admin\", \"proxy_admin_viewer\", \"internal_user\", \"internal_user_viewer\", \"team\", \"customer\". Info about each role here: `https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20`     - max_budget: Optional[float] - Specify max budget for a given user.     - 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\"), months (\"1mo\").     - models: Optional[list] - Model_name's a user is allowed to call. (if empty, key is allowed to call all models)     - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute)     - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute)     - auto_create_key: bool - Default=True. Flag used for returning a key as part of the /user/new response     - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases)     - config: Optional[dict] - [DEPRECATED PARAM] User-specific config.     - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - [\"no-cache\", \"no-store\"]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request-     - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked.     - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user     - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking.     - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata = {\"team\": \"core-infra\", \"app\": \"app2\", \"email\": \"ishaan@berri.ai\" }     - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user's parallel requests > x.     - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests.     - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys)     - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)     - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)     - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds (\"30s\"), minutes (\"30m\"), hours (\"30h\"), days (\"30d\"), months (\"1mo\").     - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.      - duration: Optional[str] - [NOT IMPLEMENTED].     - key_alias: Optional[str] - [NOT IMPLEMENTED].     - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {\"vector_stores\": [\"vector_store_1\", \"vector_store_2\"]}. IF null or {} then no object permission.
+    # @param update_user_request [UpdateUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def user_update_user_update_post(update_user_request, opts = {})
+      data, _status_code, _headers = user_update_user_update_post_with_http_info(update_user_request, opts)
+      data
+    end
+
+    # User Update
+    # Example curl   &#x60;&#x60;&#x60; curl --location &#39;http://0.0.0.0:4000/user/update&#39;     --header &#39;Authorization: Bearer sk-1234&#39;     --header &#39;Content-Type: application/json&#39;     --data &#39;{     \&quot;user_id\&quot;: \&quot;test-litellm-user-4\&quot;,     \&quot;user_role\&quot;: \&quot;proxy_admin_viewer\&quot; }&#39; &#x60;&#x60;&#x60;  Parameters:     - user_id: Optional[str] - Specify a user id. If not set, a unique id will be generated.     - user_email: Optional[str] - Specify a user email.     - password: Optional[str] - Specify a user password.     - user_alias: Optional[str] - A descriptive name for you to know who this user id refers to.     - teams: Optional[list] - specify a list of team id&#39;s a user belongs to.     - send_invite_email: Optional[bool] - Specify if an invite email should be sent.     - user_role: Optional[str] - Specify a user role - \&quot;proxy_admin\&quot;, \&quot;proxy_admin_viewer\&quot;, \&quot;internal_user\&quot;, \&quot;internal_user_viewer\&quot;, \&quot;team\&quot;, \&quot;customer\&quot;. Info about each role here: &#x60;https://github.com/BerriAI/litellm/litellm/proxy/_types.py#L20&#x60;     - max_budget: Optional[float] - Specify max budget for a given user.     - 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 (\&quot;30s\&quot;), minutes (\&quot;30m\&quot;), hours (\&quot;30h\&quot;), days (\&quot;30d\&quot;), months (\&quot;1mo\&quot;).     - models: Optional[list] - Model_name&#39;s a user is allowed to call. (if empty, key is allowed to call all models)     - tpm_limit: Optional[int] - Specify tpm limit for a given user (Tokens per minute)     - rpm_limit: Optional[int] - Specify rpm limit for a given user (Requests per minute)     - auto_create_key: bool - Default&#x3D;True. Flag used for returning a key as part of the /user/new response     - aliases: Optional[dict] - Model aliases for the user - [Docs](https://litellm.vercel.app/docs/proxy/virtual_keys#model-aliases)     - config: Optional[dict] - [DEPRECATED PARAM] User-specific config.     - allowed_cache_controls: Optional[list] - List of allowed cache control values. Example - [\&quot;no-cache\&quot;, \&quot;no-store\&quot;]. See all values - https://docs.litellm.ai/docs/proxy/caching#turn-on--off-caching-per-request-     - blocked: Optional[bool] - [Not Implemented Yet] Whether the user is blocked.     - guardrails: Optional[List[str]] - [Not Implemented Yet] List of active guardrails for the user     - permissions: Optional[dict] - [Not Implemented Yet] User-specific permissions, eg. turning off pii masking.     - metadata: Optional[dict] - Metadata for user, store information for user. Example metadata &#x3D; {\&quot;team\&quot;: \&quot;core-infra\&quot;, \&quot;app\&quot;: \&quot;app2\&quot;, \&quot;email\&quot;: \&quot;ishaan@berri.ai\&quot; }     - max_parallel_requests: Optional[int] - Rate limit a user based on the number of parallel requests. Raises 429 error, if user&#39;s parallel requests &gt; x.     - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn&#39;t block requests.     - model_max_budget: Optional[dict] - Model-specific max budget for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-budgets-to-keys)     - model_rpm_limit: Optional[float] - Model-specific rpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)     - model_tpm_limit: Optional[float] - Model-specific tpm limit for user. [Docs](https://docs.litellm.ai/docs/proxy/users#add-model-specific-limits-to-keys)     - spend: Optional[float] - Amount spent by user. Default is 0. Will be updated by proxy whenever user is used. You can set duration as seconds (\&quot;30s\&quot;), minutes (\&quot;30m\&quot;), hours (\&quot;30h\&quot;), days (\&quot;30d\&quot;), months (\&quot;1mo\&quot;).     - team_id: Optional[str] - [DEPRECATED PARAM] The team id of the user. Default is None.      - duration: Optional[str] - [NOT IMPLEMENTED].     - key_alias: Optional[str] - [NOT IMPLEMENTED].     - object_permission: Optional[LiteLLM_ObjectPermissionBase] - internal user-specific object permission. Example - {\&quot;vector_stores\&quot;: [\&quot;vector_store_1\&quot;, \&quot;vector_store_2\&quot;]}. IF null or {} then no object permission.
+    # @param update_user_request [UpdateUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def user_update_user_update_post_with_http_info(update_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InternalUserManagementApi.user_update_user_update_post ...'
+      end
+      # verify the required parameter 'update_user_request' is set
+      if @api_client.config.client_side_validation && update_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_user_request' when calling InternalUserManagementApi.user_update_user_update_post"
+      end
+      # resource path
+      local_var_path = '/user/update'
+
+      # 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(update_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['APIKeyHeader']
+
+      new_options = opts.merge(
+        :operation => :"InternalUserManagementApi.user_update_user_update_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: InternalUserManagementApi#user_update_user_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end