@gleanwork/api-client 0.18.0 → 0.18.1

package/src/models/components/platformsearchrequest.ts

@@ -33,19 +33,13 @@ export type PlatformSearchRequest = {
    */
   cursor?: string | null | undefined;
   /**
-   * Restrict results to specific datasources. Requests must not specify both `datasources` and `datasource_instances`.
+   * Restrict results to specific datasource identifiers returned by `GET /api/search/filters`. Scopes by datasource type and may include results from multiple instances of that type.
    *
    * @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.
+   * Structured filters applied to search results. Multiple values within a filter with `EQUALS` are OR'd; separate filters are AND'd. Conflicting constraints on the same field (for example, `type:document` in `query` and `type:spreadsheet` in a filter) return an empty result set. See `Filter.field` for built-in field names and operators. Other nonblank field names are accepted as custom filters without validation; behavior depends on your connected sources.
    *
    * @remarks
    */
@@ -62,7 +56,6 @@ export type PlatformSearchRequest$Outbound = {
   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;
 };
@@ -77,7 +70,6 @@ export const PlatformSearchRequest$outboundSchema: z.ZodType<
   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(),
 });

package/src/models/components/platformsearchresponse.ts

@@ -11,10 +11,16 @@ import {
   PlatformResult,
   PlatformResult$inboundSchema,
 } from "./platformresult.js";
+import {
+  PlatformWarning,
+  PlatformWarning$inboundSchema,
+} from "./platformwarning.js";
 
 export type PlatformSearchResponse = {
   /**
-   * Ordered list of search results.
+   * Ordered list of ranked document results. People cards, Q&A blocks, and other UI-only result types are not included.
+   *
+   * @remarks
    */
   results: Array<PlatformResult>;
   /**
@@ -29,6 +35,12 @@ export type PlatformSearchResponse = {
    * Platform-generated request ID for support correlation.
    */
   request_id: string;
+  /**
+   * Non-blocking warnings for this response. Required; use `[]` when there are none. Clients must tolerate unknown warning codes. `results_incomplete` means some results may be unavailable for the requested datasource scope while `results`, `has_more`, and `next_cursor` remain present. Warning messages are generic and do not include query text or internal identifiers.
+   *
+   * @remarks
+   */
+  warnings: Array<PlatformWarning>;
 };
 
 /** @internal */
@@ -41,6 +53,7 @@ export const PlatformSearchResponse$inboundSchema: z.ZodType<
   has_more: z.boolean(),
   next_cursor: z.nullable(z.string()),
   request_id: z.string(),
+  warnings: z.array(PlatformWarning$inboundSchema),
 });
 
 export function platformSearchResponseFromJSON(

package/src/models/components/platformskillimportrequest.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 04970582be67
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformSkillImportRequest = {
+  /**
+   * Resolved GitHub skill URLs selected from a source preview.
+   */
+  source_urls: Array<string>;
+};
+
+/** @internal */
+export type PlatformSkillImportRequest$Outbound = {
+  source_urls: Array<string>;
+};
+
+/** @internal */
+export const PlatformSkillImportRequest$outboundSchema: z.ZodType<
+  PlatformSkillImportRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillImportRequest
+> = z.object({
+  source_urls: z.array(z.string()),
+});
+
+export function platformSkillImportRequestToJSON(
+  platformSkillImportRequest: PlatformSkillImportRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillImportRequest$outboundSchema.parse(platformSkillImportRequest),
+  );
+}

package/src/models/components/platformskillimportresponse.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 260976c87f80
+ */
+
+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 { PlatformSkill, PlatformSkill$inboundSchema } from "./platformskill.js";
+
+export type PlatformSkillImportResponse = {
+  /**
+   * Independently persisted skills in request order.
+   */
+  skills: Array<PlatformSkill>;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformSkillImportResponse$inboundSchema: z.ZodType<
+  PlatformSkillImportResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skills: z.array(PlatformSkill$inboundSchema),
+  request_id: z.string(),
+});
+
+export function platformSkillImportResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillImportResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillImportResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillImportResponse' from JSON`,
+  );
+}

package/src/models/components/platformskillsourcepreview.ts

@@ -0,0 +1,69 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e9a0c502793d
+ */
+
+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 {
+  PlatformSkillSourcePreviewFile,
+  PlatformSkillSourcePreviewFile$inboundSchema,
+} from "./platformskillsourcepreviewfile.js";
+
+export type PlatformSkillSourcePreview = {
+  /**
+   * Skill name parsed from SKILL.md frontmatter.
+   */
+  display_name: string;
+  /**
+   * Skill description parsed from SKILL.md frontmatter.
+   */
+  description: string;
+  /**
+   * Resolved URL for this skill within the source.
+   */
+  source_url: string;
+  /**
+   * Commit SHA used to produce the preview.
+   */
+  commit_sha: string;
+  /**
+   * SKILL.md content fetched as part of the preview.
+   */
+  main_content: string;
+  /**
+   * Supporting files fetched with the skill.
+   */
+  files: Array<PlatformSkillSourcePreviewFile>;
+  /**
+   * Relative paths discovered for the skill.
+   */
+  file_tree: Array<string>;
+};
+
+/** @internal */
+export const PlatformSkillSourcePreview$inboundSchema: z.ZodType<
+  PlatformSkillSourcePreview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  display_name: z.string(),
+  description: z.string(),
+  source_url: z.string(),
+  commit_sha: z.string(),
+  main_content: z.string(),
+  files: z.array(PlatformSkillSourcePreviewFile$inboundSchema),
+  file_tree: z.array(z.string()),
+});
+
+export function platformSkillSourcePreviewFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillSourcePreview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillSourcePreview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillSourcePreview' from JSON`,
+  );
+}

package/src/models/components/platformskillsourcepreviewfailure.ts

@@ -0,0 +1,49 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: b02b808df8d9
+ */
+
+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 {
+  PlatformSkillSourcePreviewFailureCode,
+  PlatformSkillSourcePreviewFailureCode$inboundSchema,
+} from "./platformskillsourcepreviewfailurecode.js";
+
+export type PlatformSkillSourcePreviewFailure = {
+  /**
+   * Resolved URL for the entry that could not be previewed.
+   */
+  source_url: string;
+  /**
+   * Stable machine-readable reason a discovered entry was excluded.
+   */
+  code: PlatformSkillSourcePreviewFailureCode;
+  /**
+   * Safe explanation of why the entry was excluded.
+   */
+  detail: string;
+};
+
+/** @internal */
+export const PlatformSkillSourcePreviewFailure$inboundSchema: z.ZodType<
+  PlatformSkillSourcePreviewFailure,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  source_url: z.string(),
+  code: PlatformSkillSourcePreviewFailureCode$inboundSchema,
+  detail: z.string(),
+});
+
+export function platformSkillSourcePreviewFailureFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillSourcePreviewFailure, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillSourcePreviewFailure$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillSourcePreviewFailure' from JSON`,
+  );
+}

package/src/models/components/platformskillsourcepreviewfailurecode.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 69312140acc1
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Stable machine-readable reason a discovered entry was excluded.
+ */
+export const PlatformSkillSourcePreviewFailureCode = {
+  InvalidSkill: "INVALID_SKILL",
+  SkillFetchFailed: "SKILL_FETCH_FAILED",
+} as const;
+/**
+ * Stable machine-readable reason a discovered entry was excluded.
+ */
+export type PlatformSkillSourcePreviewFailureCode = OpenEnum<
+  typeof PlatformSkillSourcePreviewFailureCode
+>;
+
+/** @internal */
+export const PlatformSkillSourcePreviewFailureCode$inboundSchema: z.ZodType<
+  PlatformSkillSourcePreviewFailureCode,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformSkillSourcePreviewFailureCode);

package/src/models/components/platformskillsourcepreviewfile.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2d121cf79d2a
+ */
+
+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 PlatformSkillSourcePreviewFile = {
+  /**
+   * Relative path within the skill bundle.
+   */
+  path: string;
+  /**
+   * UTF-8 file content.
+   */
+  content: string;
+};
+
+/** @internal */
+export const PlatformSkillSourcePreviewFile$inboundSchema: z.ZodType<
+  PlatformSkillSourcePreviewFile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  path: z.string(),
+  content: z.string(),
+});
+
+export function platformSkillSourcePreviewFileFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillSourcePreviewFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillSourcePreviewFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillSourcePreviewFile' from JSON`,
+  );
+}

package/src/models/components/platformskillsourcepreviewrequest.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5a0d0f1fb5dd
+ */
+
+import * as z from "zod/v3";
+
+export type PlatformSkillSourcePreviewRequest = {
+  /**
+   * GitHub URL for a skill directory, SKILL.md file, or repository to inspect.
+   */
+  source_url: string;
+  /**
+   * Whether to stream repository scan progress using server-sent events.
+   */
+  stream?: boolean | undefined;
+};
+
+/** @internal */
+export type PlatformSkillSourcePreviewRequest$Outbound = {
+  source_url: string;
+  stream: boolean;
+};
+
+/** @internal */
+export const PlatformSkillSourcePreviewRequest$outboundSchema: z.ZodType<
+  PlatformSkillSourcePreviewRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillSourcePreviewRequest
+> = z.object({
+  source_url: z.string(),
+  stream: z.boolean().default(false),
+});
+
+export function platformSkillSourcePreviewRequestToJSON(
+  platformSkillSourcePreviewRequest: PlatformSkillSourcePreviewRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillSourcePreviewRequest$outboundSchema.parse(
+      platformSkillSourcePreviewRequest,
+    ),
+  );
+}

package/src/models/components/platformskillsourcepreviewresponse.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: a4013769ac82
+ */
+
+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 {
+  PlatformSkillSourcePreview,
+  PlatformSkillSourcePreview$inboundSchema,
+} from "./platformskillsourcepreview.js";
+import {
+  PlatformSkillSourcePreviewFailure,
+  PlatformSkillSourcePreviewFailure$inboundSchema,
+} from "./platformskillsourcepreviewfailure.js";
+
+export type PlatformSkillSourcePreviewResponse = {
+  /**
+   * Valid skills discovered at the source URL.
+   */
+  skills: Array<PlatformSkillSourcePreview>;
+  /**
+   * Discovered entries that could not be included in the preview.
+   */
+  failures: Array<PlatformSkillSourcePreviewFailure>;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformSkillSourcePreviewResponse$inboundSchema: z.ZodType<
+  PlatformSkillSourcePreviewResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skills: z.array(PlatformSkillSourcePreview$inboundSchema),
+  failures: z.array(PlatformSkillSourcePreviewFailure$inboundSchema),
+  request_id: z.string(),
+});
+
+export function platformSkillSourcePreviewResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillSourcePreviewResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PlatformSkillSourcePreviewResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillSourcePreviewResponse' from JSON`,
+  );
+}

package/src/models/components/platformskillsyncresponse.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ffcfea36c43e
+ */
+
+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 {
+  PlatformSkillSyncResultStatus,
+  PlatformSkillSyncResultStatus$inboundSchema,
+} from "./platformskillsyncresultstatus.js";
+
+export type PlatformSkillSyncResponse = {
+  /**
+   * Synchronization status after a successful refresh.
+   */
+  sync_status: PlatformSkillSyncResultStatus;
+  /**
+   * Git commit SHA now associated with the skill.
+   */
+  commit_sha: string;
+  /**
+   * Whether this request created a new skill version.
+   */
+  updated: boolean;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformSkillSyncResponse$inboundSchema: z.ZodType<
+  PlatformSkillSyncResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  sync_status: PlatformSkillSyncResultStatus$inboundSchema,
+  commit_sha: z.string(),
+  updated: z.boolean(),
+  request_id: z.string(),
+});
+
+export function platformSkillSyncResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillSyncResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillSyncResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillSyncResponse' from JSON`,
+  );
+}

package/src/models/components/platformskillsyncresultstatus.ts

@@ -0,0 +1,25 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 1109037ce8b8
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Synchronization status after a successful refresh.
+ */
+export const PlatformSkillSyncResultStatus = {
+  UpToDate: "UP_TO_DATE",
+} as const;
+/**
+ * Synchronization status after a successful refresh.
+ */
+export type PlatformSkillSyncResultStatus = ClosedEnum<
+  typeof PlatformSkillSyncResultStatus
+>;
+
+/** @internal */
+export const PlatformSkillSyncResultStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformSkillSyncResultStatus
+> = z.nativeEnum(PlatformSkillSyncResultStatus);

package/src/models/components/platformskillupdaterequest.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3df8f4155bd1
+ */
+
+import * as z from "zod/v3";
+import {
+  PlatformSkillUpdateStatus,
+  PlatformSkillUpdateStatus$outboundSchema,
+} from "./platformskillupdatestatus.js";
+
+export type PlatformSkillUpdateRequest = {
+  /**
+   * New status for the skill.
+   */
+  status: PlatformSkillUpdateStatus;
+};
+
+/** @internal */
+export type PlatformSkillUpdateRequest$Outbound = {
+  status: string;
+};
+
+/** @internal */
+export const PlatformSkillUpdateRequest$outboundSchema: z.ZodType<
+  PlatformSkillUpdateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillUpdateRequest
+> = z.object({
+  status: PlatformSkillUpdateStatus$outboundSchema,
+});
+
+export function platformSkillUpdateRequestToJSON(
+  platformSkillUpdateRequest: PlatformSkillUpdateRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillUpdateRequest$outboundSchema.parse(platformSkillUpdateRequest),
+  );
+}

package/src/models/components/platformskillupdateresponse.ts

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

package/src/models/components/platformskillupdatestatus.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5f8d04c5a43c
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * New status for the skill.
+ */
+export const PlatformSkillUpdateStatus = {
+  Enabled: "ENABLED",
+  Disabled: "DISABLED",
+} as const;
+/**
+ * New status for the skill.
+ */
+export type PlatformSkillUpdateStatus = ClosedEnum<
+  typeof PlatformSkillUpdateStatus
+>;
+
+/** @internal */
+export const PlatformSkillUpdateStatus$outboundSchema: z.ZodNativeEnum<
+  typeof PlatformSkillUpdateStatus
+> = z.nativeEnum(PlatformSkillUpdateStatus);

package/src/models/components/platformskillvalidationresponse.ts

@@ -16,9 +16,9 @@ import {
   PlatformSkillValidationMetadata$inboundSchema,
 } from "./platformskillvalidationmetadata.js";
 import {
-  PlatformSkillValidationWarning,
-  PlatformSkillValidationWarning$inboundSchema,
-} from "./platformskillvalidationwarning.js";
+  PlatformWarning,
+  PlatformWarning$inboundSchema,
+} from "./platformwarning.js";
 
 export type PlatformSkillValidationResponse = {
   metadata: PlatformSkillValidationMetadata;
@@ -29,7 +29,7 @@ export type PlatformSkillValidationResponse = {
   /**
    * Non-blocking validation warnings.
    */
-  warnings: Array<PlatformSkillValidationWarning>;
+  warnings: Array<PlatformWarning>;
   /**
    * Platform-generated request ID for support correlation.
    */
@@ -44,7 +44,7 @@ export const PlatformSkillValidationResponse$inboundSchema: z.ZodType<
 > = z.object({
   metadata: PlatformSkillValidationMetadata$inboundSchema,
   files: z.array(PlatformSkillValidationFile$inboundSchema),
-  warnings: z.array(PlatformSkillValidationWarning$inboundSchema),
+  warnings: z.array(PlatformWarning$inboundSchema),
   request_id: z.string(),
 });