/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 * @generated-id: e4891532ad93
 */

import * as z from "zod/v3";
import { safeParse } from "../../lib/schemas.js";
import * as openEnums from "../../types/enums.js";
import { OpenEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";

/**
 * The visibility-override state of the document.
 */
export const DocumentVisibilityUpdateResultOverride = {
  None: "NONE",
  HideFromAll: "HIDE_FROM_ALL",
  HideFromGroups: "HIDE_FROM_GROUPS",
  HideFromAllExceptOwner: "HIDE_FROM_ALL_EXCEPT_OWNER",
} as const;
/**
 * The visibility-override state of the document.
 */
export type DocumentVisibilityUpdateResultOverride = OpenEnum<
  typeof DocumentVisibilityUpdateResultOverride
>;

export type DocumentVisibilityUpdateResult = {
  docId?: string | undefined;
  /**
   * The visibility-override state of the document.
   */
  override?: DocumentVisibilityUpdateResultOverride | undefined;
  /**
   * Whether this document was successfully set to its desired visibility state.
   */
  success?: boolean | undefined;
};

/** @internal */
export const DocumentVisibilityUpdateResultOverride$inboundSchema: z.ZodType<
  DocumentVisibilityUpdateResultOverride,
  z.ZodTypeDef,
  unknown
> = openEnums.inboundSchema(DocumentVisibilityUpdateResultOverride);

/** @internal */
export const DocumentVisibilityUpdateResult$inboundSchema: z.ZodType<
  DocumentVisibilityUpdateResult,
  z.ZodTypeDef,
  unknown
> = z.object({
  docId: z.string().optional(),
  override: DocumentVisibilityUpdateResultOverride$inboundSchema.optional(),
  success: z.boolean().optional(),
});

export function documentVisibilityUpdateResultFromJSON(
  jsonString: string,
): SafeParseResult<DocumentVisibilityUpdateResult, SDKValidationError> {
  return safeParse(
    jsonString,
    (x) => DocumentVisibilityUpdateResult$inboundSchema.parse(JSON.parse(x)),
    `Failed to parse 'DocumentVisibilityUpdateResult' from JSON`,
  );
}