@gleanwork/api-client 0.18.1 → 0.19.1

package/src/react-query/triggersListPresetInputValues.ts

@@ -0,0 +1,159 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6bed055cbc6b
+ */
+
+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 {
+  buildTriggersListPresetInputValuesQuery,
+  prefetchTriggersListPresetInputValues,
+  queryKeyTriggersListPresetInputValues,
+  TriggersListPresetInputValuesQueryData,
+} from "./triggersListPresetInputValues.core.js";
+export {
+  buildTriggersListPresetInputValuesQuery,
+  prefetchTriggersListPresetInputValues,
+  queryKeyTriggersListPresetInputValues,
+  type TriggersListPresetInputValuesQueryData,
+};
+
+export type TriggersListPresetInputValuesQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Search trigger preset input values
+ *
+ * @remarks
+ * Return up to 300 selectable values for a single picklist input on a preset. Results are intended for typeahead selection and are not cursor-paginated. When `is_truncated` is true, refine `query` to narrow the result set.
+ */
+export function useTriggersListPresetInputValues(
+  presetId: string,
+  field: string,
+  query?: string | undefined,
+  options?: QueryHookOptions<
+    TriggersListPresetInputValuesQueryData,
+    TriggersListPresetInputValuesQueryError
+  >,
+): UseQueryResult<
+  TriggersListPresetInputValuesQueryData,
+  TriggersListPresetInputValuesQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildTriggersListPresetInputValuesQuery(
+      client,
+      presetId,
+      field,
+      query,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Search trigger preset input values
+ *
+ * @remarks
+ * Return up to 300 selectable values for a single picklist input on a preset. Results are intended for typeahead selection and are not cursor-paginated. When `is_truncated` is true, refine `query` to narrow the result set.
+ */
+export function useTriggersListPresetInputValuesSuspense(
+  presetId: string,
+  field: string,
+  query?: string | undefined,
+  options?: SuspenseQueryHookOptions<
+    TriggersListPresetInputValuesQueryData,
+    TriggersListPresetInputValuesQueryError
+  >,
+): UseSuspenseQueryResult<
+  TriggersListPresetInputValuesQueryData,
+  TriggersListPresetInputValuesQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildTriggersListPresetInputValuesQuery(
+      client,
+      presetId,
+      field,
+      query,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setTriggersListPresetInputValuesData(
+  client: QueryClient,
+  queryKeyBase: [
+    presetId: string,
+    parameters: { field: string; query?: string | undefined },
+  ],
+  data: TriggersListPresetInputValuesQueryData,
+): TriggersListPresetInputValuesQueryData | undefined {
+  const key = queryKeyTriggersListPresetInputValues(...queryKeyBase);
+
+  return client.setQueryData<TriggersListPresetInputValuesQueryData>(key, data);
+}
+
+export function invalidateTriggersListPresetInputValues(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      presetId: string,
+      parameters: { field: string; query?: string | undefined },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "triggers",
+      "listPresetInputValues",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllTriggersListPresetInputValues(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "listPresetInputValues"],
+  });
+}

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

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1ad6d934d3bf
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { triggersListPresets } from "../funcs/triggersListPresets.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 TriggersListPresetsQueryData =
+  components.PlatformTriggerPresetListResponse;
+
+export function prefetchTriggersListPresets(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  datasource?: string | undefined,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTriggersListPresetsQuery(
+      client$,
+      datasource,
+      pageSize,
+      cursor,
+      options,
+    ),
+  });
+}
+
+export function buildTriggersListPresetsQuery(
+  client$: GleanCore,
+  datasource?: string | undefined,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<TriggersListPresetsQueryData>;
+} {
+  return {
+    queryKey: queryKeyTriggersListPresets({ datasource, pageSize, cursor }),
+    queryFn: async function triggersListPresetsQueryFn(
+      ctx,
+    ): Promise<TriggersListPresetsQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(triggersListPresets(
+        client$,
+        datasource,
+        pageSize,
+        cursor,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTriggersListPresets(
+  parameters: {
+    datasource?: string | undefined;
+    pageSize?: number | undefined;
+    cursor?: string | undefined;
+  },
+): QueryKey {
+  return ["@gleanwork/api-client", "triggers", "listPresets", parameters];
+}

package/src/react-query/triggersListPresets.ts

@@ -0,0 +1,160 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f24df3df79fc
+ */
+
+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 {
+  buildTriggersListPresetsQuery,
+  prefetchTriggersListPresets,
+  queryKeyTriggersListPresets,
+  TriggersListPresetsQueryData,
+} from "./triggersListPresets.core.js";
+export {
+  buildTriggersListPresetsQuery,
+  prefetchTriggersListPresets,
+  queryKeyTriggersListPresets,
+  type TriggersListPresetsQueryData,
+};
+
+export type TriggersListPresetsQueryError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * List trigger presets
+ *
+ * @remarks
+ * List the trigger presets available to the caller. A preset is a curated content-trigger template (e.g. a new Jira ticket) which is passed when creating a trigger.
+ */
+export function useTriggersListPresets(
+  datasource?: string | undefined,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: QueryHookOptions<
+    TriggersListPresetsQueryData,
+    TriggersListPresetsQueryError
+  >,
+): UseQueryResult<TriggersListPresetsQueryData, TriggersListPresetsQueryError> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildTriggersListPresetsQuery(
+      client,
+      datasource,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * List trigger presets
+ *
+ * @remarks
+ * List the trigger presets available to the caller. A preset is a curated content-trigger template (e.g. a new Jira ticket) which is passed when creating a trigger.
+ */
+export function useTriggersListPresetsSuspense(
+  datasource?: string | undefined,
+  pageSize?: number | undefined,
+  cursor?: string | undefined,
+  options?: SuspenseQueryHookOptions<
+    TriggersListPresetsQueryData,
+    TriggersListPresetsQueryError
+  >,
+): UseSuspenseQueryResult<
+  TriggersListPresetsQueryData,
+  TriggersListPresetsQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildTriggersListPresetsQuery(
+      client,
+      datasource,
+      pageSize,
+      cursor,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setTriggersListPresetsData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      datasource?: string | undefined;
+      pageSize?: number | undefined;
+      cursor?: string | undefined;
+    },
+  ],
+  data: TriggersListPresetsQueryData,
+): TriggersListPresetsQueryData | undefined {
+  const key = queryKeyTriggersListPresets(...queryKeyBase);
+
+  return client.setQueryData<TriggersListPresetsQueryData>(key, data);
+}
+
+export function invalidateTriggersListPresets(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      datasource?: string | undefined;
+      pageSize?: number | undefined;
+      cursor?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "triggers",
+      "listPresets",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllTriggersListPresets(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "triggers", "listPresets"],
+  });
+}

package/src/react-query/triggersSearchEvents.ts

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1cb1234ae7c0
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { triggersSearchEvents } from "../funcs/triggersSearchEvents.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 TriggersSearchEventsMutationVariables = {
+  triggerId: string;
+  platformTriggerEventSearchRequest?:
+    | components.PlatformTriggerEventSearchRequest
+    | undefined;
+  options?: RequestOptions;
+};
+
+export type TriggersSearchEventsMutationData =
+  components.PlatformTriggerEventSearchResponse;
+
+export type TriggersSearchEventsMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Search events for a trigger
+ *
+ * @remarks
+ * Search recent content events an existing trigger matches. Read-only — no webhook delivery is made. Covers the last seven days.
+ */
+export function useTriggersSearchEventsMutation(
+  options?: MutationHookOptions<
+    TriggersSearchEventsMutationData,
+    TriggersSearchEventsMutationError,
+    TriggersSearchEventsMutationVariables
+  >,
+): UseMutationResult<
+  TriggersSearchEventsMutationData,
+  TriggersSearchEventsMutationError,
+  TriggersSearchEventsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildTriggersSearchEventsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTriggersSearchEvents(): MutationKey {
+  return ["@gleanwork/api-client", "triggers", "searchEvents"];
+}
+
+export function buildTriggersSearchEventsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TriggersSearchEventsMutationVariables,
+  ) => Promise<TriggersSearchEventsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTriggersSearchEvents(),
+    mutationFn: function triggersSearchEventsMutationFn({
+      triggerId,
+      platformTriggerEventSearchRequest,
+      options,
+    }): Promise<TriggersSearchEventsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(triggersSearchEvents(
+        client$,
+        triggerId,
+        platformTriggerEventSearchRequest,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/triggersSearchPresetEvents.ts

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3e65cc6cab3c
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { triggersSearchPresetEvents } from "../funcs/triggersSearchPresetEvents.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 TriggersSearchPresetEventsMutationVariables = {
+  presetId: string;
+  platformTriggerPresetEventSearchRequest?:
+    | components.PlatformTriggerPresetEventSearchRequest
+    | undefined;
+  options?: RequestOptions;
+};
+
+export type TriggersSearchPresetEventsMutationData =
+  components.PlatformTriggerEventSearchResponse;
+
+export type TriggersSearchPresetEventsMutationError =
+  | errors.PlatformProblemDetailError
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Search events for a trigger preset
+ *
+ * @remarks
+ * Search recent content events an unsaved trigger built from this preset would match, to preview it before creating the trigger. Read-only — no trigger is created and no webhook delivery is made. Covers the last seven days.
+ */
+export function useTriggersSearchPresetEventsMutation(
+  options?: MutationHookOptions<
+    TriggersSearchPresetEventsMutationData,
+    TriggersSearchPresetEventsMutationError,
+    TriggersSearchPresetEventsMutationVariables
+  >,
+): UseMutationResult<
+  TriggersSearchPresetEventsMutationData,
+  TriggersSearchPresetEventsMutationError,
+  TriggersSearchPresetEventsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildTriggersSearchPresetEventsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTriggersSearchPresetEvents(): MutationKey {
+  return ["@gleanwork/api-client", "triggers", "searchPresetEvents"];
+}
+
+export function buildTriggersSearchPresetEventsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TriggersSearchPresetEventsMutationVariables,
+  ) => Promise<TriggersSearchPresetEventsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTriggersSearchPresetEvents(),
+    mutationFn: function triggersSearchPresetEventsMutationFn({
+      presetId,
+      platformTriggerPresetEventSearchRequest,
+      options,
+    }): Promise<TriggersSearchPresetEventsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(triggersSearchPresetEvents(
+        client$,
+        presetId,
+        platformTriggerPresetEventSearchRequest,
+        mergedOptions,
+      ));
+    },
+  };
+}