@wandelbots/nova-api 25.6.0-dev.20 → 25.6.0-dev.22

package/v2/api.ts

@@ -1378,7 +1378,7 @@ export interface FloatValue {
      */
     'value': number;
     /**
-     * Input/Output floating number representation.
+     * 
      * @type {string}
      * @memberof FloatValue
      */
@@ -1522,7 +1522,7 @@ export type IOBooleanValueValueTypeEnum = typeof IOBooleanValueValueTypeEnum[key
  */
 export interface IODescription {
     /**
-     * Unique identifier defined by the controller. Identifiers are only defined uniquely per controller, e.g. Inputs/Outputs for two different robots on the same controller can have the same identifier. 
+     * Unique identifier of the input/output. 
      * @type {string}
      * @memberof IODescription
      */
@@ -1593,7 +1593,7 @@ export type IODirection = typeof IODirection[keyof typeof IODirection];
 
 
 /**
- * Input/Output floating number representation.
+ * 
  * @export
  * @interface IOFloatValue
  */
@@ -1625,7 +1625,7 @@ export const IOFloatValueValueTypeEnum = {
 export type IOFloatValueValueTypeEnum = typeof IOFloatValueValueTypeEnum[keyof typeof IOFloatValueValueTypeEnum];
 
 /**
- * Input/Output integer value representation.
+ * 
  * @export
  * @interface IOIntegerValue
  */
@@ -1637,7 +1637,7 @@ export interface IOIntegerValue {
      */
     'io': string;
     /**
-     * Value of an analog input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > there are some JS bigint libraries available to parse the string into an integral value. 
+     * Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. 
      * @type {string}
      * @memberof IOIntegerValue
      */
@@ -1906,7 +1906,7 @@ export interface InitializeMovementResponseInitResponse {
     'error_message'?: string;
 }
 /**
- * Value of an analog input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > there are some JS bigint libraries available to parse the string into an integral value. 
+ * Value of an input/output with integer representation.  > The integral value is transmitted as a string to avoid precision loss during conversion to JSON. > We recommend to use int64 in your implementation. If you want to interact with int64 in numbers, > JS bigint libraries can help you to parse the string into an integral value. 
  * @export
  * @interface IntegerValue
  */
@@ -4844,7 +4844,7 @@ export type TriggerType = typeof TriggerType[keyof typeof TriggerType];
 
 
 /**
- * The unit of input/outputs value.
+ * The unit of input/output value.
  * @export
  * @enum {string}
  */
@@ -5843,6 +5843,293 @@ export class ApplicationApi extends BaseAPI {
 
 
 
+/**
+ * BusIOsApi - axios parameter creator
+ * @export
+ */
+export const BusIOsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Retrieves the current values of inputs/outputs.  The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions). 
+         * @summary Get Input/Output Values
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {Array<string>} [ios] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getBusIOValues: async (cell: string, ios?: Array<string>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('getBusIOValues', 'cell', cell)
+            const localVarPath = `/cells/{cell}/bus-ios/ios/values`
+                .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)
+
+            if (ios) {
+                localVarQueryParameter['ios'] = ios;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * List all Bus Input/Outputs. 
+         * @summary Configuration
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBusIODescriptions: async (cell: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('listBusIODescriptions', 'cell', cell)
+            const localVarPath = `/cells/{cell}/bus-ios/ios/description`
+                .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,
+            };
+        },
+        /**
+         * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set.  All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions).  The call will return once the values have been set and accepted by the service. 
+         * @summary Set Output Values
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {Array<IOValue>} iOValue 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setBusIOValues: async (cell: string, iOValue: Array<IOValue>, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'cell' is not null or undefined
+            assertParamExists('setBusIOValues', 'cell', cell)
+            // verify required parameter 'iOValue' is not null or undefined
+            assertParamExists('setBusIOValues', 'iOValue', iOValue)
+            const localVarPath = `/cells/{cell}/bus-ios/ios/values`
+                .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 = {} 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(iOValue, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * BusIOsApi - functional programming interface
+ * @export
+ */
+export const BusIOsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = BusIOsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Retrieves the current values of inputs/outputs.  The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions). 
+         * @summary Get Input/Output Values
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {Array<string>} [ios] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IOValue>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getBusIOValues(cell, ios, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BusIOsApi.getBusIOValues']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * List all Bus Input/Outputs. 
+         * @summary Configuration
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IODescription>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listBusIODescriptions(cell, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BusIOsApi.listBusIODescriptions']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set.  All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions).  The call will return once the values have been set and accepted by the service. 
+         * @summary Set Output Values
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {Array<IOValue>} iOValue 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.setBusIOValues(cell, iOValue, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['BusIOsApi.setBusIOValues']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * BusIOsApi - factory interface
+ * @export
+ */
+export const BusIOsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = BusIOsApiFp(configuration)
+    return {
+        /**
+         * Retrieves the current values of inputs/outputs.  The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions). 
+         * @summary Get Input/Output Values
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {Array<string>} [ios] 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<Array<IOValue>> {
+            return localVarFp.getBusIOValues(cell, ios, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * List all Bus Input/Outputs. 
+         * @summary Configuration
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<IODescription>> {
+            return localVarFp.listBusIODescriptions(cell, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set.  All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions).  The call will return once the values have been set and accepted by the service. 
+         * @summary Set Output Values
+         * @param {string} cell Unique identifier addressing a cell in all API calls. 
+         * @param {Array<IOValue>} iOValue 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig): AxiosPromise<void> {
+            return localVarFp.setBusIOValues(cell, iOValue, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * BusIOsApi - object-oriented interface
+ * @export
+ * @class BusIOsApi
+ * @extends {BaseAPI}
+ */
+export class BusIOsApi extends BaseAPI {
+    /**
+     * Retrieves the current values of inputs/outputs.  The identifiers of the inputs/outputs must be provided in the request. Request all available input/output identifiers via [listBusIODescriptions](listBusIODescriptions). 
+     * @summary Get Input/Output Values
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {Array<string>} [ios] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusIOsApi
+     */
+    public getBusIOValues(cell: string, ios?: Array<string>, options?: RawAxiosRequestConfig) {
+        return BusIOsApiFp(this.configuration).getBusIOValues(cell, ios, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * List all Bus Input/Outputs. 
+     * @summary Configuration
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusIOsApi
+     */
+    public listBusIODescriptions(cell: string, options?: RawAxiosRequestConfig) {
+        return BusIOsApiFp(this.configuration).listBusIODescriptions(cell, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Set values of outputs. In case of virtual Bus Input/Outputs, also inputs can be set.  All available output identifiers can be requested via [listBusIODescriptions](listBusIODescriptions).  The call will return once the values have been set and accepted by the service. 
+     * @summary Set Output Values
+     * @param {string} cell Unique identifier addressing a cell in all API calls. 
+     * @param {Array<IOValue>} iOValue 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BusIOsApi
+     */
+    public setBusIOValues(cell: string, iOValue: Array<IOValue>, options?: RawAxiosRequestConfig) {
+        return BusIOsApiFp(this.configuration).setBusIOValues(cell, iOValue, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+
+
+
 /**
  * CellApi - axios parameter creator
  * @export