@gleanwork/api-client 0.16.0 → 0.17.0

package/src/models/components/agentrun.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -21,7 +20,7 @@ export type AgentRun = {
   /**
    * The ID of the agent to run.
    */
-  agentId: string;
+  agent_id: string;
   /**
    * The input to the agent. Required when the agent uses an input form trigger.
    */
@@ -51,10 +50,6 @@ export const AgentRun$inboundSchema: z.ZodType<
   messages: z.array(Message$inboundSchema).optional(),
   metadata: z.record(z.any()).optional(),
   status: AgentExecutionStatus$inboundSchema.optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "agent_id": "agentId",
-  });
 });
 
 export function agentRunFromJSON(

package/src/models/components/agentruncreate.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import {
   Message,
   Message$Outbound,
@@ -18,7 +17,7 @@ export type AgentRunCreate = {
   /**
    * The ID of the agent to run.
    */
-  agentId: string;
+  agent_id: string;
   /**
    * The input to the agent. Required when the agent uses an input form trigger.
    */
@@ -47,14 +46,10 @@ export const AgentRunCreate$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   AgentRunCreate
 > = z.object({
-  agentId: z.string(),
+  agent_id: z.string(),
   input: z.record(z.any()).optional(),
   messages: z.array(Message$outboundSchema).optional(),
   metadata: z.record(z.any()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    agentId: "agent_id",
-  });
 });
 
 export function agentRunCreateToJSON(agentRunCreate: AgentRunCreate): string {

package/src/models/components/agentschemas.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -27,7 +26,7 @@ export type AgentSchemas = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
   /**
    * The name of the agent.
    */
@@ -35,11 +34,11 @@ export type AgentSchemas = {
   /**
    * The schema for the agent input. In JSON Schema format.
    */
-  inputSchema: InputSchema;
+  input_schema: InputSchema;
   /**
    * The schema for the agent output. In JSON Schema format.
    */
-  outputSchema: OutputSchema;
+  output_schema: OutputSchema;
   /**
    * List of tools that the agent can invoke. Only included when include_tools query parameter is set to true.
    */
@@ -91,12 +90,6 @@ export const AgentSchemas$inboundSchema: z.ZodType<
   input_schema: z.lazy(() => InputSchema$inboundSchema),
   output_schema: z.lazy(() => OutputSchema$inboundSchema),
   tools: z.array(ActionSummary$inboundSchema).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "agent_id": "agentId",
-    "input_schema": "inputSchema",
-    "output_schema": "outputSchema",
-  });
 });
 
 export function agentSchemasFromJSON(

package/src/models/components/authconfig.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
@@ -110,7 +109,7 @@ export type AuthConfig = {
   /**
    * The URL where users will be directed to start the OAuth flow.
    */
-  clientUrl?: string | undefined;
+  client_url?: string | undefined;
   /**
    * A list of strings denoting the different scopes or access levels required by the tool.
    */
@@ -122,7 +121,7 @@ export type AuthConfig = {
   /**
    * The OAuth provider's endpoint, where access tokens are requested.
    */
-  authorizationUrl?: string | undefined;
+  authorization_url?: string | undefined;
   /**
    * The OAuth 2.0 Resource Indicator (RFC 8707) for the protected resource. Discovered from Protected Resource Metadata (RFC 9728) during DCR. Included in authorization and token exchange requests when present.
    */
@@ -130,7 +129,7 @@ export type AuthConfig = {
   /**
    * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. client_secret_post sends credentials as form fields, client_secret_basic sends them via Authorization header, none omits client secret and relies on PKCE only. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
    */
-  tokenEndpointAuthMethod?: TokenEndpointAuthMethod | undefined;
+  token_endpoint_auth_method?: TokenEndpointAuthMethod | undefined;
   /**
    * The time the tool was last authorized in ISO format (ISO 8601).
    */
@@ -209,12 +208,6 @@ export const AuthConfig$inboundSchema: z.ZodType<
   lastAuthorizedAt: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    "client_url": "clientUrl",
-    "authorization_url": "authorizationUrl",
-    "token_endpoint_auth_method": "tokenEndpointAuthMethod",
-  });
 });
 /** @internal */
 export type AuthConfig$Outbound = {
@@ -243,19 +236,13 @@ export const AuthConfig$outboundSchema: z.ZodType<
   type: AuthConfigType$outboundSchema.optional(),
   grantType: GrantType$outboundSchema.optional(),
   status: AuthConfigStatus$outboundSchema.optional(),
-  clientUrl: z.string().optional(),
+  client_url: z.string().optional(),
   scopes: z.array(z.string()).optional(),
   audiences: z.array(z.string()).optional(),
-  authorizationUrl: z.string().optional(),
+  authorization_url: z.string().optional(),
   resource: z.string().optional(),
-  tokenEndpointAuthMethod: TokenEndpointAuthMethod$outboundSchema.optional(),
+  token_endpoint_auth_method: TokenEndpointAuthMethod$outboundSchema.optional(),
   lastAuthorizedAt: z.date().transform(v => v.toISOString()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    clientUrl: "client_url",
-    authorizationUrl: "authorization_url",
-    tokenEndpointAuthMethod: "token_endpoint_auth_method",
-  });
 });
 
 export function authConfigToJSON(authConfig: AuthConfig): string {

package/src/models/components/autocompleteresponse.ts

@@ -37,7 +37,7 @@ export type AutocompleteResponse = {
    * Subsections of the results list from which distinct sections should be created.
    */
   groups?: Array<AutocompleteResultGroup> | undefined;
-  gleanDataError?: GleanDataError | undefined;
+  GleanDataError?: GleanDataError | undefined;
   /**
    * Time in milliseconds the backend took to respond to the request.
    */
@@ -59,7 +59,7 @@ export const AutocompleteResponse$inboundSchema: z.ZodType<
   backendTimeMillis: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "errorInfo": "gleanDataError",
+    "errorInfo": "GleanDataError",
   });
 });
 

package/src/models/components/index.ts

@@ -340,6 +340,30 @@ export * from "./peruserassistantinsight.js";
 export * from "./peruserinsight.js";
 export * from "./pindocument.js";
 export * from "./pinrequest.js";
+export * from "./platformactionsummary.js";
+export * from "./platformagent.js";
+export * from "./platformagentcapabilities.js";
+export * from "./platformagentexecutionstatus.js";
+export * from "./platformagentgetresponse.js";
+export * from "./platformagentrun.js";
+export * from "./platformagentruncreaterequest.js";
+export * from "./platformagentrunwaitresponse.js";
+export * from "./platformagentschemasresponse.js";
+export * from "./platformagentssearchrequest.js";
+export * from "./platformagentssearchresponse.js";
+export * from "./platformcontenttype.js";
+export * from "./platformfilter.js";
+export * from "./platformfilteroperator.js";
+export * from "./platformmessage.js";
+export * from "./platformmessagerole.js";
+export * from "./platformmessagetextblock.js";
+export * from "./platformpersonreference.js";
+export * from "./platformproblemdetailcode.js";
+export * from "./platformproblemdetailerror.js";
+export * from "./platformresult.js";
+export * from "./platformsearchrequest.js";
+export * from "./platformsearchresponse.js";
+export * from "./platformtimerange.js";
 export * from "./possiblevalue.js";
 export * from "./processalldocumentsrequest.js";
 export * from "./processallmembershipsrequest.js";

package/src/models/components/platformactionsummary.ts

@@ -0,0 +1,65 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5ba86daff548
+ */
+
+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";
+
+export type PlatformActionSummary = {
+  /**
+   * Unique identifier of the action.
+   */
+  tool_id: string;
+  /**
+   * Display name of the action.
+   */
+  display_name: string;
+  /**
+   * Tool type.
+   */
+  type?: string | undefined;
+  /**
+   * Authentication type required by the action.
+   */
+  auth_type?: string | undefined;
+  /**
+   * Write-action execution type.
+   */
+  write_action_type?: string | undefined;
+  /**
+   * Whether this action has been fully configured.
+   */
+  is_setup_finished?: boolean | undefined;
+  /**
+   * Kind of knowledge the action accesses or modifies.
+   */
+  data_source?: string | undefined;
+};
+
+/** @internal */
+export const PlatformActionSummary$inboundSchema: z.ZodType<
+  PlatformActionSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  tool_id: z.string(),
+  display_name: z.string(),
+  type: z.string().optional(),
+  auth_type: z.string().optional(),
+  write_action_type: z.string().optional(),
+  is_setup_finished: z.boolean().optional(),
+  data_source: z.string().optional(),
+});
+
+export function platformActionSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformActionSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformActionSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformActionSummary' from JSON`,
+  );
+}

package/src/models/components/platformagent.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0573787fcf08
+ */
+
+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 {
+  PlatformAgentCapabilities,
+  PlatformAgentCapabilities$inboundSchema,
+} from "./platformagentcapabilities.js";
+
+export type PlatformAgent = {
+  /**
+   * ID of the agent.
+   */
+  agent_id: string;
+  /**
+   * Name of the agent.
+   */
+  name: string;
+  /**
+   * Description of the agent.
+   */
+  description?: string | undefined;
+  /**
+   * Agent metadata.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  capabilities: PlatformAgentCapabilities;
+};
+
+/** @internal */
+export const PlatformAgent$inboundSchema: z.ZodType<
+  PlatformAgent,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent_id: z.string(),
+  name: z.string(),
+  description: z.string().optional(),
+  metadata: z.record(z.any()).optional(),
+  capabilities: PlatformAgentCapabilities$inboundSchema,
+});
+
+export function platformAgentFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgent, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgent$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgent' from JSON`,
+  );
+}

package/src/models/components/platformagentcapabilities.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: daefec738f28
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PlatformAgentCapabilities = {
+  /**
+   * Whether the agent supports messages as input.
+   */
+  "ap.io.messages"?: boolean | undefined;
+  /**
+   * Whether the agent supports streaming output.
+   */
+  "ap.io.streaming"?: boolean | undefined;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PlatformAgentCapabilities$inboundSchema: z.ZodType<
+  PlatformAgentCapabilities,
+  z.ZodTypeDef,
+  unknown
+> = collectExtraKeys$(
+  z.object({
+    "ap.io.messages": z.boolean().optional(),
+    "ap.io.streaming": z.boolean().optional(),
+  }).catchall(z.any()),
+  "additionalProperties",
+  true,
+).transform((v) => {
+  return remap$(v, {
+    "ap.io.messages": "ap.io.messages",
+    "ap.io.streaming": "ap.io.streaming",
+  });
+});
+
+export function platformAgentCapabilitiesFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentCapabilities, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentCapabilities$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentCapabilities' from JSON`,
+  );
+}

package/src/models/components/platformagentexecutionstatus.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2d23bf28f1e8
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Status of the agent run.
+ */
+export const PlatformAgentExecutionStatus = {
+  Error: "error",
+  Success: "success",
+} as const;
+/**
+ * Status of the agent run.
+ */
+export type PlatformAgentExecutionStatus = OpenEnum<
+  typeof PlatformAgentExecutionStatus
+>;
+
+/** @internal */
+export const PlatformAgentExecutionStatus$inboundSchema: z.ZodType<
+  PlatformAgentExecutionStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformAgentExecutionStatus);

package/src/models/components/platformagentgetresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e38387a46922
+ */
+
+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 { PlatformAgent, PlatformAgent$inboundSchema } from "./platformagent.js";
+
+export type PlatformAgentGetResponse = {
+  agent: PlatformAgent;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformAgentGetResponse$inboundSchema: z.ZodType<
+  PlatformAgentGetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent: PlatformAgent$inboundSchema,
+  request_id: z.string(),
+});
+
+export function platformAgentGetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentGetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentGetResponse' from JSON`,
+  );
+}

package/src/models/components/platformagentrun.ts

@@ -0,0 +1,63 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b60e7899d3b0
+ */
+
+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 {
+  PlatformAgentExecutionStatus,
+  PlatformAgentExecutionStatus$inboundSchema,
+} from "./platformagentexecutionstatus.js";
+import {
+  PlatformMessage,
+  PlatformMessage$inboundSchema,
+} from "./platformmessage.js";
+
+export type PlatformAgentRun = {
+  /**
+   * ID of the agent being run.
+   */
+  agent_id: string;
+  /**
+   * Input fields for an input-form triggered agent.
+   */
+  input?: { [k: string]: any } | undefined;
+  /**
+   * Messages passed to the agent.
+   */
+  messages?: Array<PlatformMessage> | undefined;
+  /**
+   * Metadata passed to the agent.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Status of the agent run.
+   */
+  status: PlatformAgentExecutionStatus;
+};
+
+/** @internal */
+export const PlatformAgentRun$inboundSchema: z.ZodType<
+  PlatformAgentRun,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  agent_id: z.string(),
+  input: z.record(z.any()).optional(),
+  messages: z.array(PlatformMessage$inboundSchema).optional(),
+  metadata: z.record(z.any()).optional(),
+  status: PlatformAgentExecutionStatus$inboundSchema,
+});
+
+export function platformAgentRunFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentRun, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentRun$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentRun' from JSON`,
+  );
+}

package/src/models/components/platformagentruncreaterequest.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0aaec5605e0b
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformMessage,
+  PlatformMessage$Outbound,
+  PlatformMessage$outboundSchema,
+} from "./platformmessage.js";
+
+/**
+ * Request to run an agent. A request MUST supply either `messages` (a non-empty conversation) or `input` (for input-form triggered agents).
+ *
+ * @remarks
+ */
+export type PlatformAgentRunCreateRequest = {
+  /**
+   * Input fields for an input-form triggered agent.
+   */
+  input?: { [k: string]: any } | undefined;
+  /**
+   * Messages to pass to the agent. When provided, the array MUST contain at least one message and each message MUST specify a valid `role` and non-empty `content`.
+   *
+   * @remarks
+   */
+  messages?: Array<PlatformMessage> | undefined;
+  /**
+   * Metadata to pass to the agent.
+   */
+  metadata?: { [k: string]: any } | undefined;
+  /**
+   * Whether to stream the run response as server-sent events.
+   */
+  stream?: boolean | undefined;
+};
+
+/** @internal */
+export type PlatformAgentRunCreateRequest$Outbound = {
+  input?: { [k: string]: any } | undefined;
+  messages?: Array<PlatformMessage$Outbound> | undefined;
+  metadata?: { [k: string]: any } | undefined;
+  stream: boolean;
+};
+
+/** @internal */
+export const PlatformAgentRunCreateRequest$outboundSchema: z.ZodType<
+  PlatformAgentRunCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentRunCreateRequest
+> = z.object({
+  input: z.record(z.any()).optional(),
+  messages: z.array(PlatformMessage$outboundSchema).optional(),
+  metadata: z.record(z.any()).optional(),
+  stream: z.boolean().default(false),
+});
+
+export function platformAgentRunCreateRequestToJSON(
+  platformAgentRunCreateRequest: PlatformAgentRunCreateRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentRunCreateRequest$outboundSchema.parse(
+      platformAgentRunCreateRequest,
+    ),
+  );
+}

package/src/models/components/platformagentrunwaitresponse.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 123f244b0399
+ */
+
+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 {
+  PlatformAgentRun,
+  PlatformAgentRun$inboundSchema,
+} from "./platformagentrun.js";
+import {
+  PlatformMessage,
+  PlatformMessage$inboundSchema,
+} from "./platformmessage.js";
+
+export type PlatformAgentRunWaitResponse = {
+  run?: PlatformAgentRun | undefined;
+  /**
+   * Messages returned by the completed run.
+   */
+  messages?: Array<PlatformMessage> | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformAgentRunWaitResponse$inboundSchema: z.ZodType<
+  PlatformAgentRunWaitResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  run: PlatformAgentRun$inboundSchema.optional(),
+  messages: z.array(PlatformMessage$inboundSchema).optional(),
+  request_id: z.string(),
+});
+
+export function platformAgentRunWaitResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentRunWaitResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentRunWaitResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentRunWaitResponse' from JSON`,
+  );
+}