@wandelbots/nova-api 25.5.0-dev.26 → 25.5.0-dev.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wandelbots/nova-api",
3
- "version": "25.5.0-dev.26",
3
+ "version": "25.5.0-dev.27",
4
4
  "description": "API Client to interact with Wandelbots Public API.",
5
5
  "files": [
6
6
  "*",
package/v2/api.d.ts CHANGED
@@ -1091,16 +1091,11 @@ export interface CreateTriggerRequest {
1091
1091
  'type': TriggerType;
1092
1092
  /**
1093
1093
  *
1094
- * @type {CreateTriggerRequestConfig}
1094
+ * @type {OpcuaNodeValueTriggerConfig}
1095
1095
  * @memberof CreateTriggerRequest
1096
1096
  */
1097
- 'config'?: CreateTriggerRequestConfig;
1097
+ 'config'?: OpcuaNodeValueTriggerConfig;
1098
1098
  }
1099
- /**
1100
- * @type CreateTriggerRequestConfig
1101
- * @export
1102
- */
1103
- export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
1104
1099
  /**
1105
1100
  *
1106
1101
  * @export
@@ -3569,12 +3564,11 @@ export interface OpcuaNodeValueTriggerConfig {
3569
3564
  'node_value': OpcuaNodeValueTriggerConfigNodeValue;
3570
3565
  }
3571
3566
  /**
3567
+ * @type OpcuaNodeValueTriggerConfigNodeValue
3572
3568
  * Value to trigger the program when matched.
3573
3569
  * @export
3574
- * @interface OpcuaNodeValueTriggerConfigNodeValue
3575
3570
  */
3576
- export interface OpcuaNodeValueTriggerConfigNodeValue {
3577
- }
3571
+ export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
3578
3572
  /**
3579
3573
  * The operating state.
3580
3574
  * @export
@@ -4264,7 +4258,7 @@ export interface ProgramRequest {
4264
4258
  */
4265
4259
  export interface ProgramRun {
4266
4260
  /**
4267
- * Unique id of the program run
4261
+ * Unique identifier of the program run
4268
4262
  * @type {string}
4269
4263
  * @memberof ProgramRun
4270
4264
  */
@@ -4387,13 +4381,13 @@ export interface ProgramRunReference {
4387
4381
  'state': ProgramRunState;
4388
4382
  }
4389
4383
  /**
4390
- * The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique id of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
4384
+ * The ProgramRunResult object contains the execution results of a robot. Arguments: motion_group_id: The unique identifier of the motion group motion_duration: The total execution duration of the motion group paths: The paths of the motion group as list of Path objects
4391
4385
  * @export
4392
4386
  * @interface ProgramRunResult
4393
4387
  */
4394
4388
  export interface ProgramRunResult {
4395
4389
  /**
4396
- * Unique id of the motion group that was executed
4390
+ * Unique identifier of the motion group that was executed
4397
4391
  * @type {string}
4398
4392
  * @memberof ProgramRunResult
4399
4393
  */
@@ -5474,10 +5468,10 @@ export interface TriggerObject {
5474
5468
  'type': TriggerType;
5475
5469
  /**
5476
5470
  *
5477
- * @type {CreateTriggerRequestConfig}
5471
+ * @type {OpcuaNodeValueTriggerConfig}
5478
5472
  * @memberof TriggerObject
5479
5473
  */
5480
- 'config': CreateTriggerRequestConfig;
5474
+ 'config': OpcuaNodeValueTriggerConfig;
5481
5475
  /**
5482
5476
  * ISO 8601 date-time format when the trigger was created.
5483
5477
  * @type {string}
@@ -5580,10 +5574,10 @@ export interface UpdateTriggerRequest {
5580
5574
  'enabled'?: boolean;
5581
5575
  /**
5582
5576
  *
5583
- * @type {CreateTriggerRequestConfig}
5577
+ * @type {OpcuaNodeValueTriggerConfig}
5584
5578
  * @memberof UpdateTriggerRequest
5585
5579
  */
5586
- 'config'?: CreateTriggerRequestConfig;
5580
+ 'config'?: OpcuaNodeValueTriggerConfig;
5587
5581
  }
5588
5582
  /**
5589
5583
  *
@@ -8799,7 +8793,7 @@ export declare class ProgramApi extends BaseAPI {
8799
8793
  */
8800
8794
  export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Configuration) => {
8801
8795
  /**
8802
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
8796
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
8803
8797
  * @summary Run Program from Library
8804
8798
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8805
8799
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -8835,7 +8829,7 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
8835
8829
  */
8836
8830
  getAllProgramOperatorRuns: (cell: string, state?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8837
8831
  /**
8838
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
8832
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
8839
8833
  * @summary Get All Triggers
8840
8834
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8841
8835
  * @param {*} [options] Override http request option.
@@ -8863,7 +8857,7 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
8863
8857
  /**
8864
8858
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
8865
8859
  * @summary Update Trigger
8866
- * @param {string} trigger the id of the trigger
8860
+ * @param {string} trigger The identifier of the trigger.
8867
8861
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8868
8862
  * @param {UpdateTriggerRequest} updateTriggerRequest
8869
8863
  * @param {*} [options] Override http request option.
@@ -8877,7 +8871,7 @@ export declare const ProgramOperatorApiAxiosParamCreator: (configuration?: Confi
8877
8871
  */
8878
8872
  export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
8879
8873
  /**
8880
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
8874
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
8881
8875
  * @summary Run Program from Library
8882
8876
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8883
8877
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -8913,7 +8907,7 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
8913
8907
  */
8914
8908
  getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllProgramOperatorRuns200Response>>;
8915
8909
  /**
8916
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
8910
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
8917
8911
  * @summary Get All Triggers
8918
8912
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8919
8913
  * @param {*} [options] Override http request option.
@@ -8941,7 +8935,7 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
8941
8935
  /**
8942
8936
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
8943
8937
  * @summary Update Trigger
8944
- * @param {string} trigger the id of the trigger
8938
+ * @param {string} trigger The identifier of the trigger.
8945
8939
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8946
8940
  * @param {UpdateTriggerRequest} updateTriggerRequest
8947
8941
  * @param {*} [options] Override http request option.
@@ -8955,7 +8949,7 @@ export declare const ProgramOperatorApiFp: (configuration?: Configuration) => {
8955
8949
  */
8956
8950
  export declare const ProgramOperatorApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
8957
8951
  /**
8958
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
8952
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
8959
8953
  * @summary Run Program from Library
8960
8954
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8961
8955
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -8991,7 +8985,7 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
8991
8985
  */
8992
8986
  getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): AxiosPromise<GetAllProgramOperatorRuns200Response>;
8993
8987
  /**
8994
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
8988
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
8995
8989
  * @summary Get All Triggers
8996
8990
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8997
8991
  * @param {*} [options] Override http request option.
@@ -9019,7 +9013,7 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
9019
9013
  /**
9020
9014
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
9021
9015
  * @summary Update Trigger
9022
- * @param {string} trigger the id of the trigger
9016
+ * @param {string} trigger The identifier of the trigger.
9023
9017
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9024
9018
  * @param {UpdateTriggerRequest} updateTriggerRequest
9025
9019
  * @param {*} [options] Override http request option.
@@ -9035,7 +9029,7 @@ export declare const ProgramOperatorApiFactory: (configuration?: Configuration,
9035
9029
  */
9036
9030
  export declare class ProgramOperatorApi extends BaseAPI {
9037
9031
  /**
9038
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
9032
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
9039
9033
  * @summary Run Program from Library
9040
9034
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9041
9035
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -9075,7 +9069,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
9075
9069
  */
9076
9070
  getAllProgramOperatorRuns(cell: string, state?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllProgramOperatorRuns200Response, any>>;
9077
9071
  /**
9078
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
9072
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
9079
9073
  * @summary Get All Triggers
9080
9074
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9081
9075
  * @param {*} [options] Override http request option.
@@ -9106,7 +9100,7 @@ export declare class ProgramOperatorApi extends BaseAPI {
9106
9100
  /**
9107
9101
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
9108
9102
  * @summary Update Trigger
9109
- * @param {string} trigger the id of the trigger
9103
+ * @param {string} trigger The identifier of the trigger.
9110
9104
  * @param {string} cell Unique identifier addressing a cell in all API calls.
9111
9105
  * @param {UpdateTriggerRequest} updateTriggerRequest
9112
9106
  * @param {*} [options] Override http request option.
package/v2/api.js CHANGED
@@ -6429,7 +6429,7 @@ export class ProgramApi extends BaseAPI {
6429
6429
  export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6430
6430
  return {
6431
6431
  /**
6432
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
6432
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
6433
6433
  * @summary Run Program from Library
6434
6434
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6435
6435
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -6587,7 +6587,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6587
6587
  };
6588
6588
  },
6589
6589
  /**
6590
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
6590
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
6591
6591
  * @summary Get All Triggers
6592
6592
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6593
6593
  * @param {*} [options] Override http request option.
@@ -6702,7 +6702,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
6702
6702
  /**
6703
6703
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
6704
6704
  * @summary Update Trigger
6705
- * @param {string} trigger the id of the trigger
6705
+ * @param {string} trigger The identifier of the trigger.
6706
6706
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6707
6707
  * @param {UpdateTriggerRequest} updateTriggerRequest
6708
6708
  * @param {*} [options] Override http request option.
@@ -6753,7 +6753,7 @@ export const ProgramOperatorApiFp = function (configuration) {
6753
6753
  const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration);
6754
6754
  return {
6755
6755
  /**
6756
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
6756
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
6757
6757
  * @summary Run Program from Library
6758
6758
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6759
6759
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -6809,7 +6809,7 @@ export const ProgramOperatorApiFp = function (configuration) {
6809
6809
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
6810
6810
  },
6811
6811
  /**
6812
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
6812
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
6813
6813
  * @summary Get All Triggers
6814
6814
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6815
6815
  * @param {*} [options] Override http request option.
@@ -6852,7 +6852,7 @@ export const ProgramOperatorApiFp = function (configuration) {
6852
6852
  /**
6853
6853
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
6854
6854
  * @summary Update Trigger
6855
- * @param {string} trigger the id of the trigger
6855
+ * @param {string} trigger The identifier of the trigger.
6856
6856
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6857
6857
  * @param {UpdateTriggerRequest} updateTriggerRequest
6858
6858
  * @param {*} [options] Override http request option.
@@ -6874,7 +6874,7 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6874
6874
  const localVarFp = ProgramOperatorApiFp(configuration);
6875
6875
  return {
6876
6876
  /**
6877
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
6877
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
6878
6878
  * @summary Run Program from Library
6879
6879
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6880
6880
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -6918,7 +6918,7 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6918
6918
  return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
6919
6919
  },
6920
6920
  /**
6921
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
6921
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
6922
6922
  * @summary Get All Triggers
6923
6923
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6924
6924
  * @param {*} [options] Override http request option.
@@ -6952,7 +6952,7 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6952
6952
  /**
6953
6953
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
6954
6954
  * @summary Update Trigger
6955
- * @param {string} trigger the id of the trigger
6955
+ * @param {string} trigger The identifier of the trigger.
6956
6956
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6957
6957
  * @param {UpdateTriggerRequest} updateTriggerRequest
6958
6958
  * @param {*} [options] Override http request option.
@@ -6971,7 +6971,7 @@ export const ProgramOperatorApiFactory = function (configuration, basePath, axio
6971
6971
  */
6972
6972
  export class ProgramOperatorApi extends BaseAPI {
6973
6973
  /**
6974
- * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program id that exists in the program library.
6974
+ * <!-- theme: danger --> > **Experimental** This endpoint initiates the execution of a program stored in the program library. A program is started with the a specific program identifier that exists in the program library.
6975
6975
  * @summary Run Program from Library
6976
6976
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6977
6977
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -7019,7 +7019,7 @@ export class ProgramOperatorApi extends BaseAPI {
7019
7019
  return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
7020
7020
  }
7021
7021
  /**
7022
- * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run id to get more details about a specific program run.
7022
+ * <!-- theme: danger --> > **Experimental** Returns all triggers in the system with the program runs caused by each trigger. You can use the program run identifier to get more details about a specific program run.
7023
7023
  * @summary Get All Triggers
7024
7024
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7025
7025
  * @param {*} [options] Override http request option.
@@ -7056,7 +7056,7 @@ export class ProgramOperatorApi extends BaseAPI {
7056
7056
  /**
7057
7057
  * <!-- theme: danger --> > **Experimental** Updates the details of an existing trigger The exact behavior of switching a trigger from active to inactive or vice versa is not defined yet.
7058
7058
  * @summary Update Trigger
7059
- * @param {string} trigger the id of the trigger
7059
+ * @param {string} trigger The identifier of the trigger.
7060
7060
  * @param {string} cell Unique identifier addressing a cell in all API calls.
7061
7061
  * @param {UpdateTriggerRequest} updateTriggerRequest
7062
7062
  * @param {*} [options] Override http request option.