
Мова 🇺🇦 Українська
Документація
Початок роботи
Довідник API
Використання
Агрегування
Журнали аудиту
Блокування через коментар
Перевірка заблокованих коментарів
Коментарі
Конфігурації доменів
Шаблони електронних листів
Журнал подій
Записи стрічки
Позначення коментаря
Хештеги
Модератори
Лічильник сповіщень
Сповіщення
Сторінки
Очікувані події вебхука
Конфігурації запитань
Результати запитань
Агрегація результатів запитань
SSO-користувачі
Підписки
Щоденне використання орендаря
Пакети орендарів
Користувачі орендаря
Орендарі
Тікети
Завантажити зображення
Прогрес бейджа користувача
Бейджі користувача
Сповіщення користувача
Статус присутності користувача
Пошук користувачів
Користувачі
Голоси
FastComments Nim SDK
Це офіційний SDK на Nim для FastComments.
Офіційний Nim SDK для API FastComments
Репозиторій
Встановлення 
Використання Nimble
nimble install fastcomments
Збірка з вихідного коду
nimble build
Вміст бібліотеки
Ця бібліотека містить згенерований клієнт API та утиліти SSO, щоб полегшити роботу з API.
Публічні й захищені API
Для клієнта API існує два модулі API, api_default та api_public. Модуль api_default містить методи, які вимагають вашого API-ключа, а api_public містить виклики API
які можна виконувати безпосередньо з браузера/мобільного пристрою тощо без автентифікації.
Швидкий старт 
Використання автентифікованих API (DefaultAPI)
Важливо: Для автентифікованих кінцевих точок ваш API-ключ повинен бути встановлений у заголовку x-api-key.
import httpclient
import fastcomments
import fastcomments/apis/api_default
import fastcomments/models/model_comment_data
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
# Виконати автентифіковані виклики API
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Використання публічних API (PublicAPI)
Публічні кінцеві точки не потребують автентифікації:
import httpclient
import fastcomments
import fastcomments/apis/api_public
let client = newHttpClient()
# Виконати публічні виклики API
let (response, httpResponse) = getCommentsPublic(
httpClient = client,
tenantId = "your-tenant-id",
urlId = "your-url-id",
page = 0,
direction = SortDirections.DESC,
sso = "",
skip = 0,
skipChildren = 0,
limit = 0,
limitChildren = 0,
countChildren = false,
fetchPageForCommentId = "",
includeConfig = false,
countAll = false,
includei10n = false,
locale = "",
modules = "",
isCrawler = false,
includeNotificationCount = false,
asTree = false,
maxTreeDepth = 0,
useFullTranslationIds = false,
parentId = "",
searchText = "",
hashTags = @[],
userId = "",
customConfigStr = "",
afterCommentId = "",
beforeCommentId = ""
)
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Поширені проблеми
- 401 помилка автентифікації: Переконайтеся, що ви встановили заголовок
x-api-keyна вашому HttpClient перед виконанням запитів DefaultAPI:client.headers["x-api-key"] = "your-api-key" - Неправильний клас API: Використовуйте
api_defaultдля серверних автентифікованих запитів,api_publicдля клієнтських/публічних запитів.
Виклики API 
Усі методи API в цьому SDK повертають кортежі (Option[ResponseType], Response). Перший елемент містить розібрану відповідь у разі успіху, а другий елемент — сирий HTTP-відповідь.
Приклад: Отримання коментарів
import httpclient
import options
import fastcomments
import fastcomments/apis/api_default
let client = newHttpClient()
client.headers["x-api-key"] = "your-api-key"
let (response, httpResponse) = getComments(
httpClient = client,
tenantId = "your-tenant-id",
page = 0,
limit = 0,
skip = 0,
asTree = false,
skipChildren = 0,
limitChildren = 0,
maxTreeDepth = 0,
urlId = "your-url-id",
userId = "",
anonUserId = "",
contextUserId = "",
hashTag = "",
parentId = "",
direction = SortDirections.DESC
)
if httpResponse.code == Http200:
if response.isSome:
let resp = response.get()
if resp.comments.isSome:
echo "Found ", resp.comments.get().len, " comments"
Примітки 
Ідентифікатори трансляцій
Ви побачите, що потрібно передавати broadcastId у деяких викликах API. Коли ви отримуєте події, ви отримаєте назад цей ідентифікатор, тож знатимете, що можна ігнорувати подію, якщо плануєте оптимістично застосувати зміни на клієнті (що, ймовірно, буде бажаним, оскільки забезпечує найкращий досвід). Передайте тут UUID. Ідентифікатор має бути достатньо унікальним, щоб не повторюватися двічі в одній сесії браузера.
SSO (Єдиний вхід)
Для прикладів SSO дивіться нижче.
Використання SSO 
Простий SSO
import fastcomments/sso
let user = newSimpleSSOUserData(
userId = "user-123",
email = "user@example.com",
avatar = "https://example.com/avatar.jpg"
)
let sso = newSimple(simpleUserData = user)
let token = sso.createToken()
echo "SSO Token: ", token
Безпечний SSO
import fastcomments/sso
let user = newSecureSSOUserData(
userId = "user-123",
email = "user@example.com",
username = "johndoe",
avatar = "https://example.com/avatar.jpg"
)
let apiKey = "your-api-key"
let sso = newSecure(apiKey = apiKey, secureUserData = user)
let token = sso.createToken()
echo "Secure SSO Token: ", token
Документація для FastComments 
Документація для API Endpoint-ів
Всі URI є відносними до https://fastcomments.com
| Клас | Метод | HTTP запит | Опис |
|---|---|---|---|
| DefaultApi | addDomainConfig | POST /api/v1/domain-configs | |
| DefaultApi | addHashTag | POST /api/v1/hash-tags | |
| DefaultApi | addHashTagsBulk | POST /api/v1/hash-tags/bulk | |
| DefaultApi | addPage | POST /api/v1/pages | |
| DefaultApi | addSSOUser | POST /api/v1/sso-users | |
| DefaultApi | aggregate | POST /api/v1/aggregate | Агрегує документи, групуючи їх (якщо groupBy задано) та застосовуючи декілька операцій. Підтримуються різні операції (наприклад, sum, countDistinct, avg тощо). |
| DefaultApi | aggregateQuestionResults | GET /api/v1/question-results-aggregation | |
| DefaultApi | blockUserFromComment | POST /api/v1/comments/{id}/block | |
| DefaultApi | bulkAggregateQuestionResults | POST /api/v1/question-results-aggregation/bulk | |
| DefaultApi | changeTicketState | PATCH /api/v1/tickets/{id}/state | |
| DefaultApi | combineCommentsWithQuestionResults | GET /api/v1/question-results-aggregation/combine/comments | |
| DefaultApi | createEmailTemplate | POST /api/v1/email-templates | |
| DefaultApi | createFeedPost | POST /api/v1/feed-posts | |
| DefaultApi | createModerator | POST /api/v1/moderators | |
| DefaultApi | createQuestionConfig | POST /api/v1/question-configs | |
| DefaultApi | createQuestionResult | POST /api/v1/question-results | |
| DefaultApi | createSubscription | POST /api/v1/subscriptions | |
| DefaultApi | createTenant | POST /api/v1/tenants | |
| DefaultApi | createTenantPackage | POST /api/v1/tenant-packages | |
| DefaultApi | createTenantUser | POST /api/v1/tenant-users | |
| DefaultApi | createTicket | POST /api/v1/tickets | |
| DefaultApi | createUserBadge | POST /api/v1/user-badges | |
| DefaultApi | createVote | POST /api/v1/votes | |
| DefaultApi | deleteComment | DELETE /api/v1/comments/{id} | |
| DefaultApi | deleteDomainConfig | DELETE /api/v1/domain-configs/{domain} | |
| DefaultApi | deleteEmailTemplate | DELETE /api/v1/email-templates/{id} | |
| DefaultApi | deleteEmailTemplateRenderError | DELETE /api/v1/email-templates/{id}/render-errors/{errorId} | |
| DefaultApi | deleteHashTag | DELETE /api/v1/hash-tags/{tag} | |
| DefaultApi | deleteModerator | DELETE /api/v1/moderators/{id} | |
| DefaultApi | deleteNotificationCount | DELETE /api/v1/notification-count/{id} | |
| DefaultApi | deletePage | DELETE /api/v1/pages/{id} | |
| DefaultApi | deletePendingWebhookEvent | DELETE /api/v1/pending-webhook-events/{id} | |
| DefaultApi | deleteQuestionConfig | DELETE /api/v1/question-configs/{id} | |
| DefaultApi | deleteQuestionResult | DELETE /api/v1/question-results/{id} | |
| DefaultApi | deleteSSOUser | DELETE /api/v1/sso-users/{id} | |
| DefaultApi | deleteSubscription | DELETE /api/v1/subscriptions/{id} | |
| DefaultApi | deleteTenant | DELETE /api/v1/tenants/{id} | |
| DefaultApi | deleteTenantPackage | DELETE /api/v1/tenant-packages/{id} | |
| DefaultApi | deleteTenantUser | DELETE /api/v1/tenant-users/{id} | |
| DefaultApi | deleteUserBadge | DELETE /api/v1/user-badges/{id} | |
| DefaultApi | deleteVote | DELETE /api/v1/votes/{id} | |
| DefaultApi | flagComment | POST /api/v1/comments/{id}/flag | |
| DefaultApi | getAuditLogs | GET /api/v1/audit-logs | |
| DefaultApi | getCachedNotificationCount | GET /api/v1/notification-count/{id} | |
| DefaultApi | getComment | GET /api/v1/comments/{id} | |
| DefaultApi | getComments | GET /api/v1/comments | |
| DefaultApi | getDomainConfig | GET /api/v1/domain-configs/{domain} | |
| DefaultApi | getDomainConfigs | GET /api/v1/domain-configs | |
| DefaultApi | getEmailTemplate | GET /api/v1/email-templates/{id} | |
| DefaultApi | getEmailTemplateDefinitions | GET /api/v1/email-templates/definitions | |
| DefaultApi | getEmailTemplateRenderErrors | GET /api/v1/email-templates/{id}/render-errors | |
| DefaultApi | getEmailTemplates | GET /api/v1/email-templates | |
| DefaultApi | getFeedPosts | GET /api/v1/feed-posts | req tenantId afterId |
| DefaultApi | getHashTags | GET /api/v1/hash-tags | |
| DefaultApi | getModerator | GET /api/v1/moderators/{id} | |
| DefaultApi | getModerators | GET /api/v1/moderators | |
| DefaultApi | getNotificationCount | GET /api/v1/notifications/count | |
| DefaultApi | getNotifications | GET /api/v1/notifications | |
| DefaultApi | getPageByURLId | GET /api/v1/pages/by-url-id | |
| DefaultApi | getPages | GET /api/v1/pages | |
| DefaultApi | getPendingWebhookEventCount | GET /api/v1/pending-webhook-events/count | |
| DefaultApi | getPendingWebhookEvents | GET /api/v1/pending-webhook-events | |
| DefaultApi | getQuestionConfig | GET /api/v1/question-configs/{id} | |
| DefaultApi | getQuestionConfigs | GET /api/v1/question-configs | |
| DefaultApi | getQuestionResult | GET /api/v1/question-results/{id} | |
| DefaultApi | getQuestionResults | GET /api/v1/question-results | |
| DefaultApi | getSSOUserByEmail | GET /api/v1/sso-users/by-email/{email} | |
| DefaultApi | getSSOUserById | GET /api/v1/sso-users/by-id/{id} | |
| DefaultApi | getSSOUsers | GET /api/v1/sso-users | |
| DefaultApi | getSubscriptions | GET /api/v1/subscriptions | |
| DefaultApi | getTenant | GET /api/v1/tenants/{id} | |
| DefaultApi | getTenantDailyUsages | GET /api/v1/tenant-daily-usage | |
| DefaultApi | getTenantPackage | GET /api/v1/tenant-packages/{id} | |
| DefaultApi | getTenantPackages | GET /api/v1/tenant-packages | |
| DefaultApi | getTenantUser | GET /api/v1/tenant-users/{id} | |
| DefaultApi | getTenantUsers | GET /api/v1/tenant-users | |
| DefaultApi | getTenants | GET /api/v1/tenants | |
| DefaultApi | getTicket | GET /api/v1/tickets/{id} | |
| DefaultApi | getTickets | GET /api/v1/tickets | |
| DefaultApi | getUser | GET /api/v1/users/{id} | |
| DefaultApi | getUserBadge | GET /api/v1/user-badges/{id} | |
| DefaultApi | getUserBadgeProgressById | GET /api/v1/user-badge-progress/{id} | |
| DefaultApi | getUserBadgeProgressByUserId | GET /api/v1/user-badge-progress/user/{userId} | |
| DefaultApi | getUserBadgeProgressList | GET /api/v1/user-badge-progress | |
| DefaultApi | getUserBadges | GET /api/v1/user-badges | |
| DefaultApi | getVotes | GET /api/v1/votes | |
| DefaultApi | getVotesForUser | GET /api/v1/votes/for-user | |
| DefaultApi | patchDomainConfig | PATCH /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | patchHashTag | PATCH /api/v1/hash-tags/{tag} | |
| DefaultApi | patchPage | PATCH /api/v1/pages/{id} | |
| DefaultApi | patchSSOUser | PATCH /api/v1/sso-users/{id} | |
| DefaultApi | putDomainConfig | PUT /api/v1/domain-configs/{domainToUpdate} | |
| DefaultApi | putSSOUser | PUT /api/v1/sso-users/{id} | |
| DefaultApi | renderEmailTemplate | POST /api/v1/email-templates/render | |
| DefaultApi | replaceTenantPackage | PUT /api/v1/tenant-packages/{id} | |
| DefaultApi | replaceTenantUser | PUT /api/v1/tenant-users/{id} | |
| DefaultApi | saveComment | POST /api/v1/comments | |
| DefaultApi | saveCommentsBulk | POST /api/v1/comments/bulk | |
| DefaultApi | sendInvite | POST /api/v1/moderators/{id}/send-invite | |
| DefaultApi | sendLoginLink | POST /api/v1/tenant-users/{id}/send-login-link | |
| DefaultApi | unBlockUserFromComment | POST /api/v1/comments/{id}/un-block | |
| DefaultApi | unFlagComment | POST /api/v1/comments/{id}/un-flag | |
| DefaultApi | updateComment | PATCH /api/v1/comments/{id} | |
| DefaultApi | updateEmailTemplate | PATCH /api/v1/email-templates/{id} | |
| DefaultApi | updateFeedPost | PATCH /api/v1/feed-posts/{id} | |
| DefaultApi | updateModerator | PATCH /api/v1/moderators/{id} | |
| DefaultApi | updateNotification | PATCH /api/v1/notifications/{id} | |
| DefaultApi | updateQuestionConfig | PATCH /api/v1/question-configs/{id} | |
| DefaultApi | updateQuestionResult | PATCH /api/v1/question-results/{id} | |
| DefaultApi | updateSubscription | PATCH /api/v1/subscriptions/{id} | |
| DefaultApi | updateTenant | PATCH /api/v1/tenants/{id} | |
| DefaultApi | updateTenantPackage | PATCH /api/v1/tenant-packages/{id} | |
| DefaultApi | updateTenantUser | PATCH /api/v1/tenant-users/{id} | |
| DefaultApi | updateUserBadge | PUT /api/v1/user-badges/{id} | |
| PublicApi | blockFromCommentPublic | POST /block-from-comment/{commentId} | |
| PublicApi | checkedCommentsForBlocked | GET /check-blocked-comments | |
| PublicApi | createCommentPublic | POST /comments/{tenantId} | |
| PublicApi | createFeedPostPublic | POST /feed-posts/{tenantId} | |
| PublicApi | deleteCommentPublic | DELETE /comments/{tenantId}/{commentId} | |
| PublicApi | deleteCommentVote | DELETE /comments/{tenantId}/{commentId}/vote/{voteId} | |
| PublicApi | deleteFeedPostPublic | DELETE /feed-posts/{tenantId}/{postId} | |
| PublicApi | flagCommentPublic | POST /flag-comment/{commentId} | |
| PublicApi | getCommentText | GET /comments/{tenantId}/{commentId}/text | |
| PublicApi | getCommentVoteUserNames | GET /comments/{tenantId}/{commentId}/votes | |
| PublicApi | getCommentsPublic | GET /comments/{tenantId} | req tenantId urlId |
| PublicApi | getEventLog | GET /event-log/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getFeedPostsPublic | GET /feed-posts/{tenantId} | req tenantId afterId |
| PublicApi | getFeedPostsStats | GET /feed-posts/{tenantId}/stats | |
| PublicApi | getGlobalEventLog | GET /event-log/global/{tenantId} | req tenantId urlId userIdWS |
| PublicApi | getUserNotificationCount | GET /user-notifications/get-count | |
| PublicApi | getUserNotifications | GET /user-notifications | |
| PublicApi | getUserPresenceStatuses | GET /user-presence-status | |
| PublicApi | getUserReactsPublic | GET /feed-posts/{tenantId}/user-reacts | |
| PublicApi | lockComment | POST /comments/{tenantId}/{commentId}/lock | |
| PublicApi | pinComment | POST /comments/{tenantId}/{commentId}/pin | |
| PublicApi | reactFeedPostPublic | POST /feed-posts/{tenantId}/react/{postId} | |
| PublicApi | resetUserNotificationCount | POST /user-notifications/reset-count | |
| PublicApi | resetUserNotifications | POST /user-notifications/reset | |
| PublicApi | searchUsers | GET /user-search/{tenantId} | |
| PublicApi | setCommentText | POST /comments/{tenantId}/{commentId}/update-text | |
| PublicApi | unBlockCommentPublic | DELETE /block-from-comment/{commentId} | |
| PublicApi | unLockComment | POST /comments/{tenantId}/{commentId}/unlock | |
| PublicApi | unPinComment | POST /comments/{tenantId}/{commentId}/unpin | |
| PublicApi | updateFeedPostPublic | PUT /feed-posts/{tenantId}/{postId} | |
| PublicApi | updateUserNotificationCommentSubscriptionStatus | POST /user-notifications/{notificationId}/mark-opted/{optedInOrOut} | Увімкнути або вимкнути сповіщення для конкретного коментаря. |
| PublicApi | updateUserNotificationPageSubscriptionStatus | POST /user-notifications/set-subscription-state/{subscribedOrUnsubscribed} | Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також |
| PublicApi | updateUserNotificationStatus | POST /user-notifications/{notificationId}/mark/{newStatus} | |
| PublicApi | uploadImage | POST /upload-image/{tenantId} | Завантаження та зміна розміру зображення |
| PublicApi | voteComment | POST /comments/{tenantId}/{commentId}/vote |
Документація для Моделей
- APIAuditLog
- APIComment
- APICommentBase
- APICommentBase_meta
- APICreateUserBadgeResponse
- APIDomainConfiguration
- APIEmptyResponse
- APIEmptySuccessResponse
- APIError
- APIGetCommentResponse
- APIGetCommentsResponse
- APIGetUserBadgeProgressListResponse
- APIGetUserBadgeProgressResponse
- APIGetUserBadgeResponse
- APIGetUserBadgesResponse
- APIPage
- APISSOUser
- APIStatus
- APITenant
- APITenantDailyUsage
- APITicket
- APITicketDetail
- APITicketFile
- APIUserSubscription
- AddDomainConfigParams
- AddDomainConfig_200_response
- AddDomainConfig_200_response_anyOf
- AddHashTag_200_response
- AddHashTagsBulk_200_response
- AddPageAPIResponse
- AddSSOUserAPIResponse
- AggregateQuestionResultsResponse
- AggregateQuestionResults_200_response
- AggregateTimeBucket
- AggregationItem
- AggregationOpType
- AggregationOperation
- AggregationRequest
- AggregationRequest_sort
- AggregationResponse
- AggregationResponse_stats
- AggregationValue
- BillingInfo
- BlockFromCommentParams
- BlockFromCommentPublic_200_response
- BlockSuccess
- BulkAggregateQuestionItem
- BulkAggregateQuestionResultsRequest
- BulkAggregateQuestionResultsResponse
- BulkAggregateQuestionResults_200_response
- BulkCreateHashTagsBody
- BulkCreateHashTagsBody_tags_inner
- BulkCreateHashTagsResponse
- ChangeCommentPinStatusResponse
- ChangeTicketStateBody
- ChangeTicketStateResponse
- ChangeTicketState_200_response
- CheckBlockedCommentsResponse
- CheckedCommentsForBlocked_200_response
- CombineCommentsWithQuestionResults_200_response
- CombineQuestionResultsWithCommentsResponse
- CommentData
- CommentHTMLRenderingMode
- CommentLogData
- CommentLogEntry
- CommentLogType
- CommentQuestionResultsRenderingType
- CommentQuestionsRequired
- CommentTextUpdateRequest
- CommentThreadDeletionMode
- CommentUserBadgeInfo
- CommentUserHashTagInfo
- CommentUserMentionInfo
- CommenterNameFormats
- CreateAPIPageData
- CreateAPISSOUserData
- CreateAPIUserSubscriptionData
- CreateCommentParams
- CreateCommentPublic_200_response
- CreateEmailTemplateBody
- CreateEmailTemplateResponse
- CreateEmailTemplate_200_response
- CreateFeedPostParams
- CreateFeedPostPublic_200_response
- CreateFeedPostResponse
- CreateFeedPost_200_response
- CreateFeedPostsResponse
- CreateHashTagBody
- CreateHashTagResponse
- CreateModeratorBody
- CreateModeratorResponse
- CreateModerator_200_response
- CreateQuestionConfigBody
- CreateQuestionConfigResponse
- CreateQuestionConfig_200_response
- CreateQuestionResultBody
- CreateQuestionResultResponse
- CreateQuestionResult_200_response
- CreateSubscriptionAPIResponse
- CreateTenantBody
- CreateTenantPackageBody
- CreateTenantPackageResponse
- CreateTenantPackage_200_response
- CreateTenantResponse
- CreateTenantUserBody
- CreateTenantUserResponse
- CreateTenantUser_200_response
- CreateTenant_200_response
- CreateTicketBody
- CreateTicketResponse
- CreateTicket_200_response
- CreateUserBadgeParams
- CreateUserBadge_200_response
- CustomConfigParameters
- CustomEmailTemplate
- DeleteCommentAction
- DeleteCommentPublic_200_response
- DeleteCommentResult
- DeleteCommentVote_200_response
- DeleteComment_200_response
- DeleteDomainConfig_200_response
- DeleteFeedPostPublic_200_response
- DeleteFeedPostPublic_200_response_anyOf
- DeleteHashTag_request
- DeletePageAPIResponse
- DeleteSSOUserAPIResponse
- DeleteSubscriptionAPIResponse
- DeletedCommentResultComment
- DigestEmailFrequency
- EmailTemplateDefinition
- EmailTemplateRenderErrorResponse
- EventLogEntry
- FComment
- FComment_meta
- FeedPost
- FeedPostLink
- FeedPostMediaItem
- FeedPostMediaItemAsset
- FeedPostStats
- FeedPostsStatsResponse
- FindCommentsByRangeItem
- FindCommentsByRangeResponse
- FlagCommentPublic_200_response
- FlagCommentResponse
- FlagComment_200_response
- GetAuditLogsResponse
- GetAuditLogs_200_response
- GetCachedNotificationCountResponse
- GetCachedNotificationCount_200_response
- GetCommentText_200_response
- GetCommentVoteUserNamesSuccessResponse
- GetCommentVoteUserNames_200_response
- GetComment_200_response
- GetCommentsPublic_200_response
- GetCommentsResponseWithPresence_PublicComment_
- GetCommentsResponse_PublicComment_
- GetComments_200_response
- GetDomainConfig_200_response
- GetDomainConfigs_200_response
- GetDomainConfigs_200_response_anyOf
- GetDomainConfigs_200_response_anyOf_1
- GetEmailTemplateDefinitionsResponse
- GetEmailTemplateDefinitions_200_response
- GetEmailTemplateRenderErrorsResponse
- GetEmailTemplateRenderErrors_200_response
- GetEmailTemplateResponse
- GetEmailTemplate_200_response
- GetEmailTemplatesResponse
- GetEmailTemplates_200_response
- GetEventLogResponse
- GetEventLog_200_response
- GetFeedPostsPublic_200_response
- GetFeedPostsResponse
- GetFeedPostsStats_200_response
- GetFeedPosts_200_response
- GetHashTagsResponse
- GetHashTags_200_response
- GetModeratorResponse
- GetModerator_200_response
- GetModeratorsResponse
- GetModerators_200_response
- GetMyNotificationsResponse
- GetNotificationCountResponse
- GetNotificationCount_200_response
- GetNotificationsResponse
- GetNotifications_200_response
- GetPageByURLIdAPIResponse
- GetPagesAPIResponse
- GetPendingWebhookEventCountResponse
- GetPendingWebhookEventCount_200_response
- GetPendingWebhookEventsResponse
- GetPendingWebhookEvents_200_response
- GetPublicFeedPostsResponse
- GetQuestionConfigResponse
- GetQuestionConfig_200_response
- GetQuestionConfigsResponse
- GetQuestionConfigs_200_response
- GetQuestionResultResponse
- GetQuestionResult_200_response
- GetQuestionResultsResponse
- GetQuestionResults_200_response
- GetSSOUserByEmailAPIResponse
- GetSSOUserByIdAPIResponse
- GetSSOUsers_200_response
- GetSubscriptionsAPIResponse
- GetTenantDailyUsagesResponse
- GetTenantDailyUsages_200_response
- GetTenantPackageResponse
- GetTenantPackage_200_response
- GetTenantPackagesResponse
- GetTenantPackages_200_response
- GetTenantResponse
- GetTenantUserResponse
- GetTenantUser_200_response
- GetTenantUsersResponse
- GetTenantUsers_200_response
- GetTenant_200_response
- GetTenantsResponse
- GetTenants_200_response
- GetTicketResponse
- GetTicket_200_response
- GetTicketsResponse
- GetTickets_200_response
- GetUserBadgeProgressById_200_response
- GetUserBadgeProgressList_200_response
- GetUserBadge_200_response
- GetUserBadges_200_response
- GetUserNotificationCountResponse
- GetUserNotificationCount_200_response
- GetUserNotifications_200_response
- GetUserPresenceStatusesResponse
- GetUserPresenceStatuses_200_response
- GetUserReactsPublic_200_response
- GetUserResponse
- GetUser_200_response
- GetVotesForUserResponse
- GetVotesForUser_200_response
- GetVotesResponse
- GetVotes_200_response
- GifRating
- HeaderAccountNotification
- HeaderState
- IgnoredResponse
- ImageContentProfanityLevel
- [
Агрегувати 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| aggregationRequest | AggregationRequest | Ні | |
| parentTenantId | string | Ні | |
| includeStats | bool | Ні |
Відповідь
Повертає: Option[AggregationResponse]
Приклад

Отримати журнали аудиту 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| limit | float64 | Ні | |
| skip | float64 | Ні | |
| order | SORTDIR | Ні | |
| after | float64 | Ні | |
| before | float64 | Ні |
Відповідь
Повертає: Option[GetAuditLogs_200_response]
Приклад

Заблокувати через публічний коментар 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ні | |
| sso | string | Ні |
Response
Повертає: Option[BlockFromCommentPublic_200_response]
Example

Розблокувати публічний коментар 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| publicBlockFromCommentParams | PublicBlockFromCommentParams | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[UnBlockCommentPublic_200_response]
Приклад

Перевірені коментарі на блокування 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentIds | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[CheckedCommentsForBlocked_200_response]
Приклад

Заблокувати користувача через коментар 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| blockFromCommentParams | BlockFromCommentParams | No | |
| userId | string | No | |
| anonUserId | string | No |
Відповідь
Повертає: Option[BlockFromCommentPublic_200_response]
Приклад

Створити публічний коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| broadcastId | string | No | |
| commentData | CommentData | No | |
| sessionId | string | No | |
| sso | string | No |
Відповідь
Повертає: Option[CreateCommentPublic_200_response]
Приклад

Видалити коментар 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| contextUserId | string | Ні | |
| isLive | bool | Ні |
Відповідь
Повертає: Option[DeleteComment_200_response]
Приклад

Видалити публічний коментар 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| broadcastId | string | Ні | |
| editKey | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[DeleteCommentPublic_200_response]
Приклад

Видалити голос за коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| voteId | string | Ні | |
| urlId | string | Так | |
| broadcastId | string | Ні | |
| editKey | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[DeleteCommentVote_200_response]
Приклад

Позначити коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| userId | string | No | |
| anonUserId | string | No |
Відповідь
Повертає: Option[FlagComment_200_response]
Приклад

Отримати коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Response
Повертає: Option[GetComment_200_response]
Приклад

Отримати коментарі 
Параметри
| Name | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| page | int | Ні | |
| limit | int | Ні | |
| skip | int | Ні | |
| asTree | bool | Ні | |
| skipChildren | int | Ні | |
| limitChildren | int | Ні | |
| maxTreeDepth | int | Ні | |
| urlId | string | Так | |
| userId | string | Ні | |
| anonUserId | string | Ні | |
| contextUserId | string | Ні | |
| hashTag | string | Ні | |
| parentId | string | Ні | |
| direction | SortDirections | Ні |
Відповідь
Повертає: Option[GetComments_200_response]
Приклад

Отримати публічні коментарі 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так | |
| page | int | Ні | |
| direction | SortDirections | Ні | |
| sso | string | Ні | |
| skip | int | Ні | |
| skipChildren | int | Ні | |
| limit | int | Ні | |
| limitChildren | int | Ні | |
| countChildren | bool | Ні | |
| fetchPageForCommentId | string | Ні | |
| includeConfig | bool | Ні | |
| countAll | bool | Ні | |
| includei10n | bool | Ні | |
| locale | string | Ні | |
| modules | string | Ні | |
| isCrawler | bool | Ні | |
| includeNotificationCount | bool | Ні | |
| asTree | bool | Ні | |
| maxTreeDepth | int | Ні | |
| useFullTranslationIds | bool | Ні | |
| parentId | string | Ні | |
| searchText | string | Ні | |
| hashTags | seq[string] | Ні | |
| userId | string | Ні | |
| customConfigStr | string | Ні | |
| afterCommentId | string | Ні | |
| beforeCommentId | string | Ні |
Відповідь
Повертає: Option[GetCommentsPublic_200_response]
Приклад

Отримати текст коментаря 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| editKey | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[GetCommentText_200_response]
Приклад

Отримати імена користувачів, що голосували за коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| commentId | string | Yes | |
| dir | int | No | |
| sso | string | No |
Відповідь
Повертає: Option[GetCommentVoteUserNames_200_response]
Приклад

Заблокувати коментар 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[LockComment_200_response]
Приклад

Закріпити коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[PinComment_200_response]
Приклад

Зберегти коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createCommentParams | CreateCommentParams | Ні | |
| isLive | bool | Ні | |
| doSpamCheck | bool | Ні | |
| sendEmails | bool | Ні | |
| populateNotifications | bool | Ні |
Відповідь
Повертає: Option[SaveComment_200_response]
Приклад

Масове збереження коментарів 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| createCommentParams | seq[CreateCommentParams] | No | |
| isLive | bool | No | |
| doSpamCheck | bool | No | |
| sendEmails | bool | No | |
| populateNotifications | bool): (Option[seq[SaveComment_200_response]] | No | |
| id | string | No | |
| unBlockFromCommentParams | UnBlockFromCommentParams | No | |
| userId | string | No | |
| anonUserId | string | No |
Відповідь
Повертає: Option[UnBlockCommentPublic_200_response]
Приклад

Встановити текст коментаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| broadcastId | string | Ні | |
| commentTextUpdateRequest | CommentTextUpdateRequest | Ні | |
| editKey | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[SetCommentText_200_response]
Приклад

Розблокувати користувача через коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| unBlockFromCommentParams | UnBlockFromCommentParams | Ні | |
| userId | string | Ні | |
| anonUserId | string | Ні |
Відповідь
Повертає: Option[UnBlockCommentPublic_200_response]
Приклад

Зняти позначку з коментаря 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| userId | string | Ні | |
| anonUserId | string | Ні |
Відповідь
Повертає: Option[FlagComment_200_response]
Приклад

Розблокувати коментар 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[LockComment_200_response]
Приклад

Відкріпити коментар 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[PinComment_200_response]
Приклад

Оновити коментар 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updatableCommentParams | UpdatableCommentParams | Ні | |
| contextUserId | string | Ні | |
| doSpamCheck | bool | Ні | |
| isLive | bool | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Проголосувати за коментар 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| urlId | string | Так | |
| broadcastId | string | Ні | |
| voteBodyParams | VoteBodyParams | Ні | |
| sessionId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[VoteComment_200_response]
Приклад

Додати конфігурацію домену 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| addDomainConfigParams | AddDomainConfigParams | Ні |
Відповідь
Повертає: Option[AddDomainConfig_200_response]
Приклад

Видалити конфігурацію домену 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| domain | string | Ні |
Відповідь
Повертає: Option[DeleteDomainConfig_200_response]
Приклад

Отримати конфігурацію домену 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| domain | string | Ні |
Відповідь
Повертає: Option[GetDomainConfig_200_response]
Приклад

Отримати конфігурації доменів 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так |
Відповідь
Повертає: Option[GetDomainConfigs_200_response]
Приклад

Часткове оновлення конфігурації домену 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| domainToUpdate | string | Ні | |
| patchDomainConfigParams | PatchDomainConfigParams | Ні |
Відповідь
Повертає: Option[GetDomainConfig_200_response]
Приклад

Повне оновлення конфігурації домену 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| domainToUpdate | string | Ні | |
| updateDomainConfigParams | UpdateDomainConfigParams | Ні |
Відповідь
Повертає: Option[GetDomainConfig_200_response]
Приклад

Створити шаблон електронного листа 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createEmailTemplateBody | CreateEmailTemplateBody | Ні |
Відповідь
Повертає: Option[CreateEmailTemplate_200_response]
Приклад

Видалити шаблон електронного листа 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Видалити помилку рендерингу шаблону електронного листа 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| errorId | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати шаблон електронного листа 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetEmailTemplate_200_response]
Приклад

Отримати визначення шаблонів електронних листів 
Параметри
| Ім'я | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так |
Відповідь
Повертає: Option[GetEmailTemplateDefinitions_200_response]
Приклад

Отримати помилки рендерингу шаблонів електронних листів 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetEmailTemplateRenderErrors_200_response]
Приклад

Отримати шаблони електронних листів 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetEmailTemplates_200_response]
Приклад

Згенерувати шаблон електронного листа 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| renderEmailTemplateBody | RenderEmailTemplateBody | Ні | |
| locale | string | Ні |
Відповідь
Повертає: Option[RenderEmailTemplate_200_response]
Приклад

Оновити шаблон електронного листа 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateEmailTemplateBody | UpdateEmailTemplateBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати журнал подій 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так | |
| userIdWS | string | Ні | |
| startTime | int64 | Ні | |
| endTime | int64 | Ні |
Відповідь
Повертає: Option[GetEventLog_200_response]
Приклад

Отримати глобальний журнал подій 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так | |
| userIdWS | string | Ні | |
| startTime | int64 | Ні | |
| endTime | int64 | Ні |
Відповідь
Повертає: Option[GetEventLog_200_response]
Приклад

Створити запис стрічки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createFeedPostParams | CreateFeedPostParams | Ні | |
| broadcastId | string | Ні | |
| isLive | bool | Ні | |
| doSpamCheck | bool | Ні | |
| skipDupCheck | bool | Ні |
Відповідь
Повертає: Option[CreateFeedPost_200_response]
Приклад

Створити публічний запис стрічки 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| createFeedPostParams | CreateFeedPostParams | Ні | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[CreateFeedPostPublic_200_response]
Приклад

Видалити публічний запис стрічки 
Parameters
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| postId | string | No | |
| broadcastId | string | No | |
| sso | string | No |
Відповідь
Повертає: Option[DeleteFeedPostPublic_200_response]
Приклад

Отримати записи стрічки 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| afterId | string | No | |
| limit | int | No | |
| tags | seq[string] | No |
Відповідь
Повертає: Option[GetFeedPosts_200_response]
Приклад

Отримати публічні записи стрічки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| afterId | string | Ні | |
| limit | int | Ні | |
| tags | seq[string] | Ні | |
| sso | string | Ні | |
| isCrawler | bool | Ні | |
| includeUserInfo | bool | Ні |
Відповідь
Повертає: Option[GetFeedPostsPublic_200_response]
Приклад

Отримати статистику записів стрічки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| postIds | seq[string] | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[GetFeedPostsStats_200_response]
Приклад

Отримати публічні реакції користувача 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| postIds | seq[string] | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[GetUserReactsPublic_200_response]
Приклад

Зареагувати на публічний запис стрічки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| postId | string | Ні | |
| reactBodyParams | ReactBodyParams | Ні | |
| isUndo | bool | Ні | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[ReactFeedPostPublic_200_response]
Приклад

Оновити запис стрічки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| feedPost | FeedPost | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Оновити публічний запис стрічки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| postId | string | Ні | |
| updateFeedPostParams | UpdateFeedPostParams | Ні | |
| broadcastId | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[CreateFeedPostPublic_200_response]
Приклад

Позначити публічний коментар 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| isFlagged | bool | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Додати хештег 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createHashTagBody | CreateHashTagBody | Ні |
Відповідь
Повертає: Option[AddHashTag_200_response]
Приклад

Масове додавання хештегів 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| bulkCreateHashTagsBody | BulkCreateHashTagsBody | Ні |
Відповідь
Повертає: Option[AddHashTagsBulk_200_response]
Приклад

Видалити хештег 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tag | string | Ні | |
| tenantId | string | Так | |
| deleteHashTagRequest | DeleteHashTagRequest | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати хештеги 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| page | float64 | Ні |
Відповідь
Повертає: Option[GetHashTags_200_response]
Приклад

Часткове оновлення хештегу 
Параметри
| Ім'я | Тип | Обов'язково | Опис |
|---|---|---|---|
| tag | string | Ні | |
| tenantId | string | Так | |
| updateHashTagBody | UpdateHashTagBody | Ні |
Відповідь
Повертає: Option[PatchHashTag_200_response]
Приклад

Створити модератора 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createModeratorBody | CreateModeratorBody | Ні |
Відповідь
Повертає: Option[CreateModerator_200_response]
Приклад

Видалити модератора 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| sendEmail | string | No |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати модератора 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetModerator_200_response]
Приклад

Отримати модераторів 
Параметри
| Name | Type | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetModerators_200_response]
Приклад

Оновити модератора 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateModeratorBody | UpdateModeratorBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Видалити лічильник сповіщень 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати кешований лічильник сповіщень 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetCachedNotificationCount_200_response]
Приклад

Отримати кількість сповіщень 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні | |
| urlId | string | Так | |
| fromCommentId | string | Ні | |
| viewed | bool | Ні |
Відповідь
Повертає: Option[GetNotificationCount_200_response]
Приклад

Отримати сповіщення 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні | |
| urlId | string | Так | |
| fromCommentId | string | Ні | |
| viewed | bool | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetNotifications_200_response]
Приклад

Оновити сповіщення 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateNotificationBody | UpdateNotificationBody | Ні | |
| userId | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Додати сторінку 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createAPIPageData | CreateAPIPageData | Ні |
Відповідь
Повертає: Option[AddPageAPIResponse]
Приклад

Видалити сторінку 
Parameters
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[DeletePageAPIResponse]
Приклад

Отримати сторінку за URL-ідентифікатором 
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так |
Відповідь
Повертає: Option[GetPageByURLIdAPIResponse]
Приклад

Отримати сторінки 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так |
Відповідь
Повертає: Option[GetPagesAPIResponse]
Приклад

Часткове оновлення сторінки 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateAPIPageData | UpdateAPIPageData | Ні |
Відповідь
Повертає: Option[PatchPageAPIResponse]
Приклад

Видалити очікувану подію вебхука 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати кількість очікуваних подій вебхука 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| externalId | string | Ні | |
| eventType | string | Ні | |
| domain | string | Ні | |
| attemptCountGT | float64 | Ні |
Відповідь
Повертає: Option[GetPendingWebhookEventCount_200_response]
Приклад

Отримати очікувані події вебхука 
Параметри
| Назва | Type | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| externalId | string | Ні | |
| eventType | string | Ні | |
| domain | string | Ні | |
| attemptCountGT | float64 | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetPendingWebhookEvents_200_response]
Приклад

Створити конфігурацію запитання 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createQuestionConfigBody | CreateQuestionConfigBody | Ні |
Відповідь
Повертає: Option[CreateQuestionConfig_200_response]
Приклад

Видалити конфігурацію запитання 
Параметри
| Ім'я | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати конфігурацію запитання 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetQuestionConfig_200_response]
Приклад

Отримати конфігурації запитань 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetQuestionConfigs_200_response]
Приклад

Оновити конфігурацію запитання 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateQuestionConfigBody | UpdateQuestionConfigBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Створити результат запитання 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createQuestionResultBody | CreateQuestionResultBody | Ні |
Відповідь
Повертає: Option[CreateQuestionResult_200_response]
Приклад

Видалити результат запитання 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати результат запитання 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetQuestionResult_200_response]
Приклад

Отримати результати запитань 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так | |
| userId | string | Ні | |
| startDate | string | Ні | |
| questionId | string | Ні | |
| questionIds | string | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetQuestionResults_200_response]
Приклад

Оновити результат запитання 
Параметри
| Назва | Type | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateQuestionResultBody | UpdateQuestionResultBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Агрегувати результати запитань 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| questionId | string | Ні | |
| questionIds | seq[string] | Ні | |
| urlId | string | Так | |
| timeBucket | AggregateTimeBucket | Ні | |
| startDate | string | Ні | |
| forceRecalculate | bool | Ні |
Відповідь
Повертає: Option[AggregateQuestionResults_200_response]
Приклад

Масова агрегація результатів запитань 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| bulkAggregateQuestionResultsRequest | BulkAggregateQuestionResultsRequest | Ні | |
| forceRecalculate | bool | Ні |
Відповідь
Повертає: Option[BulkAggregateQuestionResults_200_response]
Приклад

Поєднати коментарі з результатами запитань 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| questionId | string | Ні | |
| questionIds | seq[string] | Ні | |
| urlId | string | Так | |
| startDate | string | Ні | |
| forceRecalculate | bool | Ні | |
| minValue | float64 | Ні | |
| maxValue | float64 | Ні | |
| limit | float64 | Ні |
Відповідь
Повертає: Option[CombineCommentsWithQuestionResults_200_response]
Приклад

Додати SSO-користувача 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| createAPISSOUserData | CreateAPISSOUserData | Ні |
Відповідь
Повертає: Option[AddSSOUserAPIResponse]
Приклад

Видалити SSO-користувача 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| deleteComments | bool | Ні | |
| commentDeleteMode | string | Ні |
Відповідь
Повертає: Option[DeleteSSOUserAPIResponse]
Приклад

Отримати SSO-користувача за електронною поштою 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| string | Ні |
Відповідь
Повертає: Option[GetSSOUserByEmailAPIResponse]
Приклад

Отримати SSO-користувача за ідентифікатором 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No |
Відповідь
Повертає: Option[GetSSOUserByIdAPIResponse]
Приклад

Отримати SSO-користувачів 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| skip | int | Ні |
Відповідь
Повертає: Option[GetSSOUsers_200_response]
Приклад

Часткове оновлення SSO-користувача 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateAPISSOUserData | UpdateAPISSOUserData | Ні | |
| updateComments | bool | Ні |
Відповідь
Повертає: Option[PatchSSOUserAPIResponse]
Приклад

Повне оновлення SSO-користувача 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateAPISSOUserData | UpdateAPISSOUserData | Ні | |
| updateComments | bool | Ні |
Відповідь
Повертає: Option[PutSSOUserAPIResponse]
Приклад

Створити підписку 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createAPIUserSubscriptionData | CreateAPIUserSubscriptionData | Ні |
Відповідь
Повертає: Option[CreateSubscriptionAPIResponse]
Приклад

Видалити підписку 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| userId | string | No |
Відповідь
Повертає: Option[DeleteSubscriptionAPIResponse]
Приклад

Отримати підписки 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні |
Відповідь
Повертає: Option[GetSubscriptionsAPIResponse]
Приклад

Оновити підписку 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateAPIUserSubscriptionData | UpdateAPIUserSubscriptionData | Ні | |
| userId | string | Ні |
Відповідь
Повертає: Option[UpdateSubscriptionAPIResponse]
Приклад

Отримати щоденне використання орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| yearNumber | float64 | Ні | |
| monthNumber | float64 | Ні | |
| dayNumber | float64 | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetTenantDailyUsages_200_response]
Приклад

Створити пакет орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createTenantPackageBody | CreateTenantPackageBody | Ні |
Відповідь
Повертає: Option[CreateTenantPackage_200_response]
Приклад

Видалити пакет орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати пакет орендаря 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetTenantPackage_200_response]
Приклад

Отримати пакети орендарів 
Параметри
| Назва | Type | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetTenantPackages_200_response]
Приклад

Замінити пакет орендаря 
Параметри
| Назва | Type | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| replaceTenantPackageBody | ReplaceTenantPackageBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Оновити пакет орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateTenantPackageBody | UpdateTenantPackageBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Створити користувача орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createTenantUserBody | CreateTenantUserBody | Ні |
Відповідь
Повертає: Option[CreateTenantUser_200_response]
Приклад

Видалити користувача орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| deleteComments | string | Ні | |
| commentDeleteMode | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати користувача орендаря 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetTenantUser_200_response]
Приклад

Отримати користувачів орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetTenantUsers_200_response]
Приклад

Замінити користувача орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| replaceTenantUserBody | ReplaceTenantUserBody | Ні | |
| updateComments | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Надіслати посилання для входу 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| redirectURL | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Оновити користувача орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateTenantUserBody | UpdateTenantUserBody | Ні | |
| updateComments | string | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Створити орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createTenantBody | CreateTenantBody | Ні |
Відповідь
Повертає: Option[CreateTenant_200_response]
Приклад

Видалити орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| id | string | No | |
| sure | string | No |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Отримати орендаря 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetTenant_200_response]
Приклад

Отримати орендарів 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| meta | string | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetTenants_200_response]
Приклад

Оновити орендаря 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateTenantBody | UpdateTenantBody | Ні |
Відповідь
Повертає: Option[FlagCommentPublic_200_response]
Приклад

Змінити стан тікета 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні | |
| id | string | Ні | |
| changeTicketStateBody | ChangeTicketStateBody | Ні |
Відповідь
Повертає: Option[ChangeTicketState_200_response]
Приклад

Створити тікет 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні | |
| createTicketBody | CreateTicketBody | Ні |
Відповідь
Повертає: Option[CreateTicket_200_response]
Приклад

Отримати тікет 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| userId | string | Ні |
Відповідь
Повертає: Option[GetTicket_200_response]
Приклад

Отримати тікети 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| userId | string | No | |
| state | float64 | No | |
| skip | float64 | No | |
| limit | float64 | No |
Відповідь
Повертає: Option[GetTickets_200_response]
Приклад

Завантажити зображення 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| file | string | Ні | |
| sizePreset | SizePreset | Ні | |
| urlId | string | Так |
Відповідь
Повертає: Option[UploadImageResponse]
Приклад

Отримати прогрес бейджа користувача за ідентифікатором 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetUserBadgeProgressById_200_response]
Приклад

Отримати прогрес бейджа користувача за ID користувача 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні |
Відповідь
Повертає: Option[GetUserBadgeProgressById_200_response]
Приклад

Отримати список прогресу бейджів користувача 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| userId | string | No | |
| limit | float64 | No | |
| skip | float64 | No |
Відповідь
Повертає: Option[GetUserBadgeProgressList_200_response]
Приклад

Створити бейдж користувача 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| createUserBadgeParams | CreateUserBadgeParams | Ні |
Відповідь
Повертає: Option[CreateUserBadge_200_response]
Приклад

Видалити бейдж користувача 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[UpdateUserBadge_200_response]
Приклад

Отримати бейдж користувача 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetUserBadge_200_response]
Приклад

Отримати бейджі користувача 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| userId | string | Ні | |
| badgeId | string | Ні | |
| displayedOnComments | bool | Ні | |
| limit | float64 | Ні | |
| skip | float64 | Ні |
Відповідь
Повертає: Option[GetUserBadges_200_response]
Приклад

Оновити бейдж користувача 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| updateUserBadgeParams | UpdateUserBadgeParams | Ні |
Відповідь
Повертає: Option[UpdateUserBadge_200_response]
Приклад

Отримати кількість сповіщень користувача 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| sso | string | Ні |
Відповідь
Повертає: Option[GetUserNotificationCount_200_response]
Приклад

Отримати сповіщення користувача 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| pageSize | int | Ні | |
| afterId | string | Ні | |
| includeContext | bool | Ні | |
| afterCreatedAt | int64 | Ні | |
| unreadOnly | bool | Ні | |
| dmOnly | bool | Ні | |
| noDm | bool | Ні | |
| includeTranslations | bool | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[GetUserNotifications_200_response]
Приклад

Скинути лічильник сповіщень користувача 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| sso | string | Ні |
Відповідь
Повертає: Option[ResetUserNotifications_200_response]
Приклад

Скинути сповіщення користувача 
Параметри
| Name | Type | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| afterId | string | Ні | |
| afterCreatedAt | int64 | Ні | |
| unreadOnly | bool | Ні | |
| dmOnly | bool | Ні | |
| noDm | bool | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[ResetUserNotifications_200_response]
Приклад

Оновити статус підписки користувача на коментарі 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| notificationId | string | Ні | |
| optedInOrOut | string | Ні | |
| commentId | string | Так | |
| sso | string | Ні |
Відповідь
Повертає: Option[UpdateUserNotificationStatus_200_response]
Приклад

Оновити статус підписки користувача на сторінки 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так | |
| url | string | Ні | |
| pageTitle | string | Ні | |
| subscribedOrUnsubscribed | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[UpdateUserNotificationStatus_200_response]
Приклад

Оновити статус сповіщення користувача 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| notificationId | string | Ні | |
| newStatus | string | Ні | |
| sso | string | Ні |
Відповідь
Повертає: Option[UpdateUserNotificationStatus_200_response]
Приклад

Отримати статуси присутності користувачів 
Параметри
| Name | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Так | |
| urlIdWS | string | Ні | |
| userIds | string | Ні |
Відповідь
Повертає: Option[GetUserPresenceStatuses_200_response]
Приклад

Пошук користувачів 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Yes | |
| urlId | string | Yes | |
| usernameStartsWith | string | No | |
| mentionGroupIds | seq[string] | No | |
| sso | string | No | |
| searchSection | string | No |
Відповідь
Повертає: Option[SearchUsers_200_response]
Приклад

Отримати користувача 
Параметри
| Назва | Тип | Обов'язковий | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні |
Відповідь
Повертає: Option[GetUser_200_response]
Приклад

Створити голос 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| commentId | string | Так | |
| direction | string | Ні | |
| userId | string | Ні | |
| anonUserId | string | Ні |
Відповідь
Повертає: Option[VoteComment_200_response]
Приклад

Видалити голос 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| id | string | Ні | |
| editKey | string | Ні |
Відповідь
Повертає: Option[DeleteCommentVote_200_response]
Приклад

Отримати голоси 
Параметри
| Назва | Тип | Обов'язково | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так |
Відповідь
Повертає: Option[GetVotes_200_response]
Приклад

Отримати голоси користувача 
Параметри
| Назва | Тип | Обов'язкове | Опис |
|---|---|---|---|
| tenantId | string | Так | |
| urlId | string | Так | |
| userId | string | Ні | |
| anonUserId | string | Ні |
Відповідь
Повертає: Option[GetVotesForUser_200_response]
Приклад

Потрібна допомога?
Якщо ви зіткнулися з проблемами або маєте запитання щодо Nim SDK, будь ласка:
Участь у проєкті
Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для інструкцій щодо внеску.