@gleanwork/api-client 0.17.2 → 0.18.0

package/src/models/components/platformskillorigin.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5f9163750617
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Source category for the skill.
+ */
+export const PlatformSkillOrigin = {
+  Custom: "CUSTOM",
+} as const;
+/**
+ * Source category for the skill.
+ */
+export type PlatformSkillOrigin = ClosedEnum<typeof PlatformSkillOrigin>;
+
+/** @internal */
+export const PlatformSkillOrigin$inboundSchema: z.ZodNativeEnum<
+  typeof PlatformSkillOrigin
+> = z.nativeEnum(PlatformSkillOrigin);

package/src/models/components/platformskillslistresponse.ts

@@ -0,0 +1,51 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0b4832ec4dc7
+ */
+
+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 PlatformSkillsListResponse = {
+  /**
+   * Skills available to the user.
+   */
+  skills: Array<PlatformSkill>;
+  /**
+   * 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 PlatformSkillsListResponse$inboundSchema: z.ZodType<
+  PlatformSkillsListResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skills: z.array(PlatformSkill$inboundSchema),
+  has_more: z.boolean(),
+  next_cursor: z.nullable(z.string()),
+  request_id: z.string(),
+});
+
+export function platformSkillsListResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillsListResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillsListResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillsListResponse' from JSON`,
+  );
+}

package/src/models/components/platformskillsourceprovenance.ts

@@ -0,0 +1,67 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d205a4ca5eab
+ */
+
+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 {
+  PlatformSkillSyncStatus,
+  PlatformSkillSyncStatus$inboundSchema,
+} from "./platformskillsyncstatus.js";
+
+export type PlatformSkillSourceProvenance = {
+  /**
+   * URL of the external source the skill was imported from.
+   */
+  source_url?: string | undefined;
+  /**
+   * Source commit SHA for the imported skill.
+   */
+  commit_sha?: string | undefined;
+  /**
+   * Time the skill was imported.
+   */
+  imported_at?: Date | undefined;
+  /**
+   * Time the skill was last synced from its source.
+   */
+  last_synced_at?: Date | undefined;
+  /**
+   * Current external-source sync status.
+   */
+  sync_status?: PlatformSkillSyncStatus | undefined;
+  /**
+   * Human-readable sync failure reason, present only when sync_status is SYNC_FAILED.
+   */
+  sync_error?: string | undefined;
+};
+
+/** @internal */
+export const PlatformSkillSourceProvenance$inboundSchema: z.ZodType<
+  PlatformSkillSourceProvenance,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  source_url: z.string().optional(),
+  commit_sha: z.string().optional(),
+  imported_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  last_synced_at: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  sync_status: PlatformSkillSyncStatus$inboundSchema.optional(),
+  sync_error: z.string().optional(),
+});
+
+export function platformSkillSourceProvenanceFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillSourceProvenance, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillSourceProvenance$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillSourceProvenance' from JSON`,
+  );
+}

package/src/models/components/platformskillstatus.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3239e840356d
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Current skill status.
+ */
+export const PlatformSkillStatus = {
+  Draft: "DRAFT",
+  Enabled: "ENABLED",
+  Disabled: "DISABLED",
+} as const;
+/**
+ * Current skill status.
+ */
+export type PlatformSkillStatus = OpenEnum<typeof PlatformSkillStatus>;
+
+/** @internal */
+export const PlatformSkillStatus$inboundSchema: z.ZodType<
+  PlatformSkillStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformSkillStatus);

package/src/models/components/platformskillsyncstatus.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 474e34580f2d
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Current external-source sync status.
+ */
+export const PlatformSkillSyncStatus = {
+  UpToDate: "UP_TO_DATE",
+  UpdateAvailable: "UPDATE_AVAILABLE",
+  SyncFailed: "SYNC_FAILED",
+} as const;
+/**
+ * Current external-source sync status.
+ */
+export type PlatformSkillSyncStatus = OpenEnum<typeof PlatformSkillSyncStatus>;
+
+/** @internal */
+export const PlatformSkillSyncStatus$inboundSchema: z.ZodType<
+  PlatformSkillSyncStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(PlatformSkillSyncStatus);

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 {
+  PlatformSkillValidationWarning,
+  PlatformSkillValidationWarning$inboundSchema,
+} from "./platformskillvalidationwarning.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<PlatformSkillValidationWarning>;
+  /**
+   * 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(PlatformSkillValidationWarning$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/platformskillvalidationwarning.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9f6d3a564161
+ */
+
+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 PlatformSkillValidationWarning = {
+  /**
+   * Stable warning code.
+   */
+  code: string;
+  /**
+   * Human-readable warning message.
+   */
+  message: string;
+};
+
+/** @internal */
+export const PlatformSkillValidationWarning$inboundSchema: z.ZodType<
+  PlatformSkillValidationWarning,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  message: z.string(),
+});
+
+export function platformSkillValidationWarningFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkillValidationWarning, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkillValidationWarning$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkillValidationWarning' 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`,
+  );
+}