@gleanwork/api-client 0.17.3 → 0.18.0

package/src/funcs/skillsRetrieveVersionContent.ts

@@ -0,0 +1,205 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d466e3621984
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Download skill version content
+ *
+ * @remarks
+ * Download the installable bundle for a skill version available to the authenticated user.
+ */
+export function skillsRetrieveVersionContent(
+  client: GleanCore,
+  skillId: string,
+  version: number,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.PlatformSkillsGetVersionContentResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    skillId,
+    version,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  skillId: string,
+  version: number,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.PlatformSkillsGetVersionContentResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PlatformSkillsGetVersionContentRequest = {
+    skill_id: skillId,
+    version: version,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.PlatformSkillsGetVersionContentRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    skill_id: encodeSimple("skill_id", payload.skill_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    version: encodeSimple("version", payload.version, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/skills/{skill_id}/versions/{version}/content")(
+    pathParams,
+  );
+
+  const headers = new Headers(compactMap({
+    Accept: "application/octet-stream",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "platform-skills-get-version-content",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.PlatformSkillsGetVersionContentResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.stream(
+      200,
+      operations.PlatformSkillsGetVersionContentResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr(
+      [400, 401, 403, 404, 408, 429],
+      errors.PlatformProblemDetailError$inboundSchema,
+      { ctype: "application/problem+json" },
+    ),
+    M.jsonErr([500, 503], errors.PlatformProblemDetailError$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/skillsValidate.ts

@@ -0,0 +1,212 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4fe727b61c05
+ */
+
+import { GleanCore } from "../core.js";
+import { appendForm, normalizeBlob } from "../lib/encodings.js";
+import {
+  bytesToBlob,
+  getContentTypeFromFileName,
+  readableStreamToArrayBuffer,
+} from "../lib/files.js";
+import { matchStatusCode } from "../lib/http.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import * as components from "../models/components/index.js";
+import { GleanBaseError } from "../models/errors/gleanbaseerror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { isBlobLike } from "../types/blobs.js";
+import { Result } from "../types/fp.js";
+import { isReadableStream } from "../types/streams.js";
+
+/**
+ * Validate skill bundle
+ *
+ * @remarks
+ * Validate a skill bundle without persisting it. Accepts a SKILL.md, .zip, or .skill upload and returns parsed metadata plus the normalized file layout.
+ */
+export function skillsValidate(
+  client: GleanCore,
+  request: components.PlatformSkillValidationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PlatformSkillValidationResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  request: components.PlatformSkillValidationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PlatformSkillValidationResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.PlatformSkillValidationRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = new FormData();
+
+  if (isBlobLike(payload.file)) {
+    const file = payload.file;
+    const blob = await normalizeBlob(file);
+    const name = "name" in file ? (file.name as string) : undefined;
+    appendForm(body, "file", blob, name);
+  } else if (isReadableStream(payload.file.content)) {
+    const buffer = await readableStreamToArrayBuffer(payload.file.content);
+    const contentType = getContentTypeFromFileName(payload.file.fileName)
+      || "application/octet-stream";
+    appendForm(
+      body,
+      "file",
+      bytesToBlob(buffer, contentType),
+      payload.file.fileName,
+    );
+  } else {
+    const contentType = getContentTypeFromFileName(payload.file.fileName)
+      || "application/octet-stream";
+    appendForm(
+      body,
+      "file",
+      bytesToBlob(payload.file.content, contentType),
+      payload.file.fileName,
+    );
+  }
+
+  const path = pathToFunc("/api/skills/validation")();
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiToken);
+  const securityInput = secConfig == null ? {} : { apiToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "platform-skills-validate",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["4XX", "5XX"]),
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    components.PlatformSkillValidationResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PlatformSkillValidationResponse$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 408, 413, 429],
+      errors.PlatformProblemDetailError$inboundSchema,
+      { ctype: "application/problem+json" },
+    ),
+    M.jsonErr([500, 503], errors.PlatformProblemDetailError$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/lib/config.ts

@@ -73,8 +73,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.9.0",
-  sdkVersion: "0.17.3",
-  genVersion: "2.916.4",
+  sdkVersion: "0.18.0",
+  genVersion: "2.918.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.17.3 2.916.4 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.18.0 2.918.4 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/dlpfindingfilter.ts

@@ -32,7 +32,7 @@ export type DlpFindingFilter = {
   visibility?: string | undefined;
   documentIds?: Array<string> | undefined;
   /**
-   * Severity levels for DLP findings and analyses.
+   * Severity levels for DLP findings and analyses. FALSE_POSITIVE ranks below LOW and marks analyses that concluded every flagged entity is a detector false positive.
    */
   severity?: DlpSeverity | undefined;
   documentSeverity?: Array<DlpSeverity> | undefined;

package/src/models/components/dlpissuefilter.ts

@@ -37,17 +37,50 @@ export type DlpIssueFilter = {
    */
   statuses?: Array<DlpIssueStatus> | undefined;
   /**
-   * Filter by assignee user ID.
+   * Filter by a single assignee user ID. Deprecated; use assigneeIds.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
    */
   assigneeId?: string | undefined;
+  /**
+   * Filter by one or more assignee user IDs. Use the sentinel value "UNASSIGNED" to match issues with no assignee.
+   */
+  assigneeIds?: Array<string> | undefined;
+  /**
+   * Filter by a single built-in info type. Deprecated; use infoTypes.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   infoType?: string | undefined;
+  /**
+   * Filter by one or more built-in info types.
+   */
+  infoTypes?: Array<string> | undefined;
+  /**
+   * Filter by a single regex rule ID. Deprecated; use regexIds.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   regexId?: string | undefined;
+  /**
+   * Filter by one or more regex rule IDs.
+   */
+  regexIds?: Array<string> | undefined;
   /**
    * Filter by one or more report/policy IDs.
    */
   reportIds?: Array<string> | undefined;
   docId?: string | undefined;
+  /**
+   * Filter by a single datasource. Deprecated; use datasources.
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
   datasource?: string | undefined;
+  /**
+   * Filter by one or more datasources.
+   */
+  datasources?: Array<string> | undefined;
   visibility?: string | undefined;
   /**
    * Filter by one or more severity levels.
@@ -65,11 +98,15 @@ export const DlpIssueFilter$inboundSchema: z.ZodType<
   searchText: z.string().optional(),
   statuses: z.array(DlpIssueStatus$inboundSchema).optional(),
   assigneeId: z.string().optional(),
+  assigneeIds: z.array(z.string()).optional(),
   infoType: z.string().optional(),
+  infoTypes: z.array(z.string()).optional(),
   regexId: z.string().optional(),
+  regexIds: z.array(z.string()).optional(),
   reportIds: z.array(z.string()).optional(),
   docId: z.string().optional(),
   datasource: z.string().optional(),
+  datasources: z.array(z.string()).optional(),
   visibility: z.string().optional(),
   severities: z.array(DlpSeverity$inboundSchema).optional(),
   timeRange: TimeRangeFilter$inboundSchema.optional(),
@@ -79,11 +116,15 @@ export type DlpIssueFilter$Outbound = {
   searchText?: string | undefined;
   statuses?: Array<string> | undefined;
   assigneeId?: string | undefined;
+  assigneeIds?: Array<string> | undefined;
   infoType?: string | undefined;
+  infoTypes?: Array<string> | undefined;
   regexId?: string | undefined;
+  regexIds?: Array<string> | undefined;
   reportIds?: Array<string> | undefined;
   docId?: string | undefined;
   datasource?: string | undefined;
+  datasources?: Array<string> | undefined;
   visibility?: string | undefined;
   severities?: Array<string> | undefined;
   timeRange?: TimeRangeFilter$Outbound | undefined;
@@ -98,11 +139,15 @@ export const DlpIssueFilter$outboundSchema: z.ZodType<
   searchText: z.string().optional(),
   statuses: z.array(DlpIssueStatus$outboundSchema).optional(),
   assigneeId: z.string().optional(),
+  assigneeIds: z.array(z.string()).optional(),
   infoType: z.string().optional(),
+  infoTypes: z.array(z.string()).optional(),
   regexId: z.string().optional(),
+  regexIds: z.array(z.string()).optional(),
   reportIds: z.array(z.string()).optional(),
   docId: z.string().optional(),
   datasource: z.string().optional(),
+  datasources: z.array(z.string()).optional(),
   visibility: z.string().optional(),
   severities: z.array(DlpSeverity$outboundSchema).optional(),
   timeRange: TimeRangeFilter$outboundSchema.optional(),

package/src/models/components/dlpseverity.ts

@@ -8,16 +8,17 @@ import * as openEnums from "../../types/enums.js";
 import { OpenEnum } from "../../types/enums.js";
 
 /**
- * Severity levels for DLP findings and analyses.
+ * Severity levels for DLP findings and analyses. FALSE_POSITIVE ranks below LOW and marks analyses that concluded every flagged entity is a detector false positive.
  */
 export const DlpSeverity = {
   Unspecified: "UNSPECIFIED",
   Low: "LOW",
   Medium: "MEDIUM",
   High: "HIGH",
+  FalsePositive: "FALSE_POSITIVE",
 } as const;
 /**
- * Severity levels for DLP findings and analyses.
+ * Severity levels for DLP findings and analyses. FALSE_POSITIVE ranks below LOW and marks analyses that concluded every flagged entity is a detector false positive.
  */
 export type DlpSeverity = OpenEnum<typeof DlpSeverity>;
 

package/src/models/components/index.ts

@@ -367,6 +367,25 @@ export * from "./platformproblemdetailerror.js";
 export * from "./platformresult.js";
 export * from "./platformsearchrequest.js";
 export * from "./platformsearchresponse.js";
+export * from "./platformskill.js";
+export * from "./platformskillcreaterequest.js";
+export * from "./platformskillcreateresponse.js";
+export * from "./platformskillgetresponse.js";
+export * from "./platformskillorigin.js";
+export * from "./platformskillslistresponse.js";
+export * from "./platformskillsourceprovenance.js";
+export * from "./platformskillstatus.js";
+export * from "./platformskillsyncstatus.js";
+export * from "./platformskillvalidationfile.js";
+export * from "./platformskillvalidationmetadata.js";
+export * from "./platformskillvalidationrequest.js";
+export * from "./platformskillvalidationresponse.js";
+export * from "./platformskillvalidationwarning.js";
+export * from "./platformskillversion.js";
+export * from "./platformskillversioncreaterequest.js";
+export * from "./platformskillversioncreateresponse.js";
+export * from "./platformskillversiongetresponse.js";
+export * from "./platformskillversionslistresponse.js";
 export * from "./platformtimerange.js";
 export * from "./possiblevalue.js";
 export * from "./processalldocumentsrequest.js";

package/src/models/components/platformskill.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d34696ea810b
+ */
+
+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 {
+  PlatformSkillOrigin,
+  PlatformSkillOrigin$inboundSchema,
+} from "./platformskillorigin.js";
+import {
+  PlatformSkillSourceProvenance,
+  PlatformSkillSourceProvenance$inboundSchema,
+} from "./platformskillsourceprovenance.js";
+import {
+  PlatformSkillStatus,
+  PlatformSkillStatus$inboundSchema,
+} from "./platformskillstatus.js";
+
+export type PlatformSkill = {
+  /**
+   * Glean skill ID.
+   */
+  id: string;
+  /**
+   * Human-readable skill name.
+   */
+  display_name: string;
+  /**
+   * Human-readable skill description.
+   */
+  description: string;
+  /**
+   * Latest major version number for the skill.
+   */
+  latest_version: number;
+  /**
+   * Latest minor version number for the skill.
+   */
+  latest_minor_version: number;
+  /**
+   * Current skill status.
+   */
+  status: PlatformSkillStatus;
+  /**
+   * Source category for the skill.
+   */
+  origin: PlatformSkillOrigin;
+  source_provenance?: PlatformSkillSourceProvenance | undefined;
+  /**
+   * A lightweight reference to a person, used where a payload merely points at someone.
+   */
+  owner: PlatformPersonReference;
+  /**
+   * Time the skill was created.
+   */
+  created_at: Date;
+  /**
+   * Time the skill was last updated.
+   */
+  updated_at: Date;
+};
+
+/** @internal */
+export const PlatformSkill$inboundSchema: z.ZodType<
+  PlatformSkill,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  display_name: z.string(),
+  description: z.string(),
+  latest_version: z.number().int(),
+  latest_minor_version: z.number().int(),
+  status: PlatformSkillStatus$inboundSchema,
+  origin: PlatformSkillOrigin$inboundSchema,
+  source_provenance: PlatformSkillSourceProvenance$inboundSchema.optional(),
+  owner: 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)),
+});
+
+export function platformSkillFromJSON(
+  jsonString: string,
+): SafeParseResult<PlatformSkill, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PlatformSkill$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PlatformSkill' from JSON`,
+  );
+}