@wandelbots/nova-api 25.8.0-dev.17 → 25.8.0-dev.19

package/v2/api.js

@@ -355,6 +355,18 @@ export const ProfinetIOTypeEnum = {
     ProfinetIoTypeReal: 'PROFINET_IO_TYPE_REAL',
     ProfinetIoTypeLreal: 'PROFINET_IO_TYPE_LREAL'
 };
+/**
+ * The state of a program run.
+ * @export
+ * @enum {string}
+ */
+export const ProgramRunState = {
+    Preparing: 'PREPARING',
+    Running: 'RUNNING',
+    Completed: 'COMPLETED',
+    Failed: 'FAILED',
+    Stopped: 'STOPPED'
+};
 export const RRTConnectAlgorithmAlgorithmNameEnum = {
     RrtConnectAlgorithm: 'RRTConnectAlgorithm'
 };
@@ -5443,6 +5455,345 @@ export class MotionGroupModelsApi extends BaseAPI {
         return MotionGroupModelsApiFp(this.configuration).getMotionGroupModels(cell, options).then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * ProgramApi - axios parameter creator
+ * @export
+ */
+export const ProgramApiAxiosParamCreator = function (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, program, options = {}) => {
+            // 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 = {};
+            const localVarQueryParameter = {};
+            // 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, options = {}) => {
+            // 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 = {};
+            const localVarQueryParameter = {};
+            // 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, program, programStartRequest, options = {}) => {
+            // 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 = {};
+            const localVarQueryParameter = {};
+            // 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, program, options = {}) => {
+            // 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 = {};
+            const localVarQueryParameter = {};
+            // 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) {
+    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, program, options) {
+            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, options) {
+            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, program, programStartRequest, options) {
+            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, program, options) {
+            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, basePath, axios) {
+    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, program, options) {
+            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, options) {
+            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, program, programStartRequest, options) {
+            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, program, options) {
+            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
+     */
+    getProgram(cell, program, options) {
+        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
+     */
+    listPrograms(cell, options) {
+        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
+     */
+    startProgram(cell, program, programStartRequest, options) {
+        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
+     */
+    stopProgram(cell, program, options) {
+        return ProgramApiFp(this.configuration).stopProgram(cell, program, options).then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * StoreCollisionComponentsApi - axios parameter creator
  * @export