@dhbw-cloud/llm-client 0.0.0-stage → 0.1.0-test.11

package/dist/sdk.gen.d.ts

@@ -0,0 +1,113 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
+import type { BlockMachineData, BlockMachineErrors, BlockMachineResponses, CreateAccessRuleData, CreateAccessRuleErrors, CreateAccessRuleResponses, CreateKeyData, CreateKeyErrors, CreateKeyResponses, DeleteAccessRuleData, DeleteAccessRuleErrors, DeleteAccessRuleResponses, DeleteFleetPackageData, DeleteFleetPackageResponses, DeleteKeyData, DeleteKeyErrors, DeleteKeyResponses, ForgetMachineData, ForgetMachineErrors, ForgetMachineResponses, GetFleetData, GetFleetErrors, GetFleetInventoryCsvData, GetFleetInventoryCsvResponses, GetFleetPackageData, GetFleetPackageErrors, GetFleetPackageResponses, GetFleetProfileData, GetFleetProfileResponses, GetFleetReadmeData, GetFleetReadmeResponses, GetFleetResponses, GetMeData, GetMeErrors, GetMeResponses, GetUsageData, GetUsageErrors, GetUsageResponses, ListAccessRulesData, ListAccessRulesErrors, ListAccessRulesResponses, ListKeysData, ListKeysErrors, ListKeysResponses, ListTiersData, ListTiersResponses, SearchPrincipalsData, SearchPrincipalsErrors, SearchPrincipalsResponses, UnblockMachineData, UnblockMachineErrors, UnblockMachineResponses, UpdateAccessRuleData, UpdateAccessRuleErrors, UpdateAccessRuleResponses } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+/**
+ * List the access rules
+ *
+ * Rules from the configuration come first and are marked bootstrap (read-only).
+ */
+export declare const listAccessRules: <ThrowOnError extends boolean = false>(options?: Options<ListAccessRulesData, ThrowOnError>) => RequestResult<ListAccessRulesResponses, ListAccessRulesErrors, ThrowOnError>;
+/**
+ * Add an access rule
+ */
+export declare const createAccessRule: <ThrowOnError extends boolean = false>(options: Options<CreateAccessRuleData, ThrowOnError>) => RequestResult<CreateAccessRuleResponses, CreateAccessRuleErrors, ThrowOnError>;
+/**
+ * Delete an access rule
+ */
+export declare const deleteAccessRule: <ThrowOnError extends boolean = false>(options: Options<DeleteAccessRuleData, ThrowOnError>) => RequestResult<DeleteAccessRuleResponses, DeleteAccessRuleErrors, ThrowOnError>;
+/**
+ * Replace an access rule
+ */
+export declare const updateAccessRule: <ThrowOnError extends boolean = false>(options: Options<UpdateAccessRuleData, ThrowOnError>) => RequestResult<UpdateAccessRuleResponses, UpdateAccessRuleErrors, ThrowOnError>;
+/**
+ * The Mac fleet
+ *
+ * Machines with enrolment state, LiteLLM health, script state and the JAMF onboarding data.
+ */
+export declare const getFleet: <ThrowOnError extends boolean = false>(options?: Options<GetFleetData, ThrowOnError>) => RequestResult<GetFleetResponses, GetFleetErrors, ThrowOnError>;
+/**
+ * Fleet inventory as CSV
+ */
+export declare const getFleetInventoryCsv: <ThrowOnError extends boolean = false>(options?: Options<GetFleetInventoryCsvData, ThrowOnError>) => RequestResult<GetFleetInventoryCsvResponses, unknown, ThrowOnError>;
+/**
+ * Withdraw the uploaded JAMF package
+ *
+ * Admins only. The machines are unaffected; only the download disappears.
+ */
+export declare const deleteFleetPackage: <ThrowOnError extends boolean = false>(options?: Options<DeleteFleetPackageData, ThrowOnError>) => RequestResult<DeleteFleetPackageResponses, unknown, ThrowOnError>;
+/**
+ * The newest JAMF package
+ */
+export declare const getFleetPackage: <ThrowOnError extends boolean = false>(options?: Options<GetFleetPackageData, ThrowOnError>) => RequestResult<GetFleetPackageResponses, GetFleetPackageErrors, ThrowOnError>;
+/**
+ * JAMF configuration profile
+ *
+ * Optional location, operator and contact apply to every device in the profile's scope (one profile per device group).
+ */
+export declare const getFleetProfile: <ThrowOnError extends boolean = false>(options?: Options<GetFleetProfileData, ThrowOnError>) => RequestResult<GetFleetProfileResponses, unknown, ThrowOnError>;
+/**
+ * Fleet onboarding guide (Markdown)
+ */
+export declare const getFleetReadme: <ThrowOnError extends boolean = false>(options?: Options<GetFleetReadmeData, ThrowOnError>) => RequestResult<GetFleetReadmeResponses, unknown, ThrowOnError>;
+/**
+ * Remove a machine from the registry
+ *
+ * For decommissioned devices. A machine that boots again re-enrols with a NEW address; to keep it out, block it instead.
+ */
+export declare const forgetMachine: <ThrowOnError extends boolean = false>(options: Options<ForgetMachineData, ThrowOnError>) => RequestResult<ForgetMachineResponses, ForgetMachineErrors, ThrowOnError>;
+/**
+ * Block a machine (it is refused at the next enrolment)
+ */
+export declare const blockMachine: <ThrowOnError extends boolean = false>(options: Options<BlockMachineData, ThrowOnError>) => RequestResult<BlockMachineResponses, BlockMachineErrors, ThrowOnError>;
+/**
+ * Unblock a machine
+ */
+export declare const unblockMachine: <ThrowOnError extends boolean = false>(options: Options<UnblockMachineData, ThrowOnError>) => RequestResult<UnblockMachineResponses, UnblockMachineErrors, ThrowOnError>;
+/**
+ * The caller's API keys
+ */
+export declare const listKeys: <ThrowOnError extends boolean = false>(options?: Options<ListKeysData, ThrowOnError>) => RequestResult<ListKeysResponses, ListKeysErrors, ThrowOnError>;
+/**
+ * Create an API key
+ *
+ * The name is required and unique per person. The secret is returned exactly once.
+ */
+export declare const createKey: <ThrowOnError extends boolean = false>(options: Options<CreateKeyData, ThrowOnError>) => RequestResult<CreateKeyResponses, CreateKeyErrors, ThrowOnError>;
+/**
+ * Delete one of the caller's API keys
+ */
+export declare const deleteKey: <ThrowOnError extends boolean = false>(options: Options<DeleteKeyData, ThrowOnError>) => RequestResult<DeleteKeyResponses, DeleteKeyErrors, ThrowOnError>;
+/**
+ * Who am I, and what may I do?
+ *
+ * Always 200 for an authenticated caller. Without access, role is empty.
+ */
+export declare const getMe: <ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>) => RequestResult<GetMeResponses, GetMeErrors, ThrowOnError>;
+/**
+ * Search groups and users
+ *
+ * For the access-rule editor. Groups match on ID, display name or description; users on their EMAIL ADDRESS ONLY and only once q is non-empty — the directory is not browsable by person or name.
+ */
+export declare const searchPrincipals: <ThrowOnError extends boolean = false>(options?: Options<SearchPrincipalsData, ThrowOnError>) => RequestResult<SearchPrincipalsResponses, SearchPrincipalsErrors, ThrowOnError>;
+/**
+ * Quota tiers a rule may use
+ */
+export declare const listTiers: <ThrowOnError extends boolean = false>(options?: Options<ListTiersData, ThrowOnError>) => RequestResult<ListTiersResponses, unknown, ThrowOnError>;
+/**
+ * Quota, limits and keys of the caller
+ *
+ * Monthly budget over all keys, the per-key short-term budgets, rate limits and allowed models.
+ */
+export declare const getUsage: <ThrowOnError extends boolean = false>(options?: Options<GetUsageData, ThrowOnError>) => RequestResult<GetUsageResponses, GetUsageErrors, ThrowOnError>;

package/dist/types.gen.d.ts

@@ -0,0 +1,595 @@
+export type ClientOptions = {
+    baseUrl: `${string}://${string}` | (string & {});
+};
+export type AccessRole = '' | 'user' | 'fleet-admin' | 'admin';
+export type AccessRule = {
+    /**
+     * Bootstrap rules come from the configuration, not from the database. They
+     * guarantee that someone can always administer the list, and they cannot be
+     * edited or deleted through the API.
+     */
+    bootstrap?: boolean;
+    comment?: string;
+    id?: number;
+    role?: AccessRole;
+    tier?: string;
+    token?: string;
+    updated_at?: string;
+    updated_by?: string;
+};
+export type FleetFleetView = {
+    allowed_serials?: number;
+    capacity?: number;
+    enabled?: boolean;
+    endpoint_v6?: string;
+    enroll_host?: string;
+    enroll_token?: string;
+    listen_port?: number;
+    package?: FleetPackageInfo;
+    package_id?: string;
+    peers?: Array<FleetPeerView>;
+    pool?: string;
+    profiles?: Array<FleetProfile>;
+    reenroll_seconds?: number;
+    self_update?: {
+        canary?: Array<string>;
+        mode?: string;
+        scripts?: {
+            [key: string]: string;
+        };
+    };
+};
+export type FleetPackageInfo = {
+    file?: string;
+    sha256?: string;
+    size?: number;
+    uploaded_at?: string;
+    version?: string;
+};
+export type FleetPeerView = {
+    address?: string;
+    api_base?: string;
+    blocked?: boolean;
+    busy?: boolean;
+    canary?: boolean;
+    contact?: string;
+    controls?: boolean;
+    enabled?: boolean;
+    gate?: string;
+    hardware?: string;
+    hostname?: string;
+    inference?: 'angehalten' | 'unbekannt' | 'nicht registriert' | 'erreichbar' | 'gestört' | 'teilweise';
+    inference_error?: string;
+    last_seen?: string;
+    location?: string;
+    model?: string;
+    model_state?: 'fremdverwaltet' | 'erfüllt' | 'abweichend' | 'unbekannt';
+    models?: Array<string>;
+    name?: string;
+    operator?: string;
+    os?: string;
+    pkg_version?: string;
+    profile?: string;
+    quiet_seconds?: number;
+    ram_gb?: number;
+    script_state?: string;
+    serial?: string;
+    serving?: Array<string>;
+    state?: 'aktiv' | 'ohne Rückmeldung' | 'gesperrt';
+    transport?: string;
+};
+export type FleetProfile = {
+    context?: number;
+    minRamMb?: number;
+    model?: string;
+    name?: string;
+    weight?: number;
+    wiredLimitMb?: number;
+};
+export type KeysKeyView = {
+    budget?: number;
+    budget_duration?: string;
+    chat?: boolean;
+    id?: string;
+    name?: string;
+    reset_at?: string;
+    spend?: number;
+};
+export type KeysUsage = {
+    budget?: number;
+    budget_duration?: string;
+    keys?: Array<KeysKeyView>;
+    max_keys?: number;
+    models?: Array<string>;
+    own_keys?: number;
+    reset_at?: string;
+    rpm?: number;
+    spend?: number;
+    tpm?: number;
+};
+export type RoleproviderGroup = {
+    description?: string;
+    /**
+     * Display name, left out when it only repeats the group ID (imported groups).
+     */
+    label?: string;
+    token?: string;
+};
+export type WebserverCreateKeyRequest = {
+    name: string;
+};
+export type WebserverCreateKeyResponse = {
+    key?: string;
+    name?: string;
+};
+export type WebserverErrorResponse = {
+    /**
+     * Stable machine-readable reason.
+     */
+    code?: string;
+    /**
+     * Readable text, in the field the self-service-ui reads (as with the other DHBW Cloud APIs).
+     */
+    error?: string;
+};
+export type WebserverMeResponse = {
+    /**
+     * Only for admins: autologin link to the LiteLLM admin UI.
+     */
+    admin_ui_url?: string;
+    api_url?: string;
+    chat_url?: string;
+    email?: string;
+    matched_token?: string;
+    role?: 'user' | 'fleet-admin' | 'admin';
+    tier?: string;
+};
+export type WebserverPrincipalSearchResponse = {
+    groups?: Array<RoleproviderGroup>;
+    users?: Array<string>;
+};
+export type WebserverRuleRequest = {
+    comment?: string;
+    role: 'user' | 'fleet-admin' | 'admin';
+    tier: string;
+    token: string;
+};
+export type WebserverRuleRequest2 = WebserverRuleRequest;
+export type ListAccessRulesData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/access-rules';
+};
+export type ListAccessRulesErrors = {
+    /**
+     * Forbidden
+     */
+    403: WebserverErrorResponse;
+};
+export type ListAccessRulesError = ListAccessRulesErrors[keyof ListAccessRulesErrors];
+export type ListAccessRulesResponses = {
+    /**
+     * OK
+     */
+    200: Array<AccessRule>;
+};
+export type ListAccessRulesResponse = ListAccessRulesResponses[keyof ListAccessRulesResponses];
+export type CreateAccessRuleData = {
+    /**
+     * Rule
+     */
+    body: WebserverRuleRequest2;
+    path?: never;
+    query?: never;
+    url: '/v1/access-rules';
+};
+export type CreateAccessRuleErrors = {
+    /**
+     * Bad Request
+     */
+    400: WebserverErrorResponse;
+    /**
+     * Conflict
+     */
+    409: WebserverErrorResponse;
+};
+export type CreateAccessRuleError = CreateAccessRuleErrors[keyof CreateAccessRuleErrors];
+export type CreateAccessRuleResponses = {
+    /**
+     * Created
+     */
+    201: AccessRule;
+};
+export type CreateAccessRuleResponse = CreateAccessRuleResponses[keyof CreateAccessRuleResponses];
+export type DeleteAccessRuleData = {
+    body?: never;
+    path: {
+        /**
+         * Rule id
+         */
+        id: number;
+    };
+    query?: never;
+    url: '/v1/access-rules/{id}';
+};
+export type DeleteAccessRuleErrors = {
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type DeleteAccessRuleError = DeleteAccessRuleErrors[keyof DeleteAccessRuleErrors];
+export type DeleteAccessRuleResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteAccessRuleResponse = DeleteAccessRuleResponses[keyof DeleteAccessRuleResponses];
+export type UpdateAccessRuleData = {
+    /**
+     * Rule
+     */
+    body: WebserverRuleRequest2;
+    path: {
+        /**
+         * Rule id
+         */
+        id: number;
+    };
+    query?: never;
+    url: '/v1/access-rules/{id}';
+};
+export type UpdateAccessRuleErrors = {
+    /**
+     * Bad Request
+     */
+    400: WebserverErrorResponse;
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type UpdateAccessRuleError = UpdateAccessRuleErrors[keyof UpdateAccessRuleErrors];
+export type UpdateAccessRuleResponses = {
+    /**
+     * OK
+     */
+    200: AccessRule;
+};
+export type UpdateAccessRuleResponse = UpdateAccessRuleResponses[keyof UpdateAccessRuleResponses];
+export type GetFleetData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/fleet';
+};
+export type GetFleetErrors = {
+    /**
+     * Forbidden
+     */
+    403: WebserverErrorResponse;
+};
+export type GetFleetError = GetFleetErrors[keyof GetFleetErrors];
+export type GetFleetResponses = {
+    /**
+     * OK
+     */
+    200: FleetFleetView;
+};
+export type GetFleetResponse = GetFleetResponses[keyof GetFleetResponses];
+export type GetFleetInventoryCsvData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/fleet/inventory.csv';
+};
+export type GetFleetInventoryCsvResponses = {
+    /**
+     * OK
+     */
+    200: string;
+};
+export type GetFleetInventoryCsvResponse = GetFleetInventoryCsvResponses[keyof GetFleetInventoryCsvResponses];
+export type DeleteFleetPackageData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/fleet/package';
+};
+export type DeleteFleetPackageResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteFleetPackageResponse = DeleteFleetPackageResponses[keyof DeleteFleetPackageResponses];
+export type GetFleetPackageData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/fleet/package';
+};
+export type GetFleetPackageErrors = {
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type GetFleetPackageError = GetFleetPackageErrors[keyof GetFleetPackageErrors];
+export type GetFleetPackageResponses = {
+    /**
+     * OK
+     */
+    200: Blob | File;
+};
+export type GetFleetPackageResponse = GetFleetPackageResponses[keyof GetFleetPackageResponses];
+export type GetFleetProfileData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Standort
+         */
+        location?: string;
+        /**
+         * Betreiber
+         */
+        operator?: string;
+        /**
+         * Kontakt
+         */
+        contact?: string;
+    };
+    url: '/v1/fleet/profile';
+};
+export type GetFleetProfileResponses = {
+    /**
+     * OK
+     */
+    200: string;
+};
+export type GetFleetProfileResponse = GetFleetProfileResponses[keyof GetFleetProfileResponses];
+export type GetFleetReadmeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/fleet/readme';
+};
+export type GetFleetReadmeResponses = {
+    /**
+     * OK
+     */
+    200: string;
+};
+export type GetFleetReadmeResponse = GetFleetReadmeResponses[keyof GetFleetReadmeResponses];
+export type ForgetMachineData = {
+    body?: never;
+    path: {
+        /**
+         * Serial number
+         */
+        serial: string;
+    };
+    query?: never;
+    url: '/v1/fleet/{serial}';
+};
+export type ForgetMachineErrors = {
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type ForgetMachineError = ForgetMachineErrors[keyof ForgetMachineErrors];
+export type ForgetMachineResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type ForgetMachineResponse = ForgetMachineResponses[keyof ForgetMachineResponses];
+export type BlockMachineData = {
+    body?: never;
+    path: {
+        /**
+         * Serial number
+         */
+        serial: string;
+    };
+    query?: never;
+    url: '/v1/fleet/{serial}/block';
+};
+export type BlockMachineErrors = {
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type BlockMachineError = BlockMachineErrors[keyof BlockMachineErrors];
+export type BlockMachineResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type BlockMachineResponse = BlockMachineResponses[keyof BlockMachineResponses];
+export type UnblockMachineData = {
+    body?: never;
+    path: {
+        /**
+         * Serial number
+         */
+        serial: string;
+    };
+    query?: never;
+    url: '/v1/fleet/{serial}/unblock';
+};
+export type UnblockMachineErrors = {
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type UnblockMachineError = UnblockMachineErrors[keyof UnblockMachineErrors];
+export type UnblockMachineResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type UnblockMachineResponse = UnblockMachineResponses[keyof UnblockMachineResponses];
+export type ListKeysData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/keys';
+};
+export type ListKeysErrors = {
+    /**
+     * Forbidden
+     */
+    403: WebserverErrorResponse;
+};
+export type ListKeysError = ListKeysErrors[keyof ListKeysErrors];
+export type ListKeysResponses = {
+    /**
+     * OK
+     */
+    200: Array<KeysKeyView>;
+};
+export type ListKeysResponse = ListKeysResponses[keyof ListKeysResponses];
+export type CreateKeyData = {
+    /**
+     * Key
+     */
+    body: WebserverCreateKeyRequest;
+    path?: never;
+    query?: never;
+    url: '/v1/keys';
+};
+export type CreateKeyErrors = {
+    /**
+     * Bad Request
+     */
+    400: WebserverErrorResponse;
+    /**
+     * Conflict
+     */
+    409: WebserverErrorResponse;
+};
+export type CreateKeyError = CreateKeyErrors[keyof CreateKeyErrors];
+export type CreateKeyResponses = {
+    /**
+     * Created
+     */
+    201: WebserverCreateKeyResponse;
+};
+export type CreateKeyResponse = CreateKeyResponses[keyof CreateKeyResponses];
+export type DeleteKeyData = {
+    body?: never;
+    path: {
+        /**
+         * Key id (from the key list, not the secret)
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/v1/keys/{id}';
+};
+export type DeleteKeyErrors = {
+    /**
+     * Not Found
+     */
+    404: WebserverErrorResponse;
+};
+export type DeleteKeyError = DeleteKeyErrors[keyof DeleteKeyErrors];
+export type DeleteKeyResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteKeyResponse = DeleteKeyResponses[keyof DeleteKeyResponses];
+export type GetMeData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/me';
+};
+export type GetMeErrors = {
+    /**
+     * Unauthorized
+     */
+    401: WebserverErrorResponse;
+};
+export type GetMeError = GetMeErrors[keyof GetMeErrors];
+export type GetMeResponses = {
+    /**
+     * OK
+     */
+    200: WebserverMeResponse;
+};
+export type GetMeResponse = GetMeResponses[keyof GetMeResponses];
+export type SearchPrincipalsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Search text
+         */
+        q?: string;
+        /**
+         * Maximum entries per kind (default 10, at most 50)
+         */
+        limit?: number;
+    };
+    url: '/v1/principals/search';
+};
+export type SearchPrincipalsErrors = {
+    /**
+     * Bad Gateway
+     */
+    502: WebserverErrorResponse;
+};
+export type SearchPrincipalsError = SearchPrincipalsErrors[keyof SearchPrincipalsErrors];
+export type SearchPrincipalsResponses = {
+    /**
+     * OK
+     */
+    200: WebserverPrincipalSearchResponse;
+};
+export type SearchPrincipalsResponse = SearchPrincipalsResponses[keyof SearchPrincipalsResponses];
+export type ListTiersData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/tiers';
+};
+export type ListTiersResponses = {
+    /**
+     * OK
+     */
+    200: Array<string>;
+};
+export type ListTiersResponse = ListTiersResponses[keyof ListTiersResponses];
+export type GetUsageData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/v1/usage';
+};
+export type GetUsageErrors = {
+    /**
+     * Forbidden
+     */
+    403: WebserverErrorResponse;
+};
+export type GetUsageError = GetUsageErrors[keyof GetUsageErrors];
+export type GetUsageResponses = {
+    /**
+     * OK
+     */
+    200: KeysUsage;
+};
+export type GetUsageResponse = GetUsageResponses[keyof GetUsageResponses];