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

import * as z from "zod/v3";
import {
  UserRoleSpecification,
  UserRoleSpecification$Outbound,
  UserRoleSpecification$outboundSchema,
} from "./userrolespecification.js";

export type ShortcutMutableProperties = {
  /**
   * Link text following go/ prefix as entered by the user.
   */
  inputAlias?: string | undefined;
  /**
   * Destination URL for the shortcut.
   */
  destinationUrl?: string | undefined;
  /**
   * Glean Document ID for the URL, if known.
   */
  destinationDocumentId?: string | undefined;
  /**
   * A short, plain text blurb to help people understand the intent of the shortcut.
   */
  description?: string | undefined;
  /**
   * Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.
   */
  unlisted?: boolean | undefined;
  /**
   * For variable shortcuts, contains the URL template; note, `destinationUrl` contains default URL.
   */
  urlTemplate?: string | undefined;
  /**
   * A list of user roles added for the Shortcut.
   */
  addedRoles?: Array<UserRoleSpecification> | undefined;
  /**
   * A list of user roles removed for the Shortcut.
   */
  removedRoles?: Array<UserRoleSpecification> | undefined;
};

/** @internal */
export type ShortcutMutableProperties$Outbound = {
  inputAlias?: string | undefined;
  destinationUrl?: string | undefined;
  destinationDocumentId?: string | undefined;
  description?: string | undefined;
  unlisted?: boolean | undefined;
  urlTemplate?: string | undefined;
  addedRoles?: Array<UserRoleSpecification$Outbound> | undefined;
  removedRoles?: Array<UserRoleSpecification$Outbound> | undefined;
};

/** @internal */
export const ShortcutMutableProperties$outboundSchema: z.ZodType<
  ShortcutMutableProperties$Outbound,
  z.ZodTypeDef,
  ShortcutMutableProperties
> = z.object({
  inputAlias: z.string().optional(),
  destinationUrl: z.string().optional(),
  destinationDocumentId: z.string().optional(),
  description: z.string().optional(),
  unlisted: z.boolean().optional(),
  urlTemplate: z.string().optional(),
  addedRoles: z.array(UserRoleSpecification$outboundSchema).optional(),
  removedRoles: z.array(UserRoleSpecification$outboundSchema).optional(),
});

export function shortcutMutablePropertiesToJSON(
  shortcutMutableProperties: ShortcutMutableProperties,
): string {
  return JSON.stringify(
    ShortcutMutableProperties$outboundSchema.parse(shortcutMutableProperties),
  );
}