@gleanwork/api-client 0.14.19 → 0.16.0

package/src/react-query/indexingCustomMetadataGetSchema.ts

@@ -0,0 +1,146 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d67f83383602
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+import {
+  buildIndexingCustomMetadataGetSchemaQuery,
+  IndexingCustomMetadataGetSchemaQueryData,
+  prefetchIndexingCustomMetadataGetSchema,
+  queryKeyIndexingCustomMetadataGetSchema,
+} from "./indexingCustomMetadataGetSchema.core.js";
+export {
+  buildIndexingCustomMetadataGetSchemaQuery,
+  type IndexingCustomMetadataGetSchemaQueryData,
+  prefetchIndexingCustomMetadataGetSchema,
+  queryKeyIndexingCustomMetadataGetSchema,
+};
+
+export type IndexingCustomMetadataGetSchemaQueryError =
+  | errors.ErrorInfoResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Retrieve metadata schema
+ *
+ * @remarks
+ * Retrieves the current schema definition for a metadata group.
+ */
+export function useIndexingCustomMetadataGetSchema(
+  groupName: string,
+  options?: QueryHookOptions<
+    IndexingCustomMetadataGetSchemaQueryData,
+    IndexingCustomMetadataGetSchemaQueryError
+  >,
+): UseQueryResult<
+  IndexingCustomMetadataGetSchemaQueryData,
+  IndexingCustomMetadataGetSchemaQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildIndexingCustomMetadataGetSchemaQuery(
+      client,
+      groupName,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Retrieve metadata schema
+ *
+ * @remarks
+ * Retrieves the current schema definition for a metadata group.
+ */
+export function useIndexingCustomMetadataGetSchemaSuspense(
+  groupName: string,
+  options?: SuspenseQueryHookOptions<
+    IndexingCustomMetadataGetSchemaQueryData,
+    IndexingCustomMetadataGetSchemaQueryError
+  >,
+): UseSuspenseQueryResult<
+  IndexingCustomMetadataGetSchemaQueryData,
+  IndexingCustomMetadataGetSchemaQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildIndexingCustomMetadataGetSchemaQuery(
+      client,
+      groupName,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setIndexingCustomMetadataGetSchemaData(
+  client: QueryClient,
+  queryKeyBase: [groupName: string],
+  data: IndexingCustomMetadataGetSchemaQueryData,
+): IndexingCustomMetadataGetSchemaQueryData | undefined {
+  const key = queryKeyIndexingCustomMetadataGetSchema(...queryKeyBase);
+
+  return client.setQueryData<IndexingCustomMetadataGetSchemaQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateIndexingCustomMetadataGetSchema(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[groupName: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "customMetadata",
+      "getSchema",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllIndexingCustomMetadataGetSchema(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "customMetadata", "getSchema"],
+  });
+}

package/src/react-query/indexingCustomMetadataUpsert.ts

@@ -0,0 +1,118 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 90aa98ec6356
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingCustomMetadataUpsert } from "../funcs/indexingCustomMetadataUpsert.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type IndexingCustomMetadataUpsertMutationVariables = {
+  customMetadataPutRequest: components.CustomMetadataPutRequest;
+  docId: string;
+  groupName: string;
+  options?: RequestOptions;
+};
+
+export type IndexingCustomMetadataUpsertMutationData =
+  components.SuccessResponse;
+
+export type IndexingCustomMetadataUpsertMutationError =
+  | errors.ErrorInfoResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Add or update custom metadata
+ *
+ * @remarks
+ * Associates custom metadata with a specific document. Custom metadata enables you to enrich documents with additional structured information that can be used for search, filtering, and faceting.
+ */
+export function useIndexingCustomMetadataUpsertMutation(
+  options?: MutationHookOptions<
+    IndexingCustomMetadataUpsertMutationData,
+    IndexingCustomMetadataUpsertMutationError,
+    IndexingCustomMetadataUpsertMutationVariables
+  >,
+): UseMutationResult<
+  IndexingCustomMetadataUpsertMutationData,
+  IndexingCustomMetadataUpsertMutationError,
+  IndexingCustomMetadataUpsertMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingCustomMetadataUpsertMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingCustomMetadataUpsert(): MutationKey {
+  return ["@gleanwork/api-client", "customMetadata", "upsert"];
+}
+
+export function buildIndexingCustomMetadataUpsertMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingCustomMetadataUpsertMutationVariables,
+  ) => Promise<IndexingCustomMetadataUpsertMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingCustomMetadataUpsert(),
+    mutationFn: function indexingCustomMetadataUpsertMutationFn({
+      customMetadataPutRequest,
+      docId,
+      groupName,
+      options,
+    }): Promise<IndexingCustomMetadataUpsertMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingCustomMetadataUpsert(
+        client$,
+        customMetadataPutRequest,
+        docId,
+        groupName,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingCustomMetadataUpsertSchema.ts

@@ -0,0 +1,115 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0ab738ff304b
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingCustomMetadataUpsertSchema } from "../funcs/indexingCustomMetadataUpsertSchema.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type IndexingCustomMetadataUpsertSchemaMutationVariables = {
+  customMetadataSchema: components.CustomMetadataSchema;
+  groupName: string;
+  options?: RequestOptions;
+};
+
+export type IndexingCustomMetadataUpsertSchemaMutationData =
+  components.SuccessResponse;
+
+export type IndexingCustomMetadataUpsertSchemaMutationError =
+  | errors.ErrorInfoResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Create or update metadata schema
+ *
+ * @remarks
+ * Defines or updates the schema for a metadata group. Schemas should be defined before indexing metadata.
+ */
+export function useIndexingCustomMetadataUpsertSchemaMutation(
+  options?: MutationHookOptions<
+    IndexingCustomMetadataUpsertSchemaMutationData,
+    IndexingCustomMetadataUpsertSchemaMutationError,
+    IndexingCustomMetadataUpsertSchemaMutationVariables
+  >,
+): UseMutationResult<
+  IndexingCustomMetadataUpsertSchemaMutationData,
+  IndexingCustomMetadataUpsertSchemaMutationError,
+  IndexingCustomMetadataUpsertSchemaMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingCustomMetadataUpsertSchemaMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingCustomMetadataUpsertSchema(): MutationKey {
+  return ["@gleanwork/api-client", "customMetadata", "upsertSchema"];
+}
+
+export function buildIndexingCustomMetadataUpsertSchemaMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingCustomMetadataUpsertSchemaMutationVariables,
+  ) => Promise<IndexingCustomMetadataUpsertSchemaMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingCustomMetadataUpsertSchema(),
+    mutationFn: function indexingCustomMetadataUpsertSchemaMutationFn({
+      customMetadataSchema,
+      groupName,
+      options,
+    }): Promise<IndexingCustomMetadataUpsertSchemaMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingCustomMetadataUpsertSchema(
+        client$,
+        customMetadataSchema,
+        groupName,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/toolsAuthorizeActionPack.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1e27082b7f84
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { toolsAuthorizeActionPack } from "../funcs/toolsAuthorizeActionPack.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type ToolsAuthorizeActionPackMutationVariables = {
+  authorizeActionPackRequest: components.AuthorizeActionPackRequest;
+  actionPackId: string;
+  options?: RequestOptions;
+};
+
+export type ToolsAuthorizeActionPackMutationData =
+  components.AuthorizeActionPackResponse;
+
+export type ToolsAuthorizeActionPackMutationError =
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Start the OAuth authorization flow for an action pack.
+ *
+ * @remarks
+ * Starts the third-party OAuth flow for the specified action pack and returns the
+ * redirect URL that the client should navigate the end user to. After the OAuth
+ * callback completes, the user's browser is redirected back to `returnUrl` with a
+ * status query parameter (`?glean_action_auth=success|error&actionPackId=...`).
+ *
+ * `returnUrl` must match the tenant's configured return URL allowlist; otherwise the
+ * request is rejected with 400.
+ */
+export function useToolsAuthorizeActionPackMutation(
+  options?: MutationHookOptions<
+    ToolsAuthorizeActionPackMutationData,
+    ToolsAuthorizeActionPackMutationError,
+    ToolsAuthorizeActionPackMutationVariables
+  >,
+): UseMutationResult<
+  ToolsAuthorizeActionPackMutationData,
+  ToolsAuthorizeActionPackMutationError,
+  ToolsAuthorizeActionPackMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildToolsAuthorizeActionPackMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyToolsAuthorizeActionPack(): MutationKey {
+  return ["@gleanwork/api-client", "Tools", "authorizeActionPack"];
+}
+
+export function buildToolsAuthorizeActionPackMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ToolsAuthorizeActionPackMutationVariables,
+  ) => Promise<ToolsAuthorizeActionPackMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyToolsAuthorizeActionPack(),
+    mutationFn: function toolsAuthorizeActionPackMutationFn({
+      authorizeActionPackRequest,
+      actionPackId,
+      options,
+    }): Promise<ToolsAuthorizeActionPackMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(toolsAuthorizeActionPack(
+        client$,
+        authorizeActionPackRequest,
+        actionPackId,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/toolsGetActionPackAuthStatus.core.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f4208601672a
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { toolsGetActionPackAuthStatus } from "../funcs/toolsGetActionPackAuthStatus.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";
+export type ToolsGetActionPackAuthStatusQueryData =
+  components.ActionPackAuthStatusResponse;
+
+export function prefetchToolsGetActionPackAuthStatus(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  actionPackId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildToolsGetActionPackAuthStatusQuery(
+      client$,
+      actionPackId,
+      options,
+    ),
+  });
+}
+
+export function buildToolsGetActionPackAuthStatusQuery(
+  client$: GleanCore,
+  actionPackId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<ToolsGetActionPackAuthStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyToolsGetActionPackAuthStatus(actionPackId),
+    queryFn: async function toolsGetActionPackAuthStatusQueryFn(
+      ctx,
+    ): Promise<ToolsGetActionPackAuthStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(toolsGetActionPackAuthStatus(
+        client$,
+        actionPackId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyToolsGetActionPackAuthStatus(
+  actionPackId: string,
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "Tools",
+    "getActionPackAuthStatus",
+    actionPackId,
+  ];
+}