@gleanwork/api-client 0.17.3 → 0.18.1

package/src/models/components/platformskillvalidationfile.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ed89a1d60695
+ */
+
+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 PlatformSkillValidationFile = {
+  /**
+   * Normalized relative path in the skill bundle.
+   */
+  path: string;
+  /**
+   * File size in bytes.
+   */
+  size_bytes: number;
+  /**
+   * Whether this file is the skill manifest.
+   */
+  is_manifest: boolean;
+};
+
+/** @internal */
+export const PlatformSkillValidationFile$inboundSchema: z.ZodType<
+  PlatformSkillValidationFile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  path: z.string(),
+  size_bytes: z.number().int(),
+  is_manifest: z.boolean(),
+});
+
+export function platformSkillValidationFileFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillValidationFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillValidationFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillValidationFile' from JSON`,
+  );
+}

package/src/models/components/platformskillvalidationmetadata.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 198f33194249
+ */
+
+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 PlatformSkillValidationMetadata = {
+  /**
+   * Skill name parsed from SKILL.md frontmatter.
+   */
+  display_name: string;
+  /**
+   * Skill description parsed from SKILL.md frontmatter.
+   */
+  description: string;
+};
+
+/** @internal */
+export const PlatformSkillValidationMetadata$inboundSchema: z.ZodType<
+  PlatformSkillValidationMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  display_name: z.string(),
+  description: z.string(),
+});
+
+export function platformSkillValidationMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillValidationMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillValidationMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillValidationMetadata' from JSON`,
+  );
+}

package/src/models/components/platformskillvalidationrequest.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c7759b98c6a9
+ */
+
+import * as z from "zod/v3";
+import { blobLikeSchema } from "../../types/blobs.js";
+
+export type PlatformSkillValidationRequestFile = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+export type PlatformSkillValidationRequest = {
+  /**
+   * SKILL.md, .zip, or .skill bundle to validate.
+   */
+  file: PlatformSkillValidationRequestFile | Blob;
+};
+
+/** @internal */
+export type PlatformSkillValidationRequestFile$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const PlatformSkillValidationRequestFile$outboundSchema: z.ZodType<
+  PlatformSkillValidationRequestFile$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillValidationRequestFile
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+});
+
+export function platformSkillValidationRequestFileToJSON(
+  platformSkillValidationRequestFile: PlatformSkillValidationRequestFile,
+): string {
+  return JSON.stringify(
+    PlatformSkillValidationRequestFile$outboundSchema.parse(
+      platformSkillValidationRequestFile,
+    ),
+  );
+}
+
+/** @internal */
+export type PlatformSkillValidationRequest$Outbound = {
+  file: PlatformSkillValidationRequestFile$Outbound | Blob;
+};
+
+/** @internal */
+export const PlatformSkillValidationRequest$outboundSchema: z.ZodType<
+  PlatformSkillValidationRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillValidationRequest
+> = z.object({
+  file: z.lazy(() => PlatformSkillValidationRequestFile$outboundSchema).or(
+    blobLikeSchema,
+  ),
+});
+
+export function platformSkillValidationRequestToJSON(
+  platformSkillValidationRequest: PlatformSkillValidationRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillValidationRequest$outboundSchema.parse(
+      platformSkillValidationRequest,
+    ),
+  );
+}

package/src/models/components/platformskillvalidationresponse.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 72e990f8b408
+ */
+
+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 {
+  PlatformSkillValidationFile,
+  PlatformSkillValidationFile$inboundSchema,
+} from "./platformskillvalidationfile.js";
+import {
+  PlatformSkillValidationMetadata,
+  PlatformSkillValidationMetadata$inboundSchema,
+} from "./platformskillvalidationmetadata.js";
+import {
+  PlatformWarning,
+  PlatformWarning$inboundSchema,
+} from "./platformwarning.js";
+
+export type PlatformSkillValidationResponse = {
+  metadata: PlatformSkillValidationMetadata;
+  /**
+   * Normalized files in the bundle after stripping an optional single root folder.
+   */
+  files: Array<PlatformSkillValidationFile>;
+  /**
+   * Non-blocking validation warnings.
+   */
+  warnings: Array<PlatformWarning>;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformSkillValidationResponse$inboundSchema: z.ZodType<
+  PlatformSkillValidationResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  metadata: PlatformSkillValidationMetadata$inboundSchema,
+  files: z.array(PlatformSkillValidationFile$inboundSchema),
+  warnings: z.array(PlatformWarning$inboundSchema),
+  request_id: z.string(),
+});
+
+export function platformSkillValidationResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillValidationResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillValidationResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillValidationResponse' from JSON`,
+  );
+}

package/src/models/components/platformskillversion.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f58a116c278b
+ */
+
+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";
+import {
+  PlatformSkillSourceProvenance,
+  PlatformSkillSourceProvenance$inboundSchema,
+} from "./platformskillsourceprovenance.js";
+
+export type PlatformSkillVersion = {
+  /**
+   * Glean skill ID.
+   */
+  skill_id: string;
+  /**
+   * Major version number.
+   */
+  version: number;
+  /**
+   * Minor version number.
+   */
+  minor_version: number;
+  /**
+   * Whether this is the latest version of the skill.
+   */
+  is_latest: boolean;
+  /**
+   * A lightweight reference to a person, used where a payload merely points at someone.
+   */
+  created_by: PlatformPersonReference;
+  /**
+   * Time this version was created.
+   */
+  created_at: Date;
+  /**
+   * Time this version was last updated.
+   */
+  updated_at: Date;
+  source_provenance?: PlatformSkillSourceProvenance | undefined;
+};
+
+/** @internal */
+export const PlatformSkillVersion$inboundSchema: z.ZodType<
+  PlatformSkillVersion,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skill_id: z.string(),
+  version: z.number().int(),
+  minor_version: z.number().int(),
+  is_latest: z.boolean(),
+  created_by: PlatformPersonReference$inboundSchema,
+  created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  source_provenance: PlatformSkillSourceProvenance$inboundSchema.optional(),
+});
+
+export function platformSkillVersionFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillVersion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillVersion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillVersion' from JSON`,
+  );
+}

package/src/models/components/platformskillversioncreaterequest.ts

@@ -0,0 +1,76 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 48a1435a29de
+ */
+
+import * as z from "zod/v3";
+import { blobLikeSchema } from "../../types/blobs.js";
+
+export type PlatformSkillVersionCreateRequestFile = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+export type PlatformSkillVersionCreateRequest = {
+  /**
+   * SKILL.md, .zip, or .skill bundle to store as a new version.
+   */
+  file: PlatformSkillVersionCreateRequestFile | Blob;
+};
+
+/** @internal */
+export type PlatformSkillVersionCreateRequestFile$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const PlatformSkillVersionCreateRequestFile$outboundSchema: z.ZodType<
+  PlatformSkillVersionCreateRequestFile$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillVersionCreateRequestFile
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+});
+
+export function platformSkillVersionCreateRequestFileToJSON(
+  platformSkillVersionCreateRequestFile: PlatformSkillVersionCreateRequestFile,
+): string {
+  return JSON.stringify(
+    PlatformSkillVersionCreateRequestFile$outboundSchema.parse(
+      platformSkillVersionCreateRequestFile,
+    ),
+  );
+}
+
+/** @internal */
+export type PlatformSkillVersionCreateRequest$Outbound = {
+  file: PlatformSkillVersionCreateRequestFile$Outbound | Blob;
+};
+
+/** @internal */
+export const PlatformSkillVersionCreateRequest$outboundSchema: z.ZodType<
+  PlatformSkillVersionCreateRequest$Outbound,
+  z.ZodTypeDef,
+  PlatformSkillVersionCreateRequest
+> = z.object({
+  file: z.lazy(() => PlatformSkillVersionCreateRequestFile$outboundSchema).or(
+    blobLikeSchema,
+  ),
+});
+
+export function platformSkillVersionCreateRequestToJSON(
+  platformSkillVersionCreateRequest: PlatformSkillVersionCreateRequest,
+): string {
+  return JSON.stringify(
+    PlatformSkillVersionCreateRequest$outboundSchema.parse(
+      platformSkillVersionCreateRequest,
+    ),
+  );
+}

package/src/models/components/platformskillversioncreateresponse.ts

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

package/src/models/components/platformskillversiongetresponse.ts

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

package/src/models/components/platformskillversionslistresponse.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fc6cbf29ca76
+ */
+
+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 {
+  PlatformSkillVersion,
+  PlatformSkillVersion$inboundSchema,
+} from "./platformskillversion.js";
+
+export type PlatformSkillVersionsListResponse = {
+  /**
+   * Versions available for the skill.
+   */
+  versions: Array<PlatformSkillVersion>;
+  /**
+   * Whether additional results are available.
+   */
+  has_more: boolean;
+  /**
+   * Cursor for the next page, or null when no more results are available.
+   */
+  next_cursor: string | null;
+  /**
+   * Platform-generated request ID for support correlation.
+   */
+  request_id: string;
+};
+
+/** @internal */
+export const PlatformSkillVersionsListResponse$inboundSchema: z.ZodType<
+  PlatformSkillVersionsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  versions: z.array(PlatformSkillVersion$inboundSchema),
+  has_more: z.boolean(),
+  next_cursor: z.nullable(z.string()),
+  request_id: z.string(),
+});
+
+export function platformSkillVersionsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillVersionsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillVersionsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillVersionsListResponse' from JSON`,
+  );
+}

package/src/models/components/platformwarning.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 172530a57f1e
+ */
+
+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";
+
+/**
+ * Non-blocking warning attached to a successful Platform response.
+ */
+export type PlatformWarning = {
+  /**
+   * Open snake_case warning code. Clients must tolerate unknown values; the set of codes is not a closed enum.
+   *
+   * @remarks
+   */
+  code: string;
+  /**
+   * Human-readable warning message.
+   */
+  message: string;
+};
+
+/** @internal */
+export const PlatformWarning$inboundSchema: z.ZodType<
+  PlatformWarning,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  message: z.string(),
+});
+
+export function platformWarningFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformWarning, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformWarning$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformWarning' from JSON`,
+  );
+}

package/src/models/components/toolannotations.ts

@@ -0,0 +1,77 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d537caae3348
+ */
+
+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";
+
+/**
+ * Behavioural hints for the tool, exactly as declared by the tool server. No
+ *
+ * @remarks
+ * defaults are filled in — see the per-field notes for what an absent value means.
+ *
+ * Per the MCP specification, clients MUST treat these hints as untrusted unless
+ * the tool server is itself trusted. They are advisory metadata, not an
+ * authorization signal, and must not be the sole basis of a security decision.
+ */
+export type ToolAnnotations = {
+  title?: string | undefined;
+  /**
+   * True if the tool does not modify its environment. Always present. MCP
+   *
+   * @remarks
+   * defines no distinction between an undeclared value and `false` here, so
+   * `false` means "not declared read-only" rather than "declared mutating".
+   */
+  readOnlyHint?: boolean | undefined;
+  /**
+   * True if the tool may perform destructive updates. **Absent means the server
+   *
+   * @remarks
+   * did not declare it**, for which the MCP default is `true`. Only meaningful
+   * when `readOnlyHint` is `false`.
+   */
+  destructiveHint?: boolean | null | undefined;
+  /**
+   * True if repeated calls with the same arguments have no additional effect.
+   *
+   * @remarks
+   * Always present; as with `readOnlyHint`, `false` means "not declared
+   * idempotent". Only meaningful when `readOnlyHint` is `false`.
+   */
+  idempotentHint?: boolean | undefined;
+  /**
+   * True if the tool interacts with an open world of external entities. **Absent
+   *
+   * @remarks
+   * means the server did not declare it**, for which the MCP default is `true`.
+   */
+  openWorldHint?: boolean | null | undefined;
+};
+
+/** @internal */
+export const ToolAnnotations$inboundSchema: z.ZodType<
+  ToolAnnotations,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string().optional(),
+  readOnlyHint: z.boolean().optional(),
+  destructiveHint: z.nullable(z.boolean()).optional(),
+  idempotentHint: z.boolean().optional(),
+  openWorldHint: z.nullable(z.boolean()).optional(),
+});
+
+export function toolAnnotationsFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolAnnotations, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolAnnotations$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolAnnotations' from JSON`,
+  );
+}