@gleanwork/api-client 0.4.2 → 0.4.3

package/src/react-query/clientToolsRun.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientToolsRun } from "../funcs/clientToolsRun.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type ClientToolsRunMutationVariables = {
+  request: components.ToolsCallRequest;
+  options?: RequestOptions;
+};
+
+export type ClientToolsRunMutationData = components.ToolsCallResponse;
+
+/**
+ * Execute the specified tool
+ *
+ * @remarks
+ * Execute the specified tool with provided parameters
+ */
+export function useClientToolsRunMutation(
+  options?: MutationHookOptions<
+    ClientToolsRunMutationData,
+    Error,
+    ClientToolsRunMutationVariables
+  >,
+): UseMutationResult<
+  ClientToolsRunMutationData,
+  Error,
+  ClientToolsRunMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildClientToolsRunMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyClientToolsRun(): MutationKey {
+  return ["@gleanwork/api-client", "tools", "run"];
+}
+
+export function buildClientToolsRunMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ClientToolsRunMutationVariables,
+  ) => Promise<ClientToolsRunMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyClientToolsRun(),
+    mutationFn: function clientToolsRunMutationFn({
+      request,
+      options,
+    }): Promise<ClientToolsRunMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(clientToolsRun(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/index.ts

@@ -72,6 +72,8 @@ export * from "./clientShortcutsDelete.js";
 export * from "./clientShortcutsList.js";
 export * from "./clientShortcutsRetrieve.js";
 export * from "./clientShortcutsUpdate.js";
+export * from "./clientToolsList.js";
+export * from "./clientToolsRun.js";
 export * from "./clientVerificationAddReminder.js";
 export * from "./clientVerificationList.js";
 export * from "./clientVerificationVerify.js";

package/src/sdk/client.ts

@@ -18,6 +18,7 @@ import { Insights } from "./insights.js";
 import { Messages } from "./messages.js";
 import { Pins } from "./pins.js";
 import { Search } from "./search.js";
+import { Tools } from "./tools.js";
 import { Verification } from "./verification.js";
 
 export class Client extends ClientSDK {
@@ -96,6 +97,11 @@ export class Client extends ClientSDK {
     return (this._verification ??= new Verification(this._options));
   }
 
+  private _tools?: Tools;
+  get tools(): Tools {
+    return (this._tools ??= new Tools(this._options));
+  }
+
   private _governance?: Governance;
   get governance(): Governance {
     return (this._governance ??= new Governance(this._options));

package/src/sdk/search.ts

@@ -19,7 +19,7 @@ export class Search extends ClientSDK {
    * Retrieves results for search query without respect for permissions. This is available only to privileged users.
    */
   async queryAsAdmin(
-    request?: components.SearchRequest | undefined,
+    request: components.SearchRequest,
     options?: RequestOptions,
   ): Promise<components.SearchResponse> {
     return unwrapAsync(clientSearchQueryAsAdmin(
@@ -70,7 +70,7 @@ export class Search extends ClientSDK {
    * Retrieve recommended documents for the given URL or Glean Document ID.
    */
   async recommendations(
-    request?: components.RecommendationsRequest | undefined,
+    request: components.RecommendationsRequest,
     options?: RequestOptions,
   ): Promise<components.ResultsResponse | undefined> {
     return unwrapAsync(clientSearchRecommendations(
@@ -87,7 +87,7 @@ export class Search extends ClientSDK {
    * Retrieve results from the index for the given query and filters.
    */
   async query(
-    request?: components.SearchRequest | undefined,
+    request: components.SearchRequest,
     options?: RequestOptions,
   ): Promise<components.SearchResponse> {
     return unwrapAsync(clientSearchQuery(

package/src/sdk/tools.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { clientToolsList } from "../funcs/clientToolsList.js";
+import { clientToolsRun } from "../funcs/clientToolsRun.js";
+import { ClientSDK, RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { unwrapAsync } from "../types/fp.js";
+
+export class Tools extends ClientSDK {
+  /**
+   * 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.
+   */
+  async list(
+    toolNames?: Array<string> | undefined,
+    options?: RequestOptions,
+  ): Promise<components.ToolsListResponse> {
+    return unwrapAsync(clientToolsList(
+      this,
+      toolNames,
+      options,
+    ));
+  }
+
+  /**
+   * Execute the specified tool
+   *
+   * @remarks
+   * Execute the specified tool with provided parameters
+   */
+  async run(
+    request: components.ToolsCallRequest,
+    options?: RequestOptions,
+  ): Promise<components.ToolsCallResponse> {
+    return unwrapAsync(clientToolsRun(
+      this,
+      request,
+      options,
+    ));
+  }
+}

package/dist/commonjs/models/operations/getpolicies.d.ts

@@ -1,37 +0,0 @@
-import * as z from "zod";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-export type GetpoliciesRequest = {
-    /**
-     * Filter to return reports with a given value of auto-hide.
-     */
-    autoHide?: boolean | undefined;
-    /**
-     * Filter to return reports with a given frequency.
-     */
-    frequency?: string | undefined;
-};
-/** @internal */
-export declare const GetpoliciesRequest$inboundSchema: z.ZodType<GetpoliciesRequest, z.ZodTypeDef, unknown>;
-/** @internal */
-export type GetpoliciesRequest$Outbound = {
-    autoHide?: boolean | undefined;
-    frequency?: string | undefined;
-};
-/** @internal */
-export declare const GetpoliciesRequest$outboundSchema: z.ZodType<GetpoliciesRequest$Outbound, z.ZodTypeDef, GetpoliciesRequest>;
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export declare namespace GetpoliciesRequest$ {
-    /** @deprecated use `GetpoliciesRequest$inboundSchema` instead. */
-    const inboundSchema: z.ZodType<GetpoliciesRequest, z.ZodTypeDef, unknown>;
-    /** @deprecated use `GetpoliciesRequest$outboundSchema` instead. */
-    const outboundSchema: z.ZodType<GetpoliciesRequest$Outbound, z.ZodTypeDef, GetpoliciesRequest>;
-    /** @deprecated use `GetpoliciesRequest$Outbound` instead. */
-    type Outbound = GetpoliciesRequest$Outbound;
-}
-export declare function getpoliciesRequestToJSON(getpoliciesRequest: GetpoliciesRequest): string;
-export declare function getpoliciesRequestFromJSON(jsonString: string): SafeParseResult<GetpoliciesRequest, SDKValidationError>;
-//# sourceMappingURL=getpolicies.d.ts.map

package/dist/commonjs/models/operations/getpolicies.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getpolicies.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/getpolicies.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAIlB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,mBAAmB,CAAC;IACnC,kEAAkE;IAC3D,MAAM,aAAa,sDAAmC,CAAC;IAC9D,mEAAmE;IAC5D,MAAM,cAAc,0EAAoC,CAAC;IAChE,6DAA6D;IAC7D,KAAY,QAAQ,GAAG,2BAA2B,CAAC;CACpD;AAED,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}

package/dist/commonjs/models/operations/getpolicies.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getpolicies.js","sourceRoot":"","sources":["../../../../src/models/operations/getpolicies.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyDH,4DAMC;AAED,gEAQC;AAvED,uCAAyB;AACzB,qDAAiD;AAejD,gBAAgB;AACH,QAAA,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAQH,gBAAgB;AACH,QAAA,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH;;;GAGG;AACH,IAAiB,mBAAmB,CAOnC;AAPD,WAAiB,mBAAmB;IAClC,kEAAkE;IACrD,iCAAa,GAAG,wCAAgC,CAAC;IAC9D,mEAAmE;IACtD,kCAAc,GAAG,yCAAiC,CAAC;AAGlE,CAAC,EAPgB,mBAAmB,mCAAnB,mBAAmB,QAOnC;AAED,SAAgB,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,yCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC;AAED,SAAgB,0BAA0B,CACxC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,wCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}

package/dist/esm/models/operations/getpolicies.d.ts

@@ -1,37 +0,0 @@
-import * as z from "zod";
-import { Result as SafeParseResult } from "../../types/fp.js";
-import { SDKValidationError } from "../errors/sdkvalidationerror.js";
-export type GetpoliciesRequest = {
-    /**
-     * Filter to return reports with a given value of auto-hide.
-     */
-    autoHide?: boolean | undefined;
-    /**
-     * Filter to return reports with a given frequency.
-     */
-    frequency?: string | undefined;
-};
-/** @internal */
-export declare const GetpoliciesRequest$inboundSchema: z.ZodType<GetpoliciesRequest, z.ZodTypeDef, unknown>;
-/** @internal */
-export type GetpoliciesRequest$Outbound = {
-    autoHide?: boolean | undefined;
-    frequency?: string | undefined;
-};
-/** @internal */
-export declare const GetpoliciesRequest$outboundSchema: z.ZodType<GetpoliciesRequest$Outbound, z.ZodTypeDef, GetpoliciesRequest>;
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export declare namespace GetpoliciesRequest$ {
-    /** @deprecated use `GetpoliciesRequest$inboundSchema` instead. */
-    const inboundSchema: z.ZodType<GetpoliciesRequest, z.ZodTypeDef, unknown>;
-    /** @deprecated use `GetpoliciesRequest$outboundSchema` instead. */
-    const outboundSchema: z.ZodType<GetpoliciesRequest$Outbound, z.ZodTypeDef, GetpoliciesRequest>;
-    /** @deprecated use `GetpoliciesRequest$Outbound` instead. */
-    type Outbound = GetpoliciesRequest$Outbound;
-}
-export declare function getpoliciesRequestToJSON(getpoliciesRequest: GetpoliciesRequest): string;
-export declare function getpoliciesRequestFromJSON(jsonString: string): SafeParseResult<GetpoliciesRequest, SDKValidationError>;
-//# sourceMappingURL=getpolicies.d.ts.map

package/dist/esm/models/operations/getpolicies.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getpolicies.d.ts","sourceRoot":"","sources":["../../../../src/models/operations/getpolicies.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,OAAO,CACtD,kBAAkB,EAClB,CAAC,CAAC,UAAU,EACZ,OAAO,CAIP,CAAC;AAEH,gBAAgB;AAChB,MAAM,MAAM,2BAA2B,GAAG;IACxC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,OAAO,CACvD,2BAA2B,EAC3B,CAAC,CAAC,UAAU,EACZ,kBAAkB,CAIlB,CAAC;AAEH;;;GAGG;AACH,yBAAiB,mBAAmB,CAAC;IACnC,kEAAkE;IAC3D,MAAM,aAAa,sDAAmC,CAAC;IAC9D,mEAAmE;IAC5D,MAAM,cAAc,0EAAoC,CAAC;IAChE,6DAA6D;IAC7D,KAAY,QAAQ,GAAG,2BAA2B,CAAC;CACpD;AAED,wBAAgB,wBAAwB,CACtC,kBAAkB,EAAE,kBAAkB,GACrC,MAAM,CAIR;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD"}

package/dist/esm/models/operations/getpolicies.js

@@ -1,33 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
-/** @internal */
-export const GetpoliciesRequest$inboundSchema = z.object({
-    autoHide: z.boolean().optional(),
-    frequency: z.string().optional(),
-});
-/** @internal */
-export const GetpoliciesRequest$outboundSchema = z.object({
-    autoHide: z.boolean().optional(),
-    frequency: z.string().optional(),
-});
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export var GetpoliciesRequest$;
-(function (GetpoliciesRequest$) {
-    /** @deprecated use `GetpoliciesRequest$inboundSchema` instead. */
-    GetpoliciesRequest$.inboundSchema = GetpoliciesRequest$inboundSchema;
-    /** @deprecated use `GetpoliciesRequest$outboundSchema` instead. */
-    GetpoliciesRequest$.outboundSchema = GetpoliciesRequest$outboundSchema;
-})(GetpoliciesRequest$ || (GetpoliciesRequest$ = {}));
-export function getpoliciesRequestToJSON(getpoliciesRequest) {
-    return JSON.stringify(GetpoliciesRequest$outboundSchema.parse(getpoliciesRequest));
-}
-export function getpoliciesRequestFromJSON(jsonString) {
-    return safeParse(jsonString, (x) => GetpoliciesRequest$inboundSchema.parse(JSON.parse(x)), `Failed to parse 'GetpoliciesRequest' from JSON`);
-}
-//# sourceMappingURL=getpolicies.js.map

package/dist/esm/models/operations/getpolicies.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"getpolicies.js","sourceRoot":"","sources":["../../../../src/models/operations/getpolicies.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAejD,gBAAgB;AAChB,MAAM,CAAC,MAAM,gCAAgC,GAIzC,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAQH,gBAAgB;AAChB,MAAM,CAAC,MAAM,iCAAiC,GAI1C,CAAC,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,KAAW,mBAAmB,CAOnC;AAPD,WAAiB,mBAAmB;IAClC,kEAAkE;IACrD,iCAAa,GAAG,gCAAgC,CAAC;IAC9D,mEAAmE;IACtD,kCAAc,GAAG,iCAAiC,CAAC;AAGlE,CAAC,EAPgB,mBAAmB,KAAnB,mBAAmB,QAOnC;AAED,MAAM,UAAU,wBAAwB,CACtC,kBAAsC;IAEtC,OAAO,IAAI,CAAC,SAAS,CACnB,iCAAiC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAC5D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,UAAkB;IAElB,OAAO,SAAS,CACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAgC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5D,gDAAgD,CACjD,CAAC;AACJ,CAAC"}