@gleanwork/api-client 0.17.3 → 0.18.0

package/src/__tests__/indexingdatasources.test.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: c775ecfeae09
+ */
+
+import { expect, test } from "vitest";
+import { Glean } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Indexing Datasources Post /Rest/api/index/submissions/{datasource Instance}/{type}", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "post_/rest/api/index/submissions/{datasourceInstance}/{type}",
+  );
+
+  const glean = new Glean({
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.indexing.datasources.submit(
+    {
+      "key": "<value>",
+      "key1": "<value>",
+      "key2": "<value>",
+    },
+    "<value>",
+    "<value>",
+    {
+      serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    },
+  );
+  expect(result).toBeDefined();
+});

package/src/__tests__/messages.test.ts

@@ -20,7 +20,7 @@ test("Messages Messages", async () => {
     idType: "CONVERSATION_ID",
     id: "<id>",
     timestampMillis: 558834,
-    datasource: "SLACK",
+    datasource: "GCHAT",
   });
   expect(result).toBeDefined();
 });

package/src/__tests__/skills.test.ts

@@ -0,0 +1,143 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 3fa6e540c659
+ */
+
+import { expect, test } from "vitest";
+import { Glean } from "../index.js";
+import { filesToStream } from "./files.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Skills Platform Skills Create", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-create");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.create({
+    file: {
+      fileName: "example.file",
+      content: filesToStream(".speakeasy/testfiles/example.file"),
+    },
+  });
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills List", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-list");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.list();
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills Validate", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-validate");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.validate({
+    file: {
+      fileName: "example.file",
+      content: filesToStream(".speakeasy/testfiles/example.file"),
+    },
+  });
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills Get", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-get");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.retrieve("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills Get Content", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-get-content");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.retrieveContent("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills Create Version", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-create-version");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.createVersion({
+    file: {
+      fileName: "example.file",
+      content: filesToStream(".speakeasy/testfiles/example.file"),
+    },
+  }, "<id>");
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills List Versions", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-list-versions");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.listVersions("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills Get Version", async () => {
+  const testHttpClient = createTestHTTPClient("platform-skills-get-version");
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.retrieveVersion("<id>", 495658);
+  expect(result).toBeDefined();
+});
+
+test("Skills Platform Skills Get Version Content", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "platform-skills-get-version-content",
+  );
+
+  const glean = new Glean({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    apiToken: process.env["GLEAN_API_TOKEN"] ?? "value",
+  });
+
+  const result = await glean.skills.retrieveVersionContent("<id>", 117760);
+  expect(result).toBeDefined();
+});

package/src/__tests__/summarize.test.ts

@@ -19,10 +19,11 @@ test("Summarize Summarize", async () => {
   const result = await glean.client.documents.summarize({
     documentSpecs: [
       {
-        url: "https://dim-glider.com/",
+        ugcType: "COLLECTIONS",
+        contentId: 252303,
       },
       {
-        id: "<id>",
+        url: "https://shocked-casket.name/",
       },
     ],
   });

package/src/funcs/indexingDatasourcesSubmit.ts

@@ -0,0 +1,215 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: fdcdfc496303
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeJSON, 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 { PostRestApiIndexSubmissionsDatasourceInstanceTypeServerList } from "../models/operations/postrestapiindexsubmissionsdatasourceinstancetype.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Submit datasource data
+ *
+ * @remarks
+ * Validates and asynchronously processes a datasource-specific submission.
+ */
+export function indexingDatasourcesSubmit(
+  client: GleanCore,
+  requestBody: { [k: string]: any },
+  datasourceInstance: string,
+  type: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse,
+    | errors.ErrorInfoResponse
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    requestBody,
+    datasourceInstance,
+    type,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  requestBody: { [k: string]: any },
+  datasourceInstance: string,
+  type: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse,
+      | errors.ErrorInfoResponse
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input:
+    operations.PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest = {
+      requestBody: requestBody,
+      datasourceInstance: datasourceInstance,
+      type: type,
+    };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations
+        .PostRestApiIndexSubmissionsDatasourceInstanceTypeRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.RequestBody, { explode: true });
+
+  const baseURL = options?.serverURL
+    || pathToFunc(
+      PostRestApiIndexSubmissionsDatasourceInstanceTypeServerList[0],
+      { charEncoding: "percent" },
+    )({
+      instance: "instance-name",
+    });
+
+  const pathParams = {
+    datasourceInstance: encodeSimple(
+      "datasourceInstance",
+      payload.datasourceInstance,
+      { explode: false, charEncoding: "percent" },
+    ),
+    type: encodeSimple("type", payload.type, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc(
+    "/rest/api/index/submissions/{datasourceInstance}/{type}",
+  )(pathParams);
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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: baseURL ?? "",
+    operationID: "post_/rest/api/index/submissions/{datasourceInstance}/{type}",
+    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: baseURL,
+    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.PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse,
+    | errors.ErrorInfoResponse
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      202,
+      operations
+        .PostRestApiIndexSubmissionsDatasourceInstanceTypeResponse$inboundSchema,
+    ),
+    M.jsonErr([400, 401, 404], errors.ErrorInfoResponse$inboundSchema),
+    M.jsonErr(500, errors.ErrorInfoResponse$inboundSchema),
+    M.fail([405, 413, "4XX"]),
+    M.fail([503, "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/skillsCreate.ts

@@ -0,0 +1,212 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 58256c9d32bf
+ */
+
+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";
+
+/**
+ * Create skill
+ *
+ * @remarks
+ * Create a skill from an uploaded SKILL.md, .zip, or .skill bundle. If the authenticated user already has a skill with the same name, the existing skill is superseded with a new version.
+ */
+export function skillsCreate(
+  client: GleanCore,
+  request: components.PlatformSkillCreateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PlatformSkillCreateResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  request: components.PlatformSkillCreateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PlatformSkillCreateResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.PlatformSkillCreateRequest$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")();
+
+  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-create",
+    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.PlatformSkillCreateResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PlatformSkillCreateResponse$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 }];
+}