updateEnum

La función updateEnum actualiza un modelo Enum existente. Es el equivalente en JavaScript/TypeScript del endpoint REST PUT /model/enum/:id.

Los params describen el estado final deseado; el servidor los reconcilia con el enum actual por id de valor. Mantén el id de un valor existente para preservarlo (cambia su value para renombrarlo — la nueva etiqueta se propaga al contenido), añade un valor sin id y omite un valor para eliminarlo (borrándolo del contenido existente).

Ejemplo:

// Renombra el enum, renombra `S` → `Small` (mantén su id), añade `XL`, elimina el resto por omisión.
const { id } = await client.updateEnum(enumId, {
  name: 'TshirtSize',
  values: [
    { id: smallValueId, value: 'Small' },
    { id: mediumValueId, value: 'M' },
    { value: 'XL' },
  ],
});

Precaución

updateEnum requiere un Write Token como accessToken del cliente. Llamarlo con un read token devuelve 403 Forbidden.

Peligro

Omitir un valor lo elimina y lo borra del contenido. Envía siempre la lista de valores completa deseada. Obtén primero los valores actuales y sus ids con getProject.

Interface

export interface ApiClient {
  updateEnum: (enumId: string, params: UpdateEnumParams) => Promise<SaveModelResponse>;
  // ... otros métodos
}

// Misma forma que CreateEnumParams.
export type UpdateEnumParams = CreateEnumParams;

export interface SaveModelResponse {
  id: string;
}

Parámetros

Nombre	Descripción
enumId	El id del enum a actualizar.
params	El nuevo nombre y la lista values completa deseada (cada uno con su id para preservarlo).

Salida

Devuelve una Promise<SaveModelResponse> que se resuelve con { id }. En caso de fallo, lanza un ApiClientError tipado — NOT_FOUND si ningún enum tiene ese id.