@nestbox-ai/instances 1.0.25

package/dist/esm/api.d.ts

@@ -0,0 +1,624 @@
+/**
+ * Nestbox API Agents API
+ * API for Nestbox Agents, control your agents
+ *
+ * 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 { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ *
+ * @export
+ * @interface AdditionalAgentParameterDto
+ */
+export interface AdditionalAgentParameterDto {
+    /**
+     *
+     * @type {string}
+     * @memberof AdditionalAgentParameterDto
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdditionalAgentParameterDto
+     */
+    'description': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AdditionalAgentParameterDto
+     */
+    'default_value': string;
+    /**
+     * The ID of the machine model associated with this additional parameter
+     * @type {string}
+     * @memberof AdditionalAgentParameterDto
+     */
+    'machineModelId': string;
+}
+/**
+ *
+ * @export
+ * @interface AgentParameterDto
+ */
+export interface AgentParameterDto {
+    /**
+     *
+     * @type {string}
+     * @memberof AgentParameterDto
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AgentParameterDto
+     */
+    'description': string;
+    /**
+     *
+     * @type {string}
+     * @memberof AgentParameterDto
+     */
+    'default_value': string;
+    /**
+     * The ID of the machine model associated with this parameter
+     * @type {string}
+     * @memberof AgentParameterDto
+     */
+    'machineModelId': string;
+}
+/**
+ *
+ * @export
+ * @interface CreateAdditionalParameterDto
+ */
+export interface CreateAdditionalParameterDto {
+    /**
+     * The name of the additional parameter
+     * @type {string}
+     * @memberof CreateAdditionalParameterDto
+     */
+    'name': string;
+    /**
+     * The description of the additional parameter
+     * @type {string}
+     * @memberof CreateAdditionalParameterDto
+     */
+    'description': string;
+    /**
+     * The default value of the additional parameter
+     * @type {string}
+     * @memberof CreateAdditionalParameterDto
+     */
+    'default_value': string;
+    /**
+     * The ID of the machine model associated with this additional parameter
+     * @type {string}
+     * @memberof CreateAdditionalParameterDto
+     */
+    'machineModelId': string;
+}
+/**
+ *
+ * @export
+ * @interface CreateExamplePromptDto
+ */
+export interface CreateExamplePromptDto {
+    /**
+     * The training prompt for the example
+     * @type {string}
+     * @memberof CreateExamplePromptDto
+     */
+    'trainingPrompt': string;
+    /**
+     * The answer for the training prompt
+     * @type {string}
+     * @memberof CreateExamplePromptDto
+     */
+    'promptAnswer': string;
+    /**
+     * The ID of the machine model associated with this example
+     * @type {string}
+     * @memberof CreateExamplePromptDto
+     */
+    'machineModelId': string;
+}
+/**
+ *
+ * @export
+ * @interface CreateMachineAgentDto
+ */
+export interface CreateMachineAgentDto {
+    /**
+     *
+     * @type {string}
+     * @memberof CreateMachineAgentDto
+     */
+    'name': string;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateMachineAgentDto
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {Array<AgentParameterDto>}
+     * @memberof CreateMachineAgentDto
+     */
+    'parameters'?: Array<AgentParameterDto>;
+    /**
+     *
+     * @type {Array<AdditionalAgentParameterDto>}
+     * @memberof CreateMachineAgentDto
+     */
+    'additionalParameters'?: Array<AdditionalAgentParameterDto>;
+}
+/**
+ *
+ * @export
+ * @interface CreateMachineModelDto
+ */
+export interface CreateMachineModelDto {
+    /**
+     * The name of the machine model
+     * @type {string}
+     * @memberof CreateMachineModelDto
+     */
+    'name': string;
+    /**
+     * The description of the machine model
+     * @type {string}
+     * @memberof CreateMachineModelDto
+     */
+    'description': string;
+    /**
+     * The prompt associated with the machine model
+     * @type {string}
+     * @memberof CreateMachineModelDto
+     */
+    'prompt': string;
+    /**
+     * Parameters associated with the machine model
+     * @type {Array<CreateParameterDto>}
+     * @memberof CreateMachineModelDto
+     */
+    'parameters': Array<CreateParameterDto>;
+    /**
+     * Additional parameters for the machine model
+     * @type {Array<CreateAdditionalParameterDto>}
+     * @memberof CreateMachineModelDto
+     */
+    'additionalParameters': Array<CreateAdditionalParameterDto>;
+    /**
+     * Training examples for the machine model
+     * @type {Array<CreateExamplePromptDto>}
+     * @memberof CreateMachineModelDto
+     */
+    'trainingExamples': Array<CreateExamplePromptDto>;
+}
+/**
+ *
+ * @export
+ * @interface CreateParameterDto
+ */
+export interface CreateParameterDto {
+    /**
+     * The name of the parameter
+     * @type {string}
+     * @memberof CreateParameterDto
+     */
+    'name': string;
+    /**
+     * The description of the parameter
+     * @type {string}
+     * @memberof CreateParameterDto
+     */
+    'description': string;
+    /**
+     * The default value of the parameter
+     * @type {string}
+     * @memberof CreateParameterDto
+     */
+    'default_value': string;
+    /**
+     * The ID of the machine model associated with this parameter
+     * @type {string}
+     * @memberof CreateParameterDto
+     */
+    'machineModelId': string;
+}
+/**
+ * AgentsApi - axios parameter creator
+ * @export
+ */
+export declare const AgentsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateMachineAgentDto} createMachineAgentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerCreateNewAgent: (createMachineAgentDto: CreateMachineAgentDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerDeleteAgent: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerGetAllAgents: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} id
+     * @param {object} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerUpdateMachineAgent: (id: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AgentsApi - functional programming interface
+ * @export
+ */
+export declare const AgentsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateMachineAgentDto} createMachineAgentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerCreateNewAgent(createMachineAgentDto: CreateMachineAgentDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerDeleteAgent(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerGetAllAgents(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} id
+     * @param {object} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerUpdateMachineAgent(id: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * AgentsApi - factory interface
+ * @export
+ */
+export declare const AgentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateMachineAgentDto} createMachineAgentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerCreateNewAgent(createMachineAgentDto: CreateMachineAgentDto, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerDeleteAgent(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerGetAllAgents(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} id
+     * @param {object} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    agentManagementControllerUpdateMachineAgent(id: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * AgentsApi - object-oriented interface
+ * @export
+ * @class AgentsApi
+ * @extends {BaseAPI}
+ */
+export declare class AgentsApi extends BaseAPI {
+    /**
+     *
+     * @param {CreateMachineAgentDto} createMachineAgentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgentsApi
+     */
+    agentManagementControllerCreateNewAgent(createMachineAgentDto: CreateMachineAgentDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgentsApi
+     */
+    agentManagementControllerDeleteAgent(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgentsApi
+     */
+    agentManagementControllerGetAllAgents(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @param {string} id
+     * @param {object} body
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AgentsApi
+     */
+    agentManagementControllerUpdateMachineAgent(id: string, body: object, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}
+/**
+ * ManifestApi - axios parameter creator
+ * @export
+ */
+export declare const ManifestApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementManifestControllerGetManifest: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ManifestApi - functional programming interface
+ * @export
+ */
+export declare const ManifestApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementManifestControllerGetManifest(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ManifestApi - factory interface
+ * @export
+ */
+export declare const ManifestApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementManifestControllerGetManifest(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * ManifestApi - object-oriented interface
+ * @export
+ * @class ManifestApi
+ * @extends {BaseAPI}
+ */
+export declare class ManifestApi extends BaseAPI {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ManifestApi
+     */
+    modelManagementManifestControllerGetManifest(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}
+/**
+ * ModelsApi - axios parameter creator
+ * @export
+ */
+export declare const ModelsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerCreateNewModel: (createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerDeleteModel: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerGetAllModels: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {string} id
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerUpdateMachineModel: (id: string, createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ModelsApi - functional programming interface
+ * @export
+ */
+export declare const ModelsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerCreateNewModel(createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerDeleteModel(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerGetAllModels(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @param {string} id
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerUpdateMachineModel(id: string, createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ModelsApi - factory interface
+ * @export
+ */
+export declare const ModelsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerCreateNewModel(createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerDeleteModel(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerGetAllModels(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @param {string} id
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    modelManagementControllerUpdateMachineModel(id: string, createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * ModelsApi - object-oriented interface
+ * @export
+ * @class ModelsApi
+ * @extends {BaseAPI}
+ */
+export declare class ModelsApi extends BaseAPI {
+    /**
+     *
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelsApi
+     */
+    modelManagementControllerCreateNewModel(createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelsApi
+     */
+    modelManagementControllerDeleteModel(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelsApi
+     */
+    modelManagementControllerGetAllModels(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @param {string} id
+     * @param {CreateMachineModelDto} createMachineModelDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ModelsApi
+     */
+    modelManagementControllerUpdateMachineModel(id: string, createMachineModelDto: CreateMachineModelDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}
+/**
+ * ServerLiveStatusApi - axios parameter creator
+ * @export
+ */
+export declare const ServerLiveStatusApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    appControllerGetStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ServerLiveStatusApi - functional programming interface
+ * @export
+ */
+export declare const ServerLiveStatusApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    appControllerGetStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * ServerLiveStatusApi - factory interface
+ * @export
+ */
+export declare const ServerLiveStatusApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    appControllerGetStatus(options?: RawAxiosRequestConfig): AxiosPromise<void>;
+};
+/**
+ * ServerLiveStatusApi - object-oriented interface
+ * @export
+ * @class ServerLiveStatusApi
+ * @extends {BaseAPI}
+ */
+export declare class ServerLiveStatusApi extends BaseAPI {
+    /**
+     *
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ServerLiveStatusApi
+     */
+    appControllerGetStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+}