@cadenya/cadenya 0.67.0 → 0.69.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 (222) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/client.d.mts +28 -67
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +28 -67
  5. package/client.d.ts.map +1 -1
  6. package/client.js +25 -64
  7. package/client.js.map +1 -1
  8. package/client.mjs +25 -64
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/account.d.mts +34 -33
  12. package/resources/account.d.mts.map +1 -1
  13. package/resources/account.d.ts +34 -33
  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/access.d.mts +47 -0
  60. package/resources/api-keys/access.d.mts.map +1 -0
  61. package/resources/api-keys/access.d.ts +47 -0
  62. package/resources/api-keys/access.d.ts.map +1 -0
  63. package/resources/api-keys/access.js +41 -0
  64. package/resources/api-keys/access.js.map +1 -0
  65. package/resources/api-keys/access.mjs +37 -0
  66. package/resources/api-keys/access.mjs.map +1 -0
  67. package/resources/api-keys/api-keys.d.mts +213 -0
  68. package/resources/api-keys/api-keys.d.mts.map +1 -0
  69. package/resources/api-keys/api-keys.d.ts +213 -0
  70. package/resources/api-keys/api-keys.d.ts.map +1 -0
  71. package/resources/api-keys/api-keys.js +65 -0
  72. package/resources/api-keys/api-keys.js.map +1 -0
  73. package/resources/api-keys/api-keys.mjs +60 -0
  74. package/resources/api-keys/api-keys.mjs.map +1 -0
  75. package/resources/api-keys/index.d.mts +3 -0
  76. package/resources/api-keys/index.d.mts.map +1 -0
  77. package/resources/api-keys/index.d.ts +3 -0
  78. package/resources/api-keys/index.d.ts.map +1 -0
  79. package/resources/api-keys/index.js +9 -0
  80. package/resources/api-keys/index.js.map +1 -0
  81. package/resources/api-keys/index.mjs +4 -0
  82. package/resources/api-keys/index.mjs.map +1 -0
  83. package/resources/api-keys.d.mts +1 -154
  84. package/resources/api-keys.d.mts.map +1 -1
  85. package/resources/api-keys.d.ts +1 -154
  86. package/resources/api-keys.d.ts.map +1 -1
  87. package/resources/api-keys.js +2 -62
  88. package/resources/api-keys.js.map +1 -1
  89. package/resources/api-keys.mjs +1 -60
  90. package/resources/api-keys.mjs.map +1 -1
  91. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.mts +11 -18
  92. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.mts.map +1 -1
  93. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.ts +11 -18
  94. package/resources/bulk-workspace-resources/bulk-workspace-resources.d.ts.map +1 -1
  95. package/resources/bulk-workspace-resources/bulk-workspace-resources.js +3 -8
  96. package/resources/bulk-workspace-resources/bulk-workspace-resources.js.map +1 -1
  97. package/resources/bulk-workspace-resources/bulk-workspace-resources.mjs +3 -8
  98. package/resources/bulk-workspace-resources/bulk-workspace-resources.mjs.map +1 -1
  99. package/resources/bulk-workspace-resources/results.d.mts +23 -32
  100. package/resources/bulk-workspace-resources/results.d.mts.map +1 -1
  101. package/resources/bulk-workspace-resources/results.d.ts +23 -32
  102. package/resources/bulk-workspace-resources/results.d.ts.map +1 -1
  103. package/resources/bulk-workspace-resources/results.js +3 -8
  104. package/resources/bulk-workspace-resources/results.js.map +1 -1
  105. package/resources/bulk-workspace-resources/results.mjs +3 -8
  106. package/resources/bulk-workspace-resources/results.mjs.map +1 -1
  107. package/resources/index.d.mts +2 -2
  108. package/resources/index.d.mts.map +1 -1
  109. package/resources/index.d.ts +2 -2
  110. package/resources/index.d.ts.map +1 -1
  111. package/resources/index.js +1 -1
  112. package/resources/index.js.map +1 -1
  113. package/resources/index.mjs +1 -1
  114. package/resources/index.mjs.map +1 -1
  115. package/resources/memory-layers/entries.d.mts +14 -28
  116. package/resources/memory-layers/entries.d.mts.map +1 -1
  117. package/resources/memory-layers/entries.d.ts +14 -28
  118. package/resources/memory-layers/entries.d.ts.map +1 -1
  119. package/resources/memory-layers/entries.js +4 -10
  120. package/resources/memory-layers/entries.js.map +1 -1
  121. package/resources/memory-layers/entries.mjs +4 -10
  122. package/resources/memory-layers/entries.mjs.map +1 -1
  123. package/resources/memory-layers/memory-layers.d.mts +8 -20
  124. package/resources/memory-layers/memory-layers.d.mts.map +1 -1
  125. package/resources/memory-layers/memory-layers.d.ts +8 -20
  126. package/resources/memory-layers/memory-layers.d.ts.map +1 -1
  127. package/resources/memory-layers/memory-layers.js +4 -10
  128. package/resources/memory-layers/memory-layers.js.map +1 -1
  129. package/resources/memory-layers/memory-layers.mjs +4 -10
  130. package/resources/memory-layers/memory-layers.mjs.map +1 -1
  131. package/resources/models.d.mts +5 -9
  132. package/resources/models.d.mts.map +1 -1
  133. package/resources/models.d.ts +5 -9
  134. package/resources/models.d.ts.map +1 -1
  135. package/resources/models.js +3 -7
  136. package/resources/models.js.map +1 -1
  137. package/resources/models.mjs +3 -7
  138. package/resources/models.mjs.map +1 -1
  139. package/resources/objectives/feedback.d.mts +5 -5
  140. package/resources/objectives/feedback.d.ts +5 -5
  141. package/resources/objectives/objectives.d.mts +22 -31
  142. package/resources/objectives/objectives.d.mts.map +1 -1
  143. package/resources/objectives/objectives.d.ts +22 -31
  144. package/resources/objectives/objectives.d.ts.map +1 -1
  145. package/resources/objectives/objectives.js.map +1 -1
  146. package/resources/objectives/objectives.mjs.map +1 -1
  147. package/resources/objectives/tasks.d.mts +1 -4
  148. package/resources/objectives/tasks.d.mts.map +1 -1
  149. package/resources/objectives/tasks.d.ts +1 -4
  150. package/resources/objectives/tasks.d.ts.map +1 -1
  151. package/resources/objectives/tool-calls.d.mts +8 -11
  152. package/resources/objectives/tool-calls.d.mts.map +1 -1
  153. package/resources/objectives/tool-calls.d.ts +8 -11
  154. package/resources/objectives/tool-calls.d.ts.map +1 -1
  155. package/resources/objectives/tools.d.mts +1 -1
  156. package/resources/objectives/tools.d.ts +1 -1
  157. package/resources/tool-sets/tool-sets.d.mts +31 -35
  158. package/resources/tool-sets/tool-sets.d.mts.map +1 -1
  159. package/resources/tool-sets/tool-sets.d.ts +31 -35
  160. package/resources/tool-sets/tool-sets.d.ts.map +1 -1
  161. package/resources/tool-sets/tool-sets.js +4 -8
  162. package/resources/tool-sets/tool-sets.js.map +1 -1
  163. package/resources/tool-sets/tool-sets.mjs +4 -8
  164. package/resources/tool-sets/tool-sets.mjs.map +1 -1
  165. package/resources/tool-sets/tools.d.mts +16 -22
  166. package/resources/tool-sets/tools.d.mts.map +1 -1
  167. package/resources/tool-sets/tools.d.ts +16 -22
  168. package/resources/tool-sets/tools.d.ts.map +1 -1
  169. package/resources/tool-sets/tools.js +4 -8
  170. package/resources/tool-sets/tools.js.map +1 -1
  171. package/resources/tool-sets/tools.mjs +4 -8
  172. package/resources/tool-sets/tools.mjs.map +1 -1
  173. package/resources/uploads.d.mts +13 -17
  174. package/resources/uploads.d.mts.map +1 -1
  175. package/resources/uploads.d.ts +13 -17
  176. package/resources/uploads.d.ts.map +1 -1
  177. package/resources/uploads.js +3 -7
  178. package/resources/uploads.js.map +1 -1
  179. package/resources/uploads.mjs +3 -7
  180. package/resources/uploads.mjs.map +1 -1
  181. package/resources/workspace-secrets.d.mts +7 -7
  182. package/resources/workspace-secrets.d.ts +7 -7
  183. package/resources/workspaces.d.mts +2 -6
  184. package/resources/workspaces.d.mts.map +1 -1
  185. package/resources/workspaces.d.ts +2 -6
  186. package/resources/workspaces.d.ts.map +1 -1
  187. package/resources/workspaces.js +2 -6
  188. package/resources/workspaces.js.map +1 -1
  189. package/resources/workspaces.mjs +2 -6
  190. package/resources/workspaces.mjs.map +1 -1
  191. package/src/client.ts +36 -79
  192. package/src/resources/account.ts +35 -32
  193. package/src/resources/agents/agents.ts +9 -13
  194. package/src/resources/agents/feedback.ts +2 -7
  195. package/src/resources/agents/schedules.ts +18 -21
  196. package/src/resources/agents/variations.ts +48 -45
  197. package/src/resources/agents/webhook-deliveries.ts +4 -9
  198. package/src/resources/api-keys/access.ts +79 -0
  199. package/src/resources/api-keys/api-keys.ts +282 -0
  200. package/src/resources/api-keys/index.ts +13 -0
  201. package/src/resources/api-keys.ts +1 -221
  202. package/src/resources/bulk-workspace-resources/bulk-workspace-resources.ts +11 -18
  203. package/src/resources/bulk-workspace-resources/results.ts +23 -32
  204. package/src/resources/index.ts +2 -4
  205. package/src/resources/memory-layers/entries.ts +14 -28
  206. package/src/resources/memory-layers/memory-layers.ts +8 -20
  207. package/src/resources/models.ts +5 -9
  208. package/src/resources/objectives/feedback.ts +5 -5
  209. package/src/resources/objectives/objectives.ts +22 -31
  210. package/src/resources/objectives/tasks.ts +1 -4
  211. package/src/resources/objectives/tool-calls.ts +8 -11
  212. package/src/resources/objectives/tools.ts +1 -1
  213. package/src/resources/tool-sets/tool-sets.ts +31 -35
  214. package/src/resources/tool-sets/tools.ts +16 -22
  215. package/src/resources/uploads.ts +13 -17
  216. package/src/resources/workspace-secrets.ts +7 -7
  217. package/src/resources/workspaces.ts +2 -6
  218. package/src/version.ts +1 -1
  219. package/version.d.mts +1 -1
  220. package/version.d.ts +1 -1
  221. package/version.js +1 -1
  222. package/version.mjs +1 -1
@@ -5,12 +5,8 @@ exports.Workspaces = void 0;
5
5
  const resource_1 = require("../core/resource.js");
6
6
  const pagination_1 = require("../core/pagination.js");
7
7
  /**
8
- * WorkspaceService manages workspaces at the ACCOUNT level.
9
- * This service is responsible for creating and listing workspaces within an account.
10
- * Workspaces provide organizational grouping for resources within an account.
11
- *
12
- * Authentication: Bearer token (JWT)
13
- * Scope: Account-level operations (manages workspaces themselves, not resources within workspaces)
8
+ * Manage workspaces within an account. Workspaces provide organizational
9
+ * grouping and isolation for resources such as agents, tools, and API keys.
14
10
  */
15
11
  class Workspaces extends resource_1.APIResource {
16
12
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"workspaces.js","sourceRoot":"","sources":["../src/resources/workspaces.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgG;AAGhG;;;;;;;GAOG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;OAEG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,6BAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,OAAwB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAlBD,gCAkBC"}
1
+ {"version":3,"file":"workspaces.js","sourceRoot":"","sources":["../src/resources/workspaces.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,sDAAgG;AAGhG;;;GAGG;AACH,MAAa,UAAW,SAAQ,sBAAW;IACzC;;OAEG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,6BAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,OAAwB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAlBD,gCAkBC"}
@@ -2,12 +2,8 @@
2
2
  import { APIResource } from "../core/resource.mjs";
3
3
  import { CursorPagination } from "../core/pagination.mjs";
4
4
  /**
5
- * WorkspaceService manages workspaces at the ACCOUNT level.
6
- * This service is responsible for creating and listing workspaces within an account.
7
- * Workspaces provide organizational grouping for resources within an account.
8
- *
9
- * Authentication: Bearer token (JWT)
10
- * Scope: Account-level operations (manages workspaces themselves, not resources within workspaces)
5
+ * Manage workspaces within an account. Workspaces provide organizational
6
+ * grouping and isolation for resources such as agents, tools, and API keys.
11
7
  */
12
8
  export class Workspaces extends APIResource {
13
9
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"workspaces.mjs","sourceRoot":"","sources":["../src/resources/workspaces.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,gBAAgB,EAA4C;AAGrE;;;;;;;GAOG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,gBAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,OAAwB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}
1
+ {"version":3,"file":"workspaces.mjs","sourceRoot":"","sources":["../src/resources/workspaces.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,gBAAgB,EAA4C;AAGrE;;;GAGG;AACH,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC;;OAEG;IACH,IAAI,CACF,QAAgD,EAAE,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAA,gBAA2B,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvG,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,OAAwB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF"}
package/src/client.ts CHANGED
@@ -21,25 +21,13 @@ import * as API from './resources/index';
21
21
  import { APIPromise } from './core/api-promise';
22
22
  import {
23
23
  Account,
24
+ AccountInfo,
24
25
  AccountResource,
25
26
  AccountSpec,
26
27
  Profile,
27
28
  ProfileSpec,
28
29
  RotateWebhookSigningKeyResponse,
29
30
  } from './resources/account';
30
- import {
31
- APIKey,
32
- APIKeyCreateParams,
33
- APIKeyDeleteParams,
34
- APIKeyInfo,
35
- APIKeyListParams,
36
- APIKeyRetrieveParams,
37
- APIKeyRotateParams,
38
- APIKeySpec,
39
- APIKeyUpdateParams,
40
- APIKeys,
41
- APIKeysCursorPagination,
42
- } from './resources/api-keys';
43
31
  import {
44
32
  Model,
45
33
  ModelListParams,
@@ -95,6 +83,16 @@ import {
95
83
  AgentsCursorPagination,
96
84
  Page,
97
85
  } from './resources/agents/agents';
86
+ import {
87
+ APIKey,
88
+ APIKeyCreateParams,
89
+ APIKeyInfo,
90
+ APIKeyListParams,
91
+ APIKeySpec,
92
+ APIKeyUpdateParams,
93
+ APIKeys,
94
+ APIKeysCursorPagination,
95
+ } from './resources/api-keys/api-keys';
98
96
  import {
99
97
  AgentEntry,
100
98
  AgentScheduleEntry,
@@ -937,98 +935,59 @@ export class Cadenya {
937
935
  static toFile = Uploads.toFile;
938
936
 
939
937
  /**
940
- * AccountService manages account-level operations.
941
- * Accounts are the top-level organizational unit in the system.
942
- * All operations are scoped to the authenticated account determined by the JWT token.
943
- *
944
- * Authentication: Bearer token (JWT)
945
- * Scope: Account-level operations
938
+ * Manage the authenticated account. Accounts are the top-level organizational
939
+ * unit and contain one or more workspaces.
946
940
  */
947
941
  account: API.AccountResource = new API.AccountResource(this);
948
942
  /**
949
- * AgentService manages AI agents at the WORKSPACE level.
950
- * Agents are workspace-scoped resources that define AI behavior and tool access.
951
- * All operations are implicitly scoped to the workspace determined by the JWT token.
952
- *
953
- * Authentication: Bearer token (JWT)
954
- * Scope: Workspace-level operations
943
+ * Manage AI agents within a workspace. Agents define AI behavior and tool access.
955
944
  */
956
945
  agents: API.Agents = new API.Agents(this);
957
946
  objectives: API.Objectives = new API.Objectives(this);
958
947
  /**
959
- * MemoryService manages memory layers and their entries at the WORKSPACE level.
960
- * Layers are named containers that can be composed into an objective's memory
961
- * stack; entries are the keyed values within a layer.
962
- *
963
- * All operations are implicitly scoped to the workspace determined by the JWT
964
- * token. System-managed layers (e.g., episodic layers created by the runtime)
965
- * cannot be mutated through this API.
966
- *
967
- * Authentication: Bearer token (JWT)
968
- * Scope: Workspace-level operations
948
+ * Manage memory layers and their entries. Layers are named containers that can
949
+ * be composed into an objective's memory stack; entries are the keyed values
950
+ * within a layer. System-managed layers (e.g., episodic layers created by the
951
+ * runtime) cannot be mutated through this API.
969
952
  */
970
953
  memoryLayers: API.MemoryLayers = new API.MemoryLayers(this);
971
954
  /**
972
- * UploadService issues short-lived presigned URLs for direct client-to-object-
973
- * storage uploads at the WORKSPACE level. Created uploads can be referenced by
974
- * id when creating or updating resources that accept binary content (e.g.,
975
- * MemoryEntry).
976
- *
977
- * Authentication: Bearer token (JWT)
978
- * Scope: Workspace-level operations
955
+ * Issue short-lived presigned URLs for direct client-to-object-storage
956
+ * uploads. Created uploads can be referenced by id when creating or updating
957
+ * resources that accept binary content (e.g., MemoryEntry).
979
958
  */
980
959
  uploads: API.Uploads = new API.Uploads(this);
981
960
  /**
982
- * ModelService manages LLM models at the WORKSPACE level.
983
- * Models represent available LLM providers and families (e.g., "anthropic/claude-sonnet-4.6").
984
- * Models are seeded into workspaces and can be enabled or disabled.
985
- * All operations are implicitly scoped to the workspace determined by the JWT token.
986
- *
987
- * Authentication: Bearer token (JWT)
988
- * Scope: Workspace-level operations
961
+ * Manage LLM models available to a workspace. Models represent provider and
962
+ * family pairs (e.g., "anthropic/claude-sonnet-4.6"). Workspaces are seeded
963
+ * with the supported models and you can enable or disable each one.
989
964
  */
990
965
  models: API.Models = new API.Models(this);
991
966
  search: API.Search = new API.Search(this);
992
967
  /**
993
- * ToolService manages tool sets and tools at the WORKSPACE level.
994
- * Tool sets group related tools, and tools define specific capabilities for agents.
995
- * All operations are implicitly scoped to the workspace determined by the JWT token.
996
- *
997
- * Note: When a ToolSet has managed=true, only API Key actors can modify its tools.
998
- * Profile actors (humans) are restricted from modifying managed tool sets.
968
+ * Manage tool sets and the tools they contain. Tool sets group related tools,
969
+ * and tools define specific capabilities available to agents.
999
970
  *
1000
- * Authentication: Bearer token (JWT)
1001
- * Scope: Workspace-level operations
971
+ * When a tool set is managed, only API key actors can modify its tools; human
972
+ * (profile) actors cannot.
1002
973
  */
1003
974
  toolSets: API.ToolSets = new API.ToolSets(this);
1004
975
  /**
1005
- * APIKeyService manages workspace-scoped API Keys.
1006
- * Each API key belongs to a single workspace, ensuring isolation between environments.
1007
- *
1008
- * Authentication: Bearer token (JWT)
1009
- * Scope: Workspace-level operations
976
+ * Issue, rotate, and revoke API keys for the account, and grant or revoke
977
+ * each key's access to individual workspaces.
1010
978
  */
1011
979
  apiKeys: API.APIKeys = new API.APIKeys(this);
1012
980
  workspaceSecrets: API.WorkspaceSecrets = new API.WorkspaceSecrets(this);
1013
981
  /**
1014
- * WorkspaceService manages workspaces at the ACCOUNT level.
1015
- * This service is responsible for creating and listing workspaces within an account.
1016
- * Workspaces provide organizational grouping for resources within an account.
1017
- *
1018
- * Authentication: Bearer token (JWT)
1019
- * Scope: Account-level operations (manages workspaces themselves, not resources within workspaces)
982
+ * Manage workspaces within an account. Workspaces provide organizational
983
+ * grouping and isolation for resources such as agents, tools, and API keys.
1020
984
  */
1021
985
  workspaces: API.Workspaces = new API.Workspaces(this);
1022
986
  webhooks: API.Webhooks = new API.Webhooks(this);
1023
987
  /**
1024
- * BulkWorkspaceResources is the workspace-scoped service that applies
1025
- * a declarative bundle of workspace resources (tool sets, memory
1026
- * layers, agents, variations, assignments, schedules) in one async
1027
- * operation. See docs/superpowers/specs/2026-05-02-bulk-workspace-resources-design.md
1028
- * for the full design.
1029
- *
1030
- * Authentication: Bearer token (JWT)
1031
- * Scope: Workspace-level operations
988
+ * Apply a declarative bundle of workspace resources tool sets, memory
989
+ * layers, agents, variations, assignments, and schedules in a single
990
+ * asynchronous operation.
1032
991
  */
1033
992
  bulkWorkspaceResources: API.BulkWorkspaceResources = new API.BulkWorkspaceResources(this);
1034
993
  }
@@ -1059,6 +1018,7 @@ export declare namespace Cadenya {
1059
1018
  export {
1060
1019
  AccountResource as AccountResource,
1061
1020
  type Account as Account,
1021
+ type AccountInfo as AccountInfo,
1062
1022
  type AccountSpec as AccountSpec,
1063
1023
  type Profile as Profile,
1064
1024
  type ProfileSpec as ProfileSpec,
@@ -1191,11 +1151,8 @@ export declare namespace Cadenya {
1191
1151
  type APIKeySpec as APIKeySpec,
1192
1152
  type APIKeysCursorPagination as APIKeysCursorPagination,
1193
1153
  type APIKeyCreateParams as APIKeyCreateParams,
1194
- type APIKeyRetrieveParams as APIKeyRetrieveParams,
1195
1154
  type APIKeyUpdateParams as APIKeyUpdateParams,
1196
1155
  type APIKeyListParams as APIKeyListParams,
1197
- type APIKeyDeleteParams as APIKeyDeleteParams,
1198
- type APIKeyRotateParams as APIKeyRotateParams,
1199
1156
  };
1200
1157
 
1201
1158
  export {
@@ -3,16 +3,13 @@
3
3
  import { APIResource } from '../core/resource';
4
4
  import * as Shared from './shared';
5
5
  import * as WorkspacesAPI from './workspaces';
6
+ import * as APIKeysAPI from './api-keys/api-keys';
6
7
  import { APIPromise } from '../core/api-promise';
7
8
  import { RequestOptions } from '../internal/request-options';
8
9
 
9
10
  /**
10
- * AccountService manages account-level operations.
11
- * Accounts are the top-level organizational unit in the system.
12
- * All operations are scoped to the authenticated account determined by the JWT token.
13
- *
14
- * Authentication: Bearer token (JWT)
15
- * Scope: Account-level operations
11
+ * Manage the authenticated account. Accounts are the top-level organizational
12
+ * unit and contain one or more workspaces.
16
13
  */
17
14
  export class AccountResource extends APIResource {
18
15
  /**
@@ -32,13 +29,14 @@ export class AccountResource extends APIResource {
32
29
  }
33
30
 
34
31
  /**
35
- * Account is an account resource.
32
+ * An account, the top-level organizational unit. Contains workspaces and
33
+ * account-wide settings such as the webhook signing secret.
36
34
  */
37
35
  export interface Account {
38
36
  /**
39
- * AccountInfo contains information about the account.
37
+ * Server-populated information about the account.
40
38
  */
41
- info: Account.Info;
39
+ info: AccountInfo;
42
40
 
43
41
  /**
44
42
  * AccountResourceMetadata is used to represent a resource that is associated to an
@@ -47,27 +45,32 @@ export interface Account {
47
45
  metadata: Shared.AccountResourceMetadata;
48
46
 
49
47
  /**
50
- * AccountSpec contains the specification for an account.
48
+ * Configuration for an account.
51
49
  */
52
50
  spec: AccountSpec;
53
51
  }
54
52
 
55
- export namespace Account {
53
+ /**
54
+ * Server-populated information about the account.
55
+ */
56
+ export interface AccountInfo {
56
57
  /**
57
- * AccountInfo contains information about the account.
58
+ * An API key for the account. Use workspace-association RPCs to grant the key
59
+ * access to specific workspaces; a key with zero workspaces is valid but cannot
60
+ * access workspace-scoped resources.
58
61
  */
59
- export interface Info {
60
- /**
61
- * The generated secret that will sign all webhooks that are sent to your
62
- * configured Webhook URL. Formatted as "wh_asdf1234" per the
63
- * https://www.standardwebhooks.com/ format.
64
- */
65
- webhookEventsHmacSecret?: string;
66
- }
62
+ globalApiKey?: APIKeysAPI.APIKey;
63
+
64
+ /**
65
+ * The generated secret that will sign all webhooks that are sent to your
66
+ * configured Webhook URL. Formatted as "wh_asdf1234" per the
67
+ * https://www.standardwebhooks.com/ format.
68
+ */
69
+ webhookEventsHmacSecret?: string;
67
70
  }
68
71
 
69
72
  /**
70
- * AccountSpec contains the specification for an account.
73
+ * Configuration for an account.
71
74
  */
72
75
  export interface AccountSpec {
73
76
  billingEmail?: string;
@@ -80,9 +83,9 @@ export interface AccountSpec {
80
83
  }
81
84
 
82
85
  /**
83
- * Profile represents a human user at the account level. Profiles are
84
- * account-scoped resources that can be associated with multiple workspaces through
85
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
86
+ * A profile identifies a user or non-human principal (such as an API key) at the
87
+ * account level. Profiles are account-scoped and can be granted access to multiple
88
+ * workspaces.
86
89
  */
87
90
  export interface Profile {
88
91
  /**
@@ -92,35 +95,34 @@ export interface Profile {
92
95
  metadata: Shared.AccountResourceMetadata;
93
96
 
94
97
  /**
95
- * ProfileSpec contains the profile-specific fields
98
+ * Configuration for a profile.
96
99
  */
97
100
  spec: ProfileSpec;
98
101
  }
99
102
 
100
103
  /**
101
- * ProfileSpec contains the profile-specific fields
104
+ * Configuration for a profile.
102
105
  */
103
106
  export interface ProfileSpec {
104
107
  /**
105
- * Type is the type of profile. User's are humans, API keys are computers. You know
106
- * the deal.
108
+ * Whether this profile represents a human user, an API key, or a system principal.
107
109
  */
108
110
  type: 'PROFILE_TYPE_USER' | 'PROFILE_TYPE_API_KEY' | 'PROFILE_TYPE_SYSTEM';
109
111
 
110
112
  /**
111
- * Email address of the user (required, unique per account)
113
+ * Email address of the profile. Required and unique within an account for user
114
+ * profiles.
112
115
  */
113
116
  email?: string;
114
117
 
115
118
  /**
116
- * Display name for the user (e.g., "Bobby Tables")
119
+ * Display name (e.g., "Bobby Tables").
117
120
  */
118
121
  name?: string;
119
122
  }
120
123
 
121
124
  /**
122
- * RotateWebhookEventsHmacSecretResponse is a response to a
123
- * RotateWebhookEventsHmacSecretRequest.
125
+ * Response containing the newly generated webhook signing secret.
124
126
  */
125
127
  export interface RotateWebhookSigningKeyResponse {
126
128
  webhookEventsHmacSecret?: string;
@@ -129,6 +131,7 @@ export interface RotateWebhookSigningKeyResponse {
129
131
  export declare namespace AccountResource {
130
132
  export {
131
133
  type Account as Account,
134
+ type AccountInfo as AccountInfo,
132
135
  type AccountSpec as AccountSpec,
133
136
  type Profile as Profile,
134
137
  type ProfileSpec as ProfileSpec,
@@ -63,12 +63,7 @@ import { RequestOptions } from '../../internal/request-options';
63
63
  import { path } from '../../internal/utils/path';
64
64
 
65
65
  /**
66
- * AgentService manages AI agents at the WORKSPACE level.
67
- * Agents are workspace-scoped resources that define AI behavior and tool access.
68
- * All operations are implicitly scoped to the workspace determined by the JWT token.
69
- *
70
- * Authentication: Bearer token (JWT)
71
- * Scope: Workspace-level operations
66
+ * Manage AI agents within a workspace. Agents define AI behavior and tool access.
72
67
  */
73
68
  export class Agents extends APIResource {
74
69
  feedback: FeedbackAPI.Feedback = new FeedbackAPI.Feedback(this._client);
@@ -156,9 +151,9 @@ export interface Agent {
156
151
  */
157
152
  export interface AgentInfo {
158
153
  /**
159
- * Profile represents a human user at the account level. Profiles are
160
- * account-scoped resources that can be associated with multiple workspaces through
161
- * the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).
154
+ * A profile identifies a user or non-human principal (such as an API key) at the
155
+ * account level. Profiles are account-scoped and can be granted access to multiple
156
+ * workspaces.
162
157
  */
163
158
  createdBy?: AccountAPI.Profile;
164
159
 
@@ -253,14 +248,14 @@ export namespace AgentCreateParams {
253
248
 
254
249
  export interface AgentRetrieveParams {
255
250
  /**
256
- * Workspace ID (from path).
251
+ * Workspace ID.
257
252
  */
258
253
  workspaceId: string;
259
254
  }
260
255
 
261
256
  export interface AgentUpdateParams {
262
257
  /**
263
- * Path param: Workspace ID (from path).
258
+ * Path param: Workspace ID.
264
259
  */
265
260
  workspaceId: string;
266
261
 
@@ -290,7 +285,8 @@ export interface AgentListParams extends CursorPaginationParams {
290
285
  bundleKey?: string;
291
286
 
292
287
  /**
293
- * When set to true you may use more of your alloted API rate-limit
288
+ * When true, the `info` field on each returned agent is populated. Requests with
289
+ * this flag count more against your rate limit.
294
290
  */
295
291
  includeInfo?: boolean;
296
292
 
@@ -329,7 +325,7 @@ export interface AgentListParams extends CursorPaginationParams {
329
325
 
330
326
  export interface AgentDeleteParams {
331
327
  /**
332
- * Workspace ID (from path).
328
+ * Workspace ID.
333
329
  */
334
330
  workspaceId: string;
335
331
  }
@@ -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
  /**
@@ -37,7 +32,7 @@ export class Feedback extends APIResource {
37
32
 
38
33
  export interface FeedbackListParams extends CursorPaginationParams {
39
34
  /**
40
- * Path param: Workspace ID (from path).
35
+ * Path param
41
36
  */
42
37
  workspaceId: string;
43
38
 
@@ -10,12 +10,8 @@ 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
  /**
@@ -104,9 +100,9 @@ export interface AgentSchedule {
104
100
  */
105
101
  export interface AgentScheduleInfo {
106
102
  /**
107
- * Profile represents a human user at the account level. Profiles are
108
- * account-scoped resources that can be associated with multiple workspaces through
109
- * 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.
110
106
  */
111
107
  createdBy?: AccountAPI.Profile;
112
108
 
@@ -260,7 +256,7 @@ export interface ScheduleRange {
260
256
 
261
257
  export interface ScheduleCreateParams {
262
258
  /**
263
- * Path param: Workspace ID (from path).
259
+ * Path param: Workspace ID.
264
260
  */
265
261
  workspaceId: string;
266
262
 
@@ -280,26 +276,26 @@ export interface ScheduleCreateParams {
280
276
 
281
277
  export interface ScheduleRetrieveParams {
282
278
  /**
283
- * Workspace ID (from path).
279
+ * Workspace ID.
284
280
  */
285
281
  workspaceId: string;
286
282
 
287
283
  /**
288
- * Agent ID (from path). Accepts canonical agent\_… form or external_id:<value>
289
- * form (see common.proto "Path-parameter ID resolution").
284
+ * Agent ID. Accepts the canonical `agent_…` form or the `external_id:<value>`
285
+ * form.
290
286
  */
291
287
  agentId: string;
292
288
  }
293
289
 
294
290
  export interface ScheduleUpdateParams {
295
291
  /**
296
- * Path param: Workspace ID (from path).
292
+ * Path param: Workspace ID.
297
293
  */
298
294
  workspaceId: string;
299
295
 
300
296
  /**
301
- * Path param: Agent ID (from path). Accepts canonical agent\_… form or
302
- * external_id:<value> form (see common.proto "Path-parameter ID resolution").
297
+ * Path param: Agent ID. Accepts the canonical `agent_…` form or the
298
+ * `external_id:<value>` form.
303
299
  */
304
300
  agentId: string;
305
301
 
@@ -324,7 +320,7 @@ export interface ScheduleUpdateParams {
324
320
 
325
321
  export interface ScheduleListParams extends CursorPaginationParams {
326
322
  /**
327
- * Path param: Workspace ID (from path).
323
+ * Path param: Workspace ID.
328
324
  */
329
325
  workspaceId: string;
330
326
 
@@ -334,7 +330,8 @@ export interface ScheduleListParams extends CursorPaginationParams {
334
330
  bundleKey?: string;
335
331
 
336
332
  /**
337
- * Query param: 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.
338
335
  */
339
336
  includeInfo?: boolean;
340
337
 
@@ -356,13 +353,13 @@ export interface ScheduleListParams extends CursorPaginationParams {
356
353
 
357
354
  export interface ScheduleDeleteParams {
358
355
  /**
359
- * Workspace ID (from path).
356
+ * Workspace ID.
360
357
  */
361
358
  workspaceId: string;
362
359
 
363
360
  /**
364
- * Agent ID (from path). Accepts canonical agent\_… form or external_id:<value>
365
- * form (see common.proto "Path-parameter ID resolution").
361
+ * Agent ID. Accepts the canonical `agent_…` form or the `external_id:<value>`
362
+ * form.
366
363
  */
367
364
  agentId: string;
368
365
  }