@gleanwork/api-client 0.17.1 → 0.17.3

package/src/__tests__/tools.test.ts

@@ -68,3 +68,31 @@ test("Tools Authorize Action Pack", async () => {
   }, "<id>");
   expect(result).toBeDefined();
 });
+
+test("Tools Get Tool Server Auth Status", async () => {
+  const testHttpClient = createTestHTTPClient("getToolServerAuthStatus");
+
+  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.client.tools.retrieveToolServerAuthStatus("<id>");
+  expect(result).toBeDefined();
+});
+
+test("Tools Authorize Tool Server", async () => {
+  const testHttpClient = createTestHTTPClient("authorizeToolServer");
+
+  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.client.tools.authorizeToolServer({
+    returnUrl: "https://lucky-disadvantage.com",
+  }, "<id>");
+  expect(result).toBeDefined();
+});

package/src/funcs/clientToolsAuthorizeToolServer.ts

@@ -0,0 +1,189 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d3f54c35c5a2
+ */
+
+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 * 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 { 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";
+
+/**
+ * Start the OAuth authorization flow for a tool server.
+ *
+ * @remarks
+ * Initiates the third-party OAuth flow for the specified tool server and returns the
+ * authorization URL that the client should navigate the end user to. After the OAuth
+ * callback completes, the user's browser is redirected back to `returnUrl` with query
+ * parameters indicating the result.
+ *
+ * `returnUrl` must match the tenant's configured return URL allowlist; otherwise the
+ * request is rejected with 400.
+ */
+export function clientToolsAuthorizeToolServer(
+  client: GleanCore,
+  authorizeToolServerRequest: components.AuthorizeToolServerRequest,
+  serverId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.AuthorizeToolServerResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    authorizeToolServerRequest,
+    serverId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  authorizeToolServerRequest: components.AuthorizeToolServerRequest,
+  serverId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.AuthorizeToolServerResponse,
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.AuthorizeToolServerRequest = {
+    authorizeToolServerRequest: authorizeToolServerRequest,
+    serverId: serverId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.AuthorizeToolServerRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.AuthorizeToolServerRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    serverId: encodeSimple("serverId", payload.serverId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/rest/api/v1/tool-servers/{serverId}/auth")(
+    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: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "authorizeToolServer",
+    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 [result] = await M.match<
+    components.AuthorizeToolServerResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.AuthorizeToolServerResponse$inboundSchema),
+    M.fail([400, 401, 403, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response, req);
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/clientToolsRetrieveToolServerAuthStatus.ts

@@ -0,0 +1,177 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e991c3e9afec
+ */
+
+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 * 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 { 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";
+
+/**
+ * Get end-user authentication status for a tool server.
+ *
+ * @remarks
+ * Returns display information and the calling user's current authentication status
+ * for the specified tool server.
+ */
+export function clientToolsRetrieveToolServerAuthStatus(
+  client: GleanCore,
+  serverId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.ToolServerAuthStatusResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    serverId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  serverId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.ToolServerAuthStatusResponse,
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.GetToolServerAuthStatusRequest = {
+    serverId: serverId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.GetToolServerAuthStatusRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    serverId: encodeSimple("serverId", payload.serverId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/rest/api/v1/tool-servers/{serverId}/auth")(
+    pathParams,
+  );
+
+  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: "getToolServerAuthStatus",
+    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 [result] = await M.match<
+    components.ToolServerAuthStatusResponse,
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.ToolServerAuthStatusResponse$inboundSchema),
+    M.fail([400, 401, 404, 429, "4XX"]),
+    M.fail("5XX"),
+  )(response, req);
+  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.1",
-  genVersion: "2.915.1",
+  sdkVersion: "0.17.3",
+  genVersion: "2.916.4",
   userAgent:
-    "speakeasy-sdk/typescript 0.17.1 2.915.1 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.17.3 2.916.4 0.9.0 @gleanwork/api-client",
 } as const;

package/src/lib/http.ts

@@ -46,8 +46,10 @@ export class HTTPClient {
   private requestHooks: BeforeRequestHook[] = [];
   private requestErrorHooks: RequestErrorHook[] = [];
   private responseHooks: ResponseHook[] = [];
+  private options: HTTPClientOptions;
 
-  constructor(private options: HTTPClientOptions = {}) {
+  constructor(options: HTTPClientOptions = {}) {
+    this.options = options;
     this.fetcher = options.fetcher || DEFAULT_FETCHER;
   }
 

package/src/lib/security.ts

@@ -14,17 +14,22 @@ type OAuth2PasswordFlow = {
   tokenURL: string;
 };
 
-export enum SecurityErrorCode {
-  Incomplete = "incomplete",
-  UnrecognisedSecurityType = "unrecognized_security_type",
-}
+export const SecurityErrorCode = {
+  Incomplete: "incomplete",
+  UnrecognisedSecurityType: "unrecognized_security_type",
+} as const;
+export type SecurityErrorCode =
+  (typeof SecurityErrorCode)[keyof typeof SecurityErrorCode];
 
 export class SecurityError extends Error {
+  public code: SecurityErrorCode;
+
   constructor(
-    public code: SecurityErrorCode,
+    code: SecurityErrorCode,
     message: string,
   ) {
     super(message);
+    this.code = code;
     this.name = "SecurityError";
   }
 

package/src/models/components/actionpreview.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 225adf458c37
+ */
+
+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";
+
+/**
+ * Preview information for an action being executed.
+ */
+export type ActionPreview = {
+  /**
+   * Markdown preview describing what the action will do.
+   */
+  markdown?: string | undefined;
+  /**
+   * Short summary of what this specific tool invocation will do.
+   */
+  description?: string | undefined;
+};
+
+/** @internal */
+export const ActionPreview$inboundSchema: z.ZodType<
+  ActionPreview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  markdown: z.string().optional(),
+  description: z.string().optional(),
+});
+/** @internal */
+export type ActionPreview$Outbound = {
+  markdown?: string | undefined;
+  description?: string | undefined;
+};
+
+/** @internal */
+export const ActionPreview$outboundSchema: z.ZodType<
+  ActionPreview$Outbound,
+  z.ZodTypeDef,
+  ActionPreview
+> = z.object({
+  markdown: z.string().optional(),
+  description: z.string().optional(),
+});
+
+export function actionPreviewToJSON(actionPreview: ActionPreview): string {
+  return JSON.stringify(ActionPreview$outboundSchema.parse(actionPreview));
+}
+export function actionPreviewFromJSON(
+  jsonString: string,
+): SafeParseResult<ActionPreview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActionPreview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActionPreview' from JSON`,
+  );
+}

package/src/models/components/authcontext.ts

@@ -0,0 +1,56 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e7ecc07941dc
+ */
+
+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";
+
+/**
+ * Context for authentication responses, containing identifiers for the entity being authenticated.
+ *
+ * @remarks
+ */
+export type AuthContext = {
+  /**
+   * ID of the MCP server (populated when toolType is MCP).
+   */
+  serverId?: string | undefined;
+};
+
+/** @internal */
+export const AuthContext$inboundSchema: z.ZodType<
+  AuthContext,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  serverId: z.string().optional(),
+});
+/** @internal */
+export type AuthContext$Outbound = {
+  serverId?: string | undefined;
+};
+
+/** @internal */
+export const AuthContext$outboundSchema: z.ZodType<
+  AuthContext$Outbound,
+  z.ZodTypeDef,
+  AuthContext
+> = z.object({
+  serverId: z.string().optional(),
+});
+
+export function authContextToJSON(authContext: AuthContext): string {
+  return JSON.stringify(AuthContext$outboundSchema.parse(authContext));
+}
+export function authContextFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthContext, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthContext$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthContext' from JSON`,
+  );
+}

package/src/models/components/authorizetoolserverrequest.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: db98d96ed2da
+ */
+
+import * as z from "zod/v3";
+
+export type AuthorizeToolServerRequest = {
+  /**
+   * URL to redirect the end user's browser back to after the OAuth flow completes.
+   *
+   * @remarks
+   * Must be present in the tenant's configured return URL allowlist.
+   */
+  returnUrl: string;
+};
+
+/** @internal */
+export type AuthorizeToolServerRequest$Outbound = {
+  returnUrl: string;
+};
+
+/** @internal */
+export const AuthorizeToolServerRequest$outboundSchema: z.ZodType<
+  AuthorizeToolServerRequest$Outbound,
+  z.ZodTypeDef,
+  AuthorizeToolServerRequest
+> = z.object({
+  returnUrl: z.string(),
+});
+
+export function authorizeToolServerRequestToJSON(
+  authorizeToolServerRequest: AuthorizeToolServerRequest,
+): string {
+  return JSON.stringify(
+    AuthorizeToolServerRequest$outboundSchema.parse(authorizeToolServerRequest),
+  );
+}

package/src/models/components/authorizetoolserverresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 216073fe950b
+ */
+
+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 AuthorizeToolServerResponse = {
+  /**
+   * URL that the client should navigate the end user to in order to begin the OAuth flow.
+   *
+   * @remarks
+   * After the user consents, control returns to `returnUrl` from the request.
+   */
+  authorizationUrl: string;
+};
+
+/** @internal */
+export const AuthorizeToolServerResponse$inboundSchema: z.ZodType<
+  AuthorizeToolServerResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  authorizationUrl: z.string(),
+});
+
+export function authorizeToolServerResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthorizeToolServerResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthorizeToolServerResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthorizeToolServerResponse' from JSON`,
+  );
+}