@cadenya/cadenya 0.67.0 → 0.68.0

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.
Files changed (186) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/client.d.mts +24 -63
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +24 -63
  5. package/client.d.ts.map +1 -1
  6. package/client.js +24 -63
  7. package/client.js.map +1 -1
  8. package/client.mjs +24 -63
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/account.d.mts +18 -22
  12. package/resources/account.d.mts.map +1 -1
  13. package/resources/account.d.ts +18 -22
  14. package/resources/account.d.ts.map +1 -1
  15. package/resources/account.js +2 -6
  16. package/resources/account.js.map +1 -1
  17. package/resources/account.mjs +2 -6
  18. package/resources/account.mjs.map +1 -1
  19. package/resources/agents/agents.d.mts +9 -13
  20. package/resources/agents/agents.d.mts.map +1 -1
  21. package/resources/agents/agents.d.ts +9 -13
  22. package/resources/agents/agents.d.ts.map +1 -1
  23. package/resources/agents/agents.js +1 -6
  24. package/resources/agents/agents.js.map +1 -1
  25. package/resources/agents/agents.mjs +1 -6
  26. package/resources/agents/agents.mjs.map +1 -1
  27. package/resources/agents/feedback.d.mts +2 -7
  28. package/resources/agents/feedback.d.mts.map +1 -1
  29. package/resources/agents/feedback.d.ts +2 -7
  30. package/resources/agents/feedback.d.ts.map +1 -1
  31. package/resources/agents/feedback.js +1 -6
  32. package/resources/agents/feedback.js.map +1 -1
  33. package/resources/agents/feedback.mjs +1 -6
  34. package/resources/agents/feedback.mjs.map +1 -1
  35. package/resources/agents/schedules.d.mts +18 -21
  36. package/resources/agents/schedules.d.mts.map +1 -1
  37. package/resources/agents/schedules.d.ts +18 -21
  38. package/resources/agents/schedules.d.ts.map +1 -1
  39. package/resources/agents/schedules.js +2 -6
  40. package/resources/agents/schedules.js.map +1 -1
  41. package/resources/agents/schedules.mjs +2 -6
  42. package/resources/agents/schedules.mjs.map +1 -1
  43. package/resources/agents/variations.d.mts +48 -45
  44. package/resources/agents/variations.d.mts.map +1 -1
  45. package/resources/agents/variations.d.ts +48 -45
  46. package/resources/agents/variations.d.ts.map +1 -1
  47. package/resources/agents/variations.js +3 -0
  48. package/resources/agents/variations.js.map +1 -1
  49. package/resources/agents/variations.mjs +3 -0
  50. package/resources/agents/variations.mjs.map +1 -1
  51. package/resources/agents/webhook-deliveries.d.mts +4 -9
  52. package/resources/agents/webhook-deliveries.d.mts.map +1 -1
  53. package/resources/agents/webhook-deliveries.d.ts +4 -9
  54. package/resources/agents/webhook-deliveries.d.ts.map +1 -1
  55. package/resources/agents/webhook-deliveries.js +1 -6
  56. package/resources/agents/webhook-deliveries.js.map +1 -1
  57. package/resources/agents/webhook-deliveries.mjs +1 -6
  58. package/resources/agents/webhook-deliveries.mjs.map +1 -1
  59. package/resources/api-keys.d.mts +19 -22
  60. package/resources/api-keys.d.mts.map +1 -1
  61. package/resources/api-keys.d.ts +19 -22
  62. package/resources/api-keys.d.ts.map +1 -1
  63. package/resources/api-keys.js +2 -5
  64. package/resources/api-keys.js.map +1 -1
  65. package/resources/api-keys.mjs +2 -5
  66. package/resources/api-keys.mjs.map +1 -1
  67. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.mts +11 -18
  68. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.mts.map +1 -1
  69. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.ts +11 -18
  70. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.ts.map +1 -1
  71. package/resources/bulk-workspace-resources/bulk-workspace-resources.js +3 -8
  72. package/resources/bulk-workspace-resources/bulk-workspace-resources.js.map +1 -1
  73. package/resources/bulk-workspace-resources/bulk-workspace-resources.mjs +3 -8
  74. package/resources/bulk-workspace-resources/bulk-workspace-resources.mjs.map +1 -1
  75. package/resources/bulk-workspace-resources/results.d.mts +23 -32
  76. package/resources/bulk-workspace-resources/results.d.mts.map +1 -1
  77. package/resources/bulk-workspace-resources/results.d.ts +23 -32
  78. package/resources/bulk-workspace-resources/results.d.ts.map +1 -1
  79. package/resources/bulk-workspace-resources/results.js +3 -8
  80. package/resources/bulk-workspace-resources/results.js.map +1 -1
  81. package/resources/bulk-workspace-resources/results.mjs +3 -8
  82. package/resources/bulk-workspace-resources/results.mjs.map +1 -1
  83. package/resources/memory-layers/entries.d.mts +14 -28
  84. package/resources/memory-layers/entries.d.mts.map +1 -1
  85. package/resources/memory-layers/entries.d.ts +14 -28
  86. package/resources/memory-layers/entries.d.ts.map +1 -1
  87. package/resources/memory-layers/entries.js +4 -10
  88. package/resources/memory-layers/entries.js.map +1 -1
  89. package/resources/memory-layers/entries.mjs +4 -10
  90. package/resources/memory-layers/entries.mjs.map +1 -1
  91. package/resources/memory-layers/memory-layers.d.mts +8 -20
  92. package/resources/memory-layers/memory-layers.d.mts.map +1 -1
  93. package/resources/memory-layers/memory-layers.d.ts +8 -20
  94. package/resources/memory-layers/memory-layers.d.ts.map +1 -1
  95. package/resources/memory-layers/memory-layers.js +4 -10
  96. package/resources/memory-layers/memory-layers.js.map +1 -1
  97. package/resources/memory-layers/memory-layers.mjs +4 -10
  98. package/resources/memory-layers/memory-layers.mjs.map +1 -1
  99. package/resources/models.d.mts +5 -9
  100. package/resources/models.d.mts.map +1 -1
  101. package/resources/models.d.ts +5 -9
  102. package/resources/models.d.ts.map +1 -1
  103. package/resources/models.js +3 -7
  104. package/resources/models.js.map +1 -1
  105. package/resources/models.mjs +3 -7
  106. package/resources/models.mjs.map +1 -1
  107. package/resources/objectives/feedback.d.mts +5 -5
  108. package/resources/objectives/feedback.d.ts +5 -5
  109. package/resources/objectives/objectives.d.mts +22 -31
  110. package/resources/objectives/objectives.d.mts.map +1 -1
  111. package/resources/objectives/objectives.d.ts +22 -31
  112. package/resources/objectives/objectives.d.ts.map +1 -1
  113. package/resources/objectives/objectives.js.map +1 -1
  114. package/resources/objectives/objectives.mjs.map +1 -1
  115. package/resources/objectives/tasks.d.mts +1 -4
  116. package/resources/objectives/tasks.d.mts.map +1 -1
  117. package/resources/objectives/tasks.d.ts +1 -4
  118. package/resources/objectives/tasks.d.ts.map +1 -1
  119. package/resources/objectives/tool-calls.d.mts +8 -11
  120. package/resources/objectives/tool-calls.d.mts.map +1 -1
  121. package/resources/objectives/tool-calls.d.ts +8 -11
  122. package/resources/objectives/tool-calls.d.ts.map +1 -1
  123. package/resources/objectives/tools.d.mts +1 -1
  124. package/resources/objectives/tools.d.ts +1 -1
  125. package/resources/tool-sets/tool-sets.d.mts +31 -35
  126. package/resources/tool-sets/tool-sets.d.mts.map +1 -1
  127. package/resources/tool-sets/tool-sets.d.ts +31 -35
  128. package/resources/tool-sets/tool-sets.d.ts.map +1 -1
  129. package/resources/tool-sets/tool-sets.js +4 -8
  130. package/resources/tool-sets/tool-sets.js.map +1 -1
  131. package/resources/tool-sets/tool-sets.mjs +4 -8
  132. package/resources/tool-sets/tool-sets.mjs.map +1 -1
  133. package/resources/tool-sets/tools.d.mts +16 -22
  134. package/resources/tool-sets/tools.d.mts.map +1 -1
  135. package/resources/tool-sets/tools.d.ts +16 -22
  136. package/resources/tool-sets/tools.d.ts.map +1 -1
  137. package/resources/tool-sets/tools.js +4 -8
  138. package/resources/tool-sets/tools.js.map +1 -1
  139. package/resources/tool-sets/tools.mjs +4 -8
  140. package/resources/tool-sets/tools.mjs.map +1 -1
  141. package/resources/uploads.d.mts +13 -17
  142. package/resources/uploads.d.mts.map +1 -1
  143. package/resources/uploads.d.ts +13 -17
  144. package/resources/uploads.d.ts.map +1 -1
  145. package/resources/uploads.js +3 -7
  146. package/resources/uploads.js.map +1 -1
  147. package/resources/uploads.mjs +3 -7
  148. package/resources/uploads.mjs.map +1 -1
  149. package/resources/workspace-secrets.d.mts +7 -7
  150. package/resources/workspace-secrets.d.ts +7 -7
  151. package/resources/workspaces.d.mts +2 -6
  152. package/resources/workspaces.d.mts.map +1 -1
  153. package/resources/workspaces.d.ts +2 -6
  154. package/resources/workspaces.d.ts.map +1 -1
  155. package/resources/workspaces.js +2 -6
  156. package/resources/workspaces.js.map +1 -1
  157. package/resources/workspaces.mjs +2 -6
  158. package/resources/workspaces.mjs.map +1 -1
  159. package/src/client.ts +24 -63
  160. package/src/resources/account.ts +18 -22
  161. package/src/resources/agents/agents.ts +9 -13
  162. package/src/resources/agents/feedback.ts +2 -7
  163. package/src/resources/agents/schedules.ts +18 -21
  164. package/src/resources/agents/variations.ts +48 -45
  165. package/src/resources/agents/webhook-deliveries.ts +4 -9
  166. package/src/resources/api-keys.ts +19 -22
  167. package/src/resources/bulk-workspace-resources/bulk-workspace-resources.ts +11 -18
  168. package/src/resources/bulk-workspace-resources/results.ts +23 -32
  169. package/src/resources/memory-layers/entries.ts +14 -28
  170. package/src/resources/memory-layers/memory-layers.ts +8 -20
  171. package/src/resources/models.ts +5 -9
  172. package/src/resources/objectives/feedback.ts +5 -5
  173. package/src/resources/objectives/objectives.ts +22 -31
  174. package/src/resources/objectives/tasks.ts +1 -4
  175. package/src/resources/objectives/tool-calls.ts +8 -11
  176. package/src/resources/objectives/tools.ts +1 -1
  177. package/src/resources/tool-sets/tool-sets.ts +31 -35
  178. package/src/resources/tool-sets/tools.ts +16 -22
  179. package/src/resources/uploads.ts +13 -17
  180. package/src/resources/workspace-secrets.ts +7 -7
  181. package/src/resources/workspaces.ts +2 -6
  182. package/src/version.ts +1 -1
  183. package/version.d.mts +1 -1
  184. package/version.d.ts +1 -1
  185. package/version.js +1 -1
  186. package/version.mjs +1 -1
@@ -263,7 +263,7 @@ export interface MemoryRead {
263
263
  * permitted).
264
264
  *
265
265
  * memory*layer_id accepts both the canonical form (memlyr*…) and the external-id
266
- * form (external_id:my-custom-id). The same applies to memory_entry_id.
266
+ * form (external_id:my-custom-id). The same applies to memory_entry_id when set.
267
267
  */
268
268
  export interface MemoryReference {
269
269
  /**
@@ -321,9 +321,9 @@ export interface ObjectiveContextWindow {
321
321
  export namespace ObjectiveContextWindow {
322
322
  export interface Info {
323
323
  /**
324
- * Profile represents a human user at the account level. Profiles are
325
- * account-scoped resources that can be associated with multiple workspaces through
326
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
324
+ * A profile identifies a user or non-human principal (such as an API key) at the
325
+ * account level. Profiles are account-scoped and can be granted access to multiple
326
+ * workspaces.
327
327
  */
328
328
  createdBy?: AccountAPI.Profile;
329
329
 
@@ -389,22 +389,18 @@ export interface ObjectiveData {
389
389
  * Memory layers/entries to push onto this objective's memory stack on top of the
390
390
  * baseline stack inherited from the selected variation.
391
391
  *
392
- * See "Memory stack composition" in memory.proto for lookup semantics.
393
- *
394
392
  * Array order is push order: the first element sits lower in the objective's
395
393
  * contribution to the stack; the LAST element ends up on top of the effective
396
394
  * stack. Entries pinned via memory_entry_id behave as single-entry layers at their
397
395
  * position.
398
396
  *
399
397
  * System-managed layers (e.g., episodic) cannot be referenced here; they attach
400
- * themselves automatically via the runtime based on episodic_key.
398
+ * themselves automatically based on episodic_key.
401
399
  *
402
400
  * Stack size cap: the TOTAL effective stack (variation's memory layers
403
401
  *
404
402
  * - this field) must not exceed 10 entries. A request that would produce an
405
- * effective stack larger than 10 is rejected with InvalidArgument. Variations
406
- * themselves are capped at 10 memory layer assignments, so a variation that is
407
- * already "full" leaves no room for objective-level references.
403
+ * effective stack larger than 10 is rejected with InvalidArgument.
408
404
  */
409
405
  memoryStack?: Array<MemoryReference>;
410
406
 
@@ -421,10 +417,9 @@ export interface ObjectiveData {
421
417
  secrets?: Array<ObjectiveDataSecret>;
422
418
 
423
419
  /**
424
- * ID of the AgentSchedule that produced this objective, when applicable.
425
- * Read-only; populated by the runtime when the objective is created from a
426
- * schedule fire. Empty when the objective was created via CreateObjective
427
- * directly.
420
+ * ID of the AgentSchedule that produced this objective, when applicable. Populated
421
+ * when the objective is created from a schedule fire; empty when the objective was
422
+ * created via CreateObjective directly.
428
423
  */
429
424
  sourceScheduleId?: string;
430
425
 
@@ -509,9 +504,9 @@ export namespace ObjectiveEventData {
509
504
 
510
505
  export interface ObjectiveEventInfo {
511
506
  /**
512
- * Profile represents a human user at the account level. Profiles are
513
- * account-scoped resources that can be associated with multiple workspaces through
514
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
507
+ * A profile identifies a user or non-human principal (such as an API key) at the
508
+ * account level. Profiles are account-scoped and can be granted access to multiple
509
+ * workspaces.
515
510
  */
516
511
  createdBy?: AccountAPI.Profile;
517
512
 
@@ -600,9 +595,9 @@ export interface ObjectiveInfo {
600
595
  agentVariation?: Shared.ResourceMetadata;
601
596
 
602
597
  /**
603
- * Profile represents a human user at the account level. Profiles are
604
- * account-scoped resources that can be associated with multiple workspaces through
605
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
598
+ * A profile identifies a user or non-human principal (such as an API key) at the
599
+ * account level. Profiles are account-scoped and can be granted access to multiple
600
+ * workspaces.
606
601
  */
607
602
  createdBy?: AccountAPI.Profile;
608
603
 
@@ -777,9 +772,6 @@ export interface ObjectiveCreateParams {
777
772
  }
778
773
 
779
774
  export interface ObjectiveRetrieveParams {
780
- /**
781
- * Workspace ID (from path).
782
- */
783
775
  workspaceId: string;
784
776
  }
785
777
 
@@ -790,9 +782,8 @@ export interface ObjectiveListParams extends CursorPaginationParams {
790
782
  agentId?: string;
791
783
 
792
784
  /**
793
- * Filter to objectives produced by a specific AgentSchedule. Matches
794
- * ObjectiveData.source*schedule_id. Accepts canonical as*… form or
795
- * external_id:<value> form (see common.proto "Path-parameter ID resolution").
785
+ * Filter to objectives produced by a specific AgentSchedule. Accepts canonical
786
+ * as\_… form or external_id:<value> form.
796
787
  */
797
788
  agentScheduleId?: string;
798
789
 
@@ -827,7 +818,7 @@ export interface ObjectiveListParams extends CursorPaginationParams {
827
818
 
828
819
  export interface ObjectiveCancelParams {
829
820
  /**
830
- * Path param: Workspace ID (from path).
821
+ * Path param
831
822
  */
832
823
  workspaceId: string;
833
824
 
@@ -839,7 +830,7 @@ export interface ObjectiveCancelParams {
839
830
 
840
831
  export interface ObjectiveCompactParams {
841
832
  /**
842
- * Path param: Workspace ID (from path).
833
+ * Path param
843
834
  */
844
835
  workspaceId: string;
845
836
 
@@ -852,7 +843,7 @@ export interface ObjectiveCompactParams {
852
843
 
853
844
  export interface ObjectiveContinueParams {
854
845
  /**
855
- * Path param: Workspace ID (from path).
846
+ * Path param
856
847
  */
857
848
  workspaceId: string;
858
849
 
@@ -886,7 +877,7 @@ export namespace ObjectiveContinueParams {
886
877
 
887
878
  export interface ObjectiveListContextWindowsParams extends CursorPaginationParams {
888
879
  /**
889
- * Path param: Workspace ID (from path).
880
+ * Path param
890
881
  */
891
882
  workspaceId: string;
892
883
 
@@ -898,7 +889,7 @@ export interface ObjectiveListContextWindowsParams extends CursorPaginationParam
898
889
 
899
890
  export interface ObjectiveListEventsParams extends CursorPaginationParams {
900
891
  /**
901
- * Path param: Workspace ID (from path).
892
+ * Path param
902
893
  */
903
894
  workspaceId: string;
904
895
 
@@ -79,9 +79,6 @@ export interface ObjectiveTaskData {
79
79
  }
80
80
 
81
81
  export interface TaskRetrieveParams {
82
- /**
83
- * Workspace ID (from path).
84
- */
85
82
  workspaceId: string;
86
83
 
87
84
  /**
@@ -92,7 +89,7 @@ export interface TaskRetrieveParams {
92
89
 
93
90
  export interface TaskListParams extends CursorPaginationParams {
94
91
  /**
95
- * Path param: Workspace ID (from path).
92
+ * Path param
96
93
  */
97
94
  workspaceId: string;
98
95
 
@@ -121,18 +121,18 @@ export interface ObjectiveToolCallData {
121
121
  result?: string;
122
122
 
123
123
  /**
124
- * Profile represents a human user at the account level. Profiles are
125
- * account-scoped resources that can be associated with multiple workspaces through
126
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
124
+ * A profile identifies a user or non-human principal (such as an API key) at the
125
+ * account level. Profiles are account-scoped and can be granted access to multiple
126
+ * workspaces.
127
127
  */
128
128
  statusChangedBy?: AccountAPI.Profile;
129
129
  }
130
130
 
131
131
  export interface ObjectiveToolCallInfo {
132
132
  /**
133
- * Profile represents a human user at the account level. Profiles are
134
- * account-scoped resources that can be associated with multiple workspaces through
135
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
133
+ * A profile identifies a user or non-human principal (such as an API key) at the
134
+ * account level. Profiles are account-scoped and can be granted access to multiple
135
+ * workspaces.
136
136
  */
137
137
  createdBy?: AccountAPI.Profile;
138
138
 
@@ -145,7 +145,7 @@ export interface ObjectiveToolCallInfo {
145
145
 
146
146
  export interface ToolCallListParams extends CursorPaginationParams {
147
147
  /**
148
- * Path param: Workspace ID (from path).
148
+ * Path param
149
149
  */
150
150
  workspaceId: string;
151
151
 
@@ -166,9 +166,6 @@ export interface ToolCallListParams extends CursorPaginationParams {
166
166
  }
167
167
 
168
168
  export interface ToolCallApproveParams {
169
- /**
170
- * Workspace ID (from path).
171
- */
172
169
  workspaceId: string;
173
170
 
174
171
  /**
@@ -179,7 +176,7 @@ export interface ToolCallApproveParams {
179
176
 
180
177
  export interface ToolCallDenyParams {
181
178
  /**
182
- * Path param: Workspace ID (from path).
179
+ * Path param
183
180
  */
184
181
  workspaceId: string;
185
182
 
@@ -51,7 +51,7 @@ export interface ObjectiveTool {
51
51
 
52
52
  export interface ToolListParams extends CursorPaginationParams {
53
53
  /**
54
- * Path param: Workspace ID (from path).
54
+ * Path param
55
55
  */
56
56
  workspaceId: string;
57
57
  }
@@ -27,15 +27,11 @@ import { RequestOptions } from '../../internal/request-options';
27
27
  import { path } from '../../internal/utils/path';
28
28
 
29
29
  /**
30
- * ToolService manages tool sets and tools at the WORKSPACE level.
31
- * Tool sets group related tools, and tools define specific capabilities for agents.
32
- * All operations are implicitly scoped to the workspace determined by the JWT token.
30
+ * Manage tool sets and the tools they contain. Tool sets group related tools,
31
+ * and tools define specific capabilities available to agents.
33
32
  *
34
- * Note: When a ToolSet has managed=true, only API Key actors can modify its tools.
35
- * Profile actors (humans) are restricted from modifying managed tool sets.
36
- *
37
- * Authentication: Bearer token (JWT)
38
- * Scope: Workspace-level operations
33
+ * When a tool set is managed, only API key actors can modify its tools; human
34
+ * (profile) actors cannot.
39
35
  */
40
36
  export class ToolSets extends APIResource {
41
37
  tools: ToolsAPI.Tools = new ToolsAPI.Tools(this._client);
@@ -152,46 +148,46 @@ export namespace McpToolFilter {
152
148
  }
153
149
 
154
150
  /**
155
- * SyncCompleted is emitted when a tool set sync operation completes successfully
151
+ * Emitted when a tool set sync operation completes successfully.
156
152
  */
157
153
  export interface SyncCompleted {
158
154
  /**
159
- * Optional message with additional details
155
+ * Optional message with additional details.
160
156
  */
161
157
  message?: string;
162
158
 
163
159
  /**
164
- * Number of tools synced
160
+ * Number of tools synced.
165
161
  */
166
162
  toolsSynced?: number;
167
163
  }
168
164
 
169
165
  /**
170
- * SyncFailed is emitted when a tool set sync operation fails
166
+ * Emitted when a tool set sync operation fails.
171
167
  */
172
168
  export interface SyncFailed {
173
169
  /**
174
- * Indicates this is an error event
170
+ * Indicates this is an error event.
175
171
  */
176
172
  error?: boolean;
177
173
 
178
174
  /**
179
- * Optional error type/code for programmatic handling
175
+ * Optional error type/code for programmatic handling.
180
176
  */
181
177
  errorType?: string;
182
178
 
183
179
  /**
184
- * Error message describing what went wrong
180
+ * Error message describing what went wrong.
185
181
  */
186
182
  message?: string;
187
183
  }
188
184
 
189
185
  /**
190
- * SyncStarted is emitted when a tool set sync operation begins
186
+ * Emitted when a tool set sync operation begins.
191
187
  */
192
188
  export interface SyncStarted {
193
189
  /**
194
- * Timestamp when the sync was initiated
190
+ * Human-readable message describing the start of the sync.
195
191
  */
196
192
  message?: string;
197
193
  }
@@ -260,7 +256,7 @@ export namespace ToolSetAdapterMcp {
260
256
  }
261
257
 
262
258
  /**
263
- * ToolSetEvent represents a single event in the tool set's operation timeline
259
+ * A single event in the tool set's operation timeline.
264
260
  */
265
261
  export interface ToolSetEvent {
266
262
  /**
@@ -270,14 +266,14 @@ export interface ToolSetEvent {
270
266
  metadata: Shared.OperationMetadata;
271
267
 
272
268
  /**
273
- * ToolSetEventData represents the actual event payload for tool set operations
269
+ * Event payload for a tool set operation.
274
270
  */
275
271
  event?: ToolSetEventData;
276
272
 
277
273
  info?: ToolSetEvent.Info;
278
274
 
279
275
  /**
280
- * The tool set this event is associated with
276
+ * The tool set this event is associated with.
281
277
  */
282
278
  toolSetId?: string;
283
279
  }
@@ -285,9 +281,9 @@ export interface ToolSetEvent {
285
281
  export namespace ToolSetEvent {
286
282
  export interface Info {
287
283
  /**
288
- * Profile represents a human user at the account level. Profiles are
289
- * account-scoped resources that can be associated with multiple workspaces through
290
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
284
+ * A profile identifies a user or non-human principal (such as an API key) at the
285
+ * account level. Profiles are account-scoped and can be granted access to multiple
286
+ * workspaces.
291
287
  */
292
288
  createdBy?: AccountAPI.Profile;
293
289
 
@@ -299,26 +295,26 @@ export namespace ToolSetEvent {
299
295
  }
300
296
 
301
297
  /**
302
- * ToolSetEventData represents the actual event payload for tool set operations
298
+ * Event payload for a tool set operation.
303
299
  */
304
300
  export interface ToolSetEventData {
305
301
  /**
306
- * SyncCompleted is emitted when a tool set sync operation completes successfully
302
+ * Emitted when a tool set sync operation completes successfully.
307
303
  */
308
304
  syncCompleted?: SyncCompleted;
309
305
 
310
306
  /**
311
- * SyncFailed is emitted when a tool set sync operation fails
307
+ * Emitted when a tool set sync operation fails.
312
308
  */
313
309
  syncFailed?: SyncFailed;
314
310
 
315
311
  /**
316
- * SyncStarted is emitted when a tool set sync operation begins
312
+ * Emitted when a tool set sync operation begins.
317
313
  */
318
314
  syncStarted?: SyncStarted;
319
315
 
320
316
  /**
321
- * Type of the event (e.g., "sync_started", "sync_completed", "sync_failed")
317
+ * Type of the event (e.g., "sync_started", "sync_completed", "sync_failed").
322
318
  */
323
319
  type?: string;
324
320
  }
@@ -327,9 +323,9 @@ export interface ToolSetInfo {
327
323
  agentCount?: number;
328
324
 
329
325
  /**
330
- * Profile represents a human user at the account level. Profiles are
331
- * account-scoped resources that can be associated with multiple workspaces through
332
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
326
+ * A profile identifies a user or non-human principal (such as an API key) at the
327
+ * account level. Profiles are account-scoped and can be granted access to multiple
328
+ * workspaces.
333
329
  */
334
330
  createdBy?: AccountAPI.Profile;
335
331
 
@@ -357,14 +353,14 @@ export interface ToolSetCreateParams {
357
353
 
358
354
  export interface ToolSetRetrieveParams {
359
355
  /**
360
- * Workspace ID (from path).
356
+ * Workspace ID.
361
357
  */
362
358
  workspaceId: string;
363
359
  }
364
360
 
365
361
  export interface ToolSetUpdateParams {
366
362
  /**
367
- * Path param: Workspace ID (from path).
363
+ * Path param: Workspace ID.
368
364
  */
369
365
  workspaceId: string;
370
366
 
@@ -416,14 +412,14 @@ export interface ToolSetListParams extends CursorPaginationParams {
416
412
 
417
413
  export interface ToolSetDeleteParams {
418
414
  /**
419
- * Workspace ID (from path).
415
+ * Workspace ID.
420
416
  */
421
417
  workspaceId: string;
422
418
  }
423
419
 
424
420
  export interface ToolSetListEventsParams extends CursorPaginationParams {
425
421
  /**
426
- * Path param: Workspace ID (from path).
422
+ * Path param: Workspace ID.
427
423
  */
428
424
  workspaceId: string;
429
425
 
@@ -10,15 +10,11 @@ import { RequestOptions } from '../../internal/request-options';
10
10
  import { path } from '../../internal/utils/path';
11
11
 
12
12
  /**
13
- * ToolService manages tool sets and tools at the WORKSPACE level.
14
- * Tool sets group related tools, and tools define specific capabilities for agents.
15
- * All operations are implicitly scoped to the workspace determined by the JWT token.
13
+ * Manage tool sets and the tools they contain. Tool sets group related tools,
14
+ * and tools define specific capabilities available to agents.
16
15
  *
17
- * Note: When a ToolSet has managed=true, only API Key actors can modify its tools.
18
- * Profile actors (humans) are restricted from modifying managed tool sets.
19
- *
20
- * Authentication: Bearer token (JWT)
21
- * Scope: Workspace-level operations
16
+ * When a tool set is managed, only API key actors can modify its tools; human
17
+ * (profile) actors cannot.
22
18
  */
23
19
  export class Tools extends APIResource {
24
20
  /**
@@ -126,9 +122,9 @@ export interface Tool {
126
122
 
127
123
  export interface ToolInfo {
128
124
  /**
129
- * Profile represents a human user at the account level. Profiles are
130
- * account-scoped resources that can be associated with multiple workspaces through
131
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
125
+ * A profile identifies a user or non-human principal (such as an API key) at the
126
+ * account level. Profiles are account-scoped and can be granted access to multiple
127
+ * workspaces.
132
128
  */
133
129
  createdBy?: AccountAPI.Profile;
134
130
 
@@ -172,7 +168,7 @@ export interface ToolSpecConfig {
172
168
 
173
169
  export interface ToolCreateParams {
174
170
  /**
175
- * Path param: Workspace ID (from path).
171
+ * Path param: Workspace ID.
176
172
  */
177
173
  workspaceId: string;
178
174
 
@@ -192,26 +188,25 @@ export interface ToolCreateParams {
192
188
 
193
189
  export interface ToolRetrieveParams {
194
190
  /**
195
- * Workspace ID (from path).
191
+ * Workspace ID.
196
192
  */
197
193
  workspaceId: string;
198
194
 
199
195
  /**
200
- * Tool set ID (from path). Accepts canonical ts\_… form or external_id:<value>
201
- * form (see common.proto "Path-parameter ID resolution").
196
+ * Tool set ID. Accepts the canonical ts\_… form or the external_id:<value> form.
202
197
  */
203
198
  toolSetId: string;
204
199
  }
205
200
 
206
201
  export interface ToolUpdateParams {
207
202
  /**
208
- * Path param: Workspace ID (from path).
203
+ * Path param: Workspace ID.
209
204
  */
210
205
  workspaceId: string;
211
206
 
212
207
  /**
213
- * Path param: Tool set ID (from path). Accepts canonical ts\_… form or
214
- * external_id:<value> form (see common.proto "Path-parameter ID resolution").
208
+ * Path param: Tool set ID. Accepts the canonical ts\_… form or the
209
+ * external_id:<value> form.
215
210
  */
216
211
  toolSetId: string;
217
212
 
@@ -236,7 +231,7 @@ export interface ToolUpdateParams {
236
231
 
237
232
  export interface ToolListParams extends CursorPaginationParams {
238
233
  /**
239
- * Path param: Workspace ID (from path).
234
+ * Path param: Workspace ID.
240
235
  */
241
236
  workspaceId: string;
242
237
 
@@ -287,13 +282,12 @@ export interface ToolListParams extends CursorPaginationParams {
287
282
 
288
283
  export interface ToolDeleteParams {
289
284
  /**
290
- * Workspace ID (from path).
285
+ * Workspace ID.
291
286
  */
292
287
  workspaceId: string;
293
288
 
294
289
  /**
295
- * Tool set ID (from path). Accepts canonical ts\_… form or external_id:<value>
296
- * form (see common.proto "Path-parameter ID resolution").
290
+ * Tool set ID. Accepts the canonical ts\_… form or the external_id:<value> form.
297
291
  */
298
292
  toolSetId: string;
299
293
  }
@@ -8,13 +8,9 @@ import { RequestOptions } from '../internal/request-options';
8
8
  import { path } from '../internal/utils/path';
9
9
 
10
10
  /**
11
- * UploadService issues short-lived presigned URLs for direct client-to-object-
12
- * storage uploads at the WORKSPACE level. Created uploads can be referenced by
13
- * id when creating or updating resources that accept binary content (e.g.,
14
- * MemoryEntry).
15
- *
16
- * Authentication: Bearer token (JWT)
17
- * Scope: Workspace-level operations
11
+ * Issue short-lived presigned URLs for direct client-to-object-storage
12
+ * uploads. Created uploads can be referenced by id when creating or updating
13
+ * resources that accept binary content (e.g., MemoryEntry).
18
14
  */
19
15
  export class Uploads extends APIResource {
20
16
  /**
@@ -36,14 +32,14 @@ export class Uploads extends APIResource {
36
32
  }
37
33
 
38
34
  /**
39
- * Upload is a workspace-scoped handle representing a single file upload flow.
40
- * Clients call CreateUpload to receive a short-lived presigned URL, PUT the file
41
- * directly to object storage, then reference the upload by id when creating or
42
- * updating resources that accept binary content.
35
+ * A handle representing a single file upload flow. Clients call CreateUpload to
36
+ * receive a short-lived presigned URL, PUT the file directly to object storage,
37
+ * then reference the upload by id when creating or updating resources that accept
38
+ * binary content.
43
39
  *
44
- * Uploads are one-shot: once consumed by a creating or updating resource, the
40
+ * Uploads are one-shot: once consumed by a creating or updating resource the
45
41
  * upload transitions to UPLOAD_STATUS_CONSUMED and cannot be reused. Unused
46
- * uploads expire and are garbage-collected by the runtime.
42
+ * uploads expire and are garbage-collected.
47
43
  */
48
44
  export interface Upload {
49
45
  info: UploadInfo;
@@ -58,9 +54,9 @@ export interface Upload {
58
54
 
59
55
  export interface UploadInfo {
60
56
  /**
61
- * Profile represents a human user at the account level. Profiles are
62
- * account-scoped resources that can be associated with multiple workspaces through
63
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
57
+ * A profile identifies a user or non-human principal (such as an API key) at the
58
+ * account level. Profiles are account-scoped and can be granted access to multiple
59
+ * workspaces.
64
60
  */
65
61
  createdBy?: AccountAPI.Profile;
66
62
 
@@ -121,7 +117,7 @@ export interface UploadCreateParams {
121
117
 
122
118
  export interface UploadRetrieveParams {
123
119
  /**
124
- * Workspace ID (from path).
120
+ * Workspace ID.
125
121
  */
126
122
  workspaceId: string;
127
123
  }
@@ -93,9 +93,9 @@ export interface WorkspaceSecret {
93
93
 
94
94
  export interface WorkspaceSecretInfo {
95
95
  /**
96
- * Profile represents a human user at the account level. Profiles are
97
- * account-scoped resources that can be associated with multiple workspaces through
98
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
96
+ * A profile identifies a user or non-human principal (such as an API key) at the
97
+ * account level. Profiles are account-scoped and can be granted access to multiple
98
+ * workspaces.
99
99
  */
100
100
  createdBy?: AccountAPI.Profile;
101
101
 
@@ -119,14 +119,14 @@ export interface WorkspaceSecretCreateParams {
119
119
 
120
120
  export interface WorkspaceSecretRetrieveParams {
121
121
  /**
122
- * Workspace ID (from path).
122
+ * The workspace the secret belongs to.
123
123
  */
124
124
  workspaceId: string;
125
125
  }
126
126
 
127
127
  export interface WorkspaceSecretUpdateParams {
128
128
  /**
129
- * Path param: Workspace ID (from path).
129
+ * Path param: The workspace the secret belongs to.
130
130
  */
131
131
  workspaceId: string;
132
132
 
@@ -144,7 +144,7 @@ export interface WorkspaceSecretUpdateParams {
144
144
  spec?: WorkspaceSecretSpec;
145
145
 
146
146
  /**
147
- * Body param: Fields to update
147
+ * Body param: Fields to update.
148
148
  */
149
149
  updateMask?: string;
150
150
  }
@@ -178,7 +178,7 @@ export interface WorkspaceSecretListParams extends CursorPaginationParams {
178
178
 
179
179
  export interface WorkspaceSecretDeleteParams {
180
180
  /**
181
- * Workspace ID (from path).
181
+ * The workspace the secret belongs to.
182
182
  */
183
183
  workspaceId: string;
184
184
  }
@@ -7,12 +7,8 @@ import { CursorPagination, type CursorPaginationParams, PagePromise } from '../c
7
7
  import { RequestOptions } from '../internal/request-options';
8
8
 
9
9
  /**
10
- * WorkspaceService manages workspaces at the ACCOUNT level.
11
- * This service is responsible for creating and listing workspaces within an account.
12
- * Workspaces provide organizational grouping for resources within an account.
13
- *
14
- * Authentication: Bearer token (JWT)
15
- * Scope: Account-level operations (manages workspaces themselves, not resources within workspaces)
10
+ * Manage workspaces within an account. Workspaces provide organizational
11
+ * grouping and isolation for resources such as agents, tools, and API keys.
16
12
  */
17
13
  export class Workspaces extends APIResource {
18
14
  /**
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.67.0'; // x-release-please-version
1
+ export const VERSION = '0.68.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.67.0";
1
+ export declare const VERSION = "0.68.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.67.0";
1
+ export declare const VERSION = "0.68.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.67.0'; // x-release-please-version
4
+ exports.VERSION = '0.68.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map