@gleanwork/api-client 0.17.2 → 0.18.0

package/src/react-query/skillsRetrieve.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 8bd7927c56aa
+ */
+
+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 {
+  buildSkillsRetrieveQuery,
+  prefetchSkillsRetrieve,
+  queryKeySkillsRetrieve,
+  SkillsRetrieveQueryData,
+} from "./skillsRetrieve.core.js";
+export {
+  buildSkillsRetrieveQuery,
+  prefetchSkillsRetrieve,
+  queryKeySkillsRetrieve,
+  type SkillsRetrieveQueryData,
+};
+
+export type SkillsRetrieveQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Retrieve skill
+ *
+ * @remarks
+ * Retrieve metadata for a skill available to the authenticated user.
+ */
+export function useSkillsRetrieve(
+  skillId: string,
+  options?: QueryHookOptions<SkillsRetrieveQueryData, SkillsRetrieveQueryError>,
+): UseQueryResult<SkillsRetrieveQueryData, SkillsRetrieveQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsRetrieveQuery(
+      client,
+      skillId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Retrieve skill
+ *
+ * @remarks
+ * Retrieve metadata for a skill available to the authenticated user.
+ */
+export function useSkillsRetrieveSuspense(
+  skillId: string,
+  options?: SuspenseQueryHookOptions<
+    SkillsRetrieveQueryData,
+    SkillsRetrieveQueryError
+  >,
+): UseSuspenseQueryResult<SkillsRetrieveQueryData, SkillsRetrieveQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsRetrieveQuery(
+      client,
+      skillId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [skillId: string],
+  data: SkillsRetrieveQueryData,
+): SkillsRetrieveQueryData | undefined {
+  const key = queryKeySkillsRetrieve(...queryKeyBase);
+
+  return client.setQueryData<SkillsRetrieveQueryData>(key, data);
+}
+
+export function invalidateSkillsRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[skillId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllSkillsRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieve"],
+  });
+}

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

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d03069e54713
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { skillsRetrieveContent } from "../funcs/skillsRetrieveContent.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 SkillsRetrieveContentQueryData =
+  operations.PlatformSkillsGetContentResponse;
+
+export function prefetchSkillsRetrieveContent(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  skillId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSkillsRetrieveContentQuery(
+      client$,
+      skillId,
+      options,
+    ),
+  });
+}
+
+export function buildSkillsRetrieveContentQuery(
+  client$: GleanCore,
+  skillId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SkillsRetrieveContentQueryData>;
+} {
+  return {
+    queryKey: queryKeySkillsRetrieveContent(skillId),
+    queryFn: async function skillsRetrieveContentQueryFn(
+      ctx,
+    ): Promise<SkillsRetrieveContentQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(skillsRetrieveContent(
+        client$,
+        skillId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySkillsRetrieveContent(skillId: string): QueryKey {
+  return ["@gleanwork/api-client", "skills", "retrieveContent", skillId];
+}

package/src/react-query/skillsRetrieveContent.ts

@@ -0,0 +1,143 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c3ff7f8aede3
+ */
+
+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 {
+  buildSkillsRetrieveContentQuery,
+  prefetchSkillsRetrieveContent,
+  queryKeySkillsRetrieveContent,
+  SkillsRetrieveContentQueryData,
+} from "./skillsRetrieveContent.core.js";
+export {
+  buildSkillsRetrieveContentQuery,
+  prefetchSkillsRetrieveContent,
+  queryKeySkillsRetrieveContent,
+  type SkillsRetrieveContentQueryData,
+};
+
+export type SkillsRetrieveContentQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Download skill content
+ *
+ * @remarks
+ * Download the latest installable bundle for a skill available to the authenticated user.
+ */
+export function useSkillsRetrieveContent(
+  skillId: string,
+  options?: QueryHookOptions<
+    SkillsRetrieveContentQueryData,
+    SkillsRetrieveContentQueryError
+  >,
+): UseQueryResult<
+  SkillsRetrieveContentQueryData,
+  SkillsRetrieveContentQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildSkillsRetrieveContentQuery(
+      client,
+      skillId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Download skill content
+ *
+ * @remarks
+ * Download the latest installable bundle for a skill available to the authenticated user.
+ */
+export function useSkillsRetrieveContentSuspense(
+  skillId: string,
+  options?: SuspenseQueryHookOptions<
+    SkillsRetrieveContentQueryData,
+    SkillsRetrieveContentQueryError
+  >,
+): UseSuspenseQueryResult<
+  SkillsRetrieveContentQueryData,
+  SkillsRetrieveContentQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildSkillsRetrieveContentQuery(
+      client,
+      skillId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setSkillsRetrieveContentData(
+  client: QueryClient,
+  queryKeyBase: [skillId: string],
+  data: SkillsRetrieveContentQueryData,
+): SkillsRetrieveContentQueryData | undefined {
+  const key = queryKeySkillsRetrieveContent(...queryKeyBase);
+
+  return client.setQueryData<SkillsRetrieveContentQueryData>(key, data);
+}
+
+export function invalidateSkillsRetrieveContent(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[skillId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "skills",
+      "retrieveContent",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllSkillsRetrieveContent(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "skills", "retrieveContent"],
+  });
+}

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,
+  ];
+}