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

package/dist/sdk.gen.d.ts

@@ -0,0 +1,167 @@
+import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
+import type { BlockMachineData, BlockMachineErrors, BlockMachineResponses, CreateAccessRuleData, CreateAccessRuleErrors, CreateAccessRuleResponses, CreateGpuEnvironmentData, CreateGpuEnvironmentErrors, CreateGpuEnvironmentResponses, CreateKeyData, CreateKeyErrors, CreateKeyResponses, DeleteAccessRuleData, DeleteAccessRuleErrors, DeleteAccessRuleResponses, DeleteFleetPackageData, DeleteFleetPackageResponses, DeleteGpuEnvironmentData, DeleteGpuEnvironmentErrors, DeleteGpuEnvironmentResponses, DeleteKeyData, DeleteKeyErrors, DeleteKeyResponses, ForgetMachineData, ForgetMachineErrors, ForgetMachineResponses, GetFleetData, GetFleetErrors, GetFleetInventoryCsvData, GetFleetInventoryCsvResponses, GetFleetPackageData, GetFleetPackageErrors, GetFleetPackageResponses, GetFleetProfileData, GetFleetProfileResponses, GetFleetReadmeData, GetFleetReadmeResponses, GetFleetResponses, GetGpuEnvironmentData, GetGpuEnvironmentErrors, GetGpuEnvironmentLogData, GetGpuEnvironmentLogErrors, GetGpuEnvironmentLogResponses, GetGpuEnvironmentResponses, GetMeData, GetMeErrors, GetMeResponses, GetUsageData, GetUsageErrors, GetUsageResponses, ListAccessRulesData, ListAccessRulesErrors, ListAccessRulesResponses, ListGpuEnvironmentsData, ListGpuEnvironmentsErrors, ListGpuEnvironmentsResponses, ListGpuServersData, ListGpuServersErrors, ListGpuServersResponses, ListGpuTiersData, ListGpuTiersResponses, ListKeysData, ListKeysErrors, ListKeysResponses, ListTiersData, ListTiersResponses, RebuildGpuEnvironmentData, RebuildGpuEnvironmentErrors, RebuildGpuEnvironmentResponses, SearchPrincipalsData, SearchPrincipalsErrors, SearchPrincipalsResponses, StartGpuEnvironmentData, StartGpuEnvironmentErrors, StartGpuEnvironmentResponses, StopGpuServerData, StopGpuServerErrors, StopGpuServerResponses, 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>;
+/**
+ * GPU tiers a rule may use
+ *
+ * Empty when the GPU part is not enabled.
+ */
+export declare const listGpuTiers: <ThrowOnError extends boolean = false>(options?: Options<ListGpuTiersData, ThrowOnError>) => RequestResult<ListGpuTiersResponses, unknown, ThrowOnError>;
+/**
+ * My environments
+ *
+ * Environments built from Git repositories, newest first, with the current build status.
+ */
+export declare const listGpuEnvironments: <ThrowOnError extends boolean = false>(options?: Options<ListGpuEnvironmentsData, ThrowOnError>) => RequestResult<ListGpuEnvironmentsResponses, ListGpuEnvironmentsErrors, ThrowOnError>;
+/**
+ * Add an environment from a Git repository
+ *
+ * Resolves the ref to a commit. If Harbor already has the image for that commit, the environment is ready at once; otherwise a build starts (status building). Public repositories on the allowed hosts only.
+ */
+export declare const createGpuEnvironment: <ThrowOnError extends boolean = false>(options: Options<CreateGpuEnvironmentData, ThrowOnError>) => RequestResult<CreateGpuEnvironmentResponses, CreateGpuEnvironmentErrors, ThrowOnError>;
+/**
+ * Forget an environment
+ *
+ * The image stays in Harbor until its retention rules remove it.
+ */
+export declare const deleteGpuEnvironment: <ThrowOnError extends boolean = false>(options: Options<DeleteGpuEnvironmentData, ThrowOnError>) => RequestResult<DeleteGpuEnvironmentResponses, DeleteGpuEnvironmentErrors, ThrowOnError>;
+/**
+ * One environment with its build status
+ */
+export declare const getGpuEnvironment: <ThrowOnError extends boolean = false>(options: Options<GetGpuEnvironmentData, ThrowOnError>) => RequestResult<GetGpuEnvironmentResponses, GetGpuEnvironmentErrors, ThrowOnError>;
+/**
+ * Tail of the build log
+ *
+ * Available while the build job exists (one day after it finished).
+ */
+export declare const getGpuEnvironmentLog: <ThrowOnError extends boolean = false>(options: Options<GetGpuEnvironmentLogData, ThrowOnError>) => RequestResult<GetGpuEnvironmentLogResponses, GetGpuEnvironmentLogErrors, ThrowOnError>;
+/**
+ * Build the environment again
+ */
+export declare const rebuildGpuEnvironment: <ThrowOnError extends boolean = false>(options: Options<RebuildGpuEnvironmentData, ThrowOnError>) => RequestResult<RebuildGpuEnvironmentResponses, RebuildGpuEnvironmentErrors, ThrowOnError>;
+/**
+ * Start a JupyterHub server for the environment
+ *
+ * A named server per environment; the repository is checked out into ~/projekte/<repo>. With gpu=true it waits for a free GPU and counts against the GPU quota; JupyterHub's refusal comes back as 409 with its message.
+ */
+export declare const startGpuEnvironment: <ThrowOnError extends boolean = false>(options: Options<StartGpuEnvironmentData, ThrowOnError>) => RequestResult<StartGpuEnvironmentResponses, StartGpuEnvironmentErrors, ThrowOnError>;
+/**
+ * My JupyterHub servers
+ */
+export declare const listGpuServers: <ThrowOnError extends boolean = false>(options?: Options<ListGpuServersData, ThrowOnError>) => RequestResult<ListGpuServersResponses, ListGpuServersErrors, ThrowOnError>;
+/**
+ * Stop one of my servers
+ *
+ * Named servers are removed after stopping; the home stays.
+ */
+export declare const stopGpuServer: <ThrowOnError extends boolean = false>(options: Options<StopGpuServerData, ThrowOnError>) => RequestResult<StopGpuServerResponses, StopGpuServerErrors, 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>;