@wandelbots/nova-api 25.5.0-dev.24 → 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/v2/api.ts CHANGED
@@ -1106,19 +1106,13 @@ export interface CreateTriggerRequest {
1106
1106
  'type': TriggerType;
1107
1107
  /**
1108
1108
  *
1109
- * @type {CreateTriggerRequestConfig}
1109
+ * @type {OpcuaNodeValueTriggerConfig}
1110
1110
  * @memberof CreateTriggerRequest
1111
1111
  */
1112
- 'config'?: CreateTriggerRequestConfig;
1112
+ 'config'?: OpcuaNodeValueTriggerConfig;
1113
1113
  }
1114
1114
 
1115
1115
 
1116
- /**
1117
- * @type CreateTriggerRequestConfig
1118
- * @export
1119
- */
1120
- export type CreateTriggerRequestConfig = OpcuaNodeValueTriggerConfig;
1121
-
1122
1116
  /**
1123
1117
  *
1124
1118
  * @export
@@ -3672,12 +3666,12 @@ export interface OpcuaNodeValueTriggerConfig {
3672
3666
  'node_value': OpcuaNodeValueTriggerConfigNodeValue;
3673
3667
  }
3674
3668
  /**
3669
+ * @type OpcuaNodeValueTriggerConfigNodeValue
3675
3670
  * Value to trigger the program when matched.
3676
3671
  * @export
3677
- * @interface OpcuaNodeValueTriggerConfigNodeValue
3678
3672
  */
3679
- export interface OpcuaNodeValueTriggerConfigNodeValue {
3680
- }
3673
+ export type OpcuaNodeValueTriggerConfigNodeValue = boolean | number | string;
3674
+
3681
3675
  /**
3682
3676
  * The operating state.
3683
3677
  * @export
@@ -4407,7 +4401,7 @@ export interface ProgramRequest {
4407
4401
  */
4408
4402
  export interface ProgramRun {
4409
4403
  /**
4410
- * Unique id of the program run
4404
+ * Unique identifier of the program run
4411
4405
  * @type {string}
4412
4406
  * @memberof ProgramRun
4413
4407
  */
@@ -4534,13 +4528,13 @@ export interface ProgramRunReference {
4534
4528
 
4535
4529
 
4536
4530
  /**
4537
- * 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
4531
+ * 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
4538
4532
  * @export
4539
4533
  * @interface ProgramRunResult
4540
4534
  */
4541
4535
  export interface ProgramRunResult {
4542
4536
  /**
4543
- * Unique id of the motion group that was executed
4537
+ * Unique identifier of the motion group that was executed
4544
4538
  * @type {string}
4545
4539
  * @memberof ProgramRunResult
4546
4540
  */
@@ -5701,10 +5695,10 @@ export interface TriggerObject {
5701
5695
  'type': TriggerType;
5702
5696
  /**
5703
5697
  *
5704
- * @type {CreateTriggerRequestConfig}
5698
+ * @type {OpcuaNodeValueTriggerConfig}
5705
5699
  * @memberof TriggerObject
5706
5700
  */
5707
- 'config': CreateTriggerRequestConfig;
5701
+ 'config': OpcuaNodeValueTriggerConfig;
5708
5702
  /**
5709
5703
  * ISO 8601 date-time format when the trigger was created.
5710
5704
  * @type {string}
@@ -5822,10 +5816,10 @@ export interface UpdateTriggerRequest {
5822
5816
  'enabled'?: boolean;
5823
5817
  /**
5824
5818
  *
5825
- * @type {CreateTriggerRequestConfig}
5819
+ * @type {OpcuaNodeValueTriggerConfig}
5826
5820
  * @memberof UpdateTriggerRequest
5827
5821
  */
5828
- 'config'?: CreateTriggerRequestConfig;
5822
+ 'config'?: OpcuaNodeValueTriggerConfig;
5829
5823
  }
5830
5824
  /**
5831
5825
  *
@@ -12523,7 +12517,7 @@ export class ProgramApi extends BaseAPI {
12523
12517
  export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Configuration) {
12524
12518
  return {
12525
12519
  /**
12526
- * <!-- 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.
12520
+ * <!-- 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.
12527
12521
  * @summary Run Program from Library
12528
12522
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12529
12523
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -12712,7 +12706,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
12712
12706
  };
12713
12707
  },
12714
12708
  /**
12715
- * <!-- 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.
12709
+ * <!-- 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.
12716
12710
  * @summary Get All Triggers
12717
12711
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12718
12712
  * @param {*} [options] Override http request option.
@@ -12848,7 +12842,7 @@ export const ProgramOperatorApiAxiosParamCreator = function (configuration?: Con
12848
12842
  /**
12849
12843
  * <!-- 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.
12850
12844
  * @summary Update Trigger
12851
- * @param {string} trigger the id of the trigger
12845
+ * @param {string} trigger The identifier of the trigger.
12852
12846
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12853
12847
  * @param {UpdateTriggerRequest} updateTriggerRequest
12854
12848
  * @param {*} [options] Override http request option.
@@ -12908,7 +12902,7 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
12908
12902
  const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration)
12909
12903
  return {
12910
12904
  /**
12911
- * <!-- 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.
12905
+ * <!-- 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.
12912
12906
  * @summary Run Program from Library
12913
12907
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12914
12908
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -12964,7 +12958,7 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
12964
12958
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
12965
12959
  },
12966
12960
  /**
12967
- * <!-- 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.
12961
+ * <!-- 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.
12968
12962
  * @summary Get All Triggers
12969
12963
  * @param {string} cell Unique identifier addressing a cell in all API calls.
12970
12964
  * @param {*} [options] Override http request option.
@@ -13007,7 +13001,7 @@ export const ProgramOperatorApiFp = function(configuration?: Configuration) {
13007
13001
  /**
13008
13002
  * <!-- 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.
13009
13003
  * @summary Update Trigger
13010
- * @param {string} trigger the id of the trigger
13004
+ * @param {string} trigger The identifier of the trigger.
13011
13005
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13012
13006
  * @param {UpdateTriggerRequest} updateTriggerRequest
13013
13007
  * @param {*} [options] Override http request option.
@@ -13030,7 +13024,7 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13030
13024
  const localVarFp = ProgramOperatorApiFp(configuration)
13031
13025
  return {
13032
13026
  /**
13033
- * <!-- 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.
13027
+ * <!-- 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.
13034
13028
  * @summary Run Program from Library
13035
13029
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13036
13030
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -13074,7 +13068,7 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13074
13068
  return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
13075
13069
  },
13076
13070
  /**
13077
- * <!-- 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.
13071
+ * <!-- 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.
13078
13072
  * @summary Get All Triggers
13079
13073
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13080
13074
  * @param {*} [options] Override http request option.
@@ -13108,7 +13102,7 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13108
13102
  /**
13109
13103
  * <!-- 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.
13110
13104
  * @summary Update Trigger
13111
- * @param {string} trigger the id of the trigger
13105
+ * @param {string} trigger The identifier of the trigger.
13112
13106
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13113
13107
  * @param {UpdateTriggerRequest} updateTriggerRequest
13114
13108
  * @param {*} [options] Override http request option.
@@ -13128,7 +13122,7 @@ export const ProgramOperatorApiFactory = function (configuration?: Configuration
13128
13122
  */
13129
13123
  export class ProgramOperatorApi extends BaseAPI {
13130
13124
  /**
13131
- * <!-- 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.
13125
+ * <!-- 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.
13132
13126
  * @summary Run Program from Library
13133
13127
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13134
13128
  * @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
@@ -13180,7 +13174,7 @@ export class ProgramOperatorApi extends BaseAPI {
13180
13174
  }
13181
13175
 
13182
13176
  /**
13183
- * <!-- 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.
13177
+ * <!-- 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.
13184
13178
  * @summary Get All Triggers
13185
13179
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13186
13180
  * @param {*} [options] Override http request option.
@@ -13220,7 +13214,7 @@ export class ProgramOperatorApi extends BaseAPI {
13220
13214
  /**
13221
13215
  * <!-- 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.
13222
13216
  * @summary Update Trigger
13223
- * @param {string} trigger the id of the trigger
13217
+ * @param {string} trigger The identifier of the trigger.
13224
13218
  * @param {string} cell Unique identifier addressing a cell in all API calls.
13225
13219
  * @param {UpdateTriggerRequest} updateTriggerRequest
13226
13220
  * @param {*} [options] Override http request option.