@gleanwork/api-client 0.4.4 → 0.5.3

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 (236) hide show
  1. package/README.md +45 -45
  2. package/dist/commonjs/__tests__/agents.test.js +3 -1
  3. package/dist/commonjs/__tests__/agents.test.js.map +1 -1
  4. package/dist/commonjs/funcs/clientAgentsList.d.ts +2 -2
  5. package/dist/commonjs/funcs/clientAgentsList.js +2 -2
  6. package/dist/commonjs/funcs/clientAgentsRetrieve.d.ts +2 -2
  7. package/dist/commonjs/funcs/clientAgentsRetrieve.js +2 -2
  8. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.d.ts +2 -2
  9. package/dist/commonjs/funcs/clientAgentsRetrieveSchemas.js +2 -2
  10. package/dist/commonjs/funcs/clientAgentsRun.d.ts +2 -2
  11. package/dist/commonjs/funcs/clientAgentsRun.js +2 -2
  12. package/dist/commonjs/funcs/clientAgentsRunStream.d.ts +2 -2
  13. package/dist/commonjs/funcs/clientAgentsRunStream.js +2 -2
  14. package/dist/commonjs/funcs/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  15. package/dist/commonjs/funcs/clientGovernanceDataPoliciesCreate.js +1 -1
  16. package/dist/commonjs/funcs/clientGovernanceDataPoliciesDownload.d.ts +1 -1
  17. package/dist/commonjs/funcs/clientGovernanceDataPoliciesDownload.js +1 -1
  18. package/dist/commonjs/funcs/clientGovernanceDataPoliciesList.d.ts +1 -1
  19. package/dist/commonjs/funcs/clientGovernanceDataPoliciesList.js +1 -1
  20. package/dist/commonjs/funcs/clientGovernanceDataPoliciesRetrieve.d.ts +1 -1
  21. package/dist/commonjs/funcs/clientGovernanceDataPoliciesRetrieve.js +1 -1
  22. package/dist/commonjs/funcs/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  23. package/dist/commonjs/funcs/clientGovernanceDataPoliciesUpdate.js +1 -1
  24. package/dist/commonjs/funcs/clientGovernanceDataReportsCreate.d.ts +1 -1
  25. package/dist/commonjs/funcs/clientGovernanceDataReportsCreate.js +1 -1
  26. package/dist/commonjs/funcs/clientGovernanceDataReportsDownload.d.ts +1 -1
  27. package/dist/commonjs/funcs/clientGovernanceDataReportsDownload.js +1 -1
  28. package/dist/commonjs/funcs/clientGovernanceDataReportsStatus.d.ts +1 -1
  29. package/dist/commonjs/funcs/clientGovernanceDataReportsStatus.js +1 -1
  30. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  31. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  32. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesList.d.ts +1 -1
  33. package/dist/commonjs/funcs/clientGovernanceDocumentsVisibilityoverridesList.js +1 -1
  34. package/dist/commonjs/lib/config.d.ts +2 -2
  35. package/dist/commonjs/lib/config.js +2 -2
  36. package/dist/commonjs/models/components/agent.d.ts +16 -6
  37. package/dist/commonjs/models/components/agent.d.ts.map +1 -1
  38. package/dist/commonjs/models/components/agent.js.map +1 -1
  39. package/dist/commonjs/models/components/agentrun.d.ts +2 -2
  40. package/dist/commonjs/models/components/agentrun.d.ts.map +1 -1
  41. package/dist/commonjs/models/components/agentrun.js +2 -2
  42. package/dist/commonjs/models/components/agentrun.js.map +1 -1
  43. package/dist/commonjs/models/components/agentruncreate.d.ts +2 -2
  44. package/dist/commonjs/models/components/agentruncreate.d.ts.map +1 -1
  45. package/dist/commonjs/models/components/agentruncreate.js +2 -2
  46. package/dist/commonjs/models/components/agentruncreate.js.map +1 -1
  47. package/dist/commonjs/models/components/agentschemas.d.ts +4 -4
  48. package/dist/commonjs/models/components/chatrequest.d.ts +3 -0
  49. package/dist/commonjs/models/components/chatrequest.d.ts.map +1 -1
  50. package/dist/commonjs/models/components/chatrequest.js +3 -0
  51. package/dist/commonjs/models/components/chatrequest.js.map +1 -1
  52. package/dist/commonjs/models/components/searchagentsrequest.d.ts +1 -1
  53. package/dist/commonjs/models/components/workflow.d.ts +5 -5
  54. package/dist/commonjs/models/components/workflow.d.ts.map +1 -1
  55. package/dist/commonjs/models/components/workflow.js +2 -2
  56. package/dist/commonjs/models/components/workflow.js.map +1 -1
  57. package/dist/commonjs/react-query/clientAgentsList.d.ts +2 -2
  58. package/dist/commonjs/react-query/clientAgentsList.js +2 -2
  59. package/dist/commonjs/react-query/clientAgentsRetrieve.d.ts +4 -4
  60. package/dist/commonjs/react-query/clientAgentsRetrieve.js +4 -4
  61. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.d.ts +4 -4
  62. package/dist/commonjs/react-query/clientAgentsRetrieveSchemas.js +4 -4
  63. package/dist/commonjs/react-query/clientAgentsRun.d.ts +2 -2
  64. package/dist/commonjs/react-query/clientAgentsRun.js +2 -2
  65. package/dist/commonjs/react-query/clientAgentsRunStream.d.ts +2 -2
  66. package/dist/commonjs/react-query/clientAgentsRunStream.js +2 -2
  67. package/dist/commonjs/react-query/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  68. package/dist/commonjs/react-query/clientGovernanceDataPoliciesCreate.js +1 -1
  69. package/dist/commonjs/react-query/clientGovernanceDataPoliciesDownload.d.ts +2 -2
  70. package/dist/commonjs/react-query/clientGovernanceDataPoliciesDownload.js +2 -2
  71. package/dist/commonjs/react-query/clientGovernanceDataPoliciesList.d.ts +2 -2
  72. package/dist/commonjs/react-query/clientGovernanceDataPoliciesList.js +2 -2
  73. package/dist/commonjs/react-query/clientGovernanceDataPoliciesRetrieve.d.ts +2 -2
  74. package/dist/commonjs/react-query/clientGovernanceDataPoliciesRetrieve.js +2 -2
  75. package/dist/commonjs/react-query/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  76. package/dist/commonjs/react-query/clientGovernanceDataPoliciesUpdate.js +1 -1
  77. package/dist/commonjs/react-query/clientGovernanceDataReportsCreate.d.ts +1 -1
  78. package/dist/commonjs/react-query/clientGovernanceDataReportsCreate.js +1 -1
  79. package/dist/commonjs/react-query/clientGovernanceDataReportsDownload.d.ts +2 -2
  80. package/dist/commonjs/react-query/clientGovernanceDataReportsDownload.js +2 -2
  81. package/dist/commonjs/react-query/clientGovernanceDataReportsStatus.d.ts +2 -2
  82. package/dist/commonjs/react-query/clientGovernanceDataReportsStatus.js +2 -2
  83. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  84. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  85. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesList.d.ts +2 -2
  86. package/dist/commonjs/react-query/clientGovernanceDocumentsVisibilityoverridesList.js +2 -2
  87. package/dist/commonjs/sdk/agents.d.ts +10 -10
  88. package/dist/commonjs/sdk/agents.js +10 -10
  89. package/dist/commonjs/sdk/policies.d.ts +5 -5
  90. package/dist/commonjs/sdk/policies.js +5 -5
  91. package/dist/commonjs/sdk/reports.d.ts +3 -3
  92. package/dist/commonjs/sdk/reports.js +3 -3
  93. package/dist/commonjs/sdk/visibilityoverrides.d.ts +2 -2
  94. package/dist/commonjs/sdk/visibilityoverrides.js +2 -2
  95. package/dist/esm/__tests__/agents.test.js +3 -1
  96. package/dist/esm/__tests__/agents.test.js.map +1 -1
  97. package/dist/esm/funcs/clientAgentsList.d.ts +2 -2
  98. package/dist/esm/funcs/clientAgentsList.js +2 -2
  99. package/dist/esm/funcs/clientAgentsRetrieve.d.ts +2 -2
  100. package/dist/esm/funcs/clientAgentsRetrieve.js +2 -2
  101. package/dist/esm/funcs/clientAgentsRetrieveSchemas.d.ts +2 -2
  102. package/dist/esm/funcs/clientAgentsRetrieveSchemas.js +2 -2
  103. package/dist/esm/funcs/clientAgentsRun.d.ts +2 -2
  104. package/dist/esm/funcs/clientAgentsRun.js +2 -2
  105. package/dist/esm/funcs/clientAgentsRunStream.d.ts +2 -2
  106. package/dist/esm/funcs/clientAgentsRunStream.js +2 -2
  107. package/dist/esm/funcs/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  108. package/dist/esm/funcs/clientGovernanceDataPoliciesCreate.js +1 -1
  109. package/dist/esm/funcs/clientGovernanceDataPoliciesDownload.d.ts +1 -1
  110. package/dist/esm/funcs/clientGovernanceDataPoliciesDownload.js +1 -1
  111. package/dist/esm/funcs/clientGovernanceDataPoliciesList.d.ts +1 -1
  112. package/dist/esm/funcs/clientGovernanceDataPoliciesList.js +1 -1
  113. package/dist/esm/funcs/clientGovernanceDataPoliciesRetrieve.d.ts +1 -1
  114. package/dist/esm/funcs/clientGovernanceDataPoliciesRetrieve.js +1 -1
  115. package/dist/esm/funcs/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  116. package/dist/esm/funcs/clientGovernanceDataPoliciesUpdate.js +1 -1
  117. package/dist/esm/funcs/clientGovernanceDataReportsCreate.d.ts +1 -1
  118. package/dist/esm/funcs/clientGovernanceDataReportsCreate.js +1 -1
  119. package/dist/esm/funcs/clientGovernanceDataReportsDownload.d.ts +1 -1
  120. package/dist/esm/funcs/clientGovernanceDataReportsDownload.js +1 -1
  121. package/dist/esm/funcs/clientGovernanceDataReportsStatus.d.ts +1 -1
  122. package/dist/esm/funcs/clientGovernanceDataReportsStatus.js +1 -1
  123. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  124. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  125. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesList.d.ts +1 -1
  126. package/dist/esm/funcs/clientGovernanceDocumentsVisibilityoverridesList.js +1 -1
  127. package/dist/esm/lib/config.d.ts +2 -2
  128. package/dist/esm/lib/config.js +2 -2
  129. package/dist/esm/models/components/agent.d.ts +16 -6
  130. package/dist/esm/models/components/agent.d.ts.map +1 -1
  131. package/dist/esm/models/components/agent.js.map +1 -1
  132. package/dist/esm/models/components/agentrun.d.ts +2 -2
  133. package/dist/esm/models/components/agentrun.d.ts.map +1 -1
  134. package/dist/esm/models/components/agentrun.js +2 -2
  135. package/dist/esm/models/components/agentrun.js.map +1 -1
  136. package/dist/esm/models/components/agentruncreate.d.ts +2 -2
  137. package/dist/esm/models/components/agentruncreate.d.ts.map +1 -1
  138. package/dist/esm/models/components/agentruncreate.js +2 -2
  139. package/dist/esm/models/components/agentruncreate.js.map +1 -1
  140. package/dist/esm/models/components/agentschemas.d.ts +4 -4
  141. package/dist/esm/models/components/chatrequest.d.ts +3 -0
  142. package/dist/esm/models/components/chatrequest.d.ts.map +1 -1
  143. package/dist/esm/models/components/chatrequest.js +3 -0
  144. package/dist/esm/models/components/chatrequest.js.map +1 -1
  145. package/dist/esm/models/components/searchagentsrequest.d.ts +1 -1
  146. package/dist/esm/models/components/workflow.d.ts +5 -5
  147. package/dist/esm/models/components/workflow.d.ts.map +1 -1
  148. package/dist/esm/models/components/workflow.js +2 -2
  149. package/dist/esm/models/components/workflow.js.map +1 -1
  150. package/dist/esm/react-query/clientAgentsList.d.ts +2 -2
  151. package/dist/esm/react-query/clientAgentsList.js +2 -2
  152. package/dist/esm/react-query/clientAgentsRetrieve.d.ts +4 -4
  153. package/dist/esm/react-query/clientAgentsRetrieve.js +4 -4
  154. package/dist/esm/react-query/clientAgentsRetrieveSchemas.d.ts +4 -4
  155. package/dist/esm/react-query/clientAgentsRetrieveSchemas.js +4 -4
  156. package/dist/esm/react-query/clientAgentsRun.d.ts +2 -2
  157. package/dist/esm/react-query/clientAgentsRun.js +2 -2
  158. package/dist/esm/react-query/clientAgentsRunStream.d.ts +2 -2
  159. package/dist/esm/react-query/clientAgentsRunStream.js +2 -2
  160. package/dist/esm/react-query/clientGovernanceDataPoliciesCreate.d.ts +1 -1
  161. package/dist/esm/react-query/clientGovernanceDataPoliciesCreate.js +1 -1
  162. package/dist/esm/react-query/clientGovernanceDataPoliciesDownload.d.ts +2 -2
  163. package/dist/esm/react-query/clientGovernanceDataPoliciesDownload.js +2 -2
  164. package/dist/esm/react-query/clientGovernanceDataPoliciesList.d.ts +2 -2
  165. package/dist/esm/react-query/clientGovernanceDataPoliciesList.js +2 -2
  166. package/dist/esm/react-query/clientGovernanceDataPoliciesRetrieve.d.ts +2 -2
  167. package/dist/esm/react-query/clientGovernanceDataPoliciesRetrieve.js +2 -2
  168. package/dist/esm/react-query/clientGovernanceDataPoliciesUpdate.d.ts +1 -1
  169. package/dist/esm/react-query/clientGovernanceDataPoliciesUpdate.js +1 -1
  170. package/dist/esm/react-query/clientGovernanceDataReportsCreate.d.ts +1 -1
  171. package/dist/esm/react-query/clientGovernanceDataReportsCreate.js +1 -1
  172. package/dist/esm/react-query/clientGovernanceDataReportsDownload.d.ts +2 -2
  173. package/dist/esm/react-query/clientGovernanceDataReportsDownload.js +2 -2
  174. package/dist/esm/react-query/clientGovernanceDataReportsStatus.d.ts +2 -2
  175. package/dist/esm/react-query/clientGovernanceDataReportsStatus.js +2 -2
  176. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.d.ts +1 -1
  177. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.js +1 -1
  178. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesList.d.ts +2 -2
  179. package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesList.js +2 -2
  180. package/dist/esm/sdk/agents.d.ts +10 -10
  181. package/dist/esm/sdk/agents.js +10 -10
  182. package/dist/esm/sdk/policies.d.ts +5 -5
  183. package/dist/esm/sdk/policies.js +5 -5
  184. package/dist/esm/sdk/reports.d.ts +3 -3
  185. package/dist/esm/sdk/reports.js +3 -3
  186. package/dist/esm/sdk/visibilityoverrides.d.ts +2 -2
  187. package/dist/esm/sdk/visibilityoverrides.js +2 -2
  188. package/docs/sdks/agents/README.md +28 -16
  189. package/docs/sdks/policies/README.md +5 -5
  190. package/docs/sdks/reports/README.md +3 -3
  191. package/docs/sdks/visibilityoverrides/README.md +2 -2
  192. package/jsr.json +1 -1
  193. package/package.json +1 -1
  194. package/src/__tests__/agents.test.ts +3 -1
  195. package/src/funcs/clientAgentsList.ts +2 -2
  196. package/src/funcs/clientAgentsRetrieve.ts +2 -2
  197. package/src/funcs/clientAgentsRetrieveSchemas.ts +2 -2
  198. package/src/funcs/clientAgentsRun.ts +2 -2
  199. package/src/funcs/clientAgentsRunStream.ts +2 -2
  200. package/src/funcs/clientGovernanceDataPoliciesCreate.ts +1 -1
  201. package/src/funcs/clientGovernanceDataPoliciesDownload.ts +1 -1
  202. package/src/funcs/clientGovernanceDataPoliciesList.ts +1 -1
  203. package/src/funcs/clientGovernanceDataPoliciesRetrieve.ts +1 -1
  204. package/src/funcs/clientGovernanceDataPoliciesUpdate.ts +1 -1
  205. package/src/funcs/clientGovernanceDataReportsCreate.ts +1 -1
  206. package/src/funcs/clientGovernanceDataReportsDownload.ts +1 -1
  207. package/src/funcs/clientGovernanceDataReportsStatus.ts +1 -1
  208. package/src/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.ts +1 -1
  209. package/src/funcs/clientGovernanceDocumentsVisibilityoverridesList.ts +1 -1
  210. package/src/lib/config.ts +2 -2
  211. package/src/models/components/agent.ts +16 -6
  212. package/src/models/components/agentrun.ts +4 -4
  213. package/src/models/components/agentruncreate.ts +4 -4
  214. package/src/models/components/agentschemas.ts +4 -4
  215. package/src/models/components/chatrequest.ts +10 -0
  216. package/src/models/components/searchagentsrequest.ts +1 -1
  217. package/src/models/components/workflow.ts +7 -7
  218. package/src/react-query/clientAgentsList.ts +2 -2
  219. package/src/react-query/clientAgentsRetrieve.ts +4 -4
  220. package/src/react-query/clientAgentsRetrieveSchemas.ts +4 -4
  221. package/src/react-query/clientAgentsRun.ts +2 -2
  222. package/src/react-query/clientAgentsRunStream.ts +2 -2
  223. package/src/react-query/clientGovernanceDataPoliciesCreate.ts +1 -1
  224. package/src/react-query/clientGovernanceDataPoliciesDownload.ts +2 -2
  225. package/src/react-query/clientGovernanceDataPoliciesList.ts +2 -2
  226. package/src/react-query/clientGovernanceDataPoliciesRetrieve.ts +2 -2
  227. package/src/react-query/clientGovernanceDataPoliciesUpdate.ts +1 -1
  228. package/src/react-query/clientGovernanceDataReportsCreate.ts +1 -1
  229. package/src/react-query/clientGovernanceDataReportsDownload.ts +2 -2
  230. package/src/react-query/clientGovernanceDataReportsStatus.ts +2 -2
  231. package/src/react-query/clientGovernanceDocumentsVisibilityoverridesCreate.ts +1 -1
  232. package/src/react-query/clientGovernanceDocumentsVisibilityoverridesList.ts +2 -2
  233. package/src/sdk/agents.ts +10 -10
  234. package/src/sdk/policies.ts +5 -5
  235. package/src/sdk/reports.ts +3 -3
  236. package/src/sdk/visibilityoverrides.ts +2 -2
@@ -13,7 +13,7 @@ import { unwrapAsync } from "../types/fp.js";
13
13
 
14
14
  export class Policies extends ClientSDK {
15
15
  /**
16
- * Gets specified Policy.
16
+ * Gets specified policy
17
17
  *
18
18
  * @remarks
19
19
  * Fetches the specified policy version, or the latest if no version is provided.
@@ -32,7 +32,7 @@ export class Policies extends ClientSDK {
32
32
  }
33
33
 
34
34
  /**
35
- * Updates an existing policy.
35
+ * Updates an existing policy
36
36
  *
37
37
  * @remarks
38
38
  * Updates an existing policy.
@@ -51,7 +51,7 @@ export class Policies extends ClientSDK {
51
51
  }
52
52
 
53
53
  /**
54
- * Lists policies.
54
+ * Lists policies
55
55
  *
56
56
  * @remarks
57
57
  * Lists policies with filtering.
@@ -70,7 +70,7 @@ export class Policies extends ClientSDK {
70
70
  }
71
71
 
72
72
  /**
73
- * Creates new policy.
73
+ * Creates new policy
74
74
  *
75
75
  * @remarks
76
76
  * Creates a new policy with specified specifications and returns its id.
@@ -87,7 +87,7 @@ export class Policies extends ClientSDK {
87
87
  }
88
88
 
89
89
  /**
90
- * Downloads violations CSV for policy.
90
+ * Downloads violations CSV for policy
91
91
  *
92
92
  * @remarks
93
93
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
@@ -11,7 +11,7 @@ import { unwrapAsync } from "../types/fp.js";
11
11
 
12
12
  export class Reports extends ClientSDK {
13
13
  /**
14
- * Creates new one-time report.
14
+ * Creates new one-time report
15
15
  *
16
16
  * @remarks
17
17
  * Creates a new one-time report and executes its batch job.
@@ -28,7 +28,7 @@ export class Reports extends ClientSDK {
28
28
  }
29
29
 
30
30
  /**
31
- * Downloads violations CSV for report.
31
+ * Downloads violations CSV for report
32
32
  *
33
33
  * @remarks
34
34
  * Downloads CSV violations report for a specific report id.
@@ -45,7 +45,7 @@ export class Reports extends ClientSDK {
45
45
  }
46
46
 
47
47
  /**
48
- * Fetches report run status.
48
+ * Fetches report run status
49
49
  *
50
50
  * @remarks
51
51
  * Fetches the status of the run corresponding to the report-id.
@@ -10,7 +10,7 @@ import { unwrapAsync } from "../types/fp.js";
10
10
 
11
11
  export class Visibilityoverrides extends ClientSDK {
12
12
  /**
13
- * Fetches documents visibility.
13
+ * Fetches documents visibility
14
14
  *
15
15
  * @remarks
16
16
  * Fetches the visibility override status of the documents passed.
@@ -27,7 +27,7 @@ export class Visibilityoverrides extends ClientSDK {
27
27
  }
28
28
 
29
29
  /**
30
- * Hide/Un-hide docs.
30
+ * Hide or unhide docs
31
31
  *
32
32
  * @remarks
33
33
  * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.