@gleanwork/api-client 0.4.0 → 0.4.1

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 (173) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/REACT_QUERY.md +3 -3
  3. package/README.md +11 -11
  4. package/dist/commonjs/__tests__/activity.test.js +2 -2
  5. package/dist/commonjs/__tests__/activity.test.js.map +1 -1
  6. package/dist/commonjs/__tests__/adminsearch.test.js +1 -1
  7. package/dist/commonjs/__tests__/adminsearch.test.js.map +1 -1
  8. package/dist/commonjs/__tests__/agents.test.js +4 -4
  9. package/dist/commonjs/__tests__/agents.test.js.map +1 -1
  10. package/dist/commonjs/__tests__/announcements.test.js +3 -3
  11. package/dist/commonjs/__tests__/announcements.test.js.map +1 -1
  12. package/dist/commonjs/__tests__/answers.test.js +5 -5
  13. package/dist/commonjs/__tests__/answers.test.js.map +1 -1
  14. package/dist/commonjs/__tests__/chat.test.js +18 -18
  15. package/dist/commonjs/__tests__/chat.test.js.map +1 -1
  16. package/dist/commonjs/__tests__/clientauthentication.test.js +1 -1
  17. package/dist/commonjs/__tests__/clientauthentication.test.js.map +1 -1
  18. package/dist/commonjs/__tests__/clientdocuments.test.js +4 -4
  19. package/dist/commonjs/__tests__/clientdocuments.test.js.map +1 -1
  20. package/dist/commonjs/__tests__/clientsearch.test.js +3 -3
  21. package/dist/commonjs/__tests__/clientsearch.test.js.map +1 -1
  22. package/dist/commonjs/__tests__/clientshortcuts.test.js +5 -5
  23. package/dist/commonjs/__tests__/clientshortcuts.test.js.map +1 -1
  24. package/dist/commonjs/__tests__/collections.test.js +8 -8
  25. package/dist/commonjs/__tests__/collections.test.js.map +1 -1
  26. package/dist/commonjs/__tests__/datasources.test.js +2 -2
  27. package/dist/commonjs/__tests__/datasources.test.js.map +1 -1
  28. package/dist/commonjs/__tests__/entities.test.js +2 -2
  29. package/dist/commonjs/__tests__/entities.test.js.map +1 -1
  30. package/dist/commonjs/__tests__/indexingauthentication.test.js +1 -1
  31. package/dist/commonjs/__tests__/indexingauthentication.test.js.map +1 -1
  32. package/dist/commonjs/__tests__/indexingdocuments.test.js +8 -8
  33. package/dist/commonjs/__tests__/indexingdocuments.test.js.map +1 -1
  34. package/dist/commonjs/__tests__/indexingpeople.test.js +2 -2
  35. package/dist/commonjs/__tests__/indexingpeople.test.js.map +1 -1
  36. package/dist/commonjs/__tests__/insights.test.js +1 -1
  37. package/dist/commonjs/__tests__/insights.test.js.map +1 -1
  38. package/dist/commonjs/__tests__/messages.test.js +1 -1
  39. package/dist/commonjs/__tests__/messages.test.js.map +1 -1
  40. package/dist/commonjs/__tests__/permissions.test.js +12 -12
  41. package/dist/commonjs/__tests__/permissions.test.js.map +1 -1
  42. package/dist/commonjs/__tests__/pins.test.js +5 -5
  43. package/dist/commonjs/__tests__/pins.test.js.map +1 -1
  44. package/dist/commonjs/__tests__/policies.test.js +2 -2
  45. package/dist/commonjs/__tests__/policies.test.js.map +1 -1
  46. package/dist/commonjs/__tests__/search.test.js +1 -1
  47. package/dist/commonjs/__tests__/search.test.js.map +1 -1
  48. package/dist/commonjs/__tests__/verification.test.js +3 -3
  49. package/dist/commonjs/__tests__/verification.test.js.map +1 -1
  50. package/dist/commonjs/lib/config.d.ts +2 -2
  51. package/dist/commonjs/lib/config.js +2 -2
  52. package/dist/commonjs/lib/env.d.ts +1 -1
  53. package/dist/commonjs/lib/env.d.ts.map +1 -1
  54. package/dist/commonjs/lib/env.js +1 -1
  55. package/dist/commonjs/lib/env.js.map +1 -1
  56. package/dist/commonjs/lib/security.js +2 -2
  57. package/dist/commonjs/lib/security.js.map +1 -1
  58. package/dist/commonjs/models/components/security.d.ts +2 -2
  59. package/dist/commonjs/models/components/security.d.ts.map +1 -1
  60. package/dist/commonjs/models/components/security.js +11 -2
  61. package/dist/commonjs/models/components/security.js.map +1 -1
  62. package/dist/esm/__tests__/activity.test.js +2 -2
  63. package/dist/esm/__tests__/activity.test.js.map +1 -1
  64. package/dist/esm/__tests__/adminsearch.test.js +1 -1
  65. package/dist/esm/__tests__/adminsearch.test.js.map +1 -1
  66. package/dist/esm/__tests__/agents.test.js +4 -4
  67. package/dist/esm/__tests__/agents.test.js.map +1 -1
  68. package/dist/esm/__tests__/announcements.test.js +3 -3
  69. package/dist/esm/__tests__/announcements.test.js.map +1 -1
  70. package/dist/esm/__tests__/answers.test.js +5 -5
  71. package/dist/esm/__tests__/answers.test.js.map +1 -1
  72. package/dist/esm/__tests__/chat.test.js +18 -18
  73. package/dist/esm/__tests__/chat.test.js.map +1 -1
  74. package/dist/esm/__tests__/clientauthentication.test.js +1 -1
  75. package/dist/esm/__tests__/clientauthentication.test.js.map +1 -1
  76. package/dist/esm/__tests__/clientdocuments.test.js +4 -4
  77. package/dist/esm/__tests__/clientdocuments.test.js.map +1 -1
  78. package/dist/esm/__tests__/clientsearch.test.js +3 -3
  79. package/dist/esm/__tests__/clientsearch.test.js.map +1 -1
  80. package/dist/esm/__tests__/clientshortcuts.test.js +5 -5
  81. package/dist/esm/__tests__/clientshortcuts.test.js.map +1 -1
  82. package/dist/esm/__tests__/collections.test.js +8 -8
  83. package/dist/esm/__tests__/collections.test.js.map +1 -1
  84. package/dist/esm/__tests__/datasources.test.js +2 -2
  85. package/dist/esm/__tests__/datasources.test.js.map +1 -1
  86. package/dist/esm/__tests__/entities.test.js +2 -2
  87. package/dist/esm/__tests__/entities.test.js.map +1 -1
  88. package/dist/esm/__tests__/indexingauthentication.test.js +1 -1
  89. package/dist/esm/__tests__/indexingauthentication.test.js.map +1 -1
  90. package/dist/esm/__tests__/indexingdocuments.test.js +8 -8
  91. package/dist/esm/__tests__/indexingdocuments.test.js.map +1 -1
  92. package/dist/esm/__tests__/indexingpeople.test.js +2 -2
  93. package/dist/esm/__tests__/indexingpeople.test.js.map +1 -1
  94. package/dist/esm/__tests__/insights.test.js +1 -1
  95. package/dist/esm/__tests__/insights.test.js.map +1 -1
  96. package/dist/esm/__tests__/messages.test.js +1 -1
  97. package/dist/esm/__tests__/messages.test.js.map +1 -1
  98. package/dist/esm/__tests__/permissions.test.js +12 -12
  99. package/dist/esm/__tests__/permissions.test.js.map +1 -1
  100. package/dist/esm/__tests__/pins.test.js +5 -5
  101. package/dist/esm/__tests__/pins.test.js.map +1 -1
  102. package/dist/esm/__tests__/policies.test.js +2 -2
  103. package/dist/esm/__tests__/policies.test.js.map +1 -1
  104. package/dist/esm/__tests__/search.test.js +1 -1
  105. package/dist/esm/__tests__/search.test.js.map +1 -1
  106. package/dist/esm/__tests__/verification.test.js +3 -3
  107. package/dist/esm/__tests__/verification.test.js.map +1 -1
  108. package/dist/esm/lib/config.d.ts +2 -2
  109. package/dist/esm/lib/config.js +2 -2
  110. package/dist/esm/lib/env.d.ts +1 -1
  111. package/dist/esm/lib/env.d.ts.map +1 -1
  112. package/dist/esm/lib/env.js +1 -1
  113. package/dist/esm/lib/env.js.map +1 -1
  114. package/dist/esm/lib/security.js +2 -2
  115. package/dist/esm/lib/security.js.map +1 -1
  116. package/dist/esm/models/components/security.d.ts +2 -2
  117. package/dist/esm/models/components/security.d.ts.map +1 -1
  118. package/dist/esm/models/components/security.js +11 -2
  119. package/dist/esm/models/components/security.js.map +1 -1
  120. package/docs/sdks/activity/README.md +4 -4
  121. package/docs/sdks/agents/README.md +10 -10
  122. package/docs/sdks/announcements/README.md +6097 -861
  123. package/docs/sdks/answers/README.md +10 -10
  124. package/docs/sdks/chat/README.md +20 -20
  125. package/docs/sdks/clientauthentication/README.md +2 -2
  126. package/docs/sdks/clientdocuments/README.md +8 -8
  127. package/docs/sdks/clientshortcuts/README.md +10 -10
  128. package/docs/sdks/collections/README.md +16 -16
  129. package/docs/sdks/datasource/README.md +2 -2
  130. package/docs/sdks/datasources/README.md +4 -4
  131. package/docs/sdks/entities/README.md +4 -4
  132. package/docs/sdks/indexingauthentication/README.md +2 -2
  133. package/docs/sdks/indexingdocuments/README.md +20 -20
  134. package/docs/sdks/indexingshortcuts/README.md +4 -4
  135. package/docs/sdks/insights/README.md +2 -2
  136. package/docs/sdks/messages/README.md +2 -2
  137. package/docs/sdks/people/README.md +18 -18
  138. package/docs/sdks/permissions/README.md +24 -24
  139. package/docs/sdks/pins/README.md +10 -10
  140. package/docs/sdks/policies/README.md +10 -10
  141. package/docs/sdks/reports/README.md +6 -6
  142. package/docs/sdks/search/README.md +10 -10
  143. package/docs/sdks/verification/README.md +6 -6
  144. package/docs/sdks/visibilityoverrides/README.md +4 -4
  145. package/jsr.json +1 -1
  146. package/package.json +1 -1
  147. package/src/__tests__/activity.test.ts +2 -2
  148. package/src/__tests__/adminsearch.test.ts +1 -1
  149. package/src/__tests__/agents.test.ts +4 -4
  150. package/src/__tests__/announcements.test.ts +3 -3
  151. package/src/__tests__/answers.test.ts +5 -5
  152. package/src/__tests__/chat.test.ts +18 -18
  153. package/src/__tests__/clientauthentication.test.ts +1 -1
  154. package/src/__tests__/clientdocuments.test.ts +4 -4
  155. package/src/__tests__/clientsearch.test.ts +3 -3
  156. package/src/__tests__/clientshortcuts.test.ts +5 -5
  157. package/src/__tests__/collections.test.ts +8 -8
  158. package/src/__tests__/datasources.test.ts +2 -2
  159. package/src/__tests__/entities.test.ts +2 -2
  160. package/src/__tests__/indexingauthentication.test.ts +1 -1
  161. package/src/__tests__/indexingdocuments.test.ts +8 -8
  162. package/src/__tests__/indexingpeople.test.ts +2 -2
  163. package/src/__tests__/insights.test.ts +1 -1
  164. package/src/__tests__/messages.test.ts +1 -1
  165. package/src/__tests__/permissions.test.ts +12 -12
  166. package/src/__tests__/pins.test.ts +5 -5
  167. package/src/__tests__/policies.test.ts +2 -2
  168. package/src/__tests__/search.test.ts +1 -1
  169. package/src/__tests__/verification.test.ts +3 -3
  170. package/src/lib/config.ts +2 -2
  171. package/src/lib/env.ts +2 -2
  172. package/src/lib/security.ts +2 -2
  173. package/src/models/components/security.ts +13 -4
package/dist/commonjs/__tests__/chat.test.js CHANGED
@@ -12,7 +12,7 @@ const testclient_js_1 = require("./testclient.js");
12
12
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
13
13
  httpClient: testHttpClient,
14
14
  security: {
15
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
15
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
16
16
  },
17
17
  });
18
18
  const result = await glean.client.chat.create({
@@ -34,7 +34,7 @@ const testclient_js_1 = require("./testclient.js");
34
34
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
35
35
  httpClient: testHttpClient,
36
36
  security: {
37
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
37
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
38
38
  },
39
39
  });
40
40
  const result = await glean.client.chat.create({
@@ -59,7 +59,7 @@ const testclient_js_1 = require("./testclient.js");
59
59
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
60
60
  httpClient: testHttpClient,
61
61
  security: {
62
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
62
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
63
63
  },
64
64
  });
65
65
  const result = await glean.client.chat.create({
@@ -4383,7 +4383,7 @@ const testclient_js_1 = require("./testclient.js");
4383
4383
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
4384
4384
  httpClient: testHttpClient,
4385
4385
  security: {
4386
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
4386
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
4387
4387
  },
4388
4388
  });
4389
4389
  const result = await glean.client.chat.create({
@@ -8392,7 +8392,7 @@ const testclient_js_1 = require("./testclient.js");
8392
8392
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
8393
8393
  httpClient: testHttpClient,
8394
8394
  security: {
8395
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
8395
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
8396
8396
  },
8397
8397
  });
8398
8398
  const result = await glean.client.chat.create({
@@ -11089,7 +11089,7 @@ const testclient_js_1 = require("./testclient.js");
11089
11089
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11090
11090
  httpClient: testHttpClient,
11091
11091
  security: {
11092
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11092
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11093
11093
  },
11094
11094
  });
11095
11095
  await glean.client.chat.deleteAll();
@@ -11100,7 +11100,7 @@ const testclient_js_1 = require("./testclient.js");
11100
11100
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11101
11101
  httpClient: testHttpClient,
11102
11102
  security: {
11103
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11103
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11104
11104
  },
11105
11105
  });
11106
11106
  await glean.client.chat.delete({
@@ -11116,7 +11116,7 @@ const testclient_js_1 = require("./testclient.js");
11116
11116
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11117
11117
  httpClient: testHttpClient,
11118
11118
  security: {
11119
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11119
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11120
11120
  },
11121
11121
  });
11122
11122
  const result = await glean.client.chat.retrieve({
@@ -11130,7 +11130,7 @@ const testclient_js_1 = require("./testclient.js");
11130
11130
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11131
11131
  httpClient: testHttpClient,
11132
11132
  security: {
11133
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11133
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11134
11134
  },
11135
11135
  });
11136
11136
  const result = await glean.client.chat.list();
@@ -11142,7 +11142,7 @@ const testclient_js_1 = require("./testclient.js");
11142
11142
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11143
11143
  httpClient: testHttpClient,
11144
11144
  security: {
11145
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11145
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11146
11146
  },
11147
11147
  });
11148
11148
  const result = await glean.client.chat.retrieveApplication({
@@ -11156,7 +11156,7 @@ const testclient_js_1 = require("./testclient.js");
11156
11156
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11157
11157
  httpClient: testHttpClient,
11158
11158
  security: {
11159
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11159
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11160
11160
  },
11161
11161
  });
11162
11162
  const result = await glean.client.chat.uploadFiles({
@@ -11170,7 +11170,7 @@ const testclient_js_1 = require("./testclient.js");
11170
11170
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11171
11171
  httpClient: testHttpClient,
11172
11172
  security: {
11173
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11173
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11174
11174
  },
11175
11175
  });
11176
11176
  const result = await glean.client.chat.retrieveFiles({
@@ -11184,7 +11184,7 @@ const testclient_js_1 = require("./testclient.js");
11184
11184
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11185
11185
  httpClient: testHttpClient,
11186
11186
  security: {
11187
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11187
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11188
11188
  },
11189
11189
  });
11190
11190
  await glean.client.chat.deleteFiles({
@@ -11199,7 +11199,7 @@ const testclient_js_1 = require("./testclient.js");
11199
11199
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11200
11200
  httpClient: testHttpClient,
11201
11201
  security: {
11202
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11202
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11203
11203
  },
11204
11204
  });
11205
11205
  const result = await glean.client.chat.createStream({
@@ -11221,7 +11221,7 @@ const testclient_js_1 = require("./testclient.js");
11221
11221
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11222
11222
  httpClient: testHttpClient,
11223
11223
  security: {
11224
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11224
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11225
11225
  },
11226
11226
  });
11227
11227
  const result = await glean.client.chat.createStream({
@@ -11246,7 +11246,7 @@ const testclient_js_1 = require("./testclient.js");
11246
11246
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11247
11247
  httpClient: testHttpClient,
11248
11248
  security: {
11249
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11249
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11250
11250
  },
11251
11251
  });
11252
11252
  const result = await glean.client.chat.createStream({
@@ -11261,7 +11261,7 @@ const testclient_js_1 = require("./testclient.js");
11261
11261
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11262
11262
  httpClient: testHttpClient,
11263
11263
  security: {
11264
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11264
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11265
11265
  },
11266
11266
  });
11267
11267
  const result = await glean.client.chat.createStream({
@@ -15619,7 +15619,7 @@ const testclient_js_1 = require("./testclient.js");
15619
15619
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
15620
15620
  httpClient: testHttpClient,
15621
15621
  security: {
15622
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
15622
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
15623
15623
  },
15624
15624
  });
15625
15625
  const result = await glean.client.chat.createStream({