
Idioma 🇪🇸 Español
Comenzando
Documentación
Uso
Agregación
Registros de auditoría
Bloquear desde comentario
Comprobar comentarios bloqueados
Comentarios
Configuraciones de dominio
Plantillas de correo
Registro de eventos
Publicaciones del feed
Marcar comentario
Hashtags
Moderadores
Contador de notificaciones
Notificaciones
Páginas
Eventos de webhook pendientes
Configuraciones de preguntas
Resultados de preguntas
Agregación de resultados de preguntas
Usuarios SSO
Suscripciones
Uso diario del inquilino
Paquetes de inquilino
Usuarios del inquilino
Inquilinos
Tickets
Subir imagen
Progreso de insignias de usuario
Insignias de usuario
Notificaciones del usuario
Estado de presencia de usuarios
Búsqueda de usuarios
Usuarios
Votos
FastComments Ruby SDK
Este es el SDK oficial de Ruby para FastComments.
SDK oficial de Ruby para la API de FastComments
Repositorio
Instalación 
Añade esta línea al Gemfile de tu aplicación:
gem 'fastcomments'
Y luego ejecuta:
bundle install
O instálalo manualmente con:
gem install fastcomments
Library Contents
Esta biblioteca contiene el cliente de API generado y las utilidades SSO para facilitar el trabajo con la API.
Public vs Secured APIs
Para el cliente de la API, hay dos clases, DefaultApi y PublicApi. The DefaultApi contains methods that require your API key, and PublicApi contains api calls
that can be made directly from a browser/mobile device/etc without authentication.
Inicio rápido 
Uso de APIs autenticadas (DefaultApi)
Important: Debes establecer tu clave de API en el ApiClient antes de realizar solicitudes autenticadas. Si no lo haces, las solicitudes fallarán con un error 401.
require 'fastcomments-client'
# Crear y configurar el cliente de API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# OBLIGATORIO: Establece tu clave de API (obténla desde tu panel de FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Crea la instancia de la API con el cliente configurado
api = FastCommentsClient::DefaultApi.new(api_client)
# Ahora puedes hacer llamadas a la API autenticadas
begin
# Ejemplo: Agregar un usuario SSO
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Errores comunes:
# - 401: falta o es inválida la clave API
# - 400: la validación de la solicitud falló
end
Uso de APIs públicas (PublicApi)
Los endpoints públicos no requieren autenticación:
require 'fastcomments-client'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
tenant_id: 'YOUR_TENANT_ID',
url_id: 'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Problemas comunes
- 401 "missing-api-key" error: Asegúrate de establecer
config.api_key['x-api-key'] = 'YOUR_KEY'antes de crear la instancia DefaultApi. - Wrong API class: Usa
DefaultApipara solicitudes autenticadas del lado del servidor,PublicApipara solicitudes del lado del cliente/públicas. - Null API key: El SDK omitirá silenciosamente la autenticación si la clave API es null, lo que provocará errores 401.
Notas 
IDs de transmisión
Verás que se supone que debes pasar un broadcastId en algunas llamadas a la API. Cuando recibas eventos, obtendrás este ID de vuelta, por lo que sabrás ignorar el evento si planeas aplicar cambios de forma optimista en el cliente (lo cual probablemente querrás hacer ya que ofrece la mejor experiencia). Pasa un UUID aquí. El ID debe ser lo suficientemente único como para no ocurrir dos veces en una sesión del navegador.
SSO (Inicio de sesión único)
Para ejemplos de SSO, consulta más abajo.
Uso de SSO 
SSO simple
require 'fastcomments'
require 'fastcomments-client'
# Crear token SSO simple
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Usar el token SSO para realizar una llamada API autenticada
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
SSO seguro
require 'fastcomments'
require 'fastcomments-client'
# Crear token SSO seguro
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Usar el token SSO para realizar una llamada API autenticada
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
agregar 
Agrega documentos agrupándolos (si se proporciona groupBy) y aplicando múltiples operaciones. Se admiten diferentes operaciones (p. ej., sum, countDistinct, avg, etc.).
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Respuesta
Devuelve: AggregationResponse
Ejemplo

obtener registros de auditoría 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Respuesta
Devuelve: GetAuditLogs200Response
Ejemplo

bloquear desde comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: BlockFromCommentPublic200Response
Ejemplo

desbloquear comentario público 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UnBlockCommentPublic200Response
Ejemplo

comentarios marcados como bloqueados 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentIds | string | query | Sí | Una lista separada por comas de IDs de comentario. |
| sso | string | query | No |
Respuesta
Devuelve: CheckedCommentsForBlocked200Response
Ejemplo

bloquear usuario por comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: BlockFromCommentPublic200Response
Ejemplo

crear comentario público 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateCommentPublic200Response
Ejemplo

eliminar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: DeleteComment200Response
Ejemplo

eliminar comentario público 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteCommentPublic200Response
Ejemplo

eliminar voto de comentario 
Parámetros
| Name | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| voteId | string | path | Sí | |
| urlId | string | query | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteCommentVote200Response
Ejemplo

marcar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagComment200Response
Ejemplo

obtener comentario 
Parameters
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetComment200Response
Ejemplo

obtener texto del comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetCommentText200Response
Ejemplo

obtener nombres de usuarios de votos del comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| dir | integer | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetCommentVoteUserNames200Response
Ejemplo

obtener comentarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No |
Respuesta
Devuelve: GetComments200Response
Ejemplo

obtener comentarios públicos 
req tenantId urlId
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Respuesta
Devuelve: GetCommentsPublic200Response
Ejemplo

bloquear comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: LockComment200Response
Ejemplo

fijar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: PinComment200Response
Ejemplo

guardar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: SaveComment200Response
Ejemplo

guardar comentarios en lote 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respuesta
Devuelve: Array<SaveComment200Response>
Ejemplo

establecer texto del comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| editKey | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: SetCommentText200Response
Ejemplo

desbloquear usuario por comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: UnBlockCommentPublic200Response
Ejemplo

desmarcar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: FlagComment200Response
Ejemplo

desbloquear comentario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: LockComment200Response
Ejemplo

desanclar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| broadcastId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: PinComment200Response
Ejemplo

actualizar comentario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| contextUserId | string | query | No | |
| doSpamCheck | boolean | query | No | |
| isLive | boolean | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

votar comentario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| commentId | string | path | Sí | |
| urlId | string | query | Sí | |
| broadcastId | string | query | Sí | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: VoteComment200Response
Ejemplo

agregar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddDomainConfig200Response
Ejemplo

eliminar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: DeleteDomainConfig200Response
Ejemplo

obtener configuración de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domain | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

obtener configuraciones de dominio 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetDomainConfigs200Response
Ejemplo

actualizar parcialmente configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Devuelve: GetDomainConfig200Response
Ejemplo

reemplazar configuración de dominio 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| domainToUpdate | string | path | Sí |
Respuesta
Returns: GetDomainConfig200Response
Ejemplo

crear plantilla de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateEmailTemplate200Response
Ejemplo

eliminar plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

eliminar error de renderizado de plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| errorId | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener plantilla de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetEmailTemplate200Response
Ejemplo

obtener definiciones de plantillas de correo 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetEmailTemplateDefinitions200Response
Ejemplo

obtener errores de renderizado de plantillas de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplateRenderErrors200Response
Ejemplo

obtener plantillas de correo 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetEmailTemplates200Response
Ejemplo

renderizar plantilla de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| locale | string | query | No |
Respuesta
Devuelve: RenderEmailTemplate200Response
Ejemplo

actualizar plantilla de correo 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener registro de eventos 
req tenantId urlId userIdWS
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| userIdWS | string | query | Sí | |
| startTime | integer | query | Sí | |
| endTime | integer | query | Sí |
Respuesta
Devuelve: GetEventLog200Response
Ejemplo

obtener registro global de eventos 
req tenantId urlId userIdWS
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| userIdWS | string | query | Sí | |
| startTime | integer | query | Sí | |
| endTime | integer | query | Sí |
Respuesta
Devuelve: GetEventLog200Response
Ejemplo

crear publicación de feed 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respuesta
Devuelve: CreateFeedPost200Response
Ejemplo

crear publicación de feed pública 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostPublic200Response
Ejemplo

eliminar publicación de feed pública 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: DeleteFeedPostPublic200Response
Ejemplo

obtener publicaciones del feed 
req tenantId afterId
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No |
Respuesta
Devuelve: GetFeedPosts200Response
Ejemplo

obtener publicaciones del feed públicas 
req tenantId afterId
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Respuesta
Devuelve: GetFeedPostsPublic200Response
Ejemplo

obtener estadísticas de publicaciones del feed 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetFeedPostsStats200Response
Ejemplo

obtener reacciones de usuario públicas 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postIds | array | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserReactsPublic200Response
Ejemplo

reaccionar a publicación de feed pública 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| isUndo | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ReactFeedPostPublic200Response
Ejemplo

actualizar publicación del feed 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

actualizar publicación del feed pública 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| postId | string | path | Sí | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: CreateFeedPostPublic200Response
Ejemplo

marcar comentario público 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | path | Sí | |
| isFlagged | boolean | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

agregar hashtag 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
Respuesta
Devuelve: AddHashTag200Response
Ejemplo

agregar hashtags en lote 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
Respuesta
Devuelve: AddHashTagsBulk200Response
Ejemplo

eliminar hashtag 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener hashtags 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| page | number | query | No |
Respuesta
Devuelve: GetHashTags200Response
Ejemplo

actualizar parcialmente hashtag 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Sí | |
| tenantId | string | query | No |
Respuesta
Devuelve: PatchHashTag200Response
Ejemplo

crear moderador 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateModerator200Response
Ejemplo

eliminar moderador 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sendEmail | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener moderador 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetModerator200Response
Ejemplo

obtener moderadores 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetModerators200Response
Ejemplo

enviar invitación 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| fromName | string | query | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

actualizar moderador 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

eliminar contador de notificaciones 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener contador de notificaciones en caché 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetCachedNotificationCount200Response
Ejemplo

obtener contador de notificaciones 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Respuesta
Devuelve: GetNotificationCount200Response
Ejemplo

obtener notificaciones 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetNotifications200Response
Ejemplo

actualizar notificación 
Parámetros
| Nombre | Type | Location | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

agregar página 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddPageAPIResponse
Ejemplo

eliminar página 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: DeletePageAPIResponse
Ejemplo

obtener página por urlid 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Respuesta
Devuelve: GetPageByURLIdAPIResponse
Ejemplo

obtener páginas 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: GetPagesAPIResponse
Ejemplo

actualizar parcialmente página 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: PatchPageAPIResponse
Ejemplo

eliminar evento de webhook pendiente 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener contador de eventos de webhook pendientes 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No |
Respuesta
Devuelve: GetPendingWebhookEventCount200Response
Ejemplo

obtener eventos de webhook pendientes 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| externalId | string | query | No | |
| eventType | string | query | No | |
| type | string | query | No | |
| domain | string | query | No | |
| attemptCountGT | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetPendingWebhookEvents200Response
Ejemplo

crear configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionConfig200Response
Ejemplo

eliminar configuración de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener configuración de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetQuestionConfig200Response
Ejemplo

obtener configuraciones de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionConfigs200Response
Ejemplo

actualizar configuración de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

crear resultado de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateQuestionResult200Response
Ejemplo

eliminar resultado de pregunta 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: GetQuestionResult200Response
Ejemplo

obtener resultados de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | No | |
| userId | string | query | No | |
| startDate | string | query | No | |
| questionId | string | query | No | |
| questionIds | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetQuestionResults200Response
Ejemplo

actualizar resultado de pregunta 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

agregar resultados de preguntas 
Parámetros
| Nombre | Type | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Respuesta
Devuelve: AggregateQuestionResults200Response
Ejemplo

agregar en lote resultados de preguntas 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| forceRecalculate | boolean | query | No |
Respuesta
Devuelve: BulkAggregateQuestionResults200Response
Ejemplo

combinar comentarios con resultados de preguntas 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No | |
| minValue | number | query | No | |
| maxValue | number | query | No | |
| limit | number | query | No |
Respuesta
Devuelve: CombineCommentsWithQuestionResults200Response
Ejemplo

agregar usuario SSO 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: AddSSOUserAPIResponse
Ejemplo

eliminar usuario SSO 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: DeleteSSOUserAPIResponse
Ejemplo

obtener usuario SSO por correo electrónico 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| string | path | Sí |
Respuesta
Devuelve: GetSSOUserByEmailAPIResponse
Ejemplo

obtener usuario SSO por id 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetSSOUserByIdAPIResponse
Ejemplo

obtener usuarios SSO 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | integer | query | No |
Respuesta
Devuelve: GetSSOUsers200Response
Ejemplo

actualizar parcialmente usuario SSO 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PatchSSOUserAPIResponse
Ejemplo

reemplazar usuario SSO 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | boolean | query | No |
Respuesta
Devuelve: PutSSOUserAPIResponse
Ejemplo

crear suscripción 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateSubscriptionAPIResponse
Ejemplo

eliminar suscripción 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: DeleteSubscriptionAPIResponse
Ejemplo

obtener suscripciones 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: GetSubscriptionsAPIResponse
Ejemplo

actualizar suscripción 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: UpdateSubscriptionAPIResponse
Ejemplo

obtener usos diarios del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantDailyUsages200Response
Ejemplo

crear paquete de inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantPackage200Response
Ejemplo

eliminar paquete de inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener paquete de inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respuesta
Devuelve: GetTenantPackage200Response
Ejemplo

obtener paquetes de inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantPackages200Response
Ejemplo

reemplazar paquete de inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

actualizar paquete de inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

crear usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenantUser200Response
Ejemplo

eliminar usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenantUser200Response
Ejemplo

obtener usuarios del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenantUsers200Response
Ejemplo

reemplazar usuario del inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

enviar enlace de inicio de sesión 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| redirectURL | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

actualizar usuario del inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| updateComments | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

crear inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateTenant200Response
Ejemplo

eliminar inquilino 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| sure | string | query | No |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

obtener inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetTenant200Response
Ejemplo

obtener inquilinos 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| meta | string | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetTenants200Response
Ejemplo

actualizar inquilino 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: FlagCommentPublic200Response
Ejemplo

cambiar estado del ticket 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: ChangeTicketState200Response
Ejemplo

crear ticket 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | Sí |
Respuesta
Devuelve: CreateTicket200Response
Ejemplo

obtener ticket 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| userId | string | query | No |
Respuesta
Devuelve: GetTicket200Response
Ejemplo

obtener tickets 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| state | number | query | No | |
| skip | number | query | No | |
| limit | number | query | No |
Respuesta
Devuelve: GetTickets200Response
Ejemplo

subir imagen 
Subir y redimensionar una imagen
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| sizePreset | string | query | No | Preajuste de tamaño: "Default" (1000x1000px) o "CrossPlatform" (genera tamaños para dispositivos populares) |
| urlId | string | query | No | ID de página desde la que se realiza la subida, para configurar |
Respuesta
Devuelve: UploadImageResponse
Ejemplo

obtener progreso de insignia de usuario por id 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUserBadgeProgressById200Response
Ejemplo

obtener progreso de insignia de usuario por id de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Respuesta
Devuelve: GetUserBadgeProgressById200Response
Ejemplo

obtener lista de progreso de insignias de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetUserBadgeProgressList200Response
Ejemplo

crear insignia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí |
Respuesta
Devuelve: CreateUserBadge200Response
Ejemplo

eliminar insignia de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: UpdateUserBadge200Response
Ejemplo

obtener insignia de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUserBadge200Response
Ejemplo

obtener insignias de usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respuesta
Devuelve: GetUserBadges200Response
Ejemplo

actualizar insignia de usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: UpdateUserBadge200Response
Ejemplo

obtener contador de notificaciones del usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotificationCount200Response
Ejemplo

obtener notificaciones del usuario 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: GetUserNotifications200Response
Ejemplo

restablecer contador de notificaciones del usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotifications200Response
Ejemplo

restablecer notificaciones del usuario 
Parámetros
| Name | Type | Location | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Respuesta
Devuelve: ResetUserNotifications200Response
Ejemplo

actualizar estado de suscripción a comentarios de notificación del usuario 
Habilitar o deshabilitar las notificaciones para un comentario específico.
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| optedInOrOut | string | path | Sí | |
| commentId | string | query | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

actualizar estado de suscripción a página de notificación del usuario 
Habilitar o deshabilitar las notificaciones para una página. Cuando los usuarios están suscritos a una página, se crean notificaciones para nuevos comentarios raíz, y también
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

actualizar estado de notificación del usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| notificationId | string | path | Sí | |
| newStatus | string | path | Sí | |
| sso | string | query | No |
Respuesta
Devuelve: UpdateUserNotificationStatus200Response
Ejemplo

obtener estados de presencia de usuarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlIdWS | string | query | Sí | |
| userIds | string | query | Sí |
Respuesta
Devuelve: GetUserPresenceStatuses200Response
Ejemplo

buscar usuarios 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Sí | |
| urlId | string | query | Sí | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Respuesta
Devuelve: SearchUsers200Response
Ejemplo

obtener usuario 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí |
Respuesta
Devuelve: GetUser200Response
Ejemplo

crear voto 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| commentId | string | query | Sí | |
| direction | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: VoteComment200Response
Ejemplo

eliminar voto 
Parámetros
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| id | string | path | Sí | |
| editKey | string | query | No |
Respuesta
Devuelve: DeleteCommentVote200Response
Ejemplo

obtener votos 
Parámetros
| Nombre | Tipo | Ubicación | Obligatorio | Descripción |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes |
Respuesta
Devuelve: GetVotes200Response
Ejemplo

obtener votos del usuario 
Parámetros
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Sí | |
| urlId | string | query | Sí | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respuesta
Devuelve: GetVotesForUser200Response
Ejemplo

¿Necesitas ayuda?
Si encuentras algún problema o tienes preguntas sobre el SDK de Ruby, por favor:
Contribuciones
¡Las contribuciones son bienvenidas! Por favor visita el repositorio de GitHub para las directrices de contribución.