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.

Documentación de la biblioteca del cliente de 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 DefaultApi para solicitudes autenticadas del lado del servidor, PublicApi para 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
tenantId	string	query	Sí
parentTenantId	string	query	No
includeStats	boolean	query	No

Respuesta

Devuelve: AggregationResponse

Ejemplo

Ejemplo de aggregate

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest | 
opts = {
  parent_tenant_id: 'parent_tenant_id_example', # String | 
  include_stats: true # Boolean | 
}
begin
  
  result = api_instance.aggregate(tenant_id, aggregation_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate: #{e}"
end

obtener_registros_de_auditoría

Parámetros

Name	Type	Location	Required
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

Ejemplo de get_audit_logs

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

bloquear_desde_comentario_público

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
commentId	string	path	Sí
sso	string	query	No

Respuesta

Devuelve: BlockFromCommentPublic200Response

Ejemplo

Ejemplo de block_from_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->block_from_comment_public: #{e}"
end

desbloquear_comentario_público

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
commentId	string	path	Sí
sso	string	query	No

Respuesta

Devuelve: UnBlockCommentPublic200Response

Ejemplo

Ejemplo de un_block_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_block_comment_public: #{e}"
end

comprobar_comentarios_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

Ejemplo de checked_comments_for_blocked

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | Una lista separada por comas de IDs de comentario.
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
end

bloquear_usuario_desde_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
userId	string	query	No
anonUserId	string	query	No

Respuesta

Devuelve: BlockFromCommentPublic200Response

Ejemplo

Ejemplo de block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

crear_comentario_público

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	path	Yes
urlId	string	query	Yes
broadcastId	string	query	Yes
sessionId	string	query	No
sso	string	query	No

Respuesta

Devuelve: CreateCommentPublic200Response

Ejemplo

Ejemplo de create_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_comment_public: #{e}"
end

eliminar_comentario

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	query	Sí
id	string	path	Sí
contextUserId	string	query	No
isLive	boolean	query	No

Respuesta

Devuelve: DeleteComment200Response

Ejemplo

Ejemplo de delete_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p.ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

eliminar_comentario_público

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	path	Sí
commentId	string	path	Sí
broadcastId	string	query	Sí
editKey	string	query	No
sso	string	query	No

Respuesta

Devuelve: DeleteCommentPublic200Response

Ejemplo

Ejemplo de delete_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_public: #{e}"
end

eliminar_voto_de_comentario

Parámetros

Name	Tipo	Ubicación	Requerido
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

Ejemplo de delete_comment_vote

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Cadena | 
comment_id = 'comment_id_example' # Cadena | 
vote_id = 'vote_id_example' # Cadena | 
url_id = 'url_id_example' # Cadena | 
broadcast_id = 'broadcast_id_example' # Cadena | 
opts = {
  edit_key: 'edit_key_example', # Cadena | 
  sso: 'sso_example' # Cadena | 
}
begin
  
  result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_vote: #{e}"
end

marcar_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
userId	string	query	No
anonUserId	string	query	No

Respuesta

Devuelve: FlagComment200Response

Ejemplo

Ejemplo de flag_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

obtener_comentario

Parameters

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetComment200Response

Ejemplo

Ejemplo de get_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

obtener_texto_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
commentId	string	path	Sí
editKey	string	query	No
sso	string	query	No

Respuesta

Devuelve: GetCommentText200Response

Ejemplo

Ejemplo de get_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_text: #{e}"
end

obtener_nombres_de_usuarios_que_votaron_en_comentario

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	path	Sí
commentId	string	path	Sí
dir	integer	query	Sí
sso	string	query	No

Respuesta

Devuelve: GetCommentVoteUserNames200Response

Ejemplo

Ejemplo de get_comment_vote_user_names

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
dir = 56 # Integer | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
end

obtener_comentarios

Parámetros

Name	Type	Location	Required
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

Ejemplo de get_comments

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF # SortDirections | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

obtener_comentarios_públicos

req tenantId urlId

Parámetros

Nombre	Tipo	Ubicación	Requerido
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

Ejemplo de get_comments_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  page: 56, # Integer | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  sso: 'sso_example', # String | 
  skip: 56, # Integer | 
  skip_children: 56, # Integer | 
  limit: 56, # Integer | 
  limit_children: 56, # Integer | 
  count_children: true, # Boolean | 
  fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String | 
  include_config: true, # Boolean | 
  count_all: true, # Boolean | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  modules: 'modules_example', # String | 
  is_crawler: true, # Boolean | 
  include_notification_count: true, # Boolean | 
  as_tree: true, # Boolean | 
  max_tree_depth: 56, # Integer | 
  use_full_translation_ids: true, # Boolean | 
  parent_id: 'parent_id_example', # String | 
  search_text: 'search_text_example', # String | 
  hash_tags: ['inner_example'], # Array<String> | 
  user_id: 'user_id_example', # String | 
  custom_config_str: 'custom_config_str_example', # String | 
  after_comment_id: 'after_comment_id_example', # String | 
  before_comment_id: 'before_comment_id_example' # String | 
}
begin
  
  result = api_instance.get_comments_public(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_public: #{e}"
end

bloquear_comentario

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	path	Sí
commentId	string	path	Sí
broadcastId	string	query	Sí
sso	string	query	No

Respuesta

Devuelve: LockComment200Response

Ejemplo

Ejemplo de lock_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->lock_comment: #{e}"
end

fijar_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
commentId	string	path	Sí
broadcastId	string	query	Sí
sso	string	query	No

Respuesta

Devuelve: PinComment200Response

Ejemplo

Ejemplo de pin_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->pin_comment: #{e}"
end

guardar_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Respuesta

Devuelve: SaveComment200Response

Ejemplo

Ejemplo de save_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

guardar_comentarios_en_masa

Parámetros

Name	Type	Location	Required
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

Ejemplo de save_comments_bulk

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

establecer_texto_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
commentId	string	path	Sí
broadcastId	string	query	Sí
editKey	string	query	No
sso	string	query	No

Respuesta

Devuelve: SetCommentText200Response

Ejemplo

Ejemplo de set_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->set_comment_text: #{e}"
end

desbloquear_usuario_desde_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Yes
id	string	path	Yes
userId	string	query	No
anonUserId	string	query	No

Respuesta

Devuelve: UnBlockCommentPublic200Response

Ejemplo

Ejemplo de un_block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

desmarcar_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
userId	string	query	No
anonUserId	string	query	No

Respuesta

Devuelve: FlagComment200Response

Ejemplo

un_flag_comment Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de la clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave de API, p.ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

desbloquear_comentario

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	path	Sí
commentId	string	path	Sí
broadcastId	string	query	Sí
sso	string	query	No

Respuesta

Devuelve: LockComment200Response

Ejemplo

Ejemplo de un_lock_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_lock_comment: #{e}"
end

desfijar_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
commentId	string	path	Sí
broadcastId	string	query	Sí
sso	string	query	No

Respuesta

Devuelve: PinComment200Response

Ejemplo

Ejemplo de un_pin_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_pin_comment: #{e}"
end

actualizar_comentario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
contextUserId	string	query	No
doSpamCheck	boolean	query	No
isLive	boolean	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo update_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  do_spam_check: true, # Boolean | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_comment: #{e}"
end

votar_comentario

Parámetros

Nombre	Tipo	Ubicación	Requerido
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

Ejemplo de vote_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->vote_comment: #{e}"
end

añadir_configuración_de_dominio

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí

Respuesta

Devuelve: AddDomainConfig200Response

Ejemplo

Ejemplo de add_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

eliminar_configuración_de_dominio

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
domain	string	path	Sí

Respuesta

Devuelve: DeleteDomainConfig200Response

Ejemplo

Ejemplo de delete_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

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

Ejemplo de get_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

obtener_configuraciones_de_dominio

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: GetDomainConfigs200Response

Ejemplo

Ejemplo de get_domain_configs

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

parchear_configuración_de_dominio

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
domainToUpdate	string	path	Sí

Respuesta

Devuelve: GetDomainConfig200Response

Ejemplo

patch_domain_config Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

reemplazar_configuración_de_dominio

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
domainToUpdate	string	path	Sí

Respuesta

Returns: GetDomainConfig200Response

Ejemplo

Ejemplo de put_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización mediante la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

crear_plantilla_de_correo

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: CreateEmailTemplate200Response

Ejemplo

Ejemplo de create_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

eliminar_plantilla_de_correo

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

eliminar_error_de_renderizado_de_plantilla_de_correo

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
errorId	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo delete_email_template_render_error

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
error_id = 'error_id_example' # String | 
begin
  
  result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
end

obtener_plantilla_de_correo

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetEmailTemplate200Response

Ejemplo

Ejemplo de get_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

obtener_definiciones_de_plantillas_de_correo

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: GetEmailTemplateDefinitions200Response

Ejemplo

Ejemplo de get_email_template_definitions

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Cadena | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

obtener_errores_de_renderizado_de_plantillas_de_correo

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
id	string	path	Sí
skip	number	query	No

Respuesta

Devuelve: GetEmailTemplateRenderErrors200Response

Ejemplo

Ejemplo de get_email_template_render_errors

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

obtener_plantillas_de_correo

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
skip	number	query	No

Respuesta

Devuelve: GetEmailTemplates200Response

Ejemplo

Ejemplo de get_email_templates

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

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

Ejemplo de render_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

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

Ejemplo de update_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

obtener_registro_de_eventos

req tenantId urlId userIdWS

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	path	Sí
urlId	string	query	Sí
userIdWS	string	query	Sí
startTime	integer	query	Sí
endTime	integer	query	Sí

Respuesta

Devuelve: GetEventLog200Response

Ejemplo

Ejemplo de get_event_log

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Cadena | 
url_id = 'url_id_example' # Cadena | 
user_id_ws = 'user_id_ws_example' # Cadena | 
start_time = 789 # Entero | 
end_time = 789 # Entero | 
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

obtener_registro_global_de_eventos

req tenantId urlId userIdWS

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	path	Sí
urlId	string	query	Sí
userIdWS	string	query	Sí
startTime	integer	query	Sí
endTime	integer	query	Sí

Respuesta

Devuelve: GetEventLog200Response

Ejemplo

Ejemplo de get_global_event_log

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
end_time = 789 # Integer | 
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

crear_publicación_de_feed

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	query	Sí
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

Respuesta

Devuelve: CreateFeedPost200Response

Ejemplo

Ejemplo de create_feed_post

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

crear_publicación_de_feed_pública

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	path	Sí
broadcastId	string	query	No
sso	string	query	No

Respuesta

Devuelve: CreateFeedPostPublic200Response

Ejemplo

Ejemplo de create_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_feed_post_public: #{e}"
end

eliminar_publicación_de_feed_pública

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	path	Sí
postId	string	path	Sí
broadcastId	string	query	No
sso	string	query	No

Respuesta

Devuelve: DeleteFeedPostPublic200Response

Ejemplo

Ejemplo de delete_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
end

obtener_publicaciones_de_feed

req tenantId afterId

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	query	Sí
afterId	string	query	No
limit	integer	query	No
tags	array	query	No

Respuesta

Devuelve: GetFeedPosts200Response

Ejemplo

Ejemplo de get_feed_posts

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

obtener_publicaciones_de_feed_públicas

req tenantId afterId

Parámetros

Nombre	Tipo	Ubicación	Requerido
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

Ejemplo de get_feed_posts_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  is_crawler: true, # Boolean | 
  include_user_info: true # Boolean | 
}
begin
  
  result = api_instance.get_feed_posts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
end

obtener_estadísticas_de_publicaciones_de_feed

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	path	Sí
postIds	array	query	Sí
sso	string	query	No

Respuesta

Devuelve: GetFeedPostsStats200Response

Ejemplo

Ejemplo de get_feed_posts_stats

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_ids = ['inner_example'] # Array<String> | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
end

obtener_reacciones_de_usuario_públicas

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	path	Sí
postIds	array	query	No
sso	string	query	No

Respuesta

Devuelve: GetUserReactsPublic200Response

Ejemplo

Ejemplo de get_user_reacts_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  post_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_reacts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
end

reaccionar_publicación_de_feed_pública

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
postId	string	path	Sí
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Respuesta

Devuelve: ReactFeedPostPublic200Response

Ejemplo

Ejemplo de react_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->react_feed_post_public: #{e}"
end

actualizar_publicación_de_feed

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_feed_post

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (valor por defecto: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost | 
begin
  
  result = api_instance.update_feed_post(tenant_id, id, feed_post)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_feed_post: #{e}"
end

actualizar_publicación_de_feed_pública

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
postId	string	path	Sí
broadcastId	string	query	No
sso	string	query	No

Respuesta

Devuelve: CreateFeedPostPublic200Response

Ejemplo

Ejemplo de update_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_feed_post_public: #{e}"
end

marcar_comentario_público

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
commentId	string	path	Sí
isFlagged	boolean	query	Sí
sso	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de flag_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
is_flagged = true # Boolean | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->flag_comment_public: #{e}"
end

añadir_hashtag

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	No

Respuesta

Devuelve: AddHashTag200Response

Ejemplo

Ejemplo de add_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
opts = {
  tenant_id: 'tenant_id_example', # String | 
  create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
}
begin
  
  result = api_instance.add_hash_tag(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

añadir_hashtags_en_masa

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	No

Respuesta

Devuelve: AddHashTagsBulk200Response

Ejemplo

Ejemplo de add_hash_tags_bulk

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
opts = {
  tenant_id: 'tenant_id_example', # String | 
  bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
}
begin
  
  result = api_instance.add_hash_tags_bulk(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

eliminar_hashtag

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tag	string	path	Yes
tenantId	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tag = 'tag_example' # String | 
opts = {
  tenant_id: 'tenant_id_example', # String | 
  delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest | 
}
begin
  
  result = api_instance.delete_hash_tag(tag, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

obtener_hashtags

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
page	number	query	No

Respuesta

Devuelve: GetHashTags200Response

Ejemplo

Ejemplo de get_hash_tags

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización mediante la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

parchear_hashtag

Parámetros

Name	Type	Location	Required	Description
tag	string	path	Sí
tenantId	string	query	No

Respuesta

Devuelve: PatchHashTag200Response

Ejemplo

Ejemplo de patch_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tag = 'tag_example' # String | 
opts = {
  tenant_id: 'tenant_id_example', # String | 
  update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
}
begin
  
  result = api_instance.patch_hash_tag(tag, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

crear_moderador

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: CreateModerator200Response

Ejemplo

Ejemplo de create_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

eliminar_moderador

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
id	string	path	Sí
sendEmail	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

obtener_moderador

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetModerator200Response

Ejemplo

Ejemplo de get_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

obtener_moderadores

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
skip	number	query	No

Respuesta

Devuelve: GetModerators200Response

Ejemplo

Ejemplo de get_moderators

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

enviar_invitación

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
fromName	string	query	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de send_invite

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

actualizar_moderador

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

eliminar_conteo_de_notificaciones

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

obtener_conteo_de_notificaciones_en_cache

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetCachedNotificationCount200Response

Ejemplo

Ejemplo de get_cached_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización con la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

obtener_conteo_de_notificaciones

Parámetros

Name	Type	Location	Required
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

Ejemplo de get_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example' # String | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

obtener_notificaciones

Parámetros

Nombre	Tipo	Ubicación	Requerido
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

Ejemplo de get_notifications

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

actualizar_notificación

Parámetros

Nombre	Type	Location	Obligatorio
tenantId	string	query	Sí
id	string	path	Sí
userId	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_notification

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

añadir_página

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: AddPageAPIResponse

Ejemplo

Ejemplo de add_page

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

eliminar_página

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: DeletePageAPIResponse

Ejemplo

Ejemplo de delete_page

Copy

require 'time'
require 'fastcomments-client'
# Configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_page(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_page: #{e}"
end

obtener_página_por_urlid

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Yes
urlId	string	query	Yes

Respuesta

Devuelve: GetPageByURLIdAPIResponse

Ejemplo

Ejemplo de get_page_by_urlid

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con la API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la línea siguiente para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

obtener_páginas

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: GetPagesAPIResponse

Ejemplo

Ejemplo de get_pages

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización con clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave de API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

parchear_página

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: PatchPageAPIResponse

Ejemplo

Ejemplo de patch_page

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

eliminar_evento_pending_webhook

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_pending_webhook_event

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

obtener_conteo_de_eventos_pending_webhook

Parámetros

Nombre	Tipo	Ubicación	Requerido
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

Ejemplo de get_pending_webhook_event_count

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

obtener_eventos_pending_webhook

Parámetros

Name	Type	Location	Required
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

Ejemplo de get_pending_webhook_events

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

crear_configuración_de_pregunta

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: CreateQuestionConfig200Response

Ejemplo

Ejemplo de create_question_config

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

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

Ejemplo de delete_question_config

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

obtener_configuración_de_pregunta

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetQuestionConfig200Response

Ejemplo

Ejemplo de get_question_config

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

obtener_configuraciones_de_preguntas

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
skip	number	query	No

Respuesta

Devuelve: GetQuestionConfigs200Response

Ejemplo

Ejemplo de get_question_configs

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_configs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_configs: #{e}"
end

actualizar_configuración_de_pregunta

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

update_question_config Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

crear_resultado_de_pregunta

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí

Respuesta

Devuelve: CreateQuestionResult200Response

Ejemplo

Ejemplo de create_question_result

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

eliminar_resultado_de_pregunta

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

delete_question_result Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

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

Ejemplo de get_question_result

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

obtener_resultados_de_preguntas

Parámetros

Name	Type	Location	Required
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

Ejemplo de get_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

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

Ejemplo de update_question_result

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

agregar_resultados_de_preguntas

Parámetros

Nombre	Type	Ubicación	Requerido
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

Ejemplo de aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

agregar_resultados_de_preguntas_en_masa

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
forceRecalculate	boolean	query	No

Respuesta

Devuelve: BulkAggregateQuestionResults200Response

Ejemplo

Ejemplo de bulk_aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

combinar_comentarios_con_resultados_de_preguntas

Parámetros

Name	Type	Location	Required
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

Ejemplo de combine_comments_with_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

añadir_usuario_sso

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: AddSSOUserAPIResponse

Ejemplo

Ejemplo de add_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData | 
begin
  
  result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_sso_user: #{e}"
end

eliminar_usuario_sso

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
deleteComments	boolean	query	No
commentDeleteMode	string	query	No

Respuesta

Devuelve: DeleteSSOUserAPIResponse

Ejemplo

Ejemplo de delete_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

obtener_usuario_sso_por_email

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
email	string	path	Sí

Respuesta

Devuelve: GetSSOUserByEmailAPIResponse

Ejemplo

Ejemplo de get_sso_user_by_email

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

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

Ejemplo de get_sso_user_by_id

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
end

obtener_usuarios_sso

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
skip	integer	query	No

Respuesta

Devuelve: GetSSOUsers200Response

Ejemplo

Ejemplo de get_sso_users

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 56 # Integer | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

parchear_usuario_sso

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
id	string	path	Sí
updateComments	boolean	query	No

Respuesta

Devuelve: PatchSSOUserAPIResponse

Ejemplo

Ejemplo de patch_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave de API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

reemplazar_usuario_sso

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
id	string	path	Sí
updateComments	boolean	query	No

Respuesta

Devuelve: PutSSOUserAPIResponse

Ejemplo

Ejemplo de put_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_sso_user: #{e}"
end

crear_suscripción

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí

Respuesta

Devuelve: CreateSubscriptionAPIResponse

Ejemplo

Ejemplo de create_subscription

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización mediante clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave de la API, por ejemplo 'Bearer' (predeterminado: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

eliminar_suscripción

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
userId	string	query	No

Respuesta

Devuelve: DeleteSubscriptionAPIResponse

Ejemplo

delete_subscription Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

obtener_suscripciones

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
userId	string	query	No

Respuesta

Devuelve: GetSubscriptionsAPIResponse

Ejemplo

Ejemplo de get_subscriptions

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (predeterminado: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_subscriptions(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_subscriptions: #{e}"
end

obtener_uso_diario_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	query	Sí
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

Respuesta

Devuelve: GetTenantDailyUsages200Response

Ejemplo

Ejemplo de get_tenant_daily_usages

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

crear_paquete_del_tenant

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí

Respuesta

Devuelve: CreateTenantPackage200Response

Ejemplo

Ejemplo de create_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configuración de autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

eliminar_paquete_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (valor predeterminado nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

obtener_paquete_del_tenant

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Yes
id	string	path	Yes

Respuesta

Devuelve: GetTenantPackage200Response

Ejemplo

Ejemplo de get_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

obtener_paquetes_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
skip	number	query	No

Respuesta

Devuelve: GetTenantPackages200Response

Ejemplo

Ejemplo de get_tenant_packages

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

reemplazar_paquete_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

replace_tenant_package Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configuración de autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización mediante la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

actualizar_paquete_del_tenant

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

crear_usuario_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí

Respuesta

Devuelve: CreateTenantUser200Response

Ejemplo

create_tenant_user Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody | 
begin
  
  result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_user: #{e}"
end

eliminar_usuario_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

obtener_usuario_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetTenantUser200Response

Ejemplo

Ejemplo de get_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# Configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la línea siguiente para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

obtener_usuarios_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Sí
skip	number	query	No

Respuesta

Devuelve: GetTenantUsers200Response

Ejemplo

Ejemplo de get_tenant_users

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

reemplazar_usuario_del_tenant

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
updateComments	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo replace_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
end

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
tenantId	string	query	Sí
id	string	path	Sí
redirectURL	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de send_login_link

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

actualizar_usuario_del_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
id	string	path	Sí
updateComments	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

crear_tenant

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí

Respuesta

Devuelve: CreateTenant200Response

Ejemplo

Ejemplo de create_tenant

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

eliminar_tenant

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
id	string	path	Sí
sure	string	query	No

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

delete_tenant Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Cadena | 
id = 'id_example' # Cadena | 
opts = {
  sure: 'sure_example' # Cadena | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

obtener_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetTenant200Response

Ejemplo

Ejemplo de get_tenant

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de la clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave de la API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

obtener_tenants

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
meta	string	query	No
skip	number	query	No

Respuesta

Devuelve: GetTenants200Response

Ejemplo

Ejemplo de get_tenants

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave de la API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

actualizar_tenant

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_tenant

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

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

Ejemplo de upload_image

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
file = File.new('/path/to/some/file') # File | 
opts = {
  size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Preajuste de tamaño: \"Default\" (1000x1000px) o \"CrossPlatform\" (genera tamaños para dispositivos populares)
  url_id: 'url_id_example' # String | ID de página desde la que se realiza la subida, para configurar
}
begin
  
  result = api_instance.upload_image(tenant_id, file, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->upload_image: #{e}"
end

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

Ejemplo de get_user_badge_progress_by_id

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

obtener_progreso_de_insignia_de_usuario_por_user_id

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Yes
userId	string	path	Yes

Respuesta

Devuelve: GetUserBadgeProgressById200Response

Ejemplo

Ejemplo de get_user_badge_progress_by_user_id

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la API key, p.ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

obtener_lista_de_progreso_de_insignias_de_usuario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
userId	string	query	No
limit	number	query	No
skip	number	query	No

Respuesta

Devuelve: GetUserBadgeProgressList200Response

Ejemplo

Ejemplo de get_user_badge_progress_list

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave de la API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

crear_insignia_de_usuario

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí

Respuesta

Devuelve: CreateUserBadge200Response

Ejemplo

Ejemplo de create_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización con clave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave de API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

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

Ejemplo delete_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

obtener_insignia_de_usuario

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetUserBadge200Response

Ejemplo

Ejemplo de get_user_badge

Copy

require 'time'
require 'fastcomments-client'
# Configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

obtener_insignias_de_usuario

Parámetros

Name	Type	Location	Required
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

Ejemplo de get_user_badges

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  badge_id: 'badge_id_example', # String | 
  type: 1.2, # Float | 
  displayed_on_comments: true, # Boolean | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

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

Ejemplo de update_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

obtener_conteo_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

Ejemplo de get_user_notification_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notification_count: #{e}"
end

obtener_notificaciones_del_usuario

Parámetros

Nombre	Tipo	Ubicación	Obligatorio
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

Ejemplo de get_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page_size: 56, # Integer | 
  after_id: 'after_id_example', # String | 
  include_context: true, # Boolean | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  include_translations: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notifications: #{e}"
end

restablecer_conteo_de_notificaciones_del_usuario

Parámetros

Name	Type	Location	Required	Description
tenantId	string	query	Sí
sso	string	query	No

Respuesta

Devuelve: ResetUserNotifications200Response

Ejemplo

Ejemplo de reset_user_notification_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
end

restablecer_notificaciones_del_usuario

Parámetros

Name	Type	Location	Requerido
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

Ejemplo de reset_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notifications: #{e}"
end

actualizar_estado_de_suscripción_a_comentarios_del_usuario

Habilitar o deshabilitar las notificaciones para un comentario específico.

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
notificationId	string	path	Sí
optedInOrOut	string	path	Sí
commentId	string	query	Sí
sso	string	query	No

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de update_user_notification_comment_subscription_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
opted_in_or_out = 'in' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
end

actualizar_estado_de_suscripción_a_página_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
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

Ejemplo de update_user_notification_page_subscription_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Cadena | 
url_id = 'url_id_example' # Cadena | 
url = 'url_example' # Cadena | 
page_title = 'page_title_example' # Cadena | 
subscribed_or_unsubscribed = 'subscribe' # Cadena | 
opts = {
  sso: 'sso_example' # Cadena | 
}
begin
  
  result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
end

actualizar_estado_de_notificación_del_usuario

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
notificationId	string	path	Sí
newStatus	string	path	Sí
sso	string	query	No

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de update_user_notification_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
new_status = 'read' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_status: #{e}"
end

obtener_estados_de_presencia_de_usuarios

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
urlIdWS	string	query	Sí
userIds	string	query	Sí

Respuesta

Devuelve: GetUserPresenceStatuses200Response

Ejemplo

Ejemplo de get_user_presence_statuses

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Cadena | 
url_id_ws = 'url_id_ws_example' # Cadena | 
user_ids = 'user_ids_example' # Cadena | 
begin
  
  result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
end

buscar_usuarios

Parámetros

Name	Type	Location	Required
tenantId	string	path	Sí
urlId	string	query	Sí
usernameStartsWith	string	query	Sí
mentionGroupIds	array	query	No
sso	string	query	No

Respuesta

Devuelve: SearchUsers200Response

Ejemplo

Ejemplo de search_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
username_starts_with = 'username_starts_with_example' # String | 
opts = {
  mention_group_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.search_users(tenant_id, url_id, username_starts_with, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->search_users: #{e}"
end

obtener_usuario

Parámetros

Nombre	Tipo	Ubicación	Requerido	Descripción
tenantId	string	query	Sí
id	string	path	Sí

Respuesta

Devuelve: GetUser200Response

Ejemplo

Ejemplo de get_user

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

crear_voto

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
commentId	string	query	Sí
direction	string	query	Sí
userId	string	query	No
anonUserId	string	query	No

Respuesta

Devuelve: VoteComment200Response

Ejemplo

Ejemplo de create_vote

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización de clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (predeterminado a nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
direction = 'up' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

eliminar_voto

Parámetros

Nombre	Tipo	Ubicación	Requerido
tenantId	string	query	Sí
id	string	path	Sí
editKey	string	query	No

Respuesta

Devuelve: DeleteCommentVote200Response

Ejemplo

Ejemplo de delete_vote

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # Cadena | 
id = 'id_example' # Cadena | 
opts = {
  edit_key: 'edit_key_example' # Cadena | 
}
begin
  
  result = api_instance.delete_vote(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_vote: #{e}"
end

obtener_votos

Parámetros

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	query	Yes
urlId	string	query	Yes

Respuesta

Devuelve: GetVotes200Response

Ejemplo

Ejemplo de get_votes

Copy

require 'time'
require 'fastcomments-client'
# configurar la autorización
FastCommentsClient.configure do |config|
  # Configurar la autorización de la clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

obtener_votos_por_usuario

Parámetros

Name	Type	Location	Required
tenantId	string	query	Sí
urlId	string	query	Sí
userId	string	query	No
anonUserId	string	query	No

Respuesta

Devuelve: GetVotesForUser200Response

Ejemplo

get_votes_for_user Ejemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorización
FastCommentsClient.configure do |config|
  # Configurar autorización por clave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
end

¿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.

Idioma 🇪🇸 Español

Primeros pasos

Documentación

Uso

Agregación

Registros de auditoría

Bloquear desde comentario

Comprobar comentarios bloqueados

Comentarios

Configuraciones de dominio

Plantillas de correo electrónico

Registro de eventos

Publicaciones del feed

Marcar comentario

Hashtags

Moderadores

Conteo 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 tenant

Paquetes del tenant

Usuarios del tenant

Tenants

Subir imagen

Progreso de insignias del usuario

Insignias de usuario

Notificaciones de usuario

Estado de presencia de usuario

Búsqueda de usuarios

Usuarios

Votos

FastComments Ruby SDK

Repositorio

Instalación

Library Contents

Public vs Secured APIs

Inicio rápido

Uso de APIs autenticadas (DefaultApi)

Uso de APIs públicas (PublicApi)

Problemas comunes

Notas

IDs de transmisión

SSO (Inicio de sesión único)

Uso de SSO

SSO simple

SSO seguro

agregar

Parámetros

Respuesta

Ejemplo

obtener_registros_de_auditoría

Parámetros

Respuesta

Ejemplo

bloquear_desde_comentario_público

Parámetros

Respuesta

Ejemplo

desbloquear_comentario_público

Parámetros

Respuesta

Ejemplo

comprobar_comentarios_bloqueados

Parámetros

Respuesta

Ejemplo

bloquear_usuario_desde_comentario

Parámetros

Respuesta

Ejemplo

crear_comentario_público

Parámetros

Respuesta

Ejemplo