@wandelbots/nova-api 25.4.0-dev.10 → 25.4.0-dev.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wandelbots/nova-api",
-  "version": "25.4.0-dev.10",
+  "version": "25.4.0-dev.12",
   "description": "API Client to interact with Wandelbots Public API.",
   "files": [
     "*",

package/v2/api.d.ts

@@ -3871,6 +3871,16 @@ export interface OpcuaNodeValueTriggerConfig {
  */
 export interface OpcuaNodeValueTriggerConfigNodeValue {
 }
+/**
+ * The operating state.
+ * @export
+ * @enum {string}
+ */
+export declare const OperatingState: {
+    readonly Active: "ACTIVE";
+    readonly Inactive: "INACTIVE";
+};
+export type OperatingState = typeof OperatingState[keyof typeof OperatingState];
 /**
  * Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
  * @export
@@ -5349,6 +5359,25 @@ export declare const ServiceStatusPhase: {
     readonly Evicted: "Evicted";
 };
 export type ServiceStatusPhase = typeof ServiceStatusPhase[keyof typeof ServiceStatusPhase];
+/**
+ * Response containing both the overall operating state of the cell and detailed status information for each service within the cell.  The operating state indicates whether the cell is active or inactive, while the service statuses provide specific health and operational information for individual service running in the cell.
+ * @export
+ * @interface ServiceStatusResponse
+ */
+export interface ServiceStatusResponse {
+    /**
+     *
+     * @type {OperatingState}
+     * @memberof ServiceStatusResponse
+     */
+    'operating_state': OperatingState;
+    /**
+     *
+     * @type {Array<ServiceStatus>}
+     * @memberof ServiceStatusResponse
+     */
+    'service_status': Array<ServiceStatus>;
+}
 /**
  *
  * @export
@@ -6594,6 +6623,15 @@ export declare const CellApiAxiosParamCreator: (configuration?: Configuration) =
      * @throws {RequiredError}
      */
     listCells: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deactivate or activate the services of a cell.
+     * @summary Operating State
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCellStatus: (cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update the definition of the entire Cell.
      * @summary Update Configuration
@@ -6643,7 +6681,7 @@ export declare const CellApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServiceStatus>>>;
+    getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceStatusResponse>>;
     /**
      * List all deployed cell names. If no cells are deployed, an empty list is returned.
      * @summary List Cells
@@ -6651,6 +6689,15 @@ export declare const CellApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listCells(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     * Deactivate or activate the services of a cell.
+     * @summary Operating State
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Update the definition of the entire Cell.
      * @summary Update Configuration
@@ -6700,7 +6747,7 @@ export declare const CellApiFactory: (configuration?: Configuration, basePath?:
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<ServiceStatus>>;
+    getCellStatus(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<ServiceStatusResponse>;
     /**
      * List all deployed cell names. If no cells are deployed, an empty list is returned.
      * @summary List Cells
@@ -6708,6 +6755,15 @@ export declare const CellApiFactory: (configuration?: Configuration, basePath?:
      * @throws {RequiredError}
      */
     listCells(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     * Deactivate or activate the services of a cell.
+     * @summary Operating State
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Update the definition of the entire Cell.
      * @summary Update Configuration
@@ -6763,7 +6819,7 @@ export declare class CellApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof CellApi
      */
-    getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceStatus[], any>>;
+    getCellStatus(cell: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceStatusResponse, any>>;
     /**
      * List all deployed cell names. If no cells are deployed, an empty list is returned.
      * @summary List Cells
@@ -6772,6 +6828,16 @@ export declare class CellApi extends BaseAPI {
      * @memberof CellApi
      */
     listCells(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any>>;
+    /**
+     * Deactivate or activate the services of a cell.
+     * @summary Operating State
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CellApi
+     */
+    setCellStatus(cell: string, operatingState: OperatingState, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Update the definition of the entire Cell.
      * @summary Update Configuration

package/v2/api.js

@@ -320,6 +320,15 @@ export const MotionGroupModel = {
     KukaKr270R31002: 'KUKA_KR270_R3100_2',
     KukaKr360R2830: 'KUKA_KR360_R2830'
 };
+/**
+ * The operating state.
+ * @export
+ * @enum {string}
+ */
+export const OperatingState = {
+    Active: 'ACTIVE',
+    Inactive: 'INACTIVE'
+};
 /**
  * Current operation mode of the configured robot controller. Operation modes in which the attached motion groups can be moved are: - OPERATION_MODE_MANUAL (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T1 (if enabling switch is pressed) - OPERATION_MODE_MANUAL_T2 (if enabling switch is pressed) - OPERATION_MODE_AUTO (without needing to press enabling switch) All other modes are considered as non-operational.
  * @export
@@ -1355,6 +1364,47 @@ export const CellApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Deactivate or activate the services of a cell.
+         * @summary Operating State
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCellStatus: async (cell, operatingState, options = {}) => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('setCellStatus', 'cell', cell);
+            // verify required parameter 'operatingState' is not null or undefined
+            assertParamExists('setCellStatus', 'operatingState', operatingState);
+            const localVarPath = `/cells/{cell}/status`
+                .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: 'PUT', ...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);
+            if (operatingState !== undefined) {
+                localVarQueryParameter['operating_state'] = operatingState;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Update the definition of the entire Cell.
          * @summary Update Configuration
@@ -1474,6 +1524,20 @@ export const CellApiFp = function (configuration) {
             const localVarOperationServerBasePath = operationServerMap['CellApi.listCells']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Deactivate or activate the services of a cell.
+         * @summary Operating State
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async setCellStatus(cell, operatingState, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setCellStatus(cell, operatingState, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['CellApi.setCellStatus']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Update the definition of the entire Cell.
          * @summary Update Configuration
@@ -1549,6 +1613,17 @@ export const CellApiFactory = function (configuration, basePath, axios) {
         listCells(options) {
             return localVarFp.listCells(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Deactivate or activate the services of a cell.
+         * @summary Operating State
+         * @param {string} cell Unique identifier addressing a cell in all API calls.
+         * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setCellStatus(cell, operatingState, options) {
+            return localVarFp.setCellStatus(cell, operatingState, options).then((request) => request(axios, basePath));
+        },
         /**
          * Update the definition of the entire Cell.
          * @summary Update Configuration
@@ -1626,6 +1701,18 @@ export class CellApi extends BaseAPI {
     listCells(options) {
         return CellApiFp(this.configuration).listCells(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Deactivate or activate the services of a cell.
+     * @summary Operating State
+     * @param {string} cell Unique identifier addressing a cell in all API calls.
+     * @param {OperatingState} operatingState Set state of the cell. Active or inactive.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CellApi
+     */
+    setCellStatus(cell, operatingState, options) {
+        return CellApiFp(this.configuration).setCellStatus(cell, operatingState, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Update the definition of the entire Cell.
      * @summary Update Configuration