SDK FastComments para Ruby

Este é o SDK oficial em Ruby para o FastComments.

SDK oficial em Ruby para a API do FastComments

Repositório

Instalação

Adicione esta linha ao Gemfile da sua aplicação:

gem 'fastcomments'

Em seguida, execute:

bundle install

Ou instale você mesmo como:

gem install fastcomments

Conteúdo da Biblioteca

Esta biblioteca contém o cliente de API gerado e as utilidades SSO para facilitar o trabalho com a API.

API Client Library Docs

APIs Públicas vs Seguras

Para o cliente de API, existem três classes, DefaultApi, PublicApi e ModerationApi. O DefaultApi contém métodos que requerem sua chave de API, e o PublicApi contém chamadas de API
que podem ser feitas diretamente de um navegador/dispositivo móvel/etc sem autenticação. O ModerationApi contém os métodos que alimentam o painel de moderador.

O ModerationApi fornece um conjunto extenso de APIs de moderação ao vivo e rápidas. Cada método do ModerationApi aceita um parâmetro sso e pode autenticar via SSO ou um cookie de sessão do FastComments.com.

Início Rápido

Using Authenticated APIs (DefaultApi)

Importante: Você deve definir sua chave de API no ApiClient antes de fazer solicitações autenticadas. Caso contrário, as solicitações falharão com um erro 401.

require 'fastcomments'

# Crie e configure o cliente da API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# OBRIGATÓRIO: Defina sua chave de API (obtenha isso no seu painel FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Crie a instância da API com o cliente configurado
api = FastCommentsClient::DefaultApi.new(api_client)

# Agora você pode fazer chamadas de API autenticadas
begin
  # Exemplo: Adicionar um usuário 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}"
  # Erros comuns:
  # - 401: Chave de API está faltando ou é inválida
  # - 400: Validação da solicitação falhou
end

Using Public APIs (PublicApi)

Os endpoints públicos não exigem autenticação:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

begin
  response = public_api.get_comments_public(
    'YOUR_TENANT_ID',
    'page-url-id'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Using Moderation APIs (ModerationApi)

Os métodos de moderação alimentam o painel do moderador. Passe um token sso para que a solicitação seja feita em nome de um moderador autenticado via SSO:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Exemplo: Listar comentários na fila de moderação
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Common Issues

401 "missing-api-key" error: Certifique-se de definir config.api_key['x-api-key'] = 'YOUR_KEY' antes de criar a instância DefaultApi.
Wrong API class: Use DefaultApi para solicitações autenticadas no lado do servidor, PublicApi para solicitações públicas/no lado do cliente, e ModerationApi para solicitações do painel de moderador.
Null API key: O SDK ignorará silenciosamente a autenticação se a chave de API for nula, resultando em erros 401.

Notas

IDs de Broadcast

Você verá que deve passar um broadcastId em algumas chamadas de API. Quando receber eventos, você receberá esse ID de volta, assim saberá ignorar o evento se planejar aplicar alterações de forma otimista no cliente (o que você provavelmente vai querer fazer, pois oferece a melhor experiência). Passe um UUID aqui. O ID deve ser suficientemente único para não ocorrer duas vezes em uma sessão do navegador.

Para exemplos de SSO, veja abaixo.

Uso de SSO

SSO Simples

require 'fastcomments'

# Cria token SSO simples
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}"

# Usa o token SSO para fazer uma chamada de 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(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

SSO Seguro

require 'fastcomments'

# Cria 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}"

# Usa o token SSO para fazer uma chamada de 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(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

agregar

Agrega documentos por meio de groupBy (se groupBy for fornecido) e aplicando múltiplas operações. Diferentes operações (por exemplo sum, countDistinct, avg, etc.) são suportadas.

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
parentTenantId	string	query	No
includeStats	boolean	query	No

Resposta

Retorna: AggregateResponse

Exemplo

Exemplo de aggregate

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest | 
opts = {
  parent_tenant_id: 'parent_tenant_id_example', # String | 
  include_stats: true # Boolean | 
}
begin
  
  result = api_instance.aggregate(tenant_id, aggregation_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate: #{e}"
end

obter_logs_de_auditoria

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
limit	number	query	Não
skip	number	query	Não
order	string	query	Não
after	number	query	Não
before	number	query	Não

Resposta

Retorna: GetAuditLogsResponse

Exemplo

Exemplo de get_audit_logs

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

logout_público

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de logout_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
begin
  
  result = api_instance.logout_public
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->logout_public: #{e}"
end

bloquear_por_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
commentId	string	path	Sim
sso	string	query	Não

Resposta

Retorna: BlockSuccess

Exemplo

Exemplo de block_from_comment_public

Copy

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

desbloquear_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
commentId	string	path	Sim
sso	string	query	Não

Resposta

Retorna: UnblockSuccess

Exemplo

Exemplo de un_block_comment_public

Copy

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

verificar_comentarios_bloqueados

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
commentIds	string	query	Sim	Uma lista separada por vírgulas de IDs de comentários.
sso	string	query	Não

Resposta

Retorna: CheckBlockedCommentsResponse

Exemplo

Exemplo de checked_comments_for_blocked

Copy

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

bloquear_usuario_por_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: BlockSuccess

Exemplo

Exemplo de block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, e.g. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

criar_comentario_publico

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
broadcastId	string	query	Sim
sessionId	string	query	Não
sso	string	query	Não

Resposta

Retorna: SaveCommentsResponseWithPresence

Exemplo

create_comment_public Exemplo

Copy

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

excluir_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
id	string	path	Sim
contextUserId	string	query	Não
isLive	boolean	query	Não

Resposta

Retorna: DeleteCommentResult

Exemplo

Exemplo de delete_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

excluir_comentario_publico

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
commentId	string	path	Sim
broadcastId	string	query	Sim
editKey	string	query	Não
sso	string	query	Não

Resposta

Retorna: PublicAPIDeleteCommentResponse

Exemplo

Exemplo de delete_comment_public

Copy

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

excluir_voto_de_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
commentId	string	path	Sim
voteId	string	path	Sim
urlId	string	query	Sim
broadcastId	string	query	Sim
editKey	string	query	Não
sso	string	query	Não

Resposta

Retorna: VoteDeleteResponse

Exemplo

Exemplo de delete_comment_vote

Copy

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

denunciar_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: FlagCommentResponse

Exemplo

Exemplo de flag_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

obter_comentario

Parâmetros

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

Resposta

Retorna: APIGetCommentResponse

Exemplo

Exemplo de get_comment

Copy

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

obter_texto_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
commentId	string	path	Sim
editKey	string	query	Não
sso	string	query	Não

Resposta

Retorna: PublicAPIGetCommentTextResponse

Exemplo

Exemplo de get_comment_text

Copy

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

obter_nomes_usuarios_voto_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
commentId	string	path	Sim
dir	integer	query	Sim
sso	string	query	Não

Resposta

Retorna: GetCommentVoteUserNamesSuccessResponse

Exemplo

Exemplo de get_comment_vote_user_names

Copy

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

obter_comentarios

Parâmetros

Nome	Type	Location	Obrigatório
tenantId	string	query	Sim
page	integer	query	Não
limit	integer	query	Não
skip	integer	query	Não
asTree	boolean	query	Não
skipChildren	integer	query	Não
limitChildren	integer	query	Não
maxTreeDepth	integer	query	Não
urlId	string	query	Não
userId	string	query	Não
anonUserId	string	query	Não
contextUserId	string	query	Não
hashTag	string	query	Não
parentId	string	query	Não
direction	string	query	Não
fromDate	integer	query	Não
toDate	integer	query	Não

Resposta

Retorna: APIGetCommentsResponse

Exemplo

Exemplo de get_comments

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  from_date: 789, # Integer | 
  to_date: 789 # Integer | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

obter_comentarios_publicos

req tenantId urlId

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
page	integer	query	Não
direction	string	query	Não
sso	string	query	Não
skip	integer	query	Não
skipChildren	integer	query	Não
limit	integer	query	Não
limitChildren	integer	query	Não
countChildren	boolean	query	Não
fetchPageForCommentId	string	query	Não
includeConfig	boolean	query	Não
countAll	boolean	query	Não
includei10n	boolean	query	Não
locale	string	query	Não
modules	string	query	Não
isCrawler	boolean	query	Não
includeNotificationCount	boolean	query	Não
asTree	boolean	query	Não
maxTreeDepth	integer	query	Não
useFullTranslationIds	boolean	query	Não
parentId	string	query	Não
searchText	string	query	Não
hashTags	array	query	Não
userId	string	query	Não
customConfigStr	string	query	Não
afterCommentId	string	query	Não
beforeCommentId	string	query	Não

Resposta

Retorna: GetCommentsResponseWithPresencePublicComment

Exemplo

Exemplo de get_comments_public

Copy

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

bloquear_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
commentId	string	path	Sim
broadcastId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de lock_comment

Copy

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

fixar_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
commentId	string	path	Sim
broadcastId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: ChangeCommentPinStatusResponse

Exemplo

Exemplo de pin_comment

Copy

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

salvar_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
isLive	boolean	query	No
doSpamCheck	boolean	query	No
sendEmails	boolean	query	No
populateNotifications	boolean	query	No

Resposta

Retorna: APISaveCommentResponse

Exemplo

Exemplo de save_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave de API, por ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

salvar_comentarios_em_lote

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
isLive	boolean	query	Não
doSpamCheck	boolean	query	Não
sendEmails	boolean	query	Não
populateNotifications	boolean	query	Não

Resposta

Retorna: SaveCommentsBulkResponse

Exemplo

Exemplo de save_comments_bulk

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

definir_texto_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
commentId	string	path	Sim
broadcastId	string	query	Sim
editKey	string	query	Não
sso	string	query	Não

Resposta

Retorna: PublicAPISetCommentTextResponse

Exemplo

Exemplo de set_comment_text

Copy

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

desbloquear_usuario_por_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: UnblockSuccess

Exemplo

Exemplo de un_block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

remover_denuncia_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: FlagCommentResponse

Exemplo

Exemplo de un_flag_comment

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

desbloquear_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
commentId	string	path	Sim
broadcastId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de un_lock_comment

Copy

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

desfixar_comentario

Parâmetros

Nome	Tipo	Location	Obrigatório
tenantId	string	path	Sim
commentId	string	path	Sim
broadcastId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: ChangeCommentPinStatusResponse

Exemplo

Exemplo de un_pin_comment

Copy

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

atualizar_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
contextUserId	string	query	Não
doSpamCheck	boolean	query	Não
isLive	boolean	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_comment

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  do_spam_check: true, # Boolean | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_comment: #{e}"
end

votar_comentario

Parameters

Name	Type	Location	Required
tenantId	string	path	Sim
commentId	string	path	Sim
urlId	string	query	Sim
broadcastId	string	query	Sim
sessionId	string	query	Não
sso	string	query	Não

Response

Retorna: VoteResponse

Exemplo

vote_comment Exemplo

Copy

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

obter_comentarios_para_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório
userId	string	query	Não
direction	string	query	Não
repliesToUserId	string	query	Não
page	number	query	Não
includei10n	boolean	query	Não
locale	string	query	Não
isCrawler	boolean	query	Não

Resposta

Retorna: GetCommentsForUserResponse

Exemplo

Exemplo de get_comments_for_user

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
opts = {
  user_id: 'user_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  replies_to_user_id: 'replies_to_user_id_example', # String | 
  page: 1.2, # Float | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  is_crawler: true # Boolean | 
}
begin
  
  result = api_instance.get_comments_for_user(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_for_user: #{e}"
end

adicionar_configuracao_dominio

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: AddDomainConfigResponse

Exemplo

Exemplo de add_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

excluir_configuracao_dominio

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
domain	string	path	Sim

Resposta

Retorna: DeleteDomainConfigResponse

Exemplo

Exemplo de delete_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

obter_configuracao_dominio

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
domain	string	path	Sim

Resposta

Retorna: GetDomainConfigResponse

Exemplo

Exemplo de get_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

obter_configuracoes_dominio

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: GetDomainConfigsResponse

Exemplo

Exemplo de get_domain_configs

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

atualizar_parcial_configuracao_dominio

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
domainToUpdate	string	path	Sim

Resposta

Retorna: PatchDomainConfigResponse

Exemplo

Exemplo de patch_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

substituir_configuracao_dominio

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
domainToUpdate	string	path	Sim

Resposta

Retorna: PutDomainConfigResponse

Exemplo

Exemplo de put_domain_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

criar_modelo_email

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateEmailTemplateResponse

Exemplo

Exemplo de create_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, e.g. 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

excluir_modelo_email

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

excluir_erro_renderizacao_modelo_email

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
errorId	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_email_template_render_error

Copy

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

obter_modelo_email

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: GetEmailTemplateResponse

Exemplo

Exemplo de get_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

obter_definicoes_modelo_email

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: GetEmailTemplateDefinitionsResponse

Exemplo

Exemplo de get_email_template_definitions

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

obter_erros_renderizacao_modelo_email

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
id	string	path	Sim
skip	number	query	Não

Resposta

Retorna: GetEmailTemplateRenderErrorsResponse

Exemplo

Exemplo de get_email_template_render_errors

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

obter_modelos_email

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
skip	number	query	Não

Resposta

Retorna: GetEmailTemplatesResponse

Exemplo

Exemplo de get_email_templates

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (o padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

renderizar_modelo_email

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
locale	string	query	Não

Resposta

Retorna: RenderEmailTemplateResponse

Exemplo

Exemplo de render_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, e.g. 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

atualizar_modelo_email

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_email_template

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

obter_registro_evento

req tenantId urlId userIdWS

Parâmetros

Name	Type	Location	Required
tenantId	string	caminho	Sim
urlId	string	query	Sim
userIdWS	string	query	Sim
startTime	integer	query	Sim
endTime	integer	query	Não

Resposta

Retorna: GetEventLogResponse

Exemplo

Exemplo de get_event_log

Copy

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

obter_registro_evento_global

req tenantId urlId userIdWS

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
userIdWS	string	query	Sim
startTime	integer	query	Sim
endTime	integer	query	Não

Resposta

Retorna: GetEventLogResponse

Exemplo

Exemplo de get_global_event_log

Copy

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

criar_post_feed

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
broadcastId	string	query	Não
isLive	boolean	query	Não
doSpamCheck	boolean	query	Não
skipDupCheck	boolean	query	Não

Resposta

Retorna: CreateFeedPostsResponse

Exemplo

Exemplo de create_feed_post

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

criar_post_feed_publico

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: CreateFeedPostResponse

Exemplo

create_feed_post_public Exemplo

Copy

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

excluir_post_feed_publico

Parâmetros

Nome	Type	Location	Obrigatório
tenantId	string	path	Sim
postId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: DeleteFeedPostPublicResponse

Exemplo

Exemplo de delete_feed_post_public

Copy

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

obter_posts_feed

req tenantId afterId

Parameters

Name	Type	Location	Required
tenantId	string	query	Sim
afterId	string	query	Não
limit	integer	query	Não
tags	array	query	Não

Response

Retorna: GetFeedPostsResponse

Example

Exemplo de get_feed_posts

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

obter_posts_feed_publicos

req tenantId afterId

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
afterId	string	query	Não
limit	integer	query	Não
tags	array	query	Não
sso	string	query	Não
isCrawler	boolean	query	Não
includeUserInfo	boolean	query	Não

Resposta

Retorna: PublicFeedPostsResponse

Exemplo

Exemplo de get_feed_posts_public

Copy

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

obter_estatisticas_posts_feed

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	path	Sim
postIds	array	query	Sim
sso	string	query	Não

Resposta

Retorna: FeedPostsStatsResponse

Exemplo

Exemplo de get_feed_posts_stats

Copy

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

obter_reacoes_usuario_publico

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
postIds	array	query	Não
sso	string	query	Não

Resposta

Retorna: UserReactsResponse

Exemplo

Exemplo de get_user_reacts_public

Copy

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

reagir_post_feed_publico

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Yes
postId	string	path	Yes
isUndo	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Resposta

Retorna: ReactFeedPostResponse

Exemplo

Exemplo react_feed_post_public

Copy

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

atualizar_post_feed

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Yes
id	string	path	Yes

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_feed_post

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost | 
begin
  
  result = api_instance.update_feed_post(tenant_id, id, feed_post)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_feed_post: #{e}"
end

atualizar_post_feed_publico

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
postId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: CreateFeedPostResponse

Exemplo

Exemplo de update_feed_post_public

Copy

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

denunciar_comentario_publico

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
isFlagged	boolean	query	Sim
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de flag_comment_public

Copy

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

obter_gif_grande

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	path	Sim
largeInternalURLSanitized	string	query	Sim

Resposta

Retorna: GifGetLargeResponse

Exemplo

Exemplo de get_gif_large

Copy

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

obter_gifs_busca

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
search	string	query	Sim
locale	string	query	Não
rating	string	query	Não
page	number	query	Não

Resposta

Retorna: GetGifsSearchResponse

Exemplo

Exemplo de get_gifs_search

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
search = 'search_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_search(tenant_id, search, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_search: #{e}"
end

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
locale	string	query	Não
rating	string	query	Não
page	number	query	Não

Resposta

Retorna: GetGifsTrendingResponse

Exemplo

Exemplo de get_gifs_trending

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_trending(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_trending: #{e}"
end

adicionar_hashtag

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: CreateHashTagResponse

Exemplo

Exemplo add_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização de chave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave API, por exemplo 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

adicionar_hashtags_em_lote

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Yes

Response

Returns: BulkCreateHashTagsResponse

Example

add_hash_tags_bulk Exemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave API, por exemplo 'Bearer' (padrão nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
begin
  
  result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

excluir_hashtag

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
tag	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo delete_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização de chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody | 
begin
  
  result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

obter_hashtags

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
page	number	query	Não

Resposta

Retorna: GetHashTagsResponse

Exemplo

Exemplo get_hash_tags

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

atualizar_parcial_hashtag

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
tag	string	path	Sim

Resposta

Retorna: UpdateHashTagResponse

Exemplo

patch_hash_tag Exemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
begin
  
  result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

excluir_voto_moderacao

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
voteId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: VoteDeleteResponse

Exemplo

Exemplo delete_moderation_vote

Copy

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

obter_comentarios_api

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
page	number	query	Não
count	number	query	Não
text-search	string	query	Não
byIPFromComment	string	query	Não
filters	string	query	Não
searchFilters	string	query	Não
sorts	string	query	Não
demo	boolean	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationAPIGetCommentsResponse

Exemplo

Exemplo get_api_comments

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2, # Float | 
  count: 1.2, # Float | 
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_comments: #{e}"
end

obter_status_exportacao_api

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
batchJobId	string	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationExportStatusResponse

Exemplo

Exemplo get_api_export_status

Copy

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

obter_ids_api

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
text-search	string	query	Não
byIPFromComment	string	query	Não
filters	string	query	Não
searchFilters	string	query	Não
afterId	string	query	Não
demo	boolean	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationAPIGetCommentIdsResponse

Exemplo

Exemplo get_api_ids

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  after_id: 'after_id_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_ids(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_ids: #{e}"
end

obter_usuarios_banidos_por_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
sso	string	query	Não

Resposta

Retorna: GetBannedUsersFromCommentResponse

Exemplo

get_ban_users_from_comment Exemplo

Copy

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

obter_status_ban_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Resposta

Retorna: GetCommentBanStatusResponse

Exemplo

Exemplo get_comment_ban_status

Copy

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

obter_filhos_do_comentario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Resposta

Retorna: ModerationAPIChildCommentsResponse

Exemplo

Exemplo get_comment_children

Copy

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

obter_contagem

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filter	string	query	No
searchFilters	string	query	No
demo	boolean	query	No
sso	string	query	No

Resposta

Retorna: ModerationAPICountCommentsResponse

Exemplo

Exemplo get_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filter: 'filter_example', # String | 
  search_filters: 'search_filters_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_count: #{e}"
end

obter_contagens

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: GetBannedUsersCountResponse

Exemplo

get_counts Exemplo

Copy

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

obter_logs

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
sso	string	query	Não

Resposta

Retorna: ModerationAPIGetLogsResponse

Exemplo

Exemplo get_logs

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_logs(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Erro ao chamar ModerationApi->get_logs: #{e}"
end

obter_insignias_manuais

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: GetTenantManualBadgesResponse

Exemplo

Exemplo get_manual_badges

Copy

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

obter_insignias_manuais_por_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
badgesUserId	string	query	Não
commentId	string	query	Não
sso	string	query	Não

Resposta

Retorna: GetUserManualBadgesResponse

Exemplo

Exemplo get_manual_badges_for_user

Copy

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

obter_comentario_moderacao

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

Resposta

Retorna: ModerationAPICommentResponse

Exemplo

Exemplo get_moderation_comment

Copy

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

obter_texto_comentario_moderacao

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
sso	string	query	Não

Resposta

Retorna: GetCommentTextResponse

Exemplo

get_moderation_comment_text Exemplo

Copy

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

obter_resumo_pre_banimento

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
includeByUserIdAndEmail	boolean	query	Não
includeByIP	boolean	query	Não
includeByEmailDomain	boolean	query	Não
sso	string	query	Não

Resposta

Retorna: PreBanSummary

Exemplo

Exemplo get_pre_ban_summary

Copy

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

obter_resumo_busca_comentarios

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
value	string	query	Não
filters	string	query	Não
searchFilters	string	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationCommentSearchResponse

Exemplo

Exemplo get_search_comments_summary

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_comments_summary(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
end

obter_paginas_de_busca

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
value	string	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationPageSearchResponse

Exemplo

get_search_pages Exemplo

Copy

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

obter_sites_de_busca

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
value	string	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationSiteSearchResponse

Exemplo

Exemplo get_search_sites

Copy

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

obter_sugestoes_de_busca

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
text-search	string	query	Não
sso	string	query	Não

Resposta

Retorna: ModerationSuggestResponse

Exemplo

Exemplo get_search_suggest

Copy

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

obter_usuarios_de_busca

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

Response

Retorna: ModerationUserSearchResponse

Example

get_search_users Exemplo

Copy

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

obter_fator_de_confianca

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
userId	string	query	No
sso	string	query	No

Resposta

Retorna: GetUserTrustFactorResponse

Exemplo

Exemplo get_trust_factor

Copy

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

obter_preferencia_ban_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: APIModerateGetUserBanPreferencesResponse

Exemplo

Exemplo get_user_ban_preference

Copy

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

obter_perfil_interno_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	query	Não
sso	string	query	Não

Resposta

Retorna: GetUserInternalProfileResponse

Exemplo

get_user_internal_profile Exemplo

Copy

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

ajustar_votos_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	consulta	Sim
commentId	string	caminho	Sim
broadcastId	string	consulta	Não
sso	string	consulta	Não

Resposta

Retorna: AdjustVotesResponse

Exemplo

Exemplo post_adjust_comment_votes

Copy

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

post_exportacao_api

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Resposta

Retorna: ModerationExportResponse

Exemplo

Exemplo post_api_export

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_api_export(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_api_export: #{e}"
end

post_banir_usuario_por_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

Resposta

Retorna: BanUserFromCommentResult

Exemplo

post_ban_user_from_comment Exemplo

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  ban_email: true, # Boolean | 
  ban_email_domain: true, # Boolean | 
  ban_ip: true, # Boolean | 
  delete_all_users_comments: true, # Boolean | 
  banned_until: 'banned_until_example', # String | 
  is_shadow_ban: true, # Boolean | 
  update_id: 'update_id_example', # String | 
  ban_reason: 'ban_reason_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Erro ao chamar ModerationApi->post_ban_user_from_comment: #{e}"
end

post_desfazer_ban_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

post_ban_user_undo Exemplo

Copy

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

post_resumo_pre_ban_em_lote

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
includeByUserIdAndEmail	boolean	query	No
includeByIP	boolean	query	No
includeByEmailDomain	boolean	query	No
sso	string	query	No

Resposta

Retorna: BulkPreBanSummary

Exemplo

post_bulk_pre_ban_summary Exemplo

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_bulk_pre_ban_summary: #{e}"
end

post_comentarios_por_ids

Parameters

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Yes
sso	string	query	No

Resposta

Retorna: ModerationAPIChildCommentsResponse

Exemplo

post_comments_by_ids Exemplo

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_comments_by_ids: #{e}"
end

post_denunciar_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Resposta

Returns: APIEmptyResponse

Exemplo

Exemplo post_flag_comment

Copy

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

post_remover_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: PostRemoveCommentApiResponse

Exemplo

Exemplo post_remove_comment

Copy

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

post_restaurar_comentario_excluido

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
commentId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo post_restore_deleted_comment

Copy

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

post_definir_status_aprovacao_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
approved	boolean	query	Não
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: SetCommentApprovedResponse

Exemplo

post_set_comment_approval_status Exemplo

Copy

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

post_definir_status_revisao_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
reviewed	boolean	query	Não
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

post_set_comment_review_status Exemplo

Copy

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

post_definir_status_spam_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Resposta

Retorna: APIEmptyResponse

Exemplo

post_set_comment_spam_status Exemplo

Copy

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

post_definir_texto_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Resposta

Retorna: SetCommentTextResponse

Exemplo

post_set_comment_text Exemplo

Copy

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

post_remover_denuncia_comentario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Resposta

Retorna: APIEmptyResponse

Exemplo

post_un_flag_comment Exemplo

Copy

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

post_votar

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	path	Sim
direction	string	query	Não
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: VoteResponse

Exemplo

Exemplo post_vote

Copy

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

put_conceder_insignia

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
badgeId	string	query	Sim
userId	string	query	Não
commentId	string	query	Não
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: AwardUserBadgeResponse

Exemplo

Exemplo put_award_badge

Copy

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

put_fechar_topico

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
urlId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

put_close_thread Exemplo

Copy

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

put_remover_insignia

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
badgeId	string	query	Sim
userId	string	query	Não
commentId	string	query	Não
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: RemoveUserBadgeResponse

Exemplo

Exemplo put_remove_badge

Copy

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

put_reabrir_topico

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
urlId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo put_reopen_thread

Copy

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

definir_fator_de_confianca

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
userId	string	query	No
trustFactor	string	query	No
sso	string	query	No

Resposta

Retorna: SetUserTrustFactorResponse

Exemplo

Exemplo set_trust_factor

Copy

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

criar_moderador

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateModeratorResponse

Exemplo

Exemplo de create_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

excluir_moderador

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
id	string	path	Sim
sendEmail	string	query	Não

Response

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

obter_moderador

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: GetModeratorResponse

Exemplo

Exemplo de get_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

obter_moderadores

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
skip	number	query	Não

Resposta

Retorna: GetModeratorsResponse

Exemplo

Exemplo de get_moderators

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

enviar_convite

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
fromName	string	query	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de send_invite

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

atualizar_moderador

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

excluir_contagem_notificacao

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (o padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

obter_contagem_notificacoes_em_cache

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: GetCachedNotificationCountResponse

Exemplo

Exemplo de get_cached_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

obter_contagem_de_notificacoes

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
userId	string	query	Não
urlId	string	query	Não
fromCommentId	string	query	Não
viewed	boolean	query	Não
type	string	query	Não

Resposta

Retorna: GetNotificationCountResponse

Exemplo

Exemplo de get_notification_count

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave da API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example' # String | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

obter_notificacoes

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
userId	string	query	Não
urlId	string	query	Não
fromCommentId	string	query	Não
viewed	boolean	query	Não
type	string	query	Não
skip	number	query	Não

Resposta

Retorna: GetNotificationsResponse

Exemplo

Exemplo de get_notifications

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

atualizar_notificacao

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_notification

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, e.g. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

criar_reacao_pagina_v1

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
title	string	query	Não

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo de create_v1_page_react

Copy

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

criar_reacao_pagina_v2

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
id	string	query	Sim
title	string	query	Não

Resposta

Retorna: CreateV1PageReact

Exemplo

create_v2_page_react Exemplo

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v2_page_react: #{e}"
end

excluir_reacao_pagina_v1

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim
urlId	string	query	Sim

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo de delete_v1_page_react

Copy

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

excluir_reacao_pagina_v2

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
id	string	query	Sim

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo de delete_v2_page_react

Copy

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

obter_curtidas_pagina_v1

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
tenantId	string	path	Sim
urlId	string	query	Sim

Resposta

Retorna: GetV1PageLikes

Exemplo

Exemplo de get_v1_page_likes

Copy

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

obter_usuarios_reacao_pagina_v2

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
id	string	query	Sim

Resposta

Retorna: GetV2PageReactUsersResponse

Exemplo

get_v2_page_react_users Exemplo

Copy

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

obter_reacoes_pagina_v2

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim
urlId	string	query	Sim

Resposta

Retorna: GetV2PageReacts

Exemplo

Exemplo de get_v2_page_reacts

Copy

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

adicionar_pagina

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: AddPageAPIResponse

Exemplo

Exemplo de add_page

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

excluir_pagina

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: DeletePageAPIResponse

Exemplo

Exemplo de delete_page

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, e.g. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_page(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_page: #{e}"
end

obter_usuarios_offline

Comentadores anteriores na página que NÃO estão atualmente online. Ordenados por displayName. Use isto após esgotar /users/online para renderizar uma seção "Membros". Paginação por cursor em commenterName: o servidor percorre o índice parcial {tenantId, urlId, commenterName} a partir de afterName para frente via $gt, sem custo de $skip.

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	Identificador da URL da página (limpo no servidor).
afterName	string	query	No	Cursor: passe nextAfterName da resposta anterior.
afterUserId	string	query	No	Desempate do cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nomes não excluam entradas.

Response

Retorna: PageUsersOfflineResponse

Example

get_offline_users Exemplo

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Identificador da URL da página (limpo no servidor).
opts = {
  after_name: 'after_name_example', # String | Cursor: passe nextAfterName da resposta anterior.
  after_user_id: 'after_user_id_example' # String | Desempate do cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nomes não excluam entradas.
}
begin
  
  result = api_instance.get_offline_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_offline_users: #{e}"
end

obter_usuarios_online

Visualizadores atualmente online de uma página: pessoas cuja sessão websocket está inscrita na página agora. Retorna anonCount + totalCount (assinantes da sala, incluindo visualizadores anônimos que não enumeramos).

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim
urlId	string	query	Sim	Identificador da URL da página (limpo no servidor).
afterName	string	query	Não	Cursor: passe nextAfterName da resposta anterior.
afterUserId	string	query	Não	Tiebreaker do cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nome não descartem entradas.

Resposta

Retorna: PageUsersOnlineResponse

Exemplo

Exemplo get_online_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Identificador da URL da página (limpo no servidor).
opts = {
  after_name: 'after_name_example', # String | Cursor: passe nextAfterName da resposta anterior.
  after_user_id: 'after_user_id_example' # String | Tiebreaker do cursor: passe nextAfterUserId da resposta anterior. Obrigatório quando afterName está definido para que empates de nome não descartem entradas.
}
begin
  
  result = api_instance.get_online_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_online_users: #{e}"
end

obter_pagina_por_urlid

Parâmetros

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

Resposta

Retorna: GetPageByURLIdAPIResponse

Exemplo

Exemplo de get_page_by_urlid

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

obter_paginas

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: GetPagesAPIResponse

Exemplo

Exemplo de get_pages

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

obter_paginas_publicas

Lista páginas para um tenant. Usado pelo cliente desktop FChat para preencher sua lista de salas. Exige que enableFChat seja true na configuração personalizada resolvida para cada página. Páginas que exigem SSO são filtradas com base no acesso de grupo do usuário solicitante.

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim
cursor	string	query	Não	Cursor opaco de paginação retornado como `nextCursor` de uma requisição anterior. Vinculado ao mesmo `sortBy`.
limit	integer	query	Não	1..200, padrão 50
q	string	query	Não	Filtro opcional por prefixo de título, insensível a maiúsculas/minúsculas.
sortBy	string	query	Não	Ordem de classificação. `updatedAt` (padrão, mais recentes primeiro), `commentCount` (mais comentários primeiro), ou `title` (alfabética).
hasComments	boolean	query	Não	Se true, apenas retorna páginas com pelo menos um comentário.

Resposta

Retorna: GetPublicPagesResponse

Exemplo

Exemplo get_pages_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | Cursor opaco de paginação retornado como `nextCursor` de uma requisição anterior. Vinculado ao mesmo `sortBy`.
  limit: 56, # Integer | 1..200, padrão 50
  q: 'q_example', # String | Filtro opcional por prefixo de título, insensível a maiúsculas/minúsculas.
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Ordem de classificação. `updatedAt` (padrão, mais recentes primeiro), `commentCount` (mais comentários primeiro), ou `title` (alfabética).
  has_comments: true # Boolean | Se true, apenas retorna páginas com pelo menos um comentário.
}
begin
  
  result = api_instance.get_pages_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_pages_public: #{e}"
end

obter_informacoes_usuarios

Informações em massa de usuários para um tenant. Com os userIds fornecidos, retorna informações de exibição de User / SSOUser. Usado pelo widget de comentários para enriquecer usuários que acabaram de aparecer via um evento de presença. Sem contexto de página: a privacidade é aplicada de forma uniforme (perfis privados são mascarados).

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	path	Sim
ids	string	query	Sim	userIds separados por vírgula.

Resposta

Retorna: PageUsersInfoResponse

Exemplo

Exemplo de get_users_info

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | userIds separados por vírgula.
begin
  
  result = api_instance.get_users_info(tenant_id, ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_users_info: #{e}"
end

atualizar_parcial_pagina

Parâmetros

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

Resposta

Retorna: PatchPageAPIResponse

Exemplo

Exemplo de patch_page

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

excluir_evento_webhook_pendente

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_pending_webhook_event

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

obter_contagem_eventos_webhook_pendentes

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
commentId	string	query	Não
externalId	string	query	Não
eventType	string	query	Não
type	string	query	Não
domain	string	query	Não
attemptCountGT	number	query	Não

Resposta

Retorna: GetPendingWebhookEventCountResponse

Exemplo

Exemplo de get_pending_webhook_event_count

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

obter_eventos_webhook_pendentes

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
commentId	string	query	Não
externalId	string	query	Não
eventType	string	query	Não
type	string	query	Não
domain	string	query	Não
attemptCountGT	number	query	Não
skip	number	query	Não

Resposta

Retorna: GetPendingWebhookEventsResponse

Exemplo

Exemplo de get_pending_webhook_events

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

criar_configuracao_pergunta

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: CreateQuestionConfigResponse

Exemplo

Exemplo de create_question_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

excluir_configuracao_pergunta

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_question_config

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

obter_configuracao_pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionConfigResponse

Exemplo

Exemplo de get_question_config

Copy

require 'time'
require 'fastcomments-client'
# configuração da autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

obter_configuracoes_pergunta

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
skip	number	query	Não

Resposta

Retorna: GetQuestionConfigsResponse

Exemplo

Exemplo de get_question_configs

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_configs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_configs: #{e}"
end

atualizar_configuracao_pergunta

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_question_config

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

criar_resultado_pergunta

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: CreateQuestionResultResponse

Exemplo

Exemplo de create_question_result

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

excluir_resultado_pergunta

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

delete_question_result Exemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

obter_resultado_pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionResultResponse

Exemplo

Exemplo de get_question_result

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

obter_resultados_pergunta

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
urlId	string	query	Não
userId	string	query	Não
startDate	string	query	Não
questionId	string	query	Não
questionIds	string	query	Não
skip	number	query	Não

Resposta

Retorna: GetQuestionResultsResponse

Exemplo

Exemplo de get_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

atualizar_resultado_pergunta

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_question_result

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

agregar_resultados_pergunta

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
questionId	string	query	Não
questionIds	array	query	Não
urlId	string	query	Não
timeBucket	string	query	Não
startDate	string	query	Não
forceRecalculate	boolean	query	Não

Resposta

Retorna: AggregateQuestionResultsResponse

Exemplo

Exemplo de aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

agregar_resultados_pergunta_em_lote

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
forceRecalculate	boolean	query	Não

Resposta

Retorna: BulkAggregateQuestionResultsResponse

Exemplo

Exemplo de bulk_aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

combinar_comentarios_com_resultados_de_perguntas

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
questionId	string	query	Não
questionIds	array	query	Não
urlId	string	query	Não
startDate	string	query	Não
forceRecalculate	boolean	query	Não
minValue	number	query	Não
maxValue	number	query	Não
limit	number	query	Não

Resposta

Retorna: CombineQuestionResultsWithCommentsResponse

Exemplo

Exemplo de combine_comments_with_question_results

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, e.g. 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

adicionar_usuario_sso

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: AddSSOUserAPIResponse

Exemplo

Exemplo add_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData | 
begin
  
  result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_sso_user: #{e}"
end

excluir_usuario_sso

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
deleteComments	boolean	query	Não
commentDeleteMode	string	query	Não

Resposta

Retorna: DeleteSSOUserAPIResponse

Exemplo

Exemplo de delete_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

obter_usuario_sso_por_email

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
email	string	path	Sim

Resposta

Retorna: GetSSOUserByEmailAPIResponse

Exemplo

Exemplo de get_sso_user_by_email

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

obter_usuario_sso_por_id

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: GetSSOUserByIdAPIResponse

Exemplo

Exemplo de get_sso_user_by_id

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
end

obter_usuarios_sso

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
skip	integer	query	Não

Resposta

Retorna: GetSSOUsersResponse

Exemplo

Exemplo de get_sso_users

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 56 # Integer | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

atualizar_parcial_usuario_sso

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
updateComments	boolean	query	Não

Resposta

Retorna: PatchSSOUserAPIResponse

Exemplo

patch_sso_user Exemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

substituir_usuario_sso

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
updateComments	boolean	query	Não

Resposta

Retorna: PutSSOUserAPIResponse

Exemplo

Exemplo de put_sso_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_sso_user: #{e}"
end

criar_assinatura

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: CreateSubscriptionAPIResponse

Exemplo

Exemplo de create_subscription

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

excluir_assinatura

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não

Resposta

Retorna: DeleteSubscriptionAPIResponse

Exemplo

Exemplo de delete_subscription

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # config.api_key_prefix['x-api-key'] = 'Bearer'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por ex. 'Bearer' (padrão: nil)
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

obter_assinaturas

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
userId	string	query	Não

Resposta

Retorna: GetSubscriptionsAPIResponse

Exemplo

Exemplo de get_subscriptions

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_subscriptions(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_subscriptions: #{e}"
end

atualizar_assinatura

Parâmetros

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

Resposta

Retorna: UpdateSubscriptionAPIResponse

Exemplo

Exemplo de update_subscription

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar a autorização da chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_subscription: #{e}"
end

obter_usos_diarios_locatario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
yearNumber	number	query	Não
monthNumber	number	query	Não
dayNumber	number	query	Não
skip	number	query	Não

Resposta

Retorna: GetTenantDailyUsagesResponse

Exemplo

Exemplo de get_tenant_daily_usages

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

criar_pacote_locatario

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
tenantId	string	query	Sim

Resposta

Retorna: CreateTenantPackageResponse

Exemplo

Exemplo de create_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, p.ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

excluir_pacote_locatario

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

obter_pacote_locatario

Parâmetros

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

Resposta

Retorna: GetTenantPackageResponse

Exemplo

Exemplo de get_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

obter_pacotes_locatario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
skip	number	query	Não

Resposta

Retorna: GetTenantPackagesResponse

Exemplo

Exemplo de get_tenant_packages

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

substituir_pacote_locatario

Parâmetros

Nome	Tipo	Location	Required	Description
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de replace_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

atualizar_pacote_locatario

Parâmetros

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

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

criar_usuario_locatario

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateTenantUserResponse

Exemplo

Exemplo de create_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave da API, ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody | 
begin
  
  result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_user: #{e}"
end

excluir_usuario_locatario

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
deleteComments	string	query	Não
commentDeleteMode	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave da API, e.g. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

obter_usuario_locatario

Parâmetros

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

Resposta

Retorna: GetTenantUserResponse

Exemplo

Exemplo get_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

obter_usuarios_locatario

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim
skip	number	query	Não

Resposta

Retorna: GetTenantUsersResponse

Exemplo

Exemplo de get_tenant_users

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização com chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

substituir_usuario_locatario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
id	string	path	Sim
updateComments	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de replace_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
end

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
redirectURL	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de send_login_link

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

atualizar_usuario_locatario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
id	string	path	Yes
updateComments	string	query	No

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

criar_locatario

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateTenantResponse

Exemplo

Exemplo de create_tenant

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

excluir_locatario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
sure	string	query	Não

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de delete_tenant

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  sure: 'sure_example' # String | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

obter_locatario

Parâmetros

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

Resposta

Retorna: GetTenantResponse

Exemplo

Exemplo de get_tenant

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

obter_locatarios

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
meta	string	query	Não
skip	number	query	Não

Resposta

Retorna: GetTenantsResponse

Exemplo

Exemplo de get_tenants

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão é nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

atualizar_locatario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de update_tenant

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

alterar_estado_ticket

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
userId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: ChangeTicketStateResponse

Exemplo

Exemplo de change_ticket_state

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
id = 'id_example' # String | 
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody | 
begin
  
  result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->change_ticket_state: #{e}"
end

criar_ticket

Parâmetros

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

Resposta

Retorna: CreateTicketResponse

Exemplo

Exemplo de create_ticket

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody | 
begin
  
  result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_ticket: #{e}"
end

obter_ticket

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
userId	string	query	Não

Resposta

Retorna: GetTicketResponse

Exemplo

Exemplo get_ticket

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_ticket(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_ticket: #{e}"
end

obter_tickets

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
userId	string	query	Não
state	number	query	Não
skip	number	query	Não
limit	number	query	Não

Resposta

Retorna: GetTicketsResponse

Exemplo

Exemplo de get_tickets

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha seguinte para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  state: 1.2, # Float | 
  skip: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tickets(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tickets: #{e}"
end

obter_traducoes

Parâmetros

Nome	Type	Location	Obrigatório
namespace	string	path	Sim
component	string	path	Sim
locale	string	query	Não
useFullTranslationIds	boolean	query	Não

Resposta

Retorna: GetTranslationsResponse

Exemplo

Exemplo de get_translations

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
namespace = 'namespace_example' # String | 
component = 'component_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  use_full_translation_ids: true # Boolean | 
}
begin
  
  result = api_instance.get_translations(namespace, component, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_translations: #{e}"
end

enviar_imagem

Enviar e redimensionar uma imagem

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	path	Sim
sizePreset	string	query	Não	Predefinição de tamanho: "Default" (1000x1000px) ou "CrossPlatform" (cria tamanhos para dispositivos populares)
urlId	string	query	Não	ID da página de onde o upload está ocorrendo, para configurar

Resposta

Retorna: UploadImageResponse

Exemplo

Exemplo de upload_image

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
file = File.new('/path/to/some/file') # File | 
opts = {
  size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Predefinição de tamanho: \"Default\" (1000x1000px) ou \"CrossPlatform\" (cria tamanhos para dispositivos populares)
  url_id: 'url_id_example' # String | ID da página de onde o upload está ocorrendo, para configurar
}
begin
  
  result = api_instance.upload_image(tenant_id, file, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->upload_image: #{e}"
end

obter_progresso_insignia_usuario_por_id

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: APIGetUserBadgeProgressResponse

Exemplo

Exemplo de get_user_badge_progress_by_id

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autenticação por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

obter_progresso_insignia_por_usuario_id

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
userId	string	path	Sim

Resposta

Retorna: APIGetUserBadgeProgressResponse

Exemplo

get_user_badge_progress_by_user_id Exemplo

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave da API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, p.ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

obter_lista_progresso_insignia_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
userId	string	query	Não
limit	number	query	Não
skip	number	query	Não

Resposta

Retorna: APIGetUserBadgeProgressListResponse

Exemplo

Exemplo de get_user_badge_progress_list

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

criar_insignia_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Yes

Resposta

Retorna: APICreateUserBadgeResponse

Exemplo

Exemplo de create_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

excluir_insignia_usuario

Parâmetros

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

Resposta

Retorna: APIEmptySuccessResponse

Exemplo

Exemplo de delete_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a seguinte linha para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

obter_insignia_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Yes
id	string	path	Yes

Resposta

Retorna: APIGetUserBadgeResponse

Exemplo

Exemplo de get_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

obter_insignias_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
userId	string	query	Não
badgeId	string	query	Não
type	number	query	Não
displayedOnComments	boolean	query	Não
limit	number	query	Não
skip	number	query	Não

Resposta

Retorna: APIGetUserBadgesResponse

Exemplo

get_user_badges Example

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, ex.: 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  badge_id: 'badge_id_example', # String | 
  type: 1.2, # Float | 
  displayed_on_comments: true, # Boolean | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

atualizar_insignia_usuario

Parâmetros

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

Resposta

Retorna: APIEmptySuccessResponse

Exemplo

Exemplo de update_user_badge

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

obter_contagem_notificacao_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: GetUserNotificationCountResponse

Exemplo

Exemplo de get_user_notification_count

Copy

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

obter_notificacoes_usuario

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
tenantId	string	query	Sim
urlId	string	query	Não	Usado para determinar se a página atual está inscrita.
pageSize	integer	query	Não
afterId	string	query	Não
includeContext	boolean	query	Não
afterCreatedAt	integer	query	Não
unreadOnly	boolean	query	Não
dmOnly	boolean	query	Não
noDm	boolean	query	Não
includeTranslations	boolean	query	Não
includeTenantNotifications	boolean	query	Não
sso	string	query	Não

Resposta

Retorna: GetMyNotificationsResponse

Exemplo

Exemplo de get_user_notifications

Copy

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

resetar_contagem_notificacao_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: ResetUserNotificationsResponse

Exemplo

Exemplo de reset_user_notification_count

Copy

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

resetar_notificacoes_usuario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
afterId	string	query	Não
afterCreatedAt	integer	query	Não
unreadOnly	boolean	query	Não
dmOnly	boolean	query	Não
noDm	boolean	query	Não
sso	string	query	Não

Resposta

Retorna: ResetUserNotificationsResponse

Exemplo

Exemplo de reset_user_notifications

Copy

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

atualizar_status_assinatura_comentario_notificacao_usuario

Ativar ou desativar notificações para um comentário específico.

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
notificationId	string	path	Sim
optedInOrOut	string	path	Sim
commentId	string	query	Sim
sso	string	query	Não

Resposta

Retorna: UpdateUserNotificationCommentSubscriptionStatusResponse

Exemplo

Exemplo de update_user_notification_comment_subscription_status

Copy

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

atualizar_status_assinatura_pagina_notificacao_usuario

Ativar ou desativar notificações para uma página. Quando os usuários estão inscritos em uma página, são criadas notificações para novos comentários raiz, e também

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	query	Sim
urlId	string	query	Sim
url	string	query	Sim
pageTitle	string	query	Sim
subscribedOrUnsubscribed	string	path	Sim
sso	string	query	Não

Resposta

Retorna: UpdateUserNotificationPageSubscriptionStatusResponse

Exemplo

Exemplo de update_user_notification_page_subscription_status

Copy

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

atualizar_status_notificacao_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
notificationId	string	path	Sim
newStatus	string	path	Sim
sso	string	query	Não

Resposta

Retorna: UpdateUserNotificationStatusResponse

Exemplo

Exemplo de update_user_notification_status

Copy

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

obter_status_presenca_usuarios

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
urlIdWS	string	query	Sim
userIds	string	query	Sim

Resposta

Retorna: GetUserPresenceStatusesResponse

Exemplo

Exemplo de get_user_presence_statuses

Copy

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

buscar_usuarios

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	path	Sim
urlId	string	query	Sim
usernameStartsWith	string	query	Não
mentionGroupIds	array	query	Não
sso	string	query	Não
searchSection	string	query	Não

Resposta

Retorna: SearchUsersResult

Exemplo

Exemplo de search_users

Copy

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

obter_usuario

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: GetUserResponse

Exemplo

Exemplo de get_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha abaixo para definir um prefixo para a chave de API, p.ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

criar_voto

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
commentId	string	query	Sim
direction	string	query	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: VoteResponse

Exemplo

Exemplo de create_vote

Copy

require 'time'
require 'fastcomments-client'
# configuração de autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, e.g. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
direction = 'up' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

excluir_voto

Parâmetros

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
editKey	string	query	Não

Resposta

Retorna: VoteDeleteResponse

Exemplo

Exemplo de delete_vote

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave da API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  edit_key: 'edit_key_example' # String | 
}
begin
  
  result = api_instance.delete_vote(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_vote: #{e}"
end

obter_votos

Parâmetros

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

Resposta

Retorna: GetVotesResponse

Exemplo

get_votes Exemplo

Copy

require 'time'
require 'fastcomments-client'
# Configurar autorização
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

obter_votos_por_usuario

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
urlId	string	query	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: GetVotesForUserResponse

Exemplo

Exemplo de get_votes_for_user

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização da chave de API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Descomente a linha a seguir para definir um prefixo para a chave de API, por exemplo 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
end

Precisa de ajuda?

Se você encontrar algum problema ou tiver dúvidas sobre o Ruby SDK, por favor:

Contributing

Contribuições são bem-vindas! Por favor visite o repositório do GitHub para diretrizes de contribuição.

Idioma 🇧🇷 Português (Brasil)

Primeiros Passos

Documentação

Uso

Agregação

Logs de Auditoria

Autenticação

Bloquear por Comentário

Verificar Comentários Bloqueados

Comentários

Comentários do Usuário

Configurações de Domínio

Modelos de E-mail

Registro de Eventos

Publicações do Feed

Denunciar Comentário

GIFs

Hashtags

Moderação

Moderadores

Contagem de Notificações

Notificações

Reações da Página

Páginas

Eventos de Webhook Pendentes

Configurações de Pergunta

Resultados de Perguntas

Agregação de Resultados de Perguntas

Usuários SSO

Assinaturas

Uso Diário do Locatário

Pacotes do Locatário

Usuários do Locatário

Locatários

Chamados

Traduções

Enviar Imagem

Progresso de Insígnias do Usuário

Insígnias do Usuário

Notificações do Usuário

Status de Presença do Usuário

Busca de Usuários

Usuários

Votos

SDK FastComments para Ruby

Repositório

Instalação

Conteúdo da Biblioteca

APIs Públicas vs Seguras

Início Rápido

Using Authenticated APIs (DefaultApi)

Using Public APIs (PublicApi)

Using Moderation APIs (ModerationApi)

Common Issues

Notas

IDs de Broadcast

SSO (Login Único)

Uso de SSO

SSO Simples

SSO Seguro

agregar

Parâmetros

Resposta

Exemplo

obter_logs_de_auditoria

Parâmetros

Resposta

Exemplo

logout_público

Resposta

Exemplo

bloquear_por_comentario

Parâmetros

Resposta

Exemplo

desbloquear_comentario

Parâmetros

Resposta

Exemplo

verificar_comentarios_bloqueados