FastComments SDK 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'

E então 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 os utilitários SSO para facilitar o trabalho com a API.

Documentação da Biblioteca do Cliente da API

APIs Públicas vs APIs Seguras

Para o cliente de API, existem duas classes, DefaultApi e PublicApi. O DefaultApi contém métodos que exigem sua chave de API, e PublicApi contém chamadas de API que podem ser feitas diretamente a partir de um navegador/dispositivo móvel/etc sem autenticação.

Início rápido

Usando APIs Autenticadas (DefaultApi)

Importante: Você deve definir sua chave de API no ApiClient antes de fazer requisições autenticadas. Se não fizer isso, as requisições falharão com um erro 401.

require 'fastcomments-client'

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

# OBRIGATÓRIO: Defina sua chave de API (pegue isto do painel do 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 requisição falhou
end

Usando APIs Públicas (PublicApi)

Endpoints públicos não exigem autenticação:

require 'fastcomments-client'

public_api = FastCommentsClient::PublicApi.new

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

Problemas Comuns

Erro 401 "missing-api-key": Certifique-se de definir config.api_key['x-api-key'] = 'YOUR_KEY' antes de criar a instância DefaultApi.
Classe de API incorreta: Use DefaultApi para requisições do lado do servidor autenticadas, PublicApi para requisições do lado do cliente/públicas.
Chave de API nula: O SDK ignorará silenciosamente a autenticação se a chave de API for nula, resultando em erros 401.

Observações

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'
require 'fastcomments-client'

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

# Use 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(
  tenant_id: 'your-tenant-id',
  url_id: 'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

SSO Seguro

require 'fastcomments'
require 'fastcomments-client'

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

# Use 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(
  tenant_id: 'your-tenant-id',
  url_id: 'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

Agregação

Agrega documentos agrupando-os (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	Sim
parentTenantId	string	query	Não
includeStats	boolean	query	Não

Resposta

Retorna: AggregationResponse

Exemplo

Exemplo de aggregate

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 | 
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	Yes
limit	number	query	No
skip	number	query	No
order	string	query	No
after	number	query	No
before	number	query	No

Resposta

Retorna: GetAuditLogs200Response

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

Bloquear a partir de comentário público

Parâmetros

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

Resposta

Retorna: BlockFromCommentPublic200Response

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 comentário público

Parâmetros

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

Resposta

Retorna: UnBlockCommentPublic200Response

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 comentários para bloqueio

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
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: CheckedCommentsForBlocked200Response

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 usuário a partir do comentário

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: BlockFromCommentPublic200Response

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, 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 | 
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 comentário público

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: CreateCommentPublic200Response

Exemplo

Exemplo de create_comment_public

Copy

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

Excluir comentário

Parâmetros

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

Resposta

Retorna: DeleteComment200Response

Exemplo

delete_comment 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 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 comentário público

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: DeleteCommentPublic200Response

Exemplo

delete_comment_public Exemplo

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 comentário

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: DeleteCommentVote200Response

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 comentário

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: FlagComment200Response

Exemplo

Exemplo de flag_comment

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, 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 | 
  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 comentário

Parâmetros

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

Resposta

Retorna: GetComment200Response

Exemplo

Exemplo de get_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, 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_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

Obter texto do comentário

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: GetCommentText200Response

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 de usuários que votaram no comentário

Parâmetros

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

Resposta

Retorna: GetCommentVoteUserNames200Response

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 comentários

Parâmetros

Nome	Tipo	Localização	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

Resposta

Retorna: GetComments200Response

Exemplo

Exemplo de get_comments

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 = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF # SortDirections | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

Obter comentários públicos

req tenantId urlId

Parâmetros

Nome	Tipo	Location	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: GetCommentsPublic200Response

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 comentário

Parâmetros

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

Resposta

Retorna: LockComment200Response

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 comentário

Parâmetros

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

Resposta

Retorna: PinComment200Response

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 comentário

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
isLive	boolean	query	Não
doSpamCheck	boolean	query	Não
sendEmails	boolean	query	Não
populateNotifications	boolean	query	Não

Response

Retorna: SaveComment200Response

Exemplo

Exemplo de save_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 API key, 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_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 comentários em massa

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: Array<SaveComment200Response>

Exemplo

Exemplo de save_comments_bulk

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_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 do comentário

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: SetCommentText200Response

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 usuário do comentário

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: UnBlockCommentPublic200Response

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, 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 | 
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 denúncia do comentário

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: FlagComment200Response

Exemplo

Exemplo de un_flag_comment

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure 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, 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 = {
  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 comentário

Parâmetros

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

Resposta

Retorna: LockComment200Response

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

Desafixar comentário

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: PinComment200Response

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 comentário

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: FlagCommentPublic200Response

Exemplo

Exemplo de update_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 | 
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 no comentário

Parâmetros

Nome	Tipo	Localização	Obrigatório
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

Resposta

Retorna: VoteComment200Response

Exemplo

Exemplo de vote_comment

Copy

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

Adicionar configuração de domínio

Parâmetros

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

Resposta

Retorna: AddDomainConfig200Response

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 configuração de domínio

Parâmetros

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

Resposta

Retorna: DeleteDomainConfig200Response

Exemplo

Exemplo de delete_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 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 configuração de domínio

Parameters

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

Resposta

Retorna: GetDomainConfig200Response

Exemplo

Exemplo de get_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 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 | 
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 configurações de domínio

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: GetDomainConfigs200Response

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 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 | 
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 parcialmente configuração de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfig200Response

Exemplo

Exemplo de patch_domain_config

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, 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 configuração de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfig200Response

Exemplo

Exemplo de put_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_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 de e-mail

Parâmetros

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

Resposta

Retorna: CreateEmailTemplate200Response

Exemplo

Exemplo de create_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 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_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 de e-mail

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_email_template

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, 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_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

Excluir erro de renderização de modelo de e-mail

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

delete_email_template_render_error 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 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 | 
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 de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplate200Response

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 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_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

Obter definições de modelos de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplateDefinitions200Response

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 seguinte linha 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 | 
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 de renderização de modelo de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplateRenderErrors200Response

Exemplo

get_email_template_render_errors Example

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 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 | 
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 de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplates200Response

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, 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 = {
  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 de e-mail

Parâmetros

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

Resposta

Retorna: RenderEmailTemplate200Response

Exemplo

Exemplo de render_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 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 | 
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 de e-mail

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_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 abaixo 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 | 
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 log de eventos

req tenantId urlId userIdWS

Parâmetros

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

Resposta

Retorna: GetEventLog200Response

Exemplo

Exemplo do 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 | 
end_time = 789 # Integer | 
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

Obter log global de eventos

req tenantId urlId userIdWS

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
urlId	string	query	Sim
userIdWS	string	query	Sim
startTime	integer	query	Sim
endTime	integer	query	Sim

Resposta

Retorna: GetEventLog200Response

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 | 
end_time = 789 # Integer | 
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

Criar publicação do feed

Parâmetros

Nome	Tipo	Local	Obrigatório
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: CreateFeedPost200Response

Exemplo

Exemplo de create_feed_post

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 | 
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 publicação do feed pública

Parâmetros

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

Resposta

Retorna: CreateFeedPostPublic200Response

Exemplo

Exemplo de create_feed_post_public

Copy

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

Excluir publicação do feed pública

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	path	Sim
postId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: DeleteFeedPostPublic200Response

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 publicações do feed

req tenantId afterId

Parâmetros

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

Resposta

Retorna: GetFeedPosts200Response

Exemplo

Exemplo de get_feed_posts

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 | 
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 publicações públicas do feed

req tenantId afterId

Parâmetros

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

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 estatísticas das publicações do feed

Parâmetros

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

Resposta

Retorna: GetFeedPostsStats200Response

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 reações públicas dos usuários

Parâmetros

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

Response

Retorna: GetUserReactsPublic200Response

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 à publicação pública do feed

Parâmetros

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

Resposta

Retorna: ReactFeedPostPublic200Response

Exemplo

Exemplo de react_feed_post_public

Copy

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

Atualizar publicação do feed

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

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'
  # 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 | 
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 publicação pública do feed

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	path	Sim
postId	string	path	Sim
broadcastId	string	query	Não
sso	string	query	Não

Resposta

Retorna: CreateFeedPostPublic200Response

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 comentário público

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

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

Adicionar hashtag

Parâmetros

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

Resposta

Retorna: AddHashTag200Response

Exemplo

Exemplo de add_hash_tag

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 ex. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
opts = {
  tenant_id: 'tenant_id_example', # String | 
  create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
}
begin
  
  result = api_instance.add_hash_tag(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

Adicionar hashtags em massa

Parâmetros

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

Resposta

Retorna: AddHashTagsBulk200Response

Exemplo

Exemplo add_hash_tags_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 API key, e.g. 'Bearer' (padrão: nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
opts = {
  tenant_id: 'tenant_id_example', # String | 
  bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
}
begin
  
  result = api_instance.add_hash_tags_bulk(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

Excluir hashtag

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
tag	string	path	Yes
tenantId	string	query	No

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_hash_tag

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
tag = 'tag_example' # String | 
opts = {
  tenant_id: 'tenant_id_example', # String | 
  delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest | 
}
begin
  
  result = api_instance.delete_hash_tag(tag, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

Obter hashtags

Parâmetros

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

Resposta

Retorna: GetHashTags200Response

Exemplo

Exemplo de get_hash_tags

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure 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 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 parcialmente hashtag

Parâmetros

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

Resposta

Retorna: PatchHashTag200Response

Exemplo

Exemplo de patch_hash_tag

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 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
tag = 'tag_example' # String | 
opts = {
  tenant_id: 'tenant_id_example', # String | 
  update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
}
begin
  
  result = api_instance.patch_hash_tag(tag, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

Criar moderador

Parâmetros

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

Resposta

Retorna: CreateModerator200Response

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 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_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

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_moderator

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configure a autenticaçã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 | 
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	Local	Obrigatório	Descrição
tenantId	string	query	Sim
id	string	path	Sim

Resposta

Retorna: GetModerator200Response

Exemplo

Exemplo de get_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 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_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: GetModerators200Response

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, 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 = {
  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

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de send_invite

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

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_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 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 | 
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 de notificações

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_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 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.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

Obter contagem de notificações em cache

Parâmetros

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

Resposta

Retorna: GetCachedNotificationCount200Response

Exemplo

Exemplo de get_cached_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 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_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 notificações

Parâmetros

Nome	Tipo	Localização	Obrigatório
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: GetNotificationCount200Response

Exemplo

Exemplo de get_notification_count

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 = {
  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 notificações

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: GetNotifications200Response

Exemplo

Exemplo 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 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 | 
  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 notificação

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

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

Adicionar página

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 página

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 página por URL ID

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 páginas

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

Atualizar parcialmente página

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 de webhook pendente

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

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 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.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 de eventos de 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

Response

Retorna: GetPendingWebhookEventCount200Response

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 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 | 
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 de 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
skip	number	query	Não

Resposta

Retorna: GetPendingWebhookEvents200Response

Exemplo

Exemplo de get_pending_webhook_events

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 | 
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 configuração de pergunta

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateQuestionConfig200Response

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 configuração de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_question_config

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 | 
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 configuração de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionConfig200Response

Exemplo

Exemplo de get_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 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_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

Obter configurações de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionConfigs200Response

Exemplo

Exemplo de get_question_configs

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, 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 | 
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 configuração de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_question_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, 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_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 de pergunta

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateQuestionResult200Response

Exemplo

Exemplo de create_question_result

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 | 
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 de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_question_result

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.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

Obter resultado de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionResult200Response

Exemplo

Exemplo de get_question_result

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 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_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

Obter resultados de perguntas

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: GetQuestionResults200Response

Exemplo

Exemplo 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 de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_question_result

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

Agregação de 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
timeBucket	string	query	Não
startDate	string	query	Não
forceRecalculate	boolean	query	Não

Resposta

Retorna: AggregateQuestionResults200Response

Exemplo

Exemplo de aggregate_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 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 | 
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

Agregação em massa de resultados de perguntas

Parâmetros

Nome	Tipo	Location	Obrigatório	Descrição
tenantId	string	query	Sim
forceRecalculate	boolean	query	Não

Resposta

Retorna: BulkAggregateQuestionResults200Response

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 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 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 | 
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 comentários com resultados de perguntas

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
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: CombineCommentsWithQuestionResults200Response

Exemplo

Exemplo de combine_comments_with_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, 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 usuário 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 usuário 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 usuário SSO por e-mail

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 usuário 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 usuários SSO

Parâmetros

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

Resposta

Retorna: GetSSOUsers200Response

Exemplo

Exemplo get_sso_users

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização via 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 parcialmente usuário 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 usuário 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 diários do locatário

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Yes
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

Resposta

Retorna: GetTenantDailyUsages200Response

Exemplo

Exemplo de get_tenant_daily_usages

Copy

require 'time'
require 'fastcomments-client'
# configurar autorização
FastCommentsClient.configure do |config|
  # Configurar autorização por 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, 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 = {
  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 do locatário

Parâmetros

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

Resposta

Retorna: CreateTenantPackage200Response

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 a seguir para definir um prefixo para a API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_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 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 do locatário

Parâmetros

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

Resposta

Retorna: GetTenantPackage200Response

Exemplo

Exemplo de get_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, 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 do locatário

Parâmetros

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

Resposta

Retorna: GetTenantPackages200Response

Exemplo

Exemplo de get_tenant_packages

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 | 
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 do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de replace_tenant_package

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 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 | 
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 do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_tenant_package

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' (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_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 usuário do locatário

Parâmetros

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

Resposta

Retorna: CreateTenantUser200Response

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, 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_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 usuário do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_tenant_user

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 | 
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 usuário do locatário

Parâmetros

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

Resposta

Retorna: GetTenantUser200Response

Exemplo

Exemplo de get_tenant_user

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 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_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

Obter usuários do locatário

Parâmetros

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

Resposta

Retorna: GetTenantUsers200Response

Exemplo

Exemplo de get_tenant_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: 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 usuário do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

replace_tenant_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 | 
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

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

Resposta

Retorna: FlagCommentPublic200Response

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 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 = {
  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 usuário do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_tenant_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 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 | 
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 locatário

Parâmetros

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

Resposta

Retorna: CreateTenant200Response

Exemplo

Exemplo de create_tenant

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 | 
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 locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

delete_tenant Example

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 locatário

Parâmetros

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

Resposta

Retorna: GetTenant200Response

Exemplo

Exemplo de get_tenant

Copy

require 'time'
require 'fastcomments-client'
# configuração de 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, 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_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

Obter locatários

Parâmetros

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

Resposta

Retorna: GetTenants200Response

Exemplo

Exemplo de get_tenants

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 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 = {
  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 locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

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 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_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 do ticket

Parâmetros

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

Resposta

Retorna: ChangeTicketState200Response

Exemplo

Exemplo de change_ticket_state

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 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: CreateTicket200Response

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'
  # 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 | 
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

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

Resposta

Retorna: GetTicket200Response

Exemplo

Exemplo de 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 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 | 
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

Nome	Tipo	Localização	Obrigatório
tenantId	string	query	Yes
userId	string	query	No
state	number	query	No
skip	number	query	No
limit	number	query	No

Resposta

Retorna: GetTickets200Response

Exemplo

Exemplo de get_tickets

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 = {
  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

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 de distintivo por ID

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressById200Response

Exemplo

Exemplo de get_user_badge_progress_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 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_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 de distintivo por ID do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressById200Response

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 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 | 
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 de progresso de distintivos

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressList200Response

Exemplo

Exemplo de get_user_badge_progress_list

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 | 
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 distintivo do usuário

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateUserBadge200Response

Exemplo

Exemplo de create_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 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_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 distintivo do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserBadge200Response

Exemplo

Exemplo de delete_user_badge

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 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 distintivo do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadge200Response

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 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_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

Obter distintivos do usuário

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: GetUserBadges200Response

Exemplo

Exemplo de get_user_badges

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 seguinte linha 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 | 
  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 distintivo do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserBadge200Response

Exemplo

Exemplo de update_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 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_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 de notificações do usuário

Parâmetros

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

Resposta

Retorna: GetUserNotificationCount200Response

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 notificações do usuário

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	query	Sim
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
sso	string	query	Não

Resposta

Retorna: GetUserNotifications200Response

Exemplo

Exemplo de get_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page_size: 56, # Inteiro | 
  after_id: 'after_id_example', # String | 
  include_context: true, # Booleano | 
  after_created_at: 789, # Inteiro | 
  unread_only: true, # Booleano | 
  dm_only: true, # Booleano | 
  no_dm: true, # Booleano | 
  include_translations: true, # Booleano | 
  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

Redefinir contagem de notificações do usuário

Parâmetros

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

Resposta

Retorna: ResetUserNotifications200Response

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

Redefinir notificações do usuário

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: ResetUserNotifications200Response

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 de assinatura de notificações por comentário do usuário

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: UpdateUserNotificationStatus200Response

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 de assinatura de página das notificações do usuário

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

Parameters

Name	Type	Location	Required
tenantId	string	query	Yes
urlId	string	query	Yes
url	string	query	Yes
pageTitle	string	query	Yes
subscribedOrUnsubscribed	string	path	Yes
sso	string	query	No

Response

Retorna: UpdateUserNotificationStatus200Response

Example

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 da notificação do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserNotificationStatus200Response

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 de presença do usuário

Parâmetros

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

Resposta

Retorna: GetUserPresenceStatuses200Response

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 usuários

Parâmetros

Nome	Tipo	Localização	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: SearchUsers200Response

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 usuário

Parâmetros

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

Resposta

Retorna: GetUser200Response

Exemplo

Exemplo de get_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 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_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

Criar voto

Parâmetros

Nome	Tipo	Local	Obrigatório
tenantId	string	query	Sim
commentId	string	query	Sim
direction	string	query	Sim
userId	string	query	Não
anonUserId	string	query	Não

Resposta

Retorna: VoteComment200Response

Exemplo

Exemplo de create_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 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 | 
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	Local	Obrigatório
tenantId	string	query	Sim
id	string	path	Sim
editKey	string	query	Não

Resposta

Retorna: DeleteCommentVote200Response

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 abaixo 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 | 
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: GetVotes200Response

Exemplo

Exemplo de get_votes

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 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 | 
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 para o usuário

Parâmetros

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

Resposta

Retorna: GetVotesForUser200Response

Exemplo

Exemplo de get_votes_for_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 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)

Introdução

Documentação

Uso

Agregação

Logs de auditoria

Bloquear a partir do comentário

Verificar comentários bloqueados

Comentários

Configurações de domínio

Modelos de e-mail

Log de eventos

Publicações do feed

Denunciar comentário

Hashtags

Moderadores

Contagem de notificações

Notificações

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

Tickets

Enviar imagem

Progresso de distintivo do usuário

Distintivos do usuário

Notificações do usuário

Status de presença do usuário

Busca de usuários

Usuários

Votos

FastComments SDK Ruby

Repositório

Instalação

Conteúdo da Biblioteca

APIs Públicas vs APIs Seguras

Início rápido

Usando APIs Autenticadas (DefaultApi)

Usando APIs Públicas (PublicApi)

Problemas Comuns

Observações

IDs de Broadcast

SSO (Login Único)

Uso de SSO

SSO Simples

SSO Seguro

Agregação

Parâmetros

Resposta

Exemplo

Obter logs de auditoria

Parâmetros

Resposta

Exemplo

Bloquear a partir de comentário público

Parâmetros

Resposta

Exemplo

Desbloquear comentário público

Parâmetros

Resposta

Exemplo

Verificar comentários para bloqueio

Parâmetros

Resposta

Exemplo

Bloquear usuário a partir do comentário

Parâmetros

Resposta

Exemplo

Criar comentário público

Parâmetros

Resposta