@gleanwork/api-client 0.16.1 → 0.17.0

package/src/models/components/platformsearchrequest.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 649980857a72
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformFilter,
+  PlatformFilter$Outbound,
+  PlatformFilter$outboundSchema,
+} from "./platformfilter.js";
+import {
+  PlatformTimeRange,
+  PlatformTimeRange$Outbound,
+  PlatformTimeRange$outboundSchema,
+} from "./platformtimerange.js";
+
+export type PlatformSearchRequest = {
+  /**
+   * The search query string. Supports inline operators such as `from:jane type:document app:confluence`. Inline operators are AND'd with structured `filters`.
+   *
+   * @remarks
+   */
+  query: string;
+  /**
+   * Number of results to return per page.
+   */
+  page_size?: number | undefined;
+  /**
+   * Opaque pagination token from a previous response's `next_cursor` field. Omit on the first request.
+   *
+   * @remarks
+   */
+  cursor?: string | null | undefined;
+  /**
+   * Restrict results to specific datasources. Requests must not specify both `datasources` and `datasource_instances`.
+   *
+   * @remarks
+   */
+  datasources?: Array<string> | undefined;
+  /**
+   * Restrict results to specific datasource instances. Values are datasource instance identifiers returned by `GET /api/search/filters`. Requests must not specify both `datasources` and `datasource_instances`.
+   *
+   * @remarks
+   */
+  datasource_instances?: Array<string> | undefined;
+  /**
+   * Structured filters applied to search results. Equality operators OR multiple values within a filter. Multiple filters are AND'd together, including range filters on the same field. Filters are AND'd with any inline operators in `query`. Note that conflicting constraints on the same field (e.g., `type:document` in the query and `type: spreadsheet` in a filter) produce an empty result set.
+   *
+   * @remarks
+   */
+  filters?: Array<PlatformFilter> | undefined;
+  /**
+   * Filter results to those last updated within this range.
+   */
+  time_range?: PlatformTimeRange | undefined;
+};
+
+/** @internal */
+export type PlatformSearchRequest$Outbound = {
+  query: string;
+  page_size: number;
+  cursor?: string | null | undefined;
+  datasources?: Array<string> | undefined;
+  datasource_instances?: Array<string> | undefined;
+  filters?: Array<PlatformFilter$Outbound> | undefined;
+  time_range?: PlatformTimeRange$Outbound | undefined;
+};
+
+/** @internal */
+export const PlatformSearchRequest$outboundSchema: z.ZodType<
+  PlatformSearchRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSearchRequest
+> = z.object({
+  query: z.string(),
+  page_size: z.number().int().default(10),
+  cursor: z.nullable(z.string()).optional(),
+  datasources: z.array(z.string()).optional(),
+  datasource_instances: z.array(z.string()).optional(),
+  filters: z.array(PlatformFilter$outboundSchema).optional(),
+  time_range: PlatformTimeRange$outboundSchema.optional(),
+});
+
+export function platformSearchRequestToJSON(
+  platformSearchRequest: PlatformSearchRequest,
+): string {
+  return JSON.stringify(
+    PlatformSearchRequest$outboundSchema.parse(platformSearchRequest),
+  );
+}

package/src/models/components/platformsearchresponse.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a12b46a101c0
+ */
+
+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 {
+  PlatformResult,
+  PlatformResult$inboundSchema,
+} from "./platformresult.js";
+
+export type PlatformSearchResponse = {
+  /**
+   * Ordered list of search results.
+   */
+  results: Array<PlatformResult>;
+  /**
+   * Indicates whether additional pages of results are available.
+   */
+  has_more: boolean;
+  /**
+   * Opaque token to pass as `cursor` in the next request.
+   */
+  next_cursor: string | null;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformSearchResponse$inboundSchema: z.ZodType<
+  PlatformSearchResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.array(PlatformResult$inboundSchema),
+  has_more: z.boolean(),
+  next_cursor: z.nullable(z.string()),
+  request_id: z.string(),
+});
+
+export function platformSearchResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSearchResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSearchResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSearchResponse' from JSON`,
+  );
+}

package/src/models/components/platformtimerange.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fb9ab6343c3a
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Filter results to those last updated within this range.
+ */
+export type PlatformTimeRange = {
+  /**
+   * Inclusive lower bound in ISO 8601 format.
+   */
+  start?: Date | undefined;
+  /**
+   * Exclusive upper bound in ISO 8601 format.
+   */
+  end?: Date | undefined;
+};
+
+/** @internal */
+export type PlatformTimeRange$Outbound = {
+  start?: string | undefined;
+  end?: string | undefined;
+};
+
+/** @internal */
+export const PlatformTimeRange$outboundSchema: z.ZodType<
+  PlatformTimeRange$Outbound,
+  z.ZodTypeDef,
+  PlatformTimeRange
+> = z.object({
+  start: z.date().transform(v => v.toISOString()).optional(),
+  end: z.date().transform(v => v.toISOString()).optional(),
+});
+
+export function platformTimeRangeToJSON(
+  platformTimeRange: PlatformTimeRange,
+): string {
+  return JSON.stringify(
+    PlatformTimeRange$outboundSchema.parse(platformTimeRange),
+  );
+}

package/src/models/components/resultsresponse.ts

@@ -29,7 +29,7 @@ export type ResultsResponse = {
   results?: Array<SearchResult> | undefined;
   structuredResults?: Array<StructuredResult> | undefined;
   generatedQnaResult?: GeneratedQna | undefined;
-  gleanDataError?: GleanDataError | undefined;
+  GleanDataError?: GleanDataError | undefined;
   /**
    * A platform-generated request ID to correlate backend logs.
    */
@@ -56,7 +56,7 @@ export const ResultsResponse$inboundSchema: z.ZodType<
   backendTimeMillis: z.number().int().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "errorInfo": "gleanDataError",
+    "errorInfo": "GleanDataError",
   });
 });
 

package/src/models/components/searchresponse.ts

@@ -40,7 +40,7 @@ export type SearchResponse = {
   results?: Array<SearchResult> | undefined;
   structuredResults?: Array<StructuredResult> | undefined;
   generatedQnaResult?: GeneratedQna | undefined;
-  gleanDataError?: GleanDataError | undefined;
+  GleanDataError?: GleanDataError | undefined;
   /**
    * A platform-generated request ID to correlate backend logs.
    */
@@ -103,7 +103,7 @@ export const SearchResponse$inboundSchema: z.ZodType<
   hasMoreResults: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "errorInfo": "gleanDataError",
+    "errorInfo": "GleanDataError",
   });
 });
 

package/src/models/components/teammember.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 import { RFCDate } from "../../types/rfcdate.js";
 
 /**
@@ -22,7 +21,7 @@ export type TeamMember = {
   /**
    * The member's start date
    */
-  joinDate?: RFCDate | undefined;
+  join_date?: RFCDate | undefined;
 };
 
 /** @internal */
@@ -40,11 +39,7 @@ export const TeamMember$outboundSchema: z.ZodType<
 > = z.object({
   email: z.string(),
   relationship: z.string().default("MEMBER"),
-  joinDate: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
-}).transform((v) => {
-  return remap$(v, {
-    joinDate: "join_date",
-  });
+  join_date: z.instanceof(RFCDate).transform(v => v.toString()).optional(),
 });
 
 export function teamMemberToJSON(teamMember: TeamMember): string {

package/src/models/errors/index.ts

@@ -10,5 +10,6 @@ export * from "./gleanbaseerror.js";
 export * from "./gleandataerror.js";
 export * from "./gleanerror.js";
 export * from "./httpclienterrors.js";
+export * from "./platformproblemdetailerror.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkvalidationerror.js";

package/src/models/errors/platformproblemdetailerror.ts

@@ -0,0 +1,141 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2e0c46764da2
+ */
+
+import * as z from "zod/v3";
+import * as components from "../components/index.js";
+import { GleanBaseError } from "./gleanbaseerror.js";
+
+/**
+ * Error response following RFC 9457, extended with `code` and `documentation_url` for machine-readable classification and self-service remediation.
+ *
+ * @remarks
+ */
+export type PlatformProblemDetailErrorData = {
+  /**
+   * URI identifying the error type.
+   */
+  type: string;
+  /**
+   * Short, human-readable summary of the error.
+   */
+  title: string;
+  /**
+   * HTTP status code mirrored from the response.
+   */
+  status: number;
+  /**
+   * Human-readable explanation specific to this occurrence.
+   */
+  detail: string;
+  /**
+   * Stable machine-readable error code.
+   */
+  code: components.PlatformProblemDetailCode;
+  /**
+   * Direct URL to documentation for this error code.
+   */
+  documentation_url?: string | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+  /**
+   * Field-level validation problems, one entry per offending field.
+   */
+  errors?: Array<components.PlatformProblemDetailError> | undefined;
+};
+
+/**
+ * Error response following RFC 9457, extended with `code` and `documentation_url` for machine-readable classification and self-service remediation.
+ *
+ * @remarks
+ */
+export class PlatformProblemDetailError extends GleanBaseError {
+  /**
+   * URI identifying the error type.
+   */
+  type: string;
+  /**
+   * Short, human-readable summary of the error.
+   */
+  title: string;
+  /**
+   * HTTP status code mirrored from the response.
+   */
+  status: number;
+  /**
+   * Human-readable explanation specific to this occurrence.
+   */
+  detail: string;
+  /**
+   * Stable machine-readable error code.
+   */
+  code: components.PlatformProblemDetailCode;
+  /**
+   * Direct URL to documentation for this error code.
+   */
+  documentation_url?: string | undefined;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+  /**
+   * Field-level validation problems, one entry per offending field.
+   */
+  errors?: Array<components.PlatformProblemDetailError> | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: PlatformProblemDetailErrorData;
+
+  constructor(
+    err: PlatformProblemDetailErrorData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.type = err.type;
+    this.title = err.title;
+    this.status = err.status;
+    this.detail = err.detail;
+    this.code = err.code;
+    if (err.documentation_url != null) {
+      this.documentation_url = err.documentation_url;
+    }
+    this.request_id = err.request_id;
+    if (err.errors != null) this.errors = err.errors;
+
+    this.name = "PlatformProblemDetailError";
+  }
+}
+
+/** @internal */
+export const PlatformProblemDetailError$inboundSchema: z.ZodType<
+  PlatformProblemDetailError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.string(),
+  title: z.string(),
+  status: z.number().int(),
+  detail: z.string(),
+  code: components.PlatformProblemDetailCode$inboundSchema,
+  documentation_url: z.string().optional(),
+  request_id: z.string(),
+  errors: z.array(components.PlatformProblemDetailError$inboundSchema)
+    .optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PlatformProblemDetailError(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/operations/editagent.ts

@@ -19,7 +19,7 @@ export type EditAgentRequest = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
   editWorkflowRequest: components.EditWorkflowRequest;
 };
 
@@ -39,11 +39,10 @@ export const EditAgentRequest$outboundSchema: z.ZodType<
 > = z.object({
   locale: z.string().optional(),
   timezoneOffset: z.number().int().optional(),
-  agentId: z.string(),
+  agent_id: z.string(),
   editWorkflowRequest: components.EditWorkflowRequest$outboundSchema,
 }).transform((v) => {
   return remap$(v, {
-    agentId: "agent_id",
     editWorkflowRequest: "EditWorkflowRequest",
   });
 });

package/src/models/operations/getagent.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 
 export type GetAgentRequest = {
   /**
@@ -18,7 +17,7 @@ export type GetAgentRequest = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
 };
 
 /** @internal */
@@ -36,11 +35,7 @@ export const GetAgentRequest$outboundSchema: z.ZodType<
 > = z.object({
   locale: z.string().optional(),
   timezoneOffset: z.number().int().optional(),
-  agentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    agentId: "agent_id",
-  });
+  agent_id: z.string(),
 });
 
 export function getAgentRequestToJSON(

package/src/models/operations/getagentschemas.ts

@@ -4,7 +4,6 @@
  */
 
 import * as z from "zod/v3";
-import { remap as remap$ } from "../../lib/primitives.js";
 
 export type GetAgentSchemasRequest = {
   /**
@@ -18,7 +17,7 @@ export type GetAgentSchemasRequest = {
   /**
    * The ID of the agent.
    */
-  agentId: string;
+  agent_id: string;
 };
 
 /** @internal */
@@ -36,11 +35,7 @@ export const GetAgentSchemasRequest$outboundSchema: z.ZodType<
 > = z.object({
   locale: z.string().optional(),
   timezoneOffset: z.number().int().optional(),
-  agentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    agentId: "agent_id",
-  });
+  agent_id: z.string(),
 });
 
 export function getAgentSchemasRequestToJSON(

package/src/models/operations/getpersonphoto.ts

@@ -13,7 +13,7 @@ export type GetPersonPhotoRequest = {
   /**
    * The obfuscated ID of the person whose photo to retrieve.
    */
-  personId: string;
+  person_id: string;
   /**
    * Optional datasource override for crawled photos (e.g. AZURE, GDRIVE, OKTA). When omitted, the datasource is derived from the person's stored photo URL or the deployment's primary person datasource.
    *
@@ -27,7 +27,7 @@ export type GetPersonPhotoResponseResult =
   | ReadableStream<Uint8Array>;
 
 export type GetPersonPhotoResponse = {
-  headers: { [k: string]: Array<string> };
+  Headers: { [k: string]: Array<string> };
   result: ReadableStream<Uint8Array> | ReadableStream<Uint8Array>;
 };
 
@@ -43,12 +43,8 @@ export const GetPersonPhotoRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   GetPersonPhotoRequest
 > = z.object({
-  personId: z.string(),
+  person_id: z.string(),
   ds: z.string().optional(),
-}).transform((v) => {
-  return remap$(v, {
-    personId: "person_id",
-  });
 });
 
 export function getPersonPhotoRequestToJSON(
@@ -92,7 +88,6 @@ export const GetPersonPhotoResponse$inboundSchema: z.ZodType<
   ]),
 }).transform((v) => {
   return remap$(v, {
-    "Headers": "headers",
     "Result": "result",
   });
 });

package/src/models/operations/index.ts

@@ -70,6 +70,9 @@ export * from "./listverifications.js";
 export * from "./messages.js";
 export * from "./people.js";
 export * from "./pin.js";
+export * from "./platformagentscreaterun.js";
+export * from "./platformagentsget.js";
+export * from "./platformagentsgetschemas.js";
 export * from "./postapiindexv1debugdatasourcedocument.js";
 export * from "./postapiindexv1debugdatasourcedocumentevents.js";
 export * from "./postapiindexv1debugdatasourcedocuments.js";

package/src/models/operations/platformagentscreaterun.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 51a44ec04f7d
+ */
+
+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 * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PlatformAgentsCreateRunRequest = {
+  /**
+   * ID of the agent to run.
+   */
+  agent_id: string;
+  platformAgentRunCreateRequest: components.PlatformAgentRunCreateRequest;
+};
+
+export type PlatformAgentsCreateRunResponse =
+  | components.PlatformAgentRunWaitResponse
+  | string;
+
+/** @internal */
+export type PlatformAgentsCreateRunRequest$Outbound = {
+  agent_id: string;
+  PlatformAgentRunCreateRequest:
+    components.PlatformAgentRunCreateRequest$Outbound;
+};
+
+/** @internal */
+export const PlatformAgentsCreateRunRequest$outboundSchema: z.ZodType<
+  PlatformAgentsCreateRunRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentsCreateRunRequest
+> = z.object({
+  agent_id: z.string(),
+  platformAgentRunCreateRequest:
+    components.PlatformAgentRunCreateRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    platformAgentRunCreateRequest: "PlatformAgentRunCreateRequest",
+  });
+});
+
+export function platformAgentsCreateRunRequestToJSON(
+  platformAgentsCreateRunRequest: PlatformAgentsCreateRunRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentsCreateRunRequest$outboundSchema.parse(
+      platformAgentsCreateRunRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const PlatformAgentsCreateRunResponse$inboundSchema: z.ZodType<
+  PlatformAgentsCreateRunResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  components.PlatformAgentRunWaitResponse$inboundSchema,
+  z.string(),
+]);
+
+export function platformAgentsCreateRunResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformAgentsCreateRunResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformAgentsCreateRunResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformAgentsCreateRunResponse' from JSON`,
+  );
+}

package/src/models/operations/platformagentsget.ts

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

package/src/models/operations/platformagentsgetschemas.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c025879102b3
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformAgentsGetSchemasRequest = {
+  /**
+   * ID of the agent whose schemas should be retrieved.
+   */
+  agent_id: string;
+  /**
+   * Whether to include tool metadata in the response.
+   */
+  include_tools?: boolean | undefined;
+};
+
+/** @internal */
+export type PlatformAgentsGetSchemasRequest$Outbound = {
+  agent_id: string;
+  include_tools: boolean;
+};
+
+/** @internal */
+export const PlatformAgentsGetSchemasRequest$outboundSchema: z.ZodType<
+  PlatformAgentsGetSchemasRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformAgentsGetSchemasRequest
+> = z.object({
+  agent_id: z.string(),
+  include_tools: z.boolean().default(false),
+});
+
+export function platformAgentsGetSchemasRequestToJSON(
+  platformAgentsGetSchemasRequest: PlatformAgentsGetSchemasRequest,
+): string {
+  return JSON.stringify(
+    PlatformAgentsGetSchemasRequest$outboundSchema.parse(
+      platformAgentsGetSchemasRequest,
+    ),
+  );
+}