FastComments.com

SDK de FastComments para Ruby


Este es el SDK oficial de Ruby para FastComments.

SDK oficial de Ruby para la API de FastComments

Repositorio

Ver en GitHub


Instalación Internal Link

Añade esta línea al Gemfile de tu aplicación:

gem 'fastcomments'

Y luego ejecuta:

bundle install

O instálalo manualmente con:

gem install fastcomments

Library Contents

Esta biblioteca contiene el cliente de API generado y las utilidades SSO para facilitar el trabajo con la API.

Public vs Secured APIs

Para el cliente de la API, hay dos clases, DefaultApi y PublicApi. The DefaultApi contains methods that require your API key, and PublicApi contains api calls that can be made directly from a browser/mobile device/etc without authentication.

Inicio rápido Internal Link

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

  1. 401 "missing-api-key" error: Asegúrate de establecer config.api_key['x-api-key'] = 'YOUR_KEY' antes de crear la instancia DefaultApi.
  2. Wrong API class: Usa DefaultApi para solicitudes autenticadas del lado del servidor, PublicApi para solicitudes del lado del cliente/públicas.
  3. Null API key: El SDK omitirá silenciosamente la autenticación si la clave API es null, lo que provocará errores 401.

Notas Internal Link

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 Internal Link

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 Internal Link

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

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
parentTenantIdstringqueryNo
includeStatsbooleanqueryNo

Respuesta

Devuelve: AggregationResponse

Ejemplo

Ejemplo de aggregate
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
15opts = {
16 parent_tenant_id: 'parent_tenant_id_example', # String |
17 include_stats: true # Boolean |
18}
19
20begin
21
22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->aggregate: #{e}"
26end
27

obtener registros de auditoría Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Respuesta

Devuelve: GetAuditLogs200Response

Ejemplo

Ejemplo de get_audit_logs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 limit: 1.2, # Float |
16 skip: 1.2, # Float |
17 order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
18 after: 1.2, # Float |
19 before: 1.2 # Float |
20}
21
22begin
23
24 result = api_instance.get_audit_logs(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_audit_logs: #{e}"
28end
29

bloquear desde comentario público Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Respuesta

Devuelve: BlockFromCommentPublic200Response

Ejemplo

Ejemplo de block_from_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->block_from_comment_public: #{e}"
19end
20

desbloquear comentario público Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringpath
ssostringqueryNo

Respuesta

Devuelve: UnBlockCommentPublic200Response

Ejemplo

Ejemplo de un_block_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_block_comment_public: #{e}"
19end
20

comentarios marcados como bloqueados Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdsstringqueryUna lista separada por comas de IDs de comentario.
ssostringqueryNo

Respuesta

Devuelve: CheckedCommentsForBlocked200Response

Ejemplo

Ejemplo de checked_comments_for_blocked
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_ids = 'comment_ids_example' # String | Una lista separada por comas de IDs de comentario.
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
18end
19

bloquear usuario por comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Respuesta

Devuelve: BlockFromCommentPublic200Response

Ejemplo

Ejemplo de block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
27end
28

crear comentario público Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

Respuesta

Devuelve: CreateCommentPublic200Response

Ejemplo

Ejemplo de create_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData |
10opts = {
11 session_id: 'session_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->create_comment_public: #{e}"
21end
22

eliminar comentario Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath
contextUserIdstringqueryNo
isLivebooleanqueryNo

Respuesta

Devuelve: DeleteComment200Response

Ejemplo

Ejemplo de delete_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p.ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 context_user_id: 'context_user_id_example', # String |
17 is_live: true # Boolean |
18}
19
20begin
21
22 result = api_instance.delete_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_comment: #{e}"
26end
27

eliminar comentario público Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Respuesta

Devuelve: DeleteCommentPublic200Response

Ejemplo

Ejemplo de delete_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 edit_key: 'edit_key_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->delete_comment_public: #{e}"
20end
21

eliminar voto de comentario Internal Link

Parámetros

NameTipoUbicaciónRequeridoDescripción
tenantIdstringpath
commentIdstringpath
voteIdstringpath
urlIdstringquery
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Respuesta

Devuelve: DeleteCommentVote200Response

Ejemplo

Ejemplo de delete_comment_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Cadena |
7comment_id = 'comment_id_example' # Cadena |
8vote_id = 'vote_id_example' # Cadena |
9url_id = 'url_id_example' # Cadena |
10broadcast_id = 'broadcast_id_example' # Cadena |
11opts = {
12 edit_key: 'edit_key_example', # Cadena |
13 sso: 'sso_example' # Cadena |
14}
15
16begin
17
18 result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->delete_comment_vote: #{e}"
22end
23

marcar comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Respuesta

Devuelve: FlagComment200Response

Ejemplo

Ejemplo de flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->flag_comment: #{e}"
26end
27

obtener comentario Internal Link

Parameters

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetComment200Response

Ejemplo

Ejemplo de get_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_comment(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_comment: #{e}"
22end
23

obtener texto del comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
editKeystringqueryNo
ssostringqueryNo

Respuesta

Devuelve: GetCommentText200Response

Ejemplo

Ejemplo de get_comment_text
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 edit_key: 'edit_key_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.get_comment_text(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_text: #{e}"
19end
20

obtener nombres de usuarios de votos del comentario Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringpath
commentIdstringpath
dirintegerquery
ssostringqueryNo

Respuesta

Devuelve: GetCommentVoteUserNames200Response

Ejemplo

Ejemplo de get_comment_vote_user_names
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8dir = 56 # Integer |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
19end
20

obtener comentarios Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo

Respuesta

Devuelve: GetComments200Response

Ejemplo

Ejemplo de get_comments
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 56, # Integer |
16 limit: 56, # Integer |
17 skip: 56, # Integer |
18 as_tree: true, # Boolean |
19 skip_children: 56, # Integer |
20 limit_children: 56, # Integer |
21 max_tree_depth: 56, # Integer |
22 url_id: 'url_id_example', # String |
23 user_id: 'user_id_example', # String |
24 anon_user_id: 'anon_user_id_example', # String |
25 context_user_id: 'context_user_id_example', # String |
26 hash_tag: 'hash_tag_example', # String |
27 parent_id: 'parent_id_example', # String |
28 direction: FastCommentsClient::SortDirections::OF # SortDirections |
29}
30
31begin
32
33 result = api_instance.get_comments(tenant_id, opts)
34 p result
35rescue FastCommentsClient::ApiError => e
36 puts "Error when calling DefaultApi->get_comments: #{e}"
37end
38

obtener comentarios públicos Internal Link

req tenantId urlId

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
urlIdstringquery
pageintegerqueryNo
directionstringqueryNo
ssostringqueryNo
skipintegerqueryNo
skipChildrenintegerqueryNo
limitintegerqueryNo
limitChildrenintegerqueryNo
countChildrenbooleanqueryNo
fetchPageForCommentIdstringqueryNo
includeConfigbooleanqueryNo
countAllbooleanqueryNo
includei10nbooleanqueryNo
localestringqueryNo
modulesstringqueryNo
isCrawlerbooleanqueryNo
includeNotificationCountbooleanqueryNo
asTreebooleanqueryNo
maxTreeDepthintegerqueryNo
useFullTranslationIdsbooleanqueryNo
parentIdstringqueryNo
searchTextstringqueryNo
hashTagsarrayqueryNo
userIdstringqueryNo
customConfigStrstringqueryNo
afterCommentIdstringqueryNo
beforeCommentIdstringqueryNo

Respuesta

Devuelve: GetCommentsPublic200Response

Ejemplo

Ejemplo de get_comments_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 page: 56, # Integer |
10 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
11 sso: 'sso_example', # String |
12 skip: 56, # Integer |
13 skip_children: 56, # Integer |
14 limit: 56, # Integer |
15 limit_children: 56, # Integer |
16 count_children: true, # Boolean |
17 fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String |
18 include_config: true, # Boolean |
19 count_all: true, # Boolean |
20 includei10n: true, # Boolean |
21 locale: 'locale_example', # String |
22 modules: 'modules_example', # String |
23 is_crawler: true, # Boolean |
24 include_notification_count: true, # Boolean |
25 as_tree: true, # Boolean |
26 max_tree_depth: 56, # Integer |
27 use_full_translation_ids: true, # Boolean |
28 parent_id: 'parent_id_example', # String |
29 search_text: 'search_text_example', # String |
30 hash_tags: ['inner_example'], # Array<String> |
31 user_id: 'user_id_example', # String |
32 custom_config_str: 'custom_config_str_example', # String |
33 after_comment_id: 'after_comment_id_example', # String |
34 before_comment_id: 'before_comment_id_example' # String |
35}
36
37begin
38
39 result = api_instance.get_comments_public(tenant_id, url_id, opts)
40 p result
41rescue FastCommentsClient::ApiError => e
42 puts "Error when calling PublicApi->get_comments_public: #{e}"
43end
44

bloquear comentario Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Respuesta

Devuelve: LockComment200Response

Ejemplo

Ejemplo de lock_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->lock_comment: #{e}"
19end
20

fijar comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Respuesta

Devuelve: PinComment200Response

Ejemplo

Ejemplo de pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->pin_comment: #{e}"
19end
20

guardar comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Respuesta

Devuelve: SaveComment200Response

Ejemplo

Ejemplo de save_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_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 |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comment(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comment: #{e}"
28end
29

guardar comentarios en lote Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Respuesta

Devuelve: Array&lt;SaveComment200Response&gt;

Ejemplo

Ejemplo de save_comments_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_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> |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
28end
29

establecer texto del comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
editKeystringqueryNo
ssostringqueryNo

Respuesta

Devuelve: SetCommentText200Response

Ejemplo

Ejemplo de set_comment_text
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest |
10opts = {
11 edit_key: 'edit_key_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->set_comment_text: #{e}"
21end
22

desbloquear usuario por comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Respuesta

Devuelve: UnBlockCommentPublic200Response

Ejemplo

Ejemplo de un_block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
27end
28

desmarcar comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringqueryNo
anonUserIdstringqueryNo

Respuesta

Devuelve: FlagComment200Response

Ejemplo

un_flag_comment Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de la clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave de API, p.ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.un_flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->un_flag_comment: #{e}"
26end
27

desbloquear comentario Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Respuesta

Devuelve: LockComment200Response

Ejemplo

Ejemplo de un_lock_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_lock_comment: #{e}"
19end
20

desanclar comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
commentIdstringpath
broadcastIdstringquery
ssostringqueryNo

Respuesta

Devuelve: PinComment200Response

Ejemplo

Ejemplo de un_pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_pin_comment: #{e}"
19end
20

actualizar comentario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo update_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
16opts = {
17 context_user_id: 'context_user_id_example', # String |
18 do_spam_check: true, # Boolean |
19 is_live: true # Boolean |
20}
21
22begin
23
24 result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->update_comment: #{e}"
28end
29

votar comentario Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
commentIdstringpath
urlIdstringquery
broadcastIdstringquery
sessionIdstringqueryNo
ssostringqueryNo

Respuesta

Devuelve: VoteComment200Response

Ejemplo

Ejemplo de vote_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8url_id = 'url_id_example' # String |
9broadcast_id = 'broadcast_id_example' # String |
10vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams |
11opts = {
12 session_id: 'session_id_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->vote_comment: #{e}"
22end
23

agregar configuración de dominio Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery

Respuesta

Devuelve: AddDomainConfig200Response

Ejemplo

Ejemplo de add_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
15
16begin
17
18 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_domain_config: #{e}"
22end
23

eliminar configuración de dominio Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
domainstringpath

Respuesta

Devuelve: DeleteDomainConfig200Response

Ejemplo

Ejemplo de delete_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.delete_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"
22end
23

obtener configuración de dominio Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
domainstringpath

Respuesta

Devuelve: GetDomainConfig200Response

Ejemplo

Ejemplo de get_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.get_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_domain_config: #{e}"
22end
23

obtener configuraciones de dominio Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery

Respuesta

Devuelve: GetDomainConfigs200Response

Ejemplo

Ejemplo de get_domain_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_domain_configs(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_configs: #{e}"
21end
22

actualizar parcialmente configuración de dominio Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
domainToUpdatestringpath

Respuesta

Devuelve: GetDomainConfig200Response

Ejemplo

patch_domain_config Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams |
16
17begin
18
19 result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_domain_config: #{e}"
23end
24

reemplazar configuración de dominio Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
domainToUpdatestringpath

Respuesta

Returns: GetDomainConfig200Response

Ejemplo

Ejemplo de put_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización mediante la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
16
17begin
18
19 result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->put_domain_config: #{e}"
23end
24

crear plantilla de correo Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery

Respuesta

Devuelve: CreateEmailTemplate200Response

Ejemplo

Ejemplo de create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody |
15
16begin
17
18 result = api_instance.create_email_template(tenant_id, create_email_template_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_email_template: #{e}"
22end
23

eliminar plantilla de correo Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_email_template: #{e}"
22end
23

eliminar error de renderizado de plantilla de correo Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
errorIdstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo delete_email_template_render_error
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15error_id = 'error_id_example' # String |
16
17begin
18
19 result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
23end
24

obtener plantilla de correo Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetEmailTemplate200Response

Ejemplo

Ejemplo de get_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_email_template: #{e}"
22end
23

obtener definiciones de plantillas de correo Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery

Respuesta

Devuelve: GetEmailTemplateDefinitions200Response

Ejemplo

Ejemplo de get_email_template_definitions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Cadena |
14
15begin
16
17 result = api_instance.get_email_template_definitions(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
21end
22

obtener errores de renderizado de plantillas de correo Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
skipnumberqueryNo

Respuesta

Devuelve: GetEmailTemplateRenderErrors200Response

Ejemplo

Ejemplo de get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
25end
26

obtener plantillas de correo Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberqueryNo

Respuesta

Devuelve: GetEmailTemplates200Response

Ejemplo

Ejemplo de get_email_templates
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_email_templates(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_templates: #{e}"
24end
25

renderizar plantilla de correo Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
localestringqueryNo

Respuesta

Devuelve: RenderEmailTemplate200Response

Ejemplo

Ejemplo de render_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody |
15opts = {
16 locale: 'locale_example' # String |
17}
18
19begin
20
21 result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->render_email_template: #{e}"
25end
26

actualizar plantilla de correo Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody |
16
17begin
18
19 result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_email_template: #{e}"
23end
24

obtener registro de eventos Internal Link

req tenantId urlId userIdWS

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

Respuesta

Devuelve: GetEventLog200Response

Ejemplo

Ejemplo de get_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Cadena |
7url_id = 'url_id_example' # Cadena |
8user_id_ws = 'user_id_ws_example' # Cadena |
9start_time = 789 # Entero |
10end_time = 789 # Entero |
11
12begin
13
14 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_event_log: #{e}"
18end
19

obtener registro global de eventos Internal Link

req tenantId urlId userIdWS

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringpath
urlIdstringquery
userIdWSstringquery
startTimeintegerquery
endTimeintegerquery

Respuesta

Devuelve: GetEventLog200Response

Ejemplo

Ejemplo de get_global_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10end_time = 789 # Integer |
11
12begin
13
14 result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_global_event_log: #{e}"
18end
19

crear publicación de feed Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

Respuesta

Devuelve: CreateFeedPost200Response

Ejemplo

Ejemplo de create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
15opts = {
16 broadcast_id: 'broadcast_id_example', # String |
17 is_live: true, # Boolean |
18 do_spam_check: true, # Boolean |
19 skip_dup_check: true # Boolean |
20}
21
22begin
23
24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->create_feed_post: #{e}"
28end
29

crear publicación de feed pública Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Respuesta

Devuelve: CreateFeedPostPublic200Response

Ejemplo

Ejemplo de create_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->create_feed_post_public: #{e}"
19end
20

eliminar publicación de feed pública Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
postIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Respuesta

Devuelve: DeleteFeedPostPublic200Response

Ejemplo

Ejemplo de delete_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
19end
20

obtener publicaciones del feed Internal Link

req tenantId afterId

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

Respuesta

Devuelve: GetFeedPosts200Response

Ejemplo

Ejemplo de get_feed_posts
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 after_id: 'after_id_example', # String |
16 limit: 56, # Integer |
17 tags: ['inner_example'] # Array<String> |
18}
19
20begin
21
22 result = api_instance.get_feed_posts(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_feed_posts: #{e}"
26end
27

obtener publicaciones del feed públicas Internal Link

req tenantId afterId

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpath
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo
ssostringqueryNo
isCrawlerbooleanqueryNo
includeUserInfobooleanqueryNo

Respuesta

Devuelve: GetFeedPostsPublic200Response

Ejemplo

Ejemplo de get_feed_posts_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 after_id: 'after_id_example', # String |
9 limit: 56, # Integer |
10 tags: ['inner_example'], # Array<String> |
11 sso: 'sso_example', # String |
12 is_crawler: true, # Boolean |
13 include_user_info: true # Boolean |
14}
15
16begin
17
18 result = api_instance.get_feed_posts_public(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
22end
23

obtener estadísticas de publicaciones del feed Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringpath
postIdsarrayquery
ssostringqueryNo

Respuesta

Devuelve: GetFeedPostsStats200Response

Ejemplo

Ejemplo de get_feed_posts_stats
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_ids = ['inner_example'] # Array<String> |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
18end
19

obtener reacciones de usuario públicas Internal Link


Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringpath
postIdsarrayqueryNo
ssostringqueryNo

Respuesta

Devuelve: GetUserReactsPublic200Response

Ejemplo

Ejemplo de get_user_reacts_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 post_ids: ['inner_example'], # Array<String> |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_user_reacts_public(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
18end
19

reaccionar a publicación de feed pública Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
postIdstringpath
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Respuesta

Devuelve: ReactFeedPostPublic200Response

Ejemplo

Ejemplo de react_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams |
9opts = {
10 is_undo: true, # Boolean |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->react_feed_post_public: #{e}"
21end
22

actualizar publicación del feed Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (valor por defecto: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost |
16
17begin
18
19 result = api_instance.update_feed_post(tenant_id, id, feed_post)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_feed_post: #{e}"
23end
24

actualizar publicación del feed pública Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
postIdstringpath
broadcastIdstringqueryNo
ssostringqueryNo

Respuesta

Devuelve: CreateFeedPostPublic200Response

Ejemplo

Ejemplo de update_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->update_feed_post_public: #{e}"
20end
21

marcar comentario público Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
commentIdstringpath
isFlaggedbooleanquery
ssostringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de flag_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8is_flagged = true # Boolean |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->flag_comment_public: #{e}"
19end
20

agregar hashtag Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryNo

Respuesta

Devuelve: AddHashTag200Response

Ejemplo

Ejemplo de add_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tag(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
24end
25

agregar hashtags en lote Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryNo

Respuesta

Devuelve: AddHashTagsBulk200Response

Ejemplo

Ejemplo de add_hash_tags_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tags_bulk(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
24end
25

eliminar hashtag Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tagstringpathYes
tenantIdstringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest |
17}
18
19begin
20
21 result = api_instance.delete_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
25end
26

obtener hashtags Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
pagenumberqueryNo

Respuesta

Devuelve: GetHashTags200Response

Ejemplo

Ejemplo de get_hash_tags
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización mediante la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_hash_tags(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_hash_tags: #{e}"
24end
25

actualizar parcialmente hashtag Internal Link

Parámetros

NameTypeLocationRequiredDescription
tagstringpath
tenantIdstringqueryNo

Respuesta

Devuelve: PatchHashTag200Response

Ejemplo

Ejemplo de patch_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
17}
18
19begin
20
21 result = api_instance.patch_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
25end
26

crear moderador Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery

Respuesta

Devuelve: CreateModerator200Response

Ejemplo

Ejemplo de create_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody |
15
16begin
17
18 result = api_instance.create_moderator(tenant_id, create_moderator_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_moderator: #{e}"
22end
23

eliminar moderador Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
sendEmailstringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 send_email: 'send_email_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_moderator(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_moderator: #{e}"
25end
26

obtener moderador Internal Link


Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetModerator200Response

Ejemplo

Ejemplo de get_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_moderator(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_moderator: #{e}"
22end
23

obtener moderadores Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberqueryNo

Respuesta

Devuelve: GetModerators200Response

Ejemplo

Ejemplo de get_moderators
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_moderators(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_moderators: #{e}"
24end
25

enviar invitación Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
fromNamestringquery

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15from_name = 'from_name_example' # String |
16
17begin
18
19 result = api_instance.send_invite(tenant_id, id, from_name)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->send_invite: #{e}"
23end
24

actualizar moderador Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody |
16
17begin
18
19 result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_moderator: #{e}"
23end
24

eliminar contador de notificaciones Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_notification_count: #{e}"
22end
23

obtener contador de notificaciones en caché Internal Link


Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetCachedNotificationCount200Response

Ejemplo

Ejemplo de get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización con la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_cached_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
22end
23

obtener contador de notificaciones Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

Respuesta

Devuelve: GetNotificationCount200Response

Ejemplo

Ejemplo de get_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example' # String |
20}
21
22begin
23
24 result = api_instance.get_notification_count(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_notification_count: #{e}"
28end
29

obtener notificaciones Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetNotifications200Response

Ejemplo

Ejemplo de get_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_notifications(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_notifications: #{e}"
29end
30

actualizar notificación Internal Link

Parámetros

NombreTypeLocationObligatorioDescripción
tenantIdstringquery
idstringpath
userIdstringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_notification
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

agregar página Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery

Respuesta

Devuelve: AddPageAPIResponse

Ejemplo

Ejemplo de add_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
15
16begin
17
18 result = api_instance.add_page(tenant_id, create_api_page_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_page: #{e}"
22end
23

eliminar página Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: DeletePageAPIResponse

Ejemplo

Ejemplo de delete_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_page(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_page: #{e}"
22end
23

obtener página por urlid Internal Link


Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes

Respuesta

Devuelve: GetPageByURLIdAPIResponse

Ejemplo

Ejemplo de get_page_by_urlid
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con la API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la línea siguiente para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_page_by_urlid(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
22end
23

obtener páginas Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery

Respuesta

Devuelve: GetPagesAPIResponse

Ejemplo

Ejemplo de get_pages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización con clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave de API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

actualizar parcialmente página Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: PatchPageAPIResponse

Ejemplo

Ejemplo de patch_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData |
16
17begin
18
19 result = api_instance.patch_page(tenant_id, id, update_api_page_data)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_page: #{e}"
23end
24

eliminar evento de webhook pendiente Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_pending_webhook_event
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

obtener contador de eventos de webhook pendientes Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

Respuesta

Devuelve: GetPendingWebhookEventCount200Response

Ejemplo

Ejemplo de get_pending_webhook_event_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
29end
30

obtener eventos de webhook pendientes Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetPendingWebhookEvents200Response

Ejemplo

Ejemplo de get_pending_webhook_events
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2, # Float |
21 skip: 1.2 # Float |
22}
23
24begin
25
26 result = api_instance.get_pending_webhook_events(tenant_id, opts)
27 p result
28rescue FastCommentsClient::ApiError => e
29 puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
30end
31

crear configuración de pregunta Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery

Respuesta

Devuelve: CreateQuestionConfig200Response

Ejemplo

Ejemplo de create_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody |
15
16begin
17
18 result = api_instance.create_question_config(tenant_id, create_question_config_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_config: #{e}"
22end
23

eliminar configuración de pregunta Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_config: #{e}"
22end
23

obtener configuración de pregunta Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetQuestionConfig200Response

Ejemplo

Ejemplo de get_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_config: #{e}"
22end
23

obtener configuraciones de preguntas Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
skipnumberqueryNo

Respuesta

Devuelve: GetQuestionConfigs200Response

Ejemplo

Ejemplo de get_question_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_question_configs(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_question_configs: #{e}"
24end
25

actualizar configuración de pregunta Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

update_question_config Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody |
16
17begin
18
19 result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_config: #{e}"
23end
24

crear resultado de pregunta Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery

Respuesta

Devuelve: CreateQuestionResult200Response

Ejemplo

Ejemplo de create_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody |
15
16begin
17
18 result = api_instance.create_question_result(tenant_id, create_question_result_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_result: #{e}"
22end
23

eliminar resultado de pregunta Internal Link


Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

delete_question_result Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23

obtener resultado de pregunta Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringqueryYes
idstringpathYes

Respuesta

Devuelve: GetQuestionResult200Response

Ejemplo

Ejemplo de get_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_result: #{e}"
22end
23

obtener resultados de preguntas Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdstringqueryNo
userIdstringqueryNo
startDatestringqueryNo
questionIdstringqueryNo
questionIdsstringqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetQuestionResults200Response

Ejemplo

Ejemplo de get_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 url_id: 'url_id_example', # String |
16 user_id: 'user_id_example', # String |
17 start_date: 'start_date_example', # String |
18 question_id: 'question_id_example', # String |
19 question_ids: 'question_ids_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_question_results: #{e}"
29end
30

actualizar resultado de pregunta Internal Link


Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody |
16
17begin
18
19 result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_result: #{e}"
23end
24

agregar resultados de preguntas Internal Link

Parámetros

NombreTypeUbicaciónRequeridoDescripción
tenantIdstringquery
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Respuesta

Devuelve: AggregateQuestionResults200Response

Ejemplo

Ejemplo de aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
19 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
20 force_recalculate: true # Boolean |
21}
22
23begin
24
25 result = api_instance.aggregate_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
29end
30

agregar en lote resultados de preguntas Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
forceRecalculatebooleanqueryNo

Respuesta

Devuelve: BulkAggregateQuestionResults200Response

Ejemplo

Ejemplo de bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
15opts = {
16 force_recalculate: true # Boolean |
17}
18
19begin
20
21 result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
25end
26

combinar comentarios con resultados de preguntas Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Respuesta

Devuelve: CombineCommentsWithQuestionResults200Response

Ejemplo

Ejemplo de combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
19 force_recalculate: true, # Boolean |
20 min_value: 1.2, # Float |
21 max_value: 1.2, # Float |
22 limit: 1.2 # Float |
23}
24
25begin
26
27 result = api_instance.combine_comments_with_question_results(tenant_id, opts)
28 p result
29rescue FastCommentsClient::ApiError => e
30 puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
31end
32

agregar usuario SSO Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery

Respuesta

Devuelve: AddSSOUserAPIResponse

Ejemplo

Ejemplo de add_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
15
16begin
17
18 result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_sso_user: #{e}"
22end
23

eliminar usuario SSO Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

Respuesta

Devuelve: DeleteSSOUserAPIResponse

Ejemplo

Ejemplo de delete_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: true, # Boolean |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_sso_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_sso_user: #{e}"
26end
27

obtener usuario SSO por correo electrónico Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
emailstringpath

Respuesta

Devuelve: GetSSOUserByEmailAPIResponse

Ejemplo

Ejemplo de get_sso_user_by_email
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14email = 'email_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_email(tenant_id, email)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
22end
23

obtener usuario SSO por id Internal Link


Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetSSOUserByIdAPIResponse

Ejemplo

Ejemplo de get_sso_user_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
22end
23

obtener usuarios SSO Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
skipintegerqueryNo

Respuesta

Devuelve: GetSSOUsers200Response

Ejemplo

Ejemplo de get_sso_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 56 # Integer |
16}
17
18begin
19
20 result = api_instance.get_sso_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_sso_users: #{e}"
24end
25

actualizar parcialmente usuario SSO Internal Link


Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
updateCommentsbooleanqueryNo

Respuesta

Devuelve: PatchSSOUserAPIResponse

Ejemplo

Ejemplo de patch_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave de API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->patch_sso_user: #{e}"
26end
27

reemplazar usuario SSO Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
updateCommentsbooleanqueryNo

Respuesta

Devuelve: PutSSOUserAPIResponse

Ejemplo

Ejemplo de put_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->put_sso_user: #{e}"
26end
27

crear suscripción Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery

Respuesta

Devuelve: CreateSubscriptionAPIResponse

Ejemplo

Ejemplo de create_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización mediante clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave de la API, por ejemplo 'Bearer' (predeterminado: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
15
16begin
17
18 result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_subscription: #{e}"
22end
23

eliminar suscripción Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
userIdstringqueryNo

Respuesta

Devuelve: DeleteSubscriptionAPIResponse

Ejemplo

delete_subscription Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_subscription(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_subscription: #{e}"
25end
26

obtener suscripciones Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo

Respuesta

Devuelve: GetSubscriptionsAPIResponse

Ejemplo

Ejemplo de get_subscriptions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (predeterminado: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

actualizar suscripción Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
userIdstringqueryNo

Respuesta

Devuelve: UpdateSubscriptionAPIResponse

Ejemplo

Ejemplo de update_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_subscription: #{e}"
26end
27

obtener usos diarios del inquilino Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetTenantDailyUsages200Response

Ejemplo

Ejemplo de get_tenant_daily_usages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 year_number: 1.2, # Float |
16 month_number: 1.2, # Float |
17 day_number: 1.2, # Float |
18 skip: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tenant_daily_usages(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
27end
28

crear paquete de inquilino Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery

Respuesta

Devuelve: CreateTenantPackage200Response

Ejemplo

Ejemplo de create_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configuración de autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_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 |
15
16begin
17
18 result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_package: #{e}"
22end
23

eliminar paquete de inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (valor predeterminado nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
22end
23

obtener paquete de inquilino Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Respuesta

Devuelve: GetTenantPackage200Response

Ejemplo

Ejemplo de get_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_package: #{e}"
22end
23

obtener paquetes de inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
skipnumberqueryNo

Respuesta

Devuelve: GetTenantPackages200Response

Ejemplo

Ejemplo de get_tenant_packages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_packages(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
24end
25

reemplazar paquete de inquilino Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

replace_tenant_package Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configuración de autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización mediante la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_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 |
16
17begin
18
19 result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
23end
24

actualizar paquete de inquilino Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody |
16
17begin
18
19 result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant_package: #{e}"
23end
24

crear usuario del inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery

Respuesta

Devuelve: CreateTenantUser200Response

Ejemplo

create_tenant_user Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody |
15
16begin
17
18 result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_user: #{e}"
22end
23

eliminar usuario del inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringqueryYes
idstringpathYes
deleteCommentsstringqueryNo
commentDeleteModestringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de delete_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: 'delete_comments_example', # String |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_tenant_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
26end
27

obtener usuario del inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetTenantUser200Response

Ejemplo

Ejemplo de get_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la línea siguiente para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_user: #{e}"
22end
23

obtener usuarios del inquilino Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
skipnumberqueryNo

Respuesta

Devuelve: GetTenantUsers200Response

Ejemplo

Ejemplo de get_tenant_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25

reemplazar usuario del inquilino Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
updateCommentsstringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo replace_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
26end
27

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath
redirectURLstringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de send_login_link
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 redirect_url: 'redirect_url_example' # String |
17}
18
19begin
20
21 result = api_instance.send_login_link(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->send_login_link: #{e}"
25end
26

actualizar usuario del inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
updateCommentsstringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_tenant_user: #{e}"
26end
27

crear inquilino Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery

Respuesta

Devuelve: CreateTenant200Response

Ejemplo

Ejemplo de create_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody |
15
16begin
17
18 result = api_instance.create_tenant(tenant_id, create_tenant_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant: #{e}"
22end
23

eliminar inquilino Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath
surestringqueryNo

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

delete_tenant Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, por ejemplo 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Cadena |
14id = 'id_example' # Cadena |
15opts = {
16 sure: 'sure_example' # Cadena |
17}
18
19begin
20
21 result = api_instance.delete_tenant(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_tenant: #{e}"
25end
26

obtener inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetTenant200Response

Ejemplo

Ejemplo de get_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de la clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave de la API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant: #{e}"
22end
23

obtener inquilinos Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
metastringqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetTenants200Response

Ejemplo

Ejemplo de get_tenants
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave de la API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 meta: 'meta_example', # String |
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_tenants(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_tenants: #{e}"
25end
26

actualizar inquilino Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: FlagCommentPublic200Response

Ejemplo

Ejemplo de update_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

cambiar estado del ticket Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
userIdstringquery
idstringpath

Respuesta

Devuelve: ChangeTicketState200Response

Ejemplo

Ejemplo de change_ticket_state
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15id = 'id_example' # String |
16change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody |
17
18begin
19
20 result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->change_ticket_state: #{e}"
24end
25

crear ticket Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
userIdstringquery

Respuesta

Devuelve: CreateTicket200Response

Ejemplo

Ejemplo de create_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody |
16
17begin
18
19 result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->create_ticket: #{e}"
23end
24

obtener ticket Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath
userIdstringqueryNo

Respuesta

Devuelve: GetTicket200Response

Ejemplo

Ejemplo de get_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.get_ticket(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_ticket: #{e}"
25end
26

obtener tickets Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

Respuesta

Devuelve: GetTickets200Response

Ejemplo

Ejemplo de get_tickets
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 state: 1.2, # Float |
17 skip: 1.2, # Float |
18 limit: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tickets(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tickets: #{e}"
27end
28

subir imagen Internal Link

Subir y redimensionar una imagen

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
sizePresetstringqueryNoPreajuste de tamaño: "Default" (1000x1000px) o "CrossPlatform" (genera tamaños para dispositivos populares)
urlIdstringqueryNoID de página desde la que se realiza la subida, para configurar

Respuesta

Devuelve: UploadImageResponse

Ejemplo

Ejemplo de upload_image
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7file = File.new('/path/to/some/file') # File |
8opts = {
9 size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Preajuste de tamaño: \"Default\" (1000x1000px) o \"CrossPlatform\" (genera tamaños para dispositivos populares)
10 url_id: 'url_id_example' # String | ID de página desde la que se realiza la subida, para configurar
11}
12
13begin
14
15 result = api_instance.upload_image(tenant_id, file, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->upload_image: #{e}"
19end
20

obtener progreso de insignia de usuario por id Internal Link


Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetUserBadgeProgressById200Response

Ejemplo

Ejemplo de get_user_badge_progress_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
22end
23

obtener progreso de insignia de usuario por id de usuario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringpathYes

Respuesta

Devuelve: GetUserBadgeProgressById200Response

Ejemplo

Ejemplo de get_user_badge_progress_by_user_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la API key, p.ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23

obtener lista de progreso de insignias de usuario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo
limitnumberqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetUserBadgeProgressList200Response

Ejemplo

Ejemplo de get_user_badge_progress_list
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave de la API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 limit: 1.2, # Float |
17 skip: 1.2 # Float |
18}
19
20begin
21
22 result = api_instance.get_user_badge_progress_list(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
26end
27

crear insignia de usuario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery

Respuesta

Devuelve: CreateUserBadge200Response

Ejemplo

Ejemplo de create_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización con clave de API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave de API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams |
15
16begin
17
18 result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_user_badge: #{e}"
22end
23

eliminar insignia de usuario Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: UpdateUserBadge200Response

Ejemplo

Ejemplo delete_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23

obtener insignia de usuario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetUserBadge200Response

Ejemplo

Ejemplo de get_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23

obtener insignias de usuario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
userIdstringqueryNo
badgeIdstringqueryNo
typenumberqueryNo
displayedOnCommentsbooleanqueryNo
limitnumberqueryNo
skipnumberqueryNo

Respuesta

Devuelve: GetUserBadges200Response

Ejemplo

Ejemplo de get_user_badges
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la API key: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la API key, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 badge_id: 'badge_id_example', # String |
17 type: 1.2, # Float |
18 displayed_on_comments: true, # Boolean |
19 limit: 1.2, # Float |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_user_badges(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_user_badges: #{e}"
29end
30

actualizar insignia de usuario Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: UpdateUserBadge200Response

Ejemplo

Ejemplo de update_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams |
16
17begin
18
19 result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_user_badge: #{e}"
23end
24

obtener contador de notificaciones del usuario Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
ssostringqueryNo

Respuesta

Devuelve: GetUserNotificationCount200Response

Ejemplo

Ejemplo de get_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.get_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->get_user_notification_count: #{e}"
17end
18

obtener notificaciones del usuario Internal Link

Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringquery
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
ssostringqueryNo

Respuesta

Devuelve: GetUserNotifications200Response

Ejemplo

Ejemplo de get_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 page_size: 56, # Integer |
9 after_id: 'after_id_example', # String |
10 include_context: true, # Boolean |
11 after_created_at: 789, # Integer |
12 unread_only: true, # Boolean |
13 dm_only: true, # Boolean |
14 no_dm: true, # Boolean |
15 include_translations: true, # Boolean |
16 sso: 'sso_example' # String |
17}
18
19begin
20
21 result = api_instance.get_user_notifications(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling PublicApi->get_user_notifications: #{e}"
25end
26

restablecer contador de notificaciones del usuario Internal Link


Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
ssostringqueryNo

Respuesta

Devuelve: ResetUserNotifications200Response

Ejemplo

Ejemplo de reset_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.reset_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
17end
18

restablecer notificaciones del usuario Internal Link

Parámetros

NameTypeLocationRequeridoDescripción
tenantIdstringquery
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Respuesta

Devuelve: ResetUserNotifications200Response

Ejemplo

Ejemplo de reset_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 after_id: 'after_id_example', # String |
9 after_created_at: 789, # Integer |
10 unread_only: true, # Boolean |
11 dm_only: true, # Boolean |
12 no_dm: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.reset_user_notifications(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->reset_user_notifications: #{e}"
22end
23

actualizar estado de suscripción a comentarios de notificación del usuario Internal Link

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

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
notificationIdstringpath
optedInOrOutstringpath
commentIdstringquery
ssostringqueryNo

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de update_user_notification_comment_subscription_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7notification_id = 'notification_id_example' # String |
8opted_in_or_out = 'in' # String |
9comment_id = 'comment_id_example' # String |
10opts = {
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
20end
21

actualizar estado de suscripción a página de notificación del usuario Internal Link

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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
urlstringqueryYes
pageTitlestringqueryYes
subscribedOrUnsubscribedstringpathYes
ssostringqueryNo

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de update_user_notification_page_subscription_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Cadena |
7url_id = 'url_id_example' # Cadena |
8url = 'url_example' # Cadena |
9page_title = 'page_title_example' # Cadena |
10subscribed_or_unsubscribed = 'subscribe' # Cadena |
11opts = {
12 sso: 'sso_example' # Cadena |
13}
14
15begin
16
17 result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
21end
22

actualizar estado de notificación del usuario Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
notificationIdstringpath
newStatusstringpath
ssostringqueryNo

Respuesta

Devuelve: UpdateUserNotificationStatus200Response

Ejemplo

Ejemplo de update_user_notification_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7notification_id = 'notification_id_example' # String |
8new_status = 'read' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->update_user_notification_status: #{e}"
19end
20

obtener estados de presencia de usuarios Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdWSstringquery
userIdsstringquery

Respuesta

Devuelve: GetUserPresenceStatuses200Response

Ejemplo

Ejemplo de get_user_presence_statuses
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Cadena |
7url_id_ws = 'url_id_ws_example' # Cadena |
8user_ids = 'user_ids_example' # Cadena |
9
10begin
11
12 result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
16end
17

buscar usuarios Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringpath
urlIdstringquery
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

Respuesta

Devuelve: SearchUsers200Response

Ejemplo

Ejemplo de search_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 username_starts_with: 'username_starts_with_example', # String |
10 mention_group_ids: ['inner_example'], # Array<String> |
11 sso: 'sso_example', # String |
12 search_section: 'fast' # String |
13}
14
15begin
16
17 result = api_instance.search_users(tenant_id, url_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->search_users: #{e}"
21end
22

obtener usuario Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath

Respuesta

Devuelve: GetUser200Response

Ejemplo

Ejemplo de get_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user: #{e}"
22end
23

crear voto Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
commentIdstringquery
directionstringquery
userIdstringqueryNo
anonUserIdstringqueryNo

Respuesta

Devuelve: VoteComment200Response

Ejemplo

Ejemplo de create_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización de clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (predeterminado a nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14comment_id = 'comment_id_example' # String |
15direction = 'up' # String |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->create_vote: #{e}"
27end
28

eliminar voto Internal Link

Parámetros

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringquery
idstringpath
editKeystringqueryNo

Respuesta

Devuelve: DeleteCommentVote200Response

Ejemplo

Ejemplo de delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Cadena |
14id = 'id_example' # Cadena |
15opts = {
16 edit_key: 'edit_key_example' # Cadena |
17}
18
19begin
20
21 result = api_instance.delete_vote(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_vote: #{e}"
25end
26

obtener votos Internal Link


Parámetros

NombreTipoUbicaciónObligatorioDescripción
tenantIdstringqueryYes
urlIdstringqueryYes

Respuesta

Devuelve: GetVotes200Response

Ejemplo

Ejemplo de get_votes
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar la autorización
5FastCommentsClient.configure do |config|
6 # Configurar la autorización de la clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomente la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto es nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_votes(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_votes: #{e}"
22end
23

obtener votos del usuario Internal Link

Parámetros

NameTypeLocationRequiredDescription
tenantIdstringquery
urlIdstringquery
userIdstringqueryNo
anonUserIdstringqueryNo

Respuesta

Devuelve: GetVotesForUser200Response

Ejemplo

get_votes_for_user Ejemplo
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# configurar autorización
5FastCommentsClient.configure do |config|
6 # Configurar autorización por clave API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Descomenta la siguiente línea para establecer un prefijo para la clave API, p. ej. 'Bearer' (por defecto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
26end
27

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