createEnum

La función createEnum crea un nuevo modelo Enum: una lista cerrada de valores de texto que los campos de entidad de tipo enum pueden referenciar. Es el equivalente en JavaScript/TypeScript del endpoint REST POST /model/enum.

Ejemplo:

const { id } = await client.createEnum({
  name: 'Size',
  values: [{ value: 'S' }, { value: 'M' }, { value: 'L' }],
});
console.log(id);

// Después referéncialo desde un campo de entidad:
await client.createModel({
  name: 'Shirt',
  fieldList: [{ name: 'size', type: 'enum', relatedModelId: id }],
});

Precaución

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

Interface

export interface ApiClient {
  createEnum: (params: CreateEnumParams) => Promise<SaveModelResponse>;
  // ... otros métodos
}

export interface CreateEnumParams {
  name: string;
  values: Array<{ id?: string; value: string }>;
}

export interface SaveModelResponse {
  id: string;
}

Parámetros

Nombre	Descripción
name	El nombre del enum. Mismas reglas de nombres que el nombre de un modelo, único en el proyecto.
values	Los valores del enum, en orden. Se requiere al menos uno, único dentro del enum (sin distinguir mayúsculas/minúsculas). Omite id al crear.

Salida

Devuelve una Promise<SaveModelResponse> que se resuelve con { id } — úsalo como relatedModelId de un campo enum. En caso de fallo, lanza un ApiClientError tipado (por ejemplo VALIDATION_ERROR).