@gleanwork/api-client 0.18.1 → 0.19.1

package/src/react-query/triggersGet.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4257b148bb52
+ */
+
+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 {
+  buildTriggersGetQuery,
+  prefetchTriggersGet,
+  queryKeyTriggersGet,
+  TriggersGetQueryData,
+} from "./triggersGet.core.js";
+export {
+  buildTriggersGetQuery,
+  prefetchTriggersGet,
+  queryKeyTriggersGet,
+  type TriggersGetQueryData,
+};
+
+export type TriggersGetQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get trigger
+ *
+ * @remarks
+ * Retrieve a trigger owned by the authenticated caller.
+ */
+export function useTriggersGet(
+  triggerId: string,
+  options?: QueryHookOptions<TriggersGetQueryData, TriggersGetQueryError>,
+): UseQueryResult<TriggersGetQueryData, TriggersGetQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildTriggersGetQuery(
+      client,
+      triggerId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get trigger
+ *
+ * @remarks
+ * Retrieve a trigger owned by the authenticated caller.
+ */
+export function useTriggersGetSuspense(
+  triggerId: string,
+  options?: SuspenseQueryHookOptions<
+    TriggersGetQueryData,
+    TriggersGetQueryError
+  >,
+): UseSuspenseQueryResult<TriggersGetQueryData, TriggersGetQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildTriggersGetQuery(
+      client,
+      triggerId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setTriggersGetData(
+  client: QueryClient,
+  queryKeyBase: [triggerId: string],
+  data: TriggersGetQueryData,
+): TriggersGetQueryData | undefined {
+  const key = queryKeyTriggersGet(...queryKeyBase);
+
+  return client.setQueryData<TriggersGetQueryData>(key, data);
+}
+
+export function invalidateTriggersGet(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[triggerId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "get", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllTriggersGet(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "get"],
+  });
+}

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

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 572eb7a2ed9f
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { triggersGetPreset } from "../funcs/triggersGetPreset.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 TriggersGetPresetQueryData =
+  components.PlatformTriggerPresetGetResponse;
+
+export function prefetchTriggersGetPreset(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  presetId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTriggersGetPresetQuery(
+      client$,
+      presetId,
+      options,
+    ),
+  });
+}
+
+export function buildTriggersGetPresetQuery(
+  client$: GleanCore,
+  presetId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<TriggersGetPresetQueryData>;
+} {
+  return {
+    queryKey: queryKeyTriggersGetPreset(presetId),
+    queryFn: async function triggersGetPresetQueryFn(
+      ctx,
+    ): Promise<TriggersGetPresetQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(triggersGetPreset(
+        client$,
+        presetId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTriggersGetPreset(presetId: string): QueryKey {
+  return ["@gleanwork/api-client", "triggers", "getPreset", presetId];
+}

package/src/react-query/triggersGetPreset.ts

@@ -0,0 +1,140 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 653b5e2d4654
+ */
+
+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 {
+  buildTriggersGetPresetQuery,
+  prefetchTriggersGetPreset,
+  queryKeyTriggersGetPreset,
+  TriggersGetPresetQueryData,
+} from "./triggersGetPreset.core.js";
+export {
+  buildTriggersGetPresetQuery,
+  prefetchTriggersGetPreset,
+  queryKeyTriggersGetPreset,
+  type TriggersGetPresetQueryData,
+};
+
+export type TriggersGetPresetQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get trigger preset
+ *
+ * @remarks
+ * Retrieve a single trigger preset by id.
+ */
+export function useTriggersGetPreset(
+  presetId: string,
+  options?: QueryHookOptions<
+    TriggersGetPresetQueryData,
+    TriggersGetPresetQueryError
+  >,
+): UseQueryResult<TriggersGetPresetQueryData, TriggersGetPresetQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildTriggersGetPresetQuery(
+      client,
+      presetId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get trigger preset
+ *
+ * @remarks
+ * Retrieve a single trigger preset by id.
+ */
+export function useTriggersGetPresetSuspense(
+  presetId: string,
+  options?: SuspenseQueryHookOptions<
+    TriggersGetPresetQueryData,
+    TriggersGetPresetQueryError
+  >,
+): UseSuspenseQueryResult<
+  TriggersGetPresetQueryData,
+  TriggersGetPresetQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildTriggersGetPresetQuery(
+      client,
+      presetId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setTriggersGetPresetData(
+  client: QueryClient,
+  queryKeyBase: [presetId: string],
+  data: TriggersGetPresetQueryData,
+): TriggersGetPresetQueryData | undefined {
+  const key = queryKeyTriggersGetPreset(...queryKeyBase);
+
+  return client.setQueryData<TriggersGetPresetQueryData>(key, data);
+}
+
+export function invalidateTriggersGetPreset(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[presetId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "triggers",
+      "getPreset",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllTriggersGetPreset(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "getPreset"],
+  });
+}

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

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: da1c1b81b3bc
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { triggersList } from "../funcs/triggersList.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 TriggersListQueryData = components.PlatformTriggerListResponse;
+
+export function prefetchTriggersList(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTriggersListQuery(
+      client$,
+      pageSize,
+      cursor,
+      options,
+    ),
+  });
+}
+
+export function buildTriggersListQuery(
+  client$: GleanCore,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<TriggersListQueryData>;
+} {
+  return {
+    queryKey: queryKeyTriggersList({ pageSize, cursor }),
+    queryFn: async function triggersListQueryFn(
+      ctx,
+    ): Promise<TriggersListQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(triggersList(
+        client$,
+        pageSize,
+        cursor,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTriggersList(
+  parameters: { pageSize?: number | undefined; cursor?: string | undefined },
+): QueryKey {
+  return ["@gleanwork/api-client", "triggers", "list", parameters];
+}

package/src/react-query/triggersList.ts

@@ -0,0 +1,137 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2950a0bc7d2a
+ */
+
+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 {
+  buildTriggersListQuery,
+  prefetchTriggersList,
+  queryKeyTriggersList,
+  TriggersListQueryData,
+} from "./triggersList.core.js";
+export {
+  buildTriggersListQuery,
+  prefetchTriggersList,
+  queryKeyTriggersList,
+  type TriggersListQueryData,
+};
+
+export type TriggersListQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List triggers
+ *
+ * @remarks
+ * List triggers owned by the authenticated caller.
+ */
+export function useTriggersList(
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: QueryHookOptions<TriggersListQueryData, TriggersListQueryError>,
+): UseQueryResult<TriggersListQueryData, TriggersListQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildTriggersListQuery(
+      client,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List triggers
+ *
+ * @remarks
+ * List triggers owned by the authenticated caller.
+ */
+export function useTriggersListSuspense(
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: SuspenseQueryHookOptions<
+    TriggersListQueryData,
+    TriggersListQueryError
+  >,
+): UseSuspenseQueryResult<TriggersListQueryData, TriggersListQueryError> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildTriggersListQuery(
+      client,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setTriggersListData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: { pageSize?: number | undefined; cursor?: string | undefined },
+  ],
+  data: TriggersListQueryData,
+): TriggersListQueryData | undefined {
+  const key = queryKeyTriggersList(...queryKeyBase);
+
+  return client.setQueryData<TriggersListQueryData>(key, data);
+}
+
+export function invalidateTriggersList(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: { pageSize?: number | undefined; cursor?: string | undefined }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "list", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllTriggersList(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "list"],
+  });
+}

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

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4e43b3f3f0c4
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { triggersListPresetInputValues } from "../funcs/triggersListPresetInputValues.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 TriggersListPresetInputValuesQueryData =
+  components.PlatformTriggerPresetInputValueListResponse;
+
+export function prefetchTriggersListPresetInputValues(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  presetId: string,
+  field: string,
+  query?: string | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTriggersListPresetInputValuesQuery(
+      client$,
+      presetId,
+      field,
+      query,
+      options,
+    ),
+  });
+}
+
+export function buildTriggersListPresetInputValuesQuery(
+  client$: GleanCore,
+  presetId: string,
+  field: string,
+  query?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<TriggersListPresetInputValuesQueryData>;
+} {
+  return {
+    queryKey: queryKeyTriggersListPresetInputValues(presetId, { field, query }),
+    queryFn: async function triggersListPresetInputValuesQueryFn(
+      ctx,
+    ): Promise<TriggersListPresetInputValuesQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(triggersListPresetInputValues(
+        client$,
+        presetId,
+        field,
+        query,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTriggersListPresetInputValues(
+  presetId: string,
+  parameters: { field: string; query?: string | undefined },
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "triggers",
+    "listPresetInputValues",
+    presetId,
+    parameters,
+  ];
+}