@gleanwork/api-client 0.1.0-beta.6 → 0.1.0-beta.8

package/src/react-query/indexingDocumentsCount.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDocumentsCount } from "../funcs/indexingDocumentsCount.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 IndexingDocumentsCountMutationVariables = {
+  request: components.GetDocumentCountRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingDocumentsCountMutationData =
+  components.GetDocumentCountResponse;
+
+/**
+ * Get document count
+ *
+ * @remarks
+ * Fetches document count for the specified custom datasource.
+ *
+ * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export function useIndexingDocumentsCountMutation(
+  options?: MutationHookOptions<
+    IndexingDocumentsCountMutationData,
+    Error,
+    IndexingDocumentsCountMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDocumentsCountMutationData,
+  Error,
+  IndexingDocumentsCountMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDocumentsCountMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDocumentsCount(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "count"];
+}
+
+export function buildIndexingDocumentsCountMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDocumentsCountMutationVariables,
+  ) => Promise<IndexingDocumentsCountMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDocumentsCount(),
+    mutationFn: function indexingDocumentsCountMutationFn({
+      request,
+      options,
+    }): Promise<IndexingDocumentsCountMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDocumentsCount(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingDocumentsDebug.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDocumentsDebug } from "../funcs/indexingDocumentsDebug.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 IndexingDocumentsDebugMutationVariables = {
+  debugDocumentRequest: components.DebugDocumentRequest;
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingDocumentsDebugMutationData =
+  components.DebugDocumentResponse;
+
+/**
+ * Beta: Get document information
+ *
+ * @remarks
+ * Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice.
+ *
+ * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information.
+ */
+export function useIndexingDocumentsDebugMutation(
+  options?: MutationHookOptions<
+    IndexingDocumentsDebugMutationData,
+    Error,
+    IndexingDocumentsDebugMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDocumentsDebugMutationData,
+  Error,
+  IndexingDocumentsDebugMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDocumentsDebugMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDocumentsDebug(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "debug"];
+}
+
+export function buildIndexingDocumentsDebugMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDocumentsDebugMutationVariables,
+  ) => Promise<IndexingDocumentsDebugMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDocumentsDebug(),
+    mutationFn: function indexingDocumentsDebugMutationFn({
+      debugDocumentRequest,
+      datasource,
+      options,
+    }): Promise<IndexingDocumentsDebugMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDocumentsDebug(
+        client$,
+        debugDocumentRequest,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingDocumentsDebugMany.ts

@@ -0,0 +1,94 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDocumentsDebugMany } from "../funcs/indexingDocumentsDebugMany.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 IndexingDocumentsDebugManyMutationVariables = {
+  debugDocumentsRequest: components.DebugDocumentsRequest;
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingDocumentsDebugManyMutationData =
+  components.DebugDocumentsResponse;
+
+/**
+ * Beta: Get information of a batch of documents
+ *
+ * @remarks
+ * Gives various information that would help in debugging related to a batch of documents. Currently in beta, might undergo breaking changes without prior notice.
+ *
+ * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information.
+ */
+export function useIndexingDocumentsDebugManyMutation(
+  options?: MutationHookOptions<
+    IndexingDocumentsDebugManyMutationData,
+    Error,
+    IndexingDocumentsDebugManyMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDocumentsDebugManyMutationData,
+  Error,
+  IndexingDocumentsDebugManyMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDocumentsDebugManyMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDocumentsDebugMany(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "debugMany"];
+}
+
+export function buildIndexingDocumentsDebugManyMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDocumentsDebugManyMutationVariables,
+  ) => Promise<IndexingDocumentsDebugManyMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDocumentsDebugMany(),
+    mutationFn: function indexingDocumentsDebugManyMutationFn({
+      debugDocumentsRequest,
+      datasource,
+      options,
+    }): Promise<IndexingDocumentsDebugManyMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDocumentsDebugMany(
+        client$,
+        debugDocumentsRequest,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingDocumentsStatus.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingDocumentsStatus } from "../funcs/indexingDocumentsStatus.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 IndexingDocumentsStatusMutationVariables = {
+  request: components.GetDocumentStatusRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingDocumentsStatusMutationData =
+  components.GetDocumentStatusResponse;
+
+/**
+ * Get document upload and indexing status
+ *
+ * @remarks
+ * Intended for debugging/validation. Fetches the current upload and indexing status of documents.
+ *
+ * Tip: Use [/debug/{datasource}/document](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-document) for richer information.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export function useIndexingDocumentsStatusMutation(
+  options?: MutationHookOptions<
+    IndexingDocumentsStatusMutationData,
+    Error,
+    IndexingDocumentsStatusMutationVariables
+  >,
+): UseMutationResult<
+  IndexingDocumentsStatusMutationData,
+  Error,
+  IndexingDocumentsStatusMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingDocumentsStatusMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingDocumentsStatus(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "status"];
+}
+
+export function buildIndexingDocumentsStatusMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingDocumentsStatusMutationVariables,
+  ) => Promise<IndexingDocumentsStatusMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingDocumentsStatus(),
+    mutationFn: function indexingDocumentsStatusMutationFn({
+      request,
+      options,
+    }): Promise<IndexingDocumentsStatusMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingDocumentsStatus(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingPeopleBulkIndex.ts

@@ -17,7 +17,7 @@ import { useGleanContext } from "./_context.js";
 import { MutationHookOptions } from "./_types.js";
 
 export type IndexingPeopleBulkIndexMutationVariables = {
-  request: components.IndexEmployeeListRequest;
+  request: components.BulkIndexEmployeesRequest;
   options?: RequestOptions;
 };
 
@@ -27,9 +27,7 @@ export type IndexingPeopleBulkIndexMutationData = void;
  * Bulk index employees
  *
  * @remarks
- * Bulk upload details of all the employees. This deletes all employees uploaded in the prior batch. SOON TO BE DEPRECATED in favor of /bulkindexemployees.
- *
- * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ * Replaces all the currently indexed employees using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/docs/indexing_api_bulk_indexing/#bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
  */
 export function useIndexingPeopleBulkIndexMutation(
   options?: MutationHookOptions<

package/src/react-query/indexingPeopleCount.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingPeopleCount } from "../funcs/indexingPeopleCount.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 IndexingPeopleCountMutationVariables = {
+  request: components.GetUserCountRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingPeopleCountMutationData = components.GetUserCountResponse;
+
+/**
+ * Get user count
+ *
+ * @remarks
+ * Fetches user count for the specified custom datasource.
+ *
+ * Tip: Use [/debug/{datasource}/status](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/#debug-datasource-status) for richer information.
+ *
+ * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
+ */
+export function useIndexingPeopleCountMutation(
+  options?: MutationHookOptions<
+    IndexingPeopleCountMutationData,
+    Error,
+    IndexingPeopleCountMutationVariables
+  >,
+): UseMutationResult<
+  IndexingPeopleCountMutationData,
+  Error,
+  IndexingPeopleCountMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingPeopleCountMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingPeopleCount(): MutationKey {
+  return ["@gleanwork/api-client", "people", "count"];
+}
+
+export function buildIndexingPeopleCountMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingPeopleCountMutationVariables,
+  ) => Promise<IndexingPeopleCountMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingPeopleCount(),
+    mutationFn: function indexingPeopleCountMutationFn({
+      request,
+      options,
+    }): Promise<IndexingPeopleCountMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingPeopleCount(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingPeopleDebug.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingPeopleDebug } from "../funcs/indexingPeopleDebug.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 IndexingPeopleDebugMutationVariables = {
+  debugUserRequest: components.DebugUserRequest;
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingPeopleDebugMutationData = components.DebugUserResponse;
+
+/**
+ * Beta: Get user information
+ *
+ * @remarks
+ * Gives various information that would help in debugging related to a particular user. Currently in beta, might undergo breaking changes without prior notice.
+ *
+ * Tip: Refer to the [Troubleshooting tutorial](https://developers.glean.com/docs/indexing_api/indexing_api_troubleshooting/) for more information.
+ */
+export function useIndexingPeopleDebugMutation(
+  options?: MutationHookOptions<
+    IndexingPeopleDebugMutationData,
+    Error,
+    IndexingPeopleDebugMutationVariables
+  >,
+): UseMutationResult<
+  IndexingPeopleDebugMutationData,
+  Error,
+  IndexingPeopleDebugMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingPeopleDebugMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingPeopleDebug(): MutationKey {
+  return ["@gleanwork/api-client", "people", "debug"];
+}
+
+export function buildIndexingPeopleDebugMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingPeopleDebugMutationVariables,
+  ) => Promise<IndexingPeopleDebugMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingPeopleDebug(),
+    mutationFn: function indexingPeopleDebugMutationFn({
+      debugUserRequest,
+      datasource,
+      options,
+    }): Promise<IndexingPeopleDebugMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingPeopleDebug(
+        client$,
+        debugUserRequest,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingShortcutsUpload.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 { indexingShortcutsUpload } from "../funcs/indexingShortcutsUpload.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 IndexingShortcutsUploadMutationVariables = {
+  request: components.UploadShortcutsRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingShortcutsUploadMutationData = void;
+
+/**
+ * Upload shortcuts
+ *
+ * @remarks
+ * Creates glean shortcuts for uploaded shortcuts info. Glean would host the shortcuts, and they can be managed in the knowledge tab once uploaded.
+ */
+export function useIndexingShortcutsUploadMutation(
+  options?: MutationHookOptions<
+    IndexingShortcutsUploadMutationData,
+    Error,
+    IndexingShortcutsUploadMutationVariables
+  >,
+): UseMutationResult<
+  IndexingShortcutsUploadMutationData,
+  Error,
+  IndexingShortcutsUploadMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingShortcutsUploadMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingShortcutsUpload(): MutationKey {
+  return ["@gleanwork/api-client", "shortcuts", "upload"];
+}
+
+export function buildIndexingShortcutsUploadMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingShortcutsUploadMutationVariables,
+  ) => Promise<IndexingShortcutsUploadMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingShortcutsUpload(),
+    mutationFn: function indexingShortcutsUploadMutationFn({
+      request,
+      options,
+    }): Promise<IndexingShortcutsUploadMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingShortcutsUpload(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}