
Язык 🇷🇺 Русский
Начало работы
Документация
Справочник API
Агрегация
Журналы аудита
Блокировка по комментарию
Проверка заблокированных комментариев
Комментарии
Конфигурации домена
Шаблоны писем
Журнал событий
Посты ленты
Пометка комментария
Хэштеги
Модераторы
Количество уведомлений
Уведомления
Страницы
Ожидающие события вебхука
Конфигурации вопросов
Результаты вопросов
Агрегация результатов вопросов
Пользователи SSO
Подписки
Ежедневное использование тенанта
Пакеты тенанта
Пользователи тенанта
Тенанты
Тикеты
Загрузка изображения
Прогресс значков пользователя
Значки пользователей
Уведомления пользователя
Статусы присутствия пользователя
Поиск пользователей
Пользователи
Голоса
FastComments Swift SDK
Это официальный Swift SDK для FastComments.
Официальный Swift SDK для API FastComments
Репозиторий
Установка 
Менеджер пакетов Swift
Добавьте следующее в ваш файл Package.swift:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "1.2.1")
]
Или в Xcode:
- File > Add Packages...
- Введите URL репозитория:
https://github.com/fastcomments/fastcomments-swift.git - Выберите версию, которую хотите использовать
Требования
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Содержимое библиотеки 
The FastComments Swift SDK состоит из нескольких модулей:
Client Module - Автогенерируемый клиент API для FastComments REST APIs
- Полные определения типов для всех моделей API
- Как аутентифицированные (
DefaultAPI), так и публичные (PublicAPI) эндпоинты - Полная поддержка async/await
- См. client/README.md для подробной документации по API
SSO Module - Утилиты Single Sign-On на стороне сервера
- Безопасная генерация токенов для аутентификации пользователей
- Поддержка как простого, так и защищённого режимов SSO
- Подпись токенов на основе HMAC-SHA256 с использованием CryptoKit
Быстрый старт 
Использование публичного API
import FastCommentsSwift
// Создать клиент API
let publicApi = PublicAPI()
// Получить комментарии для страницы
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Использование аутентифицированного API
import FastCommentsSwift
// Создать конфигурацию с API-ключом
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Получить комментарии с использованием аутентифицированного API
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
Использование SSO для аутентификации
Защищённый SSO (рекомендуется для продакшн-среды)
import FastCommentsSwift
let apiKey = "your-api-key"
// Создать данные пользователя для защищённого SSO (только на стороне сервера!)
let userData = SecureSSOUserData(
id: "user-123", // Идентификатор пользователя
email: "user@example.com", // Электронная почта
username: "johndoe", // Имя пользователя
avatar: "https://example.com/avatar.jpg" // URL аватара
)
// Сгенерировать SSO токен
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Передайте этот токен на фронтенд для аутентификации
} catch {
print("Error creating SSO token: \(error)")
}
Простой SSO (для разработки/тестирования)
import FastCommentsSwift
// Создать данные пользователя для простого SSO (API-ключ не требуется)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Сгенерировать простой SSO токен
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Публичные и защищённые API 
The FastComments SDK предоставляет два типа конечных точек API:
PublicAPI - Конечные точки, безопасные для клиентского кода
The PublicAPI contains endpoints that are safe to call from client-side code (iOS/macOS apps). These endpoints:
- Не требуют API-ключа
- Могут использовать SSO-токены для аутентификации
- Лимитируются по пользователю/устройству
- Подходят для приложений, ориентированных на конечного пользователя
Пример использования: Получение и создание комментариев в вашем iOS-приложении
DefaultAPI - Серверные конечные точки
The DefaultAPI contains authenticated endpoints that require an API key. These endpoints:
- Требуют ваш API-ключ FastComments
- Должны вызываться ТОЛЬКО из серверного кода
- Обеспечивают полный доступ к данным FastComments
- Лимитируются по тенанту
Пример использования: административные операции, массовый экспорт данных, инструменты модерации
ВАЖНО: Никогда не раскрывайте ваш API-ключ в клиентском коде. API-ключи должны использоваться только на сервере.
Выполнение запросов к API 
Swift SDK использует современный синтаксис async/await для всех вызовов API:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Распространённые проблемы 
401 Unauthorized Errors
Если вы получаете ошибки 401 при использовании аутентифицированного API:
- Проверьте ваш API key: Убедитесь, что вы используете правильный API key из панели управления FastComments
- Проверьте tenant ID: Убедитесь, что tenant ID соответствует вашей учетной записи
- API key format: API key должен быть установлен на API client:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Использование неправильного API: Убедитесь, что вы используете
DefaultAPI(а неPublicAPI) для аутентифицированных вызовов
SSO Token Issues
Если SSO-токены не работают:
- Используйте secure режим для production: Всегда используйте
FastCommentsSSO.createSecure()с вашим API key в production - Только на стороне сервера: Генерируйте secure SSO-токены на вашем сервере, никогда не раскрывайте ваш API key клиентам
- Проверьте данные пользователя: Убедитесь, что все обязательные поля (id, email, username) предоставлены
- Истечение токена: Защищённые SSO-токены содержат метку времени и могут истечь. Генерируйте новые токены по мере необходимости.
SSL/TLS Errors
Если вы сталкиваетесь с ошибками SSL/TLS:
- Убедитесь, что Info.plist вашего приложения позволяет HTTPS-подключения к fastcomments.com
- Проверьте, что вы не используете исключения App Transport Security, которые могут блокировать подключение
Примечания 
Идентификаторы трансляций
Вы увидите, что в некоторых вызовах API нужно передавать broadcastId. Когда вы получаете события, вы получите этот идентификатор обратно, поэтому вы сможете игнорировать событие, если планируете оптимистично применить изменения на клиенте (что, вероятно, стоит сделать, поскольку это обеспечивает наилучший опыт). Передайте здесь UUID. Идентификатор должен быть достаточно уникальным, чтобы не повториться дважды в одной сессии.
let broadcastId = UUID().uuidString
aggregate 
Агрегирует документы путем их группировки (если предоставлен groupBy) и применения нескольких операций. Поддерживаются разные операции (например sum, countDistinct, avg и т.д.).
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| parentTenantId | string | query | Нет | |
| includeStats | boolean | query | Нет |
Ответ
Возвращает: AggregationResponse
Пример

getAuditLogs 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| limit | number | query | Нет | |
| skip | number | query | Нет | |
| order | string | query | Нет | |
| after | number | query | Нет | |
| before | number | query | Нет |
Ответ
Возвращает: GetAuditLogs200Response
Пример

blockFromCommentPublic 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: BlockFromCommentPublic200Response
Пример

unBlockCommentPublic 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UnBlockCommentPublic200Response
Пример

checkedCommentsForBlocked 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Список идентификаторов комментариев, разделённых запятыми. |
| sso | string | query | Нет |
Ответ
Возвращает: CheckedCommentsForBlocked200Response
Пример

blockUserFromComment 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: BlockFromCommentPublic200Response
Пример

createCommentPublic 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: CreateCommentPublic200Response
Пример

deleteComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| contextUserId | string | query | Нет | |
| isLive | boolean | query | Нет |
Ответ
Возвращает: DeleteComment200Response
Пример

deleteCommentPublic 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: DeleteCommentPublic200Response
Пример

deleteCommentVote 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| voteId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: DeleteCommentVote200Response
Пример

flagComment 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: FlagComment200Response
Пример

getComment 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetComment200Response
Пример

getComments 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | integer | query | Нет | |
| limit | integer | query | Нет | |
| skip | integer | query | Нет | |
| asTree | boolean | query | Нет | |
| skipChildren | integer | query | Нет | |
| limitChildren | integer | query | Нет | |
| maxTreeDepth | integer | query | Нет | |
| urlId | string | query | Нет | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет | |
| contextUserId | string | query | Нет | |
| hashTag | string | query | Нет | |
| parentId | string | query | Нет | |
| direction | string | query | Нет |
Ответ
Возвращает: GetComments200Response
Пример

getCommentsPublic 
req tenantId urlId
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| page | integer | query | Нет | |
| direction | string | query | Нет | |
| sso | string | query | Нет | |
| skip | integer | query | Нет | |
| skipChildren | integer | query | Нет | |
| limit | integer | query | Нет | |
| limitChildren | integer | query | Нет | |
| countChildren | boolean | query | Нет | |
| fetchPageForCommentId | string | query | Нет | |
| includeConfig | boolean | query | Нет | |
| countAll | boolean | query | Нет | |
| includei10n | boolean | query | Нет | |
| locale | string | query | Нет | |
| modules | string | query | Нет | |
| isCrawler | boolean | query | Нет | |
| includeNotificationCount | boolean | query | Нет | |
| asTree | boolean | query | Нет | |
| maxTreeDepth | integer | query | Нет | |
| useFullTranslationIds | boolean | query | Нет | |
| parentId | string | query | Нет | |
| searchText | string | query | Нет | |
| hashTags | array | query | Нет | |
| userId | string | query | Нет | |
| customConfigStr | string | query | Нет | |
| afterCommentId | string | query | Нет | |
| beforeCommentId | string | query | Нет |
Ответ
Возвращает: GetCommentsPublic200Response
Пример

getCommentText 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Ответ
Возвращает: GetCommentText200Response
Пример

getCommentVoteUserNames 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| dir | integer | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetCommentVoteUserNames200Response
Пример

lockComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: LockComment200Response
Пример

pinComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: PinComment200Response
Пример

saveComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Нет | |
| doSpamCheck | boolean | query | Нет | |
| sendEmails | boolean | query | Нет | |
| populateNotifications | boolean | query | Нет |
Ответ
Возвращает: SaveComment200Response
Пример

saveCommentsBulk 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Нет | |
| doSpamCheck | boolean | query | Нет | |
| sendEmails | boolean | query | Нет | |
| populateNotifications | boolean | query | Нет |
Ответ
Возвращает: [SaveComment200Response]
Пример

setCommentText 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: SetCommentText200Response
Пример

unBlockUserFromComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: UnBlockCommentPublic200Response
Пример

unFlagComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: FlagComment200Response
Пример

unLockComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Ответ
Возвращает: LockComment200Response
Пример

unPinComment 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: PinComment200Response
Пример

updateComment 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| contextUserId | string | query | Нет | |
| doSpamCheck | boolean | query | Нет | |
| isLive | boolean | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

voteComment 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: VoteComment200Response
Пример

addDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: AddDomainConfig200Response
Пример

deleteDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Ответ
Возвращает: DeleteDomainConfig200Response
Пример

getDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Ответ
Возвращает: GetDomainConfig200Response
Пример

getDomainConfigs 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetDomainConfigs200Response
Пример

patchDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Ответ
Возвращает: GetDomainConfig200Response
Пример

putDomainConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Ответ
Возвращает: GetDomainConfig200Response
Пример

createEmailTemplate 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateEmailTemplate200Response
Пример

deleteEmailTemplate 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

deleteEmailTemplateRenderError 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| errorId | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getEmailTemplate 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetEmailTemplate200Response
Пример

getEmailTemplateDefinitions 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetEmailTemplateDefinitions200Response
Пример

getEmailTemplateRenderErrors 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetEmailTemplateRenderErrors200Response
Пример

getEmailTemplates 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Response
Возвращает: GetEmailTemplates200Response
Пример

renderEmailTemplate 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| locale | string | query | Нет |
Ответ
Возвращает: RenderEmailTemplate200Response
Пример

updateEmailTemplate 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getEventLog 
req tenantId urlId userIdWS
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Да |
Ответ
Возвращает: GetEventLog200Response
Пример

getGlobalEventLog 
req tenantId urlId userIdWS
Параметры
| Имя | Тип | Местоположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| userIdWS | string | query | Да | |
| startTime | integer | query | Да | |
| endTime | integer | query | Да |
Ответ
Возвращает: GetEventLog200Response
Пример

createFeedPost 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| broadcastId | string | query | Нет | |
| isLive | boolean | query | Нет | |
| doSpamCheck | boolean | query | Нет | |
| skipDupCheck | boolean | query | Нет |
Ответ
Возвращает: CreateFeedPost200Response
Пример

createFeedPostPublic 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: CreateFeedPostPublic200Response
Пример

deleteFeedPostPublic 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: DeleteFeedPostPublic200Response
Пример

getFeedPosts 
req tenantId afterId
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Нет | |
| limit | integer | query | Нет | |
| tags | array | query | Нет |
Ответ
Возвращает: GetFeedPosts200Response
Пример

getFeedPostsPublic 
req tenantId afterId
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| afterId | string | query | No | |
| limit | integer | query | No | |
| tags | array | query | No | |
| sso | string | query | No | |
| isCrawler | boolean | query | No | |
| includeUserInfo | boolean | query | No |
Ответ
Возвращает: GetFeedPostsPublic200Response
Пример

getFeedPostsStats 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetFeedPostsStats200Response
Пример

getUserReactsPublic 
Параметры
| Имя | Тип | Местоположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: GetUserReactsPublic200Response
Пример

reactFeedPostPublic 
Параметры
| Имя | Тип | Местоположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| isUndo | boolean | query | Нет | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ReactFeedPostPublic200Response
Пример

updateFeedPost 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

updateFeedPostPublic 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: CreateFeedPostPublic200Response
Пример

flagCommentPublic 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

addHashTag 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Нет |
Ответ
Возвращает: AddHashTag200Response
Пример

addHashTagsBulk 
Параметры
| Имя | Тип | Location | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Нет |
Ответ
Возвращает: AddHashTagsBulk200Response
Пример

deleteHashTag 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tag | string | path | Да | |
| tenantId | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getHashTags 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | number | query | Нет |
Ответ
Возвращает: GetHashTags200Response
Пример

patchHashTag 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tag | string | path | Да | |
| tenantId | string | query | Нет |
Ответ
Возвращает: PatchHashTag200Response
Пример

createModerator 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateModerator200Response
Пример

deleteModerator 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sendEmail | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getModerator 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetModerator200Response
Пример

getModerators 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetModerators200Response
Пример

sendInvite 
Параметры
| Имя | Тип | Местоположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

updateModerator 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

deleteNotificationCount 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getCachedNotificationCount 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetCachedNotificationCount200Response
Пример

getNotificationCount 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| urlId | string | query | Нет | |
| fromCommentId | string | query | Нет | |
| viewed | boolean | query | Нет | |
| type | string | query | Нет |
Ответ
Возвращает: GetNotificationCount200Response
Пример

getNotifications 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| urlId | string | query | Нет | |
| fromCommentId | string | query | Нет | |
| viewed | boolean | query | Нет | |
| type | string | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetNotifications200Response
Пример

updateNotification 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

addPage 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: AddPageAPIResponse
Пример

deletePage 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: DeletePageAPIResponse
Пример

getPageByURLId 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Ответ
Возвращает: GetPageByURLIdAPIResponse
Пример

getPages 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: GetPagesAPIResponse
Пример

patchPage 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: PatchPageAPIResponse
Пример

deletePendingWebhookEvent 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getPendingWebhookEventCount 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Нет | |
| externalId | string | query | Нет | |
| eventType | string | query | Нет | |
| type | string | query | Нет | |
| domain | string | query | Нет | |
| attemptCountGT | number | query | Нет |
Ответ
Возвращает: GetPendingWebhookEventCount200Response
Пример

getPendingWebhookEvents 
Параметры
| Name | Type | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Нет | |
| externalId | string | query | Нет | |
| eventType | string | query | Нет | |
| type | string | query | Нет | |
| domain | string | query | Нет | |
| attemptCountGT | number | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetPendingWebhookEvents200Response
Пример

createQuestionConfig 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateQuestionConfig200Response
Пример

deleteQuestionConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getQuestionConfig 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetQuestionConfig200Response
Пример

getQuestionConfigs 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetQuestionConfigs200Response
Пример

updateQuestionConfig 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

createQuestionResult 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateQuestionResult200Response
Пример

deleteQuestionResult 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getQuestionResult 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: GetQuestionResult200Response
Пример

getQuestionResults 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Нет | |
| userId | string | query | Нет | |
| startDate | string | query | Нет | |
| questionId | string | query | Нет | |
| questionIds | string | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetQuestionResults200Response
Пример

updateQuestionResult 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

aggregateQuestionResults 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Нет | |
| questionIds | array | query | Нет | |
| urlId | string | query | Нет | |
| timeBucket | string | query | Нет | |
| startDate | string | query | Нет | |
| forceRecalculate | boolean | query | Нет |
Ответ
Возвращает: AggregateQuestionResults200Response
Пример

bulkAggregateQuestionResults 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| forceRecalculate | boolean | query | Нет |
Ответ
Возвращает: BulkAggregateQuestionResults200Response
Пример

combineCommentsWithQuestionResults 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Нет | |
| questionIds | array | query | Нет | |
| urlId | string | query | Нет | |
| startDate | string | query | Нет | |
| forceRecalculate | boolean | query | Нет | |
| minValue | number | query | Нет | |
| maxValue | number | query | Нет | |
| limit | number | query | Нет |
Ответ
Возвращает: CombineCommentsWithQuestionResults200Response
Пример

addSSOUser 
Параметры
| Имя | Тип | Местоположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: AddSSOUserAPIResponse
Пример

deleteSSOUser 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | boolean | query | Нет | |
| commentDeleteMode | string | query | Нет |
Ответ
Возвращает: DeleteSSOUserAPIResponse
Пример

getSSOUserByEmail 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| string | path | Да |
Ответ
Возвращает: GetSSOUserByEmailAPIResponse
Пример

getSSOUserById 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetSSOUserByIdAPIResponse
Пример

getSSOUsers 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Нет |
Ответ
Возвращает: GetSSOUsers200Response
Пример

patchSSOUser 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | boolean | query | No |
Ответ
Возвращает: PatchSSOUserAPIResponse
Пример

putSSOUser 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Нет |
Ответ
Возвращает: PutSSOUserAPIResponse
Пример

createSubscription 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateSubscriptionAPIResponse
Пример

deleteSubscription 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: DeleteSubscriptionAPIResponse
Пример

getSubscriptions 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: GetSubscriptionsAPIResponse
Пример

updateSubscription 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: UpdateSubscriptionAPIResponse
Пример

getTenantDailyUsages 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Ответ
Возвращает: GetTenantDailyUsages200Response
Пример

createTenantPackage 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateTenantPackage200Response
Пример

deleteTenantPackage 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getTenantPackage 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetTenantPackage200Response
Пример

getTenantPackages 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetTenantPackages200Response
Пример

replaceTenantPackage 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

updateTenantPackage 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

createTenantUser 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateTenantUser200Response
Пример

deleteTenantUser 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | string | query | Нет | |
| commentDeleteMode | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getTenantUser 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetTenantUser200Response
Пример

getTenantUsers 
Параметры
| Имя | Тип | Местоположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Нет |
Ответ
Возвращает: GetTenantUsers200Response
Пример

replaceTenantUser 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

sendLoginLink 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| redirectURL | string | query | No |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

updateTenantUser 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

createTenant 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateTenant200Response
Пример

deleteTenant 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Нет |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

getTenant 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetTenant200Response
Пример

getTenants 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| meta | string | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetTenants200Response
Пример

updateTenant 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: FlagCommentPublic200Response
Пример

changeTicketState 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: ChangeTicketState200Response
Пример

createTicket 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Да |
Ответ
Возвращает: CreateTicket200Response
Пример

getTicket 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Нет |
Ответ
Возвращает: GetTicket200Response
Пример

getTickets 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| state | number | query | Нет | |
| skip | number | query | Нет | |
| limit | number | query | Нет |
Ответ
Возвращает: GetTickets200Response
Пример

uploadImage 
Загрузить и изменить размер изображения
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Предустановка размера: "Default" (1000x1000px) или "CrossPlatform" (создаёт размеры для популярных устройств) |
| urlId | string | query | No | Идентификатор страницы, с которой выполняется загрузка, для конфигурации |
Ответ
Возвращает: UploadImageResponse
Пример

getUserBadgeProgressById 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: GetUserBadgeProgressById200Response
Пример

getUserBadgeProgressByUserId 
Параметры
| Имя | Тип | Location | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | path | Да |
Ответ
Возвращает: GetUserBadgeProgressById200Response
Пример

getUserBadgeProgressList 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Ответ
Возвращает: GetUserBadgeProgressList200Response
Пример

createUserBadge 
Параметры
| Имя | Тип | Расположение | Обязательный | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Ответ
Возвращает: CreateUserBadge200Response
Пример

deleteUserBadge 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: UpdateUserBadge200Response
Пример

getUserBadge 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetUserBadge200Response
Пример

getUserBadges 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Нет | |
| badgeId | string | query | Нет | |
| type | number | query | Нет | |
| displayedOnComments | boolean | query | Нет | |
| limit | number | query | Нет | |
| skip | number | query | Нет |
Ответ
Возвращает: GetUserBadges200Response
Пример

updateUserBadge 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Ответ
Возвращает: UpdateUserBadge200Response
Пример

getUserNotificationCount 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: GetUserNotificationCount200Response
Пример

getUserNotifications 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| sso | string | query | No |
Ответ
Возвращает: GetUserNotifications200Response
Пример

resetUserNotificationCount 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: ResetUserNotifications200Response
Пример

resetUserNotifications 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Нет | |
| afterCreatedAt | integer | query | Нет | |
| unreadOnly | boolean | query | Нет | |
| dmOnly | boolean | query | Нет | |
| noDm | boolean | query | Нет | |
| sso | string | query | Нет |
Ответ
Возвращает: ResetUserNotifications200Response
Пример

updateUserNotificationCommentSubscriptionStatus 
Включить или отключить уведомления для конкретного комментария.
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationStatus200Response
Пример

updateUserNotificationPageSubscriptionStatus 
Включить или отключить уведомления для страницы. Когда пользователи подписаны на страницу, создаются уведомления для новых корневых комментариев, а также
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationStatus200Response
Пример

updateUserNotificationStatus 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Нет |
Ответ
Возвращает: UpdateUserNotificationStatus200Response
Пример

getUserPresenceStatuses 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlIdWS | string | query | Да | |
| userIds | string | query | Да |
Ответ
Возвращает: GetUserPresenceStatuses200Response
Пример

searchUsers 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| usernameStartsWith | string | query | Нет | |
| mentionGroupIds | array | query | Нет | |
| sso | string | query | Нет | |
| searchSection | string | query | Нет |
Ответ
Возвращает: SearchUsers200Response
Пример

getUser 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Ответ
Возвращает: GetUser200Response
Пример

createVote 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Да | |
| direction | string | query | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: VoteComment200Response
Пример

deleteVote 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| editKey | string | query | Нет |
Ответ
Возвращает: DeleteCommentVote200Response
Пример

getVotes 
Параметры
| Имя | Тип | Расположение | Обязательно | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Ответ
Возвращает: GetVotes200Response
Пример

getVotesForUser 
Параметры
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| userId | string | query | Нет | |
| anonUserId | string | query | Нет |
Ответ
Возвращает: GetVotesForUser200Response
Пример

Нужна помощь?
Если вы столкнулись с проблемами или у вас есть вопросы по Swift SDK, пожалуйста:
Вклад
Вклады приветствуются! Пожалуйста, посетите репозиторий на GitHub для получения руководства по внесению вклада.