@wandelbots/nova-api 25.9.0-dev.34 → 25.9.0-dev.35

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/dist/v2/index.cjs CHANGED
@@ -3350,6 +3350,7 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
3350
3350
  return {
3351
3351
  forwardKinematics: async (cell, forwardKinematicsRequest, options = {}) => {
3352
3352
  assertParamExists("forwardKinematics", "cell", cell);
3353
+ assertParamExists("forwardKinematics", "forwardKinematicsRequest", forwardKinematicsRequest);
3353
3354
  const localVarPath = `/cells/{cell}/kinematic/forward`.replace(`{cell}`, encodeURIComponent(String(cell)));
3354
3355
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3355
3356
  let baseOptions;
@@ -3379,6 +3380,7 @@ const KinematicsApiAxiosParamCreator = function(configuration) {
3379
3380
  },
3380
3381
  inverseKinematics: async (cell, inverseKinematicsRequest, options = {}) => {
3381
3382
  assertParamExists("inverseKinematics", "cell", cell);
3383
+ assertParamExists("inverseKinematics", "inverseKinematicsRequest", inverseKinematicsRequest);
3382
3384
  const localVarPath = `/cells/{cell}/kinematic/inverse`.replace(`{cell}`, encodeURIComponent(String(cell)));
3383
3385
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3384
3386
  let baseOptions;
@@ -3455,7 +3457,7 @@ var KinematicsApi = class extends BaseAPI {
3455
3457
  * Returns the TCP poses for a list of given joint positions.
3456
3458
  * @summary Forward kinematics
3457
3459
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3458
- * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
3460
+ * @param {ForwardKinematicsRequest} forwardKinematicsRequest
3459
3461
  * @param {*} [options] Override http request option.
3460
3462
  * @throws {RequiredError}
3461
3463
  * @memberof KinematicsApi
@@ -3467,7 +3469,7 @@ var KinematicsApi = class extends BaseAPI {
3467
3469
  * Returns the reachable joint positions for a list of given poses.
3468
3470
  * @summary Inverse kinematics
3469
3471
  * @param {string} cell Unique identifier addressing a cell in all API calls.
3470
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
3472
+ * @param {InverseKinematicsRequest} inverseKinematicsRequest
3471
3473
  * @param {*} [options] Override http request option.
3472
3474
  * @throws {RequiredError}
3473
3475
  * @memberof KinematicsApi
@@ -6446,6 +6448,7 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
6446
6448
  return {
6447
6449
  planCollisionFree: async (cell, planCollisionFreeRequest, options = {}) => {
6448
6450
  assertParamExists("planCollisionFree", "cell", cell);
6451
+ assertParamExists("planCollisionFree", "planCollisionFreeRequest", planCollisionFreeRequest);
6449
6452
  const localVarPath = `/cells/{cell}/trajectory-planning/plan-collision-free`.replace(`{cell}`, encodeURIComponent(String(cell)));
6450
6453
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6451
6454
  let baseOptions;
@@ -6475,6 +6478,7 @@ const TrajectoryPlanningApiAxiosParamCreator = function(configuration) {
6475
6478
  },
6476
6479
  planTrajectory: async (cell, planTrajectoryRequest, options = {}) => {
6477
6480
  assertParamExists("planTrajectory", "cell", cell);
6481
+ assertParamExists("planTrajectory", "planTrajectoryRequest", planTrajectoryRequest);
6478
6482
  const localVarPath = `/cells/{cell}/trajectory-planning/plan-trajectory`.replace(`{cell}`, encodeURIComponent(String(cell)));
6479
6483
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6480
6484
  let baseOptions;
@@ -6551,7 +6555,7 @@ var TrajectoryPlanningApi = class extends BaseAPI {
6551
6555
  * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
6552
6556
  * @summary Plan Collision-Free Trajectory
6553
6557
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6554
- * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
6558
+ * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
6555
6559
  * @param {*} [options] Override http request option.
6556
6560
  * @throws {RequiredError}
6557
6561
  * @memberof TrajectoryPlanningApi
@@ -6563,7 +6567,7 @@ var TrajectoryPlanningApi = class extends BaseAPI {
6563
6567
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
6564
6568
  * @summary Plan Trajectory
6565
6569
  * @param {string} cell Unique identifier addressing a cell in all API calls.
6566
- * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
6570
+ * @param {PlanTrajectoryRequest} planTrajectoryRequest
6567
6571
  * @param {*} [options] Override http request option.
6568
6572
  * @throws {RequiredError}
6569
6573
  * @memberof TrajectoryPlanningApi
@@ -8021,20 +8021,20 @@ declare const KinematicsApiAxiosParamCreator: (configuration?: Configuration) =>
8021
8021
  * Returns the TCP poses for a list of given joint positions.
8022
8022
  * @summary Forward kinematics
8023
8023
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8024
- * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
8024
+ * @param {ForwardKinematicsRequest} forwardKinematicsRequest
8025
8025
  * @param {*} [options] Override http request option.
8026
8026
  * @throws {RequiredError}
8027
8027
  */
8028
- forwardKinematics: (cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8028
+ forwardKinematics: (cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8029
8029
  /**
8030
8030
  * Returns the reachable joint positions for a list of given poses.
8031
8031
  * @summary Inverse kinematics
8032
8032
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8033
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8033
+ * @param {InverseKinematicsRequest} inverseKinematicsRequest
8034
8034
  * @param {*} [options] Override http request option.
8035
8035
  * @throws {RequiredError}
8036
8036
  */
8037
- inverseKinematics: (cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8037
+ inverseKinematics: (cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
8038
8038
  };
8039
8039
  /**
8040
8040
  * KinematicsApi - functional programming interface
@@ -8045,20 +8045,20 @@ declare const KinematicsApiFp: (configuration?: Configuration) => {
8045
8045
  * Returns the TCP poses for a list of given joint positions.
8046
8046
  * @summary Forward kinematics
8047
8047
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8048
- * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
8048
+ * @param {ForwardKinematicsRequest} forwardKinematicsRequest
8049
8049
  * @param {*} [options] Override http request option.
8050
8050
  * @throws {RequiredError}
8051
8051
  */
8052
- forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
8052
+ forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ForwardKinematicsResponse>>;
8053
8053
  /**
8054
8054
  * Returns the reachable joint positions for a list of given poses.
8055
8055
  * @summary Inverse kinematics
8056
8056
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8057
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8057
+ * @param {InverseKinematicsRequest} inverseKinematicsRequest
8058
8058
  * @param {*} [options] Override http request option.
8059
8059
  * @throws {RequiredError}
8060
8060
  */
8061
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
8061
+ inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InverseKinematicsResponse>>;
8062
8062
  };
8063
8063
  /**
8064
8064
  * KinematicsApi - factory interface
@@ -8069,20 +8069,20 @@ declare const KinematicsApiFactory: (configuration?: Configuration, basePath?: s
8069
8069
  * Returns the TCP poses for a list of given joint positions.
8070
8070
  * @summary Forward kinematics
8071
8071
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8072
- * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
8072
+ * @param {ForwardKinematicsRequest} forwardKinematicsRequest
8073
8073
  * @param {*} [options] Override http request option.
8074
8074
  * @throws {RequiredError}
8075
8075
  */
8076
- forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
8076
+ forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ForwardKinematicsResponse>;
8077
8077
  /**
8078
8078
  * Returns the reachable joint positions for a list of given poses.
8079
8079
  * @summary Inverse kinematics
8080
8080
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8081
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8081
+ * @param {InverseKinematicsRequest} inverseKinematicsRequest
8082
8082
  * @param {*} [options] Override http request option.
8083
8083
  * @throws {RequiredError}
8084
8084
  */
8085
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
8085
+ inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InverseKinematicsResponse>;
8086
8086
  };
8087
8087
  /**
8088
8088
  * KinematicsApi - object-oriented interface
@@ -8095,22 +8095,22 @@ declare class KinematicsApi extends BaseAPI {
8095
8095
  * Returns the TCP poses for a list of given joint positions.
8096
8096
  * @summary Forward kinematics
8097
8097
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8098
- * @param {ForwardKinematicsRequest} [forwardKinematicsRequest]
8098
+ * @param {ForwardKinematicsRequest} forwardKinematicsRequest
8099
8099
  * @param {*} [options] Override http request option.
8100
8100
  * @throws {RequiredError}
8101
8101
  * @memberof KinematicsApi
8102
8102
  */
8103
- forwardKinematics(cell: string, forwardKinematicsRequest?: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
8103
+ forwardKinematics(cell: string, forwardKinematicsRequest: ForwardKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<ForwardKinematicsResponse, any>>;
8104
8104
  /**
8105
8105
  * Returns the reachable joint positions for a list of given poses.
8106
8106
  * @summary Inverse kinematics
8107
8107
  * @param {string} cell Unique identifier addressing a cell in all API calls.
8108
- * @param {InverseKinematicsRequest} [inverseKinematicsRequest]
8108
+ * @param {InverseKinematicsRequest} inverseKinematicsRequest
8109
8109
  * @param {*} [options] Override http request option.
8110
8110
  * @throws {RequiredError}
8111
8111
  * @memberof KinematicsApi
8112
8112
  */
8113
- inverseKinematics(cell: string, inverseKinematicsRequest?: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
8113
+ inverseKinematics(cell: string, inverseKinematicsRequest: InverseKinematicsRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<InverseKinematicsResponse, any>>;
8114
8114
  }
8115
8115
  /**
8116
8116
  * LicenseApi - axios parameter creator
@@ -10417,20 +10417,20 @@ declare const TrajectoryPlanningApiAxiosParamCreator: (configuration?: Configura
10417
10417
  * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
10418
10418
  * @summary Plan Collision-Free Trajectory
10419
10419
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10420
- * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
10420
+ * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
10421
10421
  * @param {*} [options] Override http request option.
10422
10422
  * @throws {RequiredError}
10423
10423
  */
10424
- planCollisionFree: (cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10424
+ planCollisionFree: (cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10425
10425
  /**
10426
10426
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
10427
10427
  * @summary Plan Trajectory
10428
10428
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10429
- * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
10429
+ * @param {PlanTrajectoryRequest} planTrajectoryRequest
10430
10430
  * @param {*} [options] Override http request option.
10431
10431
  * @throws {RequiredError}
10432
10432
  */
10433
- planTrajectory: (cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10433
+ planTrajectory: (cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
10434
10434
  };
10435
10435
  /**
10436
10436
  * TrajectoryPlanningApi - functional programming interface
@@ -10441,20 +10441,20 @@ declare const TrajectoryPlanningApiFp: (configuration?: Configuration) => {
10441
10441
  * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
10442
10442
  * @summary Plan Collision-Free Trajectory
10443
10443
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10444
- * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
10444
+ * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
10445
10445
  * @param {*} [options] Override http request option.
10446
10446
  * @throws {RequiredError}
10447
10447
  */
10448
- planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
10448
+ planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanCollisionFreeResponse>>;
10449
10449
  /**
10450
10450
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
10451
10451
  * @summary Plan Trajectory
10452
10452
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10453
- * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
10453
+ * @param {PlanTrajectoryRequest} planTrajectoryRequest
10454
10454
  * @param {*} [options] Override http request option.
10455
10455
  * @throws {RequiredError}
10456
10456
  */
10457
- planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanTrajectoryResponse>>;
10457
+ planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlanTrajectoryResponse>>;
10458
10458
  };
10459
10459
  /**
10460
10460
  * TrajectoryPlanningApi - factory interface
@@ -10465,20 +10465,20 @@ declare const TrajectoryPlanningApiFactory: (configuration?: Configuration, base
10465
10465
  * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
10466
10466
  * @summary Plan Collision-Free Trajectory
10467
10467
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10468
- * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
10468
+ * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
10469
10469
  * @param {*} [options] Override http request option.
10470
10470
  * @throws {RequiredError}
10471
10471
  */
10472
- planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
10472
+ planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanCollisionFreeResponse>;
10473
10473
  /**
10474
10474
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
10475
10475
  * @summary Plan Trajectory
10476
10476
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10477
- * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
10477
+ * @param {PlanTrajectoryRequest} planTrajectoryRequest
10478
10478
  * @param {*} [options] Override http request option.
10479
10479
  * @throws {RequiredError}
10480
10480
  */
10481
- planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanTrajectoryResponse>;
10481
+ planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlanTrajectoryResponse>;
10482
10482
  };
10483
10483
  /**
10484
10484
  * TrajectoryPlanningApi - object-oriented interface
@@ -10491,22 +10491,22 @@ declare class TrajectoryPlanningApi extends BaseAPI {
10491
10491
  * Plans a collision-free trajectory for a single motion group using point-to-point (PTP) motions. This endpoint is specifically designed for collision-free path planning algorithms that find a trajectory from a start joint position to a target position while avoiding obstacles. Use the following workflow to execute a planned collision-free trajectory: 1. Plan a collision-free trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory planning fails due to collision or algorithm constraints, the response will contain error information about the failure.
10492
10492
  * @summary Plan Collision-Free Trajectory
10493
10493
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10494
- * @param {PlanCollisionFreeRequest} [planCollisionFreeRequest]
10494
+ * @param {PlanCollisionFreeRequest} planCollisionFreeRequest
10495
10495
  * @param {*} [options] Override http request option.
10496
10496
  * @throws {RequiredError}
10497
10497
  * @memberof TrajectoryPlanningApi
10498
10498
  */
10499
- planCollisionFree(cell: string, planCollisionFreeRequest?: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
10499
+ planCollisionFree(cell: string, planCollisionFreeRequest: PlanCollisionFreeRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanCollisionFreeResponse, any>>;
10500
10500
  /**
10501
10501
  * Plans a new trajectory for a single motion group. Describe the trajectory as a sequence of motion commands that the robots TCP should follow. Use the following workflow to execute a planned trajectory: 1. Plan a trajectory. 2. Optional: Load the planned trajectory into the cache using the [addTrajectory](addTrajectory) endpoint. 3. Execute the (cached) trajectory using the [executeTrajectory](executeTrajectory) endpoint. If the trajectory is not executable, the response will contain the joint trajectory up until the error, e.g., all samples until a collision occurs. <!-- theme: info --> > #### Exception > > If a CartesianPTP or JointPTP motion command has an invalid target, the response will contain the trajectory up until the start of the invalid PTP motion.
10502
10502
  * @summary Plan Trajectory
10503
10503
  * @param {string} cell Unique identifier addressing a cell in all API calls.
10504
- * @param {PlanTrajectoryRequest} [planTrajectoryRequest]
10504
+ * @param {PlanTrajectoryRequest} planTrajectoryRequest
10505
10505
  * @param {*} [options] Override http request option.
10506
10506
  * @throws {RequiredError}
10507
10507
  * @memberof TrajectoryPlanningApi
10508
10508
  */
10509
- planTrajectory(cell: string, planTrajectoryRequest?: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
10509
+ planTrajectory(cell: string, planTrajectoryRequest: PlanTrajectoryRequest, options?: RawAxiosRequestConfig): Promise<axios0.AxiosResponse<PlanTrajectoryResponse, any>>;
10510
10510
  }
10511
10511
  /**
10512
10512
  * VirtualControllerApi - axios parameter creator