import {z} from 'zod' export type UsageType = 'usage' | 'codestral' | 'document_library' | 'document_library_api' | 'libraries_pages' | 'libraries_tokens' | 'libraries_audio' | 'chat' | 'rlhf' | 'ocr' | 'audio_seconds' | 'audio_characters' | 'audio_agents' | 'connectors' | 'workflow_executions' | 'vibe' | 'vibe_connectors' | 'vibe_ocr' | 'vibe_audio_seconds' | 'vibe_audio_characters'; export type AdminUsageQueryFilter = {field: 'usage_type' | 'billing_metric' | 'billing_display_name' | 'billing_group' | 'workspace_id' | 'organization_id' | 'user_id' | 'service_account_id' | 'api_key_id' | 'api_zone' | 'service_tier', operator: 'is' | 'is_not', values: Array}; export type UsageQueryIN = {usage_type?: (Array | null) | undefined, billing_metric?: (Array | null) | undefined, billing_display_name?: (Array | null) | undefined, billing_group?: (Array | null) | undefined, workspace_ids?: (Array | null) | undefined, organization_id?: (Array | null) | undefined, user_id?: (Array | null) | undefined, service_account_id?: (Array | null) | undefined, api_key_id?: (Array | null) | undefined, api_zone?: (Array | null) | undefined, service_tier?: (Array | null) | undefined, start: string, end: string, filters?: (Array | null) | undefined, group_by?: (Array<'api_zone' | 'service_tier' | 'customer_id' | 'usage_type' | 'billing_metric' | 'billing_group' | 'billing_display_name' | 'workspace_id' | 'organization_id' | 'user_id' | 'service_account_id' | 'api_key_id' | 'untracked' | 'call_source' | 'call_type' | 'customer_tier'> | null) | undefined, time_bucket?: ('second' | '1min' | '5min' | '15min' | '30min' | 'hour' | '4hours' | 'day' | 'week' | 'month' | null) | undefined, untracked?: (boolean | null) | undefined, limit?: (number | null) | undefined, offset?: (number | null) | undefined, include_aggregates?: boolean | undefined, include_nb_api_calls?: boolean | undefined}; export type CreateApiV1AdminUsageQueryArgs = {body: UsageQueryIN}; export type CreateApiV1AdminUsageQueryOptions = {baseUrl?: string | undefined, AdminApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const usageQueryRowOUT = z.object({customer_id: z.string().nullable().optional(), usage_type: z.string().nullable().optional(), billing_metric: z.string().nullable().optional(), billing_group: z.string().nullable().optional(), workspace_id: z.string().nullable().optional(), organization_id: z.string().nullable().optional(), user_id: z.string().nullable().optional(), service_account_id: z.string().nullable().optional(), api_key_id: z.string().nullable().optional(), api_zone: z.string().nullable().optional(), service_tier: z.string().nullable().optional(), timestamp: z.string().nullable().optional(), time_bucket: z.string().nullable().optional(), value: z.number().int().nullable().optional(), count: z.number().int().nullable().optional(), nb_api_calls: z.number().int().nullable().optional(), billing_display_name: z.string().nullable().optional(), customer_tier: z.string().nullable().optional(), untracked: z.boolean().nullable().optional(), call_source: z.string().nullable().optional(), call_type: z.string().nullable().optional()}); export const usageQueryAggregatesOUT = z.object({total_value: z.number(), total_count: z.number().int(), total_api_calls: z.number().int(), customer_count: z.number().int(), usage_type_count: z.number().int()}); export const usageType = z.enum(["usage", "codestral", "document_library", "document_library_api", "libraries_pages", "libraries_tokens", "libraries_audio", "chat", "rlhf", "ocr", "audio_seconds", "audio_characters", "audio_agents", "connectors", "workflow_executions", "vibe", "vibe_connectors", "vibe_ocr", "vibe_audio_seconds", "vibe_audio_characters"]); export const adminUsageQueryFilter = z.object({field: z.enum(["usage_type", "billing_metric", "billing_display_name", "billing_group", "workspace_id", "organization_id", "user_id", "service_account_id", "api_key_id", "api_zone", "service_tier"]), operator: z.enum(["is", "is_not"]), values: z.array(z.string().nullable())}); export const usageQueryParamsOUT = z.object({usage_type: z.array(usageType).nullable().optional(), billing_metric: z.array(z.string()).nullable().optional(), billing_display_name: z.array(z.string()).nullable().optional(), billing_group: z.array(z.string()).nullable().optional(), workspace_ids: z.array(z.string().nullable()).nullable().optional(), organization_id: z.array(z.string()).nullable().optional(), user_id: z.array(z.string()).nullable().optional(), service_account_id: z.array(z.string()).nullable().optional(), api_key_id: z.array(z.string()).nullable().optional(), api_zone: z.array(z.string()).nullable().optional(), service_tier: z.array(z.string()).nullable().optional(), start: z.string(), end: z.string(), customer_id: z.string().nullable().optional(), filters: z.array(adminUsageQueryFilter).nullable().optional(), group_by: z.array(z.enum(["api_zone", "service_tier", "customer_id", "usage_type", "billing_metric", "billing_group", "billing_display_name", "workspace_id", "organization_id", "user_id", "service_account_id", "api_key_id", "untracked", "call_source", "call_type", "customer_tier"])).nullable().optional(), time_bucket: z.enum(["second", "1min", "5min", "15min", "30min", "hour", "4hours", "day", "week", "month"]).nullable().optional(), limit: z.number().int().nullable().optional(), offset: z.number().int().nullable().optional(), untracked: z.boolean().nullable().optional(), include_nb_api_calls: z.boolean().optional()}); export const usageQueryMetadataOUT = z.object({query_params: usageQueryParamsOUT, has_more: z.boolean()}); export const usageQueryOUT = z.object({groups: z.array(usageQueryRowOUT), aggregates: usageQueryAggregatesOUT.nullable().optional(), metadata: usageQueryMetadataOUT}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Detailed Usage Query * * POST /v1/admin/usage/query */ export const createApiV1AdminUsageQuery = async (args: CreateApiV1AdminUsageQueryArgs, options?: CreateApiV1AdminUsageQueryOptions) => { const {baseUrl = "https://api.mistral.ai", fetch: fetchFn = fetch, AdminApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (AdminApiKey !== undefined) headers.set('authorization', `Bearer ${AdminApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/admin/usage/query${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(usageQueryOUT, await res.json()) };