@gleanwork/api-client 0.19.0 → 0.19.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 (167) hide show
  1. package/README.md +15 -15
  2. package/dist/commonjs/__tests__/agents.test.js +6 -1
  3. package/dist/commonjs/__tests__/agents.test.js.map +1 -1
  4. package/dist/commonjs/__tests__/chat.test.js +1 -1
  5. package/dist/commonjs/__tests__/chat.test.js.map +1 -1
  6. package/dist/commonjs/__tests__/messages.test.js +1 -1
  7. package/dist/commonjs/__tests__/skills.test.js +3 -3
  8. package/dist/commonjs/__tests__/skills.test.js.map +1 -1
  9. package/dist/commonjs/__tests__/summarize.test.js +4 -2
  10. package/dist/commonjs/__tests__/summarize.test.js.map +1 -1
  11. package/dist/commonjs/funcs/clientAgentsList.d.ts +2 -0
  12. package/dist/commonjs/funcs/clientAgentsList.d.ts.map +1 -1
  13. package/dist/commonjs/funcs/clientAgentsList.js +2 -0
  14. package/dist/commonjs/funcs/clientAgentsList.js.map +1 -1
  15. package/dist/commonjs/funcs/clientAgentsRetrieve.d.ts +2 -0
  16. package/dist/commonjs/funcs/clientAgentsRetrieve.d.ts.map +1 -1
  17. package/dist/commonjs/funcs/clientAgentsRetrieve.js +2 -0
  18. package/dist/commonjs/funcs/clientAgentsRetrieve.js.map +1 -1
  19. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.d.ts +2 -0
  20. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.d.ts.map +1 -1
  21. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.js +2 -0
  22. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.js.map +1 -1
  23. package/dist/commonjs/funcs/clientAgentsRun.d.ts +2 -0
  24. package/dist/commonjs/funcs/clientAgentsRun.d.ts.map +1 -1
  25. package/dist/commonjs/funcs/clientAgentsRun.js +2 -0
  26. package/dist/commonjs/funcs/clientAgentsRun.js.map +1 -1
  27. package/dist/commonjs/funcs/clientAgentsRunStream.d.ts +2 -0
  28. package/dist/commonjs/funcs/clientAgentsRunStream.d.ts.map +1 -1
  29. package/dist/commonjs/funcs/clientAgentsRunStream.js +2 -0
  30. package/dist/commonjs/funcs/clientAgentsRunStream.js.map +1 -1
  31. package/dist/commonjs/lib/config.d.ts +3 -3
  32. package/dist/commonjs/lib/config.js +3 -3
  33. package/dist/commonjs/lib/encodings.d.ts +10 -9
  34. package/dist/commonjs/lib/encodings.d.ts.map +1 -1
  35. package/dist/commonjs/lib/encodings.js +29 -13
  36. package/dist/commonjs/lib/encodings.js.map +1 -1
  37. package/dist/commonjs/models/components/chatmessagefragment.d.ts +3 -0
  38. package/dist/commonjs/models/components/chatmessagefragment.d.ts.map +1 -1
  39. package/dist/commonjs/models/components/chatmessagefragment.js.map +1 -1
  40. package/dist/commonjs/models/components/importagentrequest.d.ts +1 -1
  41. package/dist/commonjs/models/components/servertoolrequest.d.ts +4 -0
  42. package/dist/commonjs/models/components/servertoolrequest.d.ts.map +1 -1
  43. package/dist/commonjs/models/components/servertoolrequest.js +4 -0
  44. package/dist/commonjs/models/components/servertoolrequest.js.map +1 -1
  45. package/dist/commonjs/models/components/servertoolresponse.d.ts +7 -0
  46. package/dist/commonjs/models/components/servertoolresponse.d.ts.map +1 -1
  47. package/dist/commonjs/models/components/servertoolresponse.js +4 -0
  48. package/dist/commonjs/models/components/servertoolresponse.js.map +1 -1
  49. package/dist/commonjs/react-query/clientAgentsList.d.ts +2 -0
  50. package/dist/commonjs/react-query/clientAgentsList.d.ts.map +1 -1
  51. package/dist/commonjs/react-query/clientAgentsList.js +2 -0
  52. package/dist/commonjs/react-query/clientAgentsList.js.map +1 -1
  53. package/dist/commonjs/react-query/clientAgentsRetrieve.d.ts +4 -0
  54. package/dist/commonjs/react-query/clientAgentsRetrieve.d.ts.map +1 -1
  55. package/dist/commonjs/react-query/clientAgentsRetrieve.js +4 -0
  56. package/dist/commonjs/react-query/clientAgentsRetrieve.js.map +1 -1
  57. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.d.ts +4 -0
  58. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.d.ts.map +1 -1
  59. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.js +4 -0
  60. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.js.map +1 -1
  61. package/dist/commonjs/react-query/clientAgentsRun.d.ts +2 -0
  62. package/dist/commonjs/react-query/clientAgentsRun.d.ts.map +1 -1
  63. package/dist/commonjs/react-query/clientAgentsRun.js +2 -0
  64. package/dist/commonjs/react-query/clientAgentsRun.js.map +1 -1
  65. package/dist/commonjs/react-query/clientAgentsRunStream.d.ts +2 -0
  66. package/dist/commonjs/react-query/clientAgentsRunStream.d.ts.map +1 -1
  67. package/dist/commonjs/react-query/clientAgentsRunStream.js +2 -0
  68. package/dist/commonjs/react-query/clientAgentsRunStream.js.map +1 -1
  69. package/dist/commonjs/sdk/clientagents.d.ts +10 -0
  70. package/dist/commonjs/sdk/clientagents.d.ts.map +1 -1
  71. package/dist/commonjs/sdk/clientagents.js +10 -0
  72. package/dist/commonjs/sdk/clientagents.js.map +1 -1
  73. package/dist/esm/__tests__/agents.test.js +6 -1
  74. package/dist/esm/__tests__/agents.test.js.map +1 -1
  75. package/dist/esm/__tests__/chat.test.js +1 -1
  76. package/dist/esm/__tests__/chat.test.js.map +1 -1
  77. package/dist/esm/__tests__/messages.test.js +1 -1
  78. package/dist/esm/__tests__/skills.test.js +3 -3
  79. package/dist/esm/__tests__/skills.test.js.map +1 -1
  80. package/dist/esm/__tests__/summarize.test.js +4 -2
  81. package/dist/esm/__tests__/summarize.test.js.map +1 -1
  82. package/dist/esm/funcs/clientAgentsList.d.ts +2 -0
  83. package/dist/esm/funcs/clientAgentsList.d.ts.map +1 -1
  84. package/dist/esm/funcs/clientAgentsList.js +2 -0
  85. package/dist/esm/funcs/clientAgentsList.js.map +1 -1
  86. package/dist/esm/funcs/clientAgentsRetrieve.d.ts +2 -0
  87. package/dist/esm/funcs/clientAgentsRetrieve.d.ts.map +1 -1
  88. package/dist/esm/funcs/clientAgentsRetrieve.js +2 -0
  89. package/dist/esm/funcs/clientAgentsRetrieve.js.map +1 -1
  90. package/dist/esm/funcs/clientAgentsRetrieveSchemas.d.ts +2 -0
  91. package/dist/esm/funcs/clientAgentsRetrieveSchemas.d.ts.map +1 -1
  92. package/dist/esm/funcs/clientAgentsRetrieveSchemas.js +2 -0
  93. package/dist/esm/funcs/clientAgentsRetrieveSchemas.js.map +1 -1
  94. package/dist/esm/funcs/clientAgentsRun.d.ts +2 -0
  95. package/dist/esm/funcs/clientAgentsRun.d.ts.map +1 -1
  96. package/dist/esm/funcs/clientAgentsRun.js +2 -0
  97. package/dist/esm/funcs/clientAgentsRun.js.map +1 -1
  98. package/dist/esm/funcs/clientAgentsRunStream.d.ts +2 -0
  99. package/dist/esm/funcs/clientAgentsRunStream.d.ts.map +1 -1
  100. package/dist/esm/funcs/clientAgentsRunStream.js +2 -0
  101. package/dist/esm/funcs/clientAgentsRunStream.js.map +1 -1
  102. package/dist/esm/lib/config.d.ts +3 -3
  103. package/dist/esm/lib/config.js +3 -3
  104. package/dist/esm/lib/encodings.d.ts +10 -9
  105. package/dist/esm/lib/encodings.d.ts.map +1 -1
  106. package/dist/esm/lib/encodings.js +29 -13
  107. package/dist/esm/lib/encodings.js.map +1 -1
  108. package/dist/esm/models/components/chatmessagefragment.d.ts +3 -0
  109. package/dist/esm/models/components/chatmessagefragment.d.ts.map +1 -1
  110. package/dist/esm/models/components/chatmessagefragment.js.map +1 -1
  111. package/dist/esm/models/components/importagentrequest.d.ts +1 -1
  112. package/dist/esm/models/components/servertoolrequest.d.ts +4 -0
  113. package/dist/esm/models/components/servertoolrequest.d.ts.map +1 -1
  114. package/dist/esm/models/components/servertoolrequest.js +4 -0
  115. package/dist/esm/models/components/servertoolrequest.js.map +1 -1
  116. package/dist/esm/models/components/servertoolresponse.d.ts +7 -0
  117. package/dist/esm/models/components/servertoolresponse.d.ts.map +1 -1
  118. package/dist/esm/models/components/servertoolresponse.js +4 -0
  119. package/dist/esm/models/components/servertoolresponse.js.map +1 -1
  120. package/dist/esm/react-query/clientAgentsList.d.ts +2 -0
  121. package/dist/esm/react-query/clientAgentsList.d.ts.map +1 -1
  122. package/dist/esm/react-query/clientAgentsList.js +2 -0
  123. package/dist/esm/react-query/clientAgentsList.js.map +1 -1
  124. package/dist/esm/react-query/clientAgentsRetrieve.d.ts +4 -0
  125. package/dist/esm/react-query/clientAgentsRetrieve.d.ts.map +1 -1
  126. package/dist/esm/react-query/clientAgentsRetrieve.js +4 -0
  127. package/dist/esm/react-query/clientAgentsRetrieve.js.map +1 -1
  128. package/dist/esm/react-query/clientAgentsRetrieveSchemas.d.ts +4 -0
  129. package/dist/esm/react-query/clientAgentsRetrieveSchemas.d.ts.map +1 -1
  130. package/dist/esm/react-query/clientAgentsRetrieveSchemas.js +4 -0
  131. package/dist/esm/react-query/clientAgentsRetrieveSchemas.js.map +1 -1
  132. package/dist/esm/react-query/clientAgentsRun.d.ts +2 -0
  133. package/dist/esm/react-query/clientAgentsRun.d.ts.map +1 -1
  134. package/dist/esm/react-query/clientAgentsRun.js +2 -0
  135. package/dist/esm/react-query/clientAgentsRun.js.map +1 -1
  136. package/dist/esm/react-query/clientAgentsRunStream.d.ts +2 -0
  137. package/dist/esm/react-query/clientAgentsRunStream.d.ts.map +1 -1
  138. package/dist/esm/react-query/clientAgentsRunStream.js +2 -0
  139. package/dist/esm/react-query/clientAgentsRunStream.js.map +1 -1
  140. package/dist/esm/sdk/clientagents.d.ts +10 -0
  141. package/dist/esm/sdk/clientagents.d.ts.map +1 -1
  142. package/dist/esm/sdk/clientagents.js +10 -0
  143. package/dist/esm/sdk/clientagents.js.map +1 -1
  144. package/jsr.json +1 -1
  145. package/package.json +1 -1
  146. package/src/__tests__/agents.test.ts +6 -1
  147. package/src/__tests__/chat.test.ts +1 -1
  148. package/src/__tests__/messages.test.ts +1 -1
  149. package/src/__tests__/skills.test.ts +3 -3
  150. package/src/__tests__/summarize.test.ts +4 -2
  151. package/src/funcs/clientAgentsList.ts +2 -0
  152. package/src/funcs/clientAgentsRetrieve.ts +2 -0
  153. package/src/funcs/clientAgentsRetrieveSchemas.ts +2 -0
  154. package/src/funcs/clientAgentsRun.ts +2 -0
  155. package/src/funcs/clientAgentsRunStream.ts +2 -0
  156. package/src/lib/config.ts +3 -3
  157. package/src/lib/encodings.ts +58 -23
  158. package/src/models/components/chatmessagefragment.ts +3 -0
  159. package/src/models/components/importagentrequest.ts +1 -1
  160. package/src/models/components/servertoolrequest.ts +4 -0
  161. package/src/models/components/servertoolresponse.ts +7 -0
  162. package/src/react-query/clientAgentsList.ts +2 -0
  163. package/src/react-query/clientAgentsRetrieve.ts +4 -0
  164. package/src/react-query/clientAgentsRetrieveSchemas.ts +4 -0
  165. package/src/react-query/clientAgentsRun.ts +2 -0
  166. package/src/react-query/clientAgentsRunStream.ts +2 -0
  167. package/src/sdk/clientagents.ts +10 -0
@@ -42,6 +42,8 @@ export class ClientAgents extends ClientSDK {
42
42
  *
43
43
  * @remarks
44
44
  * Returns details of an [agent](https://developers.glean.com/agents/agents-api) created in the Agent Builder.
45
+ *
46
+ * @deprecated method: Deprecated on 2026-08-25, removal scheduled for 2027-04-15: Use GET /api/agents/{agent_id} instead..
45
47
  */
46
48
  async retrieve(
47
49
  agentId: string,
@@ -86,6 +88,8 @@ export class ClientAgents extends ClientSDK {
86
88
  *
87
89
  * @remarks
88
90
  * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure.
91
+ *
92
+ * @deprecated method: Deprecated on 2026-08-25, removal scheduled for 2027-04-15: Use GET /api/agents/{agent_id}/schemas instead..
89
93
  */
90
94
  async retrieveSchemas(
91
95
  agentId: string,
@@ -130,6 +134,8 @@ export class ClientAgents extends ClientSDK {
130
134
  *
131
135
  * @remarks
132
136
  * Search for [agents](https://developers.glean.com/agents/agents-api) by agent name.
137
+ *
138
+ * @deprecated method: Deprecated on 2026-08-25, removal scheduled for 2027-04-15: Use POST /api/agents/search instead..
133
139
  */
134
140
  async list(
135
141
  request: components.SearchAgentsRequest,
@@ -147,6 +153,8 @@ export class ClientAgents extends ClientSDK {
147
153
  *
148
154
  * @remarks
149
155
  * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the result as a stream of server-sent events (SSE). **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
156
+ *
157
+ * @deprecated method: Deprecated on 2026-08-25, removal scheduled for 2027-04-15: Use POST /api/agents/{agent_id}/runs with stream=true instead..
150
158
  */
151
159
  async runStream(
152
160
  request: components.AgentRunCreate,
@@ -164,6 +172,8 @@ export class ClientAgents extends ClientSDK {
164
172
  *
165
173
  * @remarks
166
174
  * Executes an [agent](https://developers.glean.com/agents/agents-api) run and returns the final response. **Note**: If the agent uses an input form trigger, all form fields (including optional fields) must be included in the `input` object.
175
+ *
176
+ * @deprecated method: Deprecated on 2026-08-25, removal scheduled for 2027-04-15: Use POST /api/agents/{agent_id}/runs instead..
167
177
  */
168
178
  async run(
169
179
  request: components.AgentRunCreate,