@cadenya/cadenya 0.66.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 (267) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +2 -2
  3. package/client.d.mts +42 -81
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +42 -81
  6. package/client.d.ts.map +1 -1
  7. package/client.js +24 -63
  8. package/client.js.map +1 -1
  9. package/client.mjs +24 -63
  10. package/client.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/account.d.mts +18 -22
  13. package/resources/account.d.mts.map +1 -1
  14. package/resources/account.d.ts +18 -22
  15. package/resources/account.d.ts.map +1 -1
  16. package/resources/account.js +2 -6
  17. package/resources/account.js.map +1 -1
  18. package/resources/account.mjs +2 -6
  19. package/resources/account.mjs.map +1 -1
  20. package/resources/agents/agents.d.mts +34 -21
  21. package/resources/agents/agents.d.mts.map +1 -1
  22. package/resources/agents/agents.d.ts +34 -21
  23. package/resources/agents/agents.d.ts.map +1 -1
  24. package/resources/agents/agents.js +17 -16
  25. package/resources/agents/agents.js.map +1 -1
  26. package/resources/agents/agents.mjs +17 -16
  27. package/resources/agents/agents.mjs.map +1 -1
  28. package/resources/agents/feedback.d.mts +15 -15
  29. package/resources/agents/feedback.d.mts.map +1 -1
  30. package/resources/agents/feedback.d.ts +15 -15
  31. package/resources/agents/feedback.d.ts.map +1 -1
  32. package/resources/agents/feedback.js +4 -8
  33. package/resources/agents/feedback.js.map +1 -1
  34. package/resources/agents/feedback.mjs +4 -8
  35. package/resources/agents/feedback.mjs.map +1 -1
  36. package/resources/agents/index.d.mts +1 -1
  37. package/resources/agents/index.d.mts.map +1 -1
  38. package/resources/agents/index.d.ts +1 -1
  39. package/resources/agents/index.d.ts.map +1 -1
  40. package/resources/agents/index.js.map +1 -1
  41. package/resources/agents/index.mjs.map +1 -1
  42. package/resources/agents/schedules.d.mts +44 -26
  43. package/resources/agents/schedules.d.mts.map +1 -1
  44. package/resources/agents/schedules.d.ts +44 -26
  45. package/resources/agents/schedules.d.ts.map +1 -1
  46. package/resources/agents/schedules.js +20 -19
  47. package/resources/agents/schedules.js.map +1 -1
  48. package/resources/agents/schedules.mjs +20 -19
  49. package/resources/agents/schedules.mjs.map +1 -1
  50. package/resources/agents/variations.d.mts +88 -43
  51. package/resources/agents/variations.d.mts.map +1 -1
  52. package/resources/agents/variations.d.ts +88 -43
  53. package/resources/agents/variations.d.ts.map +1 -1
  54. package/resources/agents/variations.js +31 -32
  55. package/resources/agents/variations.js.map +1 -1
  56. package/resources/agents/variations.mjs +31 -32
  57. package/resources/agents/variations.mjs.map +1 -1
  58. package/resources/agents/webhook-deliveries.d.mts +10 -11
  59. package/resources/agents/webhook-deliveries.d.mts.map +1 -1
  60. package/resources/agents/webhook-deliveries.d.ts +10 -11
  61. package/resources/agents/webhook-deliveries.d.ts.map +1 -1
  62. package/resources/agents/webhook-deliveries.js +4 -8
  63. package/resources/agents/webhook-deliveries.js.map +1 -1
  64. package/resources/agents/webhook-deliveries.mjs +4 -8
  65. package/resources/agents/webhook-deliveries.mjs.map +1 -1
  66. package/resources/api-keys.d.mts +48 -28
  67. package/resources/api-keys.d.mts.map +1 -1
  68. package/resources/api-keys.d.ts +48 -28
  69. package/resources/api-keys.d.ts.map +1 -1
  70. package/resources/api-keys.js +21 -17
  71. package/resources/api-keys.js.map +1 -1
  72. package/resources/api-keys.mjs +21 -17
  73. package/resources/api-keys.mjs.map +1 -1
  74. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.mts +20 -21
  75. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.mts.map +1 -1
  76. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.ts +20 -21
  77. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.ts.map +1 -1
  78. package/resources/bulk-workspace-resources/bulk-workspace-resources.js +13 -17
  79. package/resources/bulk-workspace-resources/bulk-workspace-resources.js.map +1 -1
  80. package/resources/bulk-workspace-resources/bulk-workspace-resources.mjs +13 -17
  81. package/resources/bulk-workspace-resources/bulk-workspace-resources.mjs.map +1 -1
  82. package/resources/bulk-workspace-resources/index.d.mts +1 -1
  83. package/resources/bulk-workspace-resources/index.d.mts.map +1 -1
  84. package/resources/bulk-workspace-resources/index.d.ts +1 -1
  85. package/resources/bulk-workspace-resources/index.d.ts.map +1 -1
  86. package/resources/bulk-workspace-resources/index.js.map +1 -1
  87. package/resources/bulk-workspace-resources/index.mjs.map +1 -1
  88. package/resources/bulk-workspace-resources/results.d.mts +30 -35
  89. package/resources/bulk-workspace-resources/results.d.mts.map +1 -1
  90. package/resources/bulk-workspace-resources/results.d.ts +30 -35
  91. package/resources/bulk-workspace-resources/results.d.ts.map +1 -1
  92. package/resources/bulk-workspace-resources/results.js +6 -10
  93. package/resources/bulk-workspace-resources/results.js.map +1 -1
  94. package/resources/bulk-workspace-resources/results.mjs +6 -10
  95. package/resources/bulk-workspace-resources/results.mjs.map +1 -1
  96. package/resources/index.d.mts +9 -9
  97. package/resources/index.d.mts.map +1 -1
  98. package/resources/index.d.ts +9 -9
  99. package/resources/index.d.ts.map +1 -1
  100. package/resources/index.js.map +1 -1
  101. package/resources/index.mjs +1 -1
  102. package/resources/index.mjs.map +1 -1
  103. package/resources/memory-layers/entries.d.mts +40 -33
  104. package/resources/memory-layers/entries.d.mts.map +1 -1
  105. package/resources/memory-layers/entries.d.ts +40 -33
  106. package/resources/memory-layers/entries.d.ts.map +1 -1
  107. package/resources/memory-layers/entries.js +19 -23
  108. package/resources/memory-layers/entries.js.map +1 -1
  109. package/resources/memory-layers/entries.mjs +19 -23
  110. package/resources/memory-layers/entries.mjs.map +1 -1
  111. package/resources/memory-layers/index.d.mts +1 -1
  112. package/resources/memory-layers/index.d.mts.map +1 -1
  113. package/resources/memory-layers/index.d.ts +1 -1
  114. package/resources/memory-layers/index.d.ts.map +1 -1
  115. package/resources/memory-layers/index.js.map +1 -1
  116. package/resources/memory-layers/index.mjs.map +1 -1
  117. package/resources/memory-layers/memory-layers.d.mts +33 -22
  118. package/resources/memory-layers/memory-layers.d.mts.map +1 -1
  119. package/resources/memory-layers/memory-layers.d.ts +33 -22
  120. package/resources/memory-layers/memory-layers.d.ts.map +1 -1
  121. package/resources/memory-layers/memory-layers.js +17 -20
  122. package/resources/memory-layers/memory-layers.js.map +1 -1
  123. package/resources/memory-layers/memory-layers.mjs +17 -20
  124. package/resources/memory-layers/memory-layers.mjs.map +1 -1
  125. package/resources/models.d.mts +18 -12
  126. package/resources/models.d.mts.map +1 -1
  127. package/resources/models.d.ts +18 -12
  128. package/resources/models.d.ts.map +1 -1
  129. package/resources/models.js +14 -13
  130. package/resources/models.js.map +1 -1
  131. package/resources/models.mjs +14 -13
  132. package/resources/models.mjs.map +1 -1
  133. package/resources/objectives/feedback.d.mts +19 -8
  134. package/resources/objectives/feedback.d.mts.map +1 -1
  135. package/resources/objectives/feedback.d.ts +19 -8
  136. package/resources/objectives/feedback.d.ts.map +1 -1
  137. package/resources/objectives/feedback.js +9 -4
  138. package/resources/objectives/feedback.js.map +1 -1
  139. package/resources/objectives/feedback.mjs +9 -4
  140. package/resources/objectives/feedback.mjs.map +1 -1
  141. package/resources/objectives/index.d.mts +1 -1
  142. package/resources/objectives/index.d.mts.map +1 -1
  143. package/resources/objectives/index.d.ts +1 -1
  144. package/resources/objectives/index.d.ts.map +1 -1
  145. package/resources/objectives/index.js.map +1 -1
  146. package/resources/objectives/index.mjs.map +1 -1
  147. package/resources/objectives/objectives.d.mts +63 -44
  148. package/resources/objectives/objectives.d.mts.map +1 -1
  149. package/resources/objectives/objectives.d.ts +63 -44
  150. package/resources/objectives/objectives.d.ts.map +1 -1
  151. package/resources/objectives/objectives.js +31 -16
  152. package/resources/objectives/objectives.js.map +1 -1
  153. package/resources/objectives/objectives.mjs +31 -16
  154. package/resources/objectives/objectives.mjs.map +1 -1
  155. package/resources/objectives/tasks.d.mts +7 -2
  156. package/resources/objectives/tasks.d.mts.map +1 -1
  157. package/resources/objectives/tasks.d.ts +7 -2
  158. package/resources/objectives/tasks.d.ts.map +1 -1
  159. package/resources/objectives/tasks.js +5 -4
  160. package/resources/objectives/tasks.js.map +1 -1
  161. package/resources/objectives/tasks.mjs +5 -4
  162. package/resources/objectives/tasks.mjs.map +1 -1
  163. package/resources/objectives/tool-calls.d.mts +18 -9
  164. package/resources/objectives/tool-calls.d.mts.map +1 -1
  165. package/resources/objectives/tool-calls.d.ts +18 -9
  166. package/resources/objectives/tool-calls.d.ts.map +1 -1
  167. package/resources/objectives/tool-calls.js +7 -12
  168. package/resources/objectives/tool-calls.js.map +1 -1
  169. package/resources/objectives/tool-calls.mjs +7 -12
  170. package/resources/objectives/tool-calls.mjs.map +1 -1
  171. package/resources/objectives/tools.d.mts +5 -1
  172. package/resources/objectives/tools.d.mts.map +1 -1
  173. package/resources/objectives/tools.d.ts +5 -1
  174. package/resources/objectives/tools.d.ts.map +1 -1
  175. package/resources/objectives/tools.js +3 -2
  176. package/resources/objectives/tools.js.map +1 -1
  177. package/resources/objectives/tools.mjs +3 -2
  178. package/resources/objectives/tools.mjs.map +1 -1
  179. package/resources/search.d.mts +1 -1
  180. package/resources/search.d.mts.map +1 -1
  181. package/resources/search.d.ts +1 -1
  182. package/resources/search.d.ts.map +1 -1
  183. package/resources/search.js +6 -2
  184. package/resources/search.js.map +1 -1
  185. package/resources/search.mjs +6 -2
  186. package/resources/search.mjs.map +1 -1
  187. package/resources/tool-sets/index.d.mts +1 -1
  188. package/resources/tool-sets/index.d.mts.map +1 -1
  189. package/resources/tool-sets/index.d.ts +1 -1
  190. package/resources/tool-sets/index.d.ts.map +1 -1
  191. package/resources/tool-sets/index.js.map +1 -1
  192. package/resources/tool-sets/index.mjs.map +1 -1
  193. package/resources/tool-sets/tool-sets.d.mts +66 -43
  194. package/resources/tool-sets/tool-sets.d.mts.map +1 -1
  195. package/resources/tool-sets/tool-sets.d.ts +66 -43
  196. package/resources/tool-sets/tool-sets.d.ts.map +1 -1
  197. package/resources/tool-sets/tool-sets.js +23 -23
  198. package/resources/tool-sets/tool-sets.js.map +1 -1
  199. package/resources/tool-sets/tool-sets.mjs +23 -23
  200. package/resources/tool-sets/tool-sets.mjs.map +1 -1
  201. package/resources/tool-sets/tools.d.mts +50 -31
  202. package/resources/tool-sets/tools.d.mts.map +1 -1
  203. package/resources/tool-sets/tools.d.ts +50 -31
  204. package/resources/tool-sets/tools.d.ts.map +1 -1
  205. package/resources/tool-sets/tools.js +22 -21
  206. package/resources/tool-sets/tools.js.map +1 -1
  207. package/resources/tool-sets/tools.mjs +22 -21
  208. package/resources/tool-sets/tools.mjs.map +1 -1
  209. package/resources/uploads.d.mts +21 -19
  210. package/resources/uploads.d.mts.map +1 -1
  211. package/resources/uploads.d.ts +21 -19
  212. package/resources/uploads.d.ts.map +1 -1
  213. package/resources/uploads.js +8 -11
  214. package/resources/uploads.js.map +1 -1
  215. package/resources/uploads.mjs +8 -11
  216. package/resources/uploads.mjs.map +1 -1
  217. package/resources/workspace-secrets.d.mts +33 -13
  218. package/resources/workspace-secrets.d.mts.map +1 -1
  219. package/resources/workspace-secrets.d.ts +33 -13
  220. package/resources/workspace-secrets.d.ts.map +1 -1
  221. package/resources/workspace-secrets.js +16 -13
  222. package/resources/workspace-secrets.js.map +1 -1
  223. package/resources/workspace-secrets.mjs +16 -13
  224. package/resources/workspace-secrets.mjs.map +1 -1
  225. package/resources/workspaces.d.mts +2 -6
  226. package/resources/workspaces.d.mts.map +1 -1
  227. package/resources/workspaces.d.ts +2 -6
  228. package/resources/workspaces.d.ts.map +1 -1
  229. package/resources/workspaces.js +2 -6
  230. package/resources/workspaces.js.map +1 -1
  231. package/resources/workspaces.mjs +2 -6
  232. package/resources/workspaces.mjs.map +1 -1
  233. package/src/client.ts +54 -63
  234. package/src/resources/account.ts +18 -22
  235. package/src/resources/agents/agents.ts +49 -24
  236. package/src/resources/agents/feedback.ts +18 -16
  237. package/src/resources/agents/index.ts +2 -0
  238. package/src/resources/agents/schedules.ts +69 -37
  239. package/src/resources/agents/variations.ts +141 -73
  240. package/src/resources/agents/webhook-deliveries.ts +13 -12
  241. package/src/resources/api-keys.ts +67 -32
  242. package/src/resources/bulk-workspace-resources/bulk-workspace-resources.ts +40 -25
  243. package/src/resources/bulk-workspace-resources/index.ts +1 -0
  244. package/src/resources/bulk-workspace-resources/results.ts +33 -36
  245. package/src/resources/index.ts +22 -1
  246. package/src/resources/memory-layers/entries.ts +67 -44
  247. package/src/resources/memory-layers/index.ts +2 -0
  248. package/src/resources/memory-layers/memory-layers.ts +53 -25
  249. package/src/resources/models.ts +28 -13
  250. package/src/resources/objectives/feedback.ts +29 -11
  251. package/src/resources/objectives/index.ts +1 -0
  252. package/src/resources/objectives/objectives.ts +100 -50
  253. package/src/resources/objectives/tasks.ts +16 -5
  254. package/src/resources/objectives/tool-calls.ts +33 -20
  255. package/src/resources/objectives/tools.ts +9 -3
  256. package/src/resources/search.ts +6 -1
  257. package/src/resources/tool-sets/index.ts +2 -0
  258. package/src/resources/tool-sets/tool-sets.ts +88 -50
  259. package/src/resources/tool-sets/tools.ts +75 -42
  260. package/src/resources/uploads.ts +25 -20
  261. package/src/resources/workspace-secrets.ts +60 -19
  262. package/src/resources/workspaces.ts +2 -6
  263. package/src/version.ts +1 -1
  264. package/version.d.mts +1 -1
  265. package/version.d.ts +1 -1
  266. package/version.js +1 -1
  267. package/version.mjs +1 -1
@@ -8,12 +8,7 @@ import { RequestOptions } from '../../internal/request-options';
8
8
  import { path } from '../../internal/utils/path';
9
9
 
10
10
  /**
11
- * AgentService manages AI agents at the WORKSPACE level.
12
- * Agents are workspace-scoped resources that define AI behavior and tool access.
13
- * All operations are implicitly scoped to the workspace determined by the JWT token.
14
- *
15
- * Authentication: Bearer token (JWT)
16
- * Scope: Workspace-level operations
11
+ * Manage AI agents within a workspace. Agents define AI behavior and tool access.
17
12
  */
18
13
  export class Feedback extends APIResource {
19
14
  /**
@@ -23,11 +18,12 @@ export class Feedback extends APIResource {
23
18
  */
24
19
  list(
25
20
  agentID: string,
26
- query: FeedbackListParams | null | undefined = {},
21
+ params: FeedbackListParams,
27
22
  options?: RequestOptions,
28
23
  ): PagePromise<ObjectiveFeedbacksCursorPagination, ObjectivesFeedbackAPI.ObjectiveFeedback> {
24
+ const { workspaceId, ...query } = params;
29
25
  return this._client.getAPIList(
30
- path`/v1/agents/${agentID}/feedback`,
26
+ path`/v1/workspaces/${workspaceId}/agents/${agentID}/feedback`,
31
27
  CursorPagination<ObjectivesFeedbackAPI.ObjectiveFeedback>,
32
28
  { query, ...options },
33
29
  );
@@ -36,34 +32,40 @@ export class Feedback extends APIResource {
36
32
 
37
33
  export interface FeedbackListParams extends CursorPaginationParams {
38
34
  /**
39
- * Optional filter to limit results to feedback on objectives run by a single agent
40
- * variation. Supports "external_id:" prefix for external IDs.
35
+ * Path param
36
+ */
37
+ workspaceId: string;
38
+
39
+ /**
40
+ * Query param: Optional filter to limit results to feedback on objectives run by a
41
+ * single agent variation. Supports "external_id:" prefix for external IDs.
41
42
  */
42
43
  agentVariationId?: string;
43
44
 
44
45
  /**
45
- * Inclusive lower bound on feedback creation time.
46
+ * Query param: Inclusive lower bound on feedback creation time.
46
47
  */
47
48
  createdAfter?: string;
48
49
 
49
50
  /**
50
- * Exclusive upper bound on feedback creation time.
51
+ * Query param: Exclusive upper bound on feedback creation time.
51
52
  */
52
53
  createdBefore?: string;
53
54
 
54
55
  /**
55
- * When set to true you may use more of your alloted API rate-limit
56
+ * Query param: When set to true you may use more of your alloted API rate-limit
56
57
  */
57
58
  includeInfo?: boolean;
58
59
 
59
60
  /**
60
- * Free-text search applied to the feedback comment. Case-insensitive substring
61
- * match.
61
+ * Query param: Free-text search applied to the feedback comment. Case-insensitive
62
+ * substring match.
62
63
  */
63
64
  query?: string;
64
65
 
65
66
  /**
66
- * Filter by sentiment. UNSPECIFIED returns feedback regardless of score.
67
+ * Query param: Filter by sentiment. UNSPECIFIED returns feedback regardless of
68
+ * score.
67
69
  */
68
70
  sentiment?:
69
71
  | 'FEEDBACK_SENTIMENT_UNSPECIFIED'
@@ -7,8 +7,10 @@ export {
7
7
  type AgentSpec,
8
8
  type Page,
9
9
  type AgentCreateParams,
10
+ type AgentRetrieveParams,
10
11
  type AgentUpdateParams,
11
12
  type AgentListParams,
13
+ type AgentDeleteParams,
12
14
  type AgentsCursorPagination,
13
15
  } from './agents';
14
16
  export { Feedback, type FeedbackListParams } from './feedback';
@@ -10,35 +10,38 @@ import { RequestOptions } from '../../internal/request-options';
10
10
  import { path } from '../../internal/utils/path';
11
11
 
12
12
  /**
13
- * AgentScheduleService manages recurring schedules attached to agents.
14
- * Schedules trigger objectives on a cadence defined by AgentScheduleSpec.Schedule.
15
- * All operations are implicitly scoped to the workspace determined by the JWT token.
16
- *
17
- * Authentication: Bearer token (JWT)
18
- * Scope: Workspace-level operations
13
+ * Manage recurring schedules attached to agents. Schedules trigger objectives
14
+ * on a cadence defined by AgentScheduleSpec.Schedule.
19
15
  */
20
16
  export class Schedules extends APIResource {
21
17
  /**
22
18
  * Creates a new schedule for an agent
23
19
  */
24
- create(agentID: string, body: ScheduleCreateParams, options?: RequestOptions): APIPromise<AgentSchedule> {
25
- return this._client.post(path`/v1/agents/${agentID}/schedules`, { body, ...options });
20
+ create(agentID: string, params: ScheduleCreateParams, options?: RequestOptions): APIPromise<AgentSchedule> {
21
+ const { workspaceId, ...body } = params;
22
+ return this._client.post(path`/v1/workspaces/${workspaceId}/agents/${agentID}/schedules`, {
23
+ body,
24
+ ...options,
25
+ });
26
26
  }
27
27
 
28
28
  /**
29
29
  * Retrieves a schedule by ID from an agent
30
30
  */
31
31
  retrieve(id: string, params: ScheduleRetrieveParams, options?: RequestOptions): APIPromise<AgentSchedule> {
32
- const { agentId } = params;
33
- return this._client.get(path`/v1/agents/${agentId}/schedules/${id}`, options);
32
+ const { workspaceId, agentId } = params;
33
+ return this._client.get(path`/v1/workspaces/${workspaceId}/agents/${agentId}/schedules/${id}`, options);
34
34
  }
35
35
 
36
36
  /**
37
37
  * Updates a schedule for an agent
38
38
  */
39
39
  update(id: string, params: ScheduleUpdateParams, options?: RequestOptions): APIPromise<AgentSchedule> {
40
- const { agentId, ...body } = params;
41
- return this._client.patch(path`/v1/agents/${agentId}/schedules/${id}`, { body, ...options });
40
+ const { workspaceId, agentId, ...body } = params;
41
+ return this._client.patch(path`/v1/workspaces/${workspaceId}/agents/${agentId}/schedules/${id}`, {
42
+ body,
43
+ ...options,
44
+ });
42
45
  }
43
46
 
44
47
  /**
@@ -46,21 +49,23 @@ export class Schedules extends APIResource {
46
49
  */
47
50
  list(
48
51
  agentID: string,
49
- query: ScheduleListParams | null | undefined = {},
52
+ params: ScheduleListParams,
50
53
  options?: RequestOptions,
51
54
  ): PagePromise<AgentSchedulesCursorPagination, AgentSchedule> {
52
- return this._client.getAPIList(path`/v1/agents/${agentID}/schedules`, CursorPagination<AgentSchedule>, {
53
- query,
54
- ...options,
55
- });
55
+ const { workspaceId, ...query } = params;
56
+ return this._client.getAPIList(
57
+ path`/v1/workspaces/${workspaceId}/agents/${agentID}/schedules`,
58
+ CursorPagination<AgentSchedule>,
59
+ { query, ...options },
60
+ );
56
61
  }
57
62
 
58
63
  /**
59
64
  * Deletes a schedule from an agent
60
65
  */
61
66
  delete(id: string, params: ScheduleDeleteParams, options?: RequestOptions): APIPromise<void> {
62
- const { agentId } = params;
63
- return this._client.delete(path`/v1/agents/${agentId}/schedules/${id}`, {
67
+ const { workspaceId, agentId } = params;
68
+ return this._client.delete(path`/v1/workspaces/${workspaceId}/agents/${agentId}/schedules/${id}`, {
64
69
  ...options,
65
70
  headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
66
71
  });
@@ -95,9 +100,9 @@ export interface AgentSchedule {
95
100
  */
96
101
  export interface AgentScheduleInfo {
97
102
  /**
98
- * Profile represents a human user at the account level. Profiles are
99
- * account-scoped resources that can be associated with multiple workspaces through
100
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
103
+ * A profile identifies a user or non-human principal (such as an API key) at the
104
+ * account level. Profiles are account-scoped and can be granted access to multiple
105
+ * workspaces.
101
106
  */
102
107
  createdBy?: AccountAPI.Profile;
103
108
 
@@ -251,30 +256,46 @@ export interface ScheduleRange {
251
256
 
252
257
  export interface ScheduleCreateParams {
253
258
  /**
254
- * CreateResourceMetadata contains the user-provided fields for creating a
255
- * workspace-scoped resource. Read-only fields (id, account_id, workspace_id,
256
- * profile_id, created_at) are excluded since they are set by the server.
259
+ * Path param: Workspace ID.
260
+ */
261
+ workspaceId: string;
262
+
263
+ /**
264
+ * Body param: CreateResourceMetadata contains the user-provided fields for
265
+ * creating a workspace-scoped resource. Read-only fields (id, account_id,
266
+ * workspace_id, profile_id, created_at) are excluded since they are set by the
267
+ * server.
257
268
  */
258
269
  metadata: Shared.CreateResourceMetadata;
259
270
 
260
271
  /**
261
- * AgentScheduleSpec is the user-provided configuration for a schedule.
272
+ * Body param: AgentScheduleSpec is the user-provided configuration for a schedule.
262
273
  */
263
274
  spec: AgentScheduleSpec;
264
275
  }
265
276
 
266
277
  export interface ScheduleRetrieveParams {
267
278
  /**
268
- * Agent ID (from path). Accepts canonical agent\_… form or external_id:<value>
269
- * form (see common.proto "Path-parameter ID resolution").
279
+ * Workspace ID.
280
+ */
281
+ workspaceId: string;
282
+
283
+ /**
284
+ * Agent ID. Accepts the canonical `agent_…` form or the `external_id:<value>`
285
+ * form.
270
286
  */
271
287
  agentId: string;
272
288
  }
273
289
 
274
290
  export interface ScheduleUpdateParams {
275
291
  /**
276
- * Path param: Agent ID (from path). Accepts canonical agent\_… form or
277
- * external_id:<value> form (see common.proto "Path-parameter ID resolution").
292
+ * Path param: Workspace ID.
293
+ */
294
+ workspaceId: string;
295
+
296
+ /**
297
+ * Path param: Agent ID. Accepts the canonical `agent_…` form or the
298
+ * `external_id:<value>` form.
278
299
  */
279
300
  agentId: string;
280
301
 
@@ -299,35 +320,46 @@ export interface ScheduleUpdateParams {
299
320
 
300
321
  export interface ScheduleListParams extends CursorPaginationParams {
301
322
  /**
302
- * Filter by bundle_key — return only resources owned by this bundle.
323
+ * Path param: Workspace ID.
324
+ */
325
+ workspaceId: string;
326
+
327
+ /**
328
+ * Query param: Filter by bundle_key — return only resources owned by this bundle.
303
329
  */
304
330
  bundleKey?: string;
305
331
 
306
332
  /**
307
- * When set to true you may use more of your alloted API rate-limit.
333
+ * Query param: When true, the `info` field on each returned schedule is populated.
334
+ * Requests with this flag count more against your rate limit.
308
335
  */
309
336
  includeInfo?: boolean;
310
337
 
311
338
  /**
312
- * Filter expression (query param: prefix).
339
+ * Query param: Filter expression (query param: prefix).
313
340
  */
314
341
  prefix?: string;
315
342
 
316
343
  /**
317
- * Free-form search query.
344
+ * Query param: Free-form search query.
318
345
  */
319
346
  query?: string;
320
347
 
321
348
  /**
322
- * Sort order for results (asc or desc by creation time).
349
+ * Query param: Sort order for results (asc or desc by creation time).
323
350
  */
324
351
  sortOrder?: string;
325
352
  }
326
353
 
327
354
  export interface ScheduleDeleteParams {
328
355
  /**
329
- * Agent ID (from path). Accepts canonical agent\_… form or external_id:<value>
330
- * form (see common.proto "Path-parameter ID resolution").
356
+ * Workspace ID.
357
+ */
358
+ workspaceId: string;
359
+
360
+ /**
361
+ * Agent ID. Accepts the canonical `agent_…` form or the `external_id:<value>`
362
+ * form.
331
363
  */
332
364
  agentId: string;
333
365
  }