cyberdesk 2.1.14 → 2.1.16

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.
@@ -368,7 +368,8 @@ export declare const updateRequestLogV1RequestLogsLogIdPatch: <ThrowOnError exte
368
368
  * List Trajectories
369
369
  * List all trajectories for the authenticated organization.
370
370
  *
371
- * Supports pagination and filtering by workflow.
371
+ * Supports pagination and filtering by workflow and approval status.
372
+ * Only approved trajectories are used during workflow execution.
372
373
  * Returns trajectories with their associated workflow data.
373
374
  */
374
375
  export declare const listTrajectoriesV1TrajectoriesGet: <ThrowOnError extends boolean = false>(options?: Options<ListTrajectoriesV1TrajectoriesGetData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<import("./types.gen").PaginatedResponseTrajectoryResponse, import("./types.gen").HttpValidationError, ThrowOnError>;
@@ -766,7 +766,8 @@ exports.updateRequestLogV1RequestLogsLogIdPatch = updateRequestLogV1RequestLogsL
766
766
  * List Trajectories
767
767
  * List all trajectories for the authenticated organization.
768
768
  *
769
- * Supports pagination and filtering by workflow.
769
+ * Supports pagination and filtering by workflow and approval status.
770
+ * Only approved trajectories are used during workflow execution.
770
771
  * Returns trajectories with their associated workflow data.
771
772
  */
772
773
  const listTrajectoriesV1TrajectoriesGet = (options) => {
@@ -664,6 +664,10 @@ export type TrajectoryCreate = {
664
664
  original_input_values?: {
665
665
  [key: string]: unknown;
666
666
  } | null;
667
+ /**
668
+ * Whether this trajectory is approved for use
669
+ */
670
+ is_approved?: boolean;
667
671
  };
668
672
  /**
669
673
  * Trajectory response schema
@@ -687,6 +691,7 @@ export type TrajectoryResponse = {
687
691
  original_input_values?: {
688
692
  [key: string]: unknown;
689
693
  } | null;
694
+ is_approved: boolean;
690
695
  id: string;
691
696
  user_id?: string | null;
692
697
  organization_id?: string | null;
@@ -702,6 +707,10 @@ export type TrajectoryUpdate = {
702
707
  trajectory_data?: Array<{
703
708
  [key: string]: unknown;
704
709
  }> | null;
710
+ /**
711
+ * Whether this trajectory is approved for use
712
+ */
713
+ is_approved?: boolean | null;
705
714
  };
706
715
  export type ValidationError = {
707
716
  loc: Array<string | number>;
@@ -1913,6 +1922,10 @@ export type ListTrajectoriesV1TrajectoriesGetData = {
1913
1922
  * Filter by workflow ID
1914
1923
  */
1915
1924
  workflow_id?: string | null;
1925
+ /**
1926
+ * Filter by approval status (true=approved, false=not approved)
1927
+ */
1928
+ is_approved?: boolean | null;
1916
1929
  /**
1917
1930
  * Filter trajectories created at or after this ISO timestamp (UTC)
1918
1931
  */
package/dist/index.d.ts CHANGED
@@ -692,12 +692,22 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
692
692
  * @param params.skip - Number of items to skip (for pagination)
693
693
  * @param params.limit - Maximum number of items to return
694
694
  * @param params.workflow_id - Filter by workflow ID
695
+ * @param params.is_approved - Filter by approval status (true=approved, false=not approved, undefined=all)
696
+ * @param params.created_at_from - Filter created at or after this date
697
+ * @param params.created_at_to - Filter created at or before this date
698
+ * @param params.updated_at_from - Filter updated at or after this date
699
+ * @param params.updated_at_to - Filter updated at or before this date
695
700
  * @returns Paginated list of trajectories
701
+ *
702
+ * @remarks
703
+ * By default returns both approved and unapproved trajectories.
704
+ * Only approved trajectories are used during workflow execution.
696
705
  */
697
706
  list: (params?: {
698
707
  skip?: number;
699
708
  limit?: number;
700
709
  workflow_id?: string;
710
+ is_approved?: boolean;
701
711
  created_at_from?: string | Date;
702
712
  created_at_to?: string | Date;
703
713
  updated_at_from?: string | Date;
@@ -723,6 +733,10 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
723
733
  * @param data.dimensions - Display dimensions when trajectory was recorded
724
734
  * @param data.original_input_values - Input values used during recording
725
735
  * @returns Created trajectory details
736
+ *
737
+ * @remarks
738
+ * Trajectories are created with is_approved=false by default.
739
+ * You must explicitly approve them before they can be used during workflow execution.
726
740
  */
727
741
  create: (data: TrajectoryCreate) => Promise<({
728
742
  data: undefined;
@@ -754,8 +768,12 @@ export declare function createCyberdeskClient(apiKey: string, baseUrl?: string):
754
768
  * Update a trajectory
755
769
  *
756
770
  * @param trajectoryId - The ID of the trajectory to update
757
- * @param data - Update data (trajectory_data)
771
+ * @param data - Update data (name, description, trajectory_data, is_approved)
758
772
  * @returns Updated trajectory details
773
+ *
774
+ * @remarks
775
+ * You can update trajectory metadata, trajectory data (steps), and approval status.
776
+ * Only approved trajectories are used during workflow execution.
759
777
  */
760
778
  update: (trajectoryId: string, data: TrajectoryUpdate) => Promise<({
761
779
  data: undefined;
package/dist/index.js CHANGED
@@ -640,14 +640,24 @@ function createCyberdeskClient(apiKey, baseUrl) {
640
640
  * @param params.skip - Number of items to skip (for pagination)
641
641
  * @param params.limit - Maximum number of items to return
642
642
  * @param params.workflow_id - Filter by workflow ID
643
+ * @param params.is_approved - Filter by approval status (true=approved, false=not approved, undefined=all)
644
+ * @param params.created_at_from - Filter created at or after this date
645
+ * @param params.created_at_to - Filter created at or before this date
646
+ * @param params.updated_at_from - Filter updated at or after this date
647
+ * @param params.updated_at_to - Filter updated at or before this date
643
648
  * @returns Paginated list of trajectories
649
+ *
650
+ * @remarks
651
+ * By default returns both approved and unapproved trajectories.
652
+ * Only approved trajectories are used during workflow execution.
644
653
  */
645
654
  list: (params) => __awaiter(this, void 0, void 0, function* () {
646
- var _a;
655
+ var _a, _b;
647
656
  const query = {
648
657
  skip: params === null || params === void 0 ? void 0 : params.skip,
649
658
  limit: params === null || params === void 0 ? void 0 : params.limit,
650
659
  workflow_id: (_a = params === null || params === void 0 ? void 0 : params.workflow_id) !== null && _a !== void 0 ? _a : undefined,
660
+ is_approved: (_b = params === null || params === void 0 ? void 0 : params.is_approved) !== null && _b !== void 0 ? _b : undefined,
651
661
  created_at_from: toIsoUtc(params === null || params === void 0 ? void 0 : params.created_at_from),
652
662
  created_at_to: toIsoUtc(params === null || params === void 0 ? void 0 : params.created_at_to),
653
663
  updated_at_from: toIsoUtc(params === null || params === void 0 ? void 0 : params.updated_at_from),
@@ -666,6 +676,10 @@ function createCyberdeskClient(apiKey, baseUrl) {
666
676
  * @param data.dimensions - Display dimensions when trajectory was recorded
667
677
  * @param data.original_input_values - Input values used during recording
668
678
  * @returns Created trajectory details
679
+ *
680
+ * @remarks
681
+ * Trajectories are created with is_approved=false by default.
682
+ * You must explicitly approve them before they can be used during workflow execution.
669
683
  */
670
684
  create: (data) => __awaiter(this, void 0, void 0, function* () {
671
685
  return (0, sdk_gen_1.createTrajectoryV1TrajectoriesPost)({
@@ -689,8 +703,12 @@ function createCyberdeskClient(apiKey, baseUrl) {
689
703
  * Update a trajectory
690
704
  *
691
705
  * @param trajectoryId - The ID of the trajectory to update
692
- * @param data - Update data (trajectory_data)
706
+ * @param data - Update data (name, description, trajectory_data, is_approved)
693
707
  * @returns Updated trajectory details
708
+ *
709
+ * @remarks
710
+ * You can update trajectory metadata, trajectory data (steps), and approval status.
711
+ * Only approved trajectories are used during workflow execution.
694
712
  */
695
713
  update: (trajectoryId, data) => __awaiter(this, void 0, void 0, function* () {
696
714
  return (0, sdk_gen_1.updateTrajectoryV1TrajectoriesTrajectoryIdPatch)({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cyberdesk",
3
- "version": "2.1.14",
3
+ "version": "2.1.16",
4
4
  "description": "The official TypeScript SDK for Cyberdesk",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",