@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/esm/__tests__/chat.test.js CHANGED
@@ -10,7 +10,7 @@ test("Chat Chat Default Example", async () => {
10
10
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11
11
  httpClient: testHttpClient,
12
12
  security: {
13
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
13
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
14
14
  },
15
15
  });
16
16
  const result = await glean.client.chat.create({
@@ -32,7 +32,7 @@ test("Chat Chat Gpt Agent Example", async () => {
32
32
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
33
33
  httpClient: testHttpClient,
34
34
  security: {
35
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
35
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
36
36
  },
37
37
  });
38
38
  const result = await glean.client.chat.create({
@@ -57,7 +57,7 @@ test("Chat Chat Streaming Example", async () => {
57
57
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
58
58
  httpClient: testHttpClient,
59
59
  security: {
60
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
60
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
61
61
  },
62
62
  });
63
63
  const result = await glean.client.chat.create({
@@ -4381,7 +4381,7 @@ test("Chat Chat Update Response", async () => {
4381
4381
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
4382
4382
  httpClient: testHttpClient,
4383
4383
  security: {
4384
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
4384
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
4385
4385
  },
4386
4386
  });
4387
4387
  const result = await glean.client.chat.create({
@@ -8390,7 +8390,7 @@ test("Chat Chat Citation Response", async () => {
8390
8390
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
8391
8391
  httpClient: testHttpClient,
8392
8392
  security: {
8393
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
8393
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
8394
8394
  },
8395
8395
  });
8396
8396
  const result = await glean.client.chat.create({
@@ -11087,7 +11087,7 @@ test("Chat Deleteallchats", async () => {
11087
11087
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11088
11088
  httpClient: testHttpClient,
11089
11089
  security: {
11090
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11090
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11091
11091
  },
11092
11092
  });
11093
11093
  await glean.client.chat.deleteAll();
@@ -11098,7 +11098,7 @@ test("Chat Deletechats", async () => {
11098
11098
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11099
11099
  httpClient: testHttpClient,
11100
11100
  security: {
11101
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11101
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11102
11102
  },
11103
11103
  });
11104
11104
  await glean.client.chat.delete({
@@ -11114,7 +11114,7 @@ test("Chat Getchat", async () => {
11114
11114
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11115
11115
  httpClient: testHttpClient,
11116
11116
  security: {
11117
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11117
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11118
11118
  },
11119
11119
  });
11120
11120
  const result = await glean.client.chat.retrieve({
@@ -11128,7 +11128,7 @@ test("Chat Listchats", async () => {
11128
11128
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11129
11129
  httpClient: testHttpClient,
11130
11130
  security: {
11131
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11131
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11132
11132
  },
11133
11133
  });
11134
11134
  const result = await glean.client.chat.list();
@@ -11140,7 +11140,7 @@ test("Chat Getchatapplication", async () => {
11140
11140
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11141
11141
  httpClient: testHttpClient,
11142
11142
  security: {
11143
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11143
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11144
11144
  },
11145
11145
  });
11146
11146
  const result = await glean.client.chat.retrieveApplication({
@@ -11154,7 +11154,7 @@ test("Chat Uploadchatfiles", async () => {
11154
11154
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11155
11155
  httpClient: testHttpClient,
11156
11156
  security: {
11157
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11157
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11158
11158
  },
11159
11159
  });
11160
11160
  const result = await glean.client.chat.uploadFiles({
@@ -11168,7 +11168,7 @@ test("Chat Getchatfiles", async () => {
11168
11168
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11169
11169
  httpClient: testHttpClient,
11170
11170
  security: {
11171
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11171
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11172
11172
  },
11173
11173
  });
11174
11174
  const result = await glean.client.chat.retrieveFiles({
@@ -11182,7 +11182,7 @@ test("Chat Deletechatfiles", async () => {
11182
11182
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11183
11183
  httpClient: testHttpClient,
11184
11184
  security: {
11185
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11185
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11186
11186
  },
11187
11187
  });
11188
11188
  await glean.client.chat.deleteFiles({
@@ -11197,7 +11197,7 @@ test("Chat Chat Stream Default Example", async () => {
11197
11197
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11198
11198
  httpClient: testHttpClient,
11199
11199
  security: {
11200
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11200
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11201
11201
  },
11202
11202
  });
11203
11203
  const result = await glean.client.chat.createStream({
@@ -11219,7 +11219,7 @@ test("Chat Chat Stream Gpt Agent Example", async () => {
11219
11219
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11220
11220
  httpClient: testHttpClient,
11221
11221
  security: {
11222
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11222
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11223
11223
  },
11224
11224
  });
11225
11225
  const result = await glean.client.chat.createStream({
@@ -11244,7 +11244,7 @@ test("Chat Chat Stream Streaming Example", async () => {
11244
11244
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11245
11245
  httpClient: testHttpClient,
11246
11246
  security: {
11247
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11247
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11248
11248
  },
11249
11249
  });
11250
11250
  const result = await glean.client.chat.createStream({
@@ -11259,7 +11259,7 @@ test("Chat Chat Stream Update Response", async () => {
11259
11259
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
11260
11260
  httpClient: testHttpClient,
11261
11261
  security: {
11262
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
11262
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
11263
11263
  },
11264
11264
  });
11265
11265
  const result = await glean.client.chat.createStream({
@@ -15617,7 +15617,7 @@ test("Chat Chat Stream Citation Response", async () => {
15617
15617
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
15618
15618
  httpClient: testHttpClient,
15619
15619
  security: {
15620
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
15620
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
15621
15621
  },
15622
15622
  });
15623
15623
  const result = await glean.client.chat.createStream({