Skip to content

Funcionalidades y métodos ​

Este es el índice de las funcionalidades de la plataforma. Cada sección corresponde a una funcionalidad y su tabla lista los métodos que la exponen, la superficie donde están disponibles (Servidor, Navegador o ambas) y el enlace a la documentación de la API de ese módulo.

Convenciones: nada significa que la llamada se resuelve sin cuerpo (Promise<void>); — significa que el SDK no tipa la respuesta (Promise<unknown>). Cada método se llama desde la propiedad del módulo en el cliente, por ejemplo client.companies.list().

ai ​

MétodoQué devuelveSuperficies
generatela respuesta de generación de texto de IAServidor + Navegador
getConsumptionel consumo de IA del ciclo en cursoServidor + Navegador
getOverageStatusel estado del switch de exceso de uso y su saldoServidor + Navegador
setOverageSwitchel estado de exceso de uso tras activarlo o desactivarloServidor + Navegador

Documentación de la API: Módulo AI.

apiKeys ​

MétodoQué devuelveSuperficies
listla página de claves de APIServidor + Navegador
getla clave solicitadaServidor + Navegador
createla clave creadaServidor + Navegador
rotatela clave rotadaServidor + Navegador
revokela clave revocadaServidor + Navegador
deletenadaServidor + Navegador

Documentación de la API: API Keys.

appData ​

MétodoQué devuelveSuperficies
collectionun manejador con list, get, create y update sobre una colección de la aplicaciónServidor + Navegador

Sin página de API: las instancias se documentan en Entity Manager y en la guía del SDK correspondiente.

applicationDsl ​

MétodoQué devuelveSuperficies
getla definición DSL de la aplicaciónServidor + Navegador
listlas definiciones DSL disponiblesServidor + Navegador
createDraftla definición creada como borradorServidor + Navegador
renamela definición con el nombre nuevoServidor + Navegador
putDocumentla definición con el documento guardadoServidor + Navegador
publishla definición publicadaServidor + Navegador
createVersionla nueva versión creada sobre la publicadaServidor + Navegador
retireVersionla definición tras retirar la versiónServidor + Navegador
getEagerDocumentel documento completo (eager) de la aplicaciónServidor + Navegador
getChunkun chunk del documento de la aplicaciónServidor + Navegador
followApplicationel seguimiento de la aplicación de la plataformaServidor + Navegador
listFollowslos seguimientos de aplicaciones del tenantServidor + Navegador
acceptFollowel seguimiento actualizado a la versión aceptadaServidor + Navegador
forkFollowla copia independiente de la definición en el tenantServidor + Navegador
assignRolela asignación de rol creadaServidor + Navegador
listRoleAssignmentslas asignaciones de rol de la aplicaciónServidor + Navegador
revokeRolenadaServidor + Navegador
createFormInstancela instancia de formulario creadaServidor + Navegador
updateFormInstancela instancia de formulario actualizadaServidor + Navegador
listViewInstancesla página de instancias del formularioServidor + Navegador
getViewInstancela instancia solicitada con sus datos de vistaServidor + Navegador
processFormSubmitel resultado de procesar el envío del formularioServidor + Navegador
setRuntimeContextnada. Fija o limpia el proyecto y entorno usados por las llamadas de runtime (síncrono)Servidor + Navegador
setRuntimeSessionTokennada. Guarda el token de sesión de runtime solo en memoria (síncrono)Navegador
createRuntimeArtifactMountOptionslas opciones de montaje del artefacto para el adapter de runtime del navegadorNavegador

Documentación de la API: Application DSL.

assistants ​

MétodoQué devuelveSuperficies
listlos assistants del tenantServidor + Navegador
getel assistant con sus habilidades asignadasServidor + Navegador
createel assistant creadoServidor + Navegador
updateel assistant actualizadoServidor + Navegador
deletenadaServidor + Navegador
getPresentationla presentación del assistant para el chat autenticadoServidor + Navegador
listSkillslas habilidades del tenantServidor + Navegador
getSkillla habilidad solicitadaServidor + Navegador
createSkillla habilidad creadaServidor + Navegador
updateSkillla habilidad actualizadaServidor + Navegador
deleteSkillnadaServidor + Navegador
listShareableCatalogSkillslas habilidades del catálogo de plataforma compartibles con el tenantServidor + Navegador
assignSkillsel assistant con la lista de habilidades reemplazadaServidor + Navegador
chatla respuesta del chat; puede quedar una habilidad pendiente de confirmaciónServidor + Navegador
confirmPendingSkillla respuesta tras confirmar y ejecutar la habilidad pendienteServidor + Navegador
rejectPendingSkillla respuesta tras rechazar la habilidad pendienteServidor + Navegador
interactWithChoicela respuesta del chat luego de elegir una opción planteadaNavegador
getConversationel historial de una conversación autenticadaServidor + Navegador
listConversationslas conversaciones propias del usuario autenticadoNavegador
listCapabilitieslas capacidades disponibles del assistant (solo descriptivo)Navegador
setPublicWidgetel assistant tras publicar o despublicar el widgetServidor + Navegador
getPublicWidgetel estado del widget público publicadoServidor + Navegador
publicWidgetChatla respuesta del chat anónimo por el widget públicoServidor + Navegador
listPublicWidgetConversationslas conversaciones recibidas por el widget públicoServidor + Navegador
getPublicWidgetConversationuna conversación del widget público con sus mensajesServidor + Navegador

Sin página de API propia: la superficie HTTP correspondiente se documenta en Módulo AI.

authorizedClients ​

MétodoQué devuelveSuperficies
listlos clientes autorizados del tenantNavegador
createel cliente autorizado creadoNavegador
rotateel cliente autorizado con su secreto renovadoNavegador
deletenadaNavegador
listCompanieslas empresas vinculadas al clienteNavegador
addCompanyel vínculo de empresa creadoNavegador
removeCompanynadaNavegador
linkActiveCompanyel vínculo de la empresa activaServidor + Navegador
unlinkActiveCompanynadaServidor + Navegador

Sin página de API propia: el flujo de autorización se documenta en OAuth 2.0 Authorization Server.

backups ​

MétodoQué devuelveSuperficies
listDestinationslos destinos de respaldo conocidosServidor + Navegador
listSnapshotslos snapshots de un destinoServidor + Navegador
createSnapshotel snapshot creado ahoraServidor + Navegador
restoreSnapshotla operación de restauración iniciadaServidor + Navegador
listRestoreOperationsel historial de operaciones de restauraciónServidor + Navegador
migrateToProviderel resultado de migrar los snapshots locales al proveedor de almacenamientoServidor + Navegador
getConfigla configuración de programación y retención del destinoServidor + Navegador
updateConfigla configuración de respaldo actualizadaServidor + Navegador

Documentación de la API: Respaldos de BBDD.

billing ​

MétodoQué devuelveSuperficies
getSubscriptionla suscripción del tenant, o null si no tieneServidor + Navegador
createSubscriptionla suscripción creadaServidor + Navegador
cancelSubscriptionla suscripción canceladaServidor + Navegador
listInvoiceslas facturas del tenantServidor + Navegador
listEntitlementslos entitlements del tenantServidor + Navegador
checkEntitlementsi el feature consultado está habilitadoServidor + Navegador
createCheckoutuna URL de checkoutServidor + Navegador
createPortaluna URL del portal de clienteServidor + Navegador
getPublicPlanslos planes visibles en la landing públicaServidor + Navegador
listPlanslos planes de plataforma con sus preciosServidor + Navegador
getPlanel plan solicitadoServidor + Navegador
createPlanel plan creadoServidor + Navegador
updatePlanel plan actualizadoServidor + Navegador
addPlanPriceel precio agregado al planServidor + Navegador
getByokStatusel estado BYOK sin exponer secretosServidor + Navegador
listByoklos conjuntos de credenciales BYOK, sin secretosServidor + Navegador
getByokun conjunto de credenciales BYOK, sin secretosServidor + Navegador
registerByokla credencial BYOK registradaServidor + Navegador
updateByokla credencial BYOK actualizadaServidor + Navegador
removeByoknadaServidor + Navegador
activateByokla credencial BYOK activadaServidor + Navegador
deactivateByokla credencial BYOK desactivadaServidor + Navegador
getConnectStatusel estado de la cuenta Connect, sin secretosServidor + Navegador
startConnectOnboardingel estado de Connect tras iniciar el onboardingServidor + Navegador
disconnectConnectel estado de Connect tras desconectarServidor + Navegador
getChargeMechanismStatuslos mecanismos de cobro disponibles y cuál está activoServidor + Navegador
setActiveChargeMechanismel mecanismo de cobro que quedó activoServidor + Navegador
listCustomerChargesla página de cobros del tenant a clientes finalesServidor + Navegador
createCustomerChargeel cobro al cliente final creadoServidor + Navegador
getCustomerChargeel cobro al cliente final solicitadoServidor + Navegador
refundCustomerChargeel cobro al cliente final reembolsadoServidor + Navegador
createCustomerSubscriptionla suscripción del cliente final creadaServidor + Navegador
updateCustomerSubscriptionla suscripción del cliente final actualizadaServidor + Navegador
cancelCustomerSubscriptionla suscripción del cliente final canceladaServidor + Navegador
getPlatformProviderStatusel estado de conexión del proveedor de cobro de la plataformaServidor + Navegador
connectPlatformProviderel estado tras conectar al proveedor de la plataformaServidor + Navegador
disconnectPlatformProviderel estado tras desconectar al proveedor de la plataformaServidor + Navegador
listPlatformChargesla página de cobros de la plataforma al tenantServidor + Navegador
createPlatformChargeel cobro de la plataforma al tenant creadoServidor + Navegador
getPlatformChargeel cobro de la plataforma al tenant solicitadoServidor + Navegador
refundPlatformChargeel cobro de la plataforma al tenant reembolsadoServidor + Navegador
createPlatformSubscription—Servidor + Navegador
updatePlatformSubscription—Servidor + Navegador

Documentación de la API: Billing y suscripciones.

catalog ​

MétodoQué devuelveSuperficies
listSystemOptionslas opciones del sistema, que no se pueden archivarServidor + Navegador
listCustomOptionslas opciones custom de alcance plataformaServidor + Navegador
createCustomOptionla opción custom creadaServidor + Navegador
archiveCustomOptionla opción custom archivadaServidor + Navegador
unarchiveCustomOptionla opción custom reactivadaServidor + Navegador
listCompanyCustomOptionslas opciones custom propias de la empresaServidor + Navegador
createCompanyCustomOptionla opción custom de la empresa creadaServidor + Navegador
archiveCompanyCustomOptionla opción de la empresa archivadaServidor + Navegador
unarchiveCompanyCustomOptionla opción de la empresa reactivadaServidor + Navegador

Sin página de API propia: las opciones del catálogo alimentan los planes documentados en Billing y suscripciones.

clients ​

MétodoQué devuelveSuperficies
listla página de clientesServidor + Navegador
getel cliente solicitadoServidor + Navegador
createel cliente creadoServidor + Navegador
updateel cliente actualizadoServidor + Navegador
deletenadaServidor + Navegador

Documentación de la API: Clientes (facturación comercial).

companies ​

MétodoQué devuelveSuperficies
listla página de empresasServidor + Navegador
getla empresa solicitadaServidor + Navegador
createla empresa creadaServidor + Navegador
updatela empresa actualizadaServidor + Navegador
deletenadaServidor + Navegador
listMemberslos usuarios que son miembros de la empresaServidor + Navegador
addMemberel usuario agregado a la empresaServidor + Navegador
removeMembernadaServidor + Navegador

Documentación de la API: Empresas.

documentTypes ​

MétodoQué devuelveSuperficies
listlos tipos de documentoServidor + Navegador
getel tipo de documento solicitadoServidor + Navegador
createel tipo de documento creadoServidor + Navegador
updateel tipo de documento actualizadoServidor + Navegador
deletenadaServidor + Navegador
addSeriesla serie agregada al tipoServidor + Navegador
updateSeriesla serie actualizadaServidor + Navegador
deleteSeriesnadaServidor + Navegador

Documentación de la API: Tipos de documento, series y correlativos.

documents ​

MétodoQué devuelveSuperficies
listProductslos productos de factura reutilizables de la empresaServidor + Navegador
getProductTaxOptionslas tasas de impuesto aplicables al país fiscal de la empresaServidor + Navegador
searchProductslos productos que coinciden con la búsquedaServidor + Navegador
createProductel producto creadoServidor + Navegador
updateProductel producto actualizadoServidor + Navegador
quickCreateProductel producto creado al vueloServidor + Navegador
updateQuickCreatedProductPricenadaServidor + Navegador
getSettingsla configuración de autogeneración de documentosServidor + Navegador
updateSettingsla configuración de autogeneración actualizadaServidor + Navegador
listAutoGenFailuresla página de fallos de autogeneraciónServidor + Navegador
listla página de documentos comercialesServidor + Navegador
getel documento solicitadoServidor + Navegador
createel documento creado en borradorServidor + Navegador
updateel documento borrador actualizadoServidor + Navegador
deletenadaServidor + Navegador
emitel documento emitido, con sus snapshots congelados y su número asignadoServidor + Navegador
convertel documento convertido de proforma o presupuesto a facturaServidor + Navegador
getVerifactuel registro Verifactu y su QR para documentos fiscales de EspañaServidor + Navegador
exportFacturaeel artefacto Facturae generado y validadoServidor + Navegador
downloadFacturaeel XML de Facturae como textoServidor + Navegador

Documentación de la API: Documentos comerciales.

entityManager ​

MétodoQué devuelveSuperficies
createDefinitionla definición de entidad creada como borradorServidor + Navegador
listDefinitionslas definiciones de entidad del catálogo del actorServidor + Navegador
getDefinitionla definición de entidad con sus versionesServidor + Navegador
updateDefinitionla definición actualizada, o su nueva versión si estaba publicadaServidor + Navegador
publishDefinitionla definición de entidad publicadaServidor + Navegador
createDefinitionVersionel nuevo borrador de versión sobre la publicadaServidor + Navegador
followEntityel seguimiento de la entidad publicada en la plataformaServidor + Navegador
listEntityFollowslos seguimientos de entidades del tenantServidor + Navegador
acceptEntityFollowel seguimiento actualizado a la versión aceptadaServidor + Navegador
forkEntityFollowla copia de la entidad en el catálogo del tenantServidor + Navegador
retireEntityVersionla versión de entidad retiradaServidor + Navegador
createApplicationla definición de aplicación creada como borradorServidor + Navegador
listApplicationslas definiciones de aplicación del catálogo del actorServidor + Navegador
getApplicationla definición de aplicación con sus versionesServidor + Navegador
updateApplicationla aplicación actualizada, o su nueva versión si estaba publicadaServidor + Navegador
publishApplicationla aplicación publicadaServidor + Navegador
createApplicationVersionel nuevo borrador de versión de la aplicaciónServidor + Navegador
retireApplicationVersionla versión de aplicación retiradaServidor + Navegador
followApplicationel seguimiento de la aplicación de la plataformaServidor + Navegador
listApplicationFollowslos seguimientos de aplicaciones del tenantServidor + Navegador
acceptApplicationFollowel seguimiento actualizado a la versión aceptadaServidor + Navegador
createInstancela instancia creadaServidor + Navegador
listInstancesla página de instanciasServidor + Navegador
getInstancela instancia solicitadaServidor + Navegador
updateInstancela instancia actualizadaServidor + Navegador
deleteInstancenadaServidor + Navegador
restoreInstancela instancia restauradaServidor + Navegador
associateRelationel vínculo de relación creadoServidor + Navegador
disassociateRelationnadaServidor + Navegador
listGrantslos permisos de panel otorgadosServidor + Navegador
grantel permiso otorgadoServidor + Navegador
revokenadaServidor + Navegador

Documentación de la API: Entity Manager.

eventLogger ​

MétodoQué devuelveSuperficies
createProjectIdel proyecto de analytics con su ID opaco para instrumentarServidor + Navegador
listProjectIdslos IDs de proyecto de la empresa autenticadaServidor + Navegador
revokeProjectIdel proyecto revocadoServidor + Navegador
saveEventnadaServidor + Navegador
getStatsel ranking de botones, componentes y páginas de la empresaServidor + Navegador

Documentación de la API: Event logger.

feedback ​

MétodoQué devuelveSuperficies
createel reporte de feedback creadoServidor + Navegador
listlos reportes de feedbackServidor + Navegador
markAsReadel reporte marcado como leídoServidor + Navegador

Documentación de la API: Feedback.

invitations ​

MétodoQué devuelveSuperficies
listlas invitaciones emitidasServidor + Navegador
createla invitación creadaServidor + Navegador
revokenadaServidor + Navegador
accept— (endpoint público, sin respuesta tipada)Servidor + Navegador

Documentación de la API: Invitaciones.

notifications ​

MétodoQué devuelveSuperficies
listla página de notificaciones de la casilla del usuarioServidor + Navegador
markReadla notificación marcada como leídaServidor + Navegador
markAllReadnadaServidor + Navegador
sendel acuse de recibo del envío aceptadoServidor + Navegador
scheduleel envío programado creadoServidor + Navegador
listScheduledla página de envíos programados pendientesServidor + Navegador
cancelScheduledel envío programado canceladoServidor + Navegador
listSendsla página del historial de envíos propiosServidor + Navegador
listTenantNotificationsla página de las notificaciones in-app del tenantServidor + Navegador
registerDeviceel dispositivo de push registradoServidor + Navegador
listDeviceslos dispositivos de push registradosServidor + Navegador
unregisterDevicenadaServidor + Navegador
listPreferenceslas preferencias de notificación explícitasServidor + Navegador
setPreferencela preferencia guardadaServidor + Navegador
listTemplateslas plantillas propias del tenantServidor + Navegador
listAvailableTemplateslas plantillas disponibles para componer un envío (sistema y tenant)Servidor + Navegador
getTemplatela plantilla solicitadaServidor + Navegador
createTemplatela plantilla creadaServidor + Navegador
updateTemplatela plantilla actualizadaServidor + Navegador
deleteTemplatenadaServidor + Navegador
createRealtimeTicketun ticket de un solo uso para abrir el canal en vivoServidor
subscribeuna función para dejar de escuchar los eventos en vivo (síncrono)Servidor + Navegador
unsubscribenada (síncrono)Servidor + Navegador
isSubscribedsi hay al menos un listener en vivo (síncrono)Servidor + Navegador
handleSessionLifecyclenada. Uso interno del SDK: ganchos de sesión de autenticación (síncrono)Navegador

Documentación de la API: Notificaciones.

objectStorage ​

MétodoQué devuelveSuperficies
listlos objetos y carpetas de una ruta dentro del espacioServidor + Navegador
uploadel objeto subidoServidor + Navegador
downloadlos bytes del archivoServidor + Navegador
downloadBlobel archivo como BlobNavegador
deleteel resultado del borradoServidor + Navegador
moveel objeto movido o renombradoServidor + Navegador
createFolderla carpeta creadaServidor + Navegador
createTempLinkel link público temporal emitidoServidor + Navegador
revokeTempLinknadaServidor + Navegador
downloadPublicTempLinklos bytes del archivo vía el token público, sin sesiónServidor + Navegador
downloadPublicTempLinkBlobel archivo como Blob vía el token público, sin sesiónNavegador
listGrantslos permisos de operación del tenantServidor + Navegador
grantel permiso de operación otorgadoServidor + Navegador
revokenadaServidor + Navegador
getLimitslos límites efectivos del tenantServidor + Navegador

Documentación de la API: Almacenamiento de objetos.

ownerPlans ​

MétodoQué devuelveSuperficies
listlos planes de reventa del ownerServidor + Navegador
createel plan de owner creadoServidor + Navegador
updateel plan de owner actualizadoServidor + Navegador
assignla asignación del plan a una empresaServidor + Navegador
listAssignmentslas asignaciones de planes a empresasServidor + Navegador
getOwnAssignmentla asignación de la empresa activa, o null si no tieneServidor + Navegador

Documentación de la API: Planes de reventa del owner.

providers ​

MétodoQué devuelveSuperficies
getCatalogel catálogo cerrado de proveedoresServidor + Navegador
getFamilyel catálogo de una familia de proveedoresServidor + Navegador
getTypeel catálogo de un tipo de proveedorServidor + Navegador
peekResolutionla resolución de proveedor que se aplicaríaServidor + Navegador
listTenantlas instancias de proveedor del tenantServidor + Navegador
getTenantla instancia de proveedor del tenantServidor + Navegador
createTenantla instancia del tenant creadaServidor + Navegador
updateTenantla instancia del tenant actualizadaServidor + Navegador
deleteTenantnadaServidor + Navegador
activateTenantla instancia del tenant activadaServidor + Navegador
deactivateTenantla instancia del tenant desactivadaServidor + Navegador
listPlatformlas instancias de proveedor de plataformaNavegador
getPlatformla instancia de proveedor de plataformaNavegador
createPlatformla instancia de plataforma creadaNavegador
updatePlatformla instancia de plataforma actualizadaNavegador
deletePlatformnadaNavegador
markPlatformBuiltInla instancia marcada como incorporadaNavegador
unmarkPlatformBuiltInla instancia desmarcada como incorporadaNavegador

Documentación de la API: Proveedores.

rag ​

MétodoQué devuelveSuperficies
listCorpusLinkslos archivos vinculados al corpus del assistantServidor + Navegador
linkCorpusFileel vínculo del archivo al corpusServidor + Navegador
unlinkCorpusFilenadaServidor + Navegador
reindexCorpusFileel archivo reindexadoServidor + Navegador
getConfigla configuración de widget y citas del assistantServidor + Navegador
updateConfigla configuración actualizadaServidor + Navegador

Documentación de la API: RAG documental para assistants.

settings ​

MétodoQué devuelveSuperficies
listtodas las claves de configuración del sistemaServidor + Navegador
getel valor de una claveServidor + Navegador
setla confirmación del guardado con su código de estadoServidor + Navegador
reloadla confirmación de la recarga con su código de estadoServidor + Navegador

Documentación de la API: Configuración del sistema.

tax ​

MétodoQué devuelveSuperficies
listJurisdictionslas jurisdicciones fiscalesServidor + Navegador
getJurisdictionla jurisdicción con sus tasas publicadasServidor + Navegador
getApplicableRateslas tasas aplicables para facturar en la jurisdicciónServidor + Navegador
listVersionsel historial de versiones de tasas de la jurisdicciónServidor + Navegador
listAuditsla auditoría del catálogo fiscalServidor + Navegador
incorporatela jurisdicción incorporada vía proveedorServidor + Navegador
refreshla versión de tasas refrescada desde el proveedorServidor + Navegador
publishVersionla versión de tasas publicadaServidor + Navegador
overrideRatela tasa publicada sobreescritaServidor + Navegador
createAiProposalla propuesta de tasa creada por IA, que no se publica solaServidor + Navegador
buildSnapshotel snapshot fiscal inmutable para la emisiónServidor + Navegador
validateViesel resultado de validar el VAT ID en VIESServidor + Navegador
listCustomRateslas tasas custom del tenant para OTROSServidor + Navegador
createCustomRatela tasa custom creadaServidor + Navegador
updateCustomRatela tasa custom actualizadaServidor + Navegador
deleteCustomRatenadaServidor + Navegador

Documentación de la API: Catálogo fiscal / motor de impuestos.

users ​

MétodoQué devuelveSuperficies
listla página de usuariosServidor + Navegador
getel usuario solicitadoServidor + Navegador
createel usuario creadoServidor + Navegador
updateel usuario actualizadoServidor + Navegador
deletenadaServidor + Navegador

Documentación de la API: Usuarios.

featureFlags ​

Este módulo solo existe en el SDK de navegador: todas sus filas son de superficie Navegador.

MétodoQué devuelveSuperficies
ensureClientel ID de cliente de evaluación, creado si no existíaNavegador
listlas feature flagsNavegador
getla flag solicitadaNavegador
createla flag creadaNavegador
updatela flag actualizadaNavegador
deletenadaNavegador

Documentación de la API: Feature flags nativas.

systemNotificationTemplates ​

Este módulo gestiona el catálogo de plantillas de sistema y solo existe en el SDK de navegador: todas sus filas son de superficie Navegador. Las plantillas propias de tu empresa son otro recurso y sí están en el servidor, en notifications.getTemplate, createTemplate, updateTemplate y deleteTemplate.

MétodoQué devuelveSuperficies
listlas plantillas de notificación del sistemaNavegador
getla plantilla del sistema solicitadaNavegador
createla plantilla del sistema creadaNavegador
updatela plantilla del sistema actualizadaNavegador
deletenadaNavegador

Sin página de API propia: estas plantillas se consultan y gestionan sobre las rutas de Notificaciones.