@gleanwork/api-client 0.10.3 → 0.10.5

package/src/models/components/insightsoverviewrequest.ts

@@ -0,0 +1,79 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Period,
+  Period$inboundSchema,
+  Period$Outbound,
+  Period$outboundSchema,
+} from "./period.js";
+
+export type InsightsOverviewRequest = {
+  /**
+   * Departments for which Insights are requested.
+   */
+  departments?: Array<string> | undefined;
+  dayRange?: Period | undefined;
+};
+
+/** @internal */
+export const InsightsOverviewRequest$inboundSchema: z.ZodType<
+  InsightsOverviewRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  departments: z.array(z.string()).optional(),
+  dayRange: Period$inboundSchema.optional(),
+});
+
+/** @internal */
+export type InsightsOverviewRequest$Outbound = {
+  departments?: Array<string> | undefined;
+  dayRange?: Period$Outbound | undefined;
+};
+
+/** @internal */
+export const InsightsOverviewRequest$outboundSchema: z.ZodType<
+  InsightsOverviewRequest$Outbound,
+  z.ZodTypeDef,
+  InsightsOverviewRequest
+> = z.object({
+  departments: z.array(z.string()).optional(),
+  dayRange: Period$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InsightsOverviewRequest$ {
+  /** @deprecated use `InsightsOverviewRequest$inboundSchema` instead. */
+  export const inboundSchema = InsightsOverviewRequest$inboundSchema;
+  /** @deprecated use `InsightsOverviewRequest$outboundSchema` instead. */
+  export const outboundSchema = InsightsOverviewRequest$outboundSchema;
+  /** @deprecated use `InsightsOverviewRequest$Outbound` instead. */
+  export type Outbound = InsightsOverviewRequest$Outbound;
+}
+
+export function insightsOverviewRequestToJSON(
+  insightsOverviewRequest: InsightsOverviewRequest,
+): string {
+  return JSON.stringify(
+    InsightsOverviewRequest$outboundSchema.parse(insightsOverviewRequest),
+  );
+}
+
+export function insightsOverviewRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<InsightsOverviewRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InsightsOverviewRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InsightsOverviewRequest' from JSON`,
+  );
+}

package/src/models/components/insightsrequest.ts

@@ -7,6 +7,12 @@ 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 {
+  AgentsInsightsV2Request,
+  AgentsInsightsV2Request$inboundSchema,
+  AgentsInsightsV2Request$Outbound,
+  AgentsInsightsV2Request$outboundSchema,
+} from "./agentsinsightsv2request.js";
 import {
   InsightsAgentsRequestOptions,
   InsightsAgentsRequestOptions$inboundSchema,
@@ -19,6 +25,18 @@ import {
   InsightsAiAppRequestOptions$Outbound,
   InsightsAiAppRequestOptions$outboundSchema,
 } from "./insightsaiapprequestoptions.js";
+import {
+  InsightsAssistantRequest,
+  InsightsAssistantRequest$inboundSchema,
+  InsightsAssistantRequest$Outbound,
+  InsightsAssistantRequest$outboundSchema,
+} from "./insightsassistantrequest.js";
+import {
+  InsightsOverviewRequest,
+  InsightsOverviewRequest$inboundSchema,
+  InsightsOverviewRequest$Outbound,
+  InsightsOverviewRequest$outboundSchema,
+} from "./insightsoverviewrequest.js";
 import {
   Period,
   Period$inboundSchema,
@@ -28,6 +46,9 @@ import {
 
 export const InsightsRequestCategory = {
   Agents: "AGENTS",
+  AgentUsers: "AGENT_USERS",
+  TopAgents: "TOP_AGENTS",
+  AgentsUsageByDepartment: "AGENTS_USAGE_BY_DEPARTMENT",
   Ai: "AI",
   AiApps: "AI_APPS",
   Announcements: "ANNOUNCEMENTS",
@@ -52,12 +73,23 @@ export const AssistantActivityType = {
 export type AssistantActivityType = ClosedEnum<typeof AssistantActivityType>;
 
 export type InsightsRequest = {
+  overviewRequest?: InsightsOverviewRequest | undefined;
+  assistantRequest?: InsightsAssistantRequest | undefined;
+  agentsRequest?: AgentsInsightsV2Request | undefined;
+  /**
+   * If true, suppresses the generation of per-user Insights in the response. Default is false.
+   */
+  disablePerUserInsights?: boolean | undefined;
   /**
    * Categories of data requested. Request can include single or multiple types.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
-  categories: Array<InsightsRequestCategory>;
+  categories?: Array<InsightsRequestCategory> | undefined;
   /**
    * Departments that the data is requested for. If this is empty, corresponds to whole company.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   departments?: Array<string> | undefined;
   dayRange?: Period | undefined;
@@ -65,12 +97,10 @@ export type InsightsRequest = {
   agentsRequestOptions?: InsightsAgentsRequestOptions | undefined;
   /**
    * Types of activity that should count in the definition of an Assistant Active User. Affects only insights for AI category.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   assistantActivityTypes?: Array<AssistantActivityType> | undefined;
-  /**
-   * If true, suppresses the generation of per-user Insights in the response. Default is false.
-   */
-  disablePerUserInsights?: boolean | undefined;
 };
 
 /** @internal */
@@ -121,25 +151,31 @@ export const InsightsRequest$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  categories: z.array(InsightsRequestCategory$inboundSchema),
+  overviewRequest: InsightsOverviewRequest$inboundSchema.optional(),
+  assistantRequest: InsightsAssistantRequest$inboundSchema.optional(),
+  agentsRequest: AgentsInsightsV2Request$inboundSchema.optional(),
+  disablePerUserInsights: z.boolean().optional(),
+  categories: z.array(InsightsRequestCategory$inboundSchema).optional(),
   departments: z.array(z.string()).optional(),
   dayRange: Period$inboundSchema.optional(),
   aiAppRequestOptions: InsightsAiAppRequestOptions$inboundSchema.optional(),
   agentsRequestOptions: InsightsAgentsRequestOptions$inboundSchema.optional(),
   assistantActivityTypes: z.array(AssistantActivityType$inboundSchema)
     .optional(),
-  disablePerUserInsights: z.boolean().optional(),
 });
 
 /** @internal */
 export type InsightsRequest$Outbound = {
-  categories: Array<string>;
+  overviewRequest?: InsightsOverviewRequest$Outbound | undefined;
+  assistantRequest?: InsightsAssistantRequest$Outbound | undefined;
+  agentsRequest?: AgentsInsightsV2Request$Outbound | undefined;
+  disablePerUserInsights?: boolean | undefined;
+  categories?: Array<string> | undefined;
   departments?: Array<string> | undefined;
   dayRange?: Period$Outbound | undefined;
   aiAppRequestOptions?: InsightsAiAppRequestOptions$Outbound | undefined;
   agentsRequestOptions?: InsightsAgentsRequestOptions$Outbound | undefined;
   assistantActivityTypes?: Array<string> | undefined;
-  disablePerUserInsights?: boolean | undefined;
 };
 
 /** @internal */
@@ -148,14 +184,17 @@ export const InsightsRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   InsightsRequest
 > = z.object({
-  categories: z.array(InsightsRequestCategory$outboundSchema),
+  overviewRequest: InsightsOverviewRequest$outboundSchema.optional(),
+  assistantRequest: InsightsAssistantRequest$outboundSchema.optional(),
+  agentsRequest: AgentsInsightsV2Request$outboundSchema.optional(),
+  disablePerUserInsights: z.boolean().optional(),
+  categories: z.array(InsightsRequestCategory$outboundSchema).optional(),
   departments: z.array(z.string()).optional(),
   dayRange: Period$outboundSchema.optional(),
   aiAppRequestOptions: InsightsAiAppRequestOptions$outboundSchema.optional(),
   agentsRequestOptions: InsightsAgentsRequestOptions$outboundSchema.optional(),
   assistantActivityTypes: z.array(AssistantActivityType$outboundSchema)
     .optional(),
-  disablePerUserInsights: z.boolean().optional(),
 });
 
 /**

package/src/react-query/clientInsightsRetrieve.ts

@@ -24,10 +24,10 @@ export type ClientInsightsRetrieveMutationVariables = {
 export type ClientInsightsRetrieveMutationData = components.InsightsResponse;
 
 /**
- * Read insights
+ * Get insights
  *
  * @remarks
- * Reads the aggregate information for each user, query, and content.
+ * Gets the aggregate usage insights data displayed in the Insights Dashboards.
  */
 export function useClientInsightsRetrieveMutation(
   options?: MutationHookOptions<

package/src/sdk/insights.ts

@@ -9,10 +9,10 @@ import { unwrapAsync } from "../types/fp.js";
 
 export class Insights extends ClientSDK {
   /**
-   * Read insights
+   * Get insights
    *
    * @remarks
-   * Reads the aggregate information for each user, query, and content.
+   * Gets the aggregate usage insights data displayed in the Insights Dashboards.
    */
   async retrieve(
     request: components.InsightsRequest,