@gleanwork/api-client 0.4.1 → 0.4.3

package/src/funcs/clientGovernanceDocumentsVisibilityoverridesList.ts

@@ -99,7 +99,8 @@ async function $do(
     Accept: "application/json; charset=UTF-8",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -109,7 +110,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientInsightsRetrieve.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientMessagesRetrieve.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientPinsCreate.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientPinsList.ts

@@ -77,7 +77,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -87,7 +88,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientPinsRemove.ts

@@ -90,7 +90,8 @@ async function $do(
     Accept: "*/*",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -100,7 +101,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientPinsRetrieve.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientPinsUpdate.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientSearchAutocomplete.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientSearchQuery.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  */
 export function clientSearchQuery(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -56,7 +56,7 @@ export function clientSearchQuery(
 
 async function $do(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -76,16 +76,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.SearchRequest$outboundSchema.optional().parse(value),
+    (value) => components.SearchRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/rest/api/v1/search")();
 
@@ -94,7 +92,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -104,7 +103,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientSearchQueryAsAdmin.ts

@@ -32,7 +32,7 @@ import { Result } from "../types/fp.js";
  */
 export function clientSearchQueryAsAdmin(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -56,7 +56,7 @@ export function clientSearchQueryAsAdmin(
 
 async function $do(
   client: GleanCore,
-  request?: components.SearchRequest | undefined,
+  request: components.SearchRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -76,16 +76,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) => components.SearchRequest$outboundSchema.optional().parse(value),
+    (value) => components.SearchRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/rest/api/v1/adminsearch")();
 
@@ -94,7 +92,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -104,7 +103,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientSearchRecommendations.ts

@@ -31,7 +31,7 @@ import { Result } from "../types/fp.js";
  */
 export function clientSearchRecommendations(
   client: GleanCore,
-  request?: components.RecommendationsRequest | undefined,
+  request: components.RecommendationsRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
@@ -54,7 +54,7 @@ export function clientSearchRecommendations(
 
 async function $do(
   client: GleanCore,
-  request?: components.RecommendationsRequest | undefined,
+  request: components.RecommendationsRequest,
   options?: RequestOptions,
 ): Promise<
   [
@@ -73,17 +73,14 @@ async function $do(
 > {
   const parsed = safeParse(
     request,
-    (value) =>
-      components.RecommendationsRequest$outboundSchema.optional().parse(value),
+    (value) => components.RecommendationsRequest$outboundSchema.parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = payload === undefined
-    ? null
-    : encodeJSON("body", payload, { explode: true });
+  const body = encodeJSON("body", payload, { explode: true });
 
   const path = pathToFunc("/rest/api/v1/recommendations")();
 
@@ -92,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -102,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientSearchRetrieveFeed.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientShortcutsCreate.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientShortcutsDelete.ts

@@ -90,7 +90,8 @@ async function $do(
     Accept: "*/*",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -100,7 +101,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientShortcutsList.ts

@@ -90,7 +90,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -100,7 +101,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientShortcutsRetrieve.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientShortcutsUpdate.ts

@@ -89,7 +89,8 @@ async function $do(
     Accept: "application/json",
   }));
 
-  const securityInput = await extractSecurity(client._options.security);
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
   const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const context = {
@@ -99,7 +100,7 @@ async function $do(
 
     resolvedSecurity: requestSecurity,
 
-    securitySource: client._options.security,
+    securitySource: client._options.apiToken,
     retryConfig: options?.retries
       || client._options.retryConfig
       || { strategy: "none" },

package/src/funcs/clientToolsList.ts

@@ -0,0 +1,164 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GleanError } from "../models/errors/gleanerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * List available tools
+ *
+ * @remarks
+ * Returns a filtered set of available tools based on optional tool name parameters. If no filters are provided, all available tools are returned.
+ */
+export function clientToolsList(
+  client: GleanCore,
+  toolNames?: Array<string> | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ToolsListResponse,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    toolNames,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  toolNames?: Array<string> | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ToolsListResponse,
+      | GleanError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetRestApiV1ToolsListRequest = {
+    toolNames: toolNames,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.GetRestApiV1ToolsListRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/rest/api/v1/tools/list")();
+
+  const query = encodeFormQuery({
+    "toolNames": payload.toolNames,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "get_/rest/api/v1/tools/list",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["400", "401", "404", "429", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const [result] = await M.match<
+    components.ToolsListResponse,
+    | GleanError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >(
+    M.json(200, components.ToolsListResponse$inboundSchema),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}