@gleanwork/api-client 0.17.3 → 0.18.1

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

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8a1dd7dcdfdd
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsRetrieveVersion } from "../funcs/skillsRetrieveVersion.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 SkillsRetrieveVersionQueryData =
+  components.PlatformSkillVersionGetResponse;
+
+export function prefetchSkillsRetrieveVersion(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  skillId: string,
+  version: number,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSkillsRetrieveVersionQuery(
+      client$,
+      skillId,
+      version,
+      options,
+    ),
+  });
+}
+
+export function buildSkillsRetrieveVersionQuery(
+  client$: GleanCore,
+  skillId: string,
+  version: number,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SkillsRetrieveVersionQueryData>;
+} {
+  return {
+    queryKey: queryKeySkillsRetrieveVersion(skillId, version),
+    queryFn: async function skillsRetrieveVersionQueryFn(
+      ctx,
+    ): Promise<SkillsRetrieveVersionQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(skillsRetrieveVersion(
+        client$,
+        skillId,
+        version,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySkillsRetrieveVersion(
+  skillId: string,
+  version: number,
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "skills",
+    "retrieveVersion",
+    skillId,
+    version,
+  ];
+}

package/src/react-query/skillsRetrieveVersion.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1cb35f733792
+ */
+
+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 {
+  buildSkillsRetrieveVersionQuery,
+  prefetchSkillsRetrieveVersion,
+  queryKeySkillsRetrieveVersion,
+  SkillsRetrieveVersionQueryData,
+} from "./skillsRetrieveVersion.core.js";
+export {
+  buildSkillsRetrieveVersionQuery,
+  prefetchSkillsRetrieveVersion,
+  queryKeySkillsRetrieveVersion,
+  type SkillsRetrieveVersionQueryData,
+};
+
+export type SkillsRetrieveVersionQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Retrieve skill version
+ *
+ * @remarks
+ * Retrieve metadata for a skill version available to the authenticated user.
+ */
+export function useSkillsRetrieveVersion(
+  skillId: string,
+  version: number,
+  options?: QueryHookOptions<
+    SkillsRetrieveVersionQueryData,
+    SkillsRetrieveVersionQueryError
+  >,
+): UseQueryResult<
+  SkillsRetrieveVersionQueryData,
+  SkillsRetrieveVersionQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsRetrieveVersionQuery(
+      client,
+      skillId,
+      version,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Retrieve skill version
+ *
+ * @remarks
+ * Retrieve metadata for a skill version available to the authenticated user.
+ */
+export function useSkillsRetrieveVersionSuspense(
+  skillId: string,
+  version: number,
+  options?: SuspenseQueryHookOptions<
+    SkillsRetrieveVersionQueryData,
+    SkillsRetrieveVersionQueryError
+  >,
+): UseSuspenseQueryResult<
+  SkillsRetrieveVersionQueryData,
+  SkillsRetrieveVersionQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsRetrieveVersionQuery(
+      client,
+      skillId,
+      version,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsRetrieveVersionData(
+  client: QueryClient,
+  queryKeyBase: [skillId: string, version: number],
+  data: SkillsRetrieveVersionQueryData,
+): SkillsRetrieveVersionQueryData | undefined {
+  const key = queryKeySkillsRetrieveVersion(...queryKeyBase);
+
+  return client.setQueryData<SkillsRetrieveVersionQueryData>(key, data);
+}
+
+export function invalidateSkillsRetrieveVersion(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[skillId: string, version: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "skills",
+      "retrieveVersion",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSkillsRetrieveVersion(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieveVersion"],
+  });
+}

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

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 740cd8836341
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsRetrieveVersionContent } from "../funcs/skillsRetrieveVersionContent.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+export type SkillsRetrieveVersionContentQueryData =
+  operations.PlatformSkillsGetVersionContentResponse;
+
+export function prefetchSkillsRetrieveVersionContent(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  skillId: string,
+  version: number,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSkillsRetrieveVersionContentQuery(
+      client$,
+      skillId,
+      version,
+      options,
+    ),
+  });
+}
+
+export function buildSkillsRetrieveVersionContentQuery(
+  client$: GleanCore,
+  skillId: string,
+  version: number,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SkillsRetrieveVersionContentQueryData>;
+} {
+  return {
+    queryKey: queryKeySkillsRetrieveVersionContent(skillId, version),
+    queryFn: async function skillsRetrieveVersionContentQueryFn(
+      ctx,
+    ): Promise<SkillsRetrieveVersionContentQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(skillsRetrieveVersionContent(
+        client$,
+        skillId,
+        version,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySkillsRetrieveVersionContent(
+  skillId: string,
+  version: number,
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "skills",
+    "retrieveVersionContent",
+    skillId,
+    version,
+  ];
+}

package/src/react-query/skillsRetrieveVersionContent.ts

@@ -0,0 +1,147 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: df4ac1f925b8
+ */
+
+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 {
+  buildSkillsRetrieveVersionContentQuery,
+  prefetchSkillsRetrieveVersionContent,
+  queryKeySkillsRetrieveVersionContent,
+  SkillsRetrieveVersionContentQueryData,
+} from "./skillsRetrieveVersionContent.core.js";
+export {
+  buildSkillsRetrieveVersionContentQuery,
+  prefetchSkillsRetrieveVersionContent,
+  queryKeySkillsRetrieveVersionContent,
+  type SkillsRetrieveVersionContentQueryData,
+};
+
+export type SkillsRetrieveVersionContentQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Download skill version content
+ *
+ * @remarks
+ * Download the installable bundle for a skill version available to the authenticated user.
+ */
+export function useSkillsRetrieveVersionContent(
+  skillId: string,
+  version: number,
+  options?: QueryHookOptions<
+    SkillsRetrieveVersionContentQueryData,
+    SkillsRetrieveVersionContentQueryError
+  >,
+): UseQueryResult<
+  SkillsRetrieveVersionContentQueryData,
+  SkillsRetrieveVersionContentQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsRetrieveVersionContentQuery(
+      client,
+      skillId,
+      version,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Download skill version content
+ *
+ * @remarks
+ * Download the installable bundle for a skill version available to the authenticated user.
+ */
+export function useSkillsRetrieveVersionContentSuspense(
+  skillId: string,
+  version: number,
+  options?: SuspenseQueryHookOptions<
+    SkillsRetrieveVersionContentQueryData,
+    SkillsRetrieveVersionContentQueryError
+  >,
+): UseSuspenseQueryResult<
+  SkillsRetrieveVersionContentQueryData,
+  SkillsRetrieveVersionContentQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsRetrieveVersionContentQuery(
+      client,
+      skillId,
+      version,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsRetrieveVersionContentData(
+  client: QueryClient,
+  queryKeyBase: [skillId: string, version: number],
+  data: SkillsRetrieveVersionContentQueryData,
+): SkillsRetrieveVersionContentQueryData | undefined {
+  const key = queryKeySkillsRetrieveVersionContent(...queryKeyBase);
+
+  return client.setQueryData<SkillsRetrieveVersionContentQueryData>(key, data);
+}
+
+export function invalidateSkillsRetrieveVersionContent(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[skillId: string, version: number]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "skills",
+      "retrieveVersionContent",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSkillsRetrieveVersionContent(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieveVersionContent"],
+  });
+}

package/src/react-query/skillsSync.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c5d5816caa2b
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsSync } from "../funcs/skillsSync.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 SkillsSyncMutationVariables = {
+  skillId: string;
+  options?: RequestOptions;
+};
+
+export type SkillsSyncMutationData = components.PlatformSkillSyncResponse;
+
+export type SkillsSyncMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Sync a GitHub-imported skill
+ *
+ * @remarks
+ * Refresh one GitHub-imported skill from its stored source URL. If the skill content has changed, this operation creates a new skill version. If the skill is no longer present upstream, the stored skill is left unchanged and must be deleted explicitly.
+ */
+export function useSkillsSyncMutation(
+  options?: MutationHookOptions<
+    SkillsSyncMutationData,
+    SkillsSyncMutationError,
+    SkillsSyncMutationVariables
+  >,
+): UseMutationResult<
+  SkillsSyncMutationData,
+  SkillsSyncMutationError,
+  SkillsSyncMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsSyncMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsSync(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "sync"];
+}
+
+export function buildSkillsSyncMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsSyncMutationVariables,
+  ) => Promise<SkillsSyncMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsSync(),
+    mutationFn: function skillsSyncMutationFn({
+      skillId,
+      options,
+    }): Promise<SkillsSyncMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsSync(
+        client$,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/skillsUpdate.ts

@@ -0,0 +1,114 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e62e124a1043
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsUpdate } from "../funcs/skillsUpdate.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 SkillsUpdateMutationVariables = {
+  platformSkillUpdateRequest: components.PlatformSkillUpdateRequest;
+  skillId: string;
+  options?: RequestOptions;
+};
+
+export type SkillsUpdateMutationData = components.PlatformSkillUpdateResponse;
+
+export type SkillsUpdateMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Update skill
+ *
+ * @remarks
+ * Update mutable metadata for a skill. V1 supports enabling or disabling a skill without changing its content.
+ */
+export function useSkillsUpdateMutation(
+  options?: MutationHookOptions<
+    SkillsUpdateMutationData,
+    SkillsUpdateMutationError,
+    SkillsUpdateMutationVariables
+  >,
+): UseMutationResult<
+  SkillsUpdateMutationData,
+  SkillsUpdateMutationError,
+  SkillsUpdateMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildSkillsUpdateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeySkillsUpdate(): MutationKey {
+  return ["@gleanwork/api-client", "skills", "update"];
+}
+
+export function buildSkillsUpdateMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: SkillsUpdateMutationVariables,
+  ) => Promise<SkillsUpdateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeySkillsUpdate(),
+    mutationFn: function skillsUpdateMutationFn({
+      platformSkillUpdateRequest,
+      skillId,
+      options,
+    }): Promise<SkillsUpdateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(skillsUpdate(
+        client$,
+        platformSkillUpdateRequest,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}