@wandelbots/nova-api 25.8.0-dev.16 → 25.8.0-dev.18

package/v2/api.ts

@@ -1782,9 +1782,22 @@ export interface GetTrajectoryResponse {
 export interface HTTPValidationError {
     /**
      * 
-     * @type {Array<ValidationError>}
+     * @type {Array<ValidationError2>}
      * @memberof HTTPValidationError
      */
+    'detail'?: Array<ValidationError2>;
+}
+/**
+ * 
+ * @export
+ * @interface HTTPValidationError2
+ */
+export interface HTTPValidationError2 {
+    /**
+     * 
+     * @type {Array<ValidationError>}
+     * @memberof HTTPValidationError2
+     */
     'detail'?: Array<ValidationError>;
 }
 /**
@@ -4336,6 +4349,154 @@ export interface ProfinetSubSlotDescription {
      */
     'output_length': number;
 }
+/**
+ * A program is a collection of instructions that are executed in the robot cell.
+ * @export
+ * @interface Program
+ */
+export interface Program {
+    /**
+     * 
+     * @type {string}
+     * @memberof Program
+     */
+    'program': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Program
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Program
+     */
+    'description'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Program
+     */
+    'app': string;
+    /**
+     * 
+     * @type {object}
+     * @memberof Program
+     */
+    'input_schema'?: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof Program
+     */
+    'preconditions'?: object;
+}
+/**
+ * Holds the state of a program run.
+ * @export
+ * @interface ProgramRun
+ */
+export interface ProgramRun {
+    /**
+     * Unique identifier of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'run': string;
+    /**
+     * Unique identifier of the program
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'program': string;
+    /**
+     * State of the program run
+     * @type {ProgramRunState}
+     * @memberof ProgramRun
+     */
+    'state': ProgramRunState;
+    /**
+     * Logs of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'logs'?: string;
+    /**
+     * Stdout of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'stdout'?: string;
+    /**
+     * Stderr of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'stderr'?: string;
+    /**
+     * Error message of the program run, if any
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'error'?: string;
+    /**
+     * Traceback of the program run, if any
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'traceback'?: string;
+    /**
+     * Start time of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'start_time'?: string;
+    /**
+     * End time of the program run
+     * @type {string}
+     * @memberof ProgramRun
+     */
+    'end_time'?: string;
+    /**
+     * Input data of the program run
+     * @type {object}
+     * @memberof ProgramRun
+     */
+    'input_data'?: object;
+}
+
+
+/**
+ * The state of a program run.
+ * @export
+ * @enum {string}
+ */
+
+export const ProgramRunState = {
+    Preparing: 'PREPARING',
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED',
+    Stopped: 'STOPPED'
+} as const;
+
+export type ProgramRunState = typeof ProgramRunState[keyof typeof ProgramRunState];
+
+
+/**
+ * The state of a program run.
+ * @export
+ * @interface ProgramStartRequest
+ */
+export interface ProgramStartRequest {
+    /**
+     * The arguments to pass to the program.
+     * @type {object}
+     * @memberof ProgramStartRequest
+     */
+    'arguments': object;
+}
 /**
  * <!-- theme: danger -->  > **Experimental**  RRT Connect algorithm configuration for collision-free path planning. Rapidly-exploring Random Trees (RRT) builds trees of valid configurations by randomly sampling the joint space and connecting feasible points. RRT Connect grows two trees simultaneously from start and target positions until they meet. This is a custom implementation optimized for manipulator kinematics and collision checking in industrial contexts. 
  * @export
@@ -5390,6 +5551,31 @@ export interface ValidationError {
      */
     'input': { [key: string]: any; };
 }
+/**
+ * A validation error of a program.
+ * @export
+ * @interface ValidationError2
+ */
+export interface ValidationError2 {
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof ValidationError2
+     */
+    'loc': Array<number>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ValidationError2
+     */
+    'msg': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ValidationError2
+     */
+    'type': string;
+}
 /**
  * @type ValidationErrorLocInner
  * @export
@@ -10975,6 +11161,383 @@ export class MotionGroupModelsApi extends BaseAPI {
 
 
 
+/**
+ * ProgramApi - axios parameter creator
+ * @export
+ */
+export const ProgramApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get details of a program.
+         * @summary Get program
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('getProgram', 'cell', cell)
+            // verify required parameter 'program' is not null or undefined
+            assertParamExists('getProgram', 'program', program)
+            const localVarPath = `/experimental/cells/{cell}/programs/{program}`
+                .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
+                .replace(`{${"program"}}`, encodeURIComponent(String(program)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List details of all existing programs.
+         * @summary List programs
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPrograms: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('listPrograms', 'cell', cell)
+            const localVarPath = `/experimental/cells/{cell}/programs`
+                .replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This endpoint starts a new program execution.  The program will be executed asynchronously. 
+         * @summary Start the program
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {ProgramStartRequest} programStartRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        startProgram: async (cell: string, program: string, programStartRequest: ProgramStartRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('startProgram', 'cell', cell)
+            // verify required parameter 'program' is not null or undefined
+            assertParamExists('startProgram', 'program', program)
+            // verify required parameter 'programStartRequest' is not null or undefined
+            assertParamExists('startProgram', 'programStartRequest', programStartRequest)
+            const localVarPath = `/experimental/cells/{cell}/programs/{program}/start`
+                .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
+                .replace(`{${"program"}}`, encodeURIComponent(String(program)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(programStartRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Stop a specific program run.
+         * @summary Stop program run
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        stopProgram: async (cell: string, program: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('stopProgram', 'cell', cell)
+            // verify required parameter 'program' is not null or undefined
+            assertParamExists('stopProgram', 'program', program)
+            const localVarPath = `/experimental/cells/{cell}/programs/{program}/stop`
+                .replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
+                .replace(`{${"program"}}`, encodeURIComponent(String(program)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            // authentication BearerAuth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ProgramApi - functional programming interface
+ * @export
+ */
+export const ProgramApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ProgramApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get details of a program.
+         * @summary Get program
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Program>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getProgram(cell, program, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProgramApi.getProgram']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List details of all existing programs.
+         * @summary List programs
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listPrograms(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Program>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPrograms(cell, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProgramApi.listPrograms']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * This endpoint starts a new program execution.  The program will be executed asynchronously. 
+         * @summary Start the program
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {ProgramStartRequest} programStartRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgramRun>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.startProgram(cell, program, programStartRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProgramApi.startProgram']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Stop a specific program run.
+         * @summary Stop program run
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.stopProgram(cell, program, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ProgramApi.stopProgram']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ProgramApi - factory interface
+ * @export
+ */
+export const ProgramApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ProgramApiFp(configuration)
+    return {
+        /**
+         * Get details of a program.
+         * @summary Get program
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<Program> {
+            return localVarFp.getProgram(cell, program, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List details of all existing programs.
+         * @summary List programs
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listPrograms(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<Program>> {
+            return localVarFp.listPrograms(cell, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This endpoint starts a new program execution.  The program will be executed asynchronously. 
+         * @summary Start the program
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {ProgramStartRequest} programStartRequest 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProgramRun> {
+            return localVarFp.startProgram(cell, program, programStartRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Stop a specific program run.
+         * @summary Stop program run
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {string} program 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.stopProgram(cell, program, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ProgramApi - object-oriented interface
+ * @export
+ * @class ProgramApi
+ * @extends {BaseAPI}
+ */
+export class ProgramApi extends BaseAPI {
+    /**
+     * Get details of a program.
+     * @summary Get program
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {string} program 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    public getProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
+        return ProgramApiFp(this.configuration).getProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List details of all existing programs.
+     * @summary List programs
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    public listPrograms(cell: string, options?: RawAxiosRequestConfig) {
+        return ProgramApiFp(this.configuration).listPrograms(cell, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * This endpoint starts a new program execution.  The program will be executed asynchronously. 
+     * @summary Start the program
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {string} program 
+     * @param {ProgramStartRequest} programStartRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    public startProgram(cell: string, program: string, programStartRequest: ProgramStartRequest, options?: RawAxiosRequestConfig) {
+        return ProgramApiFp(this.configuration).startProgram(cell, program, programStartRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Stop a specific program run.
+     * @summary Stop program run
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {string} program 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProgramApi
+     */
+    public stopProgram(cell: string, program: string, options?: RawAxiosRequestConfig) {
+        return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * StoreCollisionComponentsApi - axios parameter creator
  * @export