@gleanwork/api-client 0.16.1 → 0.17.0

package/src/react-query/clientDatasourcesRetrieveConfiguration.ts

@@ -0,0 +1,150 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2f370dea591e
+ */
+
+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 {
+  buildClientDatasourcesRetrieveConfigurationQuery,
+  ClientDatasourcesRetrieveConfigurationQueryData,
+  prefetchClientDatasourcesRetrieveConfiguration,
+  queryKeyClientDatasourcesRetrieveConfiguration,
+} from "./clientDatasourcesRetrieveConfiguration.core.js";
+export {
+  buildClientDatasourcesRetrieveConfigurationQuery,
+  type ClientDatasourcesRetrieveConfigurationQueryData,
+  prefetchClientDatasourcesRetrieveConfiguration,
+  queryKeyClientDatasourcesRetrieveConfiguration,
+};
+
+export type ClientDatasourcesRetrieveConfigurationQueryError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get datasource instance configuration
+ *
+ * @remarks
+ * Gets the greenlisted configuration values for a datasource instance. Returns only configuration keys that are exposed via the public API greenlist.
+ */
+export function useClientDatasourcesRetrieveConfiguration(
+  datasourceId: string,
+  instanceId: string,
+  options?: QueryHookOptions<
+    ClientDatasourcesRetrieveConfigurationQueryData,
+    ClientDatasourcesRetrieveConfigurationQueryError
+  >,
+): UseQueryResult<
+  ClientDatasourcesRetrieveConfigurationQueryData,
+  ClientDatasourcesRetrieveConfigurationQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildClientDatasourcesRetrieveConfigurationQuery(
+      client,
+      datasourceId,
+      instanceId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get datasource instance configuration
+ *
+ * @remarks
+ * Gets the greenlisted configuration values for a datasource instance. Returns only configuration keys that are exposed via the public API greenlist.
+ */
+export function useClientDatasourcesRetrieveConfigurationSuspense(
+  datasourceId: string,
+  instanceId: string,
+  options?: SuspenseQueryHookOptions<
+    ClientDatasourcesRetrieveConfigurationQueryData,
+    ClientDatasourcesRetrieveConfigurationQueryError
+  >,
+): UseSuspenseQueryResult<
+  ClientDatasourcesRetrieveConfigurationQueryData,
+  ClientDatasourcesRetrieveConfigurationQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildClientDatasourcesRetrieveConfigurationQuery(
+      client,
+      datasourceId,
+      instanceId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setClientDatasourcesRetrieveConfigurationData(
+  client: QueryClient,
+  queryKeyBase: [datasourceId: string, instanceId: string],
+  data: ClientDatasourcesRetrieveConfigurationQueryData,
+): ClientDatasourcesRetrieveConfigurationQueryData | undefined {
+  const key = queryKeyClientDatasourcesRetrieveConfiguration(...queryKeyBase);
+
+  return client.setQueryData<ClientDatasourcesRetrieveConfigurationQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateClientDatasourcesRetrieveConfiguration(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[datasourceId: string, instanceId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "datasources",
+      "retrieveConfiguration",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllClientDatasourcesRetrieveConfiguration(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "datasources", "retrieveConfiguration"],
+  });
+}

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

@@ -0,0 +1,81 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3bddf4d353bb
+ */
+
+import {
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientDatasourcesRetrieveCredentialStatus } from "../funcs/clientDatasourcesRetrieveCredentialStatus.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 ClientDatasourcesRetrieveCredentialStatusQueryData =
+  components.DatasourceCredentialStatusResponse;
+
+export function prefetchClientDatasourcesRetrieveCredentialStatus(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  datasourceInstanceId: string,
+  options?: RequestOptions,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildClientDatasourcesRetrieveCredentialStatusQuery(
+      client$,
+      datasourceInstanceId,
+      options,
+    ),
+  });
+}
+
+export function buildClientDatasourcesRetrieveCredentialStatusQuery(
+  client$: GleanCore,
+  datasourceInstanceId: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<ClientDatasourcesRetrieveCredentialStatusQueryData>;
+} {
+  return {
+    queryKey: queryKeyClientDatasourcesRetrieveCredentialStatus(
+      datasourceInstanceId,
+    ),
+    queryFn: async function clientDatasourcesRetrieveCredentialStatusQueryFn(
+      ctx,
+    ): Promise<ClientDatasourcesRetrieveCredentialStatusQueryData> {
+      const sig = combineSignals(
+        ctx.signal,
+        options?.signal,
+        options?.fetchOptions?.signal,
+      );
+      const mergedOptions = {
+        ...options?.fetchOptions,
+        ...options,
+        signal: sig,
+      };
+
+      return unwrapAsync(clientDatasourcesRetrieveCredentialStatus(
+        client$,
+        datasourceInstanceId,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyClientDatasourcesRetrieveCredentialStatus(
+  datasourceInstanceId: string,
+): QueryKey {
+  return [
+    "@gleanwork/api-client",
+    "datasources",
+    "retrieveCredentialStatus",
+    datasourceInstanceId,
+  ];
+}

package/src/react-query/clientDatasourcesRetrieveCredentialStatus.ts

@@ -0,0 +1,151 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d885f9fd297e
+ */
+
+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 {
+  buildClientDatasourcesRetrieveCredentialStatusQuery,
+  ClientDatasourcesRetrieveCredentialStatusQueryData,
+  prefetchClientDatasourcesRetrieveCredentialStatus,
+  queryKeyClientDatasourcesRetrieveCredentialStatus,
+} from "./clientDatasourcesRetrieveCredentialStatus.core.js";
+export {
+  buildClientDatasourcesRetrieveCredentialStatusQuery,
+  type ClientDatasourcesRetrieveCredentialStatusQueryData,
+  prefetchClientDatasourcesRetrieveCredentialStatus,
+  queryKeyClientDatasourcesRetrieveCredentialStatus,
+};
+
+export type ClientDatasourcesRetrieveCredentialStatusQueryError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Get datasource instance credential status
+ *
+ * @remarks
+ * Returns the current credential status for a datasource instance. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ */
+export function useClientDatasourcesRetrieveCredentialStatus(
+  datasourceInstanceId: string,
+  options?: QueryHookOptions<
+    ClientDatasourcesRetrieveCredentialStatusQueryData,
+    ClientDatasourcesRetrieveCredentialStatusQueryError
+  >,
+): UseQueryResult<
+  ClientDatasourcesRetrieveCredentialStatusQueryData,
+  ClientDatasourcesRetrieveCredentialStatusQueryError
+> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildClientDatasourcesRetrieveCredentialStatusQuery(
+      client,
+      datasourceInstanceId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get datasource instance credential status
+ *
+ * @remarks
+ * Returns the current credential status for a datasource instance. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ */
+export function useClientDatasourcesRetrieveCredentialStatusSuspense(
+  datasourceInstanceId: string,
+  options?: SuspenseQueryHookOptions<
+    ClientDatasourcesRetrieveCredentialStatusQueryData,
+    ClientDatasourcesRetrieveCredentialStatusQueryError
+  >,
+): UseSuspenseQueryResult<
+  ClientDatasourcesRetrieveCredentialStatusQueryData,
+  ClientDatasourcesRetrieveCredentialStatusQueryError
+> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildClientDatasourcesRetrieveCredentialStatusQuery(
+      client,
+      datasourceInstanceId,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function setClientDatasourcesRetrieveCredentialStatusData(
+  client: QueryClient,
+  queryKeyBase: [datasourceInstanceId: string],
+  data: ClientDatasourcesRetrieveCredentialStatusQueryData,
+): ClientDatasourcesRetrieveCredentialStatusQueryData | undefined {
+  const key = queryKeyClientDatasourcesRetrieveCredentialStatus(
+    ...queryKeyBase,
+  );
+
+  return client.setQueryData<
+    ClientDatasourcesRetrieveCredentialStatusQueryData
+  >(key, data);
+}
+
+export function invalidateClientDatasourcesRetrieveCredentialStatus(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[datasourceInstanceId: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "datasources",
+      "retrieveCredentialStatus",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllClientDatasourcesRetrieveCredentialStatus(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "datasources",
+      "retrieveCredentialStatus",
+    ],
+  });
+}

package/src/react-query/clientDatasourcesRotateCredentials.ts

@@ -0,0 +1,117 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 322a20ea20c2
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientDatasourcesRotateCredentials } from "../funcs/clientDatasourcesRotateCredentials.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 ClientDatasourcesRotateCredentialsMutationVariables = {
+  rotateDatasourceCredentialsRequest:
+    components.RotateDatasourceCredentialsRequest;
+  datasourceInstanceId: string;
+  options?: RequestOptions;
+};
+
+export type ClientDatasourcesRotateCredentialsMutationData =
+  components.DatasourceCredentialStatusResponse;
+
+export type ClientDatasourcesRotateCredentialsMutationError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Rotate datasource instance credentials
+ *
+ * @remarks
+ * Rotates the credentials that a datasource instance uses to connect to its upstream system. Replaces the active credential material with the supplied values and returns the credential status after rotation. Access is limited to callers with the ADMIN scope; the handler enforces this check.
+ * Only keys recognized as credential material for the datasource type may be set in `credentials.values` (e.g. `clientSecret`, `apiToken`, `privateKey`, depending on the configured auth method). Unrecognized keys, or keys that correspond to non-credential configuration, cause a 400; other instance configuration must be updated via PATCH /configure/datasources/{datasourceId}/instances/{instanceId}.
+ */
+export function useClientDatasourcesRotateCredentialsMutation(
+  options?: MutationHookOptions<
+    ClientDatasourcesRotateCredentialsMutationData,
+    ClientDatasourcesRotateCredentialsMutationError,
+    ClientDatasourcesRotateCredentialsMutationVariables
+  >,
+): UseMutationResult<
+  ClientDatasourcesRotateCredentialsMutationData,
+  ClientDatasourcesRotateCredentialsMutationError,
+  ClientDatasourcesRotateCredentialsMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildClientDatasourcesRotateCredentialsMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyClientDatasourcesRotateCredentials(): MutationKey {
+  return ["@gleanwork/api-client", "datasources", "rotateCredentials"];
+}
+
+export function buildClientDatasourcesRotateCredentialsMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ClientDatasourcesRotateCredentialsMutationVariables,
+  ) => Promise<ClientDatasourcesRotateCredentialsMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyClientDatasourcesRotateCredentials(),
+    mutationFn: function clientDatasourcesRotateCredentialsMutationFn({
+      rotateDatasourceCredentialsRequest,
+      datasourceInstanceId,
+      options,
+    }): Promise<ClientDatasourcesRotateCredentialsMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(clientDatasourcesRotateCredentials(
+        client$,
+        rotateDatasourceCredentialsRequest,
+        datasourceInstanceId,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/clientDatasourcesUpdateConfiguration.ts

@@ -0,0 +1,119 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 01cf9229f8e2
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { clientDatasourcesUpdateConfiguration } from "../funcs/clientDatasourcesUpdateConfiguration.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 ClientDatasourcesUpdateConfigurationMutationVariables = {
+  updateDatasourceConfigurationRequest:
+    components.UpdateDatasourceConfigurationRequest;
+  datasourceId: string;
+  instanceId: string;
+  options?: RequestOptions;
+};
+
+export type ClientDatasourcesUpdateConfigurationMutationData =
+  components.DatasourceConfigurationResponse;
+
+export type ClientDatasourcesUpdateConfigurationMutationError =
+  | errors.ErrorResponse
+  | GleanBaseError
+  | ResponseValidationError
+  | ConnectionError
+  | RequestAbortedError
+  | RequestTimeoutError
+  | InvalidRequestError
+  | UnexpectedClientError
+  | SDKValidationError;
+
+/**
+ * Update datasource instance configuration
+ *
+ * @remarks
+ * Updates the greenlisted configuration values for a datasource instance. Only configuration keys that are exposed via the public API greenlist may be set. Returns the full greenlisted configuration after the update is applied.
+ */
+export function useClientDatasourcesUpdateConfigurationMutation(
+  options?: MutationHookOptions<
+    ClientDatasourcesUpdateConfigurationMutationData,
+    ClientDatasourcesUpdateConfigurationMutationError,
+    ClientDatasourcesUpdateConfigurationMutationVariables
+  >,
+): UseMutationResult<
+  ClientDatasourcesUpdateConfigurationMutationData,
+  ClientDatasourcesUpdateConfigurationMutationError,
+  ClientDatasourcesUpdateConfigurationMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildClientDatasourcesUpdateConfigurationMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyClientDatasourcesUpdateConfiguration(): MutationKey {
+  return ["@gleanwork/api-client", "datasources", "updateConfiguration"];
+}
+
+export function buildClientDatasourcesUpdateConfigurationMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: ClientDatasourcesUpdateConfigurationMutationVariables,
+  ) => Promise<ClientDatasourcesUpdateConfigurationMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyClientDatasourcesUpdateConfiguration(),
+    mutationFn: function clientDatasourcesUpdateConfigurationMutationFn({
+      updateDatasourceConfigurationRequest,
+      datasourceId,
+      instanceId,
+      options,
+    }): Promise<ClientDatasourcesUpdateConfigurationMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(clientDatasourcesUpdateConfiguration(
+        client$,
+        updateDatasourceConfigurationRequest,
+        datasourceId,
+        instanceId,
+        mergedOptions,
+      ));
+    },
+  };
+}