@wandelbots/nova-api 25.6.0-dev.27 → 25.6.0-dev.29
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 +1 -1
- package/v2/api.d.ts +93 -674
- package/v2/api.js +19 -672
- package/v2/api.js.map +1 -1
- package/v2/api.ts +90 -1076
package/v2/api.js
CHANGED
|
@@ -398,14 +398,6 @@ export const TrajectoryDataMessageTypeEnum = {
|
|
|
398
398
|
export const TrajectoryIdMessageTypeEnum = {
|
|
399
399
|
TrajectoryId: 'TrajectoryId'
|
|
400
400
|
};
|
|
401
|
-
/**
|
|
402
|
-
* The type of the trigger.
|
|
403
|
-
* @export
|
|
404
|
-
* @enum {string}
|
|
405
|
-
*/
|
|
406
|
-
export const TriggerType = {
|
|
407
|
-
OpcuaNodeValue: 'opcua_node_value'
|
|
408
|
-
};
|
|
409
401
|
/**
|
|
410
402
|
* The unit of input/output value.
|
|
411
403
|
* @export
|
|
@@ -4061,19 +4053,19 @@ export const MotionGroupApiAxiosParamCreator = function (configuration) {
|
|
|
4061
4053
|
};
|
|
4062
4054
|
},
|
|
4063
4055
|
/**
|
|
4064
|
-
* Get the
|
|
4065
|
-
* @summary
|
|
4056
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
4057
|
+
* @summary Description
|
|
4066
4058
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4067
4059
|
* @param {string} motionGroup The motion-group identifier.
|
|
4068
4060
|
* @param {*} [options] Override http request option.
|
|
4069
4061
|
* @throws {RequiredError}
|
|
4070
4062
|
*/
|
|
4071
|
-
|
|
4063
|
+
getMotionGroupDescription: async (cell, motionGroup, options = {}) => {
|
|
4072
4064
|
// verify required parameter 'cell' is not null or undefined
|
|
4073
|
-
assertParamExists('
|
|
4065
|
+
assertParamExists('getMotionGroupDescription', 'cell', cell);
|
|
4074
4066
|
// verify required parameter 'motionGroup' is not null or undefined
|
|
4075
|
-
assertParamExists('
|
|
4076
|
-
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/
|
|
4067
|
+
assertParamExists('getMotionGroupDescription', 'motionGroup', motionGroup);
|
|
4068
|
+
const localVarPath = `/cells/{cell}/motion-groups/{motion-group}/description`
|
|
4077
4069
|
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)))
|
|
4078
4070
|
.replace(`{${"motion-group"}}`, encodeURIComponent(String(motionGroup)));
|
|
4079
4071
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -4171,17 +4163,17 @@ export const MotionGroupApiFp = function (configuration) {
|
|
|
4171
4163
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4172
4164
|
},
|
|
4173
4165
|
/**
|
|
4174
|
-
* Get the
|
|
4175
|
-
* @summary
|
|
4166
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
4167
|
+
* @summary Description
|
|
4176
4168
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4177
4169
|
* @param {string} motionGroup The motion-group identifier.
|
|
4178
4170
|
* @param {*} [options] Override http request option.
|
|
4179
4171
|
* @throws {RequiredError}
|
|
4180
4172
|
*/
|
|
4181
|
-
async
|
|
4182
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
4173
|
+
async getMotionGroupDescription(cell, motionGroup, options) {
|
|
4174
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getMotionGroupDescription(cell, motionGroup, options);
|
|
4183
4175
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4184
|
-
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.
|
|
4176
|
+
const localVarOperationServerBasePath = operationServerMap['MotionGroupApi.getMotionGroupDescription']?.[localVarOperationServerIndex]?.url;
|
|
4185
4177
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4186
4178
|
},
|
|
4187
4179
|
/**
|
|
@@ -4222,15 +4214,15 @@ export const MotionGroupApiFactory = function (configuration, basePath, axios) {
|
|
|
4222
4214
|
return localVarFp.getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(axios, basePath));
|
|
4223
4215
|
},
|
|
4224
4216
|
/**
|
|
4225
|
-
* Get the
|
|
4226
|
-
* @summary
|
|
4217
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
4218
|
+
* @summary Description
|
|
4227
4219
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4228
4220
|
* @param {string} motionGroup The motion-group identifier.
|
|
4229
4221
|
* @param {*} [options] Override http request option.
|
|
4230
4222
|
* @throws {RequiredError}
|
|
4231
4223
|
*/
|
|
4232
|
-
|
|
4233
|
-
return localVarFp.
|
|
4224
|
+
getMotionGroupDescription(cell, motionGroup, options) {
|
|
4225
|
+
return localVarFp.getMotionGroupDescription(cell, motionGroup, options).then((request) => request(axios, basePath));
|
|
4234
4226
|
},
|
|
4235
4227
|
/**
|
|
4236
4228
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
@@ -4268,16 +4260,16 @@ export class MotionGroupApi extends BaseAPI {
|
|
|
4268
4260
|
return MotionGroupApiFp(this.configuration).getCurrentMotionGroupState(cell, motionGroup, responseCoordinateSystem, options).then((request) => request(this.axios, this.basePath));
|
|
4269
4261
|
}
|
|
4270
4262
|
/**
|
|
4271
|
-
* Get the
|
|
4272
|
-
* @summary
|
|
4263
|
+
* Get the set of parameters that describe the motion group and its configuration including safety zones, limits, etc. This data might change upon connection to the robot.
|
|
4264
|
+
* @summary Description
|
|
4273
4265
|
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4274
4266
|
* @param {string} motionGroup The motion-group identifier.
|
|
4275
4267
|
* @param {*} [options] Override http request option.
|
|
4276
4268
|
* @throws {RequiredError}
|
|
4277
4269
|
* @memberof MotionGroupApi
|
|
4278
4270
|
*/
|
|
4279
|
-
|
|
4280
|
-
return MotionGroupApiFp(this.configuration).
|
|
4271
|
+
getMotionGroupDescription(cell, motionGroup, options) {
|
|
4272
|
+
return MotionGroupApiFp(this.configuration).getMotionGroupDescription(cell, motionGroup, options).then((request) => request(this.axios, this.basePath));
|
|
4281
4273
|
}
|
|
4282
4274
|
/**
|
|
4283
4275
|
* <!-- theme: danger --> > Websocket endpoint Receive updates of the motion group state. The stream will be closed from the server if the controller is disconnected.
|
|
@@ -4926,651 +4918,6 @@ export class ProgramApi extends BaseAPI {
|
|
|
4926
4918
|
return ProgramApiFp(this.configuration).validateProgram(cell, programRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4927
4919
|
}
|
|
4928
4920
|
}
|
|
4929
|
-
/**
|
|
4930
|
-
* ProgramOperatorApi - axios parameter creator
|
|
4931
|
-
* @export
|
|
4932
|
-
*/
|
|
4933
|
-
export const ProgramOperatorApiAxiosParamCreator = function (configuration) {
|
|
4934
|
-
return {
|
|
4935
|
-
/**
|
|
4936
|
-
* <!-- 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.
|
|
4937
|
-
* @summary Run Program from Library
|
|
4938
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4939
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
4940
|
-
* @param {*} [options] Override http request option.
|
|
4941
|
-
* @throws {RequiredError}
|
|
4942
|
-
*/
|
|
4943
|
-
createProgramOperatorRun: async (cell, createProgramOperatorRunRequest, options = {}) => {
|
|
4944
|
-
// verify required parameter 'cell' is not null or undefined
|
|
4945
|
-
assertParamExists('createProgramOperatorRun', 'cell', cell);
|
|
4946
|
-
// verify required parameter 'createProgramOperatorRunRequest' is not null or undefined
|
|
4947
|
-
assertParamExists('createProgramOperatorRun', 'createProgramOperatorRunRequest', createProgramOperatorRunRequest);
|
|
4948
|
-
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
4949
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
4950
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4951
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4952
|
-
let baseOptions;
|
|
4953
|
-
if (configuration) {
|
|
4954
|
-
baseOptions = configuration.baseOptions;
|
|
4955
|
-
}
|
|
4956
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
4957
|
-
const localVarHeaderParameter = {};
|
|
4958
|
-
const localVarQueryParameter = {};
|
|
4959
|
-
// authentication BasicAuth required
|
|
4960
|
-
// http basic authentication required
|
|
4961
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
4962
|
-
// authentication BearerAuth required
|
|
4963
|
-
// http bearer authentication required
|
|
4964
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
4965
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4966
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4967
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4968
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
4969
|
-
localVarRequestOptions.data = serializeDataIfNeeded(createProgramOperatorRunRequest, localVarRequestOptions, configuration);
|
|
4970
|
-
return {
|
|
4971
|
-
url: toPathString(localVarUrlObj),
|
|
4972
|
-
options: localVarRequestOptions,
|
|
4973
|
-
};
|
|
4974
|
-
},
|
|
4975
|
-
/**
|
|
4976
|
-
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
4977
|
-
* @summary Create Trigger
|
|
4978
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
4979
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
4980
|
-
* @param {*} [options] Override http request option.
|
|
4981
|
-
* @throws {RequiredError}
|
|
4982
|
-
*/
|
|
4983
|
-
createTrigger: async (cell, createTriggerRequest, options = {}) => {
|
|
4984
|
-
// verify required parameter 'cell' is not null or undefined
|
|
4985
|
-
assertParamExists('createTrigger', 'cell', cell);
|
|
4986
|
-
// verify required parameter 'createTriggerRequest' is not null or undefined
|
|
4987
|
-
assertParamExists('createTrigger', 'createTriggerRequest', createTriggerRequest);
|
|
4988
|
-
const localVarPath = `/cells/{cell}/operator/triggers`
|
|
4989
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
4990
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4991
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4992
|
-
let baseOptions;
|
|
4993
|
-
if (configuration) {
|
|
4994
|
-
baseOptions = configuration.baseOptions;
|
|
4995
|
-
}
|
|
4996
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
4997
|
-
const localVarHeaderParameter = {};
|
|
4998
|
-
const localVarQueryParameter = {};
|
|
4999
|
-
// authentication BasicAuth required
|
|
5000
|
-
// http basic authentication required
|
|
5001
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5002
|
-
// authentication BearerAuth required
|
|
5003
|
-
// http bearer authentication required
|
|
5004
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5005
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5006
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5007
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5008
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5009
|
-
localVarRequestOptions.data = serializeDataIfNeeded(createTriggerRequest, localVarRequestOptions, configuration);
|
|
5010
|
-
return {
|
|
5011
|
-
url: toPathString(localVarUrlObj),
|
|
5012
|
-
options: localVarRequestOptions,
|
|
5013
|
-
};
|
|
5014
|
-
},
|
|
5015
|
-
/**
|
|
5016
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
5017
|
-
* @summary Delete Trigger
|
|
5018
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5019
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5020
|
-
* @param {*} [options] Override http request option.
|
|
5021
|
-
* @throws {RequiredError}
|
|
5022
|
-
*/
|
|
5023
|
-
deleteTrigger: async (trigger, cell, options = {}) => {
|
|
5024
|
-
// verify required parameter 'trigger' is not null or undefined
|
|
5025
|
-
assertParamExists('deleteTrigger', 'trigger', trigger);
|
|
5026
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5027
|
-
assertParamExists('deleteTrigger', 'cell', cell);
|
|
5028
|
-
const localVarPath = `/cells/{cell}/operator/triggers/{trigger}`
|
|
5029
|
-
.replace(`{${"trigger"}}`, encodeURIComponent(String(trigger)))
|
|
5030
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5031
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5032
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5033
|
-
let baseOptions;
|
|
5034
|
-
if (configuration) {
|
|
5035
|
-
baseOptions = configuration.baseOptions;
|
|
5036
|
-
}
|
|
5037
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
5038
|
-
const localVarHeaderParameter = {};
|
|
5039
|
-
const localVarQueryParameter = {};
|
|
5040
|
-
// authentication BasicAuth required
|
|
5041
|
-
// http basic authentication required
|
|
5042
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5043
|
-
// authentication BearerAuth required
|
|
5044
|
-
// http bearer authentication required
|
|
5045
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5046
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5047
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5048
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5049
|
-
return {
|
|
5050
|
-
url: toPathString(localVarUrlObj),
|
|
5051
|
-
options: localVarRequestOptions,
|
|
5052
|
-
};
|
|
5053
|
-
},
|
|
5054
|
-
/**
|
|
5055
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
5056
|
-
* @summary Get All Program Runs
|
|
5057
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5058
|
-
* @param {string} [state]
|
|
5059
|
-
* @param {*} [options] Override http request option.
|
|
5060
|
-
* @throws {RequiredError}
|
|
5061
|
-
*/
|
|
5062
|
-
getAllProgramOperatorRuns: async (cell, state, options = {}) => {
|
|
5063
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5064
|
-
assertParamExists('getAllProgramOperatorRuns', 'cell', cell);
|
|
5065
|
-
const localVarPath = `/cells/{cell}/operator/programs/runs`
|
|
5066
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5067
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5068
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5069
|
-
let baseOptions;
|
|
5070
|
-
if (configuration) {
|
|
5071
|
-
baseOptions = configuration.baseOptions;
|
|
5072
|
-
}
|
|
5073
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5074
|
-
const localVarHeaderParameter = {};
|
|
5075
|
-
const localVarQueryParameter = {};
|
|
5076
|
-
// authentication BasicAuth required
|
|
5077
|
-
// http basic authentication required
|
|
5078
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5079
|
-
// authentication BearerAuth required
|
|
5080
|
-
// http bearer authentication required
|
|
5081
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5082
|
-
if (state !== undefined) {
|
|
5083
|
-
localVarQueryParameter['state'] = state;
|
|
5084
|
-
}
|
|
5085
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5086
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5087
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5088
|
-
return {
|
|
5089
|
-
url: toPathString(localVarUrlObj),
|
|
5090
|
-
options: localVarRequestOptions,
|
|
5091
|
-
};
|
|
5092
|
-
},
|
|
5093
|
-
/**
|
|
5094
|
-
* <!-- 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.
|
|
5095
|
-
* @summary Get All Triggers
|
|
5096
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5097
|
-
* @param {*} [options] Override http request option.
|
|
5098
|
-
* @throws {RequiredError}
|
|
5099
|
-
*/
|
|
5100
|
-
getAllTriggers: async (cell, options = {}) => {
|
|
5101
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5102
|
-
assertParamExists('getAllTriggers', 'cell', cell);
|
|
5103
|
-
const localVarPath = `/cells/{cell}/operator/triggers`
|
|
5104
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5105
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5106
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5107
|
-
let baseOptions;
|
|
5108
|
-
if (configuration) {
|
|
5109
|
-
baseOptions = configuration.baseOptions;
|
|
5110
|
-
}
|
|
5111
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5112
|
-
const localVarHeaderParameter = {};
|
|
5113
|
-
const localVarQueryParameter = {};
|
|
5114
|
-
// authentication BasicAuth required
|
|
5115
|
-
// http basic authentication required
|
|
5116
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5117
|
-
// authentication BearerAuth required
|
|
5118
|
-
// http bearer authentication required
|
|
5119
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5120
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5121
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5122
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5123
|
-
return {
|
|
5124
|
-
url: toPathString(localVarUrlObj),
|
|
5125
|
-
options: localVarRequestOptions,
|
|
5126
|
-
};
|
|
5127
|
-
},
|
|
5128
|
-
/**
|
|
5129
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
5130
|
-
* @summary Get Program Run
|
|
5131
|
-
* @param {string} run
|
|
5132
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5133
|
-
* @param {*} [options] Override http request option.
|
|
5134
|
-
* @throws {RequiredError}
|
|
5135
|
-
*/
|
|
5136
|
-
getProgramOperatorRun: async (run, cell, options = {}) => {
|
|
5137
|
-
// verify required parameter 'run' is not null or undefined
|
|
5138
|
-
assertParamExists('getProgramOperatorRun', 'run', run);
|
|
5139
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5140
|
-
assertParamExists('getProgramOperatorRun', 'cell', cell);
|
|
5141
|
-
const localVarPath = `/cells/{cell}/operator/programs/runs/{run}`
|
|
5142
|
-
.replace(`{${"run"}}`, encodeURIComponent(String(run)))
|
|
5143
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5144
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5145
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5146
|
-
let baseOptions;
|
|
5147
|
-
if (configuration) {
|
|
5148
|
-
baseOptions = configuration.baseOptions;
|
|
5149
|
-
}
|
|
5150
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5151
|
-
const localVarHeaderParameter = {};
|
|
5152
|
-
const localVarQueryParameter = {};
|
|
5153
|
-
// authentication BasicAuth required
|
|
5154
|
-
// http basic authentication required
|
|
5155
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5156
|
-
// authentication BearerAuth required
|
|
5157
|
-
// http bearer authentication required
|
|
5158
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5159
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5160
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5161
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5162
|
-
return {
|
|
5163
|
-
url: toPathString(localVarUrlObj),
|
|
5164
|
-
options: localVarRequestOptions,
|
|
5165
|
-
};
|
|
5166
|
-
},
|
|
5167
|
-
/**
|
|
5168
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
5169
|
-
* @summary Get Trigger
|
|
5170
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5171
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5172
|
-
* @param {*} [options] Override http request option.
|
|
5173
|
-
* @throws {RequiredError}
|
|
5174
|
-
*/
|
|
5175
|
-
getTrigger: async (trigger, cell, options = {}) => {
|
|
5176
|
-
// verify required parameter 'trigger' is not null or undefined
|
|
5177
|
-
assertParamExists('getTrigger', 'trigger', trigger);
|
|
5178
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5179
|
-
assertParamExists('getTrigger', 'cell', cell);
|
|
5180
|
-
const localVarPath = `/cells/{cell}/operator/triggers/{trigger}`
|
|
5181
|
-
.replace(`{${"trigger"}}`, encodeURIComponent(String(trigger)))
|
|
5182
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5183
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5184
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5185
|
-
let baseOptions;
|
|
5186
|
-
if (configuration) {
|
|
5187
|
-
baseOptions = configuration.baseOptions;
|
|
5188
|
-
}
|
|
5189
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
5190
|
-
const localVarHeaderParameter = {};
|
|
5191
|
-
const localVarQueryParameter = {};
|
|
5192
|
-
// authentication BasicAuth required
|
|
5193
|
-
// http basic authentication required
|
|
5194
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5195
|
-
// authentication BearerAuth required
|
|
5196
|
-
// http bearer authentication required
|
|
5197
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5198
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5199
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5200
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5201
|
-
return {
|
|
5202
|
-
url: toPathString(localVarUrlObj),
|
|
5203
|
-
options: localVarRequestOptions,
|
|
5204
|
-
};
|
|
5205
|
-
},
|
|
5206
|
-
/**
|
|
5207
|
-
* <!-- 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.
|
|
5208
|
-
* @summary Update Trigger
|
|
5209
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5210
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5211
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
5212
|
-
* @param {*} [options] Override http request option.
|
|
5213
|
-
* @throws {RequiredError}
|
|
5214
|
-
*/
|
|
5215
|
-
updateTrigger: async (trigger, cell, updateTriggerRequest, options = {}) => {
|
|
5216
|
-
// verify required parameter 'trigger' is not null or undefined
|
|
5217
|
-
assertParamExists('updateTrigger', 'trigger', trigger);
|
|
5218
|
-
// verify required parameter 'cell' is not null or undefined
|
|
5219
|
-
assertParamExists('updateTrigger', 'cell', cell);
|
|
5220
|
-
// verify required parameter 'updateTriggerRequest' is not null or undefined
|
|
5221
|
-
assertParamExists('updateTrigger', 'updateTriggerRequest', updateTriggerRequest);
|
|
5222
|
-
const localVarPath = `/cells/{cell}/operator/triggers/{trigger}`
|
|
5223
|
-
.replace(`{${"trigger"}}`, encodeURIComponent(String(trigger)))
|
|
5224
|
-
.replace(`{${"cell"}}`, encodeURIComponent(String(cell)));
|
|
5225
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5226
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5227
|
-
let baseOptions;
|
|
5228
|
-
if (configuration) {
|
|
5229
|
-
baseOptions = configuration.baseOptions;
|
|
5230
|
-
}
|
|
5231
|
-
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
5232
|
-
const localVarHeaderParameter = {};
|
|
5233
|
-
const localVarQueryParameter = {};
|
|
5234
|
-
// authentication BasicAuth required
|
|
5235
|
-
// http basic authentication required
|
|
5236
|
-
setBasicAuthToObject(localVarRequestOptions, configuration);
|
|
5237
|
-
// authentication BearerAuth required
|
|
5238
|
-
// http bearer authentication required
|
|
5239
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
5240
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
5241
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5242
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5243
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
5244
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateTriggerRequest, localVarRequestOptions, configuration);
|
|
5245
|
-
return {
|
|
5246
|
-
url: toPathString(localVarUrlObj),
|
|
5247
|
-
options: localVarRequestOptions,
|
|
5248
|
-
};
|
|
5249
|
-
},
|
|
5250
|
-
};
|
|
5251
|
-
};
|
|
5252
|
-
/**
|
|
5253
|
-
* ProgramOperatorApi - functional programming interface
|
|
5254
|
-
* @export
|
|
5255
|
-
*/
|
|
5256
|
-
export const ProgramOperatorApiFp = function (configuration) {
|
|
5257
|
-
const localVarAxiosParamCreator = ProgramOperatorApiAxiosParamCreator(configuration);
|
|
5258
|
-
return {
|
|
5259
|
-
/**
|
|
5260
|
-
* <!-- 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.
|
|
5261
|
-
* @summary Run Program from Library
|
|
5262
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5263
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
5264
|
-
* @param {*} [options] Override http request option.
|
|
5265
|
-
* @throws {RequiredError}
|
|
5266
|
-
*/
|
|
5267
|
-
async createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
|
|
5268
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options);
|
|
5269
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5270
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
5271
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5272
|
-
},
|
|
5273
|
-
/**
|
|
5274
|
-
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
5275
|
-
* @summary Create Trigger
|
|
5276
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5277
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
5278
|
-
* @param {*} [options] Override http request option.
|
|
5279
|
-
* @throws {RequiredError}
|
|
5280
|
-
*/
|
|
5281
|
-
async createTrigger(cell, createTriggerRequest, options) {
|
|
5282
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createTrigger(cell, createTriggerRequest, options);
|
|
5283
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5284
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.createTrigger']?.[localVarOperationServerIndex]?.url;
|
|
5285
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5286
|
-
},
|
|
5287
|
-
/**
|
|
5288
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
5289
|
-
* @summary Delete Trigger
|
|
5290
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5291
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5292
|
-
* @param {*} [options] Override http request option.
|
|
5293
|
-
* @throws {RequiredError}
|
|
5294
|
-
*/
|
|
5295
|
-
async deleteTrigger(trigger, cell, options) {
|
|
5296
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteTrigger(trigger, cell, options);
|
|
5297
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5298
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.deleteTrigger']?.[localVarOperationServerIndex]?.url;
|
|
5299
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5300
|
-
},
|
|
5301
|
-
/**
|
|
5302
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
5303
|
-
* @summary Get All Program Runs
|
|
5304
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5305
|
-
* @param {string} [state]
|
|
5306
|
-
* @param {*} [options] Override http request option.
|
|
5307
|
-
* @throws {RequiredError}
|
|
5308
|
-
*/
|
|
5309
|
-
async getAllProgramOperatorRuns(cell, state, options) {
|
|
5310
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllProgramOperatorRuns(cell, state, options);
|
|
5311
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5312
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllProgramOperatorRuns']?.[localVarOperationServerIndex]?.url;
|
|
5313
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5314
|
-
},
|
|
5315
|
-
/**
|
|
5316
|
-
* <!-- 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.
|
|
5317
|
-
* @summary Get All Triggers
|
|
5318
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5319
|
-
* @param {*} [options] Override http request option.
|
|
5320
|
-
* @throws {RequiredError}
|
|
5321
|
-
*/
|
|
5322
|
-
async getAllTriggers(cell, options) {
|
|
5323
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getAllTriggers(cell, options);
|
|
5324
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5325
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getAllTriggers']?.[localVarOperationServerIndex]?.url;
|
|
5326
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5327
|
-
},
|
|
5328
|
-
/**
|
|
5329
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
5330
|
-
* @summary Get Program Run
|
|
5331
|
-
* @param {string} run
|
|
5332
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5333
|
-
* @param {*} [options] Override http request option.
|
|
5334
|
-
* @throws {RequiredError}
|
|
5335
|
-
*/
|
|
5336
|
-
async getProgramOperatorRun(run, cell, options) {
|
|
5337
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProgramOperatorRun(run, cell, options);
|
|
5338
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5339
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getProgramOperatorRun']?.[localVarOperationServerIndex]?.url;
|
|
5340
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5341
|
-
},
|
|
5342
|
-
/**
|
|
5343
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
5344
|
-
* @summary Get Trigger
|
|
5345
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5346
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5347
|
-
* @param {*} [options] Override http request option.
|
|
5348
|
-
* @throws {RequiredError}
|
|
5349
|
-
*/
|
|
5350
|
-
async getTrigger(trigger, cell, options) {
|
|
5351
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getTrigger(trigger, cell, options);
|
|
5352
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5353
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.getTrigger']?.[localVarOperationServerIndex]?.url;
|
|
5354
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5355
|
-
},
|
|
5356
|
-
/**
|
|
5357
|
-
* <!-- 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.
|
|
5358
|
-
* @summary Update Trigger
|
|
5359
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5360
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5361
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
5362
|
-
* @param {*} [options] Override http request option.
|
|
5363
|
-
* @throws {RequiredError}
|
|
5364
|
-
*/
|
|
5365
|
-
async updateTrigger(trigger, cell, updateTriggerRequest, options) {
|
|
5366
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateTrigger(trigger, cell, updateTriggerRequest, options);
|
|
5367
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
5368
|
-
const localVarOperationServerBasePath = operationServerMap['ProgramOperatorApi.updateTrigger']?.[localVarOperationServerIndex]?.url;
|
|
5369
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5370
|
-
},
|
|
5371
|
-
};
|
|
5372
|
-
};
|
|
5373
|
-
/**
|
|
5374
|
-
* ProgramOperatorApi - factory interface
|
|
5375
|
-
* @export
|
|
5376
|
-
*/
|
|
5377
|
-
export const ProgramOperatorApiFactory = function (configuration, basePath, axios) {
|
|
5378
|
-
const localVarFp = ProgramOperatorApiFp(configuration);
|
|
5379
|
-
return {
|
|
5380
|
-
/**
|
|
5381
|
-
* <!-- 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.
|
|
5382
|
-
* @summary Run Program from Library
|
|
5383
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5384
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
5385
|
-
* @param {*} [options] Override http request option.
|
|
5386
|
-
* @throws {RequiredError}
|
|
5387
|
-
*/
|
|
5388
|
-
createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
|
|
5389
|
-
return localVarFp.createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(axios, basePath));
|
|
5390
|
-
},
|
|
5391
|
-
/**
|
|
5392
|
-
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
5393
|
-
* @summary Create Trigger
|
|
5394
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5395
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
5396
|
-
* @param {*} [options] Override http request option.
|
|
5397
|
-
* @throws {RequiredError}
|
|
5398
|
-
*/
|
|
5399
|
-
createTrigger(cell, createTriggerRequest, options) {
|
|
5400
|
-
return localVarFp.createTrigger(cell, createTriggerRequest, options).then((request) => request(axios, basePath));
|
|
5401
|
-
},
|
|
5402
|
-
/**
|
|
5403
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
5404
|
-
* @summary Delete Trigger
|
|
5405
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5406
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5407
|
-
* @param {*} [options] Override http request option.
|
|
5408
|
-
* @throws {RequiredError}
|
|
5409
|
-
*/
|
|
5410
|
-
deleteTrigger(trigger, cell, options) {
|
|
5411
|
-
return localVarFp.deleteTrigger(trigger, cell, options).then((request) => request(axios, basePath));
|
|
5412
|
-
},
|
|
5413
|
-
/**
|
|
5414
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
5415
|
-
* @summary Get All Program Runs
|
|
5416
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5417
|
-
* @param {string} [state]
|
|
5418
|
-
* @param {*} [options] Override http request option.
|
|
5419
|
-
* @throws {RequiredError}
|
|
5420
|
-
*/
|
|
5421
|
-
getAllProgramOperatorRuns(cell, state, options) {
|
|
5422
|
-
return localVarFp.getAllProgramOperatorRuns(cell, state, options).then((request) => request(axios, basePath));
|
|
5423
|
-
},
|
|
5424
|
-
/**
|
|
5425
|
-
* <!-- 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.
|
|
5426
|
-
* @summary Get All Triggers
|
|
5427
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5428
|
-
* @param {*} [options] Override http request option.
|
|
5429
|
-
* @throws {RequiredError}
|
|
5430
|
-
*/
|
|
5431
|
-
getAllTriggers(cell, options) {
|
|
5432
|
-
return localVarFp.getAllTriggers(cell, options).then((request) => request(axios, basePath));
|
|
5433
|
-
},
|
|
5434
|
-
/**
|
|
5435
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
5436
|
-
* @summary Get Program Run
|
|
5437
|
-
* @param {string} run
|
|
5438
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5439
|
-
* @param {*} [options] Override http request option.
|
|
5440
|
-
* @throws {RequiredError}
|
|
5441
|
-
*/
|
|
5442
|
-
getProgramOperatorRun(run, cell, options) {
|
|
5443
|
-
return localVarFp.getProgramOperatorRun(run, cell, options).then((request) => request(axios, basePath));
|
|
5444
|
-
},
|
|
5445
|
-
/**
|
|
5446
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
5447
|
-
* @summary Get Trigger
|
|
5448
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5449
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5450
|
-
* @param {*} [options] Override http request option.
|
|
5451
|
-
* @throws {RequiredError}
|
|
5452
|
-
*/
|
|
5453
|
-
getTrigger(trigger, cell, options) {
|
|
5454
|
-
return localVarFp.getTrigger(trigger, cell, options).then((request) => request(axios, basePath));
|
|
5455
|
-
},
|
|
5456
|
-
/**
|
|
5457
|
-
* <!-- 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.
|
|
5458
|
-
* @summary Update Trigger
|
|
5459
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5460
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5461
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
5462
|
-
* @param {*} [options] Override http request option.
|
|
5463
|
-
* @throws {RequiredError}
|
|
5464
|
-
*/
|
|
5465
|
-
updateTrigger(trigger, cell, updateTriggerRequest, options) {
|
|
5466
|
-
return localVarFp.updateTrigger(trigger, cell, updateTriggerRequest, options).then((request) => request(axios, basePath));
|
|
5467
|
-
},
|
|
5468
|
-
};
|
|
5469
|
-
};
|
|
5470
|
-
/**
|
|
5471
|
-
* ProgramOperatorApi - object-oriented interface
|
|
5472
|
-
* @export
|
|
5473
|
-
* @class ProgramOperatorApi
|
|
5474
|
-
* @extends {BaseAPI}
|
|
5475
|
-
*/
|
|
5476
|
-
export class ProgramOperatorApi extends BaseAPI {
|
|
5477
|
-
/**
|
|
5478
|
-
* <!-- 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.
|
|
5479
|
-
* @summary Run Program from Library
|
|
5480
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5481
|
-
* @param {CreateProgramOperatorRunRequest} createProgramOperatorRunRequest
|
|
5482
|
-
* @param {*} [options] Override http request option.
|
|
5483
|
-
* @throws {RequiredError}
|
|
5484
|
-
* @memberof ProgramOperatorApi
|
|
5485
|
-
*/
|
|
5486
|
-
createProgramOperatorRun(cell, createProgramOperatorRunRequest, options) {
|
|
5487
|
-
return ProgramOperatorApiFp(this.configuration).createProgramOperatorRun(cell, createProgramOperatorRunRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5488
|
-
}
|
|
5489
|
-
/**
|
|
5490
|
-
* <!-- theme: danger --> > **Experimental** Creates a new trigger that automatically runs a program when certain conditions are met. Each trigger has a different configuration, and the configuration must be valid for the provided trigger type.
|
|
5491
|
-
* @summary Create Trigger
|
|
5492
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5493
|
-
* @param {CreateTriggerRequest} createTriggerRequest
|
|
5494
|
-
* @param {*} [options] Override http request option.
|
|
5495
|
-
* @throws {RequiredError}
|
|
5496
|
-
* @memberof ProgramOperatorApi
|
|
5497
|
-
*/
|
|
5498
|
-
createTrigger(cell, createTriggerRequest, options) {
|
|
5499
|
-
return ProgramOperatorApiFp(this.configuration).createTrigger(cell, createTriggerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5500
|
-
}
|
|
5501
|
-
/**
|
|
5502
|
-
* <!-- theme: danger --> > **Experimental** Delete an existing trigger.
|
|
5503
|
-
* @summary Delete Trigger
|
|
5504
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5505
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5506
|
-
* @param {*} [options] Override http request option.
|
|
5507
|
-
* @throws {RequiredError}
|
|
5508
|
-
* @memberof ProgramOperatorApi
|
|
5509
|
-
*/
|
|
5510
|
-
deleteTrigger(trigger, cell, options) {
|
|
5511
|
-
return ProgramOperatorApiFp(this.configuration).deleteTrigger(trigger, cell, options).then((request) => request(this.axios, this.basePath));
|
|
5512
|
-
}
|
|
5513
|
-
/**
|
|
5514
|
-
* <!-- theme: danger --> > **Experimental** Retrieves all program runs, including past and current executions. Use the optional `state` parameter to filter the results by their status.
|
|
5515
|
-
* @summary Get All Program Runs
|
|
5516
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5517
|
-
* @param {string} [state]
|
|
5518
|
-
* @param {*} [options] Override http request option.
|
|
5519
|
-
* @throws {RequiredError}
|
|
5520
|
-
* @memberof ProgramOperatorApi
|
|
5521
|
-
*/
|
|
5522
|
-
getAllProgramOperatorRuns(cell, state, options) {
|
|
5523
|
-
return ProgramOperatorApiFp(this.configuration).getAllProgramOperatorRuns(cell, state, options).then((request) => request(this.axios, this.basePath));
|
|
5524
|
-
}
|
|
5525
|
-
/**
|
|
5526
|
-
* <!-- 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.
|
|
5527
|
-
* @summary Get All Triggers
|
|
5528
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5529
|
-
* @param {*} [options] Override http request option.
|
|
5530
|
-
* @throws {RequiredError}
|
|
5531
|
-
* @memberof ProgramOperatorApi
|
|
5532
|
-
*/
|
|
5533
|
-
getAllTriggers(cell, options) {
|
|
5534
|
-
return ProgramOperatorApiFp(this.configuration).getAllTriggers(cell, options).then((request) => request(this.axios, this.basePath));
|
|
5535
|
-
}
|
|
5536
|
-
/**
|
|
5537
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific program run.
|
|
5538
|
-
* @summary Get Program Run
|
|
5539
|
-
* @param {string} run
|
|
5540
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5541
|
-
* @param {*} [options] Override http request option.
|
|
5542
|
-
* @throws {RequiredError}
|
|
5543
|
-
* @memberof ProgramOperatorApi
|
|
5544
|
-
*/
|
|
5545
|
-
getProgramOperatorRun(run, cell, options) {
|
|
5546
|
-
return ProgramOperatorApiFp(this.configuration).getProgramOperatorRun(run, cell, options).then((request) => request(this.axios, this.basePath));
|
|
5547
|
-
}
|
|
5548
|
-
/**
|
|
5549
|
-
* <!-- theme: danger --> > **Experimental** Retrieves detailed information about a specific trigger.
|
|
5550
|
-
* @summary Get Trigger
|
|
5551
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5552
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5553
|
-
* @param {*} [options] Override http request option.
|
|
5554
|
-
* @throws {RequiredError}
|
|
5555
|
-
* @memberof ProgramOperatorApi
|
|
5556
|
-
*/
|
|
5557
|
-
getTrigger(trigger, cell, options) {
|
|
5558
|
-
return ProgramOperatorApiFp(this.configuration).getTrigger(trigger, cell, options).then((request) => request(this.axios, this.basePath));
|
|
5559
|
-
}
|
|
5560
|
-
/**
|
|
5561
|
-
* <!-- 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.
|
|
5562
|
-
* @summary Update Trigger
|
|
5563
|
-
* @param {string} trigger The identifier of the trigger.
|
|
5564
|
-
* @param {string} cell Unique identifier addressing a cell in all API calls.
|
|
5565
|
-
* @param {UpdateTriggerRequest} updateTriggerRequest
|
|
5566
|
-
* @param {*} [options] Override http request option.
|
|
5567
|
-
* @throws {RequiredError}
|
|
5568
|
-
* @memberof ProgramOperatorApi
|
|
5569
|
-
*/
|
|
5570
|
-
updateTrigger(trigger, cell, updateTriggerRequest, options) {
|
|
5571
|
-
return ProgramOperatorApiFp(this.configuration).updateTrigger(trigger, cell, updateTriggerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5572
|
-
}
|
|
5573
|
-
}
|
|
5574
4921
|
/**
|
|
5575
4922
|
* StoreCollisionComponentsApi - axios parameter creator
|
|
5576
4923
|
* @export
|