@gleanwork/api-client 0.18.0 → 0.18.1

package/src/funcs/skillsUpdate.ts

@@ -0,0 +1,197 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 4f45a2e98be7
+ */
+
+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 * 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";
+
+/**
+ * Update skill
+ *
+ * @remarks
+ * Update mutable metadata for a skill. V1 supports enabling or disabling a skill without changing its content.
+ */
+export function skillsUpdate(
+  client: GleanCore,
+  platformSkillUpdateRequest: components.PlatformSkillUpdateRequest,
+  skillId: string,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.PlatformSkillUpdateResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    platformSkillUpdateRequest,
+    skillId,
+    options,
+  ));
+}
+
+async function $do(
+  client: GleanCore,
+  platformSkillUpdateRequest: components.PlatformSkillUpdateRequest,
+  skillId: string,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.PlatformSkillUpdateResponse,
+      | errors.PlatformProblemDetailError
+      | GleanBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const input: operations.PlatformSkillsUpdateRequest = {
+    platformSkillUpdateRequest: platformSkillUpdateRequest,
+    skill_id: skillId,
+  };
+
+  const parsed = safeParse(
+    input,
+    (value) =>
+      operations.PlatformSkillsUpdateRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.PlatformSkillUpdateRequest, {
+    explode: true,
+  });
+
+  const pathParams = {
+    skill_id: encodeSimple("skill_id", payload.skill_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path = pathToFunc("/api/skills/{skill_id}")(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: "platform-skills-update",
+    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: "PATCH",
+    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.PlatformSkillUpdateResponse,
+    | errors.PlatformProblemDetailError
+    | GleanBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.PlatformSkillUpdateResponse$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 }];
+}

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.18.0",
-  genVersion: "2.918.4",
+  sdkVersion: "0.18.1",
+  genVersion: "2.927.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.18.0 2.918.4 0.9.0 @gleanwork/api-client",
+    "speakeasy-sdk/typescript 0.18.1 2.927.0 0.9.0 @gleanwork/api-client",
 } as const;

package/src/models/components/accessrequestpermissiondeniedresponseerror.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 22b93e030acc
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AccessRequestPermissionDeniedResponseErrorType = {
+  PermissionDenied: "PERMISSION_DENIED",
+} as const;
+export type AccessRequestPermissionDeniedResponseErrorType = ClosedEnum<
+  typeof AccessRequestPermissionDeniedResponseErrorType
+>;
+
+/** @internal */
+export const AccessRequestPermissionDeniedResponseErrorType$inboundSchema:
+  z.ZodNativeEnum<typeof AccessRequestPermissionDeniedResponseErrorType> = z
+    .nativeEnum(AccessRequestPermissionDeniedResponseErrorType);

package/src/models/components/authconfig.ts

@@ -64,18 +64,57 @@ export const AuthConfigStatus = {
 export type AuthConfigStatus = OpenEnum<typeof AuthConfigStatus>;
 
 /**
- * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. client_secret_post sends credentials as form fields, client_secret_basic sends them via Authorization header, none omits client secret and relies on PKCE only. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
+ * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
  */
 export const TokenEndpointAuthMethod = {
+  /**
+   * Send client_id and client_secret as form fields in the token request body.
+   */
   ClientSecretPost: "client_secret_post",
+  /**
+   * Send client_id and client_secret via the HTTP Basic Authorization header.
+   */
   ClientSecretBasic: "client_secret_basic",
+  /**
+   * Public client - omit the client secret and authenticate with the PKCE code_verifier only.
+   */
   None: "none",
+  /**
+   * Authenticate with a JWT client assertion signed by the client's private key (RFC 7523 Section 2.2 / OIDC Core Section 9). Requires a key pair pre-registered with the authorization server.
+   */
+  PrivateKeyJwt: "private_key_jwt",
 } as const;
 /**
- * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. client_secret_post sends credentials as form fields, client_secret_basic sends them via Authorization header, none omits client secret and relies on PKCE only. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
+ * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
  */
 export type TokenEndpointAuthMethod = OpenEnum<typeof TokenEndpointAuthMethod>;
 
+/**
+ * Defines the header structure for sending the API key or token to the server. Defaults to AUTHORIZATION_BEARER. Select the specific header format the server expects for transmitting the key.
+ */
+export const AuthHeaderType = {
+  /**
+   * Sends "Authorization: Bearer <key>".
+   */
+  AuthorizationBearer: "AUTHORIZATION_BEARER",
+  /**
+   * Sends "Authorization: Token <key>".
+   */
+  AuthorizationToken: "AUTHORIZATION_TOKEN",
+  /**
+   * Sends "Authorization: ApiKey <key>".
+   */
+  AuthorizationApiKey: "AUTHORIZATION_API_KEY",
+  /**
+   * Sends "X-API-Key: <key>". No Authorization header is sent.
+   */
+  XApiKey: "X_API_KEY",
+} as const;
+/**
+ * Defines the header structure for sending the API key or token to the server. Defaults to AUTHORIZATION_BEARER. Select the specific header format the server expects for transmitting the key.
+ */
+export type AuthHeaderType = OpenEnum<typeof AuthHeaderType>;
+
 /**
  * Config for tool's authentication method.
  */
@@ -127,9 +166,13 @@ export type AuthConfig = {
    */
   resource?: string | undefined;
   /**
-   * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. client_secret_post sends credentials as form fields, client_secret_basic sends them via Authorization header, none omits client secret and relies on PKCE only. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
+   * The OAuth 2.0 token endpoint authentication method (RFC 7591). Determines how the client authenticates when exchanging an authorization code for a token. Values use lowercase to match the OAuth 2.0 wire format (RFC 7591 Section 2).
    */
   token_endpoint_auth_method?: TokenEndpointAuthMethod | undefined;
+  /**
+   * Defines the header structure for sending the API key or token to the server. Defaults to AUTHORIZATION_BEARER. Select the specific header format the server expects for transmitting the key.
+   */
+  authHeaderType?: AuthHeaderType | undefined;
   /**
    * The time the tool was last authorized in ISO format (ISO 8601).
    */
@@ -188,6 +231,19 @@ export const TokenEndpointAuthMethod$outboundSchema: z.ZodType<
   TokenEndpointAuthMethod
 > = openEnums.outboundSchema(TokenEndpointAuthMethod);
 
+/** @internal */
+export const AuthHeaderType$inboundSchema: z.ZodType<
+  AuthHeaderType,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(AuthHeaderType);
+/** @internal */
+export const AuthHeaderType$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  AuthHeaderType
+> = openEnums.outboundSchema(AuthHeaderType);
+
 /** @internal */
 export const AuthConfig$inboundSchema: z.ZodType<
   AuthConfig,
@@ -205,6 +261,7 @@ export const AuthConfig$inboundSchema: z.ZodType<
   authorization_url: z.string().optional(),
   resource: z.string().optional(),
   token_endpoint_auth_method: TokenEndpointAuthMethod$inboundSchema.optional(),
+  authHeaderType: AuthHeaderType$inboundSchema.optional(),
   lastAuthorizedAt: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ).optional(),
@@ -222,6 +279,7 @@ export type AuthConfig$Outbound = {
   authorization_url?: string | undefined;
   resource?: string | undefined;
   token_endpoint_auth_method?: string | undefined;
+  authHeaderType?: string | undefined;
   lastAuthorizedAt?: string | undefined;
 };
 
@@ -242,6 +300,7 @@ export const AuthConfig$outboundSchema: z.ZodType<
   authorization_url: z.string().optional(),
   resource: z.string().optional(),
   token_endpoint_auth_method: TokenEndpointAuthMethod$outboundSchema.optional(),
+  authHeaderType: AuthHeaderType$outboundSchema.optional(),
   lastAuthorizedAt: z.date().transform(v => v.toISOString()).optional(),
 });
 

package/src/models/components/customdatasourceconfig.ts

@@ -50,6 +50,8 @@ export const DatasourceCategory = {
   Entity: "ENTITY",
   Calendar: "CALENDAR",
   Agents: "AGENTS",
+  AiConversation: "AI_CONVERSATION",
+  AiArtifact: "AI_ARTIFACT",
 } as const;
 /**
  * The type of this datasource. It is an important signal for relevance and must be specified and cannot be UNCATEGORIZED. Please refer to [this](https://developers.glean.com/docs/indexing_api_datasource_category/) for more details.

package/src/models/components/feedentry.ts

@@ -108,6 +108,7 @@ export const JustificationType = {
   StarterKitOrgChart: "STARTER_KIT_ORG_CHART",
   StarterKitAddDoc: "STARTER_KIT_ADD_DOC",
   MeetingRecap: "MEETING_RECAP",
+  MeetingPrepAutomation: "MEETING_PREP_AUTOMATION",
   ActiveDiscussion: "ACTIVE_DISCUSSION",
   MidDayCatchUp: "MID_DAY_CATCH_UP",
   QuerySuggestion: "QUERY_SUGGESTION",

package/src/models/components/feedrequest.ts

@@ -47,6 +47,7 @@ export const FeedRequestCategory = {
   PlanMyDay: "PLAN_MY_DAY",
   EndMyDay: "END_MY_DAY",
   StarterKit: "STARTER_KIT",
+  MeetingPrepAutomation: "MEETING_PREP_AUTOMATION",
   MidDayCatchUp: "MID_DAY_CATCH_UP",
   QuerySuggestion: "QUERY_SUGGESTION",
   CoworkCujPromo: "COWORK_CUJ_PROMO",

package/src/models/components/feedresult.ts

@@ -45,6 +45,7 @@ export const FeedResultCategory = {
   PlanMyDay: "PLAN_MY_DAY",
   EndMyDay: "END_MY_DAY",
   StarterKit: "STARTER_KIT",
+  MeetingPrepAutomation: "MEETING_PREP_AUTOMATION",
   MidDayCatchUp: "MID_DAY_CATCH_UP",
   QuerySuggestion: "QUERY_SUGGESTION",
   CoworkCujPromo: "COWORK_CUJ_PROMO",

package/src/models/components/importagentrequest.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 85de0a4396af
+ */
+
+import * as z from "zod/v3";
+import { blobLikeSchema } from "../../types/blobs.js";
+import {
+  ImportAgentSyncMode,
+  ImportAgentSyncMode$outboundSchema,
+} from "./importagentsyncmode.js";
+
+export type Bundle = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+export type ImportAgentRequest = {
+  /**
+   * Zip of the agent folder (spec.yaml, instructions.md, skills/, subagents/) with symlinks dereferenced.
+   *
+   * @remarks
+   */
+  bundle: Bundle | Blob;
+  /**
+   * Optional Git commit SHA to associate with this import.
+   */
+  gitCommitSha?: string | undefined;
+  /**
+   * Optional VCS commit author ID to associate with this import.
+   */
+  gitAuthorId?: string | undefined;
+  /**
+   * Optional commit message for the imported version.
+   */
+  commitMessage?: string | undefined;
+  /**
+   * Whether the imported version is staged (saved without updating the live version) or published directly to the live version.
+   *
+   * @remarks
+   */
+  syncMode?: ImportAgentSyncMode | undefined;
+  /**
+   * When true, validates and stores a draft preview without publishing (used for PR preview links). Takes precedence over `syncMode`: when `isDraft` is true, `syncMode` is ignored.
+   *
+   * @remarks
+   */
+  isDraft?: boolean | undefined;
+};
+
+/** @internal */
+export type Bundle$Outbound = {
+  fileName: string;
+  content: ReadableStream<Uint8Array> | Blob | ArrayBuffer | Uint8Array;
+};
+
+/** @internal */
+export const Bundle$outboundSchema: z.ZodType<
+  Bundle$Outbound,
+  z.ZodTypeDef,
+  Bundle
+> = z.object({
+  fileName: z.string(),
+  content: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(Blob),
+    z.instanceof(ArrayBuffer),
+    z.instanceof(Uint8Array),
+  ]),
+});
+
+export function bundleToJSON(bundle: Bundle): string {
+  return JSON.stringify(Bundle$outboundSchema.parse(bundle));
+}
+
+/** @internal */
+export type ImportAgentRequest$Outbound = {
+  bundle: Bundle$Outbound | Blob;
+  gitCommitSha?: string | undefined;
+  gitAuthorId?: string | undefined;
+  commitMessage?: string | undefined;
+  syncMode?: string | undefined;
+  isDraft?: boolean | undefined;
+};
+
+/** @internal */
+export const ImportAgentRequest$outboundSchema: z.ZodType<
+  ImportAgentRequest$Outbound,
+  z.ZodTypeDef,
+  ImportAgentRequest
+> = z.object({
+  bundle: z.lazy(() => Bundle$outboundSchema).or(blobLikeSchema),
+  gitCommitSha: z.string().optional(),
+  gitAuthorId: z.string().optional(),
+  commitMessage: z.string().optional(),
+  syncMode: ImportAgentSyncMode$outboundSchema.optional(),
+  isDraft: z.boolean().optional(),
+});
+
+export function importAgentRequestToJSON(
+  importAgentRequest: ImportAgentRequest,
+): string {
+  return JSON.stringify(
+    ImportAgentRequest$outboundSchema.parse(importAgentRequest),
+  );
+}

package/src/models/components/importagentresponse.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: d131f4a57b51
+ */
+
+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 {
+  ImportAgentStatus,
+  ImportAgentStatus$inboundSchema,
+} from "./importagentstatus.js";
+import {
+  WorkflowResult,
+  WorkflowResult$inboundSchema,
+} from "./workflowresult.js";
+
+export type ImportAgentResponse = {
+  workflowResult?: WorkflowResult | undefined;
+  /**
+   * Outcome of the import for the target agent.
+   */
+  status?: ImportAgentStatus | undefined;
+};
+
+/** @internal */
+export const ImportAgentResponse$inboundSchema: z.ZodType<
+  ImportAgentResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  workflowResult: WorkflowResult$inboundSchema.optional(),
+  status: ImportAgentStatus$inboundSchema.optional(),
+});
+
+export function importAgentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ImportAgentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImportAgentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImportAgentResponse' from JSON`,
+  );
+}

package/src/models/components/importagentstatus.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 5d87791473ed
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * Outcome of the import for the target agent.
+ */
+export const ImportAgentStatus = {
+  Created: "CREATED",
+  Updated: "UPDATED",
+  DraftPreview: "DRAFT_PREVIEW",
+} as const;
+/**
+ * Outcome of the import for the target agent.
+ */
+export type ImportAgentStatus = OpenEnum<typeof ImportAgentStatus>;
+
+/** @internal */
+export const ImportAgentStatus$inboundSchema: z.ZodType<
+  ImportAgentStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ImportAgentStatus);

package/src/models/components/importagentsyncmode.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 58982746383b
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Whether the imported version is staged (saved without updating the live version) or published directly to the live version.
+ *
+ * @remarks
+ */
+export const ImportAgentSyncMode = {
+  Staged: "STAGED",
+  Published: "PUBLISHED",
+} as const;
+/**
+ * Whether the imported version is staged (saved without updating the live version) or published directly to the live version.
+ *
+ * @remarks
+ */
+export type ImportAgentSyncMode = ClosedEnum<typeof ImportAgentSyncMode>;
+
+/** @internal */
+export const ImportAgentSyncMode$outboundSchema: z.ZodNativeEnum<
+  typeof ImportAgentSyncMode
+> = z.nativeEnum(ImportAgentSyncMode);