@gleanwork/api-client 0.4.3 → 0.5.1

package/dist/esm/react-query/clientGovernanceDocumentsVisibilityoverridesList.js

@@ -7,7 +7,7 @@ import { combineSignals } from "../lib/primitives.js";
 import { unwrapAsync } from "../types/fp.js";
 import { useGleanContext } from "./_context.js";
 /**
- * Fetches documents visibility.
+ * Fetches documents visibility
  *
  * @remarks
  * Fetches the visibility override status of the documents passed.
@@ -20,7 +20,7 @@ export function useClientGovernanceDocumentsVisibilityoverridesList(docIds, opti
     });
 }
 /**
- * Fetches documents visibility.
+ * Fetches documents visibility
  *
  * @remarks
  * Fetches the visibility override status of the documents passed.

package/dist/esm/sdk/policies.d.ts

@@ -2,35 +2,35 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 export declare class Policies extends ClientSDK {
     /**
-     * Gets specified Policy.
+     * Gets specified policy
      *
      * @remarks
      * Fetches the specified policy version, or the latest if no version is provided.
      */
     retrieve(id: string, version?: number | undefined, options?: RequestOptions): Promise<components.GetDlpReportResponse>;
     /**
-     * Updates an existing policy.
+     * Updates an existing policy
      *
      * @remarks
      * Updates an existing policy.
      */
     update(updateDlpReportRequest: components.UpdateDlpReportRequest, id: string, options?: RequestOptions): Promise<components.UpdateDlpReportResponse>;
     /**
-     * Lists policies.
+     * Lists policies
      *
      * @remarks
      * Lists policies with filtering.
      */
     list(autoHide?: boolean | undefined, frequency?: string | undefined, options?: RequestOptions): Promise<components.ListDlpReportsResponse>;
     /**
-     * Creates new policy.
+     * Creates new policy
      *
      * @remarks
      * Creates a new policy with specified specifications and returns its id.
      */
     create(request: components.CreateDlpReportRequest, options?: RequestOptions): Promise<components.CreateDlpReportResponse>;
     /**
-     * Downloads violations CSV for policy.
+     * Downloads violations CSV for policy
      *
      * @remarks
      * Downloads CSV violations report for a specific policy id. This does not support continuous policies.

package/dist/esm/sdk/policies.js

@@ -10,7 +10,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 export class Policies extends ClientSDK {
     /**
-     * Gets specified Policy.
+     * Gets specified policy
      *
      * @remarks
      * Fetches the specified policy version, or the latest if no version is provided.
@@ -19,7 +19,7 @@ export class Policies extends ClientSDK {
         return unwrapAsync(clientGovernanceDataPoliciesRetrieve(this, id, version, options));
     }
     /**
-     * Updates an existing policy.
+     * Updates an existing policy
      *
      * @remarks
      * Updates an existing policy.
@@ -28,7 +28,7 @@ export class Policies extends ClientSDK {
         return unwrapAsync(clientGovernanceDataPoliciesUpdate(this, updateDlpReportRequest, id, options));
     }
     /**
-     * Lists policies.
+     * Lists policies
      *
      * @remarks
      * Lists policies with filtering.
@@ -37,7 +37,7 @@ export class Policies extends ClientSDK {
         return unwrapAsync(clientGovernanceDataPoliciesList(this, autoHide, frequency, options));
     }
     /**
-     * Creates new policy.
+     * Creates new policy
      *
      * @remarks
      * Creates a new policy with specified specifications and returns its id.
@@ -46,7 +46,7 @@ export class Policies extends ClientSDK {
         return unwrapAsync(clientGovernanceDataPoliciesCreate(this, request, options));
     }
     /**
-     * Downloads violations CSV for policy.
+     * Downloads violations CSV for policy
      *
      * @remarks
      * Downloads CSV violations report for a specific policy id. This does not support continuous policies.

package/dist/esm/sdk/reports.d.ts

@@ -2,21 +2,21 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 export declare class Reports extends ClientSDK {
     /**
-     * Creates new one-time report.
+     * Creates new one-time report
      *
      * @remarks
      * Creates a new one-time report and executes its batch job.
      */
     create(request: components.UpdateDlpConfigRequest, options?: RequestOptions): Promise<components.UpdateDlpConfigResponse>;
     /**
-     * Downloads violations CSV for report.
+     * Downloads violations CSV for report
      *
      * @remarks
      * Downloads CSV violations report for a specific report id.
      */
     download(id: string, options?: RequestOptions): Promise<string>;
     /**
-     * Fetches report run status.
+     * Fetches report run status
      *
      * @remarks
      * Fetches the status of the run corresponding to the report-id.

package/dist/esm/sdk/reports.js

@@ -8,7 +8,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 export class Reports extends ClientSDK {
     /**
-     * Creates new one-time report.
+     * Creates new one-time report
      *
      * @remarks
      * Creates a new one-time report and executes its batch job.
@@ -17,7 +17,7 @@ export class Reports extends ClientSDK {
         return unwrapAsync(clientGovernanceDataReportsCreate(this, request, options));
     }
     /**
-     * Downloads violations CSV for report.
+     * Downloads violations CSV for report
      *
      * @remarks
      * Downloads CSV violations report for a specific report id.
@@ -26,7 +26,7 @@ export class Reports extends ClientSDK {
         return unwrapAsync(clientGovernanceDataReportsDownload(this, id, options));
     }
     /**
-     * Fetches report run status.
+     * Fetches report run status
      *
      * @remarks
      * Fetches the status of the run corresponding to the report-id.

package/dist/esm/sdk/visibilityoverrides.d.ts

@@ -2,14 +2,14 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
 export declare class Visibilityoverrides extends ClientSDK {
     /**
-     * Fetches documents visibility.
+     * Fetches documents visibility
      *
      * @remarks
      * Fetches the visibility override status of the documents passed.
      */
     list(docIds?: Array<string> | undefined, options?: RequestOptions): Promise<components.GetDocumentVisibilityOverridesResponse>;
     /**
-     * Hide/Un-hide docs.
+     * Hide or unhide docs
      *
      * @remarks
      * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.

package/dist/esm/sdk/visibilityoverrides.js

@@ -7,7 +7,7 @@ import { ClientSDK } from "../lib/sdks.js";
 import { unwrapAsync } from "../types/fp.js";
 export class Visibilityoverrides extends ClientSDK {
     /**
-     * Fetches documents visibility.
+     * Fetches documents visibility
      *
      * @remarks
      * Fetches the visibility override status of the documents passed.
@@ -16,7 +16,7 @@ export class Visibilityoverrides extends ClientSDK {
         return unwrapAsync(clientGovernanceDocumentsVisibilityoverridesList(this, docIds, options));
     }
     /**
-     * Hide/Un-hide docs.
+     * Hide or unhide docs
      *
      * @remarks
      * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.

package/docs/sdks/agents/README.md

@@ -316,7 +316,9 @@ const glean = new Glean({
 });
 
 async function run() {
-  const result = await glean.client.agents.runStream({});
+  const result = await glean.client.agents.runStream({
+    agentId: "<id>",
+  });
 
   // Handle the result
   console.log(result);
@@ -340,7 +342,9 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientAgentsRunStream(glean, {});
+  const res = await clientAgentsRunStream(glean, {
+    agentId: "<id>",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -405,7 +409,9 @@ const glean = new Glean({
 });
 
 async function run() {
-  const result = await glean.client.agents.run({});
+  const result = await glean.client.agents.run({
+    agentId: "<id>",
+  });
 
   // Handle the result
   console.log(result);
@@ -429,7 +435,9 @@ const glean = new GleanCore({
 });
 
 async function run() {
-  const res = await clientAgentsRun(glean, {});
+  const res = await clientAgentsRun(glean, {
+    agentId: "<id>",
+  });
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/policies/README.md

@@ -5,11 +5,11 @@
 
 ### Available Operations
 
-* [retrieve](#retrieve) - Gets specified Policy.
-* [update](#update) - Updates an existing policy.
-* [list](#list) - Lists policies.
-* [create](#create) - Creates new policy.
-* [download](#download) - Downloads violations CSV for policy.
+* [retrieve](#retrieve) - Gets specified policy
+* [update](#update) - Updates an existing policy
+* [list](#list) - Lists policies
+* [create](#create) - Creates new policy
+* [download](#download) - Downloads violations CSV for policy
 
 ## retrieve
 

package/docs/sdks/reports/README.md

@@ -5,9 +5,9 @@
 
 ### Available Operations
 
-* [create](#create) - Creates new one-time report.
-* [download](#download) - Downloads violations CSV for report.
-* [status](#status) - Fetches report run status.
+* [create](#create) - Creates new one-time report
+* [download](#download) - Downloads violations CSV for report
+* [status](#status) - Fetches report run status
 
 ## create
 

package/docs/sdks/visibilityoverrides/README.md

@@ -5,8 +5,8 @@
 
 ### Available Operations
 
-* [list](#list) - Fetches documents visibility.
-* [create](#create) - Hide/Un-hide docs.
+* [list](#list) - Fetches documents visibility
+* [create](#create) - Hide or unhide docs
 
 ## list
 

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.4.3",
+  "version": "0.5.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.4.3",
+  "version": "0.5.1",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/__tests__/agents.test.ts

@@ -78,6 +78,8 @@ test("Agents Create And Wait Run", async () => {
     apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
   });
 
-  const result = await glean.client.agents.run({});
+  const result = await glean.client.agents.run({
+    agentId: "<id>",
+  });
   expect(result).toBeDefined();
 });

package/src/funcs/clientGovernanceDataPoliciesCreate.ts

@@ -24,7 +24,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Creates new policy.
+ * Creates new policy
  *
  * @remarks
  * Creates a new policy with specified specifications and returns its id.

package/src/funcs/clientGovernanceDataPoliciesDownload.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Downloads violations CSV for policy.
+ * Downloads violations CSV for policy
  *
  * @remarks
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.

package/src/funcs/clientGovernanceDataPoliciesList.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Lists policies.
+ * Lists policies
  *
  * @remarks
  * Lists policies with filtering.

package/src/funcs/clientGovernanceDataPoliciesRetrieve.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Gets specified Policy.
+ * Gets specified policy
  *
  * @remarks
  * Fetches the specified policy version, or the latest if no version is provided.

package/src/funcs/clientGovernanceDataPoliciesUpdate.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Updates an existing policy.
+ * Updates an existing policy
  *
  * @remarks
  * Updates an existing policy.

package/src/funcs/clientGovernanceDataReportsCreate.ts

@@ -24,7 +24,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Creates new one-time report.
+ * Creates new one-time report
  *
  * @remarks
  * Creates a new one-time report and executes its batch job.

package/src/funcs/clientGovernanceDataReportsDownload.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Downloads violations CSV for report.
+ * Downloads violations CSV for report
  *
  * @remarks
  * Downloads CSV violations report for a specific report id.

package/src/funcs/clientGovernanceDataReportsStatus.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Fetches report run status.
+ * Fetches report run status
  *
  * @remarks
  * Fetches the status of the run corresponding to the report-id.

package/src/funcs/clientGovernanceDocumentsVisibilityoverridesCreate.ts

@@ -24,7 +24,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Hide/Un-hide docs.
+ * Hide or unhide docs
  *
  * @remarks
  * Sets the visibility-override state of the documents specified, effectively hiding or un-hiding documents.

package/src/funcs/clientGovernanceDocumentsVisibilityoverridesList.ts

@@ -25,7 +25,7 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Fetches documents visibility.
+ * Fetches documents visibility
  *
  * @remarks
  * Fetches the visibility override status of the documents passed.

package/src/lib/config.ts

@@ -64,8 +64,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.4.3",
+  sdkVersion: "0.5.1",
   genVersion: "2.610.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.4.3 2.610.0 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.5.1 2.610.0 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/agentrun.ts

@@ -26,7 +26,7 @@ export type AgentRun = {
   /**
    * The ID of the agent to run.
    */
-  agentId?: string | undefined;
+  agentId: string;
   /**
    * The input to the agent.
    */
@@ -47,7 +47,7 @@ export const AgentRun$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  agent_id: z.string().optional(),
+  agent_id: z.string(),
   input: z.record(z.any()).optional(),
   messages: z.array(Message$inboundSchema).optional(),
   status: AgentExecutionStatus$inboundSchema.optional(),
@@ -59,7 +59,7 @@ export const AgentRun$inboundSchema: z.ZodType<
 
 /** @internal */
 export type AgentRun$Outbound = {
-  agent_id?: string | undefined;
+  agent_id: string;
   input?: { [k: string]: any } | undefined;
   messages?: Array<Message$Outbound> | undefined;
   status?: string | undefined;
@@ -71,7 +71,7 @@ export const AgentRun$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AgentRun
 > = z.object({
-  agentId: z.string().optional(),
+  agentId: z.string(),
   input: z.record(z.any()).optional(),
   messages: z.array(Message$outboundSchema).optional(),
   status: AgentExecutionStatus$outboundSchema.optional(),

package/src/models/components/agentruncreate.ts

@@ -21,7 +21,7 @@ export type AgentRunCreate = {
   /**
    * The ID of the agent to run.
    */
-  agentId?: string | undefined;
+  agentId: string;
   /**
    * The input to the agent.
    */
@@ -38,7 +38,7 @@ export const AgentRunCreate$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  agent_id: z.string().optional(),
+  agent_id: z.string(),
   input: z.record(z.any()).optional(),
   messages: z.array(Message$inboundSchema).optional(),
 }).transform((v) => {
@@ -49,7 +49,7 @@ export const AgentRunCreate$inboundSchema: z.ZodType<
 
 /** @internal */
 export type AgentRunCreate$Outbound = {
-  agent_id?: string | undefined;
+  agent_id: string;
   input?: { [k: string]: any } | undefined;
   messages?: Array<Message$Outbound> | undefined;
 };
@@ -60,7 +60,7 @@ export const AgentRunCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AgentRunCreate
 > = z.object({
-  agentId: z.string().optional(),
+  agentId: z.string(),
   input: z.record(z.any()).optional(),
   messages: z.array(Message$outboundSchema).optional(),
 }).transform((v) => {

package/src/models/components/chatrequest.ts

@@ -24,6 +24,12 @@ import {
   ChatRestrictionFilters$Outbound,
   ChatRestrictionFilters$outboundSchema,
 } from "./chatrestrictionfilters.js";
+import {
+  SessionInfo,
+  SessionInfo$inboundSchema,
+  SessionInfo$Outbound,
+  SessionInfo$outboundSchema,
+} from "./sessioninfo.js";
 
 export type ChatRequest = {
   /**
@@ -48,6 +54,7 @@ export type ChatRequest = {
    * Timeout in milliseconds for the request. A `408` error will be returned if handling the request takes longer.
    */
   timeoutMillis?: number | undefined;
+  sessionInfo?: SessionInfo | undefined;
   /**
    * The ID of the application this request originates from, used to determine the configuration of underlying chat processes. This should correspond to the ID set during admin setup. If not specified, the default chat experience will be used.
    */
@@ -71,6 +78,7 @@ export const ChatRequest$inboundSchema: z.ZodType<
   inclusions: ChatRestrictionFilters$inboundSchema.optional(),
   exclusions: ChatRestrictionFilters$inboundSchema.optional(),
   timeoutMillis: z.number().int().optional(),
+  sessionInfo: SessionInfo$inboundSchema.optional(),
   applicationId: z.string().optional(),
   stream: z.boolean().optional(),
 });
@@ -84,6 +92,7 @@ export type ChatRequest$Outbound = {
   inclusions?: ChatRestrictionFilters$Outbound | undefined;
   exclusions?: ChatRestrictionFilters$Outbound | undefined;
   timeoutMillis?: number | undefined;
+  sessionInfo?: SessionInfo$Outbound | undefined;
   applicationId?: string | undefined;
   stream?: boolean | undefined;
 };
@@ -101,6 +110,7 @@ export const ChatRequest$outboundSchema: z.ZodType<
   inclusions: ChatRestrictionFilters$outboundSchema.optional(),
   exclusions: ChatRestrictionFilters$outboundSchema.optional(),
   timeoutMillis: z.number().int().optional(),
+  sessionInfo: SessionInfo$outboundSchema.optional(),
   applicationId: z.string().optional(),
   stream: z.boolean().optional(),
 });

package/src/models/components/textrange.ts

@@ -17,6 +17,7 @@ import {
 export const TextRangeType = {
   Bold: "BOLD",
   Citation: "CITATION",
+  Highlight: "HIGHLIGHT",
   Link: "LINK",
 } as const;
 export type TextRangeType = ClosedEnum<typeof TextRangeType>;

package/src/react-query/clientGovernanceDataPoliciesCreate.ts

@@ -25,7 +25,7 @@ export type ClientGovernanceDataPoliciesCreateMutationData =
   components.CreateDlpReportResponse;
 
 /**
- * Creates new policy.
+ * Creates new policy
  *
  * @remarks
  * Creates a new policy with specified specifications and returns its id.

package/src/react-query/clientGovernanceDataPoliciesDownload.ts

@@ -27,7 +27,7 @@ import {
 export type ClientGovernanceDataPoliciesDownloadQueryData = string;
 
 /**
- * Downloads violations CSV for policy.
+ * Downloads violations CSV for policy
  *
  * @remarks
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.
@@ -48,7 +48,7 @@ export function useClientGovernanceDataPoliciesDownload(
 }
 
 /**
- * Downloads violations CSV for policy.
+ * Downloads violations CSV for policy
  *
  * @remarks
  * Downloads CSV violations report for a specific policy id. This does not support continuous policies.

package/src/react-query/clientGovernanceDataPoliciesList.ts

@@ -29,7 +29,7 @@ export type ClientGovernanceDataPoliciesListQueryData =
   components.ListDlpReportsResponse;
 
 /**
- * Lists policies.
+ * Lists policies
  *
  * @remarks
  * Lists policies with filtering.
@@ -52,7 +52,7 @@ export function useClientGovernanceDataPoliciesList(
 }
 
 /**
- * Lists policies.
+ * Lists policies
  *
  * @remarks
  * Lists policies with filtering.

package/src/react-query/clientGovernanceDataPoliciesRetrieve.ts

@@ -29,7 +29,7 @@ export type ClientGovernanceDataPoliciesRetrieveQueryData =
   components.GetDlpReportResponse;
 
 /**
- * Gets specified Policy.
+ * Gets specified policy
  *
  * @remarks
  * Fetches the specified policy version, or the latest if no version is provided.
@@ -52,7 +52,7 @@ export function useClientGovernanceDataPoliciesRetrieve(
 }
 
 /**
- * Gets specified Policy.
+ * Gets specified policy
  *
  * @remarks
  * Fetches the specified policy version, or the latest if no version is provided.

package/src/react-query/clientGovernanceDataPoliciesUpdate.ts

@@ -26,7 +26,7 @@ export type ClientGovernanceDataPoliciesUpdateMutationData =
   components.UpdateDlpReportResponse;
 
 /**
- * Updates an existing policy.
+ * Updates an existing policy
  *
  * @remarks
  * Updates an existing policy.

package/src/react-query/clientGovernanceDataReportsCreate.ts

@@ -25,7 +25,7 @@ export type ClientGovernanceDataReportsCreateMutationData =
   components.UpdateDlpConfigResponse;
 
 /**
- * Creates new one-time report.
+ * Creates new one-time report
  *
  * @remarks
  * Creates a new one-time report and executes its batch job.

package/src/react-query/clientGovernanceDataReportsDownload.ts

@@ -27,7 +27,7 @@ import {
 export type ClientGovernanceDataReportsDownloadQueryData = string;
 
 /**
- * Downloads violations CSV for report.
+ * Downloads violations CSV for report
  *
  * @remarks
  * Downloads CSV violations report for a specific report id.
@@ -48,7 +48,7 @@ export function useClientGovernanceDataReportsDownload(
 }
 
 /**
- * Downloads violations CSV for report.
+ * Downloads violations CSV for report
  *
  * @remarks
  * Downloads CSV violations report for a specific report id.