@gleanwork/api-client 0.18.1 → 0.19.0

package/dist/esm/sdk/triggers.js

@@ -0,0 +1,109 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2b0bc3f627a3
+ */
+import { triggersCreate } from "../funcs/triggersCreate.js";
+import { triggersDelete } from "../funcs/triggersDelete.js";
+import { triggersGet } from "../funcs/triggersGet.js";
+import { triggersGetPreset } from "../funcs/triggersGetPreset.js";
+import { triggersList } from "../funcs/triggersList.js";
+import { triggersListPresetInputValues } from "../funcs/triggersListPresetInputValues.js";
+import { triggersListPresets } from "../funcs/triggersListPresets.js";
+import { triggersSearchEvents } from "../funcs/triggersSearchEvents.js";
+import { triggersSearchPresetEvents } from "../funcs/triggersSearchPresetEvents.js";
+import { triggersUpdate } from "../funcs/triggersUpdate.js";
+import { ClientSDK } from "../lib/sdks.js";
+import { unwrapAsync } from "../types/fp.js";
+export class Triggers extends ClientSDK {
+    /**
+     * Create trigger
+     *
+     * @remarks
+     * Create a trigger from a preset and return it with its signing secret.
+     */
+    async create(request, options) {
+        return unwrapAsync(triggersCreate(this, request, options));
+    }
+    /**
+     * List triggers
+     *
+     * @remarks
+     * List triggers owned by the authenticated caller.
+     */
+    async list(pageSize, cursor, options) {
+        return unwrapAsync(triggersList(this, pageSize, cursor, options));
+    }
+    /**
+     * Get trigger
+     *
+     * @remarks
+     * Retrieve a trigger owned by the authenticated caller.
+     */
+    async get(triggerId, options) {
+        return unwrapAsync(triggersGet(this, triggerId, options));
+    }
+    /**
+     * Update trigger
+     *
+     * @remarks
+     * Update a trigger.
+     */
+    async update(platformTriggerUpdateRequest, triggerId, options) {
+        return unwrapAsync(triggersUpdate(this, platformTriggerUpdateRequest, triggerId, options));
+    }
+    /**
+     * Delete trigger
+     *
+     * @remarks
+     * Delete a trigger.
+     */
+    async delete(triggerId, options) {
+        return unwrapAsync(triggersDelete(this, triggerId, options));
+    }
+    /**
+     * Search events for a trigger
+     *
+     * @remarks
+     * Search recent content events an existing trigger matches. Read-only — no webhook delivery is made. Covers the last seven days.
+     */
+    async searchEvents(triggerId, platformTriggerEventSearchRequest, options) {
+        return unwrapAsync(triggersSearchEvents(this, triggerId, platformTriggerEventSearchRequest, options));
+    }
+    /**
+     * List trigger presets
+     *
+     * @remarks
+     * List the trigger presets available to the caller. A preset is a curated content-trigger template (e.g. a new Jira ticket) which is passed when creating a trigger.
+     */
+    async listPresets(datasource, pageSize, cursor, options) {
+        return unwrapAsync(triggersListPresets(this, datasource, pageSize, cursor, options));
+    }
+    /**
+     * Get trigger preset
+     *
+     * @remarks
+     * Retrieve a single trigger preset by id.
+     */
+    async getPreset(presetId, options) {
+        return unwrapAsync(triggersGetPreset(this, presetId, options));
+    }
+    /**
+     * Search trigger preset input values
+     *
+     * @remarks
+     * Return up to 300 selectable values for a single picklist input on a preset. Results are intended for typeahead selection and are not cursor-paginated. When `is_truncated` is true, refine `query` to narrow the result set.
+     */
+    async listPresetInputValues(presetId, field, query, options) {
+        return unwrapAsync(triggersListPresetInputValues(this, presetId, field, query, options));
+    }
+    /**
+     * Search events for a trigger preset
+     *
+     * @remarks
+     * Search recent content events an unsaved trigger built from this preset would match, to preview it before creating the trigger. Read-only — no trigger is created and no webhook delivery is made. Covers the last seven days.
+     */
+    async searchPresetEvents(presetId, platformTriggerPresetEventSearchRequest, options) {
+        return unwrapAsync(triggersSearchPresetEvents(this, presetId, platformTriggerPresetEventSearchRequest, options));
+    }
+}
+//# sourceMappingURL=triggers.js.map

package/dist/esm/sdk/triggers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"triggers.js","sourceRoot":"","sources":["../../../src/sdk/triggers.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,6BAA6B,EAAE,MAAM,2CAA2C,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AACxE,OAAO,EAAE,0BAA0B,EAAE,MAAM,wCAAwC,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,SAAS,EAAkB,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C,MAAM,OAAO,QAAS,SAAQ,SAAS;IACrC;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,OAAgD,EAChD,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CACR,QAA6B,EAC7B,MAA2B,EAC3B,OAAwB;QAExB,OAAO,WAAW,CAAC,YAAY,CAC7B,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,SAAiB,EACjB,OAAwB;QAExB,OAAO,WAAW,CAAC,WAAW,CAC5B,IAAI,EACJ,SAAS,EACT,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,4BAAqE,EACrE,SAAiB,EACjB,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,4BAA4B,EAC5B,SAAS,EACT,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CACV,SAAiB,EACjB,OAAwB;QAExB,OAAO,WAAW,CAAC,cAAc,CAC/B,IAAI,EACJ,SAAS,EACT,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAChB,SAAiB,EACjB,iCAEa,EACb,OAAwB;QAExB,OAAO,WAAW,CAAC,oBAAoB,CACrC,IAAI,EACJ,SAAS,EACT,iCAAiC,EACjC,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,UAA+B,EAC/B,QAA6B,EAC7B,MAA2B,EAC3B,OAAwB;QAExB,OAAO,WAAW,CAAC,mBAAmB,CACpC,IAAI,EACJ,UAAU,EACV,QAAQ,EACR,MAAM,EACN,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,QAAgB,EAChB,OAAwB;QAExB,OAAO,WAAW,CAAC,iBAAiB,CAClC,IAAI,EACJ,QAAQ,EACR,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,qBAAqB,CACzB,QAAgB,EAChB,KAAa,EACb,KAA0B,EAC1B,OAAwB;QAExB,OAAO,WAAW,CAAC,6BAA6B,CAC9C,IAAI,EACJ,QAAQ,EACR,KAAK,EACL,KAAK,EACL,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB,CACtB,QAAgB,EAChB,uCAEa,EACb,OAAwB;QAExB,OAAO,WAAW,CAAC,0BAA0B,CAC3C,IAAI,EACJ,QAAQ,EACR,uCAAuC,EACvC,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF"}

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@gleanwork/api-client",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gleanwork/api-client",
-  "version": "0.18.1",
+  "version": "0.19.0",
   "author": "Speakeasy",
   "tshy": {
     "sourceDialects": [
@@ -13,6 +13,7 @@
       "./models/errors": "./src/models/errors/index.ts",
       "./models/components": "./src/models/components/index.ts",
       "./models/operations": "./src/models/operations/index.ts",
+      "./models/callbacks": "./src/models/callbacks/index.ts",
       "./react-query": "./src/react-query/index.ts",
       "./*.js": "./src/*.ts",
       "./*": "./src/*.ts"
@@ -119,6 +120,17 @@
         "default": "./dist/commonjs/models/operations/index.js"
       }
     },
+    "./models/callbacks": {
+      "import": {
+        "@gleanwork/api-client/source": "./src/models/callbacks/index.ts",
+        "types": "./dist/esm/models/callbacks/index.d.ts",
+        "default": "./dist/esm/models/callbacks/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/models/callbacks/index.d.ts",
+        "default": "./dist/commonjs/models/callbacks/index.js"
+      }
+    },
     "./react-query": {
       "import": {
         "@gleanwork/api-client/source": "./src/react-query/index.ts",

package/src/__tests__/messages.test.ts

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

package/src/__tests__/summarize.test.ts

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

package/src/__tests__/triggers.test.ts

@@ -0,0 +1,161 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 9325c87699e4
+ */
+
+import { expect, test } from "vitest";
+import { Glean } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Triggers Platform Triggers Create", async () => {
+  const testHttpClient = createTestHTTPClient("platform-triggers-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.triggers.create({
+    preset_id: "GITHUB_1",
+    description: "Reviews I am tagged on, sent to my team's review channel",
+    inputs: {
+      "repository": "acme/payments-api",
+    },
+    delivery: {
+      webhook_url: "https://customer.app/webhook",
+      auth: {
+        type: "BEARER",
+        secret: "secret_test_123",
+      },
+    },
+  });
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Triggers List", async () => {
+  const testHttpClient = createTestHTTPClient("platform-triggers-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.triggers.list();
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Triggers Get", async () => {
+  const testHttpClient = createTestHTTPClient("platform-triggers-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.triggers.get("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Triggers Update", async () => {
+  const testHttpClient = createTestHTTPClient("platform-triggers-update");
+
+  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.triggers.update({
+    status: "ENABLED",
+    description: "Reviews I am tagged on, sent to my team's review channel",
+    inputs: {
+      "repository": "acme/payments-api",
+    },
+    delivery: {
+      webhook_url: "https://customer.app/webhook",
+      auth: {
+        type: "BEARER",
+        secret: "secret_test_123",
+      },
+    },
+  }, "<id>");
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Triggers Events Search", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "platform-triggers-events-search",
+  );
+
+  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.triggers.searchEvents("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Trigger Presets List", async () => {
+  const testHttpClient = createTestHTTPClient("platform-trigger-presets-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.triggers.listPresets();
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Trigger Presets Get", async () => {
+  const testHttpClient = createTestHTTPClient("platform-trigger-presets-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.triggers.getPreset("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Trigger Presets Input Values List", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "platform-trigger-presets-input-values-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.triggers.listPresetInputValues("<id>", "<value>");
+  expect(result).toBeDefined();
+});
+
+test("Triggers Platform Trigger Presets Events Search", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "platform-trigger-presets-events-search",
+  );
+
+  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.triggers.searchPresetEvents("<id>", {
+    inputs: {
+      "repository": "acme/payments-api",
+    },
+  });
+  expect(result).toBeDefined();
+});

package/src/funcs/clientToolsGetToolServerTools.ts

@@ -32,14 +32,15 @@ import { Result } from "../types/fp.js";
  *
  * @remarks
  * Returns the name, description and JSON input schema for the named tools on the
- * specified tool server. Works for both action packs and MCP servers.
+ * specified tool server. Works for Glean's built-in tools, tool packs and MCP
+ * servers.
  *
  * `toolNames` is required. Names that do not exist on the server are returned in
  * `notFound` rather than failing the request, so a single bad name does not force
  * callers into one-at-a-time retries. Matching is case-insensitive and treats `-`
  * and `_` as equivalent.
  *
- * Native tools are not served; `serverId=native` returns 404.
+ * Use `serverId=native` for Glean's built-in tools.
  */
 export function clientToolsGetToolServerTools(
   client: GleanCore,

package/src/funcs/triggersCreate.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: ea9ed652cbea
+ */
+
+import { GleanCore } from "../core.js";
+import { encodeJSON } 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 * 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 { Result } from "../types/fp.js";
+
+/**
+ * Create trigger
+ *
+ * @remarks
+ * Create a trigger from a preset and return it with its signing secret.
+ */
+export function triggersCreate(
+  client: GleanCore,
+  request: components.PlatformTriggerCreateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PlatformTriggerCreateResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  request: components.PlatformTriggerCreateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PlatformTriggerCreateResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.PlatformTriggerCreateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/api/triggers")();
+
+  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: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "platform-triggers-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.PlatformTriggerCreateResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(201, components.PlatformTriggerCreateResponse$inboundSchema),
+    M.jsonErr(
+      [400, 401, 403, 404, 408, 409, 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 }];
+}