@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
@@ -13,7 +13,7 @@ test("Policies Getpolicy", async () => {
13
13
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
14
14
  httpClient: testHttpClient,
15
15
  security: {
16
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
16
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
17
17
  },
18
18
  });
19
19
 
@@ -28,7 +28,7 @@ test("Policies Getpolicies", async () => {
28
28
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
29
29
  httpClient: testHttpClient,
30
30
  security: {
31
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
31
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
32
32
  },
33
33
  });
34
34
 
@@ -13,7 +13,7 @@ test("Search Autocomplete", async () => {
13
13
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
14
14
  httpClient: testHttpClient,
15
15
  security: {
16
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
16
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
17
17
  },
18
18
  });
19
19
 
@@ -13,7 +13,7 @@ test("Verification Addverificationreminder", async () => {
13
13
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
14
14
  httpClient: testHttpClient,
15
15
  security: {
16
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
16
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
17
17
  },
18
18
  });
19
19
 
@@ -30,7 +30,7 @@ test("Verification Listverifications", async () => {
30
30
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
31
31
  httpClient: testHttpClient,
32
32
  security: {
33
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
33
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
34
34
  },
35
35
  });
36
36
 
@@ -45,7 +45,7 @@ test("Verification Verify", async () => {
45
45
  serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
46
46
  httpClient: testHttpClient,
47
47
  security: {
48
- actAsBearerToken: process.env["GLEAN_ACT_AS_BEARER_TOKEN"] ?? "value",
48
+ apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
49
49
  },
50
50
  });
51
51
 
package/src/lib/config.ts CHANGED
@@ -71,8 +71,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
71
71
  export const SDK_METADATA = {
72
72
  language: "typescript",
73
73
  openapiDocVersion: "0.9.0",
74
- sdkVersion: "0.4.0",
74
+ sdkVersion: "0.4.1",
75
75
  genVersion: "2.604.2",
76
76
  userAgent:
77
- "speakeasy-sdk/typescript 0.4.0 2.604.2 0.9.0 @gleanwork/api-client",
77
+ "speakeasy-sdk/typescript 0.4.1 2.604.2 0.9.0 @gleanwork/api-client",
78
78
  } as const;
package/src/lib/env.ts CHANGED
@@ -7,14 +7,14 @@ import { dlv } from "./dlv.js";
7
7
  import * as z from "zod";
8
8
 
9
9
  export interface Env {
10
- GLEAN_ACT_AS_BEARER_TOKEN?: string | undefined;
10
+ GLEAN_API_TOKEN?: string | undefined;
11
11
  GLEAN_COOKIE_AUTH?: string | undefined;
12
12
 
13
13
  GLEAN_DEBUG?: boolean | undefined;
14
14
  }
15
15
 
16
16
  export const envSchema: z.ZodType<Env, z.ZodTypeDef, unknown> = z.object({
17
- GLEAN_ACT_AS_BEARER_TOKEN: z.string().optional(),
17
+ GLEAN_API_TOKEN: z.string().optional(),
18
18
  GLEAN_COOKIE_AUTH: z.string().optional(),
19
19
 
20
20
  GLEAN_DEBUG: z.coerce.boolean().optional(),
@@ -243,8 +243,8 @@ export function resolveGlobalSecurity(
243
243
  [
244
244
  {
245
245
  fieldName: "Authorization",
246
- type: "apiKey:header",
247
- value: security?.actAsBearerToken ?? env().GLEAN_ACT_AS_BEARER_TOKEN,
246
+ type: "http:bearer",
247
+ value: security?.apiToken ?? env().GLEAN_API_TOKEN,
248
248
  },
249
249
  ],
250
250
  [
@@ -3,12 +3,13 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
6
7
  import { safeParse } from "../../lib/schemas.js";
7
8
  import { Result as SafeParseResult } from "../../types/fp.js";
8
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
10
 
10
11
  export type Security = {
11
- actAsBearerToken?: string | undefined;
12
+ apiToken?: string | undefined;
12
13
  cookieAuth?: string | undefined;
13
14
  };
14
15
 
@@ -18,13 +19,17 @@ export const Security$inboundSchema: z.ZodType<
18
19
  z.ZodTypeDef,
19
20
  unknown
20
21
  > = z.object({
21
- actAsBearerToken: z.string().optional(),
22
+ APIToken: z.string().optional(),
22
23
  cookieAuth: z.string().optional(),
24
+ }).transform((v) => {
25
+ return remap$(v, {
26
+ "APIToken": "apiToken",
27
+ });
23
28
  });
24
29
 
25
30
  /** @internal */
26
31
  export type Security$Outbound = {
27
- actAsBearerToken?: string | undefined;
32
+ APIToken?: string | undefined;
28
33
  cookieAuth?: string | undefined;
29
34
  };
30
35
 
@@ -34,8 +39,12 @@ export const Security$outboundSchema: z.ZodType<
34
39
  z.ZodTypeDef,
35
40
  Security
36
41
  > = z.object({
37
- actAsBearerToken: z.string().optional(),
42
+ apiToken: z.string().optional(),
38
43
  cookieAuth: z.string().optional(),
44
+ }).transform((v) => {
45
+ return remap$(v, {
46
+ apiToken: "APIToken",
47
+ });
39
48
  });
40
49
 
41
50
  /**