FastComments.com

FastComments Dart SDK

This is the official Dart SDK for FastComments.

Manage comments, users, SSO, and moderation from your Dart and Flutter applications.

Repository

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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
parentTenantIdstringqueryNo
includeStatsbooleanqueryNo

Response

Returns: AggregateResponse

Example

aggregate Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Response

Returns: GetAuditLogsResponse

Example

getAuditLogs Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: BlockSuccess

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: UnblockSuccess

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdsstringqueryYesA comma separated list of comment ids.
ssostringqueryNo

Response

Returns: CheckBlockedCommentsResponse

Example

checkedCommentsForBlocked Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final commentIds = commentIds_example; // String | A comma separated list of comment ids.
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Returns: BlockSuccess

Example

blockUserFromComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

Response

Returns: SaveCommentsResponseWithPresence

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
isLivebooleanqueryNo

Response

Returns: DeleteCommentResult

Example

deleteComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Response

Returns: PublicAPIDeleteCommentResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
voteIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Response

Returns: VoteDeleteResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Returns: FlagCommentResponse

Example

flagComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIGetCommentResponse

Example

getComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
pageintegerqueryNo
limitintegerqueryNo
skipintegerqueryNo
asTreebooleanqueryNo
skipChildrenintegerqueryNo
limitChildrenintegerqueryNo
maxTreeDepthintegerqueryNo
urlIdstringqueryNo
userIdstringqueryNo
anonUserIdstringqueryNo
contextUserIdstringqueryNo
hashTagstringqueryNo
parentIdstringqueryNo
directionstringqueryNo
fromDateintegerqueryNo
toDateintegerqueryNo

Response

Returns: APIGetCommentsResponse

Example

getComments Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

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

Response

Returns: GetCommentsResponseWithPresencePublicComment

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
editKeystringqueryNo
ssostringqueryNo

Response

Returns: PublicAPIGetCommentTextResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
dirintegerqueryYes
ssostringqueryNo

Response

Returns: GetCommentVoteUserNamesSuccessResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Response

Returns: ChangeCommentPinStatusResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Response

Returns: APISaveCommentResponse

Example

saveComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
sendEmailsbooleanqueryNo
populateNotificationsbooleanqueryNo

Response

Returns: SaveCommentsBulkResponse

Example

saveCommentsBulk Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Response

Returns: PublicAPISetCommentTextResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Returns: UnblockSuccess

Example

unBlockUserFromComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Returns: FlagCommentResponse

Example

unFlagComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
broadcastIdstringqueryYes
ssostringqueryNo

Response

Returns: ChangeCommentPinStatusResponse

Example

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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
contextUserIdstringqueryNo
doSpamCheckbooleanqueryNo
isLivebooleanqueryNo

Response

Returns: APIEmptyResponse

Example

updateComment Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
commentIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

Response

Returns: VoteResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

Response

Returns: GetCommentsForUserResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: AddDomainConfigResponse

Example

addDomainConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainstringpathYes

Response

Returns: DeleteDomainConfigResponse

Example

deleteDomainConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainstringpathYes

Response

Returns: GetDomainConfigResponse

Example

getDomainConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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.getDomainConfig(tenantId, domain);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getDomainConfig: $e\n');
17}
18

getDomainConfigs Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: GetDomainConfigsResponse

Example

getDomainConfigs Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 |
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainToUpdatestringpathYes

Response

Returns: PatchDomainConfigResponse

Example

patchDomainConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainToUpdatestringpathYes

Response

Returns: PutDomainConfigResponse

Example

putDomainConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateEmailTemplateResponse

Example

createEmailTemplate Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

deleteEmailTemplate Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
errorIdstringpathYes

Response

Returns: APIEmptyResponse

Example

deleteEmailTemplateRenderError Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetEmailTemplateResponse

Example

getEmailTemplate Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: GetEmailTemplateDefinitionsResponse

Example

getEmailTemplateDefinitions Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 |
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
skipnumberqueryNo

Response

Returns: GetEmailTemplateRenderErrorsResponse

Example

getEmailTemplateRenderErrors Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipnumberqueryNo

Response

Returns: GetEmailTemplatesResponse

Example

getEmailTemplates Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
localestringqueryNo

Response

Returns: RenderEmailTemplateResponse

Example

renderEmailTemplate Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateEmailTemplate Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
userIdWSstringqueryYes
startTimeintegerqueryYes
endTimeintegerqueryNo

Response

Returns: GetEventLogResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
userIdWSstringqueryYes
startTimeintegerqueryYes
endTimeintegerqueryNo

Response

Returns: GetEventLogResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
broadcastIdstringqueryNo
isLivebooleanqueryNo
doSpamCheckbooleanqueryNo
skipDupCheckbooleanqueryNo

Response

Returns: CreateFeedPostsResponse

Example

createFeedPost Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: CreateFeedPostResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: DeleteFeedPostPublicResponse

Example

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

req tenantId afterId

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo

Response

Returns: GetFeedPostsResponse

Example

getFeedPosts Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
afterIdstringqueryNo
limitintegerqueryNo
tagsarrayqueryNo
ssostringqueryNo
isCrawlerbooleanqueryNo
includeUserInfobooleanqueryNo

Response

Returns: PublicFeedPostsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdsarrayqueryYes
ssostringqueryNo

Response

Returns: FeedPostsStatsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdsarrayqueryNo
ssostringqueryNo

Response

Returns: UserReactsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdstringpathYes
isUndobooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: ReactFeedPostResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateFeedPost Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
postIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: CreateFeedPostResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
isFlaggedbooleanqueryYes
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
largeInternalURLSanitizedstringqueryYes

Response

Returns: GifGetLargeResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
searchstringqueryYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Response

Returns: GetGifsSearchResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
localestringqueryNo
ratingstringqueryNo
pagenumberqueryNo

Response

Returns: GetGifsTrendingResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateHashTagResponse

Example

addHashTag Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: BulkCreateHashTagsResponse

Example

addHashTagsBulk Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
tagstringpathYes

Response

Returns: APIEmptyResponse

Example

deleteHashTag Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
pagenumberqueryNo

Response

Returns: GetHashTagsResponse

Example

getHashTags Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
tagstringpathYes

Response

Returns: UpdateHashTagResponse

Example

patchHashTag Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
voteIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: VoteDeleteResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
pagenumberqueryNo
countnumberqueryNo
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Response

Returns: ModerationAPIGetCommentsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
batchJobIdstringqueryNo
ssostringqueryNo

Response

Returns: ModerationExportStatusResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Response

Returns: ModerationAPIGetCommentIdsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: GetBannedUsersFromCommentResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: GetCommentBanStatusResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: ModerationAPIChildCommentsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Response

Returns: ModerationAPICountCommentsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: GetBannedUsersCountResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: ModerationAPIGetLogsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: GetTenantManualBadgesResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

Response

Returns: GetUserManualBadgesResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

Response

Returns: ModerationAPICommentResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Response

Returns: GetCommentTextResponse

Example

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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Response

Returns: PreBanSummary

Example

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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Response

Returns: ModerationCommentSearchResponse

Example

getSearchCommentsSummary Example
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('Exception when calling ModerationApi->getSearchCommentsSummary: $e\n');
16}
17

getSearchPages Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Response

Returns: ModerationPageSearchResponse

Example

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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Response

Returns: ModerationSiteSearchResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
ssostringqueryNo

Response

Returns: ModerationSuggestResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Response

Returns: ModerationUserSearchResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
ssostringqueryNo

Response

Returns: GetUserTrustFactorResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: APIModerateGetUserBanPreferencesResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryNo
ssostringqueryNo

Response

Returns: GetUserInternalProfileResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: AdjustVotesResponse

Example

postAdjustCommentVotes Example
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('Exception when calling ModerationApi->postAdjustCommentVotes: $e\n');
16}
17

postApiExport Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Response

Returns: ModerationExportResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
banEmailbooleanqueryNo
banEmailDomainbooleanqueryNo
banIPbooleanqueryNo
deleteAllUsersCommentsbooleanqueryNo
bannedUntilstringqueryNo
isShadowBanbooleanqueryNo
updateIdstringqueryNo
banReasonstringqueryNo
ssostringqueryNo

Response

Returns: BanUserFromCommentResult

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Response

Returns: BulkPreBanSummary

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: ModerationAPIChildCommentsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: PostRemoveCommentApiResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
approvedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: SetCommentApprovedResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: SetCommentTextResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: VoteResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: AwardUserBadgeResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Returns: RemoveUserBadgeResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Response

Returns: APIEmptyResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Response

Returns: SetUserTrustFactorResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateModeratorResponse

Example

createModerator Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
sendEmailstringqueryNo

Response

Returns: APIEmptyResponse

Example

deleteModerator Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetModeratorResponse

Example

getModerator Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipnumberqueryNo

Response

Returns: GetModeratorsResponse

Example

getModerators Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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.getModerators(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getModerators: $e\n');
17}
18

sendInvite Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
fromNamestringqueryYes

Response

Returns: APIEmptyResponse

Example

sendInvite Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateModerator Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

deleteNotificationCount Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetCachedNotificationCountResponse

Example

getCachedNotificationCount Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo

Response

Returns: GetNotificationCountResponse

Example

getNotificationCount Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
urlIdstringqueryNo
fromCommentIdstringqueryNo
viewedbooleanqueryNo
typestringqueryNo
skipnumberqueryNo

Response

Returns: GetNotificationsResponse

Example

getNotifications Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Response

Returns: APIEmptyResponse

Example

updateNotification Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
titlestringqueryNo

Response

Returns: CreateV1PageReact

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes
titlestringqueryNo

Response

Returns: CreateV1PageReact

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes

Response

Returns: CreateV1PageReact

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Response

Returns: CreateV1PageReact

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes

Response

Returns: GetV1PageLikes

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes

Response

Returns: GetV2PageReacts

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
idstringqueryYes

Response

Returns: GetV2PageReactUsersResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: AddPageAPIResponse

Example

addPage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: DeletePageAPIResponse

Example

deletePage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesPage URL identifier (cleaned server-side).
afterNamestringqueryNoCursor: pass nextAfterName from the previous response.
afterUserIdstringqueryNoCursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries.

Response

Returns: PageUsersOfflineResponse

Example

getOfflineUsers Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Page URL identifier (cleaned server-side).
7final afterName = afterName_example; // String | Cursor: pass nextAfterName from the previous response.
8final afterUserId = afterUserId_example; // String | Cursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries.
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

Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesPage URL identifier (cleaned server-side).
afterNamestringqueryNoCursor: pass nextAfterName from the previous response.
afterUserIdstringqueryNoCursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries.

Response

Returns: PageUsersOnlineResponse

Example

getOnlineUsers Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Page URL identifier (cleaned server-side).
7final afterName = afterName_example; // String | Cursor: pass nextAfterName from the previous response.
8final afterUserId = afterUserId_example; // String | Cursor tiebreaker: pass nextAfterUserId from the previous response. Required when afterName is set so name-ties don't drop entries.
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes

Response

Returns: GetPageByURLIdAPIResponse

Example

getPageByURLId Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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.getPageByURLId(tenantId, urlId);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getPageByURLId: $e\n');
17}
18

getPages Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: GetPagesAPIResponse

Example

getPages Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 |
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.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
cursorstringqueryNoOpaque pagination cursor returned as nextCursor from a prior request. Tied to the same sortBy.
limitintegerqueryNo1..200, default 50
qstringqueryNoOptional case-insensitive title prefix filter.
sortBystringqueryNoSort order. updatedAt (default, newest first), commentCount (most comments first), or title (alphabetical).
hasCommentsbooleanqueryNoIf true, only return pages with at least one comment.

Response

Returns: GetPublicPagesResponse

Example

getPagesPublic Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final cursor = cursor_example; // String | Opaque pagination cursor returned as `nextCursor` from a prior request. Tied to the same `sortBy`.
7final limit = 56; // int | 1..200, default 50
8final q = q_example; // String | Optional case-insensitive title prefix filter.
9final sortBy = ; // PagesSortBy | Sort order. `updatedAt` (default, newest first), `commentCount` (most comments first), or `title` (alphabetical).
10final hasComments = true; // bool | If true, only return pages with at least one comment.
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

NameTypeLocationRequiredDescription
tenantIdstringpathYes
idsstringqueryYesComma-delimited userIds.

Response

Returns: PageUsersInfoResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: PatchPageAPIResponse

Example

patchPage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

deletePendingWebhookEvent Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo

Response

Returns: GetPendingWebhookEventCountResponse

Example

getPendingWebhookEventCount Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryNo
externalIdstringqueryNo
eventTypestringqueryNo
typestringqueryNo
domainstringqueryNo
attemptCountGTnumberqueryNo
skipnumberqueryNo

Response

Returns: GetPendingWebhookEventsResponse

Example

getPendingWebhookEvents Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateQuestionConfigResponse

Example

createQuestionConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

deleteQuestionConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Returns: GetQuestionConfigResponse

Example

getQuestionConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipnumberqueryNo

Response

Returns: GetQuestionConfigsResponse

Example

getQuestionConfigs Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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.getQuestionConfigs(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getQuestionConfigs: $e\n');
17}
18

updateQuestionConfig Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateQuestionConfig Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateQuestionResultResponse

Example

createQuestionResult Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

deleteQuestionResult Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetQuestionResultResponse

Example

getQuestionResult Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryNo
userIdstringqueryNo
startDatestringqueryNo
questionIdstringqueryNo
questionIdsstringqueryNo
skipnumberqueryNo

Response

Returns: GetQuestionResultsResponse

Example

getQuestionResults Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 |
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateQuestionResult Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
timeBucketstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo

Response

Returns: AggregateQuestionResultsResponse

Example

aggregateQuestionResults Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
forceRecalculatebooleanqueryNo

Response

Returns: BulkAggregateQuestionResultsResponse

Example

bulkAggregateQuestionResults Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Response

Returns: CombineQuestionResultsWithCommentsResponse

Example

combineCommentsWithQuestionResults Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: AddSSOUserAPIResponse

Example

addSSOUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

Response

Returns: DeleteSSOUserAPIResponse

Example

deleteSSOUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Example

getSSOUserByEmail Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetSSOUserByIdAPIResponse

Example

getSSOUserById Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipintegerqueryNo

Response

Returns: GetSSOUsersResponse

Example

getSSOUsers Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 = 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Response

Returns: PatchSSOUserAPIResponse

Example

patchSSOUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Response

Returns: PutSSOUserAPIResponse

Example

putSSOUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateSubscriptionAPIResponse

Example

createSubscription Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Response

Returns: DeleteSubscriptionAPIResponse

Example

deleteSubscription Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo

Response

Returns: GetSubscriptionsAPIResponse

Example

getSubscriptions Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Response

Returns: UpdateSubscriptionAPIResponse

Example

updateSubscription Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
yearNumbernumberqueryNo
monthNumbernumberqueryNo
dayNumbernumberqueryNo
skipnumberqueryNo

Response

Returns: GetTenantDailyUsagesResponse

Example

getTenantDailyUsages Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateTenantPackageResponse

Example

createTenantPackage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

deleteTenantPackage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

getTenantPackage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipnumberqueryNo

Response

Returns: GetTenantPackagesResponse

Example

getTenantPackages Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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.getTenantPackages(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantPackages: $e\n');
17}
18

replaceTenantPackage Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

replaceTenantPackage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateTenantPackage Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateTenantUserResponse

Example

createTenantUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
deleteCommentsstringqueryNo
commentDeleteModestringqueryNo

Response

Returns: APIEmptyResponse

Example

deleteTenantUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetTenantUserResponse

Example

getTenantUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipnumberqueryNo

Response

Returns: GetTenantUsersResponse

Example

getTenantUsers Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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.getTenantUsers(tenantId, skip);
14 print(result);
15} catch (e) {
16 print('Exception when calling DefaultApi->getTenantUsers: $e\n');
17}
18

replaceTenantUser Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsstringqueryNo

Response

Returns: APIEmptyResponse

Example

replaceTenantUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
redirectURLstringqueryNo

Response

Returns: APIEmptyResponse

Example

sendLoginLink Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsstringqueryNo

Response

Returns: APIEmptyResponse

Example

updateTenantUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 id = id_example; // String |
11final updateTenantUserBody = UpdateTenantUserBody(); // UpdateTenantUserBody |
12final updateComments = updateComments_example; // String |
13
14try {
15 final result = api_instance.updateTenantUser(tenantId, id, updateTenantUserBody, updateComments);
16 print(result);
17} catch (e) {
18 print('Exception when calling DefaultApi->updateTenantUser: $e\n');
19}
20

createTenant Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: CreateTenantResponse

Example

createTenant Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
surestringqueryNo

Response

Returns: APIEmptyResponse

Example

deleteTenant Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetTenantResponse

Example

getTenant Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
metastringqueryNo
skipnumberqueryNo

Response

Returns: GetTenantsResponse

Example

getTenants Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptyResponse

Example

updateTenant Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryYes
idstringpathYes

Response

Returns: ChangeTicketStateResponse

Example

changeTicketState Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryYes

Response

Returns: CreateTicketResponse

Example

createTicket Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
userIdstringqueryNo

Response

Returns: GetTicketResponse

Example

getTicket Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
statenumberqueryNo
skipnumberqueryNo
limitnumberqueryNo

Response

Returns: GetTicketsResponse

Example

getTickets Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
namespacestringpathYes
componentstringpathYes
localestringqueryNo
useFullTranslationIdsbooleanqueryNo

Response

Returns: GetTranslationsResponse

Example

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

Upload and resize an image

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
sizePresetstringqueryNoSize preset: "Default" (1000x1000px) or "CrossPlatform" (creates sizes for popular devices)
urlIdstringqueryNoPage id that upload is happening from, to configure

Response

Returns: UploadImageResponse

Example

uploadImage Example
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 | Size preset: \"Default\" (1000x1000px) or \"CrossPlatform\" (creates sizes for popular devices)
8final urlId = urlId_example; // String | Page id that upload is happening from, to configure
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIGetUserBadgeProgressResponse

Example

getUserBadgeProgressById Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringpathYes

Response

Returns: APIGetUserBadgeProgressResponse

Example

getUserBadgeProgressByUserId Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
limitnumberqueryNo
skipnumberqueryNo

Response

Returns: APIGetUserBadgeProgressListResponse

Example

getUserBadgeProgressList Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes

Response

Returns: APICreateUserBadgeResponse

Example

createUserBadge Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptySuccessResponse

Example

deleteUserBadge Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIGetUserBadgeResponse

Example

getUserBadge Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
userIdstringqueryNo
badgeIdstringqueryNo
typenumberqueryNo
displayedOnCommentsbooleanqueryNo
limitnumberqueryNo
skipnumberqueryNo

Response

Returns: APIGetUserBadgesResponse

Example

getUserBadges Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: APIEmptySuccessResponse

Example

updateUserBadge Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: GetUserNotificationCountResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryNoUsed to determine whether the current page is subscribed.
pageSizeintegerqueryNo
afterIdstringqueryNo
includeContextbooleanqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
includeTranslationsbooleanqueryNo
includeTenantNotificationsbooleanqueryNo
ssostringqueryNo

Response

Returns: GetMyNotificationsResponse

Example

getUserNotifications Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3
4final api_instance = PublicApi();
5final tenantId = tenantId_example; // String |
6final urlId = urlId_example; // String | Used to determine whether the current page is subscribed.
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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
ssostringqueryNo

Response

Returns: ResetUserNotificationsResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
afterIdstringqueryNo
afterCreatedAtintegerqueryNo
unreadOnlybooleanqueryNo
dmOnlybooleanqueryNo
noDmbooleanqueryNo
ssostringqueryNo

Response

Returns: ResetUserNotificationsResponse

Example

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

Enable or disable notifications for a specific comment.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
notificationIdstringpathYes
optedInOrOutstringpathYes
commentIdstringqueryYes
ssostringqueryNo

Response

Returns: UpdateUserNotificationCommentSubscriptionStatusResponse

Example

updateUserNotificationCommentSubscriptionStatus Example
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 or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
urlstringqueryYes
pageTitlestringqueryYes
subscribedOrUnsubscribedstringpathYes
ssostringqueryNo

Response

Returns: UpdateUserNotificationPageSubscriptionStatusResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
notificationIdstringpathYes
newStatusstringpathYes
ssostringqueryNo

Response

Returns: UpdateUserNotificationStatusResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdWSstringqueryYes
userIdsstringqueryYes

Response

Returns: GetUserPresenceStatusesResponse

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYes
usernameStartsWithstringqueryNo
mentionGroupIdsarrayqueryNo
ssostringqueryNo
searchSectionstringqueryNo

Response

Returns: SearchUsersResult

Example

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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Response

Returns: GetUserResponse

Example

getUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringqueryYes
directionstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Returns: VoteResponse

Example

createVote Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
editKeystringqueryNo

Response

Returns: VoteDeleteResponse

Example

deleteVote Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes

Response

Returns: GetVotesResponse

Example

getVotes Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
urlIdstringqueryYes
userIdstringqueryNo
anonUserIdstringqueryNo

Response

Returns: GetVotesForUserResponse

Example

getVotesForUser Example
Copy Copy
1
2import 'package:fastcomments_dart/api.dart';
3// TODO Configure API key authorization: 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 |
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

Need Help?

If you encounter any issues or have questions about the Dart SDK, please:

Contributing

Contributions are welcome! Please visit the GitHub repository for contribution guidelines.