@cotofe/service-of-litellm/dist/apis/BudgetManagementApi.d.ts

OpenAPI client for @cotofe/service-of-litellm

/**
 * Platform
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { BudgetDeleteRequest, BudgetNewRequest, BudgetRequest } from '../models/index';
import * as runtime from '../runtime';
export interface BudgetManagementApiBudgetSettingsBudgetSettingsGetRequest {
    budgetId: string;
}
export interface BudgetManagementApiDeleteBudgetBudgetDeletePostRequest {
    budgetDeleteRequest?: BudgetDeleteRequest;
}
export interface BudgetManagementApiInfoBudgetBudgetInfoPostRequest {
    budgetRequest?: BudgetRequest;
}
export interface BudgetManagementApiNewBudgetBudgetNewPostRequest {
    budgetNewRequest?: BudgetNewRequest;
}
export interface BudgetManagementApiUpdateBudgetBudgetUpdatePostRequest {
    budgetNewRequest?: BudgetNewRequest;
}
/**
 *
 */
export declare class BudgetManagementApi extends runtime.BaseAPI {
    /**
     * Get list of configurable params + current value for a budget item + description of each field  Used on Admin UI.  Query Parameters: - budget_id: str - The budget id to get information for
     * Budget Settings
     */
    budgetSettingsBudgetSettingsGetRaw(requestParameters: BudgetManagementApiBudgetSettingsBudgetSettingsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Get list of configurable params + current value for a budget item + description of each field  Used on Admin UI.  Query Parameters: - budget_id: str - The budget id to get information for
     * Budget Settings
     */
    budgetSettingsBudgetSettingsGet(requestParameters: BudgetManagementApiBudgetSettingsBudgetSettingsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Delete budget  Parameters: - id: str - The budget id to delete
     * Delete Budget
     */
    deleteBudgetBudgetDeletePostRaw(requestParameters: BudgetManagementApiDeleteBudgetBudgetDeletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Delete budget  Parameters: - id: str - The budget id to delete
     * Delete Budget
     */
    deleteBudgetBudgetDeletePost(requestParameters?: BudgetManagementApiDeleteBudgetBudgetDeletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Get the budget id specific information  Parameters: - budgets: List[str] - The list of budget ids to get information for
     * Info Budget
     */
    infoBudgetBudgetInfoPostRaw(requestParameters: BudgetManagementApiInfoBudgetBudgetInfoPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Get the budget id specific information  Parameters: - budgets: List[str] - The list of budget ids to get information for
     * Info Budget
     */
    infoBudgetBudgetInfoPost(requestParameters?: BudgetManagementApiInfoBudgetBudgetInfoPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * List all the created budgets in proxy db. Used on Admin UI.
     * List Budget
     */
    listBudgetBudgetListGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * List all the created budgets in proxy db. Used on Admin UI.
     * List Budget
     */
    listBudgetBudgetListGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Create a new budget object. Can apply this to teams, orgs, end-users, keys.  Parameters: - budget_duration: Optional[str] - Budget reset period (\"30d\", \"1h\", etc.) - budget_id: Optional[str] - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional[float] - The max budget for the budget. - soft_budget: Optional[float] - The soft budget for the budget. - max_parallel_requests: Optional[int] - The max number of parallel requests for the budget. - tpm_limit: Optional[int] - The tokens per minute limit for the budget. - rpm_limit: Optional[int] - The requests per minute limit for the budget. - model_max_budget: Optional[dict] - Specify max budget for a given model. Example: {\"openai/gpt-4o-mini\": {\"max_budget\": 100.0, \"budget_duration\": \"1d\", \"tpm_limit\": 100000, \"rpm_limit\": 100000}}
     * New Budget
     */
    newBudgetBudgetNewPostRaw(requestParameters: BudgetManagementApiNewBudgetBudgetNewPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Create a new budget object. Can apply this to teams, orgs, end-users, keys.  Parameters: - budget_duration: Optional[str] - Budget reset period (\"30d\", \"1h\", etc.) - budget_id: Optional[str] - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional[float] - The max budget for the budget. - soft_budget: Optional[float] - The soft budget for the budget. - max_parallel_requests: Optional[int] - The max number of parallel requests for the budget. - tpm_limit: Optional[int] - The tokens per minute limit for the budget. - rpm_limit: Optional[int] - The requests per minute limit for the budget. - model_max_budget: Optional[dict] - Specify max budget for a given model. Example: {\"openai/gpt-4o-mini\": {\"max_budget\": 100.0, \"budget_duration\": \"1d\", \"tpm_limit\": 100000, \"rpm_limit\": 100000}}
     * New Budget
     */
    newBudgetBudgetNewPost(requestParameters?: BudgetManagementApiNewBudgetBudgetNewPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Update an existing budget object.  Parameters: - budget_duration: Optional[str] - Budget reset period (\"30d\", \"1h\", etc.) - budget_id: Optional[str] - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional[float] - The max budget for the budget. - soft_budget: Optional[float] - The soft budget for the budget. - max_parallel_requests: Optional[int] - The max number of parallel requests for the budget. - tpm_limit: Optional[int] - The tokens per minute limit for the budget. - rpm_limit: Optional[int] - The requests per minute limit for the budget. - model_max_budget: Optional[dict] - Specify max budget for a given model. Example: {\"openai/gpt-4o-mini\": {\"max_budget\": 100.0, \"budget_duration\": \"1d\", \"tpm_limit\": 100000, \"rpm_limit\": 100000}}
     * Update Budget
     */
    updateBudgetBudgetUpdatePostRaw(requestParameters: BudgetManagementApiUpdateBudgetBudgetUpdatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Update an existing budget object.  Parameters: - budget_duration: Optional[str] - Budget reset period (\"30d\", \"1h\", etc.) - budget_id: Optional[str] - The id of the budget. If not provided, a new id will be generated. - max_budget: Optional[float] - The max budget for the budget. - soft_budget: Optional[float] - The soft budget for the budget. - max_parallel_requests: Optional[int] - The max number of parallel requests for the budget. - tpm_limit: Optional[int] - The tokens per minute limit for the budget. - rpm_limit: Optional[int] - The requests per minute limit for the budget. - model_max_budget: Optional[dict] - Specify max budget for a given model. Example: {\"openai/gpt-4o-mini\": {\"max_budget\": 100.0, \"budget_duration\": \"1d\", \"tpm_limit\": 100000, \"rpm_limit\": 100000}}
     * Update Budget
     */
    updateBudgetBudgetUpdatePost(requestParameters?: BudgetManagementApiUpdateBudgetBudgetUpdatePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
}