@gleanwork/api-client 0.16.1 → 0.17.0

package/src/react-query/toolsAuthorizeActionPack.ts

@@ -1,119 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 1e27082b7f84
- */
-
-import {
-  MutationKey,
-  useMutation,
-  UseMutationResult,
-} from "@tanstack/react-query";
-import { GleanCore } from "../core.js";
-import { toolsAuthorizeActionPack } from "../funcs/toolsAuthorizeActionPack.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 { 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 ToolsAuthorizeActionPackMutationVariables = {
-  authorizeActionPackRequest: components.AuthorizeActionPackRequest;
-  actionPackId: string;
-  options?: RequestOptions;
-};
-
-export type ToolsAuthorizeActionPackMutationData =
-  components.AuthorizeActionPackResponse;
-
-export type ToolsAuthorizeActionPackMutationError =
-  | GleanBaseError
-  | ResponseValidationError
-  | ConnectionError
-  | RequestAbortedError
-  | RequestTimeoutError
-  | InvalidRequestError
-  | UnexpectedClientError
-  | SDKValidationError;
-
-/**
- * Start the OAuth authorization flow for an action pack.
- *
- * @remarks
- * Starts the third-party OAuth flow for the specified action pack and returns the
- * redirect URL that the client should navigate the end user to. After the OAuth
- * callback completes, the user's browser is redirected back to `returnUrl` with a
- * status query parameter (`?glean_action_auth=success|error&actionPackId=...`).
- *
- * `returnUrl` must match the tenant's configured return URL allowlist; otherwise the
- * request is rejected with 400.
- */
-export function useToolsAuthorizeActionPackMutation(
-  options?: MutationHookOptions<
-    ToolsAuthorizeActionPackMutationData,
-    ToolsAuthorizeActionPackMutationError,
-    ToolsAuthorizeActionPackMutationVariables
-  >,
-): UseMutationResult<
-  ToolsAuthorizeActionPackMutationData,
-  ToolsAuthorizeActionPackMutationError,
-  ToolsAuthorizeActionPackMutationVariables
-> {
-  const client = useGleanContext();
-  return useMutation({
-    ...buildToolsAuthorizeActionPackMutation(client, options),
-    ...options,
-  });
-}
-
-export function mutationKeyToolsAuthorizeActionPack(): MutationKey {
-  return ["@gleanwork/api-client", "Tools", "authorizeActionPack"];
-}
-
-export function buildToolsAuthorizeActionPackMutation(
-  client$: GleanCore,
-  hookOptions?: RequestOptions,
-): {
-  mutationKey: MutationKey;
-  mutationFn: (
-    variables: ToolsAuthorizeActionPackMutationVariables,
-  ) => Promise<ToolsAuthorizeActionPackMutationData>;
-} {
-  return {
-    mutationKey: mutationKeyToolsAuthorizeActionPack(),
-    mutationFn: function toolsAuthorizeActionPackMutationFn({
-      authorizeActionPackRequest,
-      actionPackId,
-      options,
-    }): Promise<ToolsAuthorizeActionPackMutationData> {
-      const mergedOptions = {
-        ...hookOptions,
-        ...options,
-        fetchOptions: {
-          ...hookOptions?.fetchOptions,
-          ...options?.fetchOptions,
-          signal: combineSignals(
-            hookOptions?.fetchOptions?.signal,
-            options?.fetchOptions?.signal,
-          ),
-        },
-      };
-      return unwrapAsync(toolsAuthorizeActionPack(
-        client$,
-        authorizeActionPackRequest,
-        actionPackId,
-        mergedOptions,
-      ));
-    },
-  };
-}

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

@@ -1,79 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: f4208601672a
- */
-
-import {
-  QueryClient,
-  QueryFunctionContext,
-  QueryKey,
-} from "@tanstack/react-query";
-import { GleanCore } from "../core.js";
-import { toolsGetActionPackAuthStatus } from "../funcs/toolsGetActionPackAuthStatus.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 ToolsGetActionPackAuthStatusQueryData =
-  components.ActionPackAuthStatusResponse;
-
-export function prefetchToolsGetActionPackAuthStatus(
-  queryClient: QueryClient,
-  client$: GleanCore,
-  actionPackId: string,
-  options?: RequestOptions,
-): Promise<void> {
-  return queryClient.prefetchQuery({
-    ...buildToolsGetActionPackAuthStatusQuery(
-      client$,
-      actionPackId,
-      options,
-    ),
-  });
-}
-
-export function buildToolsGetActionPackAuthStatusQuery(
-  client$: GleanCore,
-  actionPackId: string,
-  options?: RequestOptions,
-): {
-  queryKey: QueryKey;
-  queryFn: (
-    context: QueryFunctionContext,
-  ) => Promise<ToolsGetActionPackAuthStatusQueryData>;
-} {
-  return {
-    queryKey: queryKeyToolsGetActionPackAuthStatus(actionPackId),
-    queryFn: async function toolsGetActionPackAuthStatusQueryFn(
-      ctx,
-    ): Promise<ToolsGetActionPackAuthStatusQueryData> {
-      const sig = combineSignals(
-        ctx.signal,
-        options?.signal,
-        options?.fetchOptions?.signal,
-      );
-      const mergedOptions = {
-        ...options?.fetchOptions,
-        ...options,
-        signal: sig,
-      };
-
-      return unwrapAsync(toolsGetActionPackAuthStatus(
-        client$,
-        actionPackId,
-        mergedOptions,
-      ));
-    },
-  };
-}
-
-export function queryKeyToolsGetActionPackAuthStatus(
-  actionPackId: string,
-): QueryKey {
-  return [
-    "@gleanwork/api-client",
-    "Tools",
-    "getActionPackAuthStatus",
-    actionPackId,
-  ];
-}

package/src/react-query/toolsGetActionPackAuthStatus.ts

@@ -1,145 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 651b3a2e8f61
- */
-
-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 { 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 {
-  buildToolsGetActionPackAuthStatusQuery,
-  prefetchToolsGetActionPackAuthStatus,
-  queryKeyToolsGetActionPackAuthStatus,
-  ToolsGetActionPackAuthStatusQueryData,
-} from "./toolsGetActionPackAuthStatus.core.js";
-export {
-  buildToolsGetActionPackAuthStatusQuery,
-  prefetchToolsGetActionPackAuthStatus,
-  queryKeyToolsGetActionPackAuthStatus,
-  type ToolsGetActionPackAuthStatusQueryData,
-};
-
-export type ToolsGetActionPackAuthStatusQueryError =
-  | GleanBaseError
-  | ResponseValidationError
-  | ConnectionError
-  | RequestAbortedError
-  | RequestTimeoutError
-  | InvalidRequestError
-  | UnexpectedClientError
-  | SDKValidationError;
-
-/**
- * Get end-user authentication status for an action pack.
- *
- * @remarks
- * Reports whether the calling user is already authenticated against the third-party
- * tool backing the specified action pack. Intended for headless / server-driven clients
- * that render an "Authorize" prompt when the user has not yet consented to the tool.
- */
-export function useToolsGetActionPackAuthStatus(
-  actionPackId: string,
-  options?: QueryHookOptions<
-    ToolsGetActionPackAuthStatusQueryData,
-    ToolsGetActionPackAuthStatusQueryError
-  >,
-): UseQueryResult<
-  ToolsGetActionPackAuthStatusQueryData,
-  ToolsGetActionPackAuthStatusQueryError
-> {
-  const client = useGleanContext();
-  return useQuery({
-    ...buildToolsGetActionPackAuthStatusQuery(
-      client,
-      actionPackId,
-      options,
-    ),
-    ...options,
-  });
-}
-
-/**
- * Get end-user authentication status for an action pack.
- *
- * @remarks
- * Reports whether the calling user is already authenticated against the third-party
- * tool backing the specified action pack. Intended for headless / server-driven clients
- * that render an "Authorize" prompt when the user has not yet consented to the tool.
- */
-export function useToolsGetActionPackAuthStatusSuspense(
-  actionPackId: string,
-  options?: SuspenseQueryHookOptions<
-    ToolsGetActionPackAuthStatusQueryData,
-    ToolsGetActionPackAuthStatusQueryError
-  >,
-): UseSuspenseQueryResult<
-  ToolsGetActionPackAuthStatusQueryData,
-  ToolsGetActionPackAuthStatusQueryError
-> {
-  const client = useGleanContext();
-  return useSuspenseQuery({
-    ...buildToolsGetActionPackAuthStatusQuery(
-      client,
-      actionPackId,
-      options,
-    ),
-    ...options,
-  });
-}
-
-export function setToolsGetActionPackAuthStatusData(
-  client: QueryClient,
-  queryKeyBase: [actionPackId: string],
-  data: ToolsGetActionPackAuthStatusQueryData,
-): ToolsGetActionPackAuthStatusQueryData | undefined {
-  const key = queryKeyToolsGetActionPackAuthStatus(...queryKeyBase);
-
-  return client.setQueryData<ToolsGetActionPackAuthStatusQueryData>(key, data);
-}
-
-export function invalidateToolsGetActionPackAuthStatus(
-  client: QueryClient,
-  queryKeyBase: TupleToPrefixes<[actionPackId: string]>,
-  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
-): Promise<void> {
-  return client.invalidateQueries({
-    ...filters,
-    queryKey: [
-      "@gleanwork/api-client",
-      "Tools",
-      "getActionPackAuthStatus",
-      ...queryKeyBase,
-    ],
-  });
-}
-
-export function invalidateAllToolsGetActionPackAuthStatus(
-  client: QueryClient,
-  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
-): Promise<void> {
-  return client.invalidateQueries({
-    ...filters,
-    queryKey: ["@gleanwork/api-client", "Tools", "getActionPackAuthStatus"],
-  });
-}

package/src/react-query/troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents.ts

@@ -1,132 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 25aad4d97aeb
- */
-
-import {
-  MutationKey,
-  useMutation,
-  UseMutationResult,
-} from "@tanstack/react-query";
-import { GleanCore } from "../core.js";
-import { troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents } from "../funcs/troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents.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 { 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 TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables =
-  {
-    debugDocumentLifecycleRequest: components.DebugDocumentLifecycleRequest;
-    datasource: string;
-    options?: RequestOptions;
-  };
-
-export type TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData =
-  components.DebugDocumentLifecycleResponse;
-
-export type TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationError =
-  | GleanBaseError
-  | ResponseValidationError
-  | ConnectionError
-  | RequestAbortedError
-  | RequestTimeoutError
-  | InvalidRequestError
-  | UnexpectedClientError
-  | SDKValidationError;
-
-/**
- * Beta: Get document lifecycle events
- *
- * @remarks
- * Retrieves lifecycle events for a specific document including upload time, index times and deletions. Rate limited to 1 request per minute per datasource. Currently in beta, might undergo breaking changes without prior notice.
- */
-export function useTroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutation(
-  options?: MutationHookOptions<
-    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData,
-    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationError,
-    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables
-  >,
-): UseMutationResult<
-  TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData,
-  TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationError,
-  TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables
-> {
-  const client = useGleanContext();
-  return useMutation({
-    ...buildTroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutation(
-      client,
-      options,
-    ),
-    ...options,
-  });
-}
-
-export function mutationKeyTroubleshootingPostApiIndexV1DebugDatasourceDocumentEvents(): MutationKey {
-  return [
-    "@gleanwork/api-client",
-    "Troubleshooting",
-    "postApiIndexV1DebugDatasourceDocumentEvents",
-  ];
-}
-
-export function buildTroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutation(
-  client$: GleanCore,
-  hookOptions?: RequestOptions,
-): {
-  mutationKey: MutationKey;
-  mutationFn: (
-    variables:
-      TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationVariables,
-  ) => Promise<
-    TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData
-  >;
-} {
-  return {
-    mutationKey:
-      mutationKeyTroubleshootingPostApiIndexV1DebugDatasourceDocumentEvents(),
-    mutationFn:
-      function troubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationFn(
-        {
-          debugDocumentLifecycleRequest,
-          datasource,
-          options,
-        },
-      ): Promise<
-        TroubleshootingPostApiIndexV1DebugDatasourceDocumentEventsMutationData
-      > {
-        const mergedOptions = {
-          ...hookOptions,
-          ...options,
-          fetchOptions: {
-            ...hookOptions?.fetchOptions,
-            ...options?.fetchOptions,
-            signal: combineSignals(
-              hookOptions?.fetchOptions?.signal,
-              options?.fetchOptions?.signal,
-            ),
-          },
-        };
-        return unwrapAsync(
-          troubleshootingPostApiIndexV1DebugDatasourceDocumentEvents(
-            client$,
-            debugDocumentLifecycleRequest,
-            datasource,
-            mergedOptions,
-          ),
-        );
-      },
-  };
-}

package/src/sdk/authentication.ts

@@ -1,32 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- * @generated-id: 627e108b9d4b
- */
-
-import { authenticationCheckdatasourceauth } from "../funcs/authenticationCheckdatasourceauth.js";
-import { ClientSDK, RequestOptions } from "../lib/sdks.js";
-import * as components from "../models/components/index.js";
-import { unwrapAsync } from "../types/fp.js";
-
-export class Authentication extends ClientSDK {
-  /**
-   * Check datasource authorization
-   *
-   * @remarks
-   * Returns all datasource instances that require per-user OAuth authorization
-   * for the authenticated user, along with a transient auth token that can be
-   * appended to auth URLs to complete OAuth flows.
-   *
-   * Clients construct the full OAuth URL by combining the backend base URL,
-   * the `authUrlRelativePath` from each instance, and the transient auth token:
-   * `<backend>/<authUrlRelativePath>?transient_auth_token=<token>`.
-   */
-  async checkdatasourceauth(
-    options?: RequestOptions,
-  ): Promise<components.CheckDatasourceAuthResponse> {
-    return unwrapAsync(authenticationCheckdatasourceauth(
-      this,
-      options,
-    ));
-  }
-}