hanzoai 0.0.1-alpha.1

package/resources/customer.d.ts

@@ -0,0 +1,298 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Customer extends APIResource {
+    /**
+     * 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.
+     *
+     * - 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" : "z-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
+     */
+    create(body: CustomerCreateParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * 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-llm-user-4",
+     *     "budget_id": "paid_tier"
+     * }'
+     *
+     * See below for all params
+     * ```
+     */
+    update(body: CustomerUpdateParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * [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'
+     * ```
+     */
+    list(options?: RequestOptions): APIPromise<CustomerListResponse>;
+    /**
+     * 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" :["z-jaff-5"]
+     * }'
+     *
+     * See below for all params
+     * ```
+     */
+    delete(body: CustomerDeleteParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * [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>, ...]
+     *   }'
+     *   ```
+     */
+    block(body: CustomerBlockParams, options?: RequestOptions): APIPromise<unknown>;
+    /**
+     * 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-llm-user-4'         -H 'Authorization: Bearer sk-1234'
+     * ```
+     */
+    retrieveInfo(query: CustomerRetrieveInfoParams, options?: RequestOptions): APIPromise<CustomerRetrieveInfoResponse>;
+    /**
+     * [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>, ...]
+     * }'
+     * ```
+     */
+    unblock(body: CustomerUnblockParams, options?: RequestOptions): APIPromise<unknown>;
+}
+export interface BlockUsers {
+    user_ids: Array<string>;
+}
+export type CustomerCreateResponse = unknown;
+export type CustomerUpdateResponse = unknown;
+export type CustomerListResponse = Array<CustomerListResponse.CustomerListResponseItem>;
+export declare namespace CustomerListResponse {
+    interface CustomerListResponseItem {
+        blocked: boolean;
+        user_id: string;
+        alias?: string | null;
+        allowed_model_region?: 'eu' | 'us' | null;
+        default_model?: string | null;
+        /**
+         * Represents user-controllable params for a LLM_BudgetTable record
+         */
+        llm_budget_table?: CustomerListResponseItem.LlmBudgetTable | null;
+        spend?: number;
+    }
+    namespace CustomerListResponseItem {
+        /**
+         * Represents user-controllable params for a LLM_BudgetTable record
+         */
+        interface LlmBudgetTable {
+            budget_duration?: string | null;
+            max_budget?: number | null;
+            max_parallel_requests?: number | null;
+            model_max_budget?: unknown | null;
+            rpm_limit?: number | null;
+            soft_budget?: number | null;
+            tpm_limit?: number | null;
+        }
+    }
+}
+export type CustomerDeleteResponse = unknown;
+export type CustomerBlockResponse = unknown;
+export interface CustomerRetrieveInfoResponse {
+    blocked: boolean;
+    user_id: string;
+    alias?: string | null;
+    allowed_model_region?: 'eu' | 'us' | null;
+    default_model?: string | null;
+    /**
+     * Represents user-controllable params for a LLM_BudgetTable record
+     */
+    llm_budget_table?: CustomerRetrieveInfoResponse.LlmBudgetTable | null;
+    spend?: number;
+}
+export declare namespace CustomerRetrieveInfoResponse {
+    /**
+     * Represents user-controllable params for a LLM_BudgetTable record
+     */
+    interface LlmBudgetTable {
+        budget_duration?: string | null;
+        max_budget?: number | null;
+        max_parallel_requests?: number | null;
+        model_max_budget?: unknown | null;
+        rpm_limit?: number | null;
+        soft_budget?: number | null;
+        tpm_limit?: number | null;
+    }
+}
+export type CustomerUnblockResponse = unknown;
+export interface CustomerCreateParams {
+    user_id: string;
+    alias?: string | null;
+    allowed_model_region?: 'eu' | 'us' | null;
+    blocked?: boolean;
+    /**
+     * Max duration budget should be set for (e.g. '1hr', '1d', '28d')
+     */
+    budget_duration?: string | null;
+    budget_id?: string | null;
+    default_model?: string | null;
+    /**
+     * Requests will fail if this budget (in USD) is exceeded.
+     */
+    max_budget?: number | null;
+    /**
+     * Max concurrent requests allowed for this budget id.
+     */
+    max_parallel_requests?: number | null;
+    /**
+     * Max budget for each model (e.g. {'gpt-4o': {'max_budget': '0.0000001',
+     * 'budget_duration': '1d', 'tpm_limit': 1000, 'rpm_limit': 1000}})
+     */
+    model_max_budget?: Record<string, CustomerCreateParams.ModelMaxBudget> | null;
+    /**
+     * Max requests per minute, allowed for this budget id.
+     */
+    rpm_limit?: number | null;
+    /**
+     * Requests will NOT fail if this is exceeded. Will fire alerting though.
+     */
+    soft_budget?: number | null;
+    /**
+     * Max tokens per minute, allowed for this budget id.
+     */
+    tpm_limit?: number | null;
+}
+export declare namespace CustomerCreateParams {
+    interface ModelMaxBudget {
+        budget_duration?: string | null;
+        max_budget?: number | null;
+        rpm_limit?: number | null;
+        tpm_limit?: number | null;
+    }
+}
+export interface CustomerUpdateParams {
+    user_id: string;
+    alias?: string | null;
+    allowed_model_region?: 'eu' | 'us' | null;
+    blocked?: boolean;
+    budget_id?: string | null;
+    default_model?: string | null;
+    max_budget?: number | null;
+}
+export interface CustomerDeleteParams {
+    user_ids: Array<string>;
+}
+export interface CustomerBlockParams {
+    user_ids: Array<string>;
+}
+export interface CustomerRetrieveInfoParams {
+    /**
+     * End User ID in the request parameters
+     */
+    end_user_id: string;
+}
+export interface CustomerUnblockParams {
+    user_ids: Array<string>;
+}
+export declare namespace Customer {
+    export { type BlockUsers as BlockUsers, type CustomerCreateResponse as CustomerCreateResponse, type CustomerUpdateResponse as CustomerUpdateResponse, type CustomerListResponse as CustomerListResponse, type CustomerDeleteResponse as CustomerDeleteResponse, type CustomerBlockResponse as CustomerBlockResponse, type CustomerRetrieveInfoResponse as CustomerRetrieveInfoResponse, type CustomerUnblockResponse as CustomerUnblockResponse, type CustomerCreateParams as CustomerCreateParams, type CustomerUpdateParams as CustomerUpdateParams, type CustomerDeleteParams as CustomerDeleteParams, type CustomerBlockParams as CustomerBlockParams, type CustomerRetrieveInfoParams as CustomerRetrieveInfoParams, type CustomerUnblockParams as CustomerUnblockParams, };
+}
+//# sourceMappingURL=customer.d.ts.map

package/resources/customer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../src/resources/customer.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIjF;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIjF;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIhE;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIjF;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI/E;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,KAAK,EAAE,0BAA0B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAI3C;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGpF;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,MAAM,oBAAoB,GAAG,KAAK,CAAC,oBAAoB,CAAC,wBAAwB,CAAC,CAAC;AAExF,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,wBAAwB;QACvC,OAAO,EAAE,OAAO,CAAC;QAEjB,OAAO,EAAE,MAAM,CAAC;QAEhB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB,oBAAoB,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;QAE1C,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC,cAAc,GAAG,IAAI,CAAC;QAElE,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED,UAAiB,wBAAwB,CAAC;QACxC;;WAEG;QACH,UAAiB,cAAc;YAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAEtC,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAElC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC3B;KACF;CACF;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAAC;AAE7C,MAAM,MAAM,qBAAqB,GAAG,OAAO,CAAC;AAE5C,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,OAAO,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,oBAAoB,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1C,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,4BAA4B,CAAC,cAAc,GAAG,IAAI,CAAC;IAEtE,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,cAAc;QAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtC,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;QAElC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE9C,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,oBAAoB,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC;IAE9E;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,cAAc;QAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB,oBAAoB,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1C,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/customer.js

@@ -0,0 +1,180 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Customer = void 0;
+const resource_1 = require("../core/resource.js");
+class Customer extends resource_1.APIResource {
+    /**
+     * 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.
+     *
+     * - 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" : "z-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
+     */
+    create(body, options) {
+        return this._client.post('/customer/new', { body, ...options });
+    }
+    /**
+     * 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-llm-user-4",
+     *     "budget_id": "paid_tier"
+     * }'
+     *
+     * See below for all params
+     * ```
+     */
+    update(body, options) {
+        return this._client.post('/customer/update', { body, ...options });
+    }
+    /**
+     * [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'
+     * ```
+     */
+    list(options) {
+        return this._client.get('/customer/list', options);
+    }
+    /**
+     * 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" :["z-jaff-5"]
+     * }'
+     *
+     * See below for all params
+     * ```
+     */
+    delete(body, options) {
+        return this._client.post('/customer/delete', { body, ...options });
+    }
+    /**
+     * [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>, ...]
+     *   }'
+     *   ```
+     */
+    block(body, options) {
+        return this._client.post('/customer/block', { body, ...options });
+    }
+    /**
+     * 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-llm-user-4'         -H 'Authorization: Bearer sk-1234'
+     * ```
+     */
+    retrieveInfo(query, options) {
+        return this._client.get('/customer/info', { query, ...options });
+    }
+    /**
+     * [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>, ...]
+     * }'
+     * ```
+     */
+    unblock(body, options) {
+        return this._client.post('/customer/unblock', { body, ...options });
+    }
+}
+exports.Customer = Customer;
+//# sourceMappingURL=customer.js.map

package/resources/customer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer.js","sourceRoot":"","sources":["../src/resources/customer.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,IAAyB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF;AArLD,4BAqLC"}

package/resources/customer.mjs

@@ -0,0 +1,176 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class Customer extends APIResource {
+    /**
+     * 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.
+     *
+     * - 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" : "z-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
+     */
+    create(body, options) {
+        return this._client.post('/customer/new', { body, ...options });
+    }
+    /**
+     * 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-llm-user-4",
+     *     "budget_id": "paid_tier"
+     * }'
+     *
+     * See below for all params
+     * ```
+     */
+    update(body, options) {
+        return this._client.post('/customer/update', { body, ...options });
+    }
+    /**
+     * [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'
+     * ```
+     */
+    list(options) {
+        return this._client.get('/customer/list', options);
+    }
+    /**
+     * 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" :["z-jaff-5"]
+     * }'
+     *
+     * See below for all params
+     * ```
+     */
+    delete(body, options) {
+        return this._client.post('/customer/delete', { body, ...options });
+    }
+    /**
+     * [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>, ...]
+     *   }'
+     *   ```
+     */
+    block(body, options) {
+        return this._client.post('/customer/block', { body, ...options });
+    }
+    /**
+     * 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-llm-user-4'         -H 'Authorization: Bearer sk-1234'
+     * ```
+     */
+    retrieveInfo(query, options) {
+        return this._client.get('/customer/info', { query, ...options });
+    }
+    /**
+     * [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>, ...]
+     * }'
+     * ```
+     */
+    unblock(body, options) {
+        return this._client.post('/customer/unblock', { body, ...options });
+    }
+}
+//# sourceMappingURL=customer.mjs.map

package/resources/customer.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"customer.mjs","sourceRoot":"","sources":["../src/resources/customer.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoDG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,IAAyB,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,KAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;CACF"}