@gleanwork/api-client 0.13.14 → 0.13.15

package/src/models/components/timerangefilter.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  TimeRange,
+  TimeRange$inboundSchema,
+  TimeRange$Outbound,
+  TimeRange$outboundSchema,
+} from "./timerange.js";
+
+/**
+ * The type of time period for which to filter findings.
+ */
+export const TimeRangeFilterTimePeriodType = {
+  PastDay: "PAST_DAY",
+  PastWeek: "PAST_WEEK",
+  PastMonth: "PAST_MONTH",
+  PastYear: "PAST_YEAR",
+  Custom: "CUSTOM",
+} as const;
+/**
+ * The type of time period for which to filter findings.
+ */
+export type TimeRangeFilterTimePeriodType = ClosedEnum<
+  typeof TimeRangeFilterTimePeriodType
+>;
+
+export type TimeRangeFilter = {
+  /**
+   * The type of time period for which to filter findings.
+   */
+  timePeriodType?: TimeRangeFilterTimePeriodType | undefined;
+  customTimeRange?: TimeRange | undefined;
+};
+
+/** @internal */
+export const TimeRangeFilterTimePeriodType$inboundSchema: z.ZodNativeEnum<
+  typeof TimeRangeFilterTimePeriodType
+> = z.nativeEnum(TimeRangeFilterTimePeriodType);
+/** @internal */
+export const TimeRangeFilterTimePeriodType$outboundSchema: z.ZodNativeEnum<
+  typeof TimeRangeFilterTimePeriodType
+> = TimeRangeFilterTimePeriodType$inboundSchema;
+
+/** @internal */
+export const TimeRangeFilter$inboundSchema: z.ZodType<
+  TimeRangeFilter,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  timePeriodType: TimeRangeFilterTimePeriodType$inboundSchema.optional(),
+  customTimeRange: TimeRange$inboundSchema.optional(),
+});
+/** @internal */
+export type TimeRangeFilter$Outbound = {
+  timePeriodType?: string | undefined;
+  customTimeRange?: TimeRange$Outbound | undefined;
+};
+
+/** @internal */
+export const TimeRangeFilter$outboundSchema: z.ZodType<
+  TimeRangeFilter$Outbound,
+  z.ZodTypeDef,
+  TimeRangeFilter
+> = z.object({
+  timePeriodType: TimeRangeFilterTimePeriodType$outboundSchema.optional(),
+  customTimeRange: TimeRange$outboundSchema.optional(),
+});
+
+export function timeRangeFilterToJSON(
+  timeRangeFilter: TimeRangeFilter,
+): string {
+  return JSON.stringify(TimeRangeFilter$outboundSchema.parse(timeRangeFilter));
+}
+export function timeRangeFilterFromJSON(
+  jsonString: string,
+): SafeParseResult<TimeRangeFilter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TimeRangeFilter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TimeRangeFilter' from JSON`,
+  );
+}

package/src/models/operations/deletefindingsexport.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeletefindingsexportRequest = {
+  /**
+   * The ID of the export to delete.
+   */
+  id: number;
+};
+
+/** @internal */
+export type DeletefindingsexportRequest$Outbound = {
+  id: number;
+};
+
+/** @internal */
+export const DeletefindingsexportRequest$outboundSchema: z.ZodType<
+  DeletefindingsexportRequest$Outbound,
+  z.ZodTypeDef,
+  DeletefindingsexportRequest
+> = z.object({
+  id: z.number().int(),
+});
+
+export function deletefindingsexportRequestToJSON(
+  deletefindingsexportRequest: DeletefindingsexportRequest,
+): string {
+  return JSON.stringify(
+    DeletefindingsexportRequest$outboundSchema.parse(
+      deletefindingsexportRequest,
+    ),
+  );
+}

package/src/models/operations/downloadfindingsexport.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DownloadfindingsexportRequest = {
+  /**
+   * The ID of the export to download.
+   */
+  id: string;
+};
+
+/** @internal */
+export type DownloadfindingsexportRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DownloadfindingsexportRequest$outboundSchema: z.ZodType<
+  DownloadfindingsexportRequest$Outbound,
+  z.ZodTypeDef,
+  DownloadfindingsexportRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function downloadfindingsexportRequestToJSON(
+  downloadfindingsexportRequest: DownloadfindingsexportRequest,
+): string {
+  return JSON.stringify(
+    DownloadfindingsexportRequest$outboundSchema.parse(
+      downloadfindingsexportRequest,
+    ),
+  );
+}

package/src/models/operations/index.ts

@@ -8,6 +8,8 @@ export * from "./createcollection.js";
 export * from "./deleteallchats.js";
 export * from "./deletechatfiles.js";
 export * from "./deletechats.js";
+export * from "./deletefindingsexport.js";
+export * from "./downloadfindingsexport.js";
 export * from "./downloadpolicycsv.js";
 export * from "./downloadreportcsv.js";
 export * from "./feedback.js";

package/src/react-query/governanceCreatefindingsexport.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { governanceCreatefindingsexport } from "../funcs/governanceCreatefindingsexport.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";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type GovernanceCreatefindingsexportMutationVariables = {
+  request: components.DlpExportFindingsRequest;
+  options?: RequestOptions;
+};
+
+export type GovernanceCreatefindingsexportMutationData = components.ExportInfo;
+
+/**
+ * Creates findings export
+ *
+ * @remarks
+ * Creates a new DLP findings export job.
+ */
+export function useGovernanceCreatefindingsexportMutation(
+  options?: MutationHookOptions<
+    GovernanceCreatefindingsexportMutationData,
+    Error,
+    GovernanceCreatefindingsexportMutationVariables
+  >,
+): UseMutationResult<
+  GovernanceCreatefindingsexportMutationData,
+  Error,
+  GovernanceCreatefindingsexportMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildGovernanceCreatefindingsexportMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyGovernanceCreatefindingsexport(): MutationKey {
+  return ["@gleanwork/api-client", "Governance", "createfindingsexport"];
+}
+
+export function buildGovernanceCreatefindingsexportMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: GovernanceCreatefindingsexportMutationVariables,
+  ) => Promise<GovernanceCreatefindingsexportMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyGovernanceCreatefindingsexport(),
+    mutationFn: function governanceCreatefindingsexportMutationFn({
+      request,
+      options,
+    }): Promise<GovernanceCreatefindingsexportMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(governanceCreatefindingsexport(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/governanceDeletefindingsexport.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { governanceDeletefindingsexport } from "../funcs/governanceDeletefindingsexport.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type GovernanceDeletefindingsexportMutationVariables = {
+  id: number;
+  options?: RequestOptions;
+};
+
+export type GovernanceDeletefindingsexportMutationData = void;
+
+/**
+ * Deletes findings export
+ *
+ * @remarks
+ * Deletes a DLP findings export.
+ */
+export function useGovernanceDeletefindingsexportMutation(
+  options?: MutationHookOptions<
+    GovernanceDeletefindingsexportMutationData,
+    Error,
+    GovernanceDeletefindingsexportMutationVariables
+  >,
+): UseMutationResult<
+  GovernanceDeletefindingsexportMutationData,
+  Error,
+  GovernanceDeletefindingsexportMutationVariables
+> {
+  const client = useGleanContext();
+  return useMutation({
+    ...buildGovernanceDeletefindingsexportMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyGovernanceDeletefindingsexport(): MutationKey {
+  return ["@gleanwork/api-client", "Governance", "deletefindingsexport"];
+}
+
+export function buildGovernanceDeletefindingsexportMutation(
+  client$: GleanCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: GovernanceDeletefindingsexportMutationVariables,
+  ) => Promise<GovernanceDeletefindingsexportMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyGovernanceDeletefindingsexport(),
+    mutationFn: function governanceDeletefindingsexportMutationFn({
+      id,
+      options,
+    }): Promise<GovernanceDeletefindingsexportMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(governanceDeletefindingsexport(
+        client$,
+        id,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/governanceDownloadfindingsexport.ts

@@ -0,0 +1,155 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { governanceDownloadfindingsexport } from "../funcs/governanceDownloadfindingsexport.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useGleanContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type GovernanceDownloadfindingsexportQueryData = string;
+
+/**
+ * Downloads findings export
+ *
+ * @remarks
+ * Downloads a DLP findings export as a CSV file.
+ */
+export function useGovernanceDownloadfindingsexport(
+  id: string,
+  options?: QueryHookOptions<GovernanceDownloadfindingsexportQueryData>,
+): UseQueryResult<GovernanceDownloadfindingsexportQueryData, Error> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildGovernanceDownloadfindingsexportQuery(
+      client,
+      id,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Downloads findings export
+ *
+ * @remarks
+ * Downloads a DLP findings export as a CSV file.
+ */
+export function useGovernanceDownloadfindingsexportSuspense(
+  id: string,
+  options?: SuspenseQueryHookOptions<GovernanceDownloadfindingsexportQueryData>,
+): UseSuspenseQueryResult<GovernanceDownloadfindingsexportQueryData, Error> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildGovernanceDownloadfindingsexportQuery(
+      client,
+      id,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchGovernanceDownloadfindingsexport(
+  queryClient: QueryClient,
+  client$: GleanCore,
+  id: string,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildGovernanceDownloadfindingsexportQuery(
+      client$,
+      id,
+    ),
+  });
+}
+
+export function setGovernanceDownloadfindingsexportData(
+  client: QueryClient,
+  queryKeyBase: [id: string],
+  data: GovernanceDownloadfindingsexportQueryData,
+): GovernanceDownloadfindingsexportQueryData | undefined {
+  const key = queryKeyGovernanceDownloadfindingsexport(...queryKeyBase);
+
+  return client.setQueryData<GovernanceDownloadfindingsexportQueryData>(
+    key,
+    data,
+  );
+}
+
+export function invalidateGovernanceDownloadfindingsexport(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<[id: string]>,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: [
+      "@gleanwork/api-client",
+      "Governance",
+      "downloadfindingsexport",
+      ...queryKeyBase,
+    ],
+  });
+}
+
+export function invalidateAllGovernanceDownloadfindingsexport(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "Governance", "downloadfindingsexport"],
+  });
+}
+
+export function buildGovernanceDownloadfindingsexportQuery(
+  client$: GleanCore,
+  id: string,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<GovernanceDownloadfindingsexportQueryData>;
+} {
+  return {
+    queryKey: queryKeyGovernanceDownloadfindingsexport(id),
+    queryFn: async function governanceDownloadfindingsexportQueryFn(
+      ctx,
+    ): Promise<GovernanceDownloadfindingsexportQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(governanceDownloadfindingsexport(
+        client$,
+        id,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyGovernanceDownloadfindingsexport(id: string): QueryKey {
+  return ["@gleanwork/api-client", "Governance", "downloadfindingsexport", id];
+}

package/src/react-query/governanceListfindingsexports.ts

@@ -0,0 +1,125 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { GleanCore } from "../core.js";
+import { governanceListfindingsexports } from "../funcs/governanceListfindingsexports.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";
+import { useGleanContext } from "./_context.js";
+import { QueryHookOptions, SuspenseQueryHookOptions } from "./_types.js";
+
+export type GovernanceListfindingsexportsQueryData =
+  components.ListDlpFindingsExportsResponse;
+
+/**
+ * Lists findings exports
+ *
+ * @remarks
+ * Lists all DLP findings exports.
+ */
+export function useGovernanceListfindingsexports(
+  options?: QueryHookOptions<GovernanceListfindingsexportsQueryData>,
+): UseQueryResult<GovernanceListfindingsexportsQueryData, Error> {
+  const client = useGleanContext();
+  return useQuery({
+    ...buildGovernanceListfindingsexportsQuery(
+      client,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Lists findings exports
+ *
+ * @remarks
+ * Lists all DLP findings exports.
+ */
+export function useGovernanceListfindingsexportsSuspense(
+  options?: SuspenseQueryHookOptions<GovernanceListfindingsexportsQueryData>,
+): UseSuspenseQueryResult<GovernanceListfindingsexportsQueryData, Error> {
+  const client = useGleanContext();
+  return useSuspenseQuery({
+    ...buildGovernanceListfindingsexportsQuery(
+      client,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchGovernanceListfindingsexports(
+  queryClient: QueryClient,
+  client$: GleanCore,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildGovernanceListfindingsexportsQuery(
+      client$,
+    ),
+  });
+}
+
+export function setGovernanceListfindingsexportsData(
+  client: QueryClient,
+  data: GovernanceListfindingsexportsQueryData,
+): GovernanceListfindingsexportsQueryData | undefined {
+  const key = queryKeyGovernanceListfindingsexports();
+
+  return client.setQueryData<GovernanceListfindingsexportsQueryData>(key, data);
+}
+
+export function invalidateAllGovernanceListfindingsexports(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@gleanwork/api-client", "Governance", "listfindingsexports"],
+  });
+}
+
+export function buildGovernanceListfindingsexportsQuery(
+  client$: GleanCore,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<GovernanceListfindingsexportsQueryData>;
+} {
+  return {
+    queryKey: queryKeyGovernanceListfindingsexports(),
+    queryFn: async function governanceListfindingsexportsQueryFn(
+      ctx,
+    ): Promise<GovernanceListfindingsexportsQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(governanceListfindingsexports(
+        client$,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyGovernanceListfindingsexports(): QueryKey {
+  return ["@gleanwork/api-client", "Governance", "listfindingsexports"];
+}

package/src/react-query/index.ts

@@ -77,6 +77,10 @@ export * from "./clientToolsRun.js";
 export * from "./clientVerificationAddReminder.js";
 export * from "./clientVerificationList.js";
 export * from "./clientVerificationVerify.js";
+export * from "./governanceCreatefindingsexport.js";
+export * from "./governanceDeletefindingsexport.js";
+export * from "./governanceDownloadfindingsexport.js";
+export * from "./governanceListfindingsexports.js";
 export * from "./indexingAuthenticationRotateToken.js";
 export * from "./indexingDatasourcesAdd.js";
 export * from "./indexingDatasourcesRetrieveConfig.js";

package/src/sdk/client.ts

@@ -10,10 +10,10 @@ import { Answers } from "./answers.js";
 import { Chat } from "./chat.js";
 import { ClientAuthentication } from "./clientauthentication.js";
 import { ClientDocuments } from "./clientdocuments.js";
+import { ClientGovernance } from "./clientgovernance.js";
 import { ClientShortcuts } from "./clientshortcuts.js";
 import { Collections } from "./collections.js";
 import { Entities } from "./entities.js";
-import { Governance } from "./governance.js";
 import { Insights } from "./insights.js";
 import { Messages } from "./messages.js";
 import { Pins } from "./pins.js";
@@ -102,8 +102,8 @@ export class Client extends ClientSDK {
     return (this._tools ??= new Tools(this._options));
   }
 
-  private _governance?: Governance;
-  get governance(): Governance {
-    return (this._governance ??= new Governance(this._options));
+  private _governance?: ClientGovernance;
+  get governance(): ClientGovernance {
+    return (this._governance ??= new ClientGovernance(this._options));
   }
 }

package/src/sdk/clientgovernance.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { ClientSDK } from "../lib/sdks.js";
+import { Data } from "./data.js";
+import { GovernanceDocuments } from "./governancedocuments.js";
+
+export class ClientGovernance extends ClientSDK {
+  private _data?: Data;
+  get data(): Data {
+    return (this._data ??= new Data(this._options));
+  }
+
+  private _documents?: GovernanceDocuments;
+  get documents(): GovernanceDocuments {
+    return (this._documents ??= new GovernanceDocuments(this._options));
+  }
+}