@gleanwork/api-client 0.16.1 → 0.17.1

package/src/models/components/platformproblemdetailcode.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 46cd388abcf0
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Stable machine-readable error code.
+ */
+export const PlatformProblemDetailCode = {
+  InvalidRequest: "invalid_request",
+  MissingRequiredField: "missing_required_field",
+  InvalidParameter: "invalid_parameter",
+  InvalidCursor: "invalid_cursor",
+  ExpiredCursor: "expired_cursor",
+  InvalidFilter: "invalid_filter",
+  InvalidDatasource: "invalid_datasource",
+  AuthenticationRequired: "authentication_required",
+  TokenExpired: "token_expired",
+  InsufficientPermissions: "insufficient_permissions",
+  ResourceNotFound: "resource_not_found",
+  MethodNotAllowed: "method_not_allowed",
+  RequestTimeout: "request_timeout",
+  RequestTooLarge: "request_too_large",
+  Conflict: "conflict",
+  Gone: "gone",
+  UnprocessableQuery: "unprocessable_query",
+  RateLimitExceeded: "rate_limit_exceeded",
+  InternalError: "internal_error",
+  ServiceUnavailable: "service_unavailable",
+} as const;
+/**
+ * Stable machine-readable error code.
+ */
+export type PlatformProblemDetailCode = OpenEnum<
+  typeof PlatformProblemDetailCode
+>;
+
+/** @internal */
+export const PlatformProblemDetailCode$inboundSchema: z.ZodType<
+  PlatformProblemDetailCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformProblemDetailCode);

package/src/models/components/platformproblemdetailerror.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b6c429f3b976
+ */
+
+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 {
+  PlatformProblemDetailCode,
+  PlatformProblemDetailCode$inboundSchema,
+} from "./platformproblemdetailcode.js";
+
+/**
+ * Field-level validation problem for a single offending field.
+ */
+export type PlatformProblemDetailError = {
+  /**
+   * RFC 6901 JSON Pointer to the offending field.
+   */
+  pointer: string;
+  /**
+   * Human-readable explanation for this field.
+   */
+  detail: string;
+  /**
+   * Stable machine-readable error code.
+   */
+  code?: PlatformProblemDetailCode | undefined;
+};
+
+/** @internal */
+export const PlatformProblemDetailError$inboundSchema: z.ZodType<
+  PlatformProblemDetailError,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pointer: z.string(),
+  detail: z.string(),
+  code: PlatformProblemDetailCode$inboundSchema.optional(),
+});
+
+export function platformProblemDetailErrorFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformProblemDetailError, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformProblemDetailError$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformProblemDetailError' from JSON`,
+  );
+}

package/src/models/components/platformresult.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ace03f2ab3c3
+ */
+
+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 {
+  PlatformPersonReference,
+  PlatformPersonReference$inboundSchema,
+} from "./platformpersonreference.js";
+
+export type PlatformResult = {
+  /**
+   * Canonical URL of the result.
+   */
+  url: string;
+  /**
+   * Result title.
+   */
+  title: string;
+  /**
+   * Query-relevant plain-text excerpts from the result body.
+   */
+  snippets?: Array<string> | undefined;
+  /**
+   * The datasource this result originates from.
+   */
+  datasource: string;
+  /**
+   * The datasource instance this result originates from, if known.
+   */
+  datasource_instance?: string | null | undefined;
+  /**
+   * The document type within the datasource.
+   */
+  document_type?: string | null | undefined;
+  /**
+   * A lightweight reference to a person, used where a payload merely points at someone.
+   */
+  creator?: PlatformPersonReference | undefined;
+  /**
+   * A lightweight reference to a person, used where a payload merely points at someone.
+   */
+  owner?: PlatformPersonReference | undefined;
+  /**
+   * When the result was last modified.
+   */
+  updated_at?: Date | null | undefined;
+  /**
+   * When the result was created.
+   */
+  created_at?: Date | null | undefined;
+};
+
+/** @internal */
+export const PlatformResult$inboundSchema: z.ZodType<
+  PlatformResult,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  url: z.string(),
+  title: z.string(),
+  snippets: z.array(z.string()).optional(),
+  datasource: z.string(),
+  datasource_instance: z.nullable(z.string()).optional(),
+  document_type: z.nullable(z.string()).optional(),
+  creator: PlatformPersonReference$inboundSchema.optional(),
+  owner: PlatformPersonReference$inboundSchema.optional(),
+  updated_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  created_at: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+});
+
+export function platformResultFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformResult' from JSON`,
+  );
+}

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/shortcut.ts

@@ -13,6 +13,12 @@ import {
   Document$Outbound,
   Document$outboundSchema,
 } from "./document.js";
+import {
+  FavoriteInfo,
+  FavoriteInfo$inboundSchema,
+  FavoriteInfo$Outbound,
+  FavoriteInfo$outboundSchema,
+} from "./favoriteinfo.js";
 import {
   ObjectPermissions,
   ObjectPermissions$inboundSchema,
@@ -109,6 +115,7 @@ export type Shortcut = {
    * A list of user roles for the Go Link.
    */
   roles?: Array<UserRoleSpecification> | undefined;
+  favoriteInfo?: FavoriteInfo | undefined;
 };
 
 /** @internal */
@@ -143,6 +150,7 @@ export const Shortcut$inboundSchema: z.ZodType<
   alias: z.string().optional(),
   title: z.string().optional(),
   roles: z.array(z.lazy(() => UserRoleSpecification$inboundSchema)).optional(),
+  favoriteInfo: FavoriteInfo$inboundSchema.optional(),
 });
 /** @internal */
 export type Shortcut$Outbound = {
@@ -168,6 +176,7 @@ export type Shortcut$Outbound = {
   alias?: string | undefined;
   title?: string | undefined;
   roles?: Array<UserRoleSpecification$Outbound> | undefined;
+  favoriteInfo?: FavoriteInfo$Outbound | undefined;
 };
 
 /** @internal */
@@ -200,6 +209,7 @@ export const Shortcut$outboundSchema: z.ZodType<
   alias: z.string().optional(),
   title: z.string().optional(),
   roles: z.array(z.lazy(() => UserRoleSpecification$outboundSchema)).optional(),
+  favoriteInfo: FavoriteInfo$outboundSchema.optional(),
 });
 
 export function shortcutToJSON(shortcut: Shortcut): string {

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/components/ugctype.ts

@@ -34,3 +34,6 @@ export type UgcType = OpenEnum<typeof UgcType>;
 /** @internal */
 export const UgcType$inboundSchema: z.ZodType<UgcType, z.ZodTypeDef, unknown> =
   openEnums.inboundSchema(UgcType);
+/** @internal */
+export const UgcType$outboundSchema: z.ZodType<string, z.ZodTypeDef, UgcType> =
+  openEnums.outboundSchema(UgcType);

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