FastComments.com

FastComments Ruby SDK

Это официальный SDK на Ruby для FastComments.

Официальный SDK на Ruby для API FastComments

Репозиторий

Посмотреть на GitHub


Установка Internal Link

Добавьте эту строку в Gemfile вашего приложения:

gem 'fastcomments'

А затем выполните:

bundle install

Или установите его самостоятельно с помощью:

gem install fastcomments

Содержимое библиотеки

Эта библиотека содержит сгенерированный клиент API и утилиты SSO, упрощающие работу с API.

Публичные и защищённые API

Для клиента API существуют два класса: DefaultApi и PublicApi. DefaultApi содержит методы, которые требуют вашего ключа API, а PublicApi содержит вызовы API, которые можно выполнять напрямую из браузера, мобильного устройства и т.д. без аутентификации.

Быстрый старт Internal Link

Использование аутентифицированных API (DefaultApi)

Важно: Вы должны установить ваш API-ключ в ApiClient перед выполнением аутентифицированных запросов. Если вы этого не сделаете, запросы завершатся с ошибкой 401.

require 'fastcomments-client'

# Создайте и настройте ApiClient
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)

Публичные endpoints не требуют аутентификации:

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

Частые проблемы

  1. 401 "missing-api-key" ошибка: Убедитесь, что вы установили config.api_key['x-api-key'] = 'YOUR_KEY' перед созданием экземпляра DefaultApi.
  2. Неправильный класс API: Используйте DefaultApi для серверных аутентифицированных запросов, PublicApi для клиентских/публичных запросов.
  3. Null API key: SDK тихо пропустит аутентификацию, если API-ключ равен null, что приведёт к ошибкам 401.

Примечания Internal Link

Идентификаторы трансляций

Вы увидите, что в некоторых вызовах API требуется передать broadcastId. Когда вы получите события, вы получите этот идентификатор обратно, поэтому вы сможете игнорировать событие, если планируете оптимистично применять изменения на клиенте (что, вероятно, вы захотите сделать, так как это обеспечивает наилучший опыт). Передайте здесь UUID. Идентификатор должен быть достаточно уникальным, чтобы не повториться дважды в сессии браузера.

SSO (единого входа)

Для примеров SSO смотрите ниже.

Использование SSO Internal Link

Простой 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}"

Агрегировать Internal Link

Агрегирует документы, группируя их (если указан groupBy) и применяя несколько операций. Поддерживаются различные операции (например sum, countDistinct, avg и т.д.).

Parameters

Name Type Location Required Description
tenantId string query Да
parentTenantId string query Нет
includeStats boolean query Нет

Ответ

Возвращает: AggregationResponse

Пример

Пример aggregate
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest |
15opts = {
16 parent_tenant_id: 'parent_tenant_id_example', # String |
17 include_stats: true # Boolean |
18}
19
20begin
21
22 result = api_instance.aggregate(tenant_id, aggregation_request, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->aggregate: #{e}"
26end
27

Получить журналы аудита Internal Link

Параметры

Name Type Location Required Description
tenantId string query Yes
limit number query No
skip number query No
order string query No
after number query No
before number query No

Ответ

Возвращает: GetAuditLogs200Response

Пример

Пример get_audit_logs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 limit: 1.2, # Float |
16 skip: 1.2, # Float |
17 order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
18 after: 1.2, # Float |
19 before: 1.2 # Float |
20}
21
22begin
23
24 result = api_instance.get_audit_logs(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_audit_logs: #{e}"
28end
29

Заблокировать по комментарию (публично) Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
commentId string path Да
sso string query Нет

Ответ

Возвращает: BlockFromCommentPublic200Response

Пример

Пример block_from_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->block_from_comment_public: #{e}"
19end
20

Разблокировать комментарий (публично) Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
commentId string path Да
sso string query Нет

Ответ

Возвращает: UnBlockCommentPublic200Response

Пример

un_block_comment_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_block_comment_public: #{e}"
19end
20

Проверить комментарии на блокировку Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
commentIds string query Да Список идентификаторов комментариев, разделённых запятыми.
sso string query Нет

Ответ

Возвращает: CheckedCommentsForBlocked200Response

Пример

Пример checked_comments_for_blocked
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_ids = 'comment_ids_example' # String | Список идентификаторов комментариев, разделённых запятыми.
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
18end
19

Заблокировать пользователя по комментарию Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Нет
anonUserId string query Нет

Ответ

Возвращает: BlockFromCommentPublic200Response

Пример

Пример block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
27end
28

Создать публичный комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string path Да
urlId string query Да
broadcastId string query Да
sessionId string query Нет
sso string query Нет

Ответ

Возвращает: CreateCommentPublic200Response

Пример

create_comment_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData |
10opts = {
11 session_id: 'session_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->create_comment_public: #{e}"
21end
22

Удалить комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
contextUserId string query Нет
isLive boolean query Нет

Ответ

Возвращает: DeleteComment200Response

Пример

delete_comment Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройте авторизацию с помощью API ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 context_user_id: 'context_user_id_example', # String |
17 is_live: true # Boolean |
18}
19
20begin
21
22 result = api_instance.delete_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_comment: #{e}"
26end
27

Удалить публичный комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string path Да
commentId string path Да
broadcastId string query Да
editKey string query Нет
sso string query Нет

Ответ

Возвращает: DeleteCommentPublic200Response

Пример

delete_comment_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 edit_key: 'edit_key_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->delete_comment_public: #{e}"
20end
21

Удалить голос за комментарий Internal Link

Параметры

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

Пример

delete_comment_vote Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7comment_id = 'comment_id_example' # Строка |
8vote_id = 'vote_id_example' # Строка |
9url_id = 'url_id_example' # Строка |
10broadcast_id = 'broadcast_id_example' # Строка |
11opts = {
12 edit_key: 'edit_key_example', # Строка |
13 sso: 'sso_example' # Строка |
14}
15
16begin
17
18 result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->delete_comment_vote: #{e}"
22end
23

Пометить комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Нет
anonUserId string query Нет

Ответ

Возвращает: FlagComment200Response

Пример

Пример flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->flag_comment: #{e}"
26end
27

Получить комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: GetComment200Response

Пример

get_comment Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации API-ключом: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_comment(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_comment: #{e}"
22end
23

Получить текст комментария Internal Link

Параметры

Имя Тип Location Обязательный Описание
tenantId string path Да
commentId string path Да
editKey string query Нет
sso string query Нет

Ответ

Возвращает: GetCommentText200Response

Пример

get_comment_text Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 edit_key: 'edit_key_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.get_comment_text(tenant_id, comment_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_text: #{e}"
19end
20

Получить имена голосовавших за комментарий Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string path Да
commentId string path Да
dir integer query Да
sso string query Нет

Ответ

Возвращает: GetCommentVoteUserNames200Response

Пример

Пример get_comment_vote_user_names
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7comment_id = 'comment_id_example' # Строка |
8dir = 56 # Целое число |
9opts = {
10 sso: 'sso_example' # Строка |
11}
12
13begin
14
15 result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
19end
20

Получить комментарии Internal Link

Параметры

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
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 56, # Integer |
16 limit: 56, # Integer |
17 skip: 56, # Integer |
18 as_tree: true, # Boolean |
19 skip_children: 56, # Integer |
20 limit_children: 56, # Integer |
21 max_tree_depth: 56, # Integer |
22 url_id: 'url_id_example', # String |
23 user_id: 'user_id_example', # String |
24 anon_user_id: 'anon_user_id_example', # String |
25 context_user_id: 'context_user_id_example', # String |
26 hash_tag: 'hash_tag_example', # String |
27 parent_id: 'parent_id_example', # String |
28 direction: FastCommentsClient::SortDirections::OF # SortDirections |
29}
30
31begin
32
33 result = api_instance.get_comments(tenant_id, opts)
34 p result
35rescue FastCommentsClient::ApiError => e
36 puts "Error when calling DefaultApi->get_comments: #{e}"
37end
38

Получить публичные комментарии Internal Link

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

Пример

Пример get_comments_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8opts = {
9 page: 56, # Integer |
10 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
11 sso: 'sso_example', # String |
12 skip: 56, # Integer |
13 skip_children: 56, # Integer |
14 limit: 56, # Integer |
15 limit_children: 56, # Integer |
16 count_children: true, # Boolean |
17 fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String |
18 include_config: true, # Boolean |
19 count_all: true, # Boolean |
20 includei10n: true, # Boolean |
21 locale: 'locale_example', # String |
22 modules: 'modules_example', # String |
23 is_crawler: true, # Boolean |
24 include_notification_count: true, # Boolean |
25 as_tree: true, # Boolean |
26 max_tree_depth: 56, # Integer |
27 use_full_translation_ids: true, # Boolean |
28 parent_id: 'parent_id_example', # String |
29 search_text: 'search_text_example', # String |
30 hash_tags: ['inner_example'], # Array<String> |
31 user_id: 'user_id_example', # String |
32 custom_config_str: 'custom_config_str_example', # String |
33 after_comment_id: 'after_comment_id_example', # String |
34 before_comment_id: 'before_comment_id_example' # String |
35}
36
37begin
38
39 result = api_instance.get_comments_public(tenant_id, url_id, opts)
40 p result
41rescue FastCommentsClient::ApiError => e
42 puts "Error when calling PublicApi->get_comments_public: #{e}"
43end
44

Заблокировать комментарий Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Нет

Ответ

Возвращает: LockComment200Response

Пример

lock_comment Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->lock_comment: #{e}"
19end
20

Закрепить комментарий Internal Link

Параметры

Name Type Location Обязательно Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Нет

Ответ

Возвращает: PinComment200Response

Пример

Пример pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->pin_comment: #{e}"
19end
20

Сохранить комментарий Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
isLive boolean query Нет
doSpamCheck boolean query Нет
sendEmails boolean query Нет
populateNotifications boolean query Нет

Ответ

Возвращает: SaveComment200Response

Пример

Пример save_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'}) # CreateCommentParams |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comment(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comment: #{e}"
28end
29

Сохранить комментарии (массово) Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Yes
isLive boolean query No
doSpamCheck boolean query No
sendEmails boolean query No
populateNotifications boolean query No

Ответ

Возвращает: Array&lt;SaveComment200Response&gt;

Пример

Пример save_comments_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_comment_params = [FastCommentsClient::CreateCommentParams.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example', locale: 'locale_example'})] # Array<CreateCommentParams> |
15opts = {
16 is_live: true, # Boolean |
17 do_spam_check: true, # Boolean |
18 send_emails: true, # Boolean |
19 populate_notifications: true # Boolean |
20}
21
22begin
23
24 result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
28end
29

Установить текст комментария Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
editKey string query Нет
sso string query Нет

Ответ

Возвращает: SetCommentText200Response

Пример

Пример использования set_comment_text
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest |
10opts = {
11 edit_key: 'edit_key_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->set_comment_text: #{e}"
21end
22

Разблокировать пользователя по комментарию Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
userId string query Нет
anonUserId string query Нет

Ответ

Возвращает: UnBlockCommentPublic200Response

Пример

Пример un_block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
27end
28

Снять пометку с комментария Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
id string path Да
userId string query Нет
anonUserId string query Нет

Ответ

Возвращает: FlagComment200Response

Пример

Пример un_flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.un_flag_comment(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->un_flag_comment: #{e}"
26end
27

Разблокировать комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Нет

Ответ

Возвращает: LockComment200Response

Пример

Пример un_lock_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_lock_comment: #{e}"
19end
20

Открепить комментарий Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Нет

Ответ

Возвращает: PinComment200Response

Пример

Пример un_pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8broadcast_id = 'broadcast_id_example' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->un_pin_comment: #{e}"
19end
20

Обновить комментарий Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
contextUserId string query Нет
doSpamCheck boolean query Нет
isLive boolean query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams |
16opts = {
17 context_user_id: 'context_user_id_example', # String |
18 do_spam_check: true, # Boolean |
19 is_live: true # Boolean |
20}
21
22begin
23
24 result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->update_comment: #{e}"
28end
29

Проголосовать за комментарий Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string path Да
commentId string path Да
urlId string query Да
broadcastId string query Да
sessionId string query Нет
sso string query Нет

Ответ

Возвращает: VoteComment200Response

Пример

Пример vote_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8url_id = 'url_id_example' # String |
9broadcast_id = 'broadcast_id_example' # String |
10vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams |
11opts = {
12 session_id: 'session_id_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->vote_comment: #{e}"
22end
23

Добавить конфигурацию домена Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: AddDomainConfig200Response

Пример

add_domain_config Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams |
15
16begin
17
18 result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_domain_config: #{e}"
22end
23

Удалить конфигурацию домена Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
domain string path Да

Ответ

Возвращает: DeleteDomainConfig200Response

Пример

Пример delete_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.delete_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"
22end
23

Получить конфигурацию домена Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
domain string path Да

Ответ

Возвращает: GetDomainConfig200Response

Пример

Пример get_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.get_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_domain_config: #{e}"
22end
23

Получить конфигурации домена Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: GetDomainConfigs200Response

Пример

Пример get_domain_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_domain_configs(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_domain_configs: #{e}"
21end
22

Частичное обновление конфигурации домена Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
domainToUpdate string path Да

Ответ

Возвращает: GetDomainConfig200Response

Пример

Пример patch_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams |
16
17begin
18
19 result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_domain_config: #{e}"
23end
24

Заменить конфигурацию домена Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
domainToUpdate string path Да

Ответ

Возвращает: GetDomainConfig200Response

Пример

Пример put_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_to_update = 'domain_to_update_example' # String |
15update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams |
16
17begin
18
19 result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->put_domain_config: #{e}"
23end
24

Создать шаблон письма Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да

Ответ

Возвращает: CreateEmailTemplate200Response

Пример

Пример create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody |
15
16begin
17
18 result = api_instance.create_email_template(tenant_id, create_email_template_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_email_template: #{e}"
22end
23

Удалить шаблон письма Internal Link

Параметры

Имя Тип Местоположение Обязательный Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример delete_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_email_template: #{e}"
22end
23

Удалить ошибку рендеринга шаблона письма Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
errorId string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

delete_email_template_render_error Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15error_id = 'error_id_example' # String |
16
17begin
18
19 result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
23end
24

Получить шаблон письма Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetEmailTemplate200Response

Пример

Пример get_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_email_template(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_email_template: #{e}"
22end
23

Получить определения шаблонов писем Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да

Ответ

Возвращает: GetEmailTemplateDefinitions200Response

Пример

Пример get_email_template_definitions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_email_template_definitions(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
21end
22

Получить ошибки рендеринга шаблонов письма Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
skip number query Нет

Ответ

Возвращает: GetEmailTemplateRenderErrors200Response

Пример

Пример get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
25end
26

Получить шаблоны писем Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
skip number query Нет

Ответ

Возвращает: GetEmailTemplates200Response

Пример

Пример get_email_templates
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_email_templates(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_templates: #{e}"
24end
25

Отрендерить шаблон письма Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
locale string query Нет

Ответ

Возвращает: RenderEmailTemplate200Response

Пример

Пример render_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody |
15opts = {
16 locale: 'locale_example' # String |
17}
18
19begin
20
21 result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->render_email_template: #{e}"
25end
26

Обновить шаблон письма Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию API ключом: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody |
16
17begin
18
19 result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_email_template: #{e}"
23end
24

Получить журнал событий Internal Link

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_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7url_id = 'url_id_example' # Строка |
8user_id_ws = 'user_id_ws_example' # Строка |
9start_time = 789 # Целое число |
10end_time = 789 # Целое число |
11
12begin
13
14 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_event_log: #{e}"
18end
19

Получить глобальный журнал событий Internal Link

req tenantId urlId userIdWS

Параметры

Название Тип Расположение Обязательно Описание
tenantId string path Да
urlId string query Да
userIdWS string query Да
startTime integer query Да
endTime integer query Да

Ответ

Возвращает: GetEventLog200Response

Пример

Пример get_global_event_log
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10end_time = 789 # Integer |
11
12begin
13
14 result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, end_time)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_global_event_log: #{e}"
18end
19

Создать запись ленты Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
broadcastId string query Нет
isLive boolean query Нет
doSpamCheck boolean query Нет
skipDupCheck boolean query Нет

Ответ

Возвращает: CreateFeedPost200Response

Пример

Пример create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
15opts = {
16 broadcast_id: 'broadcast_id_example', # String |
17 is_live: true, # Boolean |
18 do_spam_check: true, # Boolean |
19 skip_dup_check: true # Boolean |
20}
21
22begin
23
24 result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->create_feed_post: #{e}"
28end
29

Создать публичную запись ленты Internal Link

Параметры

Имя Тип Location Обязательно Описание
tenantId string path Да
broadcastId string query Нет
sso string query Нет

Response

Возвращает: CreateFeedPostPublic200Response

Пример

Пример create_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams |
8opts = {
9 broadcast_id: 'broadcast_id_example', # String |
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->create_feed_post_public: #{e}"
19end
20

Удалить публичную запись ленты Internal Link

Параметры

Name Type Location Required Description
tenantId string path Да
postId string path Да
broadcastId string query Нет
sso string query Нет

Response

Возвращает: DeleteFeedPostPublic200Response

Пример

delete_feed_post_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7post_id = 'post_id_example' # Строка |
8opts = {
9 broadcast_id: 'broadcast_id_example', # Строка |
10 sso: 'sso_example' # Строка |
11}
12
13begin
14
15 result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
19end
20

Получить записи ленты Internal Link

req tenantId afterId

Параметры

Имя Тип Местоположение Обязательный Описание
tenantId string query Да
afterId string query Нет
limit integer query Нет
tags array query Нет

Ответ

Возвращает: GetFeedPosts200Response

Пример

Пример get_feed_posts
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 after_id: 'after_id_example', # String |
16 limit: 56, # Integer |
17 tags: ['inner_example'] # Array<String> |
18}
19
20begin
21
22 result = api_instance.get_feed_posts(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_feed_posts: #{e}"
26end
27

Получить публичные записи ленты Internal Link

запрос tenantId afterId

Параметры

Name Type Location Required Description
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_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 after_id: 'after_id_example', # String |
9 limit: 56, # Integer |
10 tags: ['inner_example'], # Array<String> |
11 sso: 'sso_example', # String |
12 is_crawler: true, # Boolean |
13 include_user_info: true # Boolean |
14}
15
16begin
17
18 result = api_instance.get_feed_posts_public(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
22end
23

Получить статистику записей ленты Internal Link


Параметры

Name Type Location Required Description
tenantId string path Да
postIds array query Да
sso string query Нет

Ответ

Возвращает: GetFeedPostsStats200Response

Пример

get_feed_posts_stats Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_ids = ['inner_example'] # Array<String> |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
18end
19

Получить публичные реакции пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Yes
postIds array query No
sso string query No

Ответ

Возвращает: GetUserReactsPublic200Response

Пример

Пример get_user_reacts_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 post_ids: ['inner_example'], # Array<String> |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_user_reacts_public(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
18end
19

Поставить публичную реакцию к записи ленты Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Да
postId string path Да
isUndo boolean query Нет
broadcastId string query Нет
sso string query Нет

Ответ

Возвращает: ReactFeedPostPublic200Response

Пример

Пример react_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams |
9opts = {
10 is_undo: true, # Boolean |
11 broadcast_id: 'broadcast_id_example', # String |
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->react_feed_post_public: #{e}"
21end
22

Обновить запись ленты Internal Link

Параметры

Имя Тип Location Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost |
16
17begin
18
19 result = api_instance.update_feed_post(tenant_id, id, feed_post)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_feed_post: #{e}"
23end
24

Обновить публичную запись ленты Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Да
postId string path Да
broadcastId string query Нет
sso string query Нет

Ответ

Возвращает: CreateFeedPostPublic200Response

Пример

Пример update_feed_post_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7post_id = 'post_id_example' # String |
8update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->update_feed_post_public: #{e}"
20end
21

Пометить комментарий (публично) Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
commentId string path Да
isFlagged boolean query Да
sso string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

flag_comment_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8is_flagged = true # Boolean |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->flag_comment_public: #{e}"
19end
20

Добавить хэштег Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Нет

Ответ

Возвращает: AddHashTag200Response

Пример

Пример add_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tag(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
24end
25

Добавить хэштеги (массово) Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Нет

Ответ

Возвращает: AddHashTagsBulk200Response

Пример

Пример add_hash_tags_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Конфигурирование авторизации по API ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 bulk_create_hash_tags_body: FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tags_bulk(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
24end
25

Удалить хэштег Internal Link


Параметры

Name Type Location Required Description
tag string path Да
tenantId string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример delete_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 delete_hash_tag_request: FastCommentsClient::DeleteHashTagRequest.new # DeleteHashTagRequest |
17}
18
19begin
20
21 result = api_instance.delete_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
25end
26

Получить хэштеги Internal Link

Параметры

Name Type Location Required Description
tenantId string query Yes
page number query No

Ответ

Возвращает: GetHashTags200Response

Пример

Пример get_hash_tags
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_hash_tags(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_hash_tags: #{e}"
24end
25

Частично обновить хэштег Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tag string path Да
tenantId string query Нет

Ответ

Возвращает: PatchHashTag200Response

Пример

Пример patch_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
17}
18
19begin
20
21 result = api_instance.patch_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
25end
26

Создать модератора Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да

Ответ

Возвращает: CreateModerator200Response

Пример

create_moderator Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody |
15
16begin
17
18 result = api_instance.create_moderator(tenant_id, create_moderator_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_moderator: #{e}"
22end
23

Удалить модератора Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
id string path Да
sendEmail string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

delete_moderator Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации ключа API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 send_email: 'send_email_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_moderator(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_moderator: #{e}"
25end
26

Получить модератора Internal Link

Параметры

Name Type Location Required Description
tenantId string query Yes
id string path Yes

Response

Возвращает: GetModerator200Response

Пример

get_moderator Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_moderator(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_moderator: #{e}"
22end
23

Получить модераторов Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
skip number query Нет

Ответ

Возвращает: GetModerators200Response

Пример

get_moderators Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_moderators(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_moderators: #{e}"
24end
25

Отправить приглашение Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
id string path Да
fromName string query Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации API-ключом: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15from_name = 'from_name_example' # String |
16
17begin
18
19 result = api_instance.send_invite(tenant_id, id, from_name)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->send_invite: #{e}"
23end
24

Обновить модератора Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

update_moderator Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody |
16
17begin
18
19 result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_moderator: #{e}"
23end
24

Удалить счётчик уведомлений Internal Link

Параметры

Имя Тип Location Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

delete_notification_count Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_notification_count: #{e}"
22end
23

Получить закэшированное количество уведомлений Internal Link

Параметры

Название Тип Location Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetCachedNotificationCount200Response

Пример

Пример get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_cached_notification_count(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
22end
23

Получить количество уведомлений Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
userId string query Нет
urlId string query Нет
fromCommentId string query Нет
viewed boolean query Нет
type string query Нет

Ответ

Возвращает: GetNotificationCount200Response

Пример

Пример get_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
8 # config.api_key_prefix['x-api-key'] = 'Bearer'
9end
10
11api_instance = FastCommentsClient::DefaultApi.new
12tenant_id = 'tenant_id_example' # String |
13opts = {
14 user_id: 'user_id_example', # String |
15 url_id: 'url_id_example', # String |
16 from_comment_id: 'from_comment_id_example', # String |
17 viewed: true, # Boolean |
18 type: 'type_example' # String |
19}
20
21begin
22
23 result = api_instance.get_notification_count(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_notification_count: #{e}"
27end
28

Получить уведомления Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
userId string query Нет
urlId string query Нет
fromCommentId string query Нет
viewed boolean query Нет
type string query Нет
skip number query Нет

Ответ

Возвращает: GetNotifications200Response

Пример

Пример get_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 url_id: 'url_id_example', # String |
17 from_comment_id: 'from_comment_id_example', # String |
18 viewed: true, # Boolean |
19 type: 'type_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_notifications(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_notifications: #{e}"
29end
30

Обновить уведомление Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
id string path Да
userId string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_notification
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройте авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

Добавить страницу Internal Link


Параметры

Имя Тип Местоположение Обязательный Описание
tenantId string query Да

Ответ

Возвращает: AddPageAPIResponse

Пример

Пример add_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData |
15
16begin
17
18 result = api_instance.add_page(tenant_id, create_api_page_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_page: #{e}"
22end
23

Удалить страницу Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: DeletePageAPIResponse

Пример

Пример delete_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_page(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_page: #{e}"
22end
23

Получить страницу по URL ID Internal Link

Параметры

Имя Тип Местоположение Обязательный Описание
tenantId string query Да
urlId string query Да

Ответ

Возвращает: GetPageByURLIdAPIResponse

Пример

Пример get_page_by_urlid
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка API key авторизации: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_page_by_urlid(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
22end
23

Получить страницы Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да

Ответ

Возвращает: GetPagesAPIResponse

Пример

Пример get_pages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

Частично обновить страницу Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: PatchPageAPIResponse

Пример

Пример patch_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации через API-ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData |
16
17begin
18
19 result = api_instance.patch_page(tenant_id, id, update_api_page_data)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_page: #{e}"
23end
24

Удалить ожидающее событие вебхука Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример delete_pending_webhook_event
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

Получить количество ожидающих событий вебхука Internal Link

Параметры

Name Type Location Required Description
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_event_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
29end
30

Получить ожидающие события вебхука Internal Link

Параметры

Имя Тип 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

Пример

Пример get_pending_webhook_events
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 comment_id: 'comment_id_example', # String |
16 external_id: 'external_id_example', # String |
17 event_type: 'event_type_example', # String |
18 type: 'type_example', # String |
19 domain: 'domain_example', # String |
20 attempt_count_gt: 1.2, # Float |
21 skip: 1.2 # Float |
22}
23
24begin
25
26 result = api_instance.get_pending_webhook_events(tenant_id, opts)
27 p result
28rescue FastCommentsClient::ApiError => e
29 puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
30end
31

Создать конфигурацию вопроса Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: CreateQuestionConfig200Response

Пример

Пример create_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody |
15
16begin
17
18 result = api_instance.create_question_config(tenant_id, create_question_config_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_config: #{e}"
22end
23

Удалить конфигурацию вопроса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Yes
id string path Yes

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример delete_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_config: #{e}"
22end
23

Получить конфигурацию вопроса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: GetQuestionConfig200Response

Пример

get_question_config Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_question_config(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_config: #{e}"
22end
23

Получить настройки вопросов Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
skip number query Нет

Ответ

Возвращает: GetQuestionConfigs200Response

Пример

Пример get_question_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_question_configs(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_question_configs: #{e}"
24end
25

Обновить конфигурацию вопроса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

update_question_config Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody |
16
17begin
18
19 result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_config: #{e}"
23end
24

Создать результат вопроса Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: CreateQuestionResult200Response

Пример

Пример create_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody |
15
16begin
17
18 result = api_instance.create_question_result(tenant_id, create_question_result_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_question_result: #{e}"
22end
23

Удалить результат вопроса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

delete_question_result Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по ключу API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23

Получить результат вопроса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: GetQuestionResult200Response

Пример

Пример get_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Строка |
14id = 'id_example' # Строка |
15
16begin
17
18 result = api_instance.get_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_question_result: #{e}"
22end
23

Получить результаты вопросов Internal Link

Параметры

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

Пример

Пример get_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 url_id: 'url_id_example', # String |
16 user_id: 'user_id_example', # String |
17 start_date: 'start_date_example', # String |
18 question_id: 'question_id_example', # String |
19 question_ids: 'question_ids_example', # String |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_question_results: #{e}"
29end
30

Обновить результат вопроса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody |
16
17begin
18
19 result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_question_result: #{e}"
23end
24

Агрегировать результаты вопросов Internal Link

Параметры

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

Пример

Пример aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации ключа API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket |
19 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
20 force_recalculate: true # Boolean |
21}
22
23begin
24
25 result = api_instance.aggregate_question_results(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
29end
30

Массовая агрегация результатов вопросов Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
forceRecalculate boolean query Нет

Ответ

Возвращает: BulkAggregateQuestionResults200Response

Пример

Пример bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest |
15opts = {
16 force_recalculate: true # Boolean |
17}
18
19begin
20
21 result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
25end
26

Объединить комментарии с результатами вопросов Internal Link

Параметры

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

Пример

Пример combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 question_id: 'question_id_example', # String |
16 question_ids: ['inner_example'], # Array<String> |
17 url_id: 'url_id_example', # String |
18 start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
19 force_recalculate: true, # Boolean |
20 min_value: 1.2, # Float |
21 max_value: 1.2, # Float |
22 limit: 1.2 # Float |
23}
24
25begin
26
27 result = api_instance.combine_comments_with_question_results(tenant_id, opts)
28 p result
29rescue FastCommentsClient::ApiError => e
30 puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
31end
32

Добавить пользователя SSO Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: AddSSOUserAPIResponse

Пример

Пример add_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с API-ключом: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData |
15
16begin
17
18 result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_sso_user: #{e}"
22end
23

Удалить пользователя SSO Internal Link

Параметры

Имя Тип Location Обязательно Описание
tenantId string query Да
id string path Да
deleteComments boolean query Нет
commentDeleteMode string query Нет

Ответ

Возвращает: DeleteSSOUserAPIResponse

Пример

Пример delete_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: true, # Boolean |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_sso_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_sso_user: #{e}"
26end
27

Получить пользователя SSO по email Internal Link


Параметры

Name Type Location Required Description
tenantId string query Да
email string path Да

Ответ

Возвращает: GetSSOUserByEmailAPIResponse

Пример

Пример get_sso_user_by_email
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14email = 'email_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_email(tenant_id, email)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
22end
23

Получить пользователя SSO по ID Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Response

Возвращает: GetSSOUserByIdAPIResponse

Пример

get_sso_user_by_id Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_sso_user_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
22end
23

Получить пользователей SSO Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
skip integer query Нет

Ответ

Возвращает: GetSSOUsers200Response

Пример

Пример get_sso_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройте авторизацию с помощью API ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 56 # Integer |
16}
17
18begin
19
20 result = api_instance.get_sso_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_sso_users: #{e}"
24end
25

Частично обновить пользователя SSO Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
updateComments boolean query Нет

Ответ

Возвращает: PatchSSOUserAPIResponse

Пример

patch_sso_user Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->patch_sso_user: #{e}"
26end
27

Заменить пользователя SSO Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
id string path Да
updateComments boolean query Нет

Ответ

Возвращает: PutSSOUserAPIResponse

Пример

Пример put_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData |
16opts = {
17 update_comments: true # Boolean |
18}
19
20begin
21
22 result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->put_sso_user: #{e}"
26end
27

Создать подписку Internal Link


Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да

Ответ

Возвращает: CreateSubscriptionAPIResponse

Пример

Пример create_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData |
15
16begin
17
18 result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_subscription: #{e}"
22end
23

Удалить подписку Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да
userId string query Нет

Ответ

Возвращает: DeleteSubscriptionAPIResponse

Пример

Пример delete_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации API-ключом: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_subscription(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_subscription: #{e}"
25end
26

Получить подписки Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
userId string query Нет

Ответ

Возвращает: GetSubscriptionsAPIResponse

Пример

Пример get_subscriptions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

Получить ежедневное использование тенанта Internal Link

Параметры

Имя Тип Местоположение Обязателен Описание
tenantId string query Да
yearNumber number query Нет
monthNumber number query Нет
dayNumber number query Нет
skip number query Нет

Ответ

Возвращает: GetTenantDailyUsages200Response

Пример

Пример get_tenant_daily_usages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 year_number: 1.2, # Float |
16 month_number: 1.2, # Float |
17 day_number: 1.2, # Float |
18 skip: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tenant_daily_usages(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
27end
28

Создать пакет тенанта Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: CreateTenantPackage200Response

Пример

create_tenant_package Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_package_body = FastCommentsClient::CreateTenantPackageBody.new({name: 'name_example', max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # CreateTenantPackageBody |
15
16begin
17
18 result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_package: #{e}"
22end
23

Удалить пакет тенанта Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

delete_tenant_package Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
22end
23

Получить пакет тенанта Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetTenantPackage200Response

Пример

Пример get_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройте авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_package(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_package: #{e}"
22end
23

Получить пакеты тенанта Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
skip number query Нет

Ответ

Возвращает: GetTenantPackages200Response

Пример

Пример get_tenant_packages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_tenant_packages(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
24end
25

Заменить пакет тенанта Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

replace_tenant_package Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_package_body = FastCommentsClient::ReplaceTenantPackageBody.new({name: 'name_example', monthly_cost_usd: 3.56, yearly_cost_usd: 3.56, max_monthly_page_loads: 3.56, max_monthly_api_credits: 3.56, max_monthly_comments: 3.56, max_concurrent_users: 3.56, max_tenant_users: 3.56, max_sso_users: 3.56, max_moderators: 3.56, max_domains: 3.56, has_debranding: false, for_who_text: 'for_who_text_example', feature_taglines: ['feature_taglines_example'], has_flex_pricing: false}) # ReplaceTenantPackageBody |
16
17begin
18
19 result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
23end
24

Обновить пакет тенанта Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody |
16
17begin
18
19 result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant_package: #{e}"
23end
24

Создать пользователя тенанта Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: CreateTenantUser200Response

Пример

Пример create_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody |
15
16begin
17
18 result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant_user: #{e}"
22end
23

Удалить пользователя тенанта Internal Link

Parameters

Name Type Location Required Description
tenantId string query Да
id string path Да
deleteComments string query Нет
commentDeleteMode string query Нет

Response

Возвращает: FlagCommentPublic200Response

Example

delete_tenant_user Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: 'delete_comments_example', # String |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_tenant_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
26end
27

Получить пользователя тенанта Internal Link


Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetTenantUser200Response

Пример

Пример get_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_tenant_user: #{e}"
22end
23

Получить пользователей тенанта Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
skip number query Нет

Ответ

Возвращает: GetTenantUsers200Response

Пример

get_tenant_users Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Строка |
14opts = {
15 skip: 1.2 # Число с плавающей точкой |
16}
17
18begin
19
20 result = api_instance.get_tenant_users(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_tenant_users: #{e}"
24end
25

Заменить пользователя тенанта Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
updateComments string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

replace_tenant_user Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
26end
27

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
redirectURL string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример send_login_link
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 redirect_url: 'redirect_url_example' # String |
17}
18
19begin
20
21 result = api_instance.send_login_link(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->send_login_link: #{e}"
25end
26

Обновить пользователя тенанта Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
updateComments string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

update_tenant_user Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройте авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody |
16opts = {
17 update_comments: 'update_comments_example' # String |
18}
19
20begin
21
22 result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_tenant_user: #{e}"
26end
27

Создать тенант Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да

Ответ

Возвращает: CreateTenant200Response

Пример

Пример create_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Строка |
14create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody |
15
16begin
17
18 result = api_instance.create_tenant(tenant_id, create_tenant_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_tenant: #{e}"
22end
23

Удалить тенант Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
sure string query Нет

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример delete_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 sure: 'sure_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_tenant(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_tenant: #{e}"
25end
26

Получить тенант Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetTenant200Response

Пример

Пример get_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_tenant(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Ошибка при вызове DefaultApi->get_tenant: #{e}"
22end
23

Получить тенанты Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
meta string query Нет
skip number query Нет

Ответ

Возвращает: GetTenants200Response

Пример

Пример get_tenants
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 meta: 'meta_example', # String |
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_tenants(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_tenants: #{e}"
25end
26

Обновить тенант Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: FlagCommentPublic200Response

Пример

Пример update_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

Загрузить изображение Internal Link


Загрузить и изменить размер изображения

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Да
sizePreset string query Нет Пресет размера: "Default" (1000x1000px) или "CrossPlatform" (создаёт размеры для популярных устройств)
urlId string query Нет ID страницы, с которой выполняется загрузка, для конфигурации

Ответ

Возвращает: UploadImageResponse

Пример

Пример upload_image
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7file = File.new('/path/to/some/file') # File |
8opts = {
9 size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Пресет размера: \"Default\" (1000x1000px) или \"CrossPlatform\" (создаёт размеры для популярных устройств)
10 url_id: 'url_id_example' # String | ID страницы, с которой выполняется загрузка, для конфигурации
11}
12
13begin
14
15 result = api_instance.upload_image(tenant_id, file, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->upload_image: #{e}"
19end
20

Получить прогресс значка пользователя по ID Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да

Ответ

Возвращает: GetUserBadgeProgressById200Response

Пример

Пример get_user_badge_progress_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
22end
23

Получить прогресс значка по ID пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
userId string path Да

Ответ

Возвращает: GetUserBadgeProgressById200Response

Пример

get_user_badge_progress_by_user_id Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
22end
23

Получить список прогресса значков пользователя Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
userId string query Нет
limit number query Нет
skip number query Нет

Ответ

Возвращает: GetUserBadgeProgressList200Response

Пример

Пример get_user_badge_progress_list
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 limit: 1.2, # Float |
17 skip: 1.2 # Float |
18}
19
20begin
21
22 result = api_instance.get_user_badge_progress_list(tenant_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
26end
27

Создать значок пользователя Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да

Ответ

Возвращает: CreateUserBadge200Response

Пример

Пример create_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams |
15
16begin
17
18 result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->create_user_badge: #{e}"
22end
23

Удалить значок пользователя Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: UpdateUserBadge200Response

Пример

delete_user_badge Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23

Получить значок пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetUserBadge200Response

Пример

get_user_badge Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настроить авторизацию по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23

Получить значки пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Yes
userId string query No
badgeId string query No
type number query No
displayedOnComments boolean query No
limit number query No
skip number query No

Ответ

Возвращает: GetUserBadges200Response

Пример

Пример get_user_badges
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 badge_id: 'badge_id_example', # String |
17 type: 1.2, # Float |
18 displayed_on_comments: true, # Boolean |
19 limit: 1.2, # Float |
20 skip: 1.2 # Float |
21}
22
23begin
24
25 result = api_instance.get_user_badges(tenant_id, opts)
26 p result
27rescue FastCommentsClient::ApiError => e
28 puts "Error when calling DefaultApi->get_user_badges: #{e}"
29end
30

Обновить значок пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: UpdateUserBadge200Response

Пример

Пример update_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации с помощью API-ключа: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams |
16
17begin
18
19 result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_user_badge: #{e}"
23end
24

Получить количество уведомлений пользователя Internal Link

Параметры

Имя Тип Расположение Обязательный Описание
tenantId string query Да
sso string query Нет

Ответ

Возвращает: GetUserNotificationCount200Response

Пример

get_user_notification_count Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7opts = {
8 sso: 'sso_example' # Строка |
9}
10
11begin
12
13 result = api_instance.get_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->get_user_notification_count: #{e}"
17end
18

Получить уведомления пользователя Internal Link

Параметры

Name Type Location Required Description
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

Пример

get_user_notifications Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7opts = {
8 page_size: 56, # Целое число |
9 after_id: 'after_id_example', # Строка |
10 include_context: true, # Логическое значение |
11 after_created_at: 789, # Целое число |
12 unread_only: true, # Логическое значение |
13 dm_only: true, # Логическое значение |
14 no_dm: true, # Логическое значение |
15 include_translations: true, # Логическое значение |
16 sso: 'sso_example' # Строка |
17}
18
19begin
20
21 result = api_instance.get_user_notifications(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling PublicApi->get_user_notifications: #{e}"
25end
26

Сбросить количество уведомлений пользователя Internal Link

Параметры

Имя Тип Местоположение Обязательно Описание
tenantId string query Да
sso string query Нет

Ответ

Возвращает: ResetUserNotifications200Response

Пример

Пример reset_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 sso: 'sso_example' # String |
9}
10
11begin
12
13 result = api_instance.reset_user_notification_count(tenant_id, opts)
14 p result
15rescue FastCommentsClient::ApiError => e
16 puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
17end
18

Сбросить уведомления пользователя Internal Link

Параметры

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

Пример

Пример reset_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7opts = {
8 after_id: 'after_id_example', # Строка |
9 after_created_at: 789, # Целое число |
10 unread_only: true, # Булево |
11 dm_only: true, # Булево |
12 no_dm: true, # Булево |
13 sso: 'sso_example' # Строка |
14}
15
16begin
17
18 result = api_instance.reset_user_notifications(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->reset_user_notifications: #{e}"
22end
23

Обновить статус подписки на уведомления о комментариях пользователя Internal Link


Включает или отключает уведомления для конкретного комментария.

Параметры

Name Type Location Required Description
tenantId string query Да
notificationId string path Да
optedInOrOut string path Да
commentId string query Да
sso string query Нет

Ответ

Возвращает: UpdateUserNotificationStatus200Response

Пример

Пример update_user_notification_comment_subscription_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7notification_id = 'notification_id_example' # String |
8opted_in_or_out = 'in' # String |
9comment_id = 'comment_id_example' # String |
10opts = {
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
20end
21

Обновить статус подписки на уведомления по странице пользователя Internal Link

Включение или отключение уведомлений для страницы. Когда пользователи подписаны на страницу, создаются уведомления для новых корневых комментариев, а также

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
urlId string query Да
url string query Да
pageTitle string query Да
subscribedOrUnsubscribed string path Да
sso string query Нет

Ответ

Возвращает: UpdateUserNotificationStatus200Response

Пример

Пример update_user_notification_page_subscription_status
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8url = 'url_example' # String |
9page_title = 'page_title_example' # String |
10subscribed_or_unsubscribed = 'subscribe' # String |
11opts = {
12 sso: 'sso_example' # String |
13}
14
15begin
16
17 result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
21end
22

Обновить статус уведомлений пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
notificationId string path Да
newStatus string path Да
sso string query Нет

Ответ

Возвращает: UpdateUserNotificationStatus200Response

Пример

update_user_notification_status Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7notification_id = 'notification_id_example' # String |
8new_status = 'read' # String |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->update_user_notification_status: #{e}"
19end
20

Получить статусы присутствия пользователей Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
urlIdWS string query Да
userIds string query Да

Ответ

Возвращает: GetUserPresenceStatuses200Response

Пример

Пример get_user_presence_statuses
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Строка |
7url_id_ws = 'url_id_ws_example' # Строка |
8user_ids = 'user_ids_example' # Строка |
9
10begin
11
12 result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
16end
17

Поиск пользователей Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string path Да
urlId string query Да
usernameStartsWith string query Да
mentionGroupIds array query Нет
sso string query Нет

Ответ

Возвращает: SearchUsers200Response

Пример

Пример search_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8username_starts_with = 'username_starts_with_example' # String |
9opts = {
10 mention_group_ids: ['inner_example'], # Array<String> |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.search_users(tenant_id, url_id, username_starts_with, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->search_users: #{e}"
20end
21

Получить пользователя Internal Link

Параметры

Имя Тип Location Обязательный Описание
tenantId string query Да
id string path Да

Ответ

Возвращает: GetUser200Response

Пример

Пример get_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы установить префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.get_user(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user: #{e}"
22end
23

Создать голос Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
commentId string query Да
direction string query Да
userId string query Нет
anonUserId string query Нет

Ответ

Возвращает: VoteComment200Response

Пример

create_vote Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14comment_id = 'comment_id_example' # String |
15direction = 'up' # String |
16opts = {
17 user_id: 'user_id_example', # String |
18 anon_user_id: 'anon_user_id_example' # String |
19}
20
21begin
22
23 result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->create_vote: #{e}"
27end
28

Удалить голос Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
id string path Да
editKey string query Нет

Ответ

Возвращает: DeleteCommentVote200Response

Пример

Пример delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации ключом API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для ключа API, напр. 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 edit_key: 'edit_key_example' # String |
17}
18
19begin
20
21 result = api_instance.delete_vote(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->delete_vote: #{e}"
25end
26

Получить голоса Internal Link

Параметры

Name Type Location Required Description
tenantId string query Да
urlId string query Да

Ответ

Возвращает: GetVotes200Response

Пример

Пример get_votes
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка авторизации
5FastCommentsClient.configure do |config|
6 # Настройка авторизации по API-ключу: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Раскомментируйте следующую строку, чтобы задать префикс для API-ключа, например 'Bearer' (по умолчанию nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15
16begin
17
18 result = api_instance.get_votes(tenant_id, url_id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_votes: #{e}"
22end
23

Получить голоса пользователя Internal Link

Параметры

Имя Тип Расположение Обязательно Описание
tenantId string query Да
urlId string query Да
userId string query Нет
anonUserId string query Нет

Ответ

Возвращает: GetVotesForUser200Response

Пример

Пример get_votes_for_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# setup authorization
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14url_id = 'url_id_example' # String |
15opts = {
16 user_id: 'user_id_example', # String |
17 anon_user_id: 'anon_user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
26end
27

Нужна помощь?

Если вы столкнулись с какими-либо проблемами или у вас есть вопросы по Ruby SDK, пожалуйста:

Участие

Вклады приветствуются! Пожалуйста, посетите репозиторий на GitHub для получения руководства по внесению вклада.