@gleanwork/api-client 0.14.18 → 0.15.0

package/src/models/components/successresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: e0274c664fba
+ */
+
+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";
+
+/**
+ * Success response for custom metadata operations
+ */
+export type SuccessResponse = {
+  /**
+   * Indicates if the operation was successful
+   */
+  success: boolean;
+};
+
+/** @internal */
+export const SuccessResponse$inboundSchema: z.ZodType<
+  SuccessResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean().default(true),
+});
+
+export function successResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<SuccessResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SuccessResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SuccessResponse' from JSON`,
+  );
+}

package/src/models/components/ugctype.ts

@@ -25,6 +25,8 @@ export const UgcType = {
   ShortcutsType: "SHORTCUTS_TYPE",
   SlideType: "SLIDE_TYPE",
   SpreadsheetType: "SPREADSHEET_TYPE",
+  InlineHtmlType: "INLINE_HTML_TYPE",
+  PodcastType: "PODCAST_TYPE",
   WorkflowsType: "WORKFLOWS_TYPE",
 } as const;
 export type UgcType = OpenEnum<typeof UgcType>;

package/src/models/components/workflow.ts

@@ -31,12 +31,25 @@ export type Workflow = {
    * Server Unix timestamp of the last time the draft was saved.
    */
   lastDraftSavedAt?: number | undefined;
+  lastDraftSavedBy?: Person | undefined;
+  /**
+   * ID of the VCS user (e.g. GitHub username) who last saved the draft. Set only by the draft save path via the external Git integration API.
+   */
+  lastDraftGitAuthorId?: string | undefined;
   lastUpdatedBy?: Person | undefined;
   permissions?: ObjectPermissions | undefined;
   /**
    * The ID of the workflow.
    */
   id?: string | undefined;
+  /**
+   * When present, indicates this workflow is admin-verified. Set via the dedicated admin settings endpoint, not by regular edits.
+   */
+  verified?: boolean | undefined;
+  /**
+   * When true, displays organization name instead of author name in agent card. Set via the dedicated admin settings endpoint, not by regular edits.
+   */
+  showOrganizationAsAuthor?: boolean | undefined;
 };
 
 /** @internal */
@@ -50,9 +63,13 @@ export const Workflow$inboundSchema: z.ZodType<
   createTimestamp: z.number().int().optional(),
   lastUpdateTimestamp: z.number().int().optional(),
   lastDraftSavedAt: z.number().int().optional(),
+  lastDraftSavedBy: Person$inboundSchema.optional(),
+  lastDraftGitAuthorId: z.string().optional(),
   lastUpdatedBy: Person$inboundSchema.optional(),
   permissions: ObjectPermissions$inboundSchema.optional(),
   id: z.string().optional(),
+  verified: z.boolean().optional(),
+  showOrganizationAsAuthor: z.boolean().optional(),
 });
 
 export function workflowFromJSON(

package/src/models/errors/errorinforesponse.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 523e96d1af10
+ */
+
+import * as z from "zod/v3";
+import { GleanBaseError } from "./gleanbaseerror.js";
+
+/**
+ * Error response for custom metadata operations
+ */
+export type ErrorInfoResponseData = {
+  /**
+   * Error message describing what went wrong
+   */
+  error: string;
+  /**
+   * Additional details about the error
+   */
+  message?: string | undefined;
+};
+
+/**
+ * Error response for custom metadata operations
+ */
+export class ErrorInfoResponse extends GleanBaseError {
+  /**
+   * Error message describing what went wrong
+   */
+  error: string;
+
+  /** The original data that was passed to this error instance. */
+  data$: ErrorInfoResponseData;
+
+  constructor(
+    err: ErrorInfoResponseData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = err.message || `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.error = err.error;
+
+    this.name = "ErrorInfoResponse";
+  }
+}
+
+/** @internal */
+export const ErrorInfoResponse$inboundSchema: z.ZodType<
+  ErrorInfoResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  error: z.string(),
+  message: z.string().optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new ErrorInfoResponse(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });

package/src/models/errors/index.ts

@@ -4,6 +4,7 @@
  */
 
 export * from "./collectionerror.js";
+export * from "./errorinforesponse.js";
 export * from "./errorresponse.js";
 export * from "./gleanbaseerror.js";
 export * from "./gleandataerror.js";

package/src/models/operations/authorizeactionpack.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 6e5416c09efb
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type AuthorizeActionPackRequest = {
+  /**
+   * ID of the action pack to query or authorize.
+   */
+  actionPackId: string;
+  authorizeActionPackRequest: components.AuthorizeActionPackRequest;
+};
+
+/** @internal */
+export type AuthorizeActionPackRequest$Outbound = {
+  actionPackId: string;
+  AuthorizeActionPackRequest: components.AuthorizeActionPackRequest$Outbound;
+};
+
+/** @internal */
+export const AuthorizeActionPackRequest$outboundSchema: z.ZodType<
+  AuthorizeActionPackRequest$Outbound,
+  z.ZodTypeDef,
+  AuthorizeActionPackRequest
+> = z.object({
+  actionPackId: z.string(),
+  authorizeActionPackRequest:
+    components.AuthorizeActionPackRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    authorizeActionPackRequest: "AuthorizeActionPackRequest",
+  });
+});
+
+export function authorizeActionPackRequestToJSON(
+  authorizeActionPackRequest: AuthorizeActionPackRequest,
+): string {
+  return JSON.stringify(
+    AuthorizeActionPackRequest$outboundSchema.parse(authorizeActionPackRequest),
+  );
+}

package/src/models/operations/deleterestapiindexcustommetadataschemagroupname.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 7d1dbb682727
+ */
+
+import * as z from "zod/v3";
+
+export const DeleteRestApiIndexCustomMetadataSchemaGroupNameServerList = [
+  "https://{instance}-be.glean.com",
+] as const;
+
+export type DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest = {
+  /**
+   * Name of the metadata group schema
+   */
+  groupName: string;
+};
+
+/** @internal */
+export type DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest$Outbound = {
+  groupName: string;
+};
+
+/** @internal */
+export const DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest$outboundSchema:
+  z.ZodType<
+    DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest$Outbound,
+    z.ZodTypeDef,
+    DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest
+  > = z.object({
+    groupName: z.string(),
+  });
+
+export function deleteRestApiIndexCustomMetadataSchemaGroupNameRequestToJSON(
+  deleteRestApiIndexCustomMetadataSchemaGroupNameRequest:
+    DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest,
+): string {
+  return JSON.stringify(
+    DeleteRestApiIndexCustomMetadataSchemaGroupNameRequest$outboundSchema.parse(
+      deleteRestApiIndexCustomMetadataSchemaGroupNameRequest,
+    ),
+  );
+}

package/src/models/operations/deleterestapiindexdocumentdocidcustommetadatagroupname.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: af348e14af34
+ */
+
+import * as z from "zod/v3";
+
+export const DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameServerList =
+  [
+    "https://{instance}-be.glean.com",
+  ] as const;
+
+export type DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest = {
+  /**
+   * Unique Glean identifier of the document
+   */
+  docId: string;
+  /**
+   * Name of the metadata group as specified while adding schema
+   */
+  groupName: string;
+};
+
+/** @internal */
+export type DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest$Outbound =
+  {
+    docId: string;
+    groupName: string;
+  };
+
+/** @internal */
+export const DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest$outboundSchema:
+  z.ZodType<
+    DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest$Outbound,
+    z.ZodTypeDef,
+    DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest
+  > = z.object({
+    docId: z.string(),
+    groupName: z.string(),
+  });
+
+export function deleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequestToJSON(
+  deleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest:
+    DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest,
+): string {
+  return JSON.stringify(
+    DeleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest$outboundSchema
+      .parse(deleteRestApiIndexDocumentDocIdCustomMetadataGroupNameRequest),
+  );
+}

package/src/models/operations/editagent.ts

@@ -0,0 +1,57 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: effba0f7cfcb
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type EditAgentRequest = {
+  /**
+   * The client's preferred locale in rfc5646 format (e.g. `en`, `ja`, `pt-BR`). If omitted, the `Accept-Language` will be used. If not present or not supported, defaults to the closest match or `en`.
+   */
+  locale?: string | undefined;
+  /**
+   * The offset of the client's timezone in minutes from UTC. e.g. PDT is -420 because it's 7 hours behind UTC.
+   */
+  timezoneOffset?: number | undefined;
+  /**
+   * The ID of the agent.
+   */
+  agentId: string;
+  editWorkflowRequest: components.EditWorkflowRequest;
+};
+
+/** @internal */
+export type EditAgentRequest$Outbound = {
+  locale?: string | undefined;
+  timezoneOffset?: number | undefined;
+  agent_id: string;
+  EditWorkflowRequest: components.EditWorkflowRequest$Outbound;
+};
+
+/** @internal */
+export const EditAgentRequest$outboundSchema: z.ZodType<
+  EditAgentRequest$Outbound,
+  z.ZodTypeDef,
+  EditAgentRequest
+> = z.object({
+  locale: z.string().optional(),
+  timezoneOffset: z.number().int().optional(),
+  agentId: z.string(),
+  editWorkflowRequest: components.EditWorkflowRequest$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    agentId: "agent_id",
+    editWorkflowRequest: "EditWorkflowRequest",
+  });
+});
+
+export function editAgentRequestToJSON(
+  editAgentRequest: EditAgentRequest,
+): string {
+  return JSON.stringify(
+    EditAgentRequest$outboundSchema.parse(editAgentRequest),
+  );
+}

package/src/models/operations/getactionpackauthstatus.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 258daa495312
+ */
+
+import * as z from "zod/v3";
+
+export type GetActionPackAuthStatusRequest = {
+  /**
+   * ID of the action pack to query or authorize.
+   */
+  actionPackId: string;
+};
+
+/** @internal */
+export type GetActionPackAuthStatusRequest$Outbound = {
+  actionPackId: string;
+};
+
+/** @internal */
+export const GetActionPackAuthStatusRequest$outboundSchema: z.ZodType<
+  GetActionPackAuthStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetActionPackAuthStatusRequest
+> = z.object({
+  actionPackId: z.string(),
+});
+
+export function getActionPackAuthStatusRequestToJSON(
+  getActionPackAuthStatusRequest: GetActionPackAuthStatusRequest,
+): string {
+  return JSON.stringify(
+    GetActionPackAuthStatusRequest$outboundSchema.parse(
+      getActionPackAuthStatusRequest,
+    ),
+  );
+}

package/src/models/operations/getchatfile.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 61d9af5f621f
+ */
+
+import * as z from "zod/v3";
+
+export type GetChatFileRequest = {
+  /**
+   * Identifier of the chat file to download.
+   */
+  fileId: string;
+  /**
+   * When true and the file is a PDF, the response is served inline (Content-Disposition: inline) instead of as an attachment.
+   *
+   * @remarks
+   */
+  preview?: boolean | undefined;
+};
+
+/** @internal */
+export type GetChatFileRequest$Outbound = {
+  fileId: string;
+  preview?: boolean | undefined;
+};
+
+/** @internal */
+export const GetChatFileRequest$outboundSchema: z.ZodType<
+  GetChatFileRequest$Outbound,
+  z.ZodTypeDef,
+  GetChatFileRequest
+> = z.object({
+  fileId: z.string(),
+  preview: z.boolean().optional(),
+});
+
+export function getChatFileRequestToJSON(
+  getChatFileRequest: GetChatFileRequest,
+): string {
+  return JSON.stringify(
+    GetChatFileRequest$outboundSchema.parse(getChatFileRequest),
+  );
+}

package/src/models/operations/getdatasourcecredentialstatus.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 0c2b3e4c4b22
+ */
+
+import * as z from "zod/v3";
+
+export type GetDatasourceCredentialStatusRequest = {
+  /**
+   * The full datasource instance identifier (e.g. o365sharepoint_abc123)
+   */
+  datasourceInstanceId: string;
+};
+
+/** @internal */
+export type GetDatasourceCredentialStatusRequest$Outbound = {
+  datasourceInstanceId: string;
+};
+
+/** @internal */
+export const GetDatasourceCredentialStatusRequest$outboundSchema: z.ZodType<
+  GetDatasourceCredentialStatusRequest$Outbound,
+  z.ZodTypeDef,
+  GetDatasourceCredentialStatusRequest
+> = z.object({
+  datasourceInstanceId: z.string(),
+});
+
+export function getDatasourceCredentialStatusRequestToJSON(
+  getDatasourceCredentialStatusRequest: GetDatasourceCredentialStatusRequest,
+): string {
+  return JSON.stringify(
+    GetDatasourceCredentialStatusRequest$outboundSchema.parse(
+      getDatasourceCredentialStatusRequest,
+    ),
+  );
+}

package/src/models/operations/getpersonphoto.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 428e91c12ab8
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetPersonPhotoRequest = {
+  /**
+   * The obfuscated ID of the person whose photo to retrieve.
+   */
+  personId: string;
+  /**
+   * Optional datasource override for crawled photos (e.g. AZURE, GDRIVE, OKTA). When omitted, the datasource is derived from the person's stored photo URL or the deployment's primary person datasource.
+   *
+   * @remarks
+   */
+  ds?: string | undefined;
+};
+
+export type GetPersonPhotoResponseResult =
+  | ReadableStream<Uint8Array>
+  | ReadableStream<Uint8Array>;
+
+export type GetPersonPhotoResponse = {
+  headers: { [k: string]: Array<string> };
+  result: ReadableStream<Uint8Array> | ReadableStream<Uint8Array>;
+};
+
+/** @internal */
+export type GetPersonPhotoRequest$Outbound = {
+  person_id: string;
+  ds?: string | undefined;
+};
+
+/** @internal */
+export const GetPersonPhotoRequest$outboundSchema: z.ZodType<
+  GetPersonPhotoRequest$Outbound,
+  z.ZodTypeDef,
+  GetPersonPhotoRequest
+> = z.object({
+  personId: z.string(),
+  ds: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    personId: "person_id",
+  });
+});
+
+export function getPersonPhotoRequestToJSON(
+  getPersonPhotoRequest: GetPersonPhotoRequest,
+): string {
+  return JSON.stringify(
+    GetPersonPhotoRequest$outboundSchema.parse(getPersonPhotoRequest),
+  );
+}
+
+/** @internal */
+export const GetPersonPhotoResponseResult$inboundSchema: z.ZodType<
+  GetPersonPhotoResponseResult,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.instanceof(ReadableStream<Uint8Array>),
+  z.instanceof(ReadableStream<Uint8Array>),
+]);
+
+export function getPersonPhotoResponseResultFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPersonPhotoResponseResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPersonPhotoResponseResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPersonPhotoResponseResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPersonPhotoResponse$inboundSchema: z.ZodType<
+  GetPersonPhotoResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: z.union([
+    z.instanceof(ReadableStream<Uint8Array>),
+    z.instanceof(ReadableStream<Uint8Array>),
+  ]),
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function getPersonPhotoResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPersonPhotoResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPersonPhotoResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPersonPhotoResponse' from JSON`,
+  );
+}

package/src/models/operations/getrestapiindexcustommetadataschemagroupname.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: f6e3b285a125
+ */
+
+import * as z from "zod/v3";
+
+export const GetRestApiIndexCustomMetadataSchemaGroupNameServerList = [
+  "https://{instance}-be.glean.com",
+] as const;
+
+export type GetRestApiIndexCustomMetadataSchemaGroupNameRequest = {
+  /**
+   * Name of the metadata group schema
+   */
+  groupName: string;
+};
+
+/** @internal */
+export type GetRestApiIndexCustomMetadataSchemaGroupNameRequest$Outbound = {
+  groupName: string;
+};
+
+/** @internal */
+export const GetRestApiIndexCustomMetadataSchemaGroupNameRequest$outboundSchema:
+  z.ZodType<
+    GetRestApiIndexCustomMetadataSchemaGroupNameRequest$Outbound,
+    z.ZodTypeDef,
+    GetRestApiIndexCustomMetadataSchemaGroupNameRequest
+  > = z.object({
+    groupName: z.string(),
+  });
+
+export function getRestApiIndexCustomMetadataSchemaGroupNameRequestToJSON(
+  getRestApiIndexCustomMetadataSchemaGroupNameRequest:
+    GetRestApiIndexCustomMetadataSchemaGroupNameRequest,
+): string {
+  return JSON.stringify(
+    GetRestApiIndexCustomMetadataSchemaGroupNameRequest$outboundSchema.parse(
+      getRestApiIndexCustomMetadataSchemaGroupNameRequest,
+    ),
+  );
+}