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

package/src/react-query/indexingTroubleshootingDatasourceStatus.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { indexingTroubleshootingDatasourceStatus } from "../funcs/indexingTroubleshootingDatasourceStatus.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 IndexingTroubleshootingDatasourceStatusMutationVariables = {
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingTroubleshootingDatasourceStatusMutationData =
+  components.DebugDatasourceStatusResponse;
+
+/**
+ * Beta: Get datasource status
+ *
+ * @remarks
+ * Gather information about the datasource's overall status. 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 useIndexingTroubleshootingDatasourceStatusMutation(
+  options?: MutationHookOptions<
+    IndexingTroubleshootingDatasourceStatusMutationData,
+    Error,
+    IndexingTroubleshootingDatasourceStatusMutationVariables
+  >,
+): UseMutationResult<
+  IndexingTroubleshootingDatasourceStatusMutationData,
+  Error,
+  IndexingTroubleshootingDatasourceStatusMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingTroubleshootingDatasourceStatusMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingTroubleshootingDatasourceStatus(): MutationKey {
+  return ["@gleanwork/api-client", "datasource", "status"];
+}
+
+export function buildIndexingTroubleshootingDatasourceStatusMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingTroubleshootingDatasourceStatusMutationVariables,
+  ) => Promise<IndexingTroubleshootingDatasourceStatusMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingTroubleshootingDatasourceStatus(),
+    mutationFn: function indexingTroubleshootingDatasourceStatusMutationFn({
+      datasource,
+      options,
+    }): Promise<IndexingTroubleshootingDatasourceStatusMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingTroubleshootingDatasourceStatus(
+        client$,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingTroubleshootingDatasourceUserDebug.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 { indexingTroubleshootingDatasourceUserDebug } from "../funcs/indexingTroubleshootingDatasourceUserDebug.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 IndexingTroubleshootingDatasourceUserDebugMutationVariables = {
+  debugUserRequest: components.DebugUserRequest;
+  datasource: string;
+  options?: RequestOptions;
+};
+
+export type IndexingTroubleshootingDatasourceUserDebugMutationData =
+  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 useIndexingTroubleshootingDatasourceUserDebugMutation(
+  options?: MutationHookOptions<
+    IndexingTroubleshootingDatasourceUserDebugMutationData,
+    Error,
+    IndexingTroubleshootingDatasourceUserDebugMutationVariables
+  >,
+): UseMutationResult<
+  IndexingTroubleshootingDatasourceUserDebugMutationData,
+  Error,
+  IndexingTroubleshootingDatasourceUserDebugMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingTroubleshootingDatasourceUserDebugMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingTroubleshootingDatasourceUserDebug(): MutationKey {
+  return ["@gleanwork/api-client", "user", "debug"];
+}
+
+export function buildIndexingTroubleshootingDatasourceUserDebugMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingTroubleshootingDatasourceUserDebugMutationVariables,
+  ) => Promise<IndexingTroubleshootingDatasourceUserDebugMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingTroubleshootingDatasourceUserDebug(),
+    mutationFn: function indexingTroubleshootingDatasourceUserDebugMutationFn({
+      debugUserRequest,
+      datasource,
+      options,
+    }): Promise<IndexingTroubleshootingDatasourceUserDebugMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingTroubleshootingDatasourceUserDebug(
+        client$,
+        debugUserRequest,
+        datasource,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingTroubleshootingDocumentsCount.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 { indexingTroubleshootingDocumentsCount } from "../funcs/indexingTroubleshootingDocumentsCount.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 IndexingTroubleshootingDocumentsCountMutationVariables = {
+  request: components.GetDocumentCountRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingTroubleshootingDocumentsCountMutationData =
+  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 useIndexingTroubleshootingDocumentsCountMutation(
+  options?: MutationHookOptions<
+    IndexingTroubleshootingDocumentsCountMutationData,
+    Error,
+    IndexingTroubleshootingDocumentsCountMutationVariables
+  >,
+): UseMutationResult<
+  IndexingTroubleshootingDocumentsCountMutationData,
+  Error,
+  IndexingTroubleshootingDocumentsCountMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingTroubleshootingDocumentsCountMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingTroubleshootingDocumentsCount(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "count"];
+}
+
+export function buildIndexingTroubleshootingDocumentsCountMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingTroubleshootingDocumentsCountMutationVariables,
+  ) => Promise<IndexingTroubleshootingDocumentsCountMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingTroubleshootingDocumentsCount(),
+    mutationFn: function indexingTroubleshootingDocumentsCountMutationFn({
+      request,
+      options,
+    }): Promise<IndexingTroubleshootingDocumentsCountMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingTroubleshootingDocumentsCount(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingTroubleshootingDocumentsStatus.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 { indexingTroubleshootingDocumentsStatus } from "../funcs/indexingTroubleshootingDocumentsStatus.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 IndexingTroubleshootingDocumentsStatusMutationVariables = {
+  request: components.GetDocumentStatusRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingTroubleshootingDocumentsStatusMutationData =
+  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 useIndexingTroubleshootingDocumentsStatusMutation(
+  options?: MutationHookOptions<
+    IndexingTroubleshootingDocumentsStatusMutationData,
+    Error,
+    IndexingTroubleshootingDocumentsStatusMutationVariables
+  >,
+): UseMutationResult<
+  IndexingTroubleshootingDocumentsStatusMutationData,
+  Error,
+  IndexingTroubleshootingDocumentsStatusMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingTroubleshootingDocumentsStatusMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingTroubleshootingDocumentsStatus(): MutationKey {
+  return ["@gleanwork/api-client", "documents", "status"];
+}
+
+export function buildIndexingTroubleshootingDocumentsStatusMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingTroubleshootingDocumentsStatusMutationVariables,
+  ) => Promise<IndexingTroubleshootingDocumentsStatusMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingTroubleshootingDocumentsStatus(),
+    mutationFn: function indexingTroubleshootingDocumentsStatusMutationFn({
+      request,
+      options,
+    }): Promise<IndexingTroubleshootingDocumentsStatusMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingTroubleshootingDocumentsStatus(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/indexingTroubleshootingUsersCount.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 { indexingTroubleshootingUsersCount } from "../funcs/indexingTroubleshootingUsersCount.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 IndexingTroubleshootingUsersCountMutationVariables = {
+  request: components.GetUserCountRequest;
+  options?: RequestOptions;
+};
+
+export type IndexingTroubleshootingUsersCountMutationData =
+  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 useIndexingTroubleshootingUsersCountMutation(
+  options?: MutationHookOptions<
+    IndexingTroubleshootingUsersCountMutationData,
+    Error,
+    IndexingTroubleshootingUsersCountMutationVariables
+  >,
+): UseMutationResult<
+  IndexingTroubleshootingUsersCountMutationData,
+  Error,
+  IndexingTroubleshootingUsersCountMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildIndexingTroubleshootingUsersCountMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIndexingTroubleshootingUsersCount(): MutationKey {
+  return ["@gleanwork/api-client", "users", "count"];
+}
+
+export function buildIndexingTroubleshootingUsersCountMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IndexingTroubleshootingUsersCountMutationVariables,
+  ) => Promise<IndexingTroubleshootingUsersCountMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIndexingTroubleshootingUsersCount(),
+    mutationFn: function indexingTroubleshootingUsersCountMutationFn({
+      request,
+      options,
+    }): Promise<IndexingTroubleshootingUsersCountMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(indexingTroubleshootingUsersCount(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/peoplePostApiIndexV1Bulkindexemployees.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 { peoplePostApiIndexV1Bulkindexemployees } from "../funcs/peoplePostApiIndexV1Bulkindexemployees.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 PeoplePostApiIndexV1BulkindexemployeesMutationVariables = {
+  request: components.BulkIndexEmployeesRequest;
+  options?: RequestOptions;
+};
+
+export type PeoplePostApiIndexV1BulkindexemployeesMutationData = void;
+
+/**
+ * Bulk index employees
+ *
+ * @remarks
+ * 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 usePeoplePostApiIndexV1BulkindexemployeesMutation(
+  options?: MutationHookOptions<
+    PeoplePostApiIndexV1BulkindexemployeesMutationData,
+    Error,
+    PeoplePostApiIndexV1BulkindexemployeesMutationVariables
+  >,
+): UseMutationResult<
+  PeoplePostApiIndexV1BulkindexemployeesMutationData,
+  Error,
+  PeoplePostApiIndexV1BulkindexemployeesMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildPeoplePostApiIndexV1BulkindexemployeesMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyPeoplePostApiIndexV1Bulkindexemployees(): MutationKey {
+  return [
+    "@gleanwork/api-client",
+    "People",
+    "postApiIndexV1Bulkindexemployees",
+  ];
+}
+
+export function buildPeoplePostApiIndexV1BulkindexemployeesMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: PeoplePostApiIndexV1BulkindexemployeesMutationVariables,
+  ) => Promise<PeoplePostApiIndexV1BulkindexemployeesMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyPeoplePostApiIndexV1Bulkindexemployees(),
+    mutationFn: function peoplePostApiIndexV1BulkindexemployeesMutationFn({
+      request,
+      options,
+    }): Promise<PeoplePostApiIndexV1BulkindexemployeesMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(peoplePostApiIndexV1Bulkindexemployees(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/searchAutocomplete.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 { searchAutocomplete } from "../funcs/searchAutocomplete.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 SearchAutocompleteMutationVariables = {
+  request: components.AutocompleteRequest;
+  options?: RequestOptions;
+};
+
+export type SearchAutocompleteMutationData = components.AutocompleteResponse;
+
+/**
+ * Autocomplete
+ *
+ * @remarks
+ * Retrieve query suggestions, operators and documents for the given partially typed query.
+ */
+export function useSearchAutocompleteMutation(
+  options?: MutationHookOptions<
+    SearchAutocompleteMutationData,
+    Error,
+    SearchAutocompleteMutationVariables
+  >,
+): UseMutationResult<
+  SearchAutocompleteMutationData,
+  Error,
+  SearchAutocompleteMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSearchAutocompleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySearchAutocomplete(): MutationKey {
+  return ["@gleanwork/api-client", "Search", "autocomplete"];
+}
+
+export function buildSearchAutocompleteMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SearchAutocompleteMutationVariables,
+  ) => Promise<SearchAutocompleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySearchAutocomplete(),
+    mutationFn: function searchAutocompleteMutationFn({
+      request,
+      options,
+    }): Promise<SearchAutocompleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(searchAutocomplete(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}