
Език 🇧🇬 Български
Първи стъпки
Документация
Използване
Агрегация
Одитни записи
Блокиране от коментар
Проверка на блокирани коментари
Коментари
Конфигурации на домейни
Шаблони за имейли
Журнал на събитията
Публикации в емисията
Докладване на коментар
Хаштагове
Модератори
Брой известия
Известия
Страници
Чакащи webhook събития
Конфигурации на въпроси
Резултати от въпроси
Агрегация на резултатите от въпроси
SSO потребители
Абонаменти
Ежедневна употреба на наемателя
Пакети на наемателя
Потребители на наемателя
Наематели
Качване на изображение
Напредък на значките на потребителя
Значки на потребителите
Потребителски известия
Статус на присъствие на потребителя
Търсене на потребители
Потребители
Гласове
FastComments Ruby SDK
Това е официалният Ruby SDK за FastComments.
Официален Ruby SDK за API на FastComments
Репозитория
Инсталация 
Добавете този ред в Gemfile-а на вашето приложение:
gem 'fastcomments'
И след това изпълнете:
bundle install
Или го инсталирайте сами като:
gem install fastcomments
Съдържание на библиотеката
Тази библиотека съдържа генерирания API клиент и SSO помощни средства, за да улесни работата с API.
Публични и защитени API
За API клиента има два класа, DefaultApi и PublicApi. DefaultApi съдържа методи, които изискват вашия API ключ, а PublicApi съдържа извиквания на API, които могат да се извършват директно от браузър/мобилно устройство/и т.н. без удостоверяване.
Бърз старт 
Използване на удостоверени API (DefaultApi)
Важно: Трябва да зададете вашия API ключ в ApiClient преди да правите удостоверени заявки. Ако не го направите, заявките ще се провалят с грешка 401.
require 'fastcomments-client'
# Създаване и конфигуриране на API клиента
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# ЗАДЪЛЖИТЕЛНО: Задайте вашия API ключ (вземете го от таблото на FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Създаване на екземпляр на API с конфигурирания клиент
api = FastCommentsClient::DefaultApi.new(api_client)
# Сега можете да правите удостоверени API повиквания
begin
# Пример: Добавяне на SSO потребител
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Чести грешки:
# - 401: Липсващ или невалиден API ключ
# - 400: Провалена валидация на заявката
end
Използване на публични API (PublicApi)
Публичните крайни точки не изискват удостоверяване:
require 'fastcomments-client'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
tenant_id: 'YOUR_TENANT_ID',
url_id: 'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Често срещани проблеми
- 401 "missing-api-key" error: Уверете се, че задавате
config.api_key['x-api-key'] = 'YOUR_KEY'преди да създадете инстанция на DefaultApi. - Wrong API class: Използвайте
DefaultApiза сървърни удостоверени заявки,PublicApiза клиентски/публични заявки. - Null API key: SDK ще пропусне удостоверяването без съобщение, ако API ключът е null, което ще доведе до грешки 401.
Бележки 
Идентификатори на предавания
Ще видите, че трябва да предавате broadcastId в някои API повиквания. Когато получите събития, ще получите този ID обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента
(което вероятно ще искате да направите, тъй като осигурява най-доброто преживяване). Предайте тук UUID. ID-то трябва да е достатъчно уникално, за да не се появи два пъти в рамките на сесия на браузъра.
SSO (Еднократно влизане)
За примери за SSO, вижте по-долу.
Използване на SSO 
Просто SSO
require 'fastcomments'
require 'fastcomments-client'
# Създаване на токен за Simple SSO
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Използване на SSO токена за извършване на автентифицирано API повикване
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Защитено SSO
require 'fastcomments'
require 'fastcomments-client'
# Създаване на токен за Secure SSO
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Използване на SSO токена за извършване на автентифицирано API повикване
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
aggregate 
Агрегира документи чрез групиране (ако е зададено groupBy) и прилагане на множество операции. Поддържат се различни операции (например sum, countDistinct, avg и т.н.).
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| parentTenantId | string | query | No | |
| includeStats | boolean | query | No |
Отговор
Връща: AggregationResponse
Пример

get_audit_logs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| limit | number | query | Не | |
| skip | number | query | Не | |
| order | string | query | Не | |
| after | number | query | Не | |
| before | number | query | Не |
Отговор
Връща: GetAuditLogs200Response
Пример

block_from_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: BlockFromCommentPublic200Response
Пример

un_block_comment_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UnBlockCommentPublic200Response
Пример

checked_comments_for_blocked 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentIds | string | query | Да | Списък с идентификатори на коментари, разделени със запетаи. |
| sso | string | query | Не |
Отговор
Връща: CheckedCommentsForBlocked200Response
Пример

block_user_from_comment 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: BlockFromCommentPublic200Response
Пример

create_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: CreateCommentPublic200Response
Пример

delete_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| contextUserId | string | query | Не | |
| isLive | boolean | query | Не |
Отговор
Връща: DeleteComment200Response
Пример

delete_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: DeleteCommentPublic200Response
Пример

delete_comment_vote 
Параметри
| 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
Пример

flag_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: FlagComment200Response
Пример

get_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetComment200Response
Пример

get_comment_text 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetCommentText200Response
Пример

get_comment_vote_user_names 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| dir | integer | query | Да | |
| sso | string | query | Не |
Отговор
Връща: GetCommentVoteUserNames200Response
Пример

get_comments 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Пример

get_comments_public 
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
Пример

lock_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: LockComment200Response
Пример

pin_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: PinComment200Response
Пример

save_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| sendEmails | boolean | query | Не | |
| populateNotifications | boolean | query | Не |
Отговор
Връща: SaveComment200Response
Пример

save_comments_bulk 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| sendEmails | boolean | query | Не | |
| populateNotifications | boolean | query | Не |
Отговор
Връща: Array<SaveComment200Response>
Пример

set_comment_text 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| broadcastId | string | query | Да | |
| editKey | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: SetCommentText200Response
Пример

un_block_user_from_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Отговор
Връща: UnBlockCommentPublic200Response
Пример

un_flag_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Отговор
Връща: FlagComment200Response
Пример

un_lock_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | път | Да | |
| commentId | string | път | Да | |
| broadcastId | string | заявка | Да | |
| sso | string | заявка | Не |
Отговор
Връща: LockComment200Response
Пример

un_pin_comment 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Отговор
Връща: PinComment200Response
Пример

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

vote_comment 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| commentId | string | path | Да | |
| urlId | string | query | Да | |
| broadcastId | string | query | Да | |
| sessionId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: VoteComment200Response
Пример

add_domain_config 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Response
Връща: AddDomainConfig200Response
Пример

delete_domain_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Отговор
Връща: DeleteDomainConfig200Response
Пример

get_domain_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domain | string | path | Да |
Отговор
Връща: GetDomainConfig200Response
Пример

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

patch_domain_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| domainToUpdate | string | path | Да |
Отговор
Връща: GetDomainConfig200Response
Пример

put_domain_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domainToUpdate | string | path | Yes |
Отговор
Връща: GetDomainConfig200Response
Пример

create_email_template 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateEmailTemplate200Response
Пример

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

delete_email_template_render_error 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_email_template 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetEmailTemplate200Response
Пример

get_email_template_definitions 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetEmailTemplateDefinitions200Response
Пример

get_email_template_render_errors 
Параметри
| Име | Type | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| skip | number | query | Не |
Отговор
Връща: GetEmailTemplateRenderErrors200Response
Пример

get_email_templates 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetEmailTemplates200Response
Пример

render_email_template 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| locale | string | query | No |
Отговор
Връща: RenderEmailTemplate200Response
Пример

update_email_template 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | заявка | Да | |
| id | string | път | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_event_log 
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
Пример

get_global_event_log 
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
Пример

create_feed_post 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| broadcastId | string | query | Не | |
| isLive | boolean | query | Не | |
| doSpamCheck | boolean | query | Не | |
| skipDupCheck | boolean | query | Не |
Отговор
Връща: CreateFeedPost200Response
Пример

create_feed_post_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: CreateFeedPostPublic200Response
Пример

delete_feed_post_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: DeleteFeedPostPublic200Response
Пример

get_feed_posts 
заявка tenantId afterId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не |
Отговор
Връща: GetFeedPosts200Response
Пример

get_feed_posts_public 
req tenantId afterId
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| afterId | string | query | Не | |
| limit | integer | query | Не | |
| tags | array | query | Не | |
| sso | string | query | Не | |
| isCrawler | boolean | query | Не | |
| includeUserInfo | boolean | query | Не |
Отговор
Връща: GetFeedPostsPublic200Response
Пример

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

get_user_reacts_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postIds | array | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetUserReactsPublic200Response
Пример

react_feed_post_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| postId | string | path | Да | |
| isUndo | boolean | query | Не | |
| broadcastId | string | query | Не | |
| sso | string | query | Не |
Отговор
Връща: ReactFeedPostPublic200Response
Пример

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

update_feed_post_public 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | път | Да | |
| postId | string | път | Да | |
| broadcastId | string | заявка | Не | |
| sso | string | заявка | Не |
Отговор
Връща: CreateFeedPostPublic200Response
Пример

flag_comment_public 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | path | Да | |
| isFlagged | boolean | query | Да | |
| sso | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

add_hash_tag 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Не |
Отговор
Връща: AddHashTag200Response
Пример

add_hash_tags_bulk 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Не |
Отговор
Връща: AddHashTagsBulk200Response
Пример

delete_hash_tag 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tag | string | path | Да | |
| tenantId | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_hash_tags 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| page | number | query | Не |
Отговор
Връща: GetHashTags200Response
Пример

patch_hash_tag 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Да | |
| tenantId | string | query | Не |
Отговор
Връща: PatchHashTag200Response
Пример

create_moderator 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateModerator200Response
Пример

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

get_moderator 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetModerator200Response
Пример

get_moderators 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetModerators200Response
Пример

send_invite 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| fromName | string | query | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

update_moderator 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

delete_notification_count 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_cached_notification_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetCachedNotificationCount200Response
Пример

get_notification_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | заявка | Да | |
| userId | string | заявка | Не | |
| urlId | string | заявка | Не | |
| fromCommentId | string | заявка | Не | |
| viewed | boolean | заявка | Не | |
| type | string | заявка | Не |
Отговор
Връща: GetNotificationCount200Response
Пример

get_notifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| urlId | string | query | Не | |
| fromCommentId | string | query | Не | |
| viewed | boolean | query | Не | |
| type | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetNotifications200Response
Пример

update_notification 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Отговор
Връща: FlagCommentPublic200Response
Пример

add_page 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddPageAPIResponse
Пример

delete_page 
Параметри
| Име | Тип | Location | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: DeletePageAPIResponse
Пример

get_page_by_urlid 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetPageByURLIdAPIResponse
Пример

get_pages 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: GetPagesAPIResponse
Пример

patch_page 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Връща: PatchPageAPIResponse
Example

delete_pending_webhook_event 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_pending_webhook_event_count 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| commentId | string | query | Не | |
| externalId | string | query | Не | |
| eventType | string | query | Не | |
| type | string | query | Не | |
| domain | string | query | Не | |
| attemptCountGT | number | query | Не |
Отговор
Връща: GetPendingWebhookEventCount200Response
Пример

get_pending_webhook_events 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| 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
Пример

create_question_config 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionConfig200Response
Пример

delete_question_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_question_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionConfig200Response
Пример

get_question_configs 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionConfigs200Response
Пример

update_question_config 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

create_question_result 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateQuestionResult200Response
Пример

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

get_question_result 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetQuestionResult200Response
Пример

get_question_results 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Не | |
| userId | string | query | Не | |
| startDate | string | query | Не | |
| questionId | string | query | Не | |
| questionIds | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetQuestionResults200Response
Пример

update_question_result 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Връща: FlagCommentPublic200Response
Пример

aggregate_question_results 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| questionId | string | query | Не | |
| questionIds | array | query | Не | |
| urlId | string | query | Не | |
| timeBucket | string | query | Не | |
| startDate | string | query | Не | |
| forceRecalculate | boolean | query | Не |
Отговор
Връща: AggregateQuestionResults200Response
Пример

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

combine_comments_with_question_results 
Параметри
| 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
Пример

add_sso_user 
Параметри
| Име | Type | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: AddSSOUserAPIResponse
Пример

delete_sso_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
Отговор
Връща: DeleteSSOUserAPIResponse
Пример

get_sso_user_by_email 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Отговор
Връща: GetSSOUserByEmailAPIResponse
Пример

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

get_sso_users 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | integer | query | Не |
Отговор
Връща: GetSSOUsers200Response
Пример

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

put_sso_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | boolean | query | Не |
Отговор
Връща: PutSSOUserAPIResponse
Пример

create_subscription 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateSubscriptionAPIResponse
Пример

delete_subscription 
Параметри
| Име | Тип | Местоположение | Задължителен | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| userId | string | query | Не |
Отговор
Връща: DeleteSubscriptionAPIResponse
Пример

get_subscriptions 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не |
Отговор
Връща: GetSubscriptionsAPIResponse
Пример

get_tenant_daily_usages 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| yearNumber | number | query | Не | |
| monthNumber | number | query | Не | |
| dayNumber | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetTenantDailyUsages200Response
Пример

create_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenantPackage200Response
Пример

delete_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenantPackage200Response
Пример

get_tenant_packages 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetTenantPackages200Response
Пример

replace_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

update_tenant_package 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: FlagCommentPublic200Response
Пример

create_tenant_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenantUser200Response
Пример

delete_tenant_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| deleteComments | string | query | Не | |
| commentDeleteMode | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_tenant_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: GetTenantUser200Response
Пример

get_tenant_users 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| skip | number | query | Не |
Отговор
Връща: GetTenantUsers200Response
Пример

replace_tenant_user 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

send_login_link 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| redirectURL | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

update_tenant_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| updateComments | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

create_tenant 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateTenant200Response
Пример

delete_tenant 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| sure | string | query | Не |
Отговор
Връща: FlagCommentPublic200Response
Пример

get_tenant 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetTenant200Response
Пример

get_tenants 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| meta | string | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetTenants200Response
Пример

update_tenant 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: FlagCommentPublic200Response
Пример

upload_image 
Качване и преоразмеряване на изображение
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Да | |
| sizePreset | string | query | Не | Преднастройка на размера: "Default" (1000x1000px) или "CrossPlatform" (създава размери за популярни устройства) |
| urlId | string | query | Не | ID на страницата, от която се извършва качването, за конфигуриране |
Отговор
Връща: UploadImageResponse
Пример

get_user_badge_progress_by_id 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Отговор
Връща: GetUserBadgeProgressById200Response
Пример

get_user_badge_progress_by_user_id 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | path | Yes |
Отговор
Връща: GetUserBadgeProgressById200Response
Пример

get_user_badge_progress_list 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| userId | string | query | Не | |
| limit | number | query | Не | |
| skip | number | query | Не |
Отговор
Връща: GetUserBadgeProgressList200Response
Пример

create_user_badge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да |
Отговор
Връща: CreateUserBadge200Response
Пример

delete_user_badge 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: UpdateUserBadge200Response
Пример

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

get_user_badges 
Параметри
| 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
Пример

update_user_badge 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Response
Връща: UpdateUserBadge200Response
Пример

get_user_notification_count 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: GetUserNotificationCount200Response
Пример

get_user_notifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| pageSize | integer | query | Не | |
| afterId | string | query | Не | |
| includeContext | boolean | query | Не | |
| afterCreatedAt | integer | query | Не | |
| unreadOnly | boolean | query | Не | |
| dmOnly | boolean | query | Не | |
| noDm | boolean | query | Не | |
| includeTranslations | boolean | query | Не | |
| sso | string | query | Не |
Отговор
Връща: GetUserNotifications200Response
Пример

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

reset_user_notifications 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| afterId | string | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| sso | string | query | No |
Отговор
Връща: ResetUserNotifications200Response
Пример

update_user_notification_comment_subscription_status 
Активиране или деактивиране на известия за конкретен коментар.
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| optedInOrOut | string | path | Да | |
| commentId | string | query | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatus200Response
Пример

update_user_notification_page_subscription_status 
Активиране или деактивиране на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови основни коментари, и също така
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| url | string | query | Да | |
| pageTitle | string | query | Да | |
| subscribedOrUnsubscribed | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatus200Response
Пример

update_user_notification_status 
Параметри
| Име | Тип | Локация | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| notificationId | string | path | Да | |
| newStatus | string | path | Да | |
| sso | string | query | Не |
Отговор
Връща: UpdateUserNotificationStatus200Response
Пример

get_user_presence_statuses 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlIdWS | string | query | Да | |
| userIds | string | query | Да |
Отговор
Връща: GetUserPresenceStatuses200Response
Пример

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

get_user 
Параметри
| Име | Тип | Location | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да |
Отговор
Връща: GetUser200Response
Пример

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

delete_vote 
Параметри
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| id | string | path | Да | |
| editKey | string | query | Не |
Отговор
Връща: DeleteCommentVote200Response
Пример

get_votes 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да |
Отговор
Връща: GetVotes200Response
Пример

get_votes_for_user 
Параметри
| Име | Тип | Местоположение | Задължително | Описание |
|---|---|---|---|---|
| tenantId | string | query | Да | |
| urlId | string | query | Да | |
| userId | string | query | Не | |
| anonUserId | string | query | Не |
Отговор
Връща: GetVotesForUser200Response
Пример

Нуждаете ли се от помощ?
Ако срещнете проблеми или имате въпроси относно Ruby SDK, моля:
Принос
Приноси са добре дошли! Моля, посетете репозитория в GitHub за указания за принос.