FastComments.com

FastComments Dart SDK


Este é o SDK oficial em Dart para FastComments.

Gerencie comentários, usuários, SSO e moderação a partir de suas aplicações Dart e Flutter.

Repositório

Visualizar no GitHub


Layout Internal Link

fastcomments-dart/
  client/        generated dart client (do not edit by hand)
  sso/           hand-written SSO token helpers
  openapi.json   committed copy of the spec used for generation
  config.json    openapi-generator config
  update.py      regenerate the client from the spec

SSO Internal Link

import 'package:fastcomments_dart/sso/fastcomments_sso.dart';
import 'package:fastcomments_dart/sso/secure_sso_user_data.dart';

final sso = FastCommentsSSO.secure(
  apiKey: 'YOUR_API_SECRET',
  user: SecureSSOUserData(
    id: 'user-123',
    email: 'jane@example.com',
    username: 'jane',
    avatar: 'https://example.com/jane.png',
  ),
);
final token = sso.prepareToSend();

aggregate Internal Link

Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
Different operations (e.g. sum, countDistinct, avg, etc.) are supported.

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
parentTenantIdstringqueryNão
includeStatsbooleanqueryNão

Response

Retorna: AggregateResponse

Example

Exemplo de Agregação
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final aggregationRequest = AggregationRequest(); // AggregationRequest |
11final parentTenantId = parentTenantId_example; // String |
12final includeStats = true; // bool |
13
14try {
15 final result = api_instance.aggregate(tenantId, aggregationRequest, AggregateOptions(parentTenantId: parentTenantId, includeStats: includeStats));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->aggregate: $e\n');
19}
20

getAuditLogs Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Resposta

Retorna: GetAuditLogsResponse

Exemplo

Exemplo getAuditLogs
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar a autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final limit = 1.2; // double |
11final skip = 1.2; // double |
12final order = ; // SORTDIR |
13final after = 1.2; // double |
14final before = 1.2; // double |
15
16try {
17 final result = api_instance.getAuditLogs(tenantId, GetAuditLogsOptions(limit: limit, skip: skip, order: order, after: after, before: before));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->getAuditLogs: $e\n');
21}
22

logoutPublic Internal Link

Resposta

Retorna: APIEmptyResponse

Exemplo

logoutPublic Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5
6try {
7 final result = api_instance.logoutPublic();
8 print(result);
9} catch (e) {
10 print('Exception when calling PublicApi->logoutPublic: $e\n');
11}
12

blockFromCommentPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
ssostringqueryNão

Resposta

Retorna: BlockSuccess

Exemplo

blockFromCommentPublic Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final publicBlockFromCommentParams = PublicBlockFromCommentParams(); // PublicBlockFromCommentParams |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.blockFromCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->blockFromCommentPublic: $e\n');
15}
16

unBlockCommentPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
ssostringqueryNão

Resposta

Retorna: UnblockSuccess

Exemplo

unBlockCommentPublic Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final publicBlockFromCommentParams = PublicBlockFromCommentParams(); // PublicBlockFromCommentParams |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.unBlockCommentPublic(tenantId, commentId, publicBlockFromCommentParams, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->unBlockCommentPublic: $e\n');
15}
16

checkedCommentsForBlocked Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringquerySim
commentIdsstringquerySimUma lista separada por vírgulas de IDs de comentários.
ssostringqueryNão

Resposta

Retorna: CheckBlockedCommentsResponse

Exemplo

Exemplo de checkedCommentsForBlocked
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentIds = commentIds_example; // String | Uma lista separada por vírgulas de IDs de comentários.
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.checkedCommentsForBlocked(tenantId, commentIds, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->checkedCommentsForBlocked: $e\n');
14}
15

blockUserFromComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Resposta

Retorna: BlockSuccess

Exemplo

Exemplo de blockUserFromComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final blockFromCommentParams = BlockFromCommentParams(); // BlockFromCommentParams |
12final userId = userId_example; // String |
13final anonUserId = anonUserId_example; // String |
14
15try {
16 final result = api_instance.blockUserFromComment(tenantId, id, blockFromCommentParams, BlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->blockUserFromComment: $e\n');
20}
21

createCommentPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim
broadcastIdstringquerySim
sessionIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: SaveCommentsResponseWithPresence

Exemplo

createCommentPublic Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final commentData = CommentData(); // CommentData |
9final sessionId = sessionId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.createCommentPublic(tenantId, urlId, broadcastId, commentData, CreateCommentPublicOptions(sessionId: sessionId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->createCommentPublic: $e\n');
17}
18

deleteComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
contextUserIdstringqueryNão
isLivebooleanqueryNão

Resposta

Retorna: DeleteCommentResult

Exemplo

Exemplo deleteComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final contextUserId = contextUserId_example; // String |
12final isLive = true; // bool |
13
14try {
15 final result = api_instance.deleteComment(tenantId, id, DeleteCommentOptions(contextUserId: contextUserId, isLive: isLive));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->deleteComment: $e\n');
19}
20

deleteCommentPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
broadcastIdstringquerySim
editKeystringqueryNão
ssostringqueryNão

Resposta

Retorna: PublicAPIDeleteCommentResponse

Exemplo

Exemplo deleteCommentPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final editKey = editKey_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.deleteCommentPublic(tenantId, commentId, broadcastId, DeleteCommentPublicOptions(editKey: editKey, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->deleteCommentPublic: $e\n');
16}
17

deleteCommentVote Internal Link


Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
commentIdstringpathYes
voteIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Resposta

Retorna: VoteDeleteResponse

Exemplo

deleteCommentVote Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final voteId = voteId_example; // String |
8final urlId = urlId_example; // String |
9final broadcastId = broadcastId_example; // String |
10final editKey = editKey_example; // String |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.deleteCommentVote(tenantId, commentId, voteId, urlId, broadcastId, DeleteCommentVoteOptions(editKey: editKey, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->deleteCommentVote: $e\n');
18}
19

flagComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Resposta

Retorna: FlagCommentResponse

Exemplo

Exemplo flagComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12final anonUserId = anonUserId_example; // String |
13
14try {
15 final result = api_instance.flagComment(tenantId, id, FlagCommentOptions(userId: userId, anonUserId: anonUserId));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->flagComment: $e\n');
19}
20

getComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIGetCommentResponse

Exemplo

Exemplo getComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex. Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getComment(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getComment: $e\n');
17}
18

getComments Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

Resposta

Returns: APIGetCommentsResponse

Exemplo

Exemplo getComments
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final page = 56; // int |
11final limit = 56; // int |
12final skip = 56; // int |
13final asTree = true; // bool |
14final skipChildren = 56; // int |
15final limitChildren = 56; // int |
16final maxTreeDepth = 56; // int |
17final urlId = urlId_example; // String |
18final userId = userId_example; // String |
19final anonUserId = anonUserId_example; // String |
20final contextUserId = contextUserId_example; // String |
21final hashTag = hashTag_example; // String |
22final parentId = parentId_example; // String |
23final direction = ; // SortDirections |
24final fromDate = 789; // int |
25final toDate = 789; // int |
26
27try {
28 final result = api_instance.getComments(tenantId, GetCommentsOptions(page: page, limit: limit, skip: skip, asTree: asTree, skipChildren: skipChildren, limitChildren: limitChildren, maxTreeDepth: maxTreeDepth, urlId: urlId, userId: userId, anonUserId: anonUserId, contextUserId: contextUserId, hashTag: hashTag, parentId: parentId, direction: direction, fromDate: fromDate, toDate: toDate));
29 print(result);
30} catch (e) {
31 print('Exception when calling DefaultApi->getComments: $e\n');
32}
33

getCommentsPublic Internal Link


req tenantId urlId

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
pageintegerqueryNo
directionstringqueryNo
ssostringqueryNo
skipintegerqueryNo
skipChildrenintegerqueryNo
limitintegerqueryNo
limitChildrenintegerqueryNo
countChildrenbooleanqueryNo
fetchPageForCommentIdstringqueryNo
includeConfigbooleanqueryNo
countAllbooleanqueryNo
includei10nbooleanqueryNo
localestringqueryNo
modulesstringqueryNo
isCrawlerbooleanqueryNo
includeNotificationCountbooleanqueryNo
asTreebooleanqueryNo
maxTreeDepthintegerqueryNo
useFullTranslationIdsbooleanqueryNo
parentIdstringqueryNo
searchTextstringqueryNo
hashTagsarrayqueryNo
userIdstringqueryNo
customConfigStrstringqueryNo
afterCommentIdstringqueryNo
beforeCommentIdstringqueryNo

Resposta

Retorna: GetCommentsResponseWithPresencePublicComment

Exemplo

Exemplo getCommentsPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final page = 56; // int |
8final direction = ; // SortDirections |
9final sso = sso_example; // String |
10final skip = 56; // int |
11final skipChildren = 56; // int |
12final limit = 56; // int |
13final limitChildren = 56; // int |
14final countChildren = true; // bool |
15final fetchPageForCommentId = fetchPageForCommentId_example; // String |
16final includeConfig = true; // bool |
17final countAll = true; // bool |
18final includei10n = true; // bool |
19final locale = locale_example; // String |
20final modules = modules_example; // String |
21final isCrawler = true; // bool |
22final includeNotificationCount = true; // bool |
23final asTree = true; // bool |
24final maxTreeDepth = 56; // int |
25final useFullTranslationIds = true; // bool |
26final parentId = parentId_example; // String |
27final searchText = searchText_example; // String |
28final hashTags = []; // List<String> |
29final userId = userId_example; // String |
30final customConfigStr = customConfigStr_example; // String |
31final afterCommentId = afterCommentId_example; // String |
32final beforeCommentId = beforeCommentId_example; // String |
33
34try {
35 final result = api_instance.getCommentsPublic(tenantId, urlId, GetCommentsPublicOptions(page: page, direction: direction, sso: sso, skip: skip, skipChildren: skipChildren, limit: limit, limitChildren: limitChildren, countChildren: countChildren, fetchPageForCommentId: fetchPageForCommentId, includeConfig: includeConfig, countAll: countAll, includei10n: includei10n, locale: locale, modules: modules, isCrawler: isCrawler, includeNotificationCount: includeNotificationCount, asTree: asTree, maxTreeDepth: maxTreeDepth, useFullTranslationIds: useFullTranslationIds, parentId: parentId, searchText: searchText, hashTags: hashTags, userId: userId, customConfigStr: customConfigStr, afterCommentId: afterCommentId, beforeCommentId: beforeCommentId));
36 print(result);
37} catch (e) {
38 print('Exception when calling PublicApi->getCommentsPublic: $e\n');
39}
40

getCommentText Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
editKeystringqueryNão
ssostringqueryNão

Resposta

Retorna: PublicAPIGetCommentTextResponse

Exemplo

Exemplo getCommentText
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final editKey = editKey_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.getCommentText(tenantId, commentId, GetCommentTextOptions(editKey: editKey, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getCommentText: $e\n');
15}
16

getCommentVoteUserNames Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

Resposta

Retorna: GetCommentVoteUserNamesSuccessResponse

Exemplo

Exemplo getCommentVoteUserNames
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final dir = 56; // int |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.getCommentVoteUserNames(tenantId, commentId, dir, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getCommentVoteUserNames: $e\n');
15}
16

lockComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
broadcastIdstringquerySim
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo lockComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.lockComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->lockComment: $e\n');
15}
16

pinComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
broadcastIdstringquerySim
ssostringqueryNão

Resposta

Retorna: ChangeCommentPinStatusResponse

Exemplo

Exemplo pinComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.pinComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->pinComment: $e\n');
15}
16

saveComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
isLivebooleanqueryNão
doSpamCheckbooleanqueryNão
sendEmailsbooleanqueryNão
populateNotificationsbooleanqueryNão

Resposta

Retorna: APISaveCommentResponse

Exemplo

Exemplo saveComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createCommentParams = CreateCommentParams(); // CreateCommentParams |
11final isLive = true; // bool |
12final doSpamCheck = true; // bool |
13final sendEmails = true; // bool |
14final populateNotifications = true; // bool |
15
16try {
17 final result = api_instance.saveComment(tenantId, createCommentParams, SaveCommentOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->saveComment: $e\n');
21}
22

saveCommentsBulk Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
isLivebooleanqueryNão
doSpamCheckbooleanqueryNão
sendEmailsbooleanqueryNão
populateNotificationsbooleanqueryNão

Resposta

Retorna: SaveCommentsBulkResponse

Exemplo

Exemplo saveCommentsBulk
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createCommentParams = [List<CreateCommentParams>()]; // List<CreateCommentParams> |
11final isLive = true; // bool |
12final doSpamCheck = true; // bool |
13final sendEmails = true; // bool |
14final populateNotifications = true; // bool |
15
16try {
17 final result = api_instance.saveCommentsBulk(tenantId, createCommentParams, SaveCommentsBulkOptions(isLive: isLive, doSpamCheck: doSpamCheck, sendEmails: sendEmails, populateNotifications: populateNotifications));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->saveCommentsBulk: $e\n');
21}
22

setCommentText Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Resposta

Returns: PublicAPISetCommentTextResponse

Exemplo

Exemplo setCommentText
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final commentTextUpdateRequest = CommentTextUpdateRequest(); // CommentTextUpdateRequest |
9final editKey = editKey_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.setCommentText(tenantId, commentId, broadcastId, commentTextUpdateRequest, SetCommentTextOptions(editKey: editKey, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->setCommentText: $e\n');
17}
18

unBlockUserFromComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
userIdstringqueryNão
anonUserIdstringqueryNão

Resposta

Retorna: UnblockSuccess

Exemplo

Exemplo de unBlockUserFromComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final unBlockFromCommentParams = UnBlockFromCommentParams(); // UnBlockFromCommentParams |
12final userId = userId_example; // String |
13final anonUserId = anonUserId_example; // String |
14
15try {
16 final result = api_instance.unBlockUserFromComment(tenantId, id, unBlockFromCommentParams, UnBlockUserFromCommentOptions(userId: userId, anonUserId: anonUserId));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->unBlockUserFromComment: $e\n');
20}
21

unFlagComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Resposta

Retorna: FlagCommentResponse

Exemplo

Exemplo unFlagComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12final anonUserId = anonUserId_example; // String |
13
14try {
15 final result = api_instance.unFlagComment(tenantId, id, UnFlagCommentOptions(userId: userId, anonUserId: anonUserId));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->unFlagComment: $e\n');
19}
20

unLockComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
broadcastIdstringquerySim
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de unLockComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.unLockComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->unLockComment: $e\n');
15}
16

unPinComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
broadcastIdstringquerySim
ssostringqueryNão

Resposta

Retorna: ChangeCommentPinStatusResponse

Exemplo

unPinComment Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.unPinComment(tenantId, commentId, broadcastId, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->unPinComment: $e\n');
15}
16

updateComment Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
contextUserIdstringqueryNão
doSpamCheckbooleanqueryNão
isLivebooleanqueryNão

Response

Retorna: APIEmptyResponse

Example

Exemplo de updateComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure a autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updatableCommentParams = UpdatableCommentParams(); // UpdatableCommentParams |
12final contextUserId = contextUserId_example; // String |
13final doSpamCheck = true; // bool |
14final isLive = true; // bool |
15
16try {
17 final result = api_instance.updateComment(tenantId, id, updatableCommentParams, UpdateCommentOptions(contextUserId: contextUserId, doSpamCheck: doSpamCheck, isLive: isLive));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->updateComment: $e\n');
21}
22

voteComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
commentIdstringpathSim
urlIdstringquerySim
broadcastIdstringquerySim
sessionIdstringqueryNão
ssostringqueryNão

Resposta

Returns: VoteResponse

Exemplo

Exemplo voteComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final urlId = urlId_example; // String |
8final broadcastId = broadcastId_example; // String |
9final voteBodyParams = VoteBodyParams(); // VoteBodyParams |
10final sessionId = sessionId_example; // String |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.voteComment(tenantId, commentId, urlId, broadcastId, voteBodyParams, VoteCommentOptions(sessionId: sessionId, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->voteComment: $e\n');
18}
19

getCommentsForUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
userIdstringqueryNão
directionstringqueryNão
repliesToUserIdstringqueryNão
pagenumberqueryNão
includei10nbooleanqueryNão
localestringqueryNão
isCrawlerbooleanqueryNão

Resposta

Retorna: GetCommentsForUserResponse

Exemplo

Exemplo getCommentsForUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final userId = userId_example; // String |
6final direction = ; // SortDirections |
7final repliesToUserId = repliesToUserId_example; // String |
8final page = 1.2; // double |
9final includei10n = true; // bool |
10final locale = locale_example; // String |
11final isCrawler = true; // bool |
12
13try {
14 final result = api_instance.getCommentsForUser(GetCommentsForUserOptions(userId: userId, direction: direction, repliesToUserId: repliesToUserId, page: page, includei10n: includei10n, locale: locale, isCrawler: isCrawler));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->getCommentsForUser: $e\n');
18}
19

addDomainConfig Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: AddDomainConfigResponse

Exemplo

Exemplo addDomainConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final addDomainConfigParams = AddDomainConfigParams(); // AddDomainConfigParams |
11
12try {
13 final result = api_instance.addDomainConfig(tenantId, addDomainConfigParams);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addDomainConfig: $e\n');
17}
18

deleteDomainConfig Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
domainstringpathYes

Resposta

Returns: DeleteDomainConfigResponse

Exemplo

Exemplo deleteDomainConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domain = domain_example; // String |
11
12try {
13 final result = api_instance.deleteDomainConfig(tenantId, domain);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteDomainConfig: $e\n');
17}
18

getDomainConfig Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
domainstringpathYes

Resposta

Returns: GetDomainConfigResponse

Exemplo

Exemplo getDomainConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domain = domain_example; // String |
11
12try {
13 final result = api_instance.getDomainConfig(tenantId, domain);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getDomainConfig: $e\n');
17}
18

getDomainConfigs Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: GetDomainConfigsResponse

Exemplo

Exemplo getDomainConfigs
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10
11try {
12 final result = api_instance.getDomainConfigs(tenantId);
13 print(result);
14} catch (e) {
15 print('Exception when calling DefaultApi->getDomainConfigs: $e\n');
16}
17

patchDomainConfig Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainToUpdatestringpathYes

Resposta

Returns: PatchDomainConfigResponse

Exemplo

Exemplo patchDomainConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domainToUpdate = domainToUpdate_example; // String |
11final patchDomainConfigParams = PatchDomainConfigParams(); // PatchDomainConfigParams |
12
13try {
14 final result = api_instance.patchDomainConfig(tenantId, domainToUpdate, patchDomainConfigParams);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->patchDomainConfig: $e\n');
18}
19

putDomainConfig Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
domainToUpdatestringpathSim

Resposta

Returns: PutDomainConfigResponse

Exemplo

Exemplo putDomainConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final domainToUpdate = domainToUpdate_example; // String |
11final updateDomainConfigParams = UpdateDomainConfigParams(); // UpdateDomainConfigParams |
12
13try {
14 final result = api_instance.putDomainConfig(tenantId, domainToUpdate, updateDomainConfigParams);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->putDomainConfig: $e\n');
18}
19

createEmailTemplate Internal Link


Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Returns: CreateEmailTemplateResponse

Exemplo

createEmailTemplate Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createEmailTemplateBody = CreateEmailTemplateBody(); // CreateEmailTemplateBody |
11
12try {
13 final result = api_instance.createEmailTemplate(tenantId, createEmailTemplateBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createEmailTemplate: $e\n');
17}
18

deleteEmailTemplate Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteEmailTemplate
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteEmailTemplate(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteEmailTemplate: $e\n');
17}
18

deleteEmailTemplateRenderError Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
errorIdstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

deleteEmailTemplateRenderError Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave da API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final errorId = errorId_example; // String |
12
13try {
14 final result = api_instance.deleteEmailTemplateRenderError(tenantId, id, errorId);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteEmailTemplateRenderError: $e\n');
18}
19

getEmailTemplate Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: GetEmailTemplateResponse

Exemplo

Exemplo getEmailTemplate
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getEmailTemplate(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getEmailTemplate: $e\n');
17}
18

getEmailTemplateDefinitions Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Response

Retorna: GetEmailTemplateDefinitionsResponse

Example

Exemplo getEmailTemplateDefinitions
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10
11try {
12 final result = api_instance.getEmailTemplateDefinitions(tenantId);
13 print(result);
14} catch (e) {
15 print('Exception when calling DefaultApi->getEmailTemplateDefinitions: $e\n');
16}
17

getEmailTemplateRenderErrors Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
skipnumberqueryNão

Resposta

Retorna: GetEmailTemplateRenderErrorsResponse

Exemplo

Exemplo getEmailTemplateRenderErrors
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final skip = 1.2; // double |
12
13try {
14 final result = api_instance.getEmailTemplateRenderErrors(tenantId, id, skip);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->getEmailTemplateRenderErrors: $e\n');
18}
19

getEmailTemplates Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
skipnumberqueryNão

Resposta

Retorna: GetEmailTemplatesResponse

Exemplo

Exemplo getEmailTemplates
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getEmailTemplates(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getEmailTemplates: $e\n');
17}
18

renderEmailTemplate Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
localestringqueryNão

Resposta

Retorna: RenderEmailTemplateResponse

Exemplo

Exemplo renderEmailTemplate
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final renderEmailTemplateBody = RenderEmailTemplateBody(); // RenderEmailTemplateBody |
11final locale = locale_example; // String |
12
13try {
14 final result = api_instance.renderEmailTemplate(tenantId, renderEmailTemplateBody, locale);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->renderEmailTemplate: $e\n');
18}
19

updateEmailTemplate Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de updateEmailTemplate
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateEmailTemplateBody = UpdateEmailTemplateBody(); // UpdateEmailTemplateBody |
12
13try {
14 final result = api_instance.updateEmailTemplate(tenantId, id, updateEmailTemplateBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateEmailTemplate: $e\n');
18}
19

getEventLog Internal Link

req tenantId urlId userIdWS

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim
userIdWSstringquerySim
startTimeintegerquerySim
endTimeintegerqueryNão

Resposta

Retorna: GetEventLogResponse

Exemplo

Exemplo getEventLog
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final userIdWS = userIdWS_example; // String |
8final startTime = 789; // int |
9final endTime = 789; // int |
10
11try {
12 final result = api_instance.getEventLog(tenantId, urlId, userIdWS, startTime, endTime);
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->getEventLog: $e\n');
16}
17

getGlobalEventLog Internal Link

req tenantId urlId userIdWS

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim
userIdWSstringquerySim
startTimeintegerquerySim
endTimeintegerqueryNão

Resposta

Retorna: GetEventLogResponse

Exemplo

Exemplo getGlobalEventLog
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final userIdWS = userIdWS_example; // String |
8final startTime = 789; // int |
9final endTime = 789; // int |
10
11try {
12 final result = api_instance.getGlobalEventLog(tenantId, urlId, userIdWS, startTime, endTime);
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->getGlobalEventLog: $e\n');
16}
17

createFeedPost Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

Resposta

Retorna: CreateFeedPostsResponse

Exemplo

createFeedPost Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure a autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams |
11final broadcastId = broadcastId_example; // String |
12final isLive = true; // bool |
13final doSpamCheck = true; // bool |
14final skipDupCheck = true; // bool |
15
16try {
17 final result = api_instance.createFeedPost(tenantId, createFeedPostParams, CreateFeedPostOptions(broadcastId: broadcastId, isLive: isLive, doSpamCheck: doSpamCheck, skipDupCheck: skipDupCheck));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->createFeedPost: $e\n');
21}
22

createFeedPostPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: CreateFeedPostResponse

Exemplo

createFeedPostPublic Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final createFeedPostParams = CreateFeedPostParams(); // CreateFeedPostParams |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.createFeedPostPublic(tenantId, createFeedPostParams, CreateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->createFeedPostPublic: $e\n');
15}
16

deleteFeedPostPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
postIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: DeleteFeedPostPublicResponse

Exemplo

Exemplo deleteFeedPostPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postId = postId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.deleteFeedPostPublic(tenantId, postId, DeleteFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->deleteFeedPostPublic: $e\n');
15}
16

getFeedPosts Internal Link

requisição
tenantId
afterId

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
afterIdstringqueryNão
limitintegerqueryNão
tagsarrayqueryNão

Resposta

Retorna: GetFeedPostsResponse

Exemplo

Exemplo getFeedPosts
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final afterId = afterId_example; // String |
11final limit = 56; // int |
12final tags = []; // List<String> |
13
14try {
15 final result = api_instance.getFeedPosts(tenantId, GetFeedPostsOptions(afterId: afterId, limit: limit, tags: tags));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->getFeedPosts: $e\n');
19}
20

getFeedPostsPublic Internal Link

req
tenantId
afterId

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
afterIdstringqueryNão
limitintegerqueryNão
tagsarrayqueryNão
ssostringqueryNão
isCrawlerbooleanqueryNão
includeUserInfobooleanqueryNão

Resposta

Retorna: PublicFeedPostsResponse

Exemplo

Exemplo getFeedPostsPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final afterId = afterId_example; // String |
7final limit = 56; // int |
8final tags = []; // List<String> |
9final sso = sso_example; // String |
10final isCrawler = true; // bool |
11final includeUserInfo = true; // bool |
12
13try {
14 final result = api_instance.getFeedPostsPublic(tenantId, GetFeedPostsPublicOptions(afterId: afterId, limit: limit, tags: tags, sso: sso, isCrawler: isCrawler, includeUserInfo: includeUserInfo));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->getFeedPostsPublic: $e\n');
18}
19

getFeedPostsStats Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
postIdsarrayqueryYes
ssostringqueryNo

Resposta

Retorna: FeedPostsStatsResponse

Exemplo

Exemplo getFeedPostsStats
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postIds = []; // List<String> |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getFeedPostsStats(tenantId, postIds, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getFeedPostsStats: $e\n');
14}
15

getUserReactsPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
postIdsarrayqueryNão
ssostringqueryNão

Resposta

Retorna: UserReactsResponse

Exemplo

Exemplo getUserReactsPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postIds = []; // List<String> |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getUserReactsPublic(tenantId, GetUserReactsPublicOptions(postIds: postIds, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getUserReactsPublic: $e\n');
14}
15

reactFeedPostPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
postIdstringpathSim
isUndobooleanqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: ReactFeedPostResponse

Exemplo

Exemplo reactFeedPostPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postId = postId_example; // String |
7final reactBodyParams = ReactBodyParams(); // ReactBodyParams |
8final isUndo = true; // bool |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.reactFeedPostPublic(tenantId, postId, reactBodyParams, ReactFeedPostPublicOptions(isUndo: isUndo, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->reactFeedPostPublic: $e\n');
17}
18

updateFeedPost Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

updateFeedPost Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final feedPost = FeedPost(); // FeedPost |
12
13try {
14 final result = api_instance.updateFeedPost(tenantId, id, feedPost);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateFeedPost: $e\n');
18}
19

updateFeedPostPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
postIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: CreateFeedPostResponse

Exemplo

updateFeedPostPublic Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final postId = postId_example; // String |
7final updateFeedPostParams = UpdateFeedPostParams(); // UpdateFeedPostParams |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.updateFeedPostPublic(tenantId, postId, updateFeedPostParams, UpdateFeedPostPublicOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->updateFeedPostPublic: $e\n');
16}
17

flagCommentPublic Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
isFlaggedbooleanquerySim
ssostringqueryNão

Resposta

Returns: APIEmptyResponse

Exemplo

Exemplo flagCommentPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final isFlagged = true; // bool |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.flagCommentPublic(tenantId, commentId, isFlagged, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->flagCommentPublic: $e\n');
15}
16

getGifLarge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
largeInternalURLSanitizedstringquerySim

Resposta

Retorna: GifGetLargeResponse

Exemplo

Exemplo getGifLarge
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final largeInternalURLSanitized = largeInternalURLSanitized_example; // String |
7
8try {
9 final result = api_instance.getGifLarge(tenantId, largeInternalURLSanitized);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getGifLarge: $e\n');
13}
14

getGifsSearch Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
searchstringqueryYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Resposta

Retorna: GetGifsSearchResponse

Exemplo

getGifsSearch Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final search = search_example; // String |
7final locale = locale_example; // String |
8final rating = rating_example; // String |
9final page = 1.2; // double |
10
11try {
12 final result = api_instance.getGifsSearch(tenantId, search, GetGifsSearchOptions(locale: locale, rating: rating, page: page));
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->getGifsSearch: $e\n');
16}
17

getGifsTrending Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
localestringqueryNão
ratingstringqueryNão
pagenumberqueryNão

Resposta

Retorna: GetGifsTrendingResponse

Exemplo

Exemplo getGifsTrending
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final locale = locale_example; // String |
7final rating = rating_example; // String |
8final page = 1.2; // double |
9
10try {
11 final result = api_instance.getGifsTrending(tenantId, GetGifsTrendingOptions(locale: locale, rating: rating, page: page));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getGifsTrending: $e\n');
15}
16

addHashTag Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes

Resposta

Returns: CreateHashTagResponse

Exemplo

Exemplo addHashTag
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createHashTagBody = CreateHashTagBody(); // CreateHashTagBody |
11
12try {
13 final result = api_instance.addHashTag(tenantId, createHashTagBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addHashTag: $e\n');
17}
18

addHashTagsBulk Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: BulkCreateHashTagsResponse

Exemplo

addHashTagsBulk Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final bulkCreateHashTagsBody = BulkCreateHashTagsBody(); // BulkCreateHashTagsBody |
11
12try {
13 final result = api_instance.addHashTagsBulk(tenantId, bulkCreateHashTagsBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addHashTagsBulk: $e\n');
17}
18

deleteHashTag Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
tagstringpathYes

Response

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteHashTag
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final tag = tag_example; // String |
11final deleteHashTagRequestBody = DeleteHashTagRequestBody(); // DeleteHashTagRequestBody |
12
13try {
14 final result = api_instance.deleteHashTag(tenantId, tag, deleteHashTagRequestBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteHashTag: $e\n');
18}
19

getHashTags Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
pagenumberqueryNão

Resposta

Retorna: GetHashTagsResponse

Exemplo

Exemplo getHashTags
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave da API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave da API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final page = 1.2; // double |
11
12try {
13 final result = api_instance.getHashTags(tenantId, page);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getHashTags: $e\n');
17}
18

patchHashTag Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
tagstringpathYes

Resposta

Retorna: UpdateHashTagResponse

Exemplo

patchHashTag Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final tag = tag_example; // String |
11final updateHashTagBody = UpdateHashTagBody(); // UpdateHashTagBody |
12
13try {
14 final result = api_instance.patchHashTag(tenantId, tag, updateHashTagBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->patchHashTag: $e\n');
18}
19

deleteModerationVote Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
voteIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: VoteDeleteResponse

Exemplo

Exemplo deleteModerationVote
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final voteId = voteId_example; // String |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.deleteModerationVote(tenantId, commentId, voteId, DeleteModerationVoteOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->deleteModerationVote: $e\n');
16}
17

getApiComments Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
pagenumberqueryNão
countnumberqueryNão
text-searchstringqueryNão
byIPFromCommentstringqueryNão
filtersstringqueryNão
searchFiltersstringqueryNão
sortsstringqueryNão
demobooleanqueryNão
ssostringqueryNão

Resposta

Retorna: ModerationAPIGetCommentsResponse

Exemplo

Exemplo getApiComments
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final page = 1.2; // double |
7final count = 1.2; // double |
8final textSearch = textSearch_example; // String |
9final byIPFromComment = byIPFromComment_example; // String |
10final filters = filters_example; // String |
11final searchFilters = searchFilters_example; // String |
12final sorts = sorts_example; // String |
13final demo = true; // bool |
14final sso = sso_example; // String |
15
16try {
17 final result = api_instance.getApiComments(tenantId, GetApiCommentsOptions(page: page, count: count, textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, demo: demo, sso: sso));
18 print(result);
19} catch (e) {
20 print('Exception when calling ModerationApi->getApiComments: $e\n');
21}
22

getApiExportStatus Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
batchJobIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: ModerationExportStatusResponse

Exemplo

getApiExportStatus Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final batchJobId = batchJobId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getApiExportStatus(tenantId, GetApiExportStatusOptions(batchJobId: batchJobId, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getApiExportStatus: $e\n');
14}
15

getApiIds Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
text-searchstringqueryNão
byIPFromCommentstringqueryNão
filtersstringqueryNão
searchFiltersstringqueryNão
afterIdstringqueryNão
demobooleanqueryNão
ssostringqueryNão

Resposta

Retorna: ModerationAPIGetCommentIdsResponse

Exemplo

Exemplo getApiIds
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final byIPFromComment = byIPFromComment_example; // String |
8final filters = filters_example; // String |
9final searchFilters = searchFilters_example; // String |
10final afterId = afterId_example; // String |
11final demo = true; // bool |
12final sso = sso_example; // String |
13
14try {
15 final result = api_instance.getApiIds(tenantId, GetApiIdsOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, afterId: afterId, demo: demo, sso: sso));
16 print(result);
17} catch (e) {
18 print('Exception when calling ModerationApi->getApiIds: $e\n');
19}
20

getBanUsersFromComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
ssostringqueryNão

Resposta

Retorna: GetBannedUsersFromCommentResponse

Exemplo

Exemplo getBanUsersFromComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getBanUsersFromComment(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getBanUsersFromComment: $e\n');
14}
15

getCommentBanStatus Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
ssostringqueryNão

Resposta

Retorna: GetCommentBanStatusResponse

Exemplo

Exemplo getCommentBanStatus
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getCommentBanStatus(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getCommentBanStatus: $e\n');
14}
15

getCommentChildren Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
ssostringqueryNão

Resposta

Returns: ModerationAPIChildCommentsResponse

Exemplo

Exemplo getCommentChildren
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getCommentChildren(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getCommentChildren: $e\n');
14}
15

getCount Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Resposta

Retorna: ModerationAPICountCommentsResponse

Exemplo

Exemplo getCount
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final byIPFromComment = byIPFromComment_example; // String |
8final filter = filter_example; // String |
9final searchFilters = searchFilters_example; // String |
10final demo = true; // bool |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.getCount(tenantId, GetCountOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filter: filter, searchFilters: searchFilters, demo: demo, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling ModerationApi->getCount: $e\n');
18}
19

getCounts Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
ssostringqueryNão

Resposta

Retorna: GetBannedUsersCountResponse

Exemplo

Exemplo getCounts
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getCounts(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling ModerationApi->getCounts: $e\n');
13}
14

getLogs Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Resposta

Retorna: ModerationAPIGetLogsResponse

Exemplo

Exemplo getLogs
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getLogs(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getLogs: $e\n');
14}
15

getManualBadges Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
ssostringqueryNo

Resposta

Retorna: GetTenantManualBadgesResponse

Exemplo

Exemplo getManualBadges
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getManualBadges(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling ModerationApi->getManualBadges: $e\n');
13}
14

getManualBadgesForUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
badgesUserIdstringqueryNão
commentIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: GetUserManualBadgesResponse

Exemplo

Exemplo getManualBadgesForUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final badgesUserId = badgesUserId_example; // String |
7final commentId = commentId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.getManualBadgesForUser(tenantId, GetManualBadgesForUserOptions(badgesUserId: badgesUserId, commentId: commentId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->getManualBadgesForUser: $e\n');
15}
16

getModerationComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

Resposta

Retorna: ModerationAPICommentResponse

Exemplo

Exemplo getModerationComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final includeEmail = true; // bool |
8final includeIP = true; // bool |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.getModerationComment(tenantId, commentId, GetModerationCommentOptions(includeEmail: includeEmail, includeIP: includeIP, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->getModerationComment: $e\n');
16}
17

getModerationCommentText Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
ssostringqueryNão

Resposta

Retorna: GetCommentTextResponse

Exemplo

Exemplo de getModerationCommentText
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getModerationCommentText(tenantId, commentId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getModerationCommentText: $e\n');
14}
15

getPreBanSummary Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
includeByUserIdAndEmailbooleanqueryNão
includeByIPbooleanqueryNão
includeByEmailDomainbooleanqueryNão
ssostringqueryNão

Response

Retorna: PreBanSummary

Example

Exemplo getPreBanSummary
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final includeByUserIdAndEmail = true; // bool |
8final includeByIP = true; // bool |
9final includeByEmailDomain = true; // bool |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.getPreBanSummary(tenantId, commentId, GetPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->getPreBanSummary: $e\n');
17}
18

getSearchCommentsSummary Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Response

Retorna: ModerationCommentSearchResponse

Example

Exemplo getSearchCommentsSummary
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final filters = filters_example; // String |
8final searchFilters = searchFilters_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.getSearchCommentsSummary(tenantId, GetSearchCommentsSummaryOptions(value: value, filters: filters, searchFilters: searchFilters, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exceção ao chamar ModerationApi->getSearchCommentsSummary: $e\n');
16}
17

getSearchPages Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
valuestringqueryNão
ssostringqueryNão

Resposta

Retorna: ModerationPageSearchResponse

Exemplo

Exemplo getSearchPages
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchPages(tenantId, GetSearchPagesOptions(value: value, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchPages: $e\n');
14}
15

getSearchSites Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Response

Retorna: ModerationSiteSearchResponse

Example

Exemplo getSearchSites
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchSites(tenantId, GetSearchSitesOptions(value: value, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchSites: $e\n');
14}
15

getSearchSuggest Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
text-searchstringqueryNão
ssostringqueryNão

Resposta

Retorna: ModerationSuggestResponse

Exemplo

Exemplo getSearchSuggest
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchSuggest(tenantId, GetSearchSuggestOptions(textSearch: textSearch, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchSuggest: $e\n');
14}
15

getSearchUsers Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Resposta

Retorna: ModerationUserSearchResponse

Exemplo

getSearchUsers Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final value = value_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getSearchUsers(tenantId, GetSearchUsersOptions(value: value, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getSearchUsers: $e\n');
14}
15

getTrustFactor Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: GetUserTrustFactorResponse

Exemplo

Exemplo getTrustFactor
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final userId = userId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getTrustFactor(tenantId, GetTrustFactorOptions(userId: userId, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getTrustFactor: $e\n');
14}
15

getUserBanPreference Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
ssostringqueryNão

Resposta

Retorna: APIModerateGetUserBanPreferencesResponse

Exemplo

getUserBanPreference Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getUserBanPreference(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling ModerationApi->getUserBanPreference: $e\n');
13}
14

getUserInternalProfile Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: GetUserInternalProfileResponse

Exemplo

Exemplo getUserInternalProfile
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.getUserInternalProfile(tenantId, GetUserInternalProfileOptions(commentId: commentId, sso: sso));
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->getUserInternalProfile: $e\n');
14}
15

postAdjustCommentVotes Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Resposta

Retorna: AdjustVotesResponse

Exemplo

postAdjustCommentVotes Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final adjustCommentVotesParams = AdjustCommentVotesParams(); // AdjustCommentVotesParams |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postAdjustCommentVotes(tenantId, commentId, adjustCommentVotesParams, PostAdjustCommentVotesOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exceção ao chamar ModerationApi->postAdjustCommentVotes: $e\n');
16}
17

postApiExport Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Resposta

Retorna: ModerationExportResponse

Exemplo

Exemplo postApiExport
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final textSearch = textSearch_example; // String |
7final byIPFromComment = byIPFromComment_example; // String |
8final filters = filters_example; // String |
9final searchFilters = searchFilters_example; // String |
10final sorts = sorts_example; // String |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.postApiExport(tenantId, PostApiExportOptions(textSearch: textSearch, byIPFromComment: byIPFromComment, filters: filters, searchFilters: searchFilters, sorts: sorts, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling ModerationApi->postApiExport: $e\n');
18}
19

postBanUserFromComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

Resposta

Retorna: BanUserFromCommentResult

Exemplo

postBanUserFromComment Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final banEmail = true; // bool |
8final banEmailDomain = true; // bool |
9final banIP = true; // bool |
10final deleteAllUsersComments = true; // bool |
11final bannedUntil = bannedUntil_example; // String |
12final isShadowBan = true; // bool |
13final updateId = updateId_example; // String |
14final banReason = banReason_example; // String |
15final sso = sso_example; // String |
16
17try {
18 final result = api_instance.postBanUserFromComment(tenantId, commentId, PostBanUserFromCommentOptions(banEmail: banEmail, banEmailDomain: banEmailDomain, banIP: banIP, deleteAllUsersComments: deleteAllUsersComments, bannedUntil: bannedUntil, isShadowBan: isShadowBan, updateId: updateId, banReason: banReason, sso: sso));
19 print(result);
20} catch (e) {
21 print('Exception when calling ModerationApi->postBanUserFromComment: $e\n');
22}
23

postBanUserUndo Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
ssostringqueryNo

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de postBanUserUndo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final banUserUndoParams = BanUserUndoParams(); // BanUserUndoParams |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.postBanUserUndo(tenantId, banUserUndoParams, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->postBanUserUndo: $e\n');
14}
15

postBulkPreBanSummary Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
includeByUserIdAndEmailbooleanqueryNão
includeByIPbooleanqueryNão
includeByEmailDomainbooleanqueryNão
ssostringqueryNão

Resposta

Retorna: BulkPreBanSummary

Exemplo

Exemplo postBulkPreBanSummary
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final bulkPreBanParams = BulkPreBanParams(); // BulkPreBanParams |
7final includeByUserIdAndEmail = true; // bool |
8final includeByIP = true; // bool |
9final includeByEmailDomain = true; // bool |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.postBulkPreBanSummary(tenantId, bulkPreBanParams, PostBulkPreBanSummaryOptions(includeByUserIdAndEmail: includeByUserIdAndEmail, includeByIP: includeByIP, includeByEmailDomain: includeByEmailDomain, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->postBulkPreBanSummary: $e\n');
17}
18

postCommentsByIds Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
ssostringqueryNão

Resposta

Retorna: ModerationAPIChildCommentsResponse

Exemplo

Exemplo postCommentsByIds
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentsByIdsParams = CommentsByIdsParams(); // CommentsByIdsParams |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.postCommentsByIds(tenantId, commentsByIdsParams, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->postCommentsByIds: $e\n');
14}
15

postFlagComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postFlagComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postFlagComment(tenantId, commentId, PostFlagCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postFlagComment: $e\n');
15}
16

postRemoveComment Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Resposta

Returns: PostRemoveCommentApiResponse

Exemplo

Exemplo postRemoveComment
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postRemoveComment(tenantId, commentId, PostRemoveCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postRemoveComment: $e\n');
15}
16

postRestoreDeletedComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

postRestoreDeletedComment Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postRestoreDeletedComment(tenantId, commentId, PostRestoreDeletedCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postRestoreDeletedComment: $e\n');
15}
16

postSetCommentApprovalStatus Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
approvedbooleanqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: SetCommentApprovedResponse

Exemplo

postSetCommentApprovalStatus Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final approved = true; // bool |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postSetCommentApprovalStatus(tenantId, commentId, PostSetCommentApprovalStatusOptions(approved: approved, broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postSetCommentApprovalStatus: $e\n');
16}
17

postSetCommentReviewStatus Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
reviewedbooleanqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postSetCommentReviewStatus
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final reviewed = true; // bool |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postSetCommentReviewStatus(tenantId, commentId, PostSetCommentReviewStatusOptions(reviewed: reviewed, broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postSetCommentReviewStatus: $e\n');
16}
17

postSetCommentSpamStatus Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
spambooleanqueryNão
permNotSpambooleanqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo postSetCommentSpamStatus
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final spam = true; // bool |
8final permNotSpam = true; // bool |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.postSetCommentSpamStatus(tenantId, commentId, PostSetCommentSpamStatusOptions(spam: spam, permNotSpam: permNotSpam, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->postSetCommentSpamStatus: $e\n');
17}
18

postSetCommentText Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: SetCommentTextResponse

Exemplo

postSetCommentText Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final setCommentTextParams = SetCommentTextParams(); // SetCommentTextParams |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postSetCommentText(tenantId, commentId, setCommentTextParams, PostSetCommentTextOptions(broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postSetCommentText: $e\n');
16}
17

postUnFlagComment Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Returns: APIEmptyResponse

Exemplo

postUnFlagComment Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final broadcastId = broadcastId_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.postUnFlagComment(tenantId, commentId, PostUnFlagCommentOptions(broadcastId: broadcastId, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->postUnFlagComment: $e\n');
15}
16

postVote Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
commentIdstringpathSim
directionstringqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: VoteResponse

Exemplo

Exemplo postVote
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final commentId = commentId_example; // String |
7final direction = direction_example; // String |
8final broadcastId = broadcastId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.postVote(tenantId, commentId, PostVoteOptions(direction: direction, broadcastId: broadcastId, sso: sso));
13 print(result);
14} catch (e) {
15 print('Exception when calling ModerationApi->postVote: $e\n');
16}
17

putAwardBadge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
badgeIdstringquerySim
userIdstringqueryNão
commentIdstringqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: AwardUserBadgeResponse

Exemplo

putAwardBadge Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final badgeId = badgeId_example; // String |
7final userId = userId_example; // String |
8final commentId = commentId_example; // String |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.putAwardBadge(tenantId, badgeId, PutAwardBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->putAwardBadge: $e\n');
17}
18

putCloseThread Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
urlIdstringquerySim
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo putCloseThread
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.putCloseThread(tenantId, urlId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->putCloseThread: $e\n');
14}
15

putRemoveBadge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
badgeIdstringquerySim
userIdstringqueryNão
commentIdstringqueryNão
broadcastIdstringqueryNão
ssostringqueryNão

Resposta

Retorna: RemoveUserBadgeResponse

Exemplo

putRemoveBadge Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final badgeId = badgeId_example; // String |
7final userId = userId_example; // String |
8final commentId = commentId_example; // String |
9final broadcastId = broadcastId_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.putRemoveBadge(tenantId, badgeId, PutRemoveBadgeOptions(userId: userId, commentId: commentId, broadcastId: broadcastId, sso: sso));
14 print(result);
15} catch (e) {
16 print('Exception when calling ModerationApi->putRemoveBadge: $e\n');
17}
18

putReopenThread Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
urlIdstringquerySim
ssostringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

putReopenThread Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final sso = sso_example; // String |
8
9try {
10 final result = api_instance.putReopenThread(tenantId, urlId, sso);
11 print(result);
12} catch (e) {
13 print('Exception when calling ModerationApi->putReopenThread: $e\n');
14}
15

setTrustFactor Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão
trustFactorstringqueryNão
ssostringqueryNão

Resposta

Retorna: SetUserTrustFactorResponse

Exemplo

Exemplo setTrustFactor
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = ModerationApi();
5final tenantId = tenantId_example; // String |
6final userId = userId_example; // String |
7final trustFactor = trustFactor_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.setTrustFactor(tenantId, SetTrustFactorOptions(userId: userId, trustFactor: trustFactor, sso: sso));
12 print(result);
13} catch (e) {
14 print('Exception when calling ModerationApi->setTrustFactor: $e\n');
15}
16

createModerator Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Resposta

Retorna: CreateModeratorResponse

Exemplo

Exemplo createModerator
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createModeratorBody = CreateModeratorBody(); // CreateModeratorBody |
11
12try {
13 final result = api_instance.createModerator(tenantId, createModeratorBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createModerator: $e\n');
17}
18

deleteModerator Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
sendEmailstringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteModerator
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final sendEmail = sendEmail_example; // String |
12
13try {
14 final result = api_instance.deleteModerator(tenantId, id, sendEmail);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteModerator: $e\n');
18}
19

getModerator Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: GetModeratorResponse

Exemplo

Exemplo getModerator
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getModerator(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getModerator: $e\n');
17}
18

getModerators Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
skipnumberqueryNão

Resposta

Retorna: GetModeratorsResponse

Exemplo

Exemplo getModerators
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getModerators(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getModerators: $e\n');
17}
18

sendInvite Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
fromNamestringqueryYes

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo sendInvite
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir um prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final fromName = fromName_example; // String |
12
13try {
14 final result = api_instance.sendInvite(tenantId, id, fromName);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->sendInvite: $e\n');
18}
19

updateModerator Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: APIEmptyResponse

Exemplo

updateModerator Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateModeratorBody = UpdateModeratorBody(); // UpdateModeratorBody |
12
13try {
14 final result = api_instance.updateModerator(tenantId, id, updateModeratorBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateModerator: $e\n');
18}
19

deleteNotificationCount Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

deleteNotificationCount Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteNotificationCount(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteNotificationCount: $e\n');
17}
18

getCachedNotificationCount Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: GetCachedNotificationCountResponse

Exemplo

Exemplo getCachedNotificationCount
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getCachedNotificationCount(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getCachedNotificationCount: $e\n');
17}
18

getNotificationCount Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão
urlIdstringqueryNão
fromCommentIdstringqueryNão
viewedbooleanqueryNão
typestringqueryNão

Resposta

Retorna: GetNotificationCountResponse

Exemplo

Exemplo getNotificationCount
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final urlId = urlId_example; // String |
12final fromCommentId = fromCommentId_example; // String |
13final viewed = true; // bool |
14final type = type_example; // String |
15
16try {
17 final result = api_instance.getNotificationCount(tenantId, GetNotificationCountOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type));
18 print(result);
19} catch (e) {
20 print('Exception when calling DefaultApi->getNotificationCount: $e\n');
21}
22

getNotifications Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão
urlIdstringqueryNão
fromCommentIdstringqueryNão
viewedbooleanqueryNão
typestringqueryNão
skipnumberqueryNão

Resposta

Retorna: GetNotificationsResponse

Exemplo

Exemplo getNotifications
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex. Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final urlId = urlId_example; // String |
12final fromCommentId = fromCommentId_example; // String |
13final viewed = true; // bool |
14final type = type_example; // String |
15final skip = 1.2; // double |
16
17try {
18 final result = api_instance.getNotifications(tenantId, GetNotificationsOptions(userId: userId, urlId: urlId, fromCommentId: fromCommentId, viewed: viewed, type: type, skip: skip));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getNotifications: $e\n');
22}
23

updateNotification Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateNotification
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure a autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateNotificationBody = UpdateNotificationBody(); // UpdateNotificationBody |
12final userId = userId_example; // String |
13
14try {
15 final result = api_instance.updateNotification(tenantId, id, updateNotificationBody, userId);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->updateNotification: $e\n');
19}
20

createV1PageReact Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim
titlestringqueryNão

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo createV1PageReact
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final title = title_example; // String |
8
9try {
10 final result = api_instance.createV1PageReact(tenantId, urlId, title);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->createV1PageReact: $e\n');
14}
15

createV2PageReact Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes
titlestringqueryNo

Resposta

Retorna: CreateV1PageReact

Exemplo

Exemplo createV2PageReact
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final id = id_example; // String |
8final title = title_example; // String |
9
10try {
11 final result = api_instance.createV2PageReact(tenantId, urlId, id, title);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->createV2PageReact: $e\n');
15}
16

deleteV1PageReact Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim

Resposta

Retorna: CreateV1PageReact

Exemplo

deleteV1PageReact Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7
8try {
9 final result = api_instance.deleteV1PageReact(tenantId, urlId);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->deleteV1PageReact: $e\n');
13}
14

deleteV2PageReact Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Resposta

Retorna: CreateV1PageReact

Exemplo

deleteV2PageReact Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final id = id_example; // String |
8
9try {
10 final result = api_instance.deleteV2PageReact(tenantId, urlId, id);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->deleteV2PageReact: $e\n');
14}
15

getV1PageLikes Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim

Resposta

Retorna: GetV1PageLikes

Exemplo

Exemplo getV1PageLikes
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7
8try {
9 final result = api_instance.getV1PageLikes(tenantId, urlId);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getV1PageLikes: $e\n');
13}
14

getV2PageReacts Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim

Resposta

Retorna: GetV2PageReacts

Exemplo

Exemplo getV2PageReacts
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7
8try {
9 final result = api_instance.getV2PageReacts(tenantId, urlId);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getV2PageReacts: $e\n');
13}
14

getV2PageReactUsers Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySim
idstringquerySim

Resposta

Retorna: GetV2PageReactUsersResponse

Exemplo

Exemplo getV2PageReactUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final id = id_example; // String |
8
9try {
10 final result = api_instance.getV2PageReactUsers(tenantId, urlId, id);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getV2PageReactUsers: $e\n');
14}
15

addPage Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: AddPageAPIResponse

Exemplo

addPage Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createAPIPageData = CreateAPIPageData(); // CreateAPIPageData |
11
12try {
13 final result = api_instance.addPage(tenantId, createAPIPageData);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addPage: $e\n');
17}
18

deletePage Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: DeletePageAPIResponse

Exemplo

Exemplo deletePage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deletePage(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deletePage: $e\n');
17}
18

getOfflineUsers Internal Link


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

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
urlIdstringquerySimIdentificador da URL da página (limpo no servidor).
afterNamestringqueryNãoCursor: passe nextAfterName da resposta anterior.
afterUserIdstringqueryNãoDesempate de cursor: passe nextAfterUserId da resposta anterior. Necessário quando afterName estiver definido para que empates de nomes não removam entradas.

Resposta

Retorna: PageUsersOfflineResponse

Exemplo

Exemplo getOfflineUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Identificador da URL da página (limpo no servidor).
7final afterName = afterName_example; // String | Cursor: passe nextAfterName da resposta anterior.
8final afterUserId = afterUserId_example; // String | Desempate de cursor: passe nextAfterUserId da resposta anterior. Necessário quando afterName estiver definido para que empates de nomes não removam entradas.
9
10try {
11 final result = api_instance.getOfflineUsers(tenantId, urlId, GetOfflineUsersOptions(afterName: afterName, afterUserId: afterUserId));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getOfflineUsers: $e\n');
15}
16

getOnlineUsers Internal Link

Visualizadores atualmente online de uma página: pessoas cuja sessão websocket está assinada à página neste momento.
Retorna anonCount + totalCount (assinantes de toda a sala, incluindo visualizadores anônimos que não enumeramos).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesIdentificador da URL da página (limpo no lado do servidor).
afterNamestringqueryNoCursor: passe nextAfterName da resposta anterior.
afterUserIdstringqueryNoDesempate de cursor: passe nextAfterUserId da resposta anterior. Necessário quando afterName está definido para que empates de nome não removam entradas.

Response

Retorna: PageUsersOnlineResponse

Example

Exemplo getOnlineUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Identificador da URL da página (limpo no lado do servidor).
7final afterName = afterName_example; // String | Cursor: passe nextAfterName da resposta anterior.
8final afterUserId = afterUserId_example; // String | Desempate de cursor: passe nextAfterUserId da resposta anterior. Necessário quando afterName está definido para que empates de nome não removam entradas.
9
10try {
11 final result = api_instance.getOnlineUsers(tenantId, urlId, GetOnlineUsersOptions(afterName: afterName, afterUserId: afterUserId));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getOnlineUsers: $e\n');
15}
16

getPageByURLId Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
urlIdstringquerySim

Resposta

Retorna: GetPageByURLIdAPIResponse

Exemplo

Exemplo getPageByURLId
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11
12try {
13 final result = api_instance.getPageByURLId(tenantId, urlId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getPageByURLId: $e\n');
17}
18

getPages Internal Link


Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: GetPagesAPIResponse

Exemplo

Exemplo getPages
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10
11try {
12 final result = api_instance.getPages(tenantId);
13 print(result);
14} catch (e) {
15 print('Exception when calling DefaultApi->getPages: $e\n');
16}
17

getPagesPublic Internal Link

List pages for a tenant. Used by the FChat desktop client to populate its room list.
Requires enableFChat to be true on the resolved custom config for each page.
Pages that require SSO are filtered against the requesting user's group access.

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
cursorstringqueryNãoCursor de paginação opaco retornado como nextCursor de uma solicitação anterior. Vinculado ao mesmo sortBy.
limitintegerqueryNão1..200, padrão 50
qstringqueryNãoFiltro opcional de prefixo de título sem distinção entre maiúsculas e minúsculas.
sortBystringqueryNãoOrdem de classificação. updatedAt (padrão, mais recente primeiro), commentCount (maior número de comentários primeiro) ou title (alfabética).
hasCommentsbooleanqueryNãoSe verdadeiro, retorna apenas páginas com ao menos um comentário.

Resposta

Retorna: GetPublicPagesResponse

Exemplo

Exemplo getPagesPublic
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final cursor = cursor_example; // String | Cursor de paginação opaco retornado como `nextCursor` de uma solicitação anterior. Vinculado ao mesmo `sortBy`.
7final limit = 56; // int | 1..200, padrão 50
8final q = q_example; // String | Filtro opcional de prefixo de título sem distinção entre maiúsculas e minúsculas.
9final sortBy = ; // PagesSortBy | Ordem de classificação. `updatedAt` (padrão, mais recente primeiro), `commentCount` (maior número de comentários primeiro) ou `title` (alfabética).
10final hasComments = true; // bool | Se verdadeiro, retorna apenas páginas com ao menos um comentário.
11
12try {
13 final result = api_instance.getPagesPublic(tenantId, GetPagesPublicOptions(cursor: cursor, limit: limit, q: q, sortBy: sortBy, hasComments: hasComments));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->getPagesPublic: $e\n');
17}
18

getUsersInfo Internal Link

Bulk user info for a tenant. Given userIds, return display info from User / SSOUser.
Used by the comment widget to enrich users that just appeared via a presence event.
No page context: privacy is enforced uniformly (private profiles are masked).

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
idsstringqueryYesIDs de usuário delimitados por vírgula.

Response

Retorna: PageUsersInfoResponse

Example

Exemplo getUsersInfo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final ids = ids_example; // String | Comma-delimited userIds.
7
8try {
9 final result = api_instance.getUsersInfo(tenantId, ids);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getUsersInfo: $e\n');
13}
14

patchPage Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: PatchPageAPIResponse

Exemplo

Exemplo patchPage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPIPageData = UpdateAPIPageData(); // UpdateAPIPageData |
12
13try {
14 final result = api_instance.patchPage(tenantId, id, updateAPIPageData);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->patchPage: $e\n');
18}
19

deletePendingWebhookEvent Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

deletePendingWebhookEvent Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deletePendingWebhookEvent(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deletePendingWebhookEvent: $e\n');
17}
18

getPendingWebhookEventCount Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

Resposta

Retorna: GetPendingWebhookEventCountResponse

Exemplo

getPendingWebhookEventCount Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar a autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final commentId = commentId_example; // String |
11final externalId = externalId_example; // String |
12final eventType = eventType_example; // String |
13final type = type_example; // String |
14final domain = domain_example; // String |
15final attemptCountGT = 1.2; // double |
16
17try {
18 final result = api_instance.getPendingWebhookEventCount(tenantId, GetPendingWebhookEventCountOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getPendingWebhookEventCount: $e\n');
22}
23

getPendingWebhookEvents Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Resposta

Retorna: GetPendingWebhookEventsResponse

Exemplo

Exemplo getPendingWebhookEvents
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final commentId = commentId_example; // String |
11final externalId = externalId_example; // String |
12final eventType = eventType_example; // String |
13final type = type_example; // String |
14final domain = domain_example; // String |
15final attemptCountGT = 1.2; // double |
16final skip = 1.2; // double |
17
18try {
19 final result = api_instance.getPendingWebhookEvents(tenantId, GetPendingWebhookEventsOptions(commentId: commentId, externalId: externalId, eventType: eventType, type: type, domain: domain, attemptCountGT: attemptCountGT, skip: skip));
20 print(result);
21} catch (e) {
22 print('Exception when calling DefaultApi->getPendingWebhookEvents: $e\n');
23}
24

createQuestionConfig Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Returns: CreateQuestionConfigResponse

Exemplo

Exemplo createQuestionConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createQuestionConfigBody = CreateQuestionConfigBody(); // CreateQuestionConfigBody |
11
12try {
13 final result = api_instance.createQuestionConfig(tenantId, createQuestionConfigBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createQuestionConfig: $e\n');
17}
18

deleteQuestionConfig Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

Exemplo deleteQuestionConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteQuestionConfig(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteQuestionConfig: $e\n');
17}
18

getQuestionConfig Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Retorna: GetQuestionConfigResponse

Example

Exemplo getQuestionConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure a autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getQuestionConfig(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionConfig: $e\n');
17}
18

getQuestionConfigs Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
skipnumberqueryNo

Resposta

Retorna: GetQuestionConfigsResponse

Exemplo

Exemplo getQuestionConfigs
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getQuestionConfigs(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionConfigs: $e\n');
17}
18

updateQuestionConfig Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Returns: APIEmptyResponse

Exemplo

Exemplo de updateQuestionConfig
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateQuestionConfigBody = UpdateQuestionConfigBody(); // UpdateQuestionConfigBody |
12
13try {
14 final result = api_instance.updateQuestionConfig(tenantId, id, updateQuestionConfigBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateQuestionConfig: $e\n');
18}
19

createQuestionResult Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes

Response

Retorna: CreateQuestionResultResponse

Example

Exemplo createQuestionResult
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createQuestionResultBody = CreateQuestionResultBody(); // CreateQuestionResultBody |
11
12try {
13 final result = api_instance.createQuestionResult(tenantId, createQuestionResultBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createQuestionResult: $e\n');
17}
18

deleteQuestionResult Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteQuestionResult
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure a autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteQuestionResult(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteQuestionResult: $e\n');
17}
18

getQuestionResult Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: GetQuestionResultResponse

Exemplo

Exemplo getQuestionResult
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getQuestionResult(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionResult: $e\n');
17}
18

getQuestionResults Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
urlIdstringqueryNo
userIdstringqueryNo
startDatestringqueryNo
questionIdstringqueryNo
questionIdsstringqueryNo
skipnumberqueryNo

Resposta

Retorna: GetQuestionResultsResponse

Exemplo

Exemplo getQuestionResults
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex. Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11final userId = userId_example; // String |
12final startDate = startDate_example; // String |
13final questionId = questionId_example; // String |
14final questionIds = questionIds_example; // String |
15final skip = 1.2; // double |
16
17try {
18 final result = api_instance.getQuestionResults(tenantId, GetQuestionResultsOptions(urlId: urlId, userId: userId, startDate: startDate, questionId: questionId, questionIds: questionIds, skip: skip));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getQuestionResults: $e\n');
22}
23

updateQuestionResult Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: APIEmptyResponse

Exemplo

updateQuestionResult Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateQuestionResultBody = UpdateQuestionResultBody(); // UpdateQuestionResultBody |
12
13try {
14 final result = api_instance.updateQuestionResult(tenantId, id, updateQuestionResultBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateQuestionResult: $e\n');
18}
19

aggregateQuestionResults Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Resposta

Retorna: AggregateQuestionResultsResponse

Exemplo

aggregateQuestionResults Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final questionId = questionId_example; // String |
11final questionIds = []; // List<String> |
12final urlId = urlId_example; // String |
13final timeBucket = ; // AggregateTimeBucket |
14final startDate = 2013-10-20T19:20:30+01:00; // DateTime |
15final forceRecalculate = true; // bool |
16
17try {
18 final result = api_instance.aggregateQuestionResults(tenantId, AggregateQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, timeBucket: timeBucket, startDate: startDate, forceRecalculate: forceRecalculate));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->aggregateQuestionResults: $e\n');
22}
23

bulkAggregateQuestionResults Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
forceRecalculatebooleanqueryNo

Resposta

Retorna: BulkAggregateQuestionResultsResponse

Exemplo

bulkAggregateQuestionResults Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final bulkAggregateQuestionResultsRequest = BulkAggregateQuestionResultsRequest(); // BulkAggregateQuestionResultsRequest |
11final forceRecalculate = true; // bool |
12
13try {
14 final result = api_instance.bulkAggregateQuestionResults(tenantId, bulkAggregateQuestionResultsRequest, forceRecalculate);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->bulkAggregateQuestionResults: $e\n');
18}
19

combineCommentsWithQuestionResults Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Resposta

Returns: CombineQuestionResultsWithCommentsResponse

Exemplo

Exemplo combineCommentsWithQuestionResults
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final questionId = questionId_example; // String |
11final questionIds = []; // List<String> |
12final urlId = urlId_example; // String |
13final startDate = 2013-10-20T19:20:30+01:00; // DateTime |
14final forceRecalculate = true; // bool |
15final minValue = 1.2; // double |
16final maxValue = 1.2; // double |
17final limit = 1.2; // double |
18
19try {
20 final result = api_instance.combineCommentsWithQuestionResults(tenantId, CombineCommentsWithQuestionResultsOptions(questionId: questionId, questionIds: questionIds, urlId: urlId, startDate: startDate, forceRecalculate: forceRecalculate, minValue: minValue, maxValue: maxValue, limit: limit));
21 print(result);
22} catch (e) {
23 print('Exception when calling DefaultApi->combineCommentsWithQuestionResults: $e\n');
24}
25

addSSOUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: AddSSOUserAPIResponse

Exemplo

Exemplo addSSOUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createAPISSOUserData = CreateAPISSOUserData(); // CreateAPISSOUserData |
11
12try {
13 final result = api_instance.addSSOUser(tenantId, createAPISSOUserData);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->addSSOUser: $e\n');
17}
18

deleteSSOUser Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
deleteCommentsbooleanqueryNão
commentDeleteModestringqueryNão

Response

Retorna: DeleteSSOUserAPIResponse

Exemplo

Exemplo deleteSSOUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final deleteComments = true; // bool |
12final commentDeleteMode = commentDeleteMode_example; // String |
13
14try {
15 final result = api_instance.deleteSSOUser(tenantId, id, DeleteSSOUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->deleteSSOUser: $e\n');
19}
20

getSSOUserByEmail Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
emailstringpathYes

Response

Returns: GetSSOUserByEmailAPIResponse

Exemplo

Exemplo getSSOUserByEmail
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final email = email_example; // String |
11
12try {
13 final result = api_instance.getSSOUserByEmail(tenantId, email);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSSOUserByEmail: $e\n');
17}
18

getSSOUserById Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: GetSSOUserByIdAPIResponse

Exemplo

Exemplo getSSOUserById
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getSSOUserById(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSSOUserById: $e\n');
17}
18

getSSOUsers Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
skipintegerqueryNão

Resposta

Retorna: GetSSOUsersResponse

Exemplo

Exemplo getSSOUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 56; // int |
11
12try {
13 final result = api_instance.getSSOUsers(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSSOUsers: $e\n');
17}
18

patchSSOUser Internal Link

Parâmetros

NomeTipoLocalObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
updateCommentsbooleanqueryNão

Resposta

Retorna: PatchSSOUserAPIResponse

Exemplo

Exemplo patchSSOUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData |
12final updateComments = true; // bool |
13
14try {
15 final result = api_instance.patchSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->patchSSOUser: $e\n');
19}
20

putSSOUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Resposta

Retorna: PutSSOUserAPIResponse

Exemplo

putSSOUser Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPISSOUserData = UpdateAPISSOUserData(); // UpdateAPISSOUserData |
12final updateComments = true; // bool |
13
14try {
15 final result = api_instance.putSSOUser(tenantId, id, updateAPISSOUserData, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->putSSOUser: $e\n');
19}
20

createSubscription Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: CreateSubscriptionAPIResponse

Exemplo

Exemplo createSubscription
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createAPIUserSubscriptionData = CreateAPIUserSubscriptionData(); // CreateAPIUserSubscriptionData |
11
12try {
13 final result = api_instance.createSubscription(tenantId, createAPIUserSubscriptionData);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createSubscription: $e\n');
17}
18

deleteSubscription Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Resposta

Retorna: DeleteSubscriptionAPIResponse

Exemplo

Exemplo deleteSubscription
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12
13try {
14 final result = api_instance.deleteSubscription(tenantId, id, userId);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteSubscription: $e\n');
18}
19

getSubscriptions Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão

Resposta

Retorna: GetSubscriptionsAPIResponse

Exemplo

getSubscriptions Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11
12try {
13 final result = api_instance.getSubscriptions(tenantId, userId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getSubscriptions: $e\n');
17}
18

updateSubscription Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Resposta

Retorna: UpdateSubscriptionAPIResponse

Exemplo

Exemplo updateSubscription
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateAPIUserSubscriptionData = UpdateAPIUserSubscriptionData(); // UpdateAPIUserSubscriptionData |
12final userId = userId_example; // String |
13
14try {
15 final result = api_instance.updateSubscription(tenantId, id, updateAPIUserSubscriptionData, userId);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->updateSubscription: $e\n');
19}
20

getTenantDailyUsages Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

Resposta

Retorna: GetTenantDailyUsagesResponse

Exemplo

Exemplo getTenantDailyUsages
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final yearNumber = 1.2; // double |
11final monthNumber = 1.2; // double |
12final dayNumber = 1.2; // double |
13final skip = 1.2; // double |
14
15try {
16 final result = api_instance.getTenantDailyUsages(tenantId, GetTenantDailyUsagesOptions(yearNumber: yearNumber, monthNumber: monthNumber, dayNumber: dayNumber, skip: skip));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->getTenantDailyUsages: $e\n');
20}
21

createTenantPackage Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Resposta

Retorna: CreateTenantPackageResponse

Exemplo

Exemplo createTenantPackage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createTenantPackageBody = CreateTenantPackageBody(); // CreateTenantPackageBody |
11
12try {
13 final result = api_instance.createTenantPackage(tenantId, createTenantPackageBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createTenantPackage: $e\n');
17}
18

deleteTenantPackage Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIEmptyResponse

Exemplo

deleteTenantPackage Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteTenantPackage(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteTenantPackage: $e\n');
17}
18

getTenantPackage Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetTenantPackageResponse

Example

Exemplo getTenantPackage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getTenantPackage(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantPackage: $e\n');
17}
18

getTenantPackages Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
skipnumberqueryNão

Resposta

Retorna: GetTenantPackagesResponse

Exemplo

Exemplo getTenantPackages
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getTenantPackages(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantPackages: $e\n');
17}
18

replaceTenantPackage Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Resposta

Returns: APIEmptyResponse

Exemplo

Exemplo replaceTenantPackage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final replaceTenantPackageBody = ReplaceTenantPackageBody(); // ReplaceTenantPackageBody |
12
13try {
14 final result = api_instance.replaceTenantPackage(tenantId, id, replaceTenantPackageBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->replaceTenantPackage: $e\n');
18}
19

updateTenantPackage Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Response

Retorna: APIEmptyResponse

Example

Exemplo updateTenantPackage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateTenantPackageBody = UpdateTenantPackageBody(); // UpdateTenantPackageBody |
12
13try {
14 final result = api_instance.updateTenantPackage(tenantId, id, updateTenantPackageBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateTenantPackage: $e\n');
18}
19

createTenantUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: CreateTenantUserResponse

Exemplo

createTenantUser Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createTenantUserBody = CreateTenantUserBody(); // CreateTenantUserBody |
11
12try {
13 final result = api_instance.createTenantUser(tenantId, createTenantUserBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createTenantUser: $e\n');
17}
18

deleteTenantUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
deleteCommentsstringqueryNão
commentDeleteModestringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteTenantUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final deleteComments = deleteComments_example; // String |
12final commentDeleteMode = commentDeleteMode_example; // String |
13
14try {
15 final result = api_instance.deleteTenantUser(tenantId, id, DeleteTenantUserOptions(deleteComments: deleteComments, commentDeleteMode: commentDeleteMode));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->deleteTenantUser: $e\n');
19}
20

getTenantUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: GetTenantUserResponse

Exemplo

Exemplo getTenantUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getTenantUser(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantUser: $e\n');
17}
18

getTenantUsers Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
skipnumberqueryNão

Resposta

Retorna: GetTenantUsersResponse

Exemplo

Exemplo getTenantUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar o prefixo (por exemplo, Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final skip = 1.2; // double |
11
12try {
13 final result = api_instance.getTenantUsers(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantUsers: $e\n');
17}
18

replaceTenantUser Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
updateCommentsstringqueryNão

Response

Retorna: APIEmptyResponse

Example

Exemplo replaceTenantUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para definir prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final replaceTenantUserBody = ReplaceTenantUserBody(); // ReplaceTenantUserBody |
12final updateComments = updateComments_example; // String |
13
14try {
15 final result = api_instance.replaceTenantUser(tenantId, id, replaceTenantUserBody, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->replaceTenantUser: $e\n');
19}
20

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
redirectURLstringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

sendLoginLink Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final redirectURL = redirectURL_example; // String |
12
13try {
14 final result = api_instance.sendLoginLink(tenantId, id, redirectURL);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->sendLoginLink: $e\n');
18}
19

updateTenantUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
updateCommentsstringqueryNão

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo updateTenantUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6
7final api_instance = DefaultApi();
8final tenantId = tenantId_example; // String |
9final id = id_example; // String |
10final updateTenantUserBody = UpdateTenantUserBody(); // UpdateTenantUserBody |
11final updateComments = updateComments_example; // String |
12
13try {
14 final result = api_instance.updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateTenantUser: $e\n');
18}
19

createTenant Internal Link


Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: CreateTenantResponse

Exemplo

createTenant Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createTenantBody = CreateTenantBody(); // CreateTenantBody |
11
12try {
13 final result = api_instance.createTenant(tenantId, createTenantBody);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createTenant: $e\n');
17}
18

deleteTenant Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes
surestringqueryNo

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo deleteTenant
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final sure = sure_example; // String |
12
13try {
14 final result = api_instance.deleteTenant(tenantId, id, sure);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteTenant: $e\n');
18}
19

getTenant Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: GetTenantResponse

Exemplo

getTenant Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getTenant(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenant: $e\n');
17}
18

getTenants Internal Link

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
metastringqueryNo
skipnumberqueryNo

Response

Retorna: GetTenantsResponse

Exemplo

Exemplo getTenants
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final meta = meta_example; // String |
11final skip = 1.2; // double |
12
13try {
14 final result = api_instance.getTenants(tenantId, GetTenantsOptions(meta: meta, skip: skip));
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->getTenants: $e\n');
18}
19

updateTenant Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: APIEmptyResponse

Exemplo

Exemplo de updateTenant
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar a autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateTenantBody = UpdateTenantBody(); // UpdateTenantBody |
12
13try {
14 final result = api_instance.updateTenant(tenantId, id, updateTenantBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateTenant: $e\n');
18}
19

changeTicketState Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringquerySim
idstringpathSim

Resposta

Retorna: ChangeTicketStateResponse

Exemplo

Exemplo de changeTicketState
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final id = id_example; // String |
12final changeTicketStateBody = ChangeTicketStateBody(); // ChangeTicketStateBody |
13
14try {
15 final result = api_instance.changeTicketState(tenantId, userId, id, changeTicketStateBody);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->changeTicketState: $e\n');
19}
20

createTicket Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringquerySim

Resposta

Retorna: CreateTicketResponse

Exemplo

Exemplo createTicket
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final createTicketBody = CreateTicketBody(); // CreateTicketBody |
12
13try {
14 final result = api_instance.createTicket(tenantId, userId, createTicketBody);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->createTicket: $e\n');
18}
19

getTicket Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
userIdstringqueryNão

Resposta

Retorna: GetTicketResponse

Exemplo

Exemplo getTicket
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final userId = userId_example; // String |
12
13try {
14 final result = api_instance.getTicket(tenantId, id, userId);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->getTicket: $e\n');
18}
19

getTickets Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

Resposta

Retorna: GetTicketsResponse

Exemplo

Exemplo getTickets
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final state = 1.2; // double |
12final skip = 1.2; // double |
13final limit = 1.2; // double |
14
15try {
16 final result = api_instance.getTickets(tenantId, GetTicketsOptions(userId: userId, state: state, skip: skip, limit: limit));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->getTickets: $e\n');
20}
21

getTranslations Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
namespacestringpathSim
componentstringpathSim
localestringqueryNão
useFullTranslationIdsbooleanqueryNão

Resposta

Retorna: GetTranslationsResponse

Exemplo

Exemplo getTranslations
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final namespace = namespace_example; // String |
6final component = component_example; // String |
7final locale = locale_example; // String |
8final useFullTranslationIds = true; // bool |
9
10try {
11 final result = api_instance.getTranslations(namespace, component, GetTranslationsOptions(locale: locale, useFullTranslationIds: useFullTranslationIds));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->getTranslations: $e\n');
15}
16

uploadImage Internal Link

Carregar e redimensionar uma imagem

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathSim
sizePresetstringqueryNãoTamanho predefinido: "Default" (1000x1000px) ou "CrossPlatform" (cria tamanhos para dispositivos populares)
urlIdstringqueryNãoID da página de onde o upload está sendo realizado, para configurar

Resposta

Retorna: UploadImageResponse

Exemplo

Exemplo uploadImage
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final file = BINARY_DATA_HERE; // MultipartFile |
7final sizePreset = ; // SizePreset | Tamanho predefinido: \"Default\" (1000x1000px) ou \"CrossPlatform\" (cria tamanhos para dispositivos populares)
8final urlId = urlId_example; // String | ID da página de onde o upload está sendo realizado, para configurar
9
10try {
11 final result = api_instance.uploadImage(tenantId, file, UploadImageOptions(sizePreset: sizePreset, urlId: urlId));
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->uploadImage: $e\n');
15}
16

getUserBadgeProgressById Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Returns: APIGetUserBadgeProgressResponse

Exemplo

Exemplo getUserBadgeProgressById
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getUserBadgeProgressById(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUserBadgeProgressById: $e\n');
17}
18

getUserBadgeProgressByUserId Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
userIdstringpathYes

Resposta

Retorna: APIGetUserBadgeProgressResponse

Exemplo

Exemplo getUserBadgeProgressByUserId
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11
12try {
13 final result = api_instance.getUserBadgeProgressByUserId(tenantId, userId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUserBadgeProgressByUserId: $e\n');
17}
18

getUserBadgeProgressList Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão
limitnumberqueryNão
skipnumberqueryNão

Resposta

Returns: APIGetUserBadgeProgressListResponse

Exemplo

Exemplo getUserBadgeProgressList
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final limit = 1.2; // double |
12final skip = 1.2; // double |
13
14try {
15 final result = api_instance.getUserBadgeProgressList(tenantId, GetUserBadgeProgressListOptions(userId: userId, limit: limit, skip: skip));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->getUserBadgeProgressList: $e\n');
19}
20

createUserBadge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim

Resposta

Retorna: APICreateUserBadgeResponse

Exemplo

Exemplo createUserBadge
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final createUserBadgeParams = CreateUserBadgeParams(); // CreateUserBadgeParams |
11
12try {
13 final result = api_instance.createUserBadge(tenantId, createUserBadgeParams);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->createUserBadge: $e\n');
17}
18

deleteUserBadge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: APIEmptySuccessResponse

Exemplo

Exemplo deleteUserBadge
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave da API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave da API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.deleteUserBadge(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->deleteUserBadge: $e\n');
17}
18

getUserBadge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: APIGetUserBadgeResponse

Exemplo

Exemplo getUserBadge
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getUserBadge(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUserBadge: $e\n');
17}
18

getUserBadges Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
userIdstringqueryNão
badgeIdstringqueryNão
typenumberqueryNão
displayedOnCommentsbooleanqueryNão
limitnumberqueryNão
skipnumberqueryNão

Resposta

Retorna: APIGetUserBadgesResponse

Exemplo

getUserBadges Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização de chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (por exemplo, Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final userId = userId_example; // String |
11final badgeId = badgeId_example; // String |
12final type = 1.2; // double |
13final displayedOnComments = true; // bool |
14final limit = 1.2; // double |
15final skip = 1.2; // double |
16
17try {
18 final result = api_instance.getUserBadges(tenantId, GetUserBadgesOptions(userId: userId, badgeId: badgeId, type: type, displayedOnComments: displayedOnComments, limit: limit, skip: skip));
19 print(result);
20} catch (e) {
21 print('Exception when calling DefaultApi->getUserBadges: $e\n');
22}
23

updateUserBadge Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
idstringpathYes

Resposta

Retorna: APIEmptySuccessResponse

Exemplo

Exemplo updateUserBadge
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final updateUserBadgeParams = UpdateUserBadgeParams(); // UpdateUserBadgeParams |
12
13try {
14 final result = api_instance.updateUserBadge(tenantId, id, updateUserBadgeParams);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->updateUserBadge: $e\n');
18}
19

getUserNotificationCount Internal Link

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Resposta

Retorna: GetUserNotificationCountResponse

Exemplo

Exemplo getUserNotificationCount
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.getUserNotificationCount(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->getUserNotificationCount: $e\n');
13}
14

getUserNotifications Internal Link


Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
urlIdstringqueryNãoUsado para determinar se a página atual está inscrita.
pageSizeintegerqueryNão
afterIdstringqueryNão
includeContextbooleanqueryNão
afterCreatedAtintegerqueryNão
unreadOnlybooleanqueryNão
dmOnlybooleanqueryNão
noDmbooleanqueryNão
includeTranslationsbooleanqueryNão
includeTenantNotificationsbooleanqueryNão
ssostringqueryNão

Resposta

Retorna: GetMyNotificationsResponse

Exemplo

Exemplo getUserNotifications
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Usado para determinar se a página atual está inscrita.
7final pageSize = 56; // int |
8final afterId = afterId_example; // String |
9final includeContext = true; // bool |
10final afterCreatedAt = 789; // int |
11final unreadOnly = true; // bool |
12final dmOnly = true; // bool |
13final noDm = true; // bool |
14final includeTranslations = true; // bool |
15final includeTenantNotifications = true; // bool |
16final sso = sso_example; // String |
17
18try {
19 final result = api_instance.getUserNotifications(tenantId, GetUserNotificationsOptions(urlId: urlId, pageSize: pageSize, afterId: afterId, includeContext: includeContext, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, includeTranslations: includeTranslations, includeTenantNotifications: includeTenantNotifications, sso: sso));
20 print(result);
21} catch (e) {
22 print('Exception when calling PublicApi->getUserNotifications: $e\n');
23}
24

resetUserNotificationCount Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
ssostringqueryNo

Resposta

Retorna: ResetUserNotificationsResponse

Exemplo

Exemplo resetUserNotificationCount
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final sso = sso_example; // String |
7
8try {
9 final result = api_instance.resetUserNotificationCount(tenantId, sso);
10 print(result);
11} catch (e) {
12 print('Exception when calling PublicApi->resetUserNotificationCount: $e\n');
13}
14

resetUserNotifications Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Resposta

Retorna: ResetUserNotificationsResponse

Exemplo

resetUserNotifications Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final afterId = afterId_example; // String |
7final afterCreatedAt = 789; // int |
8final unreadOnly = true; // bool |
9final dmOnly = true; // bool |
10final noDm = true; // bool |
11final sso = sso_example; // String |
12
13try {
14 final result = api_instance.resetUserNotifications(tenantId, ResetUserNotificationsOptions(afterId: afterId, afterCreatedAt: afterCreatedAt, unreadOnly: unreadOnly, dmOnly: dmOnly, noDm: noDm, sso: sso));
15 print(result);
16} catch (e) {
17 print('Exception when calling PublicApi->resetUserNotifications: $e\n');
18}
19

updateUserNotificationCommentSubscriptionStatus Internal Link

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

Parameters

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
notificationIdstringpathYes
optedInOrOutstringpathYes
commentIdstringqueryYes
ssostringqueryNo

Response

Retorna: UpdateUserNotificationCommentSubscriptionStatusResponse

Example

Exemplo de updateUserNotificationCommentSubscriptionStatus
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final notificationId = notificationId_example; // String |
7final optedInOrOut = optedInOrOut_example; // String |
8final commentId = commentId_example; // String |
9final sso = sso_example; // String |
10
11try {
12 final result = api_instance.updateUserNotificationCommentSubscriptionStatus(tenantId, notificationId, optedInOrOut, commentId, sso);
13 print(result);
14} catch (e) {
15 print('Exception when calling PublicApi->updateUserNotificationCommentSubscriptionStatus: $e\n');
16}
17

updateUserNotificationPageSubscriptionStatus Internal Link

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

Parâmetros

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
urlstringqueryYes
pageTitlestringqueryYes
subscribedOrUnsubscribedstringpathYes
ssostringqueryNo

Resposta

Retorna: UpdateUserNotificationPageSubscriptionStatusResponse

Exemplo

Exemplo de updateUserNotificationPageSubscriptionStatus
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final url = url_example; // String |
8final pageTitle = pageTitle_example; // String |
9final subscribedOrUnsubscribed = subscribedOrUnsubscribed_example; // String |
10final sso = sso_example; // String |
11
12try {
13 final result = api_instance.updateUserNotificationPageSubscriptionStatus(tenantId, urlId, url, pageTitle, subscribedOrUnsubscribed, sso);
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->updateUserNotificationPageSubscriptionStatus: $e\n');
17}
18

updateUserNotificationStatus Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
notificationIdstringpathSim
newStatusstringpathSim
ssostringqueryNão

Resposta

Retorna: UpdateUserNotificationStatusResponse

Exemplo

Exemplo de updateUserNotificationStatus
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final notificationId = notificationId_example; // String |
7final newStatus = newStatus_example; // String |
8final sso = sso_example; // String |
9
10try {
11 final result = api_instance.updateUserNotificationStatus(tenantId, notificationId, newStatus, sso);
12 print(result);
13} catch (e) {
14 print('Exception when calling PublicApi->updateUserNotificationStatus: $e\n');
15}
16

getUserPresenceStatuses Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
urlIdWSstringquerySim
userIdsstringquerySim

Resposta

Retorna: GetUserPresenceStatusesResponse

Exemplo

Exemplo getUserPresenceStatuses
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlIdWS = urlIdWS_example; // String |
7final userIds = userIds_example; // String |
8
9try {
10 final result = api_instance.getUserPresenceStatuses(tenantId, urlIdWS, userIds);
11 print(result);
12} catch (e) {
13 print('Exception when calling PublicApi->getUserPresenceStatuses: $e\n');
14}
15

searchUsers Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringpathYes
urlIdstringqueryYes
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

Resposta

Retorna: SearchUsersResult

Exemplo

Exemplo searchUsers
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String |
7final usernameStartsWith = usernameStartsWith_example; // String |
8final mentionGroupIds = []; // List<String> |
9final sso = sso_example; // String |
10final searchSection = searchSection_example; // String |
11
12try {
13 final result = api_instance.searchUsers(tenantId, urlId, SearchUsersOptions(usernameStartsWith: usernameStartsWith, mentionGroupIds: mentionGroupIds, sso: sso, searchSection: searchSection));
14 print(result);
15} catch (e) {
16 print('Exception when calling PublicApi->searchUsers: $e\n');
17}
18

getUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim

Resposta

Retorna: GetUserResponse

Exemplo

getUser Exemplo
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure a autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// Descomente abaixo para configurar o prefixo (ex.: Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11
12try {
13 final result = api_instance.getUser(tenantId, id);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getUser: $e\n');
17}
18

createVote Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Resposta

Retorna: VoteResponse

Exemplo

Exemplo createVote
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar prefixo (ex. Bearer) para a chave API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final commentId = commentId_example; // String |
11final direction = direction_example; // String |
12final userId = userId_example; // String |
13final anonUserId = anonUserId_example; // String |
14
15try {
16 final result = api_instance.createVote(tenantId, commentId, direction, CreateVoteOptions(userId: userId, anonUserId: anonUserId));
17 print(result);
18} catch (e) {
19 print('Exception when calling DefaultApi->createVote: $e\n');
20}
21

deleteVote Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringquerySim
idstringpathSim
editKeystringqueryNão

Resposta

Retorna: VoteDeleteResponse

Exemplo

Exemplo de deleteVote
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final id = id_example; // String |
11final editKey = editKey_example; // String |
12
13try {
14 final result = api_instance.deleteVote(tenantId, id, editKey);
15 print(result);
16} catch (e) {
17 print('Exception when calling DefaultApi->deleteVote: $e\n');
18}
19

getVotes Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
urlIdstringqueryYes

Resposta

Retorna: GetVotesResponse

Exemplo

Exemplo getVotes
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11
12try {
13 final result = api_instance.getVotes(tenantId, urlId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getVotes: $e\n');
17}
18

getVotesForUser Internal Link

Parâmetros

NomeTipoLocalizaçãoObrigatórioDescrição
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Resposta

Retorna: GetVotesForUserResponse

Exemplo

Exemplo getVotesForUser
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configurar autorização da chave de API: api_key
4//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
5// descomente abaixo para configurar o prefixo (ex.: Bearer) da chave de API, se necessário
6//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
7
8final api_instance = DefaultApi();
9final tenantId = tenantId_example; // String |
10final urlId = urlId_example; // String |
11final userId = userId_example; // String |
12final anonUserId = anonUserId_example; // String |
13
14try {
15 final result = api_instance.getVotesForUser(tenantId, urlId, GetVotesForUserOptions(userId: userId, anonUserId: anonUserId));
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->getVotesForUser: $e\n');
19}
20

Precisa de ajuda?

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

Contribuindo

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