@wandelbots/nova-api 25.4.0-dev.2 → 25.4.0-dev.21

package/package.json

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

package/v2/api.d.ts

@@ -228,6 +228,12 @@ export interface App {
      * @memberof App
      */
     'storage'?: ContainerStorage;
+    /**
+     * Defines the URL path suffix used to check the application\'s health status. The complete health check URL is constructed as `/$cell/$name/$health_path`. When the application is working as expected, the endpoint returns an HTTP 200 status code.  If not specified, the system will default to using the application icon path suffix (the value of `app_icon`) as the health check endpoint, resulting in `/$cell/$name/$app_icon`.  If the health check fails (no response or non-200 status code), the system will automatically restart the application container to restore service.
+     * @type {string}
+     * @memberof App
+     */
+    'health_path'?: string;
 }
 /**
  *
@@ -870,6 +876,31 @@ export interface Compound {
      */
     'child_geometries': Array<Geometry>;
 }
+/**
+ * Configuration resource object.
+ * @export
+ * @interface ConfigurationResource
+ */
+export interface ConfigurationResource {
+    /**
+     * Identifier of a configuration resource.
+     * @type {string}
+     * @memberof ConfigurationResource
+     */
+    'id': string;
+    /**
+     * Human-readable name of the configuration resource.
+     * @type {string}
+     * @memberof ConfigurationResource
+     */
+    'name': string;
+    /**
+     * Array of configuration resources.
+     * @type {Array<ConfigurationResource>}
+     * @memberof ConfigurationResource
+     */
+    'children'?: Array<ConfigurationResource>;
+}
 /**
  *
  * @export
@@ -1327,6 +1358,19 @@ export declare const Direction: {
     readonly DirectionBackward: "DIRECTION_BACKWARD";
 };
 export type Direction = typeof Direction[keyof typeof Direction];
+/**
+ *
+ * @export
+ * @interface Error2
+ */
+export interface Error2 {
+    /**
+     *
+     * @type {string}
+     * @memberof Error2
+     */
+    'message': string;
+}
 /**
  * @type ExecuteJoggingRequest
  * @export
@@ -1843,7 +1887,7 @@ export interface IODescription {
      * @type {IODirection}
      * @memberof IODescription
      */
-    'direction'?: IODirection;
+    'direction': IODirection;
     /**
      *
      * @type {IOValueType}
@@ -3205,7 +3249,7 @@ export interface ModelError {
      * @type {string}
      * @memberof ModelError
      */
-    'code': string;
+    'code'?: string;
     /**
      *
      * @type {string}
@@ -3250,7 +3294,7 @@ export type MotionCommandBlending = BlendingAuto | BlendingPosition;
  */
 export type MotionCommandPath = PathCartesianPTP | PathCircle | PathCubicSpline | PathJointPTP | PathLine;
 /**
- * The data type describes the physically connected motion groups on a robot controller, e.g. a robot arm.
+ * The data type describes the physically connected motion groups on a robot controller, e.g., a robot arm.
  * @export
  * @interface MotionGroup
  */
@@ -3274,11 +3318,17 @@ export interface MotionGroup {
      */
     'name_from_controller': string;
     /**
-     * The robot controller model if available. Usable for frontend 3D visualization.
+     * The robot controller model, if available. Usable for frontend 3D visualization.
      * @type {string}
      * @memberof MotionGroup
      */
     'model_from_controller': string;
+    /**
+     * The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, then empty.
+     * @type {string}
+     * @memberof MotionGroup
+     */
+    'serial_number'?: string;
 }
 /**
  *
@@ -3519,11 +3569,17 @@ export interface MotionGroupPhysical {
      */
     'active': boolean;
     /**
-     * The robot controller model if available. Usable for frontend 3D visualization.
+     * The robot controller model, if available. Usable for frontend 3D visualization.
      * @type {string}
      * @memberof MotionGroupPhysical
      */
     'model_from_controller'?: string;
+    /**
+     * The serial number of the motion group, if available. If not available, the serial number of the robot controller. if available. If not available, the response is empty.
+     * @type {string}
+     * @memberof MotionGroupPhysical
+     */
+    'serial_number'?: string;
 }
 /**
  * Holding static properties of the motion group.
@@ -3827,6 +3883,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
@@ -5305,6 +5371,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
@@ -5556,25 +5641,6 @@ export interface StartOnIO {
      */
     'comparator': Comparator;
 }
-/**
- * The `Status` type defines a logical error model that is suitable for different programming environments including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `status` message contains two pieces of data: error code and error message. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
- * @export
- * @interface Status
- */
-export interface Status {
-    /**
-     * The status code, which should be an enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto).
-     * @type {number}
-     * @memberof Status
-     */
-    'code'?: number;
-    /**
-     * An error message in English.
-     * @type {string}
-     * @memberof Status
-     */
-    'message'?: string;
-}
 /**
  *
  * @export
@@ -6569,6 +6635,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
@@ -6618,7 +6693,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
@@ -6626,6 +6701,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
@@ -6675,7 +6759,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
@@ -6683,6 +6767,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
@@ -6738,7 +6831,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
@@ -6747,6 +6840,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
@@ -10863,6 +10966,17 @@ export declare class StoreObjectApi extends BaseAPI {
  * @export
  */
 export declare const SystemApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Retrieves a configuration backup based on provided resource identifiers.
+     * @summary Retrieve Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backupConfiguration: (resources: Array<string>, metadata?: {
+        [key: string]: string;
+    }, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Check if a more recent Wandelbots NOVA Version is available.
      * @summary Check update
@@ -10892,6 +11006,22 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getSystemVersion: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of all available configuration resources for backup purposes.
+     * @summary List Configuration Resources
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConfigurationResources: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Restores a previously backed up configuration.
+     * @summary Restore Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {File} body Backup file stream containing the configuration to restore.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreConfiguration: (resources: Array<string>, body: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored.
      * @summary Update Wandelbots NOVA version
@@ -10906,6 +11036,17 @@ export declare const SystemApiAxiosParamCreator: (configuration?: Configuration)
  * @export
  */
 export declare const SystemApiFp: (configuration?: Configuration) => {
+    /**
+     * Retrieves a configuration backup based on provided resource identifiers.
+     * @summary Retrieve Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backupConfiguration(resources: Array<string>, metadata?: {
+        [key: string]: string;
+    }, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
     /**
      * Check if a more recent Wandelbots NOVA Version is available.
      * @summary Check update
@@ -10935,6 +11076,22 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSystemVersion(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     * Retrieves a list of all available configuration resources for backup purposes.
+     * @summary List Configuration Resources
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConfigurationResources(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ConfigurationResource>>>;
+    /**
+     * Restores a previously backed up configuration.
+     * @summary Restore Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {File} body Backup file stream containing the configuration to restore.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored.
      * @summary Update Wandelbots NOVA version
@@ -10949,6 +11106,17 @@ export declare const SystemApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const SystemApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Retrieves a configuration backup based on provided resource identifiers.
+     * @summary Retrieve Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    backupConfiguration(resources: Array<string>, metadata?: {
+        [key: string]: string;
+    }, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      * Check if a more recent Wandelbots NOVA Version is available.
      * @summary Check update
@@ -10978,6 +11146,22 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getSystemVersion(options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     * Retrieves a list of all available configuration resources for backup purposes.
+     * @summary List Configuration Resources
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listConfigurationResources(options?: RawAxiosRequestConfig): AxiosPromise<Array<ConfigurationResource>>;
+    /**
+     * Restores a previously backed up configuration.
+     * @summary Restore Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {File} body Backup file stream containing the configuration to restore.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored.
      * @summary Update Wandelbots NOVA version
@@ -10994,6 +11178,18 @@ export declare const SystemApiFactory: (configuration?: Configuration, basePath?
  * @extends {BaseAPI}
  */
 export declare class SystemApi extends BaseAPI {
+    /**
+     * Retrieves a configuration backup based on provided resource identifiers.
+     * @summary Retrieve Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {{ [key: string]: string; }} [metadata] Additional metadata to add to the backup
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemApi
+     */
+    backupConfiguration(resources: Array<string>, metadata?: {
+        [key: string]: string;
+    }, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      * Check if a more recent Wandelbots NOVA Version is available.
      * @summary Check update
@@ -11027,6 +11223,24 @@ export declare class SystemApi extends BaseAPI {
      * @memberof SystemApi
      */
     getSystemVersion(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
+    /**
+     * Retrieves a list of all available configuration resources for backup purposes.
+     * @summary List Configuration Resources
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemApi
+     */
+    listConfigurationResources(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigurationResource[], any>>;
+    /**
+     * Restores a previously backed up configuration.
+     * @summary Restore Configuration Backup
+     * @param {Array<string>} resources List of resource identifiers to included in the backup and restore operations.
+     * @param {File} body Backup file stream containing the configuration to restore.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SystemApi
+     */
+    restoreConfiguration(resources: Array<string>, body: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * Update the Wandelbots NOVA version and all attached services.  Sending this API Request will trigger an update of all NOVA services that are part of a cell. Previous cells and cell configurations will remain on the instance.  If the update fails, the previous Wandelbots NOVA version is restored.
      * @summary Update Wandelbots NOVA version