FastComments Python SDK

Este é o SDK oficial em Python para o FastComments.

SDK oficial em Python para a API do FastComments

Repositório

Instalação

PyPI

pip install fastcomments

Conteúdo da Biblioteca

Esta biblioteca contém dois módulos: o cliente de API gerado e a biblioteca principal em Python, que contém utilitários escritos à mão para tornar o trabalho com a API mais fácil, incluindo suporte a SSO.

APIs Públicas vs APIs Protegidas

Para o cliente de API, existem duas classes, `DefaultApi` e `PublicApi`. A `DefaultApi` contém métodos que requerem sua API key, e a `PublicApi` contém chamadas de API que podem ser feitas diretamente 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 na Configuration antes de fazer requisições autenticadas. Se não definir, as requisições falharão com um erro 401.

from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData

# Crie e configure o cliente da API
config = Configuration()
config.host = "https://fastcomments.com/api"

# OBRIGATÓRIO: Defina sua chave de API (obtenha isso no seu painel do FastComments)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}

# Crie a instância da API com o cliente configurado
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)

# Agora você pode fazer chamadas de API autenticadas
try:
    # Exemplo: Adicionar um usuário SSO
    user_data = CreateAPISSOUserData(
        id="user-123",
        email="user@example.com",
        display_name="John Doe"
    )

    response = api.add_sso_user(
        tenant_id="YOUR_TENANT_ID",
        create_apisso_user_data=user_data
    )
    print(f"User created: {response}")

except Exception as e:
    print(f"Error: {e}")
    # Erros comuns:
    # - 401: chave da API ausente ou inválida
    # - 400: Falha na validação da requisição

Usando APIs Públicas (PublicApi)

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

from client import ApiClient, Configuration, PublicApi

config = Configuration()
config.host = "https://fastcomments.com/api"

api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)

try:
    response = public_api.get_comments_public(
        tenant_id="YOUR_TENANT_ID",
        url_id="page-url-id"
    )
    print(response)
except Exception as e:
    print(f"Error: {e}")

Usando SSO (Single Sign-On)

O SDK inclui utilitários para gerar tokens SSO seguros:

from sso import FastCommentsSSO, SecureSSOUserData

# Crie os dados do usuário
user_data = SecureSSOUserData(
    user_id="user-123",
    email="user@example.com",
    username="johndoe",
    avatar="https://example.com/avatar.jpg"
)

# Crie a instância SSO com seu segredo da API
sso = FastCommentsSSO.new_secure(
    api_secret="YOUR_API_SECRET",
    user_data=user_data
)

# Gere o token SSO
sso_token = sso.create_token()

# Use este token no seu frontend ou passe para chamadas de API
print(f"SSO Token: {sso_token}")

Para SSO simples (menos seguro, para testes):

from sso import FastCommentsSSO, SimpleSSOUserData

user_data = SimpleSSOUserData(
    user_id="user-123",
    email="user@example.com"
)

sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()

Problemas Comuns

401 "missing-api-key" error: Certifique-se de definir config.api_key = {"ApiKeyAuth": "YOUR_KEY"} antes de criar a instância DefaultApi.
Classe de API incorreta: Use DefaultApi para requisições autenticadas no lado do servidor, PublicApi para requisições do lado do cliente/públicas.
Erros de importação: Certifique-se de importar do módulo correto:
- Cliente da API: from client import ...
- Utilitários SSO: from sso import ...

Notas

IDs de Broadcast

Você verá que deve passar um broadcast_id em algumas chamadas de API. Quando você receber eventos, receberá esse ID de volta, assim você saberá ignorar o evento se planejar aplicar alterações de forma otimista no cliente (o que provavelmente você vai querer fazer, já que 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.

Requisitos

Python >= 3.8
urllib3 >= 1.25.3
python-dateutil >= 2.8.2
pydantic >= 2.0.0
typing-extensions >= 4.0.0

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

Name	Type	Location	Required
tenantId	string	query	Yes
parentTenantId	string	query	No
includeStats	boolean	query	No

Resposta

Retorna: AggregationResponse

Exemplo

Exemplo de aggregate

Copy

import client
from client.models.aggregation_request import AggregationRequest
from client.models.aggregation_response import AggregationResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    aggregation_request = client.AggregationRequest() # AggregationRequest | 
    parent_tenant_id = 'parent_tenant_id_example' # str |  (opcional)
    include_stats = True # bool |  (opcional)
    try:
        api_response = api_instance.aggregate(tenant_id, aggregation_request, parent_tenant_id=parent_tenant_id, include_stats=include_stats)
        print("The response of DefaultApi->aggregate:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->aggregate: %s\n" % e)

Obter registros de auditoria

Parâmetros

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

Resposta

Retorna: GetAuditLogs200Response

Exemplo

Exemplo de get_audit_logs

Copy

import client
from client.models.get_audit_logs200_response import GetAuditLogs200Response
from client.models.sortdir import SORTDIR
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe de API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    limit = 3.4 # float |  (opcional)
    skip = 3.4 # float |  (opcional)
    order = client.SORTDIR() # SORTDIR |  (opcional)
    after = 3.4 # float |  (opcional)
    before = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_audit_logs(tenant_id, limit=limit, skip=skip, order=order, after=after, before=before)
        print("The response of DefaultApi->get_audit_logs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_audit_logs: %s\n" % e)

Bloquear a partir de comentário público

Parâmetros

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

import client
from client.models.block_from_comment_public200_response import BlockFromCommentPublic200Response
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->block_from_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->block_from_comment_public: %s\n" % e)

Desbloquear comentário público

Parâmetros

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

Resposta

Retorna: UnBlockCommentPublic200Response

Exemplo

Exemplo un_block_comment_public

Copy

import client
from client.models.public_block_from_comment_params import PublicBlockFromCommentParams
from client.models.un_block_comment_public200_response import UnBlockCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, sso=sso)
        print("The response of PublicApi->un_block_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_block_comment_public: %s\n" % e)

Verificar comentários bloqueados

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

import client
from client.models.checked_comments_for_blocked200_response import CheckedCommentsForBlocked200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_ids = 'comment_ids_example' # str | Uma lista separada por vírgulas de IDs de comentários.
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, sso=sso)
        print("The response of PublicApi->checked_comments_for_blocked:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->checked_comments_for_blocked: %s\n" % e)

Bloquear usuário a partir do comentário

Parâmetros

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

import client
from client.models.block_from_comment_params import BlockFromCommentParams
from client.models.block_from_comment_public200_response import BlockFromCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (e.g. Bearer) para API key, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    block_from_comment_params = client.BlockFromCommentParams() # BlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (opcional)
    anon_user_id = 'anon_user_id_example' # str |  (opcional)
    try:
        api_response = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->block_user_from_comment: %s\n" % e)

Criar comentário público

Parâmetros

Name	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

create_comment_public Exemplo

Copy

import client
from client.models.comment_data import CommentData
from client.models.create_comment_public200_response import CreateCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_data = client.CommentData() # CommentData | 
    session_id = 'session_id_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, session_id=session_id, sso=sso)
        print("The response of PublicApi->create_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_comment_public: %s\n" % e)

Excluir comentário

Parâmetros

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

Resposta

Retorna: DeleteComment200Response

Exemplo

Exemplo de delete_comment

Copy

import client
from client.models.delete_comment200_response import DeleteComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    context_user_id = 'context_user_id_example' # str |  (opcional)
    is_live = True # bool |  (opcional)
    try:
        api_response = api_instance.delete_comment(tenant_id, id, context_user_id=context_user_id, is_live=is_live)
        print("The response of DefaultApi->delete_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_comment: %s\n" % e)

Excluir comentário público

Parâmetros

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

Exemplo de delete_comment_public

Copy

import client
from client.models.delete_comment_public200_response import DeleteCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, edit_key=edit_key, sso=sso)
        print("The response of PublicApi->delete_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_public: %s\n" % e)

Excluir voto de comentário

Parâmetros

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

Resposta

Retorna: DeleteCommentVote200Response

Exemplo

Exemplo de delete_comment_vote

Copy

import client
from client.models.delete_comment_vote200_response import DeleteCommentVote200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    vote_id = 'vote_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, edit_key=edit_key, sso=sso)
        print("The response of PublicApi->delete_comment_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_comment_vote: %s\n" % e)

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

Copy

import client
from client.models.flag_comment200_response import FlagComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    anon_user_id = 'anon_user_id_example' # str |  (opcional)
    try:
        api_response = api_instance.flag_comment(tenant_id, id, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->flag_comment: %s\n" % e)

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

import client
from client.models.get_comment200_response import GetComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão usa https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_comment(tenant_id, id)
        print("The response of DefaultApi->get_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comment: %s\n" % e)

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

import client
from client.models.get_comment_text200_response import GetCommentText200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    edit_key = 'edit_key_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.get_comment_text(tenant_id, comment_id, edit_key=edit_key, sso=sso)
        print("The response of PublicApi->get_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_text: %s\n" % e)

Obter nomes dos 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

import client
from client.models.get_comment_vote_user_names200_response import GetCommentVoteUserNames200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    dir = 56 # int | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, sso=sso)
        print("The response of PublicApi->get_comment_vote_user_names:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comment_vote_user_names: %s\n" % e)

Obter comentários

Parâmetros

Nome	Tipo	Local	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

Response

Retorna: GetComments200Response

Exemplo

Exemplo de get_comments

Copy

import client
from client.models.get_comments200_response import GetComments200Response
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 56 # int |  (opcional)
    limit = 56 # int |  (opcional)
    skip = 56 # int |  (opcional)
    as_tree = True # bool |  (opcional)
    skip_children = 56 # int |  (opcional)
    limit_children = 56 # int |  (opcional)
    max_tree_depth = 56 # int |  (opcional)
    url_id = 'url_id_example' # str |  (opcional)
    user_id = 'user_id_example' # str |  (opcional)
    anon_user_id = 'anon_user_id_example' # str |  (opcional)
    context_user_id = 'context_user_id_example' # str |  (opcional)
    hash_tag = 'hash_tag_example' # str |  (opcional)
    parent_id = 'parent_id_example' # str |  (opcional)
    direction = client.SortDirections() # SortDirections |  (opcional)
    try:
        api_response = api_instance.get_comments(tenant_id, page=page, limit=limit, skip=skip, as_tree=as_tree, skip_children=skip_children, limit_children=limit_children, max_tree_depth=max_tree_depth, url_id=url_id, user_id=user_id, anon_user_id=anon_user_id, context_user_id=context_user_id, hash_tag=hash_tag, parent_id=parent_id, direction=direction)
        print("The response of DefaultApi->get_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_comments: %s\n" % e)

Obter comentários públicos

req tenantId urlId

Parâmetros

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

import client
from client.models.get_comments_public200_response import GetCommentsPublic200Response
from client.models.sort_directions import SortDirections
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    page = 56 # int |  (opcional)
    direction = client.SortDirections() # SortDirections |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    skip = 56 # int |  (opcional)
    skip_children = 56 # int |  (opcional)
    limit = 56 # int |  (opcional)
    limit_children = 56 # int |  (opcional)
    count_children = True # bool |  (opcional)
    fetch_page_for_comment_id = 'fetch_page_for_comment_id_example' # str |  (opcional)
    include_config = True # bool |  (opcional)
    count_all = True # bool |  (opcional)
    includei10n = True # bool |  (opcional)
    locale = 'locale_example' # str |  (opcional)
    modules = 'modules_example' # str |  (opcional)
    is_crawler = True # bool |  (opcional)
    include_notification_count = True # bool |  (opcional)
    as_tree = True # bool |  (opcional)
    max_tree_depth = 56 # int |  (opcional)
    use_full_translation_ids = True # bool |  (opcional)
    parent_id = 'parent_id_example' # str |  (opcional)
    search_text = 'search_text_example' # str |  (opcional)
    hash_tags = ['hash_tags_example'] # List[str] |  (opcional)
    user_id = 'user_id_example' # str |  (opcional)
    custom_config_str = 'custom_config_str_example' # str |  (opcional)
    after_comment_id = 'after_comment_id_example' # str |  (opcional)
    before_comment_id = 'before_comment_id_example' # str |  (opcional)
    try:
        api_response = api_instance.get_comments_public(tenant_id, url_id, page=page, direction=direction, sso=sso, skip=skip, skip_children=skip_children, limit=limit, limit_children=limit_children, count_children=count_children, fetch_page_for_comment_id=fetch_page_for_comment_id, include_config=include_config, count_all=count_all, includei10n=includei10n, locale=locale, modules=modules, is_crawler=is_crawler, include_notification_count=include_notification_count, as_tree=as_tree, max_tree_depth=max_tree_depth, use_full_translation_ids=use_full_translation_ids, parent_id=parent_id, search_text=search_text, hash_tags=hash_tags, user_id=user_id, custom_config_str=custom_config_str, after_comment_id=after_comment_id, before_comment_id=before_comment_id)
        print("The response of PublicApi->get_comments_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_comments_public: %s\n" % e)

Bloquear comentário

Parâmetros

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

Resposta

Retorna: LockComment200Response

Exemplo

Exemplo de lock_comment

Copy

import client
from client.models.lock_comment200_response import LockComment200Response
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->lock_comment: %s\n" % e)

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

import client
from client.models.pin_comment200_response import PinComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->pin_comment: %s\n" % e)

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

Resposta

Retorna: SaveComment200Response

Exemplo

Exemplo de save_comment

Copy

import client
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comment200_response import SaveComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave da API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_comment_params = client.CreateCommentParams() # CreateCommentParams | 
    is_live = True # bool |  (opcional)
    do_spam_check = True # bool |  (opcional)
    send_emails = True # bool |  (opcional)
    populate_notifications = True # bool |  (opcional)
    try:
        api_response = api_instance.save_comment(tenant_id, create_comment_params, is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications)
        print("The response of DefaultApi->save_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->save_comment: %s\n" % e)

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

Exemplo

Exemplo de save_comments_bulk

Copy

import client
from client.models.create_comment_params import CreateCommentParams
from client.models.save_comment200_response import SaveComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atender ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para definir o prefixo (ex.: Bearer) para a chave da API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_comment_params = [client.CreateCommentParams()] # List[CreateCommentParams] | 
    is_live = True # bool |  (optional)
    do_spam_check = True # bool |  (optional)
    send_emails = True # bool |  (optional)
    populate_notifications = True # bool |  (optional)
    try:
        api_response = api_instance.save_comments_bulk(tenant_id, create_comment_params, is_live=is_live, do_spam_check=do_spam_check, send_emails=send_emails, populate_notifications=populate_notifications)
        print("The response of DefaultApi->save_comments_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->save_comments_bulk: %s\n" % e)

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

import client
from client.models.comment_text_update_request import CommentTextUpdateRequest
from client.models.set_comment_text200_response import SetCommentText200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    comment_text_update_request = client.CommentTextUpdateRequest() # CommentTextUpdateRequest | 
    edit_key = 'edit_key_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, edit_key=edit_key, sso=sso)
        print("The response of PublicApi->set_comment_text:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->set_comment_text: %s\n" % e)

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

import client
from client.models.un_block_comment_public200_response import UnBlockCommentPublic200Response
from client.models.un_block_from_comment_params import UnBlockFromCommentParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    un_block_from_comment_params = client.UnBlockFromCommentParams() # UnBlockFromCommentParams | 
    user_id = 'user_id_example' # str |  (opcional)
    anon_user_id = 'anon_user_id_example' # str |  (opcional)
    try:
        api_response = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->un_block_user_from_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_block_user_from_comment: %s\n" % e)

Remover sinalização 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

import client
from client.models.flag_comment200_response import FlagComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.un_flag_comment(tenant_id, id, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->un_flag_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->un_flag_comment: %s\n" % e)

Desbloquear 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: LockComment200Response

Exemplo

Exemplo de un_lock_comment

Copy

import client
from client.models.lock_comment200_response import LockComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe de API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_lock_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_lock_comment: %s\n" % e)

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

Copy

import client
from client.models.pin_comment200_response import PinComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, sso=sso)
        print("The response of PublicApi->un_pin_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->un_pin_comment: %s\n" % e)

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

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.pick_api_comment_updatable_comment_fields import PickAPICommentUpdatableCommentFields
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    body = client.PickAPICommentUpdatableCommentFields() # PickAPICommentUpdatableCommentFields | 
    context_user_id = 'context_user_id_example' # str |  (opcional)
    do_spam_check = True # bool |  (opcional)
    is_live = True # bool |  (opcional)
    try:
        api_response = api_instance.update_comment(tenant_id, id, body, context_user_id=context_user_id, do_spam_check=do_spam_check, is_live=is_live)
        print("The response of DefaultApi->update_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_comment: %s\n" % e)

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

import client
from client.models.vote_body_params import VoteBodyParams
from client.models.vote_comment200_response import VoteComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe de API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    url_id = 'url_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str | 
    vote_body_params = client.VoteBodyParams() # VoteBodyParams | 
    session_id = 'session_id_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, session_id=session_id, sso=sso)
        print("The response of PublicApi->vote_comment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->vote_comment: %s\n" % e)

Adicionar configuração de domínio

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: AddDomainConfig200Response

Exemplo

Exemplo de add_domain_config

Copy

import client
from client.models.add_domain_config200_response import AddDomainConfig200Response
from client.models.add_domain_config_params import AddDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e tem como padrão https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    add_domain_config_params = client.AddDomainConfigParams() # AddDomainConfigParams | 
    try:
        api_response = api_instance.add_domain_config(tenant_id, add_domain_config_params)
        print("The response of DefaultApi->add_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_domain_config: %s\n" % e)

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

import client
from client.models.delete_domain_config200_response import DeleteDomainConfig200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão usa https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.delete_domain_config(tenant_id, domain)
        print("The response of DefaultApi->delete_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_domain_config: %s\n" % e)

Obter configuração de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfig200Response

Exemplo

Exemplo de get_domain_config

Copy

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain = 'domain_example' # str | 
    try:
        api_response = api_instance.get_domain_config(tenant_id, domain)
        print("The response of DefaultApi->get_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_domain_config: %s\n" % e)

Obter configurações de domínio

Parâmetros

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

Resposta

Retorna: GetDomainConfigs200Response

Exemplo

Exemplo de get_domain_configs

Copy

import client
from client.models.get_domain_configs200_response import GetDomainConfigs200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a API key, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_domain_configs(tenant_id)
        print("The response of DefaultApi->get_domain_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_domain_configs: %s\n" % e)

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

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.models.patch_domain_config_params import PatchDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para API key, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_to_update = 'domain_to_update_example' # str | 
    patch_domain_config_params = client.PatchDomainConfigParams() # PatchDomainConfigParams | 
    try:
        api_response = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
        print("The response of DefaultApi->patch_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_domain_config: %s\n" % e)

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

import client
from client.models.get_domain_config200_response import GetDomainConfig200Response
from client.models.update_domain_config_params import UpdateDomainConfigParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    domain_to_update = 'domain_to_update_example' # str | 
    update_domain_config_params = client.UpdateDomainConfigParams() # UpdateDomainConfigParams | 
    try:
        api_response = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
        print("The response of DefaultApi->put_domain_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->put_domain_config: %s\n" % e)

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

import client
from client.models.create_email_template200_response import CreateEmailTemplate200Response
from client.models.create_email_template_body import CreateEmailTemplateBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_email_template_body = client.CreateEmailTemplateBody() # CreateEmailTemplateBody | 
    try:
        api_response = api_instance.create_email_template(tenant_id, create_email_template_body)
        print("The response of DefaultApi->create_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_email_template: %s\n" % e)

Excluir modelo de e-mail

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_email_template

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_email_template(tenant_id, id)
        print("The response of DefaultApi->delete_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template: %s\n" % e)

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

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_email_template_render_error

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    error_id = 'error_id_example' # str | 
    try:
        api_response = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
        print("The response of DefaultApi->delete_email_template_render_error:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_email_template_render_error: %s\n" % e)

Obter modelo de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplate200Response

Exemplo

Exemplo de get_email_template

Copy

import client
from client.models.get_email_template200_response import GetEmailTemplate200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_email_template(tenant_id, id)
        print("The response of DefaultApi->get_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template: %s\n" % e)

Obter definições de modelos de e-mail

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: GetEmailTemplateDefinitions200Response

Exemplo

Exemplo de get_email_template_definitions

Copy

import client
from client.models.get_email_template_definitions200_response import GetEmailTemplateDefinitions200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_email_template_definitions(tenant_id)
        print("The response of DefaultApi->get_email_template_definitions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template_definitions: %s\n" % e)

Obter erros de renderização de modelos 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

Exemplo de get_email_template_render_errors

Copy

import client
from client.models.get_email_template_render_errors200_response import GetEmailTemplateRenderErrors200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_email_template_render_errors(tenant_id, id, skip=skip)
        print("The response of DefaultApi->get_email_template_render_errors:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_template_render_errors: %s\n" % e)

Obter modelos de e-mail

Parâmetros

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

Resposta

Retorna: GetEmailTemplates200Response

Exemplo

Exemplo get_email_templates

Copy

import client
from client.models.get_email_templates200_response import GetEmailTemplates200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_email_templates(tenant_id, skip=skip)
        print("The response of DefaultApi->get_email_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_email_templates: %s\n" % e)

Renderizar modelo de e-mail

Parâmetros

Name	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

import client
from client.models.render_email_template200_response import RenderEmailTemplate200Response
from client.models.render_email_template_body import RenderEmailTemplateBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    render_email_template_body = client.RenderEmailTemplateBody() # RenderEmailTemplateBody | 
    locale = 'locale_example' # str |  (opcional)
    try:
        api_response = api_instance.render_email_template(tenant_id, render_email_template_body, locale=locale)
        print("The response of DefaultApi->render_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->render_email_template: %s\n" % e)

Atualizar modelo de e-mail

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_email_template

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_email_template_body import UpdateEmailTemplateBody
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_email_template_body = client.UpdateEmailTemplateBody() # UpdateEmailTemplateBody | 
    try:
        api_response = api_instance.update_email_template(tenant_id, id, update_email_template_body)
        print("The response of DefaultApi->update_email_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_email_template: %s\n" % e)

Obter registro 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 de get_event_log

Copy

import client
from client.models.get_event_log200_response import GetEventLog200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para a lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    try:
        api_response = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
        print("The response of PublicApi->get_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_event_log: %s\n" % e)

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

import client
from client.models.get_event_log200_response import GetEventLog200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para a lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id_ws = 'user_id_ws_example' # str | 
    start_time = 56 # int | 
    end_time = 56 # int | 
    try:
        api_response = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
        print("The response of PublicApi->get_global_event_log:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_global_event_log: %s\n" % e)

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

import client
from client.models.create_feed_post200_response import CreateFeedPost200Response
from client.models.create_feed_post_params import CreateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (opcional)
    is_live = True # bool |  (opcional)
    do_spam_check = True # bool |  (opcional)
    skip_dup_check = True # bool |  (opcional)
    try:
        api_response = api_instance.create_feed_post(tenant_id, create_feed_post_params, broadcast_id=broadcast_id, is_live=is_live, do_spam_check=do_spam_check, skip_dup_check=skip_dup_check)
        print("The response of DefaultApi->create_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_feed_post: %s\n" % e)

Criar postagem do feed pública

Parâmetros

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

import client
from client.models.create_feed_post_params import CreateFeedPostParams
from client.models.create_feed_post_public200_response import CreateFeedPostPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_feed_post_params = client.CreateFeedPostParams() # CreateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, broadcast_id=broadcast_id, sso=sso)
        print("The response of PublicApi->create_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->create_feed_post_public: %s\n" % e)

Excluir postagem do feed pública

Parâmetros

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

import client
from client.models.delete_feed_post_public200_response import DeleteFeedPostPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    broadcast_id = 'broadcast_id_example' # str |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.delete_feed_post_public(tenant_id, post_id, broadcast_id=broadcast_id, sso=sso)
        print("The response of PublicApi->delete_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->delete_feed_post_public: %s\n" % e)

Obter postagens do feed

req tenantId afterId

Parâmetros

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

import client
from client.models.get_feed_posts200_response import GetFeedPosts200Response
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (optional)
    limit = 56 # int |  (optional)
    tags = ['tags_example'] # List[str] |  (optional)
    try:
        api_response = api_instance.get_feed_posts(tenant_id, after_id=after_id, limit=limit, tags=tags)
        print("The response of DefaultApi->get_feed_posts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_feed_posts: %s\n" % e)

Obter postagens do feed públicas

req tenantId afterId

Parâmetros

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

Resposta

Retorna: GetFeedPostsPublic200Response

Exemplo

Exemplo de get_feed_posts_public

Copy

import client
from client.models.get_feed_posts_public200_response import GetFeedPostsPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (opcional)
    limit = 56 # int |  (opcional)
    tags = ['tags_example'] # List[str] |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    is_crawler = True # bool |  (opcional)
    include_user_info = True # bool |  (opcional)
    try:
        api_response = api_instance.get_feed_posts_public(tenant_id, after_id=after_id, limit=limit, tags=tags, sso=sso, is_crawler=is_crawler, include_user_info=include_user_info)
        print("The response of PublicApi->get_feed_posts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_public: %s\n" % e)

Obter estatísticas de postagens do feed

Parâmetros

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

Resposta

Retorna: GetFeedPostsStats200Response

Exemplo

get_feed_posts_stats Exemplo

Copy

import client
from client.models.get_feed_posts_stats200_response import GetFeedPostsStats200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] | 
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.get_feed_posts_stats(tenant_id, post_ids, sso=sso)
        print("The response of PublicApi->get_feed_posts_stats:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_feed_posts_stats: %s\n" % e)

Obter reações de usuário (público)

Parâmetros

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

Resposta

Retorna: GetUserReactsPublic200Response

Exemplo

Exemplo de get_user_reacts_public

Copy

import client
from client.models.get_user_reacts_public200_response import GetUserReactsPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_ids = ['post_ids_example'] # List[str] |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.get_user_reacts_public(tenant_id, post_ids=post_ids, sso=sso)
        print("The response of PublicApi->get_user_reacts_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_reacts_public: %s\n" % e)

Reagir à postagem do feed pública

Parâmetros

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

import client
from client.models.react_body_params import ReactBodyParams
from client.models.react_feed_post_public200_response import ReactFeedPostPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente de API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    react_body_params = client.ReactBodyParams() # ReactBodyParams | 
    is_undo = True # bool |  (opcional)
    broadcast_id = 'broadcast_id_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, is_undo=is_undo, broadcast_id=broadcast_id, sso=sso)
        print("The response of PublicApi->react_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->react_feed_post_public: %s\n" % e)

Atualizar postagem do feed

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_feed_post

Copy

import client
from client.models.feed_post import FeedPost
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    feed_post = client.FeedPost() # FeedPost | 
    try:
        api_response = api_instance.update_feed_post(tenant_id, id, feed_post)
        print("The response of DefaultApi->update_feed_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_feed_post: %s\n" % e)

Atualizar postagem do feed pública

Parâmetros

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

import client
from client.models.create_feed_post_public200_response import CreateFeedPostPublic200Response
from client.models.update_feed_post_params import UpdateFeedPostParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    post_id = 'post_id_example' # str | 
    update_feed_post_params = client.UpdateFeedPostParams() # UpdateFeedPostParams | 
    broadcast_id = 'broadcast_id_example' # str |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, broadcast_id=broadcast_id, sso=sso)
        print("The response of PublicApi->update_feed_post_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_feed_post_public: %s\n" % e)

Sinalizar comentário público

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo flag_comment_public

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    is_flagged = True # bool | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, sso=sso)
        print("The response of PublicApi->flag_comment_public:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->flag_comment_public: %s\n" % e)

Adicionar hashtag

Parâmetros

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

Resposta

Retorna: AddHashTag200Response

Exemplo

Exemplo add_hash_tag

Copy

import client
from client.models.add_hash_tag200_response import AddHashTag200Response
from client.models.create_hash_tag_body import CreateHashTagBody
from client.rest import ApiException
from pprint import pprint
# A definição do host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str |  (opcional)
    create_hash_tag_body = client.CreateHashTagBody() # CreateHashTagBody |  (opcional)
    try:
        api_response = api_instance.add_hash_tag(tenant_id=tenant_id, create_hash_tag_body=create_hash_tag_body)
        print("The response of DefaultApi->add_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_hash_tag: %s\n" % e)

Adicionar hashtags em massa

Parâmetros

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

Resposta

Retorna: AddHashTagsBulk200Response

Exemplo

Exemplo add_hash_tags_bulk

Copy

import client
from client.models.add_hash_tags_bulk200_response import AddHashTagsBulk200Response
from client.models.bulk_create_hash_tags_body import BulkCreateHashTagsBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e tem como padrão https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str |  (opcional)
    bulk_create_hash_tags_body = client.BulkCreateHashTagsBody() # BulkCreateHashTagsBody |  (opcional)
    try:
        api_response = api_instance.add_hash_tags_bulk(tenant_id=tenant_id, bulk_create_hash_tags_body=bulk_create_hash_tags_body)
        print("The response of DefaultApi->add_hash_tags_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_hash_tags_bulk: %s\n" % e)

Excluir hashtag

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_hash_tag

Copy

import client
from client.models.delete_hash_tag_request import DeleteHashTagRequest
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tag = 'tag_example' # str | 
    tenant_id = 'tenant_id_example' # str |  (opcional)
    delete_hash_tag_request = client.DeleteHashTagRequest() # DeleteHashTagRequest |  (opcional)
    try:
        api_response = api_instance.delete_hash_tag(tag, tenant_id=tenant_id, delete_hash_tag_request=delete_hash_tag_request)
        print("The response of DefaultApi->delete_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_hash_tag: %s\n" % e)

Obter hashtags

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Yes
page	number	query	No

Resposta

Retorna: GetHashTags200Response

Exemplo

Exemplo de get_hash_tags

Copy

import client
from client.models.get_hash_tags200_response import GetHashTags200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação estão fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_hash_tags(tenant_id, page=page)
        print("The response of DefaultApi->get_hash_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_hash_tags: %s\n" % e)

Atualizar parcialmente hashtag

Parâmetros

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

Resposta

Retorna: PatchHashTag200Response

Exemplo

Exemplo de patch_hash_tag

Copy

import client
from client.models.patch_hash_tag200_response import PatchHashTag200Response
from client.models.update_hash_tag_body import UpdateHashTagBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tag = 'tag_example' # str | 
    tenant_id = 'tenant_id_example' # str |  (opcional)
    update_hash_tag_body = client.UpdateHashTagBody() # UpdateHashTagBody |  (opcional)
    try:
        api_response = api_instance.patch_hash_tag(tag, tenant_id=tenant_id, update_hash_tag_body=update_hash_tag_body)
        print("The response of DefaultApi->patch_hash_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_hash_tag: %s\n" % e)

Criar moderador

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateModerator200Response

Exemplo

Exemplo de create_moderator

Copy

import client
from client.models.create_moderator200_response import CreateModerator200Response
from client.models.create_moderator_body import CreateModeratorBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_moderator_body = client.CreateModeratorBody() # CreateModeratorBody | 
    try:
        api_response = api_instance.create_moderator(tenant_id, create_moderator_body)
        print("The response of DefaultApi->create_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_moderator: %s\n" % e)

Excluir moderador

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_moderator

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    send_email = 'send_email_example' # str |  (opcional)
    try:
        api_response = api_instance.delete_moderator(tenant_id, id, send_email=send_email)
        print("The response of DefaultApi->delete_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_moderator: %s\n" % e)

Obter moderador

Parâmetros

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

Resposta

Retorna: GetModerator200Response

Exemplo

Exemplo de get_moderator

Copy

import client
from client.models.get_moderator200_response import GetModerator200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_moderator(tenant_id, id)
        print("The response of DefaultApi->get_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderator: %s\n" % e)

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

import client
from client.models.get_moderators200_response import GetModerators200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_moderators(tenant_id, skip=skip)
        print("The response of DefaultApi->get_moderators:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_moderators: %s\n" % e)

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

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça o seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    from_name = 'from_name_example' # str | 
    try:
        api_response = api_instance.send_invite(tenant_id, id, from_name)
        print("The response of DefaultApi->send_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_invite: %s\n" % e)

Atualizar moderador

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_moderator

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_moderator_body import UpdateModeratorBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_moderator_body = client.UpdateModeratorBody() # UpdateModeratorBody | 
    try:
        api_response = api_instance.update_moderator(tenant_id, id, update_moderator_body)
        print("The response of DefaultApi->update_moderator:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_moderator: %s\n" % e)

Excluir contagem de notificações

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_notification_count

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para a lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_notification_count(tenant_id, id)
        print("The response of DefaultApi->delete_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_notification_count: %s\n" % e)

Obter contagem de notificações em cache

Parâmetros

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

Resposta

Retorna: GetCachedNotificationCount200Response

Exemplo

Exemplo de get_cached_notification_count

Copy

import client
from client.models.get_cached_notification_count200_response import GetCachedNotificationCount200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_cached_notification_count(tenant_id, id)
        print("The response of DefaultApi->get_cached_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_cached_notification_count: %s\n" % e)

Obter contagem de notificações

Parâmetros

Nome	Tipo	Local	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

import client
from client.models.get_notification_count200_response import GetNotificationCount200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    url_id = 'url_id_example' # str |  (opcional)
    from_comment_id = 'from_comment_id_example' # str |  (opcional)
    viewed = True # bool |  (opcional)
    type = 'type_example' # str |  (opcional)
    try:
        api_response = api_instance.get_notification_count(tenant_id, user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type)
        print("The response of DefaultApi->get_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notification_count: %s\n" % e)

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

Resposta

Retorna: GetNotifications200Response

Exemplo

Exemplo de get_notifications

Copy

import client
from client.models.get_notifications200_response import GetNotifications200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    url_id = 'url_id_example' # str |  (opcional)
    from_comment_id = 'from_comment_id_example' # str |  (opcional)
    viewed = True # bool |  (opcional)
    type = 'type_example' # str |  (opcional)
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_notifications(tenant_id, user_id=user_id, url_id=url_id, from_comment_id=from_comment_id, viewed=viewed, type=type, skip=skip)
        print("The response of DefaultApi->get_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_notifications: %s\n" % e)

Atualizar notificação

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_notification

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_notification_body import UpdateNotificationBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_notification_body = client.UpdateNotificationBody() # UpdateNotificationBody | 
    user_id = 'user_id_example' # str |  (optional)
    try:
        api_response = api_instance.update_notification(tenant_id, id, update_notification_body, user_id=user_id)
        print("The response of DefaultApi->update_notification:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_notification: %s\n" % e)

Adicionar página

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: AddPageAPIResponse

Exemplo

Exemplo de add_page

Copy

import client
from client.models.add_page_api_response import AddPageAPIResponse
from client.models.create_api_page_data import CreateAPIPageData
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
# Descomente abaixo para configurar o prefixo (por ex. Bearer) para a chave de API, se necessário
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_api_page_data = client.CreateAPIPageData() # CreateAPIPageData | 
    try:
        api_response = api_instance.add_page(tenant_id, create_api_page_data)
        print("The response of DefaultApi->add_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_page: %s\n" % e)

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

import client
from client.models.delete_page_api_response import DeletePageAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_page(tenant_id, id)
        print("The response of DefaultApi->delete_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_page: %s\n" % e)

Obter página por URL ID

Parâmetros

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

Resposta

Retorna: GetPageByURLIdAPIResponse

Exemplo

Exemplo de get_page_by_urlid

Copy

import client
from client.models.get_page_by_urlid_api_response import GetPageByURLIdAPIResponse
from client.rest import ApiException
from pprint import pprint
# A definição do host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_page_by_urlid(tenant_id, url_id)
        print("The response of DefaultApi->get_page_by_urlid:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_page_by_urlid: %s\n" % e)

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

import client
from client.models.get_pages_api_response import GetPagesAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (e.g. Bearer) para API key, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente de API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    try:
        api_response = api_instance.get_pages(tenant_id)
        print("The response of DefaultApi->get_pages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pages: %s\n" % e)

Atualizar parcialmente a página

Parâmetros

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

Resposta

Retorna: PatchPageAPIResponse

Exemplo

Exemplo de patch_page

Copy

import client
from client.models.patch_page_api_response import PatchPageAPIResponse
from client.models.update_api_page_data import UpdateAPIPageData
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e padrão para https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaz seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_api_page_data = client.UpdateAPIPageData() # UpdateAPIPageData | 
    try:
        api_response = api_instance.patch_page(tenant_id, id, update_api_page_data)
        print("The response of DefaultApi->patch_page:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_page: %s\n" % e)

Excluir evento de webhook pendente

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

delete_pending_webhook_event Example

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_pending_webhook_event(tenant_id, id)
        print("The response of DefaultApi->delete_pending_webhook_event:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_pending_webhook_event: %s\n" % e)

Obter contagem de eventos de webhook pendentes

Parâmetros

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

Resposta

Retorna: GetPendingWebhookEventCount200Response

Exemplo

Exemplo de get_pending_webhook_event_count

Copy

import client
from client.models.get_pending_webhook_event_count200_response import GetPendingWebhookEventCount200Response
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (opcional)
    external_id = 'external_id_example' # str |  (opcional)
    event_type = 'event_type_example' # str |  (opcional)
    type = 'type_example' # str |  (opcional)
    domain = 'domain_example' # str |  (opcional)
    attempt_count_gt = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_pending_webhook_event_count(tenant_id, comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt)
        print("The response of DefaultApi->get_pending_webhook_event_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_event_count: %s\n" % e)

Obter eventos de webhook pendentes

Parâmetros

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

Resposta

Retorna: GetPendingWebhookEvents200Response

Exemplo

Exemplo de get_pending_webhook_events

Copy

import client
from client.models.get_pending_webhook_events200_response import GetPendingWebhookEvents200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str |  (opcional)
    external_id = 'external_id_example' # str |  (opcional)
    event_type = 'event_type_example' # str |  (opcional)
    type = 'type_example' # str |  (opcional)
    domain = 'domain_example' # str |  (opcional)
    attempt_count_gt = 3.4 # float |  (opcional)
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_pending_webhook_events(tenant_id, comment_id=comment_id, external_id=external_id, event_type=event_type, type=type, domain=domain, attempt_count_gt=attempt_count_gt, skip=skip)
        print("The response of DefaultApi->get_pending_webhook_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_pending_webhook_events: %s\n" % e)

Criar configuração de pergunta

Parâmetros

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

Resposta

Retorna: CreateQuestionConfig200Response

Exemplo

Exemplo create_question_config

Copy

import client
from client.models.create_question_config200_response import CreateQuestionConfig200Response
from client.models.create_question_config_body import CreateQuestionConfigBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça o seu caso de uso de autenticação.
# Configurar a autorização por chave de API: api_key
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_question_config_body = client.CreateQuestionConfigBody() # CreateQuestionConfigBody | 
    try:
        api_response = api_instance.create_question_config(tenant_id, create_question_config_body)
        print("The response of DefaultApi->create_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_config: %s\n" % e)

Excluir configuração 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 delete_question_config

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_config(tenant_id, id)
        print("The response of DefaultApi->delete_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_config: %s\n" % e)

Obter configuração de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionConfig200Response

Exemplo

Exemplo de get_question_config

Copy

import client
from client.models.get_question_config200_response import GetQuestionConfig200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor de API.
# Exemplos para cada método de autenticação estão fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para definir prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_config(tenant_id, id)
        print("The response of DefaultApi->get_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_config: %s\n" % e)

Obter configurações de perguntas

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

import client
from client.models.get_question_configs200_response import GetQuestionConfigs200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_question_configs(tenant_id, skip=skip)
        print("The response of DefaultApi->get_question_configs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_configs: %s\n" % e)

Atualizar configuração de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_question_config

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_question_config_body import UpdateQuestionConfigBody
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_config_body = client.UpdateQuestionConfigBody() # UpdateQuestionConfigBody | 
    try:
        api_response = api_instance.update_question_config(tenant_id, id, update_question_config_body)
        print("The response of DefaultApi->update_question_config:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_config: %s\n" % e)

Criar resultado de pergunta

Parâmetros

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

Resposta

Retorna: CreateQuestionResult200Response

Exemplo

Exemplo de create_question_result

Copy

import client
from client.models.create_question_result200_response import CreateQuestionResult200Response
from client.models.create_question_result_body import CreateQuestionResultBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# corresponda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_question_result_body = client.CreateQuestionResultBody() # CreateQuestionResultBody | 
    try:
        api_response = api_instance.create_question_result(tenant_id, create_question_result_body)
        print("The response of DefaultApi->create_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_question_result: %s\n" % e)

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

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (e.g. Bearer) para API key, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_question_result(tenant_id, id)
        print("The response of DefaultApi->delete_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_question_result: %s\n" % e)

Obter resultado de pergunta

Parâmetros

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

Resposta

Retorna: GetQuestionResult200Response

Exemplo

Exemplo de get_question_result

Copy

import client
from client.models.get_question_result200_response import GetQuestionResult200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo Bearer) para a chave da API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_question_result(tenant_id, id)
        print("The response of DefaultApi->get_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_result: %s\n" % e)

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

Copy

import client
from client.models.get_question_results200_response import GetQuestionResults200Response
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# Consulte configuration.py para a lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave da API, se necessário
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str |  (opcional)
    user_id = 'user_id_example' # str |  (opcional)
    start_date = 'start_date_example' # str |  (opcional)
    question_id = 'question_id_example' # str |  (opcional)
    question_ids = 'question_ids_example' # str |  (opcional)
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_question_results(tenant_id, url_id=url_id, user_id=user_id, start_date=start_date, question_id=question_id, question_ids=question_ids, skip=skip)
        print("The response of DefaultApi->get_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_question_results: %s\n" % e)

Atualizar resultado de pergunta

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de update_question_result

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_question_result_body import UpdateQuestionResultBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_question_result_body = client.UpdateQuestionResultBody() # UpdateQuestionResultBody | 
    try:
        api_response = api_instance.update_question_result(tenant_id, id, update_question_result_body)
        print("The response of DefaultApi->update_question_result:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_question_result: %s\n" % e)

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

import client
from client.models.aggregate_question_results200_response import AggregateQuestionResults200Response
from client.models.aggregate_time_bucket import AggregateTimeBucket
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  (opcional)
    question_ids = ['question_ids_example'] # List[str] |  (opcional)
    url_id = 'url_id_example' # str |  (opcional)
    time_bucket = client.AggregateTimeBucket() # AggregateTimeBucket |  (opcional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (opcional)
    force_recalculate = True # bool |  (opcional)
    try:
        api_response = api_instance.aggregate_question_results(tenant_id, question_id=question_id, question_ids=question_ids, url_id=url_id, time_bucket=time_bucket, start_date=start_date, force_recalculate=force_recalculate)
        print("The response of DefaultApi->aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->aggregate_question_results: %s\n" % e)

Agregação em massa de resultados de perguntas

Parâmetros

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

Resposta

Retorna: BulkAggregateQuestionResults200Response

Exemplo

Exemplo de bulk_aggregate_question_results

Copy

import client
from client.models.bulk_aggregate_question_results200_response import BulkAggregateQuestionResults200Response
from client.models.bulk_aggregate_question_results_request import BulkAggregateQuestionResultsRequest
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por API key: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a API key, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    bulk_aggregate_question_results_request = client.BulkAggregateQuestionResultsRequest() # BulkAggregateQuestionResultsRequest | 
    force_recalculate = True # bool |  (opcional)
    try:
        api_response = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, force_recalculate=force_recalculate)
        print("The response of DefaultApi->bulk_aggregate_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->bulk_aggregate_question_results: %s\n" % e)

Combinar comentários com resultados de perguntas

Parâmetros

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

Resposta

Retorna: CombineCommentsWithQuestionResults200Response

Exemplo

Exemplo de combine_comments_with_question_results

Copy

import client
from client.models.combine_comments_with_question_results200_response import CombineCommentsWithQuestionResults200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaz seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (por ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    question_id = 'question_id_example' # str |  (opcional)
    question_ids = ['question_ids_example'] # List[str] |  (opcional)
    url_id = 'url_id_example' # str |  (opcional)
    start_date = '2013-10-20T19:20:30+01:00' # datetime |  (opcional)
    force_recalculate = True # bool |  (opcional)
    min_value = 3.4 # float |  (opcional)
    max_value = 3.4 # float |  (opcional)
    limit = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.combine_comments_with_question_results(tenant_id, question_id=question_id, question_ids=question_ids, url_id=url_id, start_date=start_date, force_recalculate=force_recalculate, min_value=min_value, max_value=max_value, limit=limit)
        print("The response of DefaultApi->combine_comments_with_question_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->combine_comments_with_question_results: %s\n" % e)

Adicionar usuário SSO

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: AddSSOUserAPIResponse

Exemplo

Exemplo add_sso_user

Copy

import client
from client.models.add_sso_user_api_response import AddSSOUserAPIResponse
from client.models.create_apisso_user_data import CreateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_apisso_user_data = client.CreateAPISSOUserData() # CreateAPISSOUserData | 
    try:
        api_response = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
        print("The response of DefaultApi->add_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->add_sso_user: %s\n" % e)

Excluir usuário SSO

Parâmetros

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

import client
from client.models.delete_sso_user_api_response import DeleteSSOUserAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = True # bool |  (optional)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (optional)
    try:
        api_response = api_instance.delete_sso_user(tenant_id, id, delete_comments=delete_comments, comment_delete_mode=comment_delete_mode)
        print("The response of DefaultApi->delete_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_sso_user: %s\n" % e)

Obter usuário SSO por e-mail

Parâmetros

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

Resposta

Retorna: GetSSOUserByEmailAPIResponse

Exemplo

Exemplo de get_sso_user_by_email

Copy

import client
from client.models.get_sso_user_by_email_api_response import GetSSOUserByEmailAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    email = 'email_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_email(tenant_id, email)
        print("The response of DefaultApi->get_sso_user_by_email:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_email: %s\n" % e)

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

import client
from client.models.get_sso_user_by_id_api_response import GetSSOUserByIdAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_sso_user_by_id(tenant_id, id)
        print("The response of DefaultApi->get_sso_user_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_user_by_id: %s\n" % e)

Obter usuários SSO

Parâmetros

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

Resposta

Retorna: GetSSOUsers200Response

Exemplo

Exemplo de get_sso_users

Copy

import client
from client.models.get_sso_users200_response import GetSSOUsers200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 56 # int |  (opcional)
    try:
        api_response = api_instance.get_sso_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_sso_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_sso_users: %s\n" % e)

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

Exemplo de patch_sso_user

Copy

import client
from client.models.patch_sso_user_api_response import PatchSSOUserAPIResponse
from client.models.update_apisso_user_data import UpdateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  (optional)
    try:
        api_response = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->patch_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->patch_sso_user: %s\n" % e)

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

import client
from client.models.put_sso_user_api_response import PutSSOUserAPIResponse
from client.models.update_apisso_user_data import UpdateAPISSOUserData
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e tem como valor padrão https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_apisso_user_data = client.UpdateAPISSOUserData() # UpdateAPISSOUserData | 
    update_comments = True # bool |  (opcional)
    try:
        api_response = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, update_comments=update_comments)
        print("The response of DefaultApi->put_sso_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->put_sso_user: %s\n" % e)

Criar assinatura

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateSubscriptionAPIResponse

Exemplo

Exemplo de create_subscription

Copy

import client
from client.models.create_api_user_subscription_data import CreateAPIUserSubscriptionData
from client.models.create_subscription_api_response import CreateSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_api_user_subscription_data = client.CreateAPIUserSubscriptionData() # CreateAPIUserSubscriptionData | 
    try:
        api_response = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
        print("The response of DefaultApi->create_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_subscription: %s\n" % e)

Excluir assinatura

Parâmetros

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

Resposta

Retorna: DeleteSubscriptionAPIResponse

Exemplo

Exemplo de delete_subscription

Copy

import client
from client.models.delete_subscription_api_response import DeleteSubscriptionAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    try:
        api_response = api_instance.delete_subscription(tenant_id, id, user_id=user_id)
        print("The response of DefaultApi->delete_subscription:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_subscription: %s\n" % e)

Obter assinaturas

Parâmetros

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

Resposta

Retorna: GetSubscriptionsAPIResponse

Exemplo

Exemplo de get_subscriptions

Copy

import client
from client.models.get_subscriptions_api_response import GetSubscriptionsAPIResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    try:
        api_response = api_instance.get_subscriptions(tenant_id, user_id=user_id)
        print("The response of DefaultApi->get_subscriptions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_subscriptions: %s\n" % e)

Obter usos diários do locatário

Parâmetros

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

Resposta

Retorna: GetTenantDailyUsages200Response

Exemplo

Exemplo de get_tenant_daily_usages

Copy

import client
from client.models.get_tenant_daily_usages200_response import GetTenantDailyUsages200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão usa https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    year_number = 3.4 # float |  (opcional)
    month_number = 3.4 # float |  (opcional)
    day_number = 3.4 # float |  (opcional)
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_tenant_daily_usages(tenant_id, year_number=year_number, month_number=month_number, day_number=day_number, skip=skip)
        print("The response of DefaultApi->get_tenant_daily_usages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_daily_usages: %s\n" % e)

Criar pacote do locatário

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateTenantPackage200Response

Exemplo

create_tenant_package Exemplo

Copy

import client
from client.models.create_tenant_package200_response import CreateTenantPackage200Response
from client.models.create_tenant_package_body import CreateTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso.
#
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (p.ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_package_body = client.CreateTenantPackageBody() # CreateTenantPackageBody | 
    try:
        api_response = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
        print("The response of DefaultApi->create_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_package: %s\n" % e)

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

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_tenant_package(tenant_id, id)
        print("The response of DefaultApi->delete_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant_package: %s\n" % e)

Obter pacote do locatário

Parâmetros

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

Resposta

Retorna: GetTenantPackage200Response

Exemplo

get_tenant_package Exemplo

Copy

import client
from client.models.get_tenant_package200_response import GetTenantPackage200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e padrão para https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_package(tenant_id, id)
        print("The response of DefaultApi->get_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_package: %s\n" % e)

Obter pacotes do locatário

Parâmetros

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

Resposta

Retorna: GetTenantPackages200Response

Exemplo

Exemplo de get_tenant_packages

Copy

import client
from client.models.get_tenant_packages200_response import GetTenantPackages200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaz seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_tenant_packages(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_packages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_packages: %s\n" % e)

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

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.replace_tenant_package_body import ReplaceTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o
# exemplo que satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_package_body = client.ReplaceTenantPackageBody() # ReplaceTenantPackageBody | 
    try:
        api_response = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
        print("The response of DefaultApi->replace_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_package: %s\n" % e)

Atualizar pacote do 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_package

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_tenant_package_body import UpdateTenantPackageBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_package_body = client.UpdateTenantPackageBody() # UpdateTenantPackageBody | 
    try:
        api_response = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
        print("The response of DefaultApi->update_tenant_package:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_package: %s\n" % e)

Criar usuário do locatário

Parâmetros

Name	Type	Location	Required	Description
tenantId	string	query	Sim

Resposta

Retorna: CreateTenantUser200Response

Exemplo

Exemplo de create_tenant_user

Copy

import client
from client.models.create_tenant_user200_response import CreateTenantUser200Response
from client.models.create_tenant_user_body import CreateTenantUserBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe de API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_user_body = client.CreateTenantUserBody() # CreateTenantUserBody | 
    try:
        api_response = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
        print("The response of DefaultApi->create_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant_user: %s\n" % e)

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

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    delete_comments = 'delete_comments_example' # str |  (opcional)
    comment_delete_mode = 'comment_delete_mode_example' # str |  (opcional)
    try:
        api_response = api_instance.delete_tenant_user(tenant_id, id, delete_comments=delete_comments, comment_delete_mode=comment_delete_mode)
        print("The response of DefaultApi->delete_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant_user: %s\n" % e)

Obter usuário do locatário

Parâmetros

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

Resposta

Retorna: GetTenantUser200Response

Exemplo

Exemplo de get_tenant_user

Copy

import client
from client.models.get_tenant_user200_response import GetTenantUser200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (p.ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant_user(tenant_id, id)
        print("The response of DefaultApi->get_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_user: %s\n" % e)

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

import client
from client.models.get_tenant_users200_response import GetTenantUsers200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_tenant_users(tenant_id, skip=skip)
        print("The response of DefaultApi->get_tenant_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant_users: %s\n" % e)

Substituir usuário do locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo replace_tenant_user

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.replace_tenant_user_body import ReplaceTenantUserBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo Bearer) para a chave API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    replace_tenant_user_body = client.ReplaceTenantUserBody() # ReplaceTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (optional)
    try:
        api_response = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->replace_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->replace_tenant_user: %s\n" % e)

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

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    redirect_url = 'redirect_url_example' # str |  (opcional)
    try:
        api_response = api_instance.send_login_link(tenant_id, id, redirect_url=redirect_url)
        print("The response of DefaultApi->send_login_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->send_login_link: %s\n" % e)

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

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_tenant_user_body import UpdateTenantUserBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Cria uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_user_body = client.UpdateTenantUserBody() # UpdateTenantUserBody | 
    update_comments = 'update_comments_example' # str |  (opcional)
    try:
        api_response = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, update_comments=update_comments)
        print("The response of DefaultApi->update_tenant_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant_user: %s\n" % e)

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

import client
from client.models.create_tenant200_response import CreateTenant200Response
from client.models.create_tenant_body import CreateTenantBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_tenant_body = client.CreateTenantBody() # CreateTenantBody | 
    try:
        api_response = api_instance.create_tenant(tenant_id, create_tenant_body)
        print("The response of DefaultApi->create_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_tenant: %s\n" % e)

Excluir locatário

Parâmetros

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

Resposta

Retorna: FlagCommentPublic200Response

Exemplo

Exemplo de delete_tenant

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    sure = 'sure_example' # str |  (opcional)
    try:
        api_response = api_instance.delete_tenant(tenant_id, id, sure=sure)
        print("The response of DefaultApi->delete_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_tenant: %s\n" % e)

Obter locatário

Parâmetros

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

Resposta

Retorna: GetTenant200Response

Exemplo

Exemplo de get_tenant

Copy

import client
from client.models.get_tenant200_response import GetTenant200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Cria uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_tenant(tenant_id, id)
        print("The response of DefaultApi->get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenant: %s\n" % e)

Obter locatários

Parâmetros

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

Resposta

Retorna: GetTenants200Response

Exemplo

Exemplo de get_tenants

Copy

import client
from client.models.get_tenants200_response import GetTenants200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# melhor atender ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    meta = 'meta_example' # str |  (opcional)
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_tenants(tenant_id, meta=meta, skip=skip)
        print("The response of DefaultApi->get_tenants:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_tenants: %s\n" % e)

Atualizar locatário

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_tenant

Copy

import client
from client.models.flag_comment_public200_response import FlagCommentPublic200Response
from client.models.update_tenant_body import UpdateTenantBody
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_tenant_body = client.UpdateTenantBody() # UpdateTenantBody | 
    try:
        api_response = api_instance.update_tenant(tenant_id, id, update_tenant_body)
        print("The response of DefaultApi->update_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_tenant: %s\n" % e)

Enviar imagem

Carregar e redimensionar uma imagem

Parâmetros

Nome	Tipo	Localização	Obrigatório	Descrição
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á sendo feito, para configurar

Resposta

Retorna: UploadImageResponse

Exemplo

Exemplo de upload_image

Copy

import client
from client.models.size_preset import SizePreset
from client.models.upload_image_response import UploadImageResponse
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    file = None # bytearray | 
    size_preset = client.SizePreset() # SizePreset | Predefinição de tamanho: \"Default\" (1000x1000px) ou \"CrossPlatform\" (cria tamanhos para dispositivos populares) (opcional)
    url_id = 'url_id_example' # str | ID da página de onde o upload está sendo feito, para configurar (opcional)
    try:
        api_response = api_instance.upload_image(tenant_id, file, size_preset=size_preset, url_id=url_id)
        print("The response of PublicApi->upload_image:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->upload_image: %s\n" % e)

Obter progresso de insígnia do usuário 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

import client
from client.models.get_user_badge_progress_by_id200_response import GetUserBadgeProgressById200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaz seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (p.ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_id(tenant_id, id)
        print("The response of DefaultApi->get_user_badge_progress_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_id: %s\n" % e)

Obter progresso de insígnia do usuário por ID de usuário

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressById200Response

Exemplo

Exemplo get_user_badge_progress_by_user_id

Copy

import client
from client.models.get_user_badge_progress_by_id200_response import GetUserBadgeProgressById200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
# Descomente abaixo para configurar o prefixo (e.g. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str | 
    try:
        api_response = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
        print("The response of DefaultApi->get_user_badge_progress_by_user_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_by_user_id: %s\n" % e)

Obter lista de progresso de insígnia do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadgeProgressList200Response

Exemplo

Exemplo de get_user_badge_progress_list

Copy

import client
from client.models.get_user_badge_progress_list200_response import GetUserBadgeProgressList200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    limit = 3.4 # float |  (opcional)
    skip = 3.4 # float |  (opcional)
    try:
        api_response = api_instance.get_user_badge_progress_list(tenant_id, user_id=user_id, limit=limit, skip=skip)
        print("The response of DefaultApi->get_user_badge_progress_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge_progress_list: %s\n" % e)

Criar insígnia do usuário

Parâmetros

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

Resposta

Retorna: CreateUserBadge200Response

Exemplo

create_user_badge Exemplo

Copy

import client
from client.models.create_user_badge200_response import CreateUserBadge200Response
from client.models.create_user_badge_params import CreateUserBadgeParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    create_user_badge_params = client.CreateUserBadgeParams() # CreateUserBadgeParams | 
    try:
        api_response = api_instance.create_user_badge(tenant_id, create_user_badge_params)
        print("The response of DefaultApi->create_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_user_badge: %s\n" % e)

Excluir insígnia 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 delete_user_badge

Copy

import client
from client.models.update_user_badge200_response import UpdateUserBadge200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.delete_user_badge(tenant_id, id)
        print("The response of DefaultApi->delete_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_user_badge: %s\n" % e)

Obter insígnia do usuário

Parâmetros

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

Resposta

Retorna: GetUserBadge200Response

Exemplo

Exemplo de get_user_badge

Copy

import client
from client.models.get_user_badge200_response import GetUserBadge200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e padrão para https://fastcomments.com
# Veja configuration.py para a lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar um prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user_badge(tenant_id, id)
        print("The response of DefaultApi->get_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badge: %s\n" % e)

Obter insígnias do usuário

Parâmetros

Name	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

import client
from client.models.get_user_badges200_response import GetUserBadges200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e padrão para https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (por exemplo Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    badge_id = 'badge_id_example' # str |  (optional)
    type = 3.4 # float |  (optional)
    displayed_on_comments = True # bool |  (optional)
    limit = 3.4 # float |  (optional)
    skip = 3.4 # float |  (optional)
    try:
        api_response = api_instance.get_user_badges(tenant_id, user_id=user_id, badge_id=badge_id, type=type, displayed_on_comments=displayed_on_comments, limit=limit, skip=skip)
        print("The response of DefaultApi->get_user_badges:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user_badges: %s\n" % e)

Atualizar insígnia do usuário

Parâmetros

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

Resposta

Retorna: UpdateUserBadge200Response

Exemplo

Exemplo de update_user_badge

Copy

import client
from client.models.update_user_badge200_response import UpdateUserBadge200Response
from client.models.update_user_badge_params import UpdateUserBadgeParams
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# atende ao seu caso de uso de autenticação.
# Configure a autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    update_user_badge_params = client.UpdateUserBadgeParams() # UpdateUserBadgeParams | 
    try:
        api_response = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
        print("The response of DefaultApi->update_user_badge:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->update_user_badge: %s\n" % e)

Obter contagem de notificações do usuário

Parâmetros

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

Resposta

Retorna: GetUserNotificationCount200Response

Exemplo

Exemplo de get_user_notification_count

Copy

import client
from client.models.get_user_notification_count200_response import GetUserNotificationCount200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Consulte configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.get_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->get_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notification_count: %s\n" % e)

Obter notificações do usuário

Parâmetros

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

import client
from client.models.get_user_notifications200_response import GetUserNotifications200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão usa https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    page_size = 56 # int |  (opcional)
    after_id = 'after_id_example' # str |  (opcional)
    include_context = True # bool |  (opcional)
    after_created_at = 56 # int |  (opcional)
    unread_only = True # bool |  (opcional)
    dm_only = True # bool |  (opcional)
    no_dm = True # bool |  (opcional)
    include_translations = True # bool |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.get_user_notifications(tenant_id, page_size=page_size, after_id=after_id, include_context=include_context, after_created_at=after_created_at, unread_only=unread_only, dm_only=dm_only, no_dm=no_dm, include_translations=include_translations, sso=sso)
        print("The response of PublicApi->get_user_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_notifications: %s\n" % e)

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

import client
from client.models.reset_user_notifications200_response import ResetUserNotifications200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para a lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.reset_user_notification_count(tenant_id, sso=sso)
        print("The response of PublicApi->reset_user_notification_count:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->reset_user_notification_count: %s\n" % e)

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

import client
from client.models.reset_user_notifications200_response import ResetUserNotifications200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    after_id = 'after_id_example' # str |  (opcional)
    after_created_at = 56 # int |  (opcional)
    unread_only = True # bool |  (opcional)
    dm_only = True # bool |  (opcional)
    no_dm = True # bool |  (opcional)
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.reset_user_notifications(tenant_id, after_id=after_id, after_created_at=after_created_at, unread_only=unread_only, dm_only=dm_only, no_dm=no_dm, sso=sso)
        print("The response of PublicApi->reset_user_notifications:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->reset_user_notifications: %s\n" % e)

Atualizar status de assinatura de notificação por comentário do usuário

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

Parâmetros

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

update_user_notification_comment_subscription_status Exemplo

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e por padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    opted_in_or_out = 'opted_in_or_out_example' # str | 
    comment_id = 'comment_id_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, sso=sso)
        print("The response of PublicApi->update_user_notification_comment_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_comment_subscription_status: %s\n" % e)

Atualizar status de assinatura de notificação por página do usuário

Habilitar ou desabilitar 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

Parâmetros

Name	Type	Location	Required
tenantId	string	query	Sim
urlId	string	query	Sim
url	string	query	Sim
pageTitle	string	query	Sim
subscribedOrUnsubscribed	string	path	Sim
sso	string	query	Não

Resposta

Retorna: UpdateUserNotificationStatus200Response

Exemplo

Exemplo de update_user_notification_page_subscription_status

Copy

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o valor padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    url = 'url_example' # str | 
    page_title = 'page_title_example' # str | 
    subscribed_or_unsubscribed = 'subscribed_or_unsubscribed_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, sso=sso)
        print("The response of PublicApi->update_user_notification_page_subscription_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_page_subscription_status: %s\n" % e)

Atualizar status de 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

import client
from client.models.update_user_notification_status200_response import UpdateUserNotificationStatus200Response
from client.rest import ApiException
from pprint import pprint
# A definição do host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe da API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    notification_id = 'notification_id_example' # str | 
    new_status = 'new_status_example' # str | 
    sso = 'sso_example' # str |  (opcional)
    try:
        api_response = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, sso=sso)
        print("The response of PublicApi->update_user_notification_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->update_user_notification_status: %s\n" % e)

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

import client
from client.models.get_user_presence_statuses200_response import GetUserPresenceStatuses200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Abra um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id_ws = 'url_id_ws_example' # str | 
    user_ids = 'user_ids_example' # str | 
    try:
        api_response = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
        print("The response of PublicApi->get_user_presence_statuses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->get_user_presence_statuses: %s\n" % e)

Pesquisar usuários

Parâmetros

Name	Type	Location	Required
tenantId	string	path	Sim
urlId	string	query	Sim
usernameStartsWith	string	query	Sim
mentionGroupIds	array	query	Não
sso	string	query	Não

Resposta

Retorna: SearchUsers200Response

Exemplo

Exemplo de search_users

Copy

import client
from client.models.search_users200_response import SearchUsers200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.PublicApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    username_starts_with = 'username_starts_with_example' # str | 
    mention_group_ids = ['mention_group_ids_example'] # List[str] |  (optional)
    sso = 'sso_example' # str |  (optional)
    try:
        api_response = api_instance.search_users(tenant_id, url_id, username_starts_with, mention_group_ids=mention_group_ids, sso=sso)
        print("The response of PublicApi->search_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PublicApi->search_users: %s\n" % e)

Obter usuário

Parâmetros

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

Resposta

Retorna: GetUser200Response

Exemplo

Exemplo de get_user

Copy

import client
from client.models.get_user200_response import GetUser200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configure a autorização por chave da API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo Bearer) para a chave da API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    try:
        api_response = api_instance.get_user(tenant_id, id)
        print("The response of DefaultApi->get_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_user: %s\n" % e)

Criar voto

Parâmetros

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

Resposta

Retorna: VoteComment200Response

Exemplo

Exemplo de create_vote

Copy

import client
from client.models.vote_comment200_response import VoteComment200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# satisfaça seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (p.ex. Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    comment_id = 'comment_id_example' # str | 
    direction = 'direction_example' # str | 
    user_id = 'user_id_example' # str |  (optional)
    anon_user_id = 'anon_user_id_example' # str |  (optional)
    try:
        api_response = api_instance.create_vote(tenant_id, comment_id, direction, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->create_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->create_vote: %s\n" % e)

Excluir voto

Parâmetros

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

Resposta

Retorna: DeleteCommentVote200Response

Exemplo

Exemplo de delete_vote

Copy

import client
from client.models.delete_comment_vote200_response import DeleteCommentVote200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e o padrão é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo, use o exemplo que
# atenda ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe de API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    id = 'id_example' # str | 
    edit_key = 'edit_key_example' # str |  (optional)
    try:
        api_response = api_instance.delete_vote(tenant_id, id, edit_key=edit_key)
        print("The response of DefaultApi->delete_vote:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->delete_vote: %s\n" % e)

Obter votos

Parâmetros

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

Resposta

Retorna: GetVotes200Response

Exemplo

Exemplo de get_votes

Copy

import client
from client.models.get_votes200_response import GetVotes200Response
from client.rest import ApiException
from pprint import pprint
# Definir o host é opcional e, por padrão, é https://fastcomments.com
# Veja configuration.py para uma lista de todos os parâmetros de configuração suportados.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# O cliente deve configurar os parâmetros de autenticação e autorização
# de acordo com a política de segurança do servidor da API.
# Exemplos para cada método de autenticação são fornecidos abaixo; use o exemplo que
# melhor atende ao seu caso de uso de autenticação.
# Configurar autorização por chave de API: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave da API, se necessário
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Entre em um contexto com uma instância do cliente da API
with client.ApiClient(configuration) as api_client:
    # Crie uma instância da classe API
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    try:
        api_response = api_instance.get_votes(tenant_id, url_id)
        print("The response of DefaultApi->get_votes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_votes: %s\n" % e)

Obter votos do usuário

Parâmetros

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

Resposta

Retorna: GetVotesForUser200Response

Exemplo

Exemplo de get_votes_for_user

Copy

import client
from client.models.get_votes_for_user200_response import GetVotesForUser200Response
from client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://fastcomments.com
# See configuration.py for a list of all supported configuration parameters.
configuration = client.Configuration(
    host = "https://fastcomments.com"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: api_key
configuration.api_key['api_key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['api_key'] = 'Bearer'
# Enter a context with an instance of the API client
with client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = client.DefaultApi(api_client)
    tenant_id = 'tenant_id_example' # str | 
    url_id = 'url_id_example' # str | 
    user_id = 'user_id_example' # str |  (opcional)
    anon_user_id = 'anon_user_id_example' # str |  (opcional)
    try:
        api_response = api_instance.get_votes_for_user(tenant_id, url_id, user_id=user_id, anon_user_id=anon_user_id)
        print("The response of DefaultApi->get_votes_for_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DefaultApi->get_votes_for_user: %s\n" % e)

Precisa de ajuda?

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

Contribuindo

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

Idioma 🇧🇷 Português (Brasil)

Primeiros passos

Documentação

Agregação

Registros de Auditoria

Bloquear por Comentário

Verificar Comentários Bloqueados

Comentários

Configurações de Domínio

Modelos de E-mail

Registro de Eventos

Postagens do Feed

Sinalizar Comentário

Hashtags

Moderadores

Contagem de Notificações

Notificações

Páginas

Eventos de Webhook Pendentes

Configurações de Perguntas

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

Upload de Imagem

Progresso da Insígnia do Usuário

Insígnias do Usuário

Notificações do Usuário

Status de Presença do Usuário

Busca de Usuários

Usuários

Votos

FastComments Python SDK

Repositório

Instalação

PyPI

Conteúdo da Biblioteca

APIs Públicas vs APIs Protegidas

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

Início Rápido

Usando APIs Autenticadas (DefaultApi)

Usando APIs Públicas (PublicApi)

Usando SSO (Single Sign-On)

Problemas Comuns

Notas

IDs de Broadcast

Requisitos

Agregação

Parâmetros

Resposta

Exemplo

Obter registros 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 bloqueados

Parâmetros

Resposta

Exemplo

Bloquear usuário a partir do comentário

Parâmetros

Resposta

Exemplo

Criar comentário público

Parâmetros

Resposta

Exemplo

Excluir comentário

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