@gleanwork/api-client 0.13.13 → 0.13.15

package/src/models/components/querysuggestion.ts

@@ -6,6 +6,12 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ResultTab,
+  ResultTab$inboundSchema,
+  ResultTab$Outbound,
+  ResultTab$outboundSchema,
+} from "./resulttab.js";
 import {
   SearchProviderInfo,
   SearchProviderInfo$inboundSchema,
@@ -49,6 +55,7 @@ export type QuerySuggestion = {
    * The datasource associated with the suggestion.
    */
   datasource?: string | undefined;
+  resultTab?: ResultTab | undefined;
   requestOptions?: SearchRequestOptions | undefined;
   /**
    * The bolded ranges within the query of the QuerySuggestion.
@@ -68,6 +75,7 @@ export const QuerySuggestion$inboundSchema: z.ZodType<
   searchProviderInfo: SearchProviderInfo$inboundSchema.optional(),
   label: z.string().optional(),
   datasource: z.string().optional(),
+  resultTab: ResultTab$inboundSchema.optional(),
   requestOptions: SearchRequestOptions$inboundSchema.optional(),
   ranges: z.array(z.lazy(() => TextRange$inboundSchema)).optional(),
   inputDetails: SearchRequestInputDetails$inboundSchema.optional(),
@@ -79,6 +87,7 @@ export type QuerySuggestion$Outbound = {
   searchProviderInfo?: SearchProviderInfo$Outbound | undefined;
   label?: string | undefined;
   datasource?: string | undefined;
+  resultTab?: ResultTab$Outbound | undefined;
   requestOptions?: SearchRequestOptions$Outbound | undefined;
   ranges?: Array<TextRange$Outbound> | undefined;
   inputDetails?: SearchRequestInputDetails$Outbound | undefined;
@@ -95,6 +104,7 @@ export const QuerySuggestion$outboundSchema: z.ZodType<
   searchProviderInfo: SearchProviderInfo$outboundSchema.optional(),
   label: z.string().optional(),
   datasource: z.string().optional(),
+  resultTab: ResultTab$outboundSchema.optional(),
   requestOptions: SearchRequestOptions$outboundSchema.optional(),
   ranges: z.array(z.lazy(() => TextRange$outboundSchema)).optional(),
   inputDetails: SearchRequestInputDetails$outboundSchema.optional(),

package/src/models/components/resulttab.ts

@@ -37,7 +37,29 @@ export const ResultTab$inboundSchema: z.ZodType<
   datasource: z.string().optional(),
   datasourceInstance: z.string().optional(),
 });
+/** @internal */
+export type ResultTab$Outbound = {
+  id?: string | undefined;
+  count?: number | undefined;
+  datasource?: string | undefined;
+  datasourceInstance?: string | undefined;
+};
+
+/** @internal */
+export const ResultTab$outboundSchema: z.ZodType<
+  ResultTab$Outbound,
+  z.ZodTypeDef,
+  ResultTab
+> = z.object({
+  id: z.string().optional(),
+  count: z.number().int().optional(),
+  datasource: z.string().optional(),
+  datasourceInstance: z.string().optional(),
+});
 
+export function resultTabToJSON(resultTab: ResultTab): string {
+  return JSON.stringify(ResultTab$outboundSchema.parse(resultTab));
+}
 export function resultTabFromJSON(
   jsonString: string,
 ): SafeParseResult<ResultTab, SDKValidationError> {

package/src/models/components/sensitivecontentoptions.ts

@@ -6,6 +6,12 @@ import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomSensitiveExpression,
+  CustomSensitiveExpression$inboundSchema,
+  CustomSensitiveExpression$Outbound,
+  CustomSensitiveExpression$outboundSchema,
+} from "./customsensitiveexpression.js";
 import {
   SensitiveExpression,
   SensitiveExpression$inboundSchema,
@@ -24,17 +30,27 @@ import {
  */
 export type SensitiveContentOptions = {
   /**
-   * Predefined categories of terms to consider as sensitive content. See https://cloud.google.com/dlp/docs/infotypes-reference for available types.
+   * DEPRECATED - use 'customSensitiveExpressions' instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   sensitiveInfoTypes?: Array<SensitiveInfoType> | undefined;
   /**
-   * list of words and phrases to consider as sensitive content
+   * DEPRECATED - use 'customSensitiveExpressions' instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   sensitiveTerms?: Array<SensitiveExpression> | undefined;
   /**
-   * list of regular expressions to consider as sensitive content
+   * DEPRECATED - use 'customSensitiveExpressions' instead.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   sensitiveRegexes?: Array<SensitiveExpression> | undefined;
+  /**
+   * list of custom sensitive expressions to consider as sensitive content
+   */
+  customSensitiveExpressions?: Array<CustomSensitiveExpression> | undefined;
 };
 
 /** @internal */
@@ -46,12 +62,17 @@ export const SensitiveContentOptions$inboundSchema: z.ZodType<
   sensitiveInfoTypes: z.array(SensitiveInfoType$inboundSchema).optional(),
   sensitiveTerms: z.array(SensitiveExpression$inboundSchema).optional(),
   sensitiveRegexes: z.array(SensitiveExpression$inboundSchema).optional(),
+  customSensitiveExpressions: z.array(CustomSensitiveExpression$inboundSchema)
+    .optional(),
 });
 /** @internal */
 export type SensitiveContentOptions$Outbound = {
   sensitiveInfoTypes?: Array<SensitiveInfoType$Outbound> | undefined;
   sensitiveTerms?: Array<SensitiveExpression$Outbound> | undefined;
   sensitiveRegexes?: Array<SensitiveExpression$Outbound> | undefined;
+  customSensitiveExpressions?:
+    | Array<CustomSensitiveExpression$Outbound>
+    | undefined;
 };
 
 /** @internal */
@@ -63,6 +84,8 @@ export const SensitiveContentOptions$outboundSchema: z.ZodType<
   sensitiveInfoTypes: z.array(SensitiveInfoType$outboundSchema).optional(),
   sensitiveTerms: z.array(SensitiveExpression$outboundSchema).optional(),
   sensitiveRegexes: z.array(SensitiveExpression$outboundSchema).optional(),
+  customSensitiveExpressions: z.array(CustomSensitiveExpression$outboundSchema)
+    .optional(),
 });
 
 export function sensitiveContentOptionsToJSON(

package/src/models/components/sensitiveinfotype.ts

@@ -11,20 +11,25 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
  */
-export const LikelihoodThreshold = {
+export const SensitiveInfoTypeLikelihoodThreshold = {
   Likely: "LIKELY",
   VeryLikely: "VERY_LIKELY",
+  Possible: "POSSIBLE",
+  Unlikely: "UNLIKELY",
+  VeryUnlikely: "VERY_UNLIKELY",
 } as const;
 /**
  * @deprecated enum: This will be removed in a future release, please migrate away from it as soon as possible.
  */
-export type LikelihoodThreshold = ClosedEnum<typeof LikelihoodThreshold>;
+export type SensitiveInfoTypeLikelihoodThreshold = ClosedEnum<
+  typeof SensitiveInfoTypeLikelihoodThreshold
+>;
 
 export type SensitiveInfoType = {
   /**
    * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
-  likelihoodThreshold?: LikelihoodThreshold | undefined;
+  likelihoodThreshold?: SensitiveInfoTypeLikelihoodThreshold | undefined;
   /**
    * Text representation of an info-type to scan for.
    */
@@ -32,13 +37,14 @@ export type SensitiveInfoType = {
 };
 
 /** @internal */
-export const LikelihoodThreshold$inboundSchema: z.ZodNativeEnum<
-  typeof LikelihoodThreshold
-> = z.nativeEnum(LikelihoodThreshold);
+export const SensitiveInfoTypeLikelihoodThreshold$inboundSchema:
+  z.ZodNativeEnum<typeof SensitiveInfoTypeLikelihoodThreshold> = z.nativeEnum(
+    SensitiveInfoTypeLikelihoodThreshold,
+  );
 /** @internal */
-export const LikelihoodThreshold$outboundSchema: z.ZodNativeEnum<
-  typeof LikelihoodThreshold
-> = LikelihoodThreshold$inboundSchema;
+export const SensitiveInfoTypeLikelihoodThreshold$outboundSchema:
+  z.ZodNativeEnum<typeof SensitiveInfoTypeLikelihoodThreshold> =
+    SensitiveInfoTypeLikelihoodThreshold$inboundSchema;
 
 /** @internal */
 export const SensitiveInfoType$inboundSchema: z.ZodType<
@@ -46,7 +52,8 @@ export const SensitiveInfoType$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  likelihoodThreshold: LikelihoodThreshold$inboundSchema.optional(),
+  likelihoodThreshold: SensitiveInfoTypeLikelihoodThreshold$inboundSchema
+    .optional(),
   infoType: z.string().optional(),
 });
 /** @internal */
@@ -61,7 +68,8 @@ export const SensitiveInfoType$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SensitiveInfoType
 > = z.object({
-  likelihoodThreshold: LikelihoodThreshold$outboundSchema.optional(),
+  likelihoodThreshold: SensitiveInfoTypeLikelihoodThreshold$outboundSchema
+    .optional(),
   infoType: z.string().optional(),
 });
 

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,
+      ));
+    },
+  };
+}