@redis-iris/agent-playbook 0.1.0-alpha.4 → 0.1.0-beta.2

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 (439) hide show
  1. package/FUNCTIONS.md +12 -46
  2. package/README.md +135 -53
  3. package/RUNTIMES.md +1 -1
  4. package/dist/commonjs/controlplane/core.d.ts +1 -1
  5. package/dist/commonjs/controlplane/core.d.ts.map +1 -1
  6. package/dist/commonjs/controlplane/core.js +3 -3
  7. package/dist/commonjs/controlplane/core.js.map +1 -1
  8. package/dist/commonjs/controlplane/funcs/clear-playbook.d.ts +3 -3
  9. package/dist/commonjs/controlplane/funcs/clear-playbook.d.ts.map +1 -1
  10. package/dist/commonjs/controlplane/funcs/clear-playbook.js.map +1 -1
  11. package/dist/commonjs/controlplane/funcs/create-extraction-binding.d.ts +4 -4
  12. package/dist/commonjs/controlplane/funcs/create-extraction-binding.d.ts.map +1 -1
  13. package/dist/commonjs/controlplane/funcs/create-extraction-binding.js +1 -1
  14. package/dist/commonjs/controlplane/funcs/create-extraction-binding.js.map +1 -1
  15. package/dist/commonjs/controlplane/funcs/create-playbook.d.ts +3 -3
  16. package/dist/commonjs/controlplane/funcs/create-playbook.d.ts.map +1 -1
  17. package/dist/commonjs/controlplane/funcs/create-playbook.js.map +1 -1
  18. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.d.ts +3 -3
  19. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.d.ts.map +1 -1
  20. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.js.map +1 -1
  21. package/dist/commonjs/controlplane/funcs/delete-model-credential.d.ts +3 -3
  22. package/dist/commonjs/controlplane/funcs/delete-model-credential.d.ts.map +1 -1
  23. package/dist/commonjs/controlplane/funcs/delete-model-credential.js.map +1 -1
  24. package/dist/commonjs/controlplane/funcs/delete-playbook.d.ts +3 -3
  25. package/dist/commonjs/controlplane/funcs/delete-playbook.d.ts.map +1 -1
  26. package/dist/commonjs/controlplane/funcs/delete-playbook.js.map +1 -1
  27. package/dist/commonjs/controlplane/funcs/get-extraction-binding.d.ts +3 -3
  28. package/dist/commonjs/controlplane/funcs/get-extraction-binding.d.ts.map +1 -1
  29. package/dist/commonjs/controlplane/funcs/get-extraction-binding.js.map +1 -1
  30. package/dist/commonjs/controlplane/funcs/get-model-credential.d.ts +3 -3
  31. package/dist/commonjs/controlplane/funcs/get-model-credential.d.ts.map +1 -1
  32. package/dist/commonjs/controlplane/funcs/get-model-credential.js.map +1 -1
  33. package/dist/commonjs/controlplane/funcs/get-network-info.d.ts +3 -3
  34. package/dist/commonjs/controlplane/funcs/get-network-info.d.ts.map +1 -1
  35. package/dist/commonjs/controlplane/funcs/get-network-info.js.map +1 -1
  36. package/dist/commonjs/controlplane/funcs/get-playbook.d.ts +4 -4
  37. package/dist/commonjs/controlplane/funcs/get-playbook.d.ts.map +1 -1
  38. package/dist/commonjs/controlplane/funcs/get-playbook.js +1 -1
  39. package/dist/commonjs/controlplane/funcs/get-playbook.js.map +1 -1
  40. package/dist/commonjs/controlplane/funcs/list-databases.d.ts +3 -3
  41. package/dist/commonjs/controlplane/funcs/list-databases.d.ts.map +1 -1
  42. package/dist/commonjs/controlplane/funcs/list-databases.js.map +1 -1
  43. package/dist/commonjs/controlplane/funcs/list-extraction-bindings.d.ts +3 -3
  44. package/dist/commonjs/controlplane/funcs/list-extraction-bindings.d.ts.map +1 -1
  45. package/dist/commonjs/controlplane/funcs/list-extraction-bindings.js.map +1 -1
  46. package/dist/commonjs/controlplane/funcs/list-extraction-stores.d.ts +4 -4
  47. package/dist/commonjs/controlplane/funcs/list-extraction-stores.d.ts.map +1 -1
  48. package/dist/commonjs/controlplane/funcs/list-extraction-stores.js +1 -1
  49. package/dist/commonjs/controlplane/funcs/list-extraction-stores.js.map +1 -1
  50. package/dist/commonjs/controlplane/funcs/list-models.d.ts +3 -3
  51. package/dist/commonjs/controlplane/funcs/list-models.d.ts.map +1 -1
  52. package/dist/commonjs/controlplane/funcs/list-models.js.map +1 -1
  53. package/dist/commonjs/controlplane/funcs/list-playbooks.d.ts +4 -4
  54. package/dist/commonjs/controlplane/funcs/list-playbooks.d.ts.map +1 -1
  55. package/dist/commonjs/controlplane/funcs/list-playbooks.js +1 -1
  56. package/dist/commonjs/controlplane/funcs/list-playbooks.js.map +1 -1
  57. package/dist/commonjs/controlplane/funcs/put-model-credential.d.ts +3 -3
  58. package/dist/commonjs/controlplane/funcs/put-model-credential.d.ts.map +1 -1
  59. package/dist/commonjs/controlplane/funcs/put-model-credential.js.map +1 -1
  60. package/dist/commonjs/controlplane/funcs/update-extraction-binding.d.ts +3 -3
  61. package/dist/commonjs/controlplane/funcs/update-extraction-binding.d.ts.map +1 -1
  62. package/dist/commonjs/controlplane/funcs/update-extraction-binding.js.map +1 -1
  63. package/dist/commonjs/controlplane/funcs/update-playbook.d.ts +3 -3
  64. package/dist/commonjs/controlplane/funcs/update-playbook.d.ts.map +1 -1
  65. package/dist/commonjs/controlplane/funcs/update-playbook.js.map +1 -1
  66. package/dist/commonjs/controlplane/lib/config.d.ts +2 -2
  67. package/dist/commonjs/controlplane/lib/config.js +2 -2
  68. package/dist/commonjs/controlplane/lib/config.js.map +1 -1
  69. package/dist/commonjs/controlplane/lib/env.d.ts +2 -2
  70. package/dist/commonjs/controlplane/lib/env.d.ts.map +1 -1
  71. package/dist/commonjs/controlplane/lib/env.js +8 -3
  72. package/dist/commonjs/controlplane/lib/env.js.map +1 -1
  73. package/dist/commonjs/controlplane/lib/sdks.js +1 -1
  74. package/dist/commonjs/controlplane/lib/sdks.js.map +1 -1
  75. package/dist/commonjs/controlplane/lib/security.js +1 -1
  76. package/dist/commonjs/controlplane/lib/security.js.map +1 -1
  77. package/dist/commonjs/controlplane/models/create-extraction-binding-request-content.d.ts +2 -2
  78. package/dist/commonjs/controlplane/models/create-extraction-binding-response-content.d.ts +4 -4
  79. package/dist/commonjs/controlplane/models/create-playbook-response-content.d.ts +3 -0
  80. package/dist/commonjs/controlplane/models/create-playbook-response-content.d.ts.map +1 -1
  81. package/dist/commonjs/controlplane/models/create-playbook-response-content.js.map +1 -1
  82. package/dist/commonjs/controlplane/models/delete-extraction-binding-response-content.d.ts +4 -4
  83. package/dist/commonjs/controlplane/models/errors/{playbook-service-error.d.ts → agent-playbooks-service-error.d.ts} +2 -2
  84. package/dist/commonjs/controlplane/models/errors/agent-playbooks-service-error.d.ts.map +1 -0
  85. package/dist/commonjs/controlplane/models/errors/{playbook-service-error.js → agent-playbooks-service-error.js} +5 -5
  86. package/dist/commonjs/controlplane/models/errors/agent-playbooks-service-error.js.map +1 -0
  87. package/dist/commonjs/controlplane/models/errors/api-error.d.ts +2 -2
  88. package/dist/commonjs/controlplane/models/errors/api-error.d.ts.map +1 -1
  89. package/dist/commonjs/controlplane/models/errors/api-error.js +2 -2
  90. package/dist/commonjs/controlplane/models/errors/api-error.js.map +1 -1
  91. package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.d.ts +2 -2
  92. package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.d.ts.map +1 -1
  93. package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.js +2 -2
  94. package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.js.map +1 -1
  95. package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.d.ts +2 -2
  96. package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.d.ts.map +1 -1
  97. package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.js +2 -2
  98. package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.js.map +1 -1
  99. package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.d.ts +2 -2
  100. package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.d.ts.map +1 -1
  101. package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.js +2 -2
  102. package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.js.map +1 -1
  103. package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.d.ts +2 -2
  104. package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.d.ts.map +1 -1
  105. package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.js +2 -2
  106. package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.js.map +1 -1
  107. package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts +2 -2
  108. package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts.map +1 -1
  109. package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.js +2 -2
  110. package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.js.map +1 -1
  111. package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.d.ts +2 -2
  112. package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.d.ts.map +1 -1
  113. package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.js +2 -2
  114. package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.js.map +1 -1
  115. package/dist/commonjs/controlplane/models/errors/index.d.ts +1 -1
  116. package/dist/commonjs/controlplane/models/errors/index.d.ts.map +1 -1
  117. package/dist/commonjs/controlplane/models/errors/index.js +1 -1
  118. package/dist/commonjs/controlplane/models/errors/index.js.map +1 -1
  119. package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.d.ts +2 -2
  120. package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.d.ts.map +1 -1
  121. package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.js +2 -2
  122. package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.js.map +1 -1
  123. package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts +2 -2
  124. package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts.map +1 -1
  125. package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.js +2 -2
  126. package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.js.map +1 -1
  127. package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.d.ts +2 -2
  128. package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.d.ts.map +1 -1
  129. package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.js +2 -2
  130. package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.js.map +1 -1
  131. package/dist/commonjs/controlplane/models/errors/response-validation-error.d.ts +2 -2
  132. package/dist/commonjs/controlplane/models/errors/response-validation-error.d.ts.map +1 -1
  133. package/dist/commonjs/controlplane/models/errors/response-validation-error.js +2 -2
  134. package/dist/commonjs/controlplane/models/errors/response-validation-error.js.map +1 -1
  135. package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.d.ts +2 -2
  136. package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.d.ts.map +1 -1
  137. package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.js +2 -2
  138. package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.js.map +1 -1
  139. package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.d.ts +2 -2
  140. package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.d.ts.map +1 -1
  141. package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.js +2 -2
  142. package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.js.map +1 -1
  143. package/dist/commonjs/controlplane/models/extraction-binding-source.d.ts +1 -1
  144. package/dist/commonjs/controlplane/models/extraction-binding-status.d.ts +0 -1
  145. package/dist/commonjs/controlplane/models/extraction-binding-status.d.ts.map +1 -1
  146. package/dist/commonjs/controlplane/models/extraction-binding-status.js +0 -1
  147. package/dist/commonjs/controlplane/models/extraction-binding-status.js.map +1 -1
  148. package/dist/commonjs/controlplane/models/extraction-binding.d.ts +4 -4
  149. package/dist/commonjs/controlplane/models/extraction-job-configuration.d.ts +1 -1
  150. package/dist/commonjs/controlplane/models/extraction-job.d.ts +0 -4
  151. package/dist/commonjs/controlplane/models/extraction-job.d.ts.map +1 -1
  152. package/dist/commonjs/controlplane/models/extraction-job.js +0 -1
  153. package/dist/commonjs/controlplane/models/extraction-job.js.map +1 -1
  154. package/dist/commonjs/controlplane/models/get-extraction-binding-response-content.d.ts +4 -4
  155. package/dist/commonjs/controlplane/models/get-playbook-response-content.d.ts +3 -0
  156. package/dist/commonjs/controlplane/models/get-playbook-response-content.d.ts.map +1 -1
  157. package/dist/commonjs/controlplane/models/get-playbook-response-content.js.map +1 -1
  158. package/dist/commonjs/controlplane/models/playbook-state.d.ts +7 -0
  159. package/dist/commonjs/controlplane/models/playbook-state.d.ts.map +1 -1
  160. package/dist/commonjs/controlplane/models/playbook-state.js +4 -0
  161. package/dist/commonjs/controlplane/models/playbook-state.js.map +1 -1
  162. package/dist/commonjs/controlplane/models/playbook.d.ts +3 -0
  163. package/dist/commonjs/controlplane/models/playbook.d.ts.map +1 -1
  164. package/dist/commonjs/controlplane/models/playbook.js.map +1 -1
  165. package/dist/commonjs/controlplane/models/update-extraction-binding-request-content.d.ts +1 -1
  166. package/dist/commonjs/controlplane/models/update-extraction-binding-response-content.d.ts +4 -4
  167. package/dist/commonjs/controlplane/models/update-playbook-response-content.d.ts +3 -0
  168. package/dist/commonjs/controlplane/models/update-playbook-response-content.d.ts.map +1 -1
  169. package/dist/commonjs/controlplane/models/update-playbook-response-content.js.map +1 -1
  170. package/dist/commonjs/controlplane/sdk/sdk.d.ts +5 -5
  171. package/dist/commonjs/controlplane/sdk/sdk.d.ts.map +1 -1
  172. package/dist/commonjs/controlplane/sdk/sdk.js +7 -7
  173. package/dist/commonjs/controlplane/sdk/sdk.js.map +1 -1
  174. package/dist/commonjs/index.d.ts +2 -2
  175. package/dist/commonjs/index.d.ts.map +1 -1
  176. package/dist/commonjs/index.js +2 -2
  177. package/dist/commonjs/index.js.map +1 -1
  178. package/dist/commonjs/lib/config.d.ts +2 -2
  179. package/dist/commonjs/lib/config.js +2 -2
  180. package/dist/commonjs/lib/config.js.map +1 -1
  181. package/dist/commonjs/lib/env.d.ts +3 -3
  182. package/dist/commonjs/lib/env.d.ts.map +1 -1
  183. package/dist/commonjs/lib/env.js +12 -6
  184. package/dist/commonjs/lib/env.js.map +1 -1
  185. package/dist/commonjs/lib/sdks.js +1 -1
  186. package/dist/commonjs/lib/sdks.js.map +1 -1
  187. package/dist/commonjs/lib/security.js +1 -1
  188. package/dist/commonjs/lib/security.js.map +1 -1
  189. package/dist/esm/controlplane/core.d.ts +1 -1
  190. package/dist/esm/controlplane/core.d.ts.map +1 -1
  191. package/dist/esm/controlplane/core.js +1 -1
  192. package/dist/esm/controlplane/core.js.map +1 -1
  193. package/dist/esm/controlplane/funcs/clear-playbook.d.ts +3 -3
  194. package/dist/esm/controlplane/funcs/clear-playbook.d.ts.map +1 -1
  195. package/dist/esm/controlplane/funcs/clear-playbook.js.map +1 -1
  196. package/dist/esm/controlplane/funcs/create-extraction-binding.d.ts +4 -4
  197. package/dist/esm/controlplane/funcs/create-extraction-binding.d.ts.map +1 -1
  198. package/dist/esm/controlplane/funcs/create-extraction-binding.js +1 -1
  199. package/dist/esm/controlplane/funcs/create-extraction-binding.js.map +1 -1
  200. package/dist/esm/controlplane/funcs/create-playbook.d.ts +3 -3
  201. package/dist/esm/controlplane/funcs/create-playbook.d.ts.map +1 -1
  202. package/dist/esm/controlplane/funcs/create-playbook.js.map +1 -1
  203. package/dist/esm/controlplane/funcs/delete-extraction-binding.d.ts +3 -3
  204. package/dist/esm/controlplane/funcs/delete-extraction-binding.d.ts.map +1 -1
  205. package/dist/esm/controlplane/funcs/delete-extraction-binding.js.map +1 -1
  206. package/dist/esm/controlplane/funcs/delete-model-credential.d.ts +3 -3
  207. package/dist/esm/controlplane/funcs/delete-model-credential.d.ts.map +1 -1
  208. package/dist/esm/controlplane/funcs/delete-model-credential.js.map +1 -1
  209. package/dist/esm/controlplane/funcs/delete-playbook.d.ts +3 -3
  210. package/dist/esm/controlplane/funcs/delete-playbook.d.ts.map +1 -1
  211. package/dist/esm/controlplane/funcs/delete-playbook.js.map +1 -1
  212. package/dist/esm/controlplane/funcs/get-extraction-binding.d.ts +3 -3
  213. package/dist/esm/controlplane/funcs/get-extraction-binding.d.ts.map +1 -1
  214. package/dist/esm/controlplane/funcs/get-extraction-binding.js.map +1 -1
  215. package/dist/esm/controlplane/funcs/get-model-credential.d.ts +3 -3
  216. package/dist/esm/controlplane/funcs/get-model-credential.d.ts.map +1 -1
  217. package/dist/esm/controlplane/funcs/get-model-credential.js.map +1 -1
  218. package/dist/esm/controlplane/funcs/get-network-info.d.ts +3 -3
  219. package/dist/esm/controlplane/funcs/get-network-info.d.ts.map +1 -1
  220. package/dist/esm/controlplane/funcs/get-network-info.js.map +1 -1
  221. package/dist/esm/controlplane/funcs/get-playbook.d.ts +4 -4
  222. package/dist/esm/controlplane/funcs/get-playbook.d.ts.map +1 -1
  223. package/dist/esm/controlplane/funcs/get-playbook.js +1 -1
  224. package/dist/esm/controlplane/funcs/get-playbook.js.map +1 -1
  225. package/dist/esm/controlplane/funcs/list-databases.d.ts +3 -3
  226. package/dist/esm/controlplane/funcs/list-databases.d.ts.map +1 -1
  227. package/dist/esm/controlplane/funcs/list-databases.js.map +1 -1
  228. package/dist/esm/controlplane/funcs/list-extraction-bindings.d.ts +3 -3
  229. package/dist/esm/controlplane/funcs/list-extraction-bindings.d.ts.map +1 -1
  230. package/dist/esm/controlplane/funcs/list-extraction-bindings.js.map +1 -1
  231. package/dist/esm/controlplane/funcs/list-extraction-stores.d.ts +4 -4
  232. package/dist/esm/controlplane/funcs/list-extraction-stores.d.ts.map +1 -1
  233. package/dist/esm/controlplane/funcs/list-extraction-stores.js +1 -1
  234. package/dist/esm/controlplane/funcs/list-extraction-stores.js.map +1 -1
  235. package/dist/esm/controlplane/funcs/list-models.d.ts +3 -3
  236. package/dist/esm/controlplane/funcs/list-models.d.ts.map +1 -1
  237. package/dist/esm/controlplane/funcs/list-models.js.map +1 -1
  238. package/dist/esm/controlplane/funcs/list-playbooks.d.ts +4 -4
  239. package/dist/esm/controlplane/funcs/list-playbooks.d.ts.map +1 -1
  240. package/dist/esm/controlplane/funcs/list-playbooks.js +1 -1
  241. package/dist/esm/controlplane/funcs/list-playbooks.js.map +1 -1
  242. package/dist/esm/controlplane/funcs/put-model-credential.d.ts +3 -3
  243. package/dist/esm/controlplane/funcs/put-model-credential.d.ts.map +1 -1
  244. package/dist/esm/controlplane/funcs/put-model-credential.js.map +1 -1
  245. package/dist/esm/controlplane/funcs/update-extraction-binding.d.ts +3 -3
  246. package/dist/esm/controlplane/funcs/update-extraction-binding.d.ts.map +1 -1
  247. package/dist/esm/controlplane/funcs/update-extraction-binding.js.map +1 -1
  248. package/dist/esm/controlplane/funcs/update-playbook.d.ts +3 -3
  249. package/dist/esm/controlplane/funcs/update-playbook.d.ts.map +1 -1
  250. package/dist/esm/controlplane/funcs/update-playbook.js.map +1 -1
  251. package/dist/esm/controlplane/lib/config.d.ts +2 -2
  252. package/dist/esm/controlplane/lib/config.js +2 -2
  253. package/dist/esm/controlplane/lib/config.js.map +1 -1
  254. package/dist/esm/controlplane/lib/env.d.ts +2 -2
  255. package/dist/esm/controlplane/lib/env.d.ts.map +1 -1
  256. package/dist/esm/controlplane/lib/env.js +8 -3
  257. package/dist/esm/controlplane/lib/env.js.map +1 -1
  258. package/dist/esm/controlplane/lib/sdks.js +1 -1
  259. package/dist/esm/controlplane/lib/sdks.js.map +1 -1
  260. package/dist/esm/controlplane/lib/security.js +1 -1
  261. package/dist/esm/controlplane/lib/security.js.map +1 -1
  262. package/dist/esm/controlplane/models/create-extraction-binding-request-content.d.ts +2 -2
  263. package/dist/esm/controlplane/models/create-extraction-binding-response-content.d.ts +4 -4
  264. package/dist/esm/controlplane/models/create-playbook-response-content.d.ts +3 -0
  265. package/dist/esm/controlplane/models/create-playbook-response-content.d.ts.map +1 -1
  266. package/dist/esm/controlplane/models/create-playbook-response-content.js.map +1 -1
  267. package/dist/esm/controlplane/models/delete-extraction-binding-response-content.d.ts +4 -4
  268. package/dist/esm/controlplane/models/errors/{playbook-service-error.d.ts → agent-playbooks-service-error.d.ts} +2 -2
  269. package/dist/esm/controlplane/models/errors/agent-playbooks-service-error.d.ts.map +1 -0
  270. package/dist/esm/controlplane/models/errors/{playbook-service-error.js → agent-playbooks-service-error.js} +3 -3
  271. package/dist/esm/controlplane/models/errors/agent-playbooks-service-error.js.map +1 -0
  272. package/dist/esm/controlplane/models/errors/api-error.d.ts +2 -2
  273. package/dist/esm/controlplane/models/errors/api-error.d.ts.map +1 -1
  274. package/dist/esm/controlplane/models/errors/api-error.js +2 -2
  275. package/dist/esm/controlplane/models/errors/api-error.js.map +1 -1
  276. package/dist/esm/controlplane/models/errors/authentication-error-response-content.d.ts +2 -2
  277. package/dist/esm/controlplane/models/errors/authentication-error-response-content.d.ts.map +1 -1
  278. package/dist/esm/controlplane/models/errors/authentication-error-response-content.js +2 -2
  279. package/dist/esm/controlplane/models/errors/authentication-error-response-content.js.map +1 -1
  280. package/dist/esm/controlplane/models/errors/bad-request-error-response-content.d.ts +2 -2
  281. package/dist/esm/controlplane/models/errors/bad-request-error-response-content.d.ts.map +1 -1
  282. package/dist/esm/controlplane/models/errors/bad-request-error-response-content.js +2 -2
  283. package/dist/esm/controlplane/models/errors/bad-request-error-response-content.js.map +1 -1
  284. package/dist/esm/controlplane/models/errors/conflict-error-response-content.d.ts +2 -2
  285. package/dist/esm/controlplane/models/errors/conflict-error-response-content.d.ts.map +1 -1
  286. package/dist/esm/controlplane/models/errors/conflict-error-response-content.js +2 -2
  287. package/dist/esm/controlplane/models/errors/conflict-error-response-content.js.map +1 -1
  288. package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.d.ts +2 -2
  289. package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.d.ts.map +1 -1
  290. package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.js +2 -2
  291. package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.js.map +1 -1
  292. package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts +2 -2
  293. package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts.map +1 -1
  294. package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.js +2 -2
  295. package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.js.map +1 -1
  296. package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.d.ts +2 -2
  297. package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.d.ts.map +1 -1
  298. package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.js +2 -2
  299. package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.js.map +1 -1
  300. package/dist/esm/controlplane/models/errors/index.d.ts +1 -1
  301. package/dist/esm/controlplane/models/errors/index.d.ts.map +1 -1
  302. package/dist/esm/controlplane/models/errors/index.js +1 -1
  303. package/dist/esm/controlplane/models/errors/index.js.map +1 -1
  304. package/dist/esm/controlplane/models/errors/not-found-error-response-content.d.ts +2 -2
  305. package/dist/esm/controlplane/models/errors/not-found-error-response-content.d.ts.map +1 -1
  306. package/dist/esm/controlplane/models/errors/not-found-error-response-content.js +2 -2
  307. package/dist/esm/controlplane/models/errors/not-found-error-response-content.js.map +1 -1
  308. package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts +2 -2
  309. package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts.map +1 -1
  310. package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.js +2 -2
  311. package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.js.map +1 -1
  312. package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.d.ts +2 -2
  313. package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.d.ts.map +1 -1
  314. package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.js +2 -2
  315. package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.js.map +1 -1
  316. package/dist/esm/controlplane/models/errors/response-validation-error.d.ts +2 -2
  317. package/dist/esm/controlplane/models/errors/response-validation-error.d.ts.map +1 -1
  318. package/dist/esm/controlplane/models/errors/response-validation-error.js +2 -2
  319. package/dist/esm/controlplane/models/errors/response-validation-error.js.map +1 -1
  320. package/dist/esm/controlplane/models/errors/timeout-error-response-content.d.ts +2 -2
  321. package/dist/esm/controlplane/models/errors/timeout-error-response-content.d.ts.map +1 -1
  322. package/dist/esm/controlplane/models/errors/timeout-error-response-content.js +2 -2
  323. package/dist/esm/controlplane/models/errors/timeout-error-response-content.js.map +1 -1
  324. package/dist/esm/controlplane/models/errors/unexpected-error-response-content.d.ts +2 -2
  325. package/dist/esm/controlplane/models/errors/unexpected-error-response-content.d.ts.map +1 -1
  326. package/dist/esm/controlplane/models/errors/unexpected-error-response-content.js +2 -2
  327. package/dist/esm/controlplane/models/errors/unexpected-error-response-content.js.map +1 -1
  328. package/dist/esm/controlplane/models/extraction-binding-source.d.ts +1 -1
  329. package/dist/esm/controlplane/models/extraction-binding-status.d.ts +0 -1
  330. package/dist/esm/controlplane/models/extraction-binding-status.d.ts.map +1 -1
  331. package/dist/esm/controlplane/models/extraction-binding-status.js +0 -1
  332. package/dist/esm/controlplane/models/extraction-binding-status.js.map +1 -1
  333. package/dist/esm/controlplane/models/extraction-binding.d.ts +4 -4
  334. package/dist/esm/controlplane/models/extraction-job-configuration.d.ts +1 -1
  335. package/dist/esm/controlplane/models/extraction-job.d.ts +0 -4
  336. package/dist/esm/controlplane/models/extraction-job.d.ts.map +1 -1
  337. package/dist/esm/controlplane/models/extraction-job.js +0 -1
  338. package/dist/esm/controlplane/models/extraction-job.js.map +1 -1
  339. package/dist/esm/controlplane/models/get-extraction-binding-response-content.d.ts +4 -4
  340. package/dist/esm/controlplane/models/get-playbook-response-content.d.ts +3 -0
  341. package/dist/esm/controlplane/models/get-playbook-response-content.d.ts.map +1 -1
  342. package/dist/esm/controlplane/models/get-playbook-response-content.js.map +1 -1
  343. package/dist/esm/controlplane/models/playbook-state.d.ts +7 -0
  344. package/dist/esm/controlplane/models/playbook-state.d.ts.map +1 -1
  345. package/dist/esm/controlplane/models/playbook-state.js +4 -0
  346. package/dist/esm/controlplane/models/playbook-state.js.map +1 -1
  347. package/dist/esm/controlplane/models/playbook.d.ts +3 -0
  348. package/dist/esm/controlplane/models/playbook.d.ts.map +1 -1
  349. package/dist/esm/controlplane/models/playbook.js.map +1 -1
  350. package/dist/esm/controlplane/models/update-extraction-binding-request-content.d.ts +1 -1
  351. package/dist/esm/controlplane/models/update-extraction-binding-response-content.d.ts +4 -4
  352. package/dist/esm/controlplane/models/update-playbook-response-content.d.ts +3 -0
  353. package/dist/esm/controlplane/models/update-playbook-response-content.d.ts.map +1 -1
  354. package/dist/esm/controlplane/models/update-playbook-response-content.js.map +1 -1
  355. package/dist/esm/controlplane/sdk/sdk.d.ts +5 -5
  356. package/dist/esm/controlplane/sdk/sdk.d.ts.map +1 -1
  357. package/dist/esm/controlplane/sdk/sdk.js +5 -5
  358. package/dist/esm/controlplane/sdk/sdk.js.map +1 -1
  359. package/dist/esm/index.d.ts +2 -2
  360. package/dist/esm/index.d.ts.map +1 -1
  361. package/dist/esm/index.js +1 -1
  362. package/dist/esm/index.js.map +1 -1
  363. package/dist/esm/lib/config.d.ts +2 -2
  364. package/dist/esm/lib/config.js +2 -2
  365. package/dist/esm/lib/config.js.map +1 -1
  366. package/dist/esm/lib/env.d.ts +3 -3
  367. package/dist/esm/lib/env.d.ts.map +1 -1
  368. package/dist/esm/lib/env.js +12 -6
  369. package/dist/esm/lib/env.js.map +1 -1
  370. package/dist/esm/lib/sdks.js +1 -1
  371. package/dist/esm/lib/sdks.js.map +1 -1
  372. package/dist/esm/lib/security.js +1 -1
  373. package/dist/esm/lib/security.js.map +1 -1
  374. package/jsr.json +1 -1
  375. package/package.json +3 -3
  376. package/src/controlplane/core.ts +1 -1
  377. package/src/controlplane/funcs/clear-playbook.ts +7 -7
  378. package/src/controlplane/funcs/create-extraction-binding.ts +8 -8
  379. package/src/controlplane/funcs/create-playbook.ts +7 -7
  380. package/src/controlplane/funcs/delete-extraction-binding.ts +7 -7
  381. package/src/controlplane/funcs/delete-model-credential.ts +7 -7
  382. package/src/controlplane/funcs/delete-playbook.ts +7 -7
  383. package/src/controlplane/funcs/get-extraction-binding.ts +7 -7
  384. package/src/controlplane/funcs/get-model-credential.ts +7 -7
  385. package/src/controlplane/funcs/get-network-info.ts +7 -7
  386. package/src/controlplane/funcs/get-playbook.ts +8 -8
  387. package/src/controlplane/funcs/list-databases.ts +7 -7
  388. package/src/controlplane/funcs/list-extraction-bindings.ts +7 -7
  389. package/src/controlplane/funcs/list-extraction-stores.ts +8 -8
  390. package/src/controlplane/funcs/list-models.ts +7 -7
  391. package/src/controlplane/funcs/list-playbooks.ts +8 -8
  392. package/src/controlplane/funcs/put-model-credential.ts +7 -7
  393. package/src/controlplane/funcs/update-extraction-binding.ts +7 -7
  394. package/src/controlplane/funcs/update-playbook.ts +7 -7
  395. package/src/controlplane/lib/config.ts +2 -2
  396. package/src/controlplane/lib/env.ts +10 -5
  397. package/src/controlplane/lib/sdks.ts +1 -1
  398. package/src/controlplane/lib/security.ts +1 -1
  399. package/src/controlplane/models/create-extraction-binding-request-content.ts +2 -2
  400. package/src/controlplane/models/create-extraction-binding-response-content.ts +4 -4
  401. package/src/controlplane/models/create-playbook-response-content.ts +3 -0
  402. package/src/controlplane/models/delete-extraction-binding-response-content.ts +4 -4
  403. package/src/controlplane/models/errors/{playbook-service-error.ts → agent-playbooks-service-error.ts} +2 -2
  404. package/src/controlplane/models/errors/api-error.ts +2 -2
  405. package/src/controlplane/models/errors/authentication-error-response-content.ts +4 -2
  406. package/src/controlplane/models/errors/bad-request-error-response-content.ts +2 -2
  407. package/src/controlplane/models/errors/conflict-error-response-content.ts +2 -2
  408. package/src/controlplane/models/errors/extraction-conflict-error-response-content.ts +2 -2
  409. package/src/controlplane/models/errors/extraction-forbidden-error-response-content.ts +2 -2
  410. package/src/controlplane/models/errors/failed-dependency-error-response-content.ts +4 -2
  411. package/src/controlplane/models/errors/index.ts +1 -1
  412. package/src/controlplane/models/errors/not-found-error-response-content.ts +2 -2
  413. package/src/controlplane/models/errors/playbook-service-unavailable-error-response-content.ts +2 -2
  414. package/src/controlplane/models/errors/resource-suspended-error-response-content.ts +2 -2
  415. package/src/controlplane/models/errors/response-validation-error.ts +2 -2
  416. package/src/controlplane/models/errors/timeout-error-response-content.ts +2 -2
  417. package/src/controlplane/models/errors/unexpected-error-response-content.ts +2 -2
  418. package/src/controlplane/models/extraction-binding-source.ts +1 -1
  419. package/src/controlplane/models/extraction-binding-status.ts +0 -1
  420. package/src/controlplane/models/extraction-binding.ts +4 -4
  421. package/src/controlplane/models/extraction-job-configuration.ts +1 -1
  422. package/src/controlplane/models/extraction-job.ts +0 -5
  423. package/src/controlplane/models/get-extraction-binding-response-content.ts +4 -4
  424. package/src/controlplane/models/get-playbook-response-content.ts +3 -0
  425. package/src/controlplane/models/playbook-state.ts +7 -0
  426. package/src/controlplane/models/playbook.ts +3 -0
  427. package/src/controlplane/models/update-extraction-binding-request-content.ts +1 -1
  428. package/src/controlplane/models/update-extraction-binding-response-content.ts +4 -4
  429. package/src/controlplane/models/update-playbook-response-content.ts +3 -0
  430. package/src/controlplane/sdk/sdk.ts +5 -5
  431. package/src/index.ts +2 -2
  432. package/src/lib/config.ts +2 -2
  433. package/src/lib/env.ts +15 -9
  434. package/src/lib/sdks.ts +1 -1
  435. package/src/lib/security.ts +1 -1
  436. package/dist/commonjs/controlplane/models/errors/playbook-service-error.d.ts.map +0 -1
  437. package/dist/commonjs/controlplane/models/errors/playbook-service-error.js.map +0 -1
  438. package/dist/esm/controlplane/models/errors/playbook-service-error.d.ts.map +0 -1
  439. package/dist/esm/controlplane/models/errors/playbook-service-error.js.map +0 -1
@@ -20,7 +20,7 @@ import {
20
20
  } from "./extraction-job.js";
21
21
 
22
22
  /**
23
- * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Ready means the configured extraction-worker grants were accepted; the worker validates live RAM access during execution. Without a configured RAM connection, preparation remains pending and cannot be enabled. This release has no extraction worker. Activation requires a separate PATCH after readiness.
23
+ * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Creation synchronously validates caller consent and exact RAM source ownership, returning ready and disabled. Every explicit enable revalidates with the current caller. Consent is durable account-owned configuration.
24
24
  */
25
25
  export type CreateExtractionBindingResponseContent = {
26
26
  bindingId: string;
@@ -29,13 +29,13 @@ export type CreateExtractionBindingResponseContent = {
29
29
  */
30
30
  playbookId: string;
31
31
  /**
32
- * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
32
+ * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
33
33
  */
34
34
  source: ExtractionBindingSource;
35
35
  job: ExtractionJob;
36
36
  status: ExtractionBindingStatus;
37
37
  /**
38
- * Activation intent. Creation is disabled; enabling requires ready status and a separate PATCH. Pausing clears intent and retains prepared source/destination grants.
38
+ * Activation intent. Creation is disabled. A separate enable PATCH revalidates current source consent and ownership, and can recover a blocked binding. Pausing clears intent without a RAM request or source permission.
39
39
  */
40
40
  enabled: boolean;
41
41
  /**
@@ -43,7 +43,7 @@ export type CreateExtractionBindingResponseContent = {
43
43
  */
44
44
  version: number;
45
45
  /**
46
- * Machine-readable source preparation or execution failure reason, such as source_grant_refused, source_not_found, or source_access_denied. Clients must tolerate unknown reasons.
46
+ * Machine-readable runtime failure reason, such as source_not_found or source_access_denied. Clients must tolerate unknown reasons.
47
47
  */
48
48
  blockedReason?: string | undefined;
49
49
  /**
@@ -51,6 +51,9 @@ export type CreatePlaybookResponseContent = {
51
51
  playbookId: string;
52
52
  tenantId: string;
53
53
  name: string;
54
+ /**
55
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
56
+ */
54
57
  state: PlaybookState;
55
58
  /**
56
59
  * Create-only embedding identity for a Playbook.
@@ -20,7 +20,7 @@ import {
20
20
  } from "./extraction-job.js";
21
21
 
22
22
  /**
23
- * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Ready means the configured extraction-worker grants were accepted; the worker validates live RAM access during execution. Without a configured RAM connection, preparation remains pending and cannot be enabled. This release has no extraction worker. Activation requires a separate PATCH after readiness.
23
+ * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Creation synchronously validates caller consent and exact RAM source ownership, returning ready and disabled. Every explicit enable revalidates with the current caller. Consent is durable account-owned configuration.
24
24
  */
25
25
  export type DeleteExtractionBindingResponseContent = {
26
26
  bindingId: string;
@@ -29,13 +29,13 @@ export type DeleteExtractionBindingResponseContent = {
29
29
  */
30
30
  playbookId: string;
31
31
  /**
32
- * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
32
+ * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
33
33
  */
34
34
  source: ExtractionBindingSource;
35
35
  job: ExtractionJob;
36
36
  status: ExtractionBindingStatus;
37
37
  /**
38
- * Activation intent. Creation is disabled; enabling requires ready status and a separate PATCH. Pausing clears intent and retains prepared source/destination grants.
38
+ * Activation intent. Creation is disabled. A separate enable PATCH revalidates current source consent and ownership, and can recover a blocked binding. Pausing clears intent without a RAM request or source permission.
39
39
  */
40
40
  enabled: boolean;
41
41
  /**
@@ -43,7 +43,7 @@ export type DeleteExtractionBindingResponseContent = {
43
43
  */
44
44
  version: number;
45
45
  /**
46
- * Machine-readable source preparation or execution failure reason, such as source_grant_refused, source_not_found, or source_access_denied. Clients must tolerate unknown reasons.
46
+ * Machine-readable runtime failure reason, such as source_not_found or source_access_denied. Clients must tolerate unknown reasons.
47
47
  */
48
48
  blockedReason?: string | undefined;
49
49
  /**
@@ -3,7 +3,7 @@
3
3
  */
4
4
 
5
5
  /** The base class for all HTTP error responses */
6
- export class PlaybookServiceError extends Error {
6
+ export class AgentPlaybooksServiceError extends Error {
7
7
  /** HTTP status code */
8
8
  public readonly statusCode: number;
9
9
  /** HTTP body */
@@ -30,6 +30,6 @@ export class PlaybookServiceError extends Error {
30
30
  this.contentType = httpMeta.response.headers.get("content-type") || "";
31
31
  this.rawResponse = httpMeta.response;
32
32
 
33
- this.name = "PlaybookServiceError";
33
+ this.name = "AgentPlaybooksServiceError";
34
34
  }
35
35
  }
@@ -2,10 +2,10 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
- import { PlaybookServiceError } from "./playbook-service-error.js";
5
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
6
6
 
7
7
  /** The fallback error class if no more specific error class is matched */
8
- export class APIError extends PlaybookServiceError {
8
+ export class APIError extends AgentPlaybooksServiceError {
9
9
  constructor(
10
10
  message: string,
11
11
  httpMeta: {
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * Authentication credentials are missing, malformed, or invalid.
@@ -40,7 +40,9 @@ export type AuthenticationErrorResponseContentData = {
40
40
  /**
41
41
  * Authentication credentials are missing, malformed, or invalid.
42
42
  */
43
- export class AuthenticationErrorResponseContent extends PlaybookServiceError {
43
+ export class AuthenticationErrorResponseContent
44
+ extends AgentPlaybooksServiceError
45
+ {
44
46
  /**
45
47
  * A short, human-readable summary of the problem
46
48
  *
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * Request validation or input decoding failed.
@@ -44,7 +44,7 @@ export type BadRequestErrorResponseContentData = {
44
44
  /**
45
45
  * Request validation or input decoding failed.
46
46
  */
47
- export class BadRequestErrorResponseContent extends PlaybookServiceError {
47
+ export class BadRequestErrorResponseContent extends AgentPlaybooksServiceError {
48
48
  /**
49
49
  * A short, human-readable summary of the problem
50
50
  *
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * The request conflicts with the current state of the resource.
@@ -40,7 +40,7 @@ export type ConflictErrorResponseContentData = {
40
40
  /**
41
41
  * The request conflicts with the current state of the resource.
42
42
  */
43
- export class ConflictErrorResponseContent extends PlaybookServiceError {
43
+ export class ConflictErrorResponseContent extends AgentPlaybooksServiceError {
44
44
  /**
45
45
  * A short, human-readable summary of the problem
46
46
  *
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * Binding version/state conflict, or extraction disabled by deployment configuration. Disabled extraction still permits inspection, pause and deletion.
@@ -38,7 +38,7 @@ export type ExtractionConflictErrorResponseContentData = {
38
38
  * Binding version/state conflict, or extraction disabled by deployment configuration. Disabled extraction still permits inspection, pause and deletion.
39
39
  */
40
40
  export class ExtractionConflictErrorResponseContent
41
- extends PlaybookServiceError
41
+ extends AgentPlaybooksServiceError
42
42
  {
43
43
  /**
44
44
  * A short, human-readable summary of the problem
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * Caller authorization failure.
@@ -38,7 +38,7 @@ export type ExtractionForbiddenErrorResponseContentData = {
38
38
  * Caller authorization failure.
39
39
  */
40
40
  export class ExtractionForbiddenErrorResponseContent
41
- extends PlaybookServiceError
41
+ extends AgentPlaybooksServiceError
42
42
  {
43
43
  /**
44
44
  * A short, human-readable summary of the problem
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * A dependent resource required to process the request is unavailable or unhealthy.
@@ -40,7 +40,9 @@ export type FailedDependencyErrorResponseContentData = {
40
40
  /**
41
41
  * A dependent resource required to process the request is unavailable or unhealthy.
42
42
  */
43
- export class FailedDependencyErrorResponseContent extends PlaybookServiceError {
43
+ export class FailedDependencyErrorResponseContent
44
+ extends AgentPlaybooksServiceError
45
+ {
44
46
  /**
45
47
  * A short, human-readable summary of the problem
46
48
  *
@@ -2,6 +2,7 @@
2
2
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
3
  */
4
4
 
5
+ export * from "./agent-playbooks-service-error.js";
5
6
  export * from "./api-error.js";
6
7
  export * from "./authentication-error-response-content.js";
7
8
  export * from "./bad-request-error-response-content.js";
@@ -11,7 +12,6 @@ export * from "./extraction-forbidden-error-response-content.js";
11
12
  export * from "./failed-dependency-error-response-content.js";
12
13
  export * from "./http-client-errors.js";
13
14
  export * from "./not-found-error-response-content.js";
14
- export * from "./playbook-service-error.js";
15
15
  export * from "./playbook-service-unavailable-error-response-content.js";
16
16
  export * from "./resource-suspended-error-response-content.js";
17
17
  export * from "./response-validation-error.js";
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * The requested resource does not exist.
@@ -40,7 +40,7 @@ export type NotFoundErrorResponseContentData = {
40
40
  /**
41
41
  * The requested resource does not exist.
42
42
  */
43
- export class NotFoundErrorResponseContent extends PlaybookServiceError {
43
+ export class NotFoundErrorResponseContent extends AgentPlaybooksServiceError {
44
44
  /**
45
45
  * A short, human-readable summary of the problem
46
46
  *
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  export type PlaybookServiceUnavailableErrorResponseContentData = {
10
10
  /**
@@ -32,7 +32,7 @@ export type PlaybookServiceUnavailableErrorResponseContentData = {
32
32
  };
33
33
 
34
34
  export class PlaybookServiceUnavailableErrorResponseContent
35
- extends PlaybookServiceError
35
+ extends AgentPlaybooksServiceError
36
36
  {
37
37
  /**
38
38
  * A short, human-readable summary of the problem
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * The requested resource exists but is suspended by an administrator.
@@ -41,7 +41,7 @@ export type ResourceSuspendedErrorResponseContentData = {
41
41
  * The requested resource exists but is suspended by an administrator.
42
42
  */
43
43
  export class ResourceSuspendedErrorResponseContent
44
- extends PlaybookServiceError
44
+ extends AgentPlaybooksServiceError
45
45
  {
46
46
  /**
47
47
  * A short, human-readable summary of the problem
@@ -3,10 +3,10 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
- import { PlaybookServiceError } from "./playbook-service-error.js";
6
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
7
7
  import { formatZodError } from "./sdk-validation-error.js";
8
8
 
9
- export class ResponseValidationError extends PlaybookServiceError {
9
+ export class ResponseValidationError extends AgentPlaybooksServiceError {
10
10
  /**
11
11
  * The raw value that failed validation.
12
12
  */
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * The request timed out before the service could complete it.
@@ -40,7 +40,7 @@ export type TimeoutErrorResponseContentData = {
40
40
  /**
41
41
  * The request timed out before the service could complete it.
42
42
  */
43
- export class TimeoutErrorResponseContent extends PlaybookServiceError {
43
+ export class TimeoutErrorResponseContent extends AgentPlaybooksServiceError {
44
44
  /**
45
45
  * A short, human-readable summary of the problem
46
46
  *
@@ -4,7 +4,7 @@
4
4
 
5
5
  import * as z from "zod/v3";
6
6
  import * as models from "../index.js";
7
- import { PlaybookServiceError } from "./playbook-service-error.js";
7
+ import { AgentPlaybooksServiceError } from "./agent-playbooks-service-error.js";
8
8
 
9
9
  /**
10
10
  * The service failed with an unexpected internal error.
@@ -40,7 +40,7 @@ export type UnexpectedErrorResponseContentData = {
40
40
  /**
41
41
  * The service failed with an unexpected internal error.
42
42
  */
43
- export class UnexpectedErrorResponseContent extends PlaybookServiceError {
43
+ export class UnexpectedErrorResponseContent extends AgentPlaybooksServiceError {
44
44
  /**
45
45
  * A short, human-readable summary of the problem
46
46
  *
@@ -13,7 +13,7 @@ import {
13
13
  } from "./extraction-source-type.js";
14
14
 
15
15
  /**
16
- * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
16
+ * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
17
17
  */
18
18
  export type ExtractionBindingSource = {
19
19
  storeId: string;
@@ -7,7 +7,6 @@ import * as openEnums from "../types/enums.js";
7
7
  import { OpenEnum } from "../types/enums.js";
8
8
 
9
9
  export const ExtractionBindingStatus = {
10
- Preparing: "preparing",
11
10
  Ready: "ready",
12
11
  Blocked: "blocked",
13
12
  Deleting: "deleting",
@@ -20,7 +20,7 @@ import {
20
20
  } from "./extraction-job.js";
21
21
 
22
22
  /**
23
- * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Ready means the configured extraction-worker grants were accepted; the worker validates live RAM access during execution. Without a configured RAM connection, preparation remains pending and cannot be enabled. This release has no extraction worker. Activation requires a separate PATCH after readiness.
23
+ * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Creation synchronously validates caller consent and exact RAM source ownership, returning ready and disabled. Every explicit enable revalidates with the current caller. Consent is durable account-owned configuration.
24
24
  */
25
25
  export type ExtractionBinding = {
26
26
  bindingId: string;
@@ -29,13 +29,13 @@ export type ExtractionBinding = {
29
29
  */
30
30
  playbookId: string;
31
31
  /**
32
- * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
32
+ * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
33
33
  */
34
34
  source: ExtractionBindingSource;
35
35
  job: ExtractionJob;
36
36
  status: ExtractionBindingStatus;
37
37
  /**
38
- * Activation intent. Creation is disabled; enabling requires ready status and a separate PATCH. Pausing clears intent and retains prepared source/destination grants.
38
+ * Activation intent. Creation is disabled. A separate enable PATCH revalidates current source consent and ownership, and can recover a blocked binding. Pausing clears intent without a RAM request or source permission.
39
39
  */
40
40
  enabled: boolean;
41
41
  /**
@@ -43,7 +43,7 @@ export type ExtractionBinding = {
43
43
  */
44
44
  version: number;
45
45
  /**
46
- * Machine-readable source preparation or execution failure reason, such as source_grant_refused, source_not_found, or source_access_denied. Clients must tolerate unknown reasons.
46
+ * Machine-readable runtime failure reason, such as source_not_found or source_access_denied. Clients must tolerate unknown reasons.
47
47
  */
48
48
  blockedReason?: string | undefined;
49
49
  /**
@@ -9,7 +9,7 @@ import {
9
9
  } from "./extraction-job-type.js";
10
10
 
11
11
  /**
12
- * One extraction kind and its user-owned policy. Scan cadence is fixed at 300 seconds and is not accepted in requests. Omitted idleWindowSeconds defaults to 1800 on create and retains its existing value on update. Idle bounds are 60–86400 seconds. Model context and output budgets are deployment-owned worker settings rather than binding fields. Job type is immutable; changing extraction kind requires a new binding. Policy changes advance the binding version and do not reset completed-source deduplication.
12
+ * One extraction kind and its user-owned policy. Scan cadence is deployment-owned worker configuration and is not accepted in requests or returned on bindings. Omitted idleWindowSeconds defaults to 1800 on create and retains its existing value on update. Idle bounds are 60–86400 seconds. Model context and output budgets are deployment-owned worker settings rather than binding fields. Job type is immutable; changing extraction kind requires a new binding. Policy changes advance the binding version and do not reset completed-source deduplication.
13
13
  */
14
14
  export type ExtractionJobConfiguration = {
15
15
  /**
@@ -16,10 +16,6 @@ export type ExtractionJob = {
16
16
  * Exactly one extraction job kind. Skill extraction is reserved for future implementation and is currently rejected.
17
17
  */
18
18
  type: ExtractionJobType;
19
- /**
20
- * Read-only platform scan cadence, fixed at 300 seconds.
21
- */
22
- intervalSeconds: number;
23
19
  idleWindowSeconds: number;
24
20
  };
25
21
 
@@ -30,7 +26,6 @@ export const ExtractionJob$inboundSchema: z.ZodType<
30
26
  unknown
31
27
  > = z.object({
32
28
  type: ExtractionJobType$inboundSchema,
33
- intervalSeconds: z.number().int(),
34
29
  idleWindowSeconds: z.number().int(),
35
30
  });
36
31
 
@@ -20,7 +20,7 @@ import {
20
20
  } from "./extraction-job.js";
21
21
 
22
22
  /**
23
- * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Ready means the configured extraction-worker grants were accepted; the worker validates live RAM access during execution. Without a configured RAM connection, preparation remains pending and cannot be enabled. This release has no extraction worker. Activation requires a separate PATCH after readiness.
23
+ * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Creation synchronously validates caller consent and exact RAM source ownership, returning ready and disabled. Every explicit enable revalidates with the current caller. Consent is durable account-owned configuration.
24
24
  */
25
25
  export type GetExtractionBindingResponseContent = {
26
26
  bindingId: string;
@@ -29,13 +29,13 @@ export type GetExtractionBindingResponseContent = {
29
29
  */
30
30
  playbookId: string;
31
31
  /**
32
- * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
32
+ * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
33
33
  */
34
34
  source: ExtractionBindingSource;
35
35
  job: ExtractionJob;
36
36
  status: ExtractionBindingStatus;
37
37
  /**
38
- * Activation intent. Creation is disabled; enabling requires ready status and a separate PATCH. Pausing clears intent and retains prepared source/destination grants.
38
+ * Activation intent. Creation is disabled. A separate enable PATCH revalidates current source consent and ownership, and can recover a blocked binding. Pausing clears intent without a RAM request or source permission.
39
39
  */
40
40
  enabled: boolean;
41
41
  /**
@@ -43,7 +43,7 @@ export type GetExtractionBindingResponseContent = {
43
43
  */
44
44
  version: number;
45
45
  /**
46
- * Machine-readable source preparation or execution failure reason, such as source_grant_refused, source_not_found, or source_access_denied. Clients must tolerate unknown reasons.
46
+ * Machine-readable runtime failure reason, such as source_not_found or source_access_denied. Clients must tolerate unknown reasons.
47
47
  */
48
48
  blockedReason?: string | undefined;
49
49
  /**
@@ -51,6 +51,9 @@ export type GetPlaybookResponseContent = {
51
51
  playbookId: string;
52
52
  tenantId: string;
53
53
  name: string;
54
+ /**
55
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
56
+ */
54
57
  state: PlaybookState;
55
58
  /**
56
59
  * Create-only embedding identity for a Playbook.
@@ -6,13 +6,20 @@ import * as z from "zod/v3";
6
6
  import * as openEnums from "../types/enums.js";
7
7
  import { OpenEnum } from "../types/enums.js";
8
8
 
9
+ /**
10
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
11
+ */
9
12
  export const PlaybookState = {
10
13
  Provisioning: "provisioning",
11
14
  Ready: "ready",
12
15
  Failed: "failed",
13
16
  Suspended: "suspended",
14
17
  Deleting: "deleting",
18
+ Unavailable: "unavailable",
15
19
  } as const;
20
+ /**
21
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
22
+ */
16
23
  export type PlaybookState = OpenEnum<typeof PlaybookState>;
17
24
 
18
25
  /** @internal */
@@ -51,6 +51,9 @@ export type Playbook = {
51
51
  playbookId: string;
52
52
  tenantId: string;
53
53
  name: string;
54
+ /**
55
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
56
+ */
54
57
  state: PlaybookState;
55
58
  /**
56
59
  * Create-only embedding identity for a Playbook.
@@ -12,7 +12,7 @@ import {
12
12
  export type UpdateExtractionBindingRequestContent = {
13
13
  expectedVersion: number;
14
14
  /**
15
- * One extraction kind and its user-owned policy. Scan cadence is fixed at 300 seconds and is not accepted in requests. Omitted idleWindowSeconds defaults to 1800 on create and retains its existing value on update. Idle bounds are 60–86400 seconds. Model context and output budgets are deployment-owned worker settings rather than binding fields. Job type is immutable; changing extraction kind requires a new binding. Policy changes advance the binding version and do not reset completed-source deduplication.
15
+ * One extraction kind and its user-owned policy. Scan cadence is deployment-owned worker configuration and is not accepted in requests or returned on bindings. Omitted idleWindowSeconds defaults to 1800 on create and retains its existing value on update. Idle bounds are 60–86400 seconds. Model context and output budgets are deployment-owned worker settings rather than binding fields. Job type is immutable; changing extraction kind requires a new binding. Policy changes advance the binding version and do not reset completed-source deduplication.
16
16
  */
17
17
  job?: ExtractionJobConfiguration | undefined;
18
18
  enabled?: boolean | undefined;
@@ -20,7 +20,7 @@ import {
20
20
  } from "./extraction-job.js";
21
21
 
22
22
  /**
23
- * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Ready means the configured extraction-worker grants were accepted; the worker validates live RAM access during execution. Without a configured RAM connection, preparation remains pending and cannot be enabled. This release has no extraction worker. Activation requires a separate PATCH after readiness.
23
+ * Durable tenant-owned metadata for one Playbook, one RAM store, and one FAQ policy. Creation synchronously validates caller consent and exact RAM source ownership, returning ready and disabled. Every explicit enable revalidates with the current caller. Consent is durable account-owned configuration.
24
24
  */
25
25
  export type UpdateExtractionBindingResponseContent = {
26
26
  bindingId: string;
@@ -29,13 +29,13 @@ export type UpdateExtractionBindingResponseContent = {
29
29
  */
30
30
  playbookId: string;
31
31
  /**
32
- * Typed RAM store reference. This release accepts only redis_agent_memory and a client-supplied storeId. The source is implicitly whole-store. When the deployment enables the RAM connection, server-side preparation verifies store access. Namespace selection and extraction workers arrive later; credentials are never accepted here. Unknown fields are rejected.
32
+ * Typed RAM store reference. Only redis_agent_memory with a client-supplied storeId is supported. The source is implicitly whole-store. The control plane verifies source consent and same-account/tenant RAM ownership on create and every explicit enable. Namespace selection is not supported. Credentials are never accepted here. Unknown fields are rejected.
33
33
  */
34
34
  source: ExtractionBindingSource;
35
35
  job: ExtractionJob;
36
36
  status: ExtractionBindingStatus;
37
37
  /**
38
- * Activation intent. Creation is disabled; enabling requires ready status and a separate PATCH. Pausing clears intent and retains prepared source/destination grants.
38
+ * Activation intent. Creation is disabled. A separate enable PATCH revalidates current source consent and ownership, and can recover a blocked binding. Pausing clears intent without a RAM request or source permission.
39
39
  */
40
40
  enabled: boolean;
41
41
  /**
@@ -43,7 +43,7 @@ export type UpdateExtractionBindingResponseContent = {
43
43
  */
44
44
  version: number;
45
45
  /**
46
- * Machine-readable source preparation or execution failure reason, such as source_grant_refused, source_not_found, or source_access_denied. Clients must tolerate unknown reasons.
46
+ * Machine-readable runtime failure reason, such as source_not_found or source_access_denied. Clients must tolerate unknown reasons.
47
47
  */
48
48
  blockedReason?: string | undefined;
49
49
  /**
@@ -51,6 +51,9 @@ export type UpdatePlaybookResponseContent = {
51
51
  playbookId: string;
52
52
  tenantId: string;
53
53
  name: string;
54
+ /**
55
+ * Effective read state. Cloud reads can report unavailable when live database metadata cannot be obtained; this state is never persisted and cannot be submitted in a mutation.
56
+ */
54
57
  state: PlaybookState;
55
58
  /**
56
59
  * Create-only embedding identity for a Playbook.