FastComments SDK для Ruby

Це офіційний Ruby SDK для FastComments.

Офіційний Ruby SDK для API FastComments

Репозиторій

Встановлення

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Library Contents

This library contains the generated API client and the SSO utilities to make working with the API easier.

Документація бібліотеки клієнта API

Public vs Secured APIs

For the API client, there are three classes, DefaultApi, PublicApi, and ModerationApi. The DefaultApi contains methods that require your API key, and PublicApi contains api calls that can be made directly from a browser/mobile device/etc without authentication. The ModerationApi contains the methods that power the moderator dashboard.

The ModerationApi provides an extensive suite of live and fast moderation APIs. Every ModerationApi method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.

Швидкий старт

Використання автентифікованих API (DefaultApi)

Важливо: Ви повинні встановити ваш API-ключ у ApiClient перед виконанням автентифікованих запитів. Якщо не зробите, запити завершаться помилкою 401.

require 'fastcomments'

# Створити та налаштувати клієнт API
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# ОБОВ'ЯЗКОВО: Встановити ваш API-ключ (отримайте його у вашій панелі FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Створити екземпляр API з налаштованим клієнтом
api = FastCommentsClient::DefaultApi.new(api_client)

# Тепер ви можете робити автентифіковані виклики API
begin
  # Приклад: Додати SSO користувача
  user_data = {
    id: 'user-123',
    email: 'user@example.com',
    displayName: 'John Doe'
  }

  response = api.add_sso_user('YOUR_TENANT_ID', user_data)
  puts "User created: #{response}"

rescue FastCommentsClient::ApiError => e
  puts "Error: #{e.response_body}"
  # Поширені помилки:
  # - 401: API-ключ відсутній або недійсний
  # - 400: Валідація запиту не пройшла
end

Використання публічних API (PublicApi)

Публічні кінцеві точки не вимагають автентифікації:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

begin
  response = public_api.get_comments_public(
    'YOUR_TENANT_ID',
    'page-url-id'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Використання модераційних API (ModerationApi)

Методи модерації забезпечують роботу панелі модератора. Передайте токен sso, щоб запит був виконаний від імені модератора, автентифікованого через SSO:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Приклад: Список коментарів у черзі модерації
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Поширені проблеми

Помилка 401 "missing-api-key": Переконайтеся, що ви встановили config.api_key['x-api-key'] = 'YOUR_KEY' перед створенням екземпляра DefaultApi.
Невірний клас API: Використовуйте DefaultApi для серверних автентифікованих запитів, PublicApi для клієнтських/публічних запитів та ModerationApi для запитів панелі модератора.
Null API-ключ: SDK тихо пропустить автентифікацію, якщо API-ключ дорівнює null, що призведе до помилок 401.

Примітки

Ідентифікатори трансляцій

Ви побачите, що у деяких викликах API потрібно передати broadcastId. Коли ви отримуєте події, цей ідентифікатор повертається, тож ви знатимете ігнорувати подію, якщо плануєте оптимістично застосовувати зміни на клієнті (що, ймовірно, ви й захочете зробити, оскільки це забезпечує найкращий досвід). Передайте тут UUID. Ідентифікатор повинен бути достатньо унікальним, щоб не повторюватися двічі протягом сесії браузера.

SSO (Єдиний вхід)

Приклади SSO див. нижче.

Використання SSO

Простий SSO

require 'fastcomments'

# Створити токен 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(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

Безпечний SSO

require 'fastcomments'

# Створити токен 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(
  'your-tenant-id',
  'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

aggregate

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

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
parentTenantId	string	query	No
includeStats	boolean	query	No

Відповідь

Повертає: AggregateResponse

Приклад

Приклад aggregate

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
aggregation_request = FastCommentsClient::AggregationRequest.new({resource_name: 'resource_name_example', operations: [FastCommentsClient::AggregationOperation.new({field: 'field_example', op: FastCommentsClient::AggregationOpType::SUM})]}) # AggregationRequest | 
opts = {
  parent_tenant_id: 'parent_tenant_id_example', # String | 
  include_stats: true # Boolean | 
}
begin
  
  result = api_instance.aggregate(tenant_id, aggregation_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate: #{e}"
end

get_audit_logs

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
limit	number	query	Ні
skip	number	query	Ні
order	string	query	Ні
after	number	query	Ні
before	number	query	Ні

Відповідь

Повертає: GetAuditLogsResponse

Приклад

Приклад get_audit_logs

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію через API-ключ: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  limit: 1.2, # Float | 
  skip: 1.2, # Float | 
  order: FastCommentsClient::SORTDIR::ASC, # SORTDIR | 
  after: 1.2, # Float | 
  before: 1.2 # Float | 
}
begin
  
  result = api_instance.get_audit_logs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_audit_logs: #{e}"
end

logout_public

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад logout_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
begin
  
  result = api_instance.logout_public
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->logout_public: #{e}"
end

block_from_comment_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: BlockSuccess

Приклад

block_from_comment_public Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->block_from_comment_public: #{e}"
end

un_block_comment_public

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UnblockSuccess

Приклад

un_block_comment_public Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_block_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_block_comment_public: #{e}"
end

checked_comments_for_blocked

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
commentIds	string	query	Так	Список ідентифікаторів коментарів, розділених комами.
sso	string	query	Ні

Відповідь

Повертає: CheckBlockedCommentsResponse

Приклад

checked_comments_for_blocked Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_ids = 'comment_ids_example' # String | Список ідентифікаторів коментарів, розділених комами.
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.checked_comments_for_blocked(tenant_id, comment_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->checked_comments_for_blocked: #{e}"
end

block_user_from_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: BlockSuccess

Приклад

Приклад block_user_from_comment

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API key, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
block_from_comment_params = FastCommentsClient::BlockFromCommentParams.new # BlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.block_user_from_comment(tenant_id, id, block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->block_user_from_comment: #{e}"
end

create_comment_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
sessionId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: SaveCommentsResponseWithPresence

Приклад

create_comment_public Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_data = FastCommentsClient::CommentData.new({commenter_name: 'commenter_name_example', comment: 'comment_example', url: 'url_example', url_id: 'url_id_example'}) # CommentData | 
opts = {
  session_id: 'session_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_comment_public(tenant_id, url_id, broadcast_id, comment_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_comment_public: #{e}"
end

delete_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
contextUserId	string	query	Ні
isLive	boolean	query	Ні

Відповідь

Повертає: DeleteCommentResult

Приклад

Приклад delete_comment

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.delete_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_comment: #{e}"
end

delete_comment_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: PublicAPIDeleteCommentResponse

Приклад

Приклад delete_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_public(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_public: #{e}"
end

delete_comment_vote

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
voteId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: VoteDeleteResponse

Приклад

Приклад delete_comment_vote

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
url_id = 'url_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_comment_vote: #{e}"
end

flag_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: FlagCommentResponse

Приклад

Приклад flag_comment

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр., 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->flag_comment: #{e}"
end

get_comment

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIGetCommentResponse

Приклад

Приклад get_comment

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_comment(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comment: #{e}"
end

get_comment_text

Параметри

Ім'я	Тип	Розташування	Обов'язковий
tenantId	string	path	Так
commentId	string	path	Так
editKey	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: PublicAPIGetCommentTextResponse

Приклад

Приклад get_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_text: #{e}"
end

get_comment_vote_user_names

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	path	Так
commentId	string	path	Так
dir	integer	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentVoteUserNamesSuccessResponse

Приклад

get_comment_vote_user_names Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
dir = 56 # Integer | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_vote_user_names(tenant_id, comment_id, dir, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comment_vote_user_names: #{e}"
end

get_comments

Параметри

Назва	Тип	Розташування	Обов'язковий
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	Ні
fromDate	integer	query	Ні
toDate	integer	query	Ні

Відповідь

Повертає: APIGetCommentsResponse

Приклад

Приклад get_comments

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 56, # Integer | 
  limit: 56, # Integer | 
  skip: 56, # Integer | 
  as_tree: true, # Boolean | 
  skip_children: 56, # Integer | 
  limit_children: 56, # Integer | 
  max_tree_depth: 56, # Integer | 
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example', # String | 
  context_user_id: 'context_user_id_example', # String | 
  hash_tag: 'hash_tag_example', # String | 
  parent_id: 'parent_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  from_date: 789, # Integer | 
  to_date: 789 # Integer | 
}
begin
  
  result = api_instance.get_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_comments: #{e}"
end

get_comments_public

req tenantId urlId

Параметри

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

Відповідь

Повертає: GetCommentsResponseWithPresencePublicComment

Приклад

Приклад get_comments_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  page: 56, # Integer | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  sso: 'sso_example', # String | 
  skip: 56, # Integer | 
  skip_children: 56, # Integer | 
  limit: 56, # Integer | 
  limit_children: 56, # Integer | 
  count_children: true, # Boolean | 
  fetch_page_for_comment_id: 'fetch_page_for_comment_id_example', # String | 
  include_config: true, # Boolean | 
  count_all: true, # Boolean | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  modules: 'modules_example', # String | 
  is_crawler: true, # Boolean | 
  include_notification_count: true, # Boolean | 
  as_tree: true, # Boolean | 
  max_tree_depth: 56, # Integer | 
  use_full_translation_ids: true, # Boolean | 
  parent_id: 'parent_id_example', # String | 
  search_text: 'search_text_example', # String | 
  hash_tags: ['inner_example'], # Array<String> | 
  user_id: 'user_id_example', # String | 
  custom_config_str: 'custom_config_str_example', # String | 
  after_comment_id: 'after_comment_id_example', # String | 
  before_comment_id: 'before_comment_id_example' # String | 
}
begin
  
  result = api_instance.get_comments_public(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_public: #{e}"
end

lock_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

lock_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->lock_comment: #{e}"
end

pin_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ChangeCommentPinStatusResponse

Приклад

Приклад pin_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->pin_comment: #{e}"
end

save_comment

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
isLive	boolean	query	Ні
doSpamCheck	boolean	query	Ні
sendEmails	boolean	query	Ні
populateNotifications	boolean	query	Ні

Відповідь

Повертає: APISaveCommentResponse

Приклад

Приклад save_comment

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comment(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comment: #{e}"
end

save_comments_bulk

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
isLive	boolean	query	Ні
doSpamCheck	boolean	query	Ні
sendEmails	boolean	query	Ні
populateNotifications	boolean	query	Ні

Відповідь

Повертає: SaveCommentsBulkResponse

Приклад

save_comments_bulk Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр., 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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> | 
opts = {
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  send_emails: true, # Boolean | 
  populate_notifications: true # Boolean | 
}
begin
  
  result = api_instance.save_comments_bulk(tenant_id, create_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->save_comments_bulk: #{e}"
end

set_comment_text

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Yes
commentId	string	path	Yes
broadcastId	string	query	Yes
editKey	string	query	No
sso	string	query	No

Відповідь

Повертає: PublicAPISetCommentTextResponse

Приклад

set_comment_text Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
comment_text_update_request = FastCommentsClient::CommentTextUpdateRequest.new({comment: 'comment_example'}) # CommentTextUpdateRequest | 
opts = {
  edit_key: 'edit_key_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_comment_text(tenant_id, comment_id, broadcast_id, comment_text_update_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->set_comment_text: #{e}"
end

un_block_user_from_comment

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: UnblockSuccess

Приклад

un_block_user_from_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
un_block_from_comment_params = FastCommentsClient::UnBlockFromCommentParams.new # UnBlockFromCommentParams | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_block_user_from_comment(tenant_id, id, un_block_from_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_block_user_from_comment: #{e}"
end

un_flag_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: FlagCommentResponse

Приклад

Приклад un_flag_comment

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр., 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.un_flag_comment(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->un_flag_comment: #{e}"
end

un_lock_comment

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

un_lock_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_lock_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_lock_comment: #{e}"
end

un_pin_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
commentId	string	path	Так
broadcastId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ChangeCommentPinStatusResponse

Приклад

un_pin_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
broadcast_id = 'broadcast_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.un_pin_comment(tenant_id, comment_id, broadcast_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->un_pin_comment: #{e}"
end

update_comment

Parameters

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
contextUserId	string	query	Ні
doSpamCheck	boolean	query	Ні
isLive	boolean	query	Ні

Response

Повертає: APIEmptyResponse

Example

Приклад update_comment

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
updatable_comment_params = FastCommentsClient::UpdatableCommentParams.new # UpdatableCommentParams | 
opts = {
  context_user_id: 'context_user_id_example', # String | 
  do_spam_check: true, # Boolean | 
  is_live: true # Boolean | 
}
begin
  
  result = api_instance.update_comment(tenant_id, id, updatable_comment_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_comment: #{e}"
end

vote_comment

Параметри

Назва	Тип	Location	Обов'язковий
tenantId	string	path	Так
commentId	string	path	Так
urlId	string	query	Так
broadcastId	string	query	Так
sessionId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: VoteResponse

Приклад

Приклад vote_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Рядок | 
comment_id = 'comment_id_example' # Рядок | 
url_id = 'url_id_example' # Рядок | 
broadcast_id = 'broadcast_id_example' # Рядок | 
vote_body_params = FastCommentsClient::VoteBodyParams.new({commenter_email: 'commenter_email_example', commenter_name: 'commenter_name_example', vote_dir: 'up', url: 'url_example'}) # VoteBodyParams | 
opts = {
  session_id: 'session_id_example', # Рядок | 
  sso: 'sso_example' # Рядок | 
}
begin
  
  result = api_instance.vote_comment(tenant_id, comment_id, url_id, broadcast_id, vote_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->vote_comment: #{e}"
end

get_comments_for_user

Параметри

Name	Type	Location	Required
userId	string	query	Ні
direction	string	query	Ні
repliesToUserId	string	query	Ні
page	number	query	Ні
includei10n	boolean	query	Ні
locale	string	query	Ні
isCrawler	boolean	query	Ні

Відповідь

Повертає: GetCommentsForUserResponse

Приклад

Приклад get_comments_for_user

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
opts = {
  user_id: 'user_id_example', # String | 
  direction: FastCommentsClient::SortDirections::OF, # SortDirections | 
  replies_to_user_id: 'replies_to_user_id_example', # String | 
  page: 1.2, # Float | 
  includei10n: true, # Boolean | 
  locale: 'locale_example', # String | 
  is_crawler: true # Boolean | 
}
begin
  
  result = api_instance.get_comments_for_user(opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_comments_for_user: #{e}"
end

add_domain_config

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: AddDomainConfigResponse

Приклад

Приклад add_domain_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
add_domain_config_params = FastCommentsClient::AddDomainConfigParams.new({domain: 'domain_example'}) # AddDomainConfigParams | 
begin
  
  result = api_instance.add_domain_config(tenant_id, add_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_domain_config: #{e}"
end

delete_domain_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
domain	string	path	Так

Відповідь

Повертає: DeleteDomainConfigResponse

Приклад

Приклад delete_domain_config

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API key: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API key, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.delete_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_domain_config: #{e}"
end

get_domain_config

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
domain	string	path	Так

Відповідь

Повертає: GetDomainConfigResponse

Приклад

Приклад get_domain_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain = 'domain_example' # String | 
begin
  
  result = api_instance.get_domain_config(tenant_id, domain)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_config: #{e}"
end

get_domain_configs

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так

Відповідь

Повертає: GetDomainConfigsResponse

Приклад

Приклад get_domain_configs

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для ключа API, напр., 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_domain_configs(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_domain_configs: #{e}"
end

patch_domain_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
domainToUpdate	string	path	Так

Відповідь

Повертає: PatchDomainConfigResponse

Приклад

Приклад patch_domain_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
patch_domain_config_params = FastCommentsClient::PatchDomainConfigParams.new # PatchDomainConfigParams | 
begin
  
  result = api_instance.patch_domain_config(tenant_id, domain_to_update, patch_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_domain_config: #{e}"
end

put_domain_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
domainToUpdate	string	path	Так

Відповідь

Повертає: PutDomainConfigResponse

Приклад

Приклад put_domain_config

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
domain_to_update = 'domain_to_update_example' # String | 
update_domain_config_params = FastCommentsClient::UpdateDomainConfigParams.new({domain: 'domain_example'}) # UpdateDomainConfigParams | 
begin
  
  result = api_instance.put_domain_config(tenant_id, domain_to_update, update_domain_config_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_domain_config: #{e}"
end

create_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateEmailTemplateResponse

Приклад

Приклад create_email_template

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_email_template_body = FastCommentsClient::CreateEmailTemplateBody.new({email_template_id: 'email_template_id_example', display_name: 'display_name_example', ejs: 'ejs_example'}) # CreateEmailTemplateBody | 
begin
  
  result = api_instance.create_email_template(tenant_id, create_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_email_template: #{e}"
end

delete_email_template

Параметри

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

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_email_template

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template: #{e}"
end

delete_email_template_render_error

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
id	string	path	Так
errorId	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

delete_email_template_render_error Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
error_id = 'error_id_example' # String | 
begin
  
  result = api_instance.delete_email_template_render_error(tenant_id, id, error_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_email_template_render_error: #{e}"
end

get_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetEmailTemplateResponse

Приклад

Приклад get_email_template

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_email_template(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template: #{e}"
end

get_email_template_definitions

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: GetEmailTemplateDefinitionsResponse

Приклад

get_email_template_definitions Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_email_template_definitions(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_definitions: #{e}"
end

get_email_template_render_errors

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
skip	number	query	Ні

Відповідь

Повертає: GetEmailTemplateRenderErrorsResponse

Приклад

Приклад get_email_template_render_errors

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
end

get_email_templates

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetEmailTemplatesResponse

Приклад

Приклад get_email_templates

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_email_templates(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_email_templates: #{e}"
end

render_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
locale	string	query	Ні

Відповідь

Повертає: RenderEmailTemplateResponse

Приклад

Приклад render_email_template

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
render_email_template_body = FastCommentsClient::RenderEmailTemplateBody.new({email_template_id: 'email_template_id_example', ejs: 'ejs_example'}) # RenderEmailTemplateBody | 
opts = {
  locale: 'locale_example' # String | 
}
begin
  
  result = api_instance.render_email_template(tenant_id, render_email_template_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->render_email_template: #{e}"
end

update_email_template

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_email_template

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_email_template_body = FastCommentsClient::UpdateEmailTemplateBody.new # UpdateEmailTemplateBody | 
begin
  
  result = api_instance.update_email_template(tenant_id, id, update_email_template_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_email_template: #{e}"
end

get_event_log

req tenantId urlId userIdWS

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	path	Так
urlId	string	query	Так
userIdWS	string	query	Так
startTime	integer	query	Так
endTime	integer	query	Ні

Відповідь

Повертає: GetEventLogResponse

Приклад

get_event_log Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_event_log: #{e}"
end

get_global_event_log

req tenantId urlId userIdWS

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
urlId	string	query	Так
userIdWS	string	query	Так
startTime	integer	query	Так
endTime	integer	query	Ні

Відповідь

Повертає: GetEventLogResponse

Приклад

Приклад get_global_event_log

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
user_id_ws = 'user_id_ws_example' # String | 
start_time = 789 # Integer | 
opts = {
  end_time: 789 # Integer | 
}
begin
  
  result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_global_event_log: #{e}"
end

create_feed_post

Параметри

Ім'я	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
broadcastId	string	query	No
isLive	boolean	query	No
doSpamCheck	boolean	query	No
skipDupCheck	boolean	query	No

Відповідь

Повертає: CreateFeedPostsResponse

Приклад

Приклад create_feed_post

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  is_live: true, # Boolean | 
  do_spam_check: true, # Boolean | 
  skip_dup_check: true # Boolean | 
}
begin
  
  result = api_instance.create_feed_post(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_feed_post: #{e}"
end

create_feed_post_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: CreateFeedPostResponse

Приклад

create_feed_post_public Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
create_feed_post_params = FastCommentsClient::CreateFeedPostParams.new # CreateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.create_feed_post_public(tenant_id, create_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_feed_post_public: #{e}"
end

delete_feed_post_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
postId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: DeleteFeedPostPublicResponse

Приклад

Приклад delete_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_feed_post_public(tenant_id, post_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_feed_post_public: #{e}"
end

get_feed_posts

req tenantId afterId

Параметри

Назва	Тип	Розташування	Обов'язкове
tenantId	string	query	Так
afterId	string	query	Ні
limit	integer	query	Ні
tags	array	query	Ні

Відповідь

Повертає: GetFeedPostsResponse

Приклад

get_feed_posts Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'] # Array<String> | 
}
begin
  
  result = api_instance.get_feed_posts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_feed_posts: #{e}"
end

get_feed_posts_public

req tenantId afterId

Параметри

Назва	Тип	Місце	Обов'язково
tenantId	string	path	Так
afterId	string	query	Ні
limit	integer	query	Ні
tags	array	query	Ні
sso	string	query	Ні
isCrawler	boolean	query	Ні
includeUserInfo	boolean	query	Ні

Відповідь

Повертає: PublicFeedPostsResponse

Приклад

Приклад get_feed_posts_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  limit: 56, # Integer | 
  tags: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  is_crawler: true, # Boolean | 
  include_user_info: true # Boolean | 
}
begin
  
  result = api_instance.get_feed_posts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_public: #{e}"
end

get_feed_posts_stats

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
postIds	array	query	Так
sso	string	query	Ні

Відповідь

Повертає: FeedPostsStatsResponse

Приклад

get_feed_posts_stats Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_ids = ['inner_example'] # Array<String> | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_feed_posts_stats(tenant_id, post_ids, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_feed_posts_stats: #{e}"
end

get_user_reacts_public

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
postIds	array	query	Ні
sso	string	query	Ні

Відповідь

Повертає: UserReactsResponse

Приклад

Приклад get_user_reacts_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  post_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_reacts_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
end

react_feed_post_public

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
postId	string	path	Так
isUndo	boolean	query	Ні
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ReactFeedPostResponse

Приклад

Приклад react_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
react_body_params = FastCommentsClient::ReactBodyParams.new # ReactBodyParams | 
opts = {
  is_undo: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.react_feed_post_public(tenant_id, post_id, react_body_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->react_feed_post_public: #{e}"
end

update_feed_post

Параметри

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

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_feed_post

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
feed_post = FastCommentsClient::FeedPost.new({_id: '_id_example', tenant_id: 'tenant_id_example', created_at: Time.now}) # FeedPost | 
begin
  
  result = api_instance.update_feed_post(tenant_id, id, feed_post)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_feed_post: #{e}"
end

update_feed_post_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
postId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: CreateFeedPostResponse

Приклад

Приклад update_feed_post_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
post_id = 'post_id_example' # String | 
update_feed_post_params = FastCommentsClient::UpdateFeedPostParams.new # UpdateFeedPostParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_feed_post_public(tenant_id, post_id, update_feed_post_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_feed_post_public: #{e}"
end

flag_comment_public

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
isFlagged	boolean	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад flag_comment_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
is_flagged = true # Boolean | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.flag_comment_public(tenant_id, comment_id, is_flagged, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->flag_comment_public: #{e}"
end

get_gif_large

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Так
largeInternalURLSanitized	string	query	Так

Response

Повертає: GifGetLargeResponse

Example

Приклад get_gif_large

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Рядок | 
large_internal_url_sanitized = 'large_internal_url_sanitized_example' # Рядок | 
begin
  
  result = api_instance.get_gif_large(tenant_id, large_internal_url_sanitized)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gif_large: #{e}"
end

get_gifs_search

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
search	string	query	Так
locale	string	query	Ні
rating	string	query	Ні
page	number	query	Ні

Відповідь

Повертає: GetGifsSearchResponse

Приклад

Приклад get_gifs_search

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Рядок | 
search = 'search_example' # Рядок | 
opts = {
  locale: 'locale_example', # Рядок | 
  rating: 'rating_example', # Рядок | 
  page: 1.2 # Число з плаваючою комою | 
}
begin
  
  result = api_instance.get_gifs_search(tenant_id, search, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_search: #{e}"
end

Параметри

Name	Type	Location	Required
tenantId	string	path	Yes
locale	string	query	No
rating	string	query	No
page	number	query	No

Відповідь

Повертає: GetGifsTrendingResponse

Приклад

Приклад get_gifs_trending

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  rating: 'rating_example', # String | 
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_gifs_trending(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_gifs_trending: #{e}"
end

add_hash_tag

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateHashTagResponse

Приклад

add_hash_tag Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody | 
begin
  
  result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tag: #{e}"
end

add_hash_tags_bulk

Параметри

Назва	Тип	Розташування	Обов’язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: BulkCreateHashTagsResponse

Приклад

add_hash_tags_bulk Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр., 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody | 
begin
  
  result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
end

delete_hash_tag

Параметри

Назва	Тип	Розташування	Обов’язковий	Опис
tenantId	string	query	Так
tag	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_hash_tag

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію ключем API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody | 
begin
  
  result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
end

get_hash_tags

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
page	number	query	Ні

Відповідь

Повертає: GetHashTagsResponse

Приклад

get_hash_tags Приклад

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  page: 1.2 # Float | 
}
begin
  
  result = api_instance.get_hash_tags(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_hash_tags: #{e}"
end

patch_hash_tag

Параметри

Ім'я	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
tag	string	path	Так

Відповідь

Повертає: UpdateHashTagResponse

Приклад

patch_hash_tag Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
tag = 'tag_example' # String | 
update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody | 
begin
  
  result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
end

delete_moderation_vote

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
voteId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: VoteDeleteResponse

Приклад

delete_moderation_vote Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
vote_id = 'vote_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.delete_moderation_vote(tenant_id, comment_id, vote_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->delete_moderation_vote: #{e}"
end

get_api_comments

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
page	number	query	No
count	number	query	No
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
demo	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ModerationAPIGetCommentsResponse

Приклад

Приклад get_api_comments

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Рядок | 
opts = {
  page: 1.2, # Дробове | 
  count: 1.2, # Дробове | 
  text_search: 'text_search_example', # Рядок | 
  by_ip_from_comment: 'by_ip_from_comment_example', # Рядок | 
  filters: 'filters_example', # Рядок | 
  search_filters: 'search_filters_example', # Рядок | 
  sorts: 'sorts_example', # Рядок | 
  demo: true, # Логічний | 
  sso: 'sso_example' # Рядок | 
}
begin
  
  result = api_instance.get_api_comments(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_comments: #{e}"
end

get_api_export_status

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
batchJobId	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationExportStatusResponse

Приклад

get_api_export_status Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  batch_job_id: 'batch_job_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_export_status(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_export_status: #{e}"
end

get_api_ids

Параметри

Назва	Тип	Місце	Обовʼязково
tenantId	string	query	Так
text-search	string	query	Ні
byIPFromComment	string	query	Ні
filters	string	query	Ні
searchFilters	string	query	Ні
afterId	string	query	Ні
demo	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIGetCommentIdsResponse

Приклад

Приклад get_api_ids

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  after_id: 'after_id_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_api_ids(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_api_ids: #{e}"
end

get_ban_users_from_comment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetBannedUsersFromCommentResponse

Приклад

Приклад get_ban_users_from_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_ban_users_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_ban_users_from_comment: #{e}"
end

get_comment_ban_status

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: GetCommentBanStatusResponse

Приклад

get_comment_ban_status Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_ban_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_ban_status: #{e}"
end

get_comment_children

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIChildCommentsResponse

Приклад

get_comment_children Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_comment_children(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_comment_children: #{e}"
end

get_count

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
text-search	string	query	Ні
byIPFromComment	string	query	Ні
filter	string	query	Ні
searchFilters	string	query	Ні
demo	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationAPICountCommentsResponse

Приклад

get_count Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filter: 'filter_example', # String | 
  search_filters: 'search_filters_example', # String | 
  demo: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Помилка під час виклику ModerationApi->get_count: #{e}"
end

get_counts

Параметри

Назва	Тип	Розташування	Обов’язковий	Опис
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetBannedUsersCountResponse

Приклад

Приклад get_counts

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_counts(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_counts: #{e}"
end

get_logs

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
commentId	string	path	Yes
sso	string	query	No

Відповідь

Повертає: ModerationAPIGetLogsResponse

Приклад

Приклад get_logs

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_logs(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_logs: #{e}"
end

get_manual_badges

Параметри

Назва	Тип	Місцезнаходження	Обов’язковий	Опис
tenantId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: GetTenantManualBadgesResponse

Приклад

Приклад get_manual_badges

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_manual_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_manual_badges: #{e}"
end

get_manual_badges_for_user

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
badgesUserId	string	query	No
commentId	string	query	No
sso	string	query	No

Відповідь

Повертає: GetUserManualBadgesResponse

Приклад

Приклад get_manual_badges_for_user

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  badges_user_id: 'badges_user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_manual_badges_for_user(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Помилка під час виклику ModerationApi->get_manual_badges_for_user: #{e}"
end

get_moderation_comment

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
commentId	string	path	Yes
includeEmail	boolean	query	No
includeIP	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ModerationAPICommentResponse

Приклад

Приклад get_moderation_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_email: true, # Boolean | 
  include_ip: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment: #{e}"
end

get_moderation_comment_text

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	запит	Так
commentId	string	шлях	Так
sso	string	запит	Ні

Відповідь

Повертає: GetCommentTextResponse

Приклад

Приклад get_moderation_comment_text

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_moderation_comment_text(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_moderation_comment_text: #{e}"
end

get_pre_ban_summary

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
includeByUserIdAndEmail	boolean	query	Ні
includeByIP	boolean	query	Ні
includeByEmailDomain	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: PreBanSummary

Приклад

get_pre_ban_summary Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  include_by_user_id_and_email: true, # Boolean | 
  include_by_ip: true, # Boolean | 
  include_by_email_domain: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
end

get_search_comments_summary

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
value	string	query	Ні
filters	string	query	Ні
searchFilters	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationCommentSearchResponse

Приклад

Приклад get_search_comments_summary

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_comments_summary(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
end

get_search_pages

Parameters

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Response

Повертає: ModerationPageSearchResponse

Приклад

get_search_pages Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_pages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_pages: #{e}"
end

get_search_sites

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
value	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationSiteSearchResponse

Приклад

get_search_sites Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_sites(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_sites: #{e}"
end

get_search_suggest

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
text-search	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationSuggestResponse

Приклад

Приклад get_search_suggest

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_suggest(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_suggest: #{e}"
end

get_search_users

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
value	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: ModerationUserSearchResponse

Приклад

Приклад get_search_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  value: 'value_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_search_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_search_users: #{e}"
end

get_trust_factor

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
userId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: GetUserTrustFactorResponse

Приклад

Приклад get_trust_factor

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Рядок | 
opts = {
  user_id: 'user_id_example', # Рядок | 
  sso: 'sso_example' # Рядок | 
}
begin
  
  result = api_instance.get_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_trust_factor: #{e}"
end

get_user_ban_preference

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIModerateGetUserBanPreferencesResponse

Приклад

Приклад get_user_ban_preference

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_ban_preference(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_ban_preference: #{e}"
end

get_user_internal_profile

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: GetUserInternalProfileResponse

Приклад

get_user_internal_profile Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_internal_profile(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->get_user_internal_profile: #{e}"
end

post_adjust_comment_votes

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: AdjustVotesResponse

Приклад

post_adjust_comment_votes Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
end

post_api_export

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
text-search	string	query	No
byIPFromComment	string	query	No
filters	string	query	No
searchFilters	string	query	No
sorts	string	query	No
sso	string	query	No

Відповідь

Повертає: ModerationExportResponse

Приклад

post_api_export Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  text_search: 'text_search_example', # String | 
  by_ip_from_comment: 'by_ip_from_comment_example', # String | 
  filters: 'filters_example', # String | 
  search_filters: 'search_filters_example', # String | 
  sorts: 'sorts_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_api_export(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_api_export: #{e}"
end

post_ban_user_from_comment

Параметри

Назва	Тип	Розташування	Обовʼязковий
tenantId	string	query	Yes
commentId	string	path	Yes
banEmail	boolean	query	No
banEmailDomain	boolean	query	No
banIP	boolean	query	No
deleteAllUsersComments	boolean	query	No
bannedUntil	string	query	No
isShadowBan	boolean	query	No
updateId	string	query	No
banReason	string	query	No
sso	string	query	No

Відповідь

Повертає: BanUserFromCommentResult

Приклад

post_ban_user_from_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Рядок |
comment_id = 'comment_id_example' # Рядок |
opts = {
  ban_email: true, # Логічний |
  ban_email_domain: true, # Логічний |
  ban_ip: true, # Логічний |
  delete_all_users_comments: true, # Логічний |
  banned_until: 'banned_until_example', # Рядок |
  is_shadow_ban: true, # Логічний |
  update_id: 'update_id_example', # Рядок |
  ban_reason: 'ban_reason_example', # Рядок |
  sso: 'sso_example' # Рядок |
}
begin
  
  result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_from_comment: #{e}"
end

post_ban_user_undo

Параметри

Назва	Тип	Розташування	Обов’язковий	Опис
tenantId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

post_ban_user_undo Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
ban_user_undo_params = FastCommentsClient::BanUserUndoParams.new({changelog: FastCommentsClient::APIBanUserChangeLog.new}) # BanUserUndoParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_ban_user_undo(tenant_id, ban_user_undo_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_ban_user_undo: #{e}"
end

post_bulk_pre_ban_summary

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
includeByUserIdAndEmail	boolean	query	Ні
includeByIP	boolean	query	Ні
includeByEmailDomain	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: BulkPreBanSummary

Приклад

Приклад post_bulk_pre_ban_summary

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Рядок |
bulk_pre_ban_params = FastCommentsClient::BulkPreBanParams.new({comment_ids: ['comment_ids_example']}) # BulkPreBanParams |
opts = {
  include_by_user_id_and_email: true, # Boolean |
  include_by_ip: true, # Boolean |
  include_by_email_domain: true, # Boolean |
  sso: 'sso_example' # String |
}
begin
  
  result = api_instance.post_bulk_pre_ban_summary(tenant_id, bulk_pre_ban_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_bulk_pre_ban_summary: #{e}"
end

post_comments_by_ids

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ModerationAPIChildCommentsResponse

Приклад

post_comments_by_ids Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comments_by_ids_params = FastCommentsClient::CommentsByIdsParams.new({ids: ['ids_example']}) # CommentsByIdsParams | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_comments_by_ids(tenant_id, comments_by_ids_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Помилка під час виклику ModerationApi->post_comments_by_ids: #{e}"
end

post_flag_comment

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

post_flag_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_flag_comment: #{e}"
end

post_remove_comment

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: PostRemoveCommentApiResponse

Приклад

Приклад post_remove_comment

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_remove_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Помилка під час виклику ModerationApi->post_remove_comment: #{e}"
end

post_restore_deleted_comment

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

post_restore_deleted_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_restore_deleted_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_restore_deleted_comment: #{e}"
end

post_set_comment_approval_status

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
approved	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: SetCommentApprovedResponse

Приклад

post_set_comment_approval_status Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  approved: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_approval_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_approval_status: #{e}"
end

post_set_comment_review_status

Параметри

Ім'я	Тип	Розташування	Обов’язково
tenantId	string	query	Yes
commentId	string	path	Yes
reviewed	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

post_set_comment_review_status Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # Рядок | 
comment_id = 'comment_id_example' # Рядок | 
opts = {
  reviewed: true, # Булевий | 
  broadcast_id: 'broadcast_id_example', # Рядок | 
  sso: 'sso_example' # Рядок | 
}
begin
  
  result = api_instance.post_set_comment_review_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Помилка під час виклику ModerationApi->post_set_comment_review_status: #{e}"
end

post_set_comment_spam_status

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	path	Yes
spam	boolean	query	No
permNotSpam	boolean	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад post_set_comment_spam_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  spam: true, # Boolean | 
  perm_not_spam: true, # Boolean | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
end

post_set_comment_text

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
commentId	string	path	Yes
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: SetCommentTextResponse

Приклад

post_set_comment_text Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
set_comment_text_params = FastCommentsClient::SetCommentTextParams.new({comment: 'comment_example'}) # SetCommentTextParams | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_set_comment_text(tenant_id, comment_id, set_comment_text_params, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_set_comment_text: #{e}"
end

post_un_flag_comment

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
commentId	string	path	Так
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Returns: APIEmptyResponse

Приклад

post_un_flag_comment Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_un_flag_comment(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->post_un_flag_comment: #{e}"
end

post_vote

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	path	Так
direction	string	query	Ні
broadcastId	string	query	Ні
sso	string	query	Ні

Відповідь

Returns: VoteResponse

Приклад

Приклад post_vote

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  direction: 'direction_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.post_vote(tenant_id, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Помилка під час виклику ModerationApi->post_vote: #{e}"
end

put_award_badge

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: AwardUserBadgeResponse

Приклад

Приклад put_award_badge

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_award_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_award_badge: #{e}"
end

put_close_thread

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
urlId	string	query	Yes
sso	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

put_close_thread Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_close_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_close_thread: #{e}"
end

put_remove_badge

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Yes
badgeId	string	query	Yes
userId	string	query	No
commentId	string	query	No
broadcastId	string	query	No
sso	string	query	No

Відповідь

Повертає: RemoveUserBadgeResponse

Приклад

put_remove_badge Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
badge_id = 'badge_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  comment_id: 'comment_id_example', # String | 
  broadcast_id: 'broadcast_id_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_remove_badge(tenant_id, badge_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_remove_badge: #{e}"
end

put_reopen_thread

Параметри

Назва	Тип	Розташування	Обов’язковий
tenantId	string	query	Так
urlId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

put_reopen_thread Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->put_reopen_thread: #{e}"
end

set_trust_factor

Параметри

Назва	Тип	Розташування	Обов’язково
tenantId	string	query	Так
userId	string	query	Ні
trustFactor	string	query	Ні
sso	string	query	Ні

Відповідь

Повертає: SetUserTrustFactorResponse

Приклад

set_trust_factor Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::ModerationApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  trust_factor: 'trust_factor_example', # String | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.set_trust_factor(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling ModerationApi->set_trust_factor: #{e}"
end

create_moderator

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateModeratorResponse

Приклад

create_moderator Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_moderator_body = FastCommentsClient::CreateModeratorBody.new({name: 'name_example', email: 'email_example'}) # CreateModeratorBody | 
begin
  
  result = api_instance.create_moderator(tenant_id, create_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_moderator: #{e}"
end

delete_moderator

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
sendEmail	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

delete_moderator Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  send_email: 'send_email_example' # String | 
}
begin
  
  result = api_instance.delete_moderator(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_moderator: #{e}"
end

get_moderator

Parameters

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Response

Повертає: GetModeratorResponse

Example

Приклад get_moderator

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_moderator(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderator: #{e}"
end

get_moderators

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetModeratorsResponse

Приклад

Приклад get_moderators

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_moderators(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_moderators: #{e}"
end

send_invite

Параметри

Назва	Тип	Розташування	Обов'язкове
tenantId	string	query	Так
id	string	path	Так
fromName	string	query	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад send_invite

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
from_name = 'from_name_example' # String | 
begin
  
  result = api_instance.send_invite(tenant_id, id, from_name)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_invite: #{e}"
end

update_moderator

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

update_moderator Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштуйте авторизацію
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_moderator_body = FastCommentsClient::UpdateModeratorBody.new # UpdateModeratorBody | 
begin
  
  result = api_instance.update_moderator(tenant_id, id, update_moderator_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_moderator: #{e}"
end

delete_notification_count

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

delete_notification_count Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_notification_count: #{e}"
end

get_cached_notification_count

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetCachedNotificationCountResponse

Приклад

Приклад get_cached_notification_count

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API ключа, наприклад 'Bearer' (за замовчуванням — nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_cached_notification_count(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_cached_notification_count: #{e}"
end

get_notification_count

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
userId	string	query	Ні
urlId	string	query	Ні
fromCommentId	string	query	Ні
viewed	boolean	query	Ні
type	string	query	Ні

Відповідь

Повертає: GetNotificationCountResponse

Приклад

get_notification_count Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example' # String | 
}
begin
  
  result = api_instance.get_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notification_count: #{e}"
end

get_notifications

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
userId	string	query	Ні
urlId	string	query	Ні
fromCommentId	string	query	Ні
viewed	boolean	query	Ні
type	string	query	Ні
skip	number	query	Ні

Відповідь

Повертає: GetNotificationsResponse

Приклад

Приклад get_notifications

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  url_id: 'url_id_example', # String | 
  from_comment_id: 'from_comment_id_example', # String | 
  viewed: true, # Boolean | 
  type: 'type_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_notifications: #{e}"
end

update_notification

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_notification

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API ключем: api_key
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_notification: #{e}"
end

create_v1_page_react

Параметри

Назва	Type	Location	Обов'язковий
tenantId	string	path	Так
urlId	string	query	Так
title	string	query	Ні

Відповідь

Повертає: CreateV1PageReact

Приклад

create_v1_page_react Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v1_page_react(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v1_page_react: #{e}"
end

create_v2_page_react

Parameters

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
id	string	query	Так
title	string	query	Ні

Response

Повертає: CreateV1PageReact

Example

Приклад create_v2_page_react

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
opts = {
  title: 'title_example' # String | 
}
begin
  
  result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->create_v2_page_react: #{e}"
end

delete_v1_page_react

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	path	Так
urlId	string	query	Так

Відповідь

Повертає: CreateV1PageReact

Приклад

delete_v1_page_react Example

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.delete_v1_page_react(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v1_page_react: #{e}"
end

delete_v2_page_react

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	path	Так
urlId	string	query	Так
id	string	query	Так

Відповідь

Повертає: CreateV1PageReact

Приклад

delete_v2_page_react Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
end

get_v1_page_likes

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	path	Так
urlId	string	query	Так

Відповідь

Повертає: GetV1PageLikes

Приклад

Приклад get_v1_page_likes

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v1_page_likes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
end

get_v2_page_react_users

Параметри

Назва	Тип	Розташування	Обов'язкове
tenantId	string	path	Так
urlId	string	query	Так
id	string	query	Так

Відповідь

Повертає: GetV2PageReactUsersResponse

Приклад

Приклад get_v2_page_react_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_v2_page_react_users(tenant_id, url_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_react_users: #{e}"
end

get_v2_page_reacts

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	path	Так
urlId	string	query	Так

Відповідь

Повертає: GetV2PageReacts

Приклад

Приклад get_v2_page_reacts

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_v2_page_reacts(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_v2_page_reacts: #{e}"
end

add_page

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: AddPageAPIResponse

Приклад

Приклад add_page

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр., 'Bearer' (за замовчуванням — nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_page_data = FastCommentsClient::CreateAPIPageData.new({title: 'title_example', url: 'url_example', url_id: 'url_id_example'}) # CreateAPIPageData | 
begin
  
  result = api_instance.add_page(tenant_id, create_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_page: #{e}"
end

delete_page

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Response

Повертає: DeletePageAPIResponse

Приклад

Приклад delete_page

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_page(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_page: #{e}"
end

get_offline_users

Попередні коментатори на сторінці, які наразі НЕ в мережі. Відсортовано за displayName. Використовуйте це після вичерпання /users/online, щоб відобразити секцію "Members". Курсорна пагінація за commenterName: сервер обходить частковий індекс {tenantId, urlId, commenterName} індекс від afterName вперед через $gt, без витрат на $skip.

Параметри

Name	Type	Location	Required	Description
tenantId	string	path	Yes
urlId	string	query	Yes	Ідентифікатор URL сторінки (очищується на сервері).
afterName	string	query	No	Курсор: передайте nextAfterName з попередньої відповіді.
afterUserId	string	query	No	Тайбрейкер курсора: передайте nextAfterUserId з попередньої відповіді. Обов'язково, коли встановлено afterName, щоб при однакових іменах записи не пропадали.

Відповідь

Повертає: PageUsersOfflineResponse

Приклад

Приклад get_offline_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Ідентифікатор URL сторінки (очищується на сервері).
opts = {
  after_name: 'after_name_example', # String | Курсор: передайте nextAfterName з попередньої відповіді.
  after_user_id: 'after_user_id_example' # String | Тайбрейкер курсора: передайте nextAfterUserId з попередньої відповіді. Обов'язково, коли встановлено afterName, щоб при однакових іменах записи не пропадали.
}
begin
  
  result = api_instance.get_offline_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_offline_users: #{e}"
end

get_online_users

Користувачі, які наразі онлайн на сторінці: люди, чиї websocket сесії зараз підписані на цю сторінку. Повертає anonCount + totalCount (підписники в межах кімнати, включаючи анонімних глядачів, яких ми не перелічуємо).

Параметри

Name	Type	Location	Required	Description
tenantId	string	path	Так
urlId	string	query	Так	Ідентифікатор URL сторінки (очищено на сервері).
afterName	string	query	Ні	Курсор: передайте nextAfterName з попередньої відповіді.
afterUserId	string	query	Ні	Розв'язувач нічиїх для курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли встановлено afterName, щоб записи з однаковими іменами не пропадали.

Відповідь

Повертає: PageUsersOnlineResponse

Приклад

Приклад get_online_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | Ідентифікатор URL сторінки (очищено на сервері).
opts = {
  after_name: 'after_name_example', # String | Курсор: передайте nextAfterName з попередньої відповіді.
  after_user_id: 'after_user_id_example' # String | Розв'язувач нічиїх для курсора: передайте nextAfterUserId з попередньої відповіді. Потрібно, коли встановлено afterName, щоб записи з однаковими іменами не пропадали.
}
begin
  
  result = api_instance.get_online_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_online_users: #{e}"
end

get_page_by_urlid

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
urlId	string	query	Так

Відповідь

Повертає: GetPageByURLIdAPIResponse

Приклад

Приклад get_page_by_urlid

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_page_by_urlid(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_page_by_urlid: #{e}"
end

get_pages

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: GetPagesAPIResponse

Приклад

Приклад get_pages

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
begin
  
  result = api_instance.get_pages(tenant_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pages: #{e}"
end

get_pages_public

Повертає список сторінок для тенанта. Використовується десктоп-клієнтом FChat для заповнення списку кімнат. Потребує, щоб enableFChat був true у підсумковому custom config для кожної сторінки. Сторінки, які вимагають SSO, відфільтровуються відповідно до групового доступу користувача, що робить запит.

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	path	Так
cursor	string	query	Ні	Непрозорий курсор пагінації, що повертається як `nextCursor` з попереднього запиту. Пов'язаний з тим же `sortBy`.
limit	integer	query	Ні	1..200, за замовчуванням 50
q	string	query	Ні	Необов'язковий нечутливий до регістру фільтр префіксу заголовка.
sortBy	string	query	Ні	Порядок сортування. `updatedAt` (за замовчуванням, спочатку новіші), `commentCount` (спочатку сторінки з більшою кількістю коментарів) або `title` (за алфавітом).
hasComments	boolean	query	Ні	Якщо true, повертати лише сторінки з принаймні одним коментарем.

Відповідь

Повертає: GetPublicPagesResponse

Приклад

Приклад get_pages_public

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  cursor: 'cursor_example', # String | Непрозорий курсор пагінації, що повертається як `nextCursor` з попереднього запиту. Пов'язаний з тим же `sortBy`.
  limit: 56, # Integer | 1..200, за замовчуванням 50
  q: 'q_example', # String | Необов'язковий нечутливий до регістру фільтр префіксу заголовка.
  sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Порядок сортування. `updatedAt` (за замовчуванням, спочатку новіші), `commentCount` (спочатку сторінки з більшою кількістю коментарів), або `title` (за алфавітом).
  has_comments: true # Boolean | Якщо true, повертати лише сторінки з принаймні одним коментарем.
}
begin
  
  result = api_instance.get_pages_public(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_pages_public: #{e}"
end

get_users_info

Зведена інформація про користувачів для орендаря. За наданими userIds повертає відображувану інформацію з User / SSOUser. Використовується віджетом коментарів для доповнення користувачів, які щойно з'явилися через подію присутності. Без контексту сторінки: конфіденційність застосовується однаково (приватні профілі приховані).

Parameters

Name	Type	Location	Required	Description
tenantId	string	path	Yes
ids	string	query	Yes	userIds, розділені комами.

Response

Повертає: PageUsersInfoResponse

Example

Приклад get_users_info

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
ids = 'ids_example' # String | userIds, розділені комами.
begin
  
  result = api_instance.get_users_info(tenant_id, ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_users_info: #{e}"
end

patch_page

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: PatchPageAPIResponse

Приклад

patch_page Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_page_data = FastCommentsClient::UpdateAPIPageData.new # UpdateAPIPageData | 
begin
  
  result = api_instance.patch_page(tenant_id, id, update_api_page_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_page: #{e}"
end

delete_pending_webhook_event

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_pending_webhook_event

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_pending_webhook_event(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
end

get_pending_webhook_event_count

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
commentId	string	query	Ні
externalId	string	query	Ні
eventType	string	query	Ні
type	string	query	Ні
domain	string	query	Ні
attemptCountGT	number	query	Ні

Відповідь

Повертає: GetPendingWebhookEventCountResponse

Приклад

Приклад get_pending_webhook_event_count

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_event_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_event_count: #{e}"
end

get_pending_webhook_events

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
commentId	string	query	No
externalId	string	query	No
eventType	string	query	No
type	string	query	No
domain	string	query	No
attemptCountGT	number	query	No
skip	number	query	No

Відповідь

Повертає: GetPendingWebhookEventsResponse

Приклад

Приклад get_pending_webhook_events

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  comment_id: 'comment_id_example', # String | 
  external_id: 'external_id_example', # String | 
  event_type: 'event_type_example', # String | 
  type: 'type_example', # String | 
  domain: 'domain_example', # String | 
  attempt_count_gt: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_pending_webhook_events(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_pending_webhook_events: #{e}"
end

create_question_config

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateQuestionConfigResponse

Приклад

Приклад create_question_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за API ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_config_body = FastCommentsClient::CreateQuestionConfigBody.new({name: 'name_example', question: 'question_example', type: 'type_example', reporting_order: 3.56}) # CreateQuestionConfigBody | 
begin
  
  result = api_instance.create_question_config(tenant_id, create_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_config: #{e}"
end

delete_question_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_question_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_config: #{e}"
end

get_question_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetQuestionConfigResponse

Приклад

Приклад get_question_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_config(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_config: #{e}"
end

get_question_configs

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetQuestionConfigsResponse

Приклад

get_question_configs Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_configs(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_configs: #{e}"
end

update_question_config

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_question_config

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_config_body = FastCommentsClient::UpdateQuestionConfigBody.new # UpdateQuestionConfigBody | 
begin
  
  result = api_instance.update_question_config(tenant_id, id, update_question_config_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_config: #{e}"
end

create_question_result

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Yes

Відповідь

Повертає: CreateQuestionResultResponse

Приклад

Приклад create_question_result

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_question_result_body = FastCommentsClient::CreateQuestionResultBody.new({url_id: 'url_id_example', value: 3.56, question_id: 'question_id_example'}) # CreateQuestionResultBody | 
begin
  
  result = api_instance.create_question_result(tenant_id, create_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_question_result: #{e}"
end

delete_question_result

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_question_result

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_question_result: #{e}"
end

get_question_result

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetQuestionResultResponse

Приклад

Приклад get_question_result

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_question_result(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_result: #{e}"
end

get_question_results

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
urlId	string	query	Ні
userId	string	query	Ні
startDate	string	query	Ні
questionId	string	query	Ні
questionIds	string	query	Ні
skip	number	query	Ні

Відповідь

Повертає: GetQuestionResultsResponse

Приклад

Приклад get_question_results

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | 
  user_id: 'user_id_example', # String | 
  start_date: 'start_date_example', # String | 
  question_id: 'question_id_example', # String | 
  question_ids: 'question_ids_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_question_results: #{e}"
end

update_question_result

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_question_result

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації ключем API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_question_result_body = FastCommentsClient::UpdateQuestionResultBody.new # UpdateQuestionResultBody | 
begin
  
  result = api_instance.update_question_result(tenant_id, id, update_question_result_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_question_result: #{e}"
end

aggregate_question_results

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
questionId	string	query	Ні
questionIds	array	query	Ні
urlId	string	query	Ні
timeBucket	string	query	Ні
startDate	string	query	Ні
forceRecalculate	boolean	query	Ні

Відповідь

Повертає: AggregateQuestionResultsResponse

Приклад

Приклад aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наведений нижче рядок, щоб задати префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  time_bucket: FastCommentsClient::AggregateTimeBucket::DAY, # AggregateTimeBucket | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.aggregate_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->aggregate_question_results: #{e}"
end

bulk_aggregate_question_results

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
forceRecalculate	boolean	query	Ні

Відповідь

Повертає: BulkAggregateQuestionResultsResponse

Приклад

Приклад bulk_aggregate_question_results

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
bulk_aggregate_question_results_request = FastCommentsClient::BulkAggregateQuestionResultsRequest.new({aggregations: [FastCommentsClient::BulkAggregateQuestionItem.new({agg_id: 'agg_id_example'})]}) # BulkAggregateQuestionResultsRequest | 
opts = {
  force_recalculate: true # Boolean | 
}
begin
  
  result = api_instance.bulk_aggregate_question_results(tenant_id, bulk_aggregate_question_results_request, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->bulk_aggregate_question_results: #{e}"
end

combine_comments_with_question_results

Параметри

Назва	Тип	Розташування	Обов'язково
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	Ні

Відповідь

Повертає: CombineQuestionResultsWithCommentsResponse

Приклад

Приклад combine_comments_with_question_results

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наведений рядок, щоб встановити префікс для API-ключа, напр., 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  question_id: 'question_id_example', # String | 
  question_ids: ['inner_example'], # Array<String> | 
  url_id: 'url_id_example', # String | 
  start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  force_recalculate: true, # Boolean | 
  min_value: 1.2, # Float | 
  max_value: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.combine_comments_with_question_results(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->combine_comments_with_question_results: #{e}"
end

add_sso_user

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: AddSSOUserAPIResponse

Приклад

Приклад add_sso_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_apisso_user_data = FastCommentsClient::CreateAPISSOUserData.new({email: 'email_example', username: 'username_example', id: 'id_example'}) # CreateAPISSOUserData | 
begin
  
  result = api_instance.add_sso_user(tenant_id, create_apisso_user_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->add_sso_user: #{e}"
end

delete_sso_user

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
id	string	path	Так
deleteComments	boolean	query	Ні
commentDeleteMode	string	query	Ні

Відповідь

Повертає: DeleteSSOUserAPIResponse

Приклад

Приклад delete_sso_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: true, # Boolean | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_sso_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_sso_user: #{e}"
end

get_sso_user_by_email

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
email	string	path	Так

Відповідь

Повертає: GetSSOUserByEmailAPIResponse

Приклад

Приклад get_sso_user_by_email

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб задати префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
email = 'email_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_email(tenant_id, email)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_email: #{e}"
end

get_sso_user_by_id

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetSSOUserByIdAPIResponse

Приклад

Приклад get_sso_user_by_id

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації ключем API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_sso_user_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_user_by_id: #{e}"
end

get_sso_users

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	integer	query	Ні

Відповідь

Повертає: GetSSOUsersResponse

Приклад

Приклад get_sso_users

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 56 # Integer | 
}
begin
  
  result = api_instance.get_sso_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_sso_users: #{e}"
end

patch_sso_user

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
updateComments	boolean	query	Ні

Відповідь

Повертає: PatchSSOUserAPIResponse

Приклад

Приклад patch_sso_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію за допомогою ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.patch_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->patch_sso_user: #{e}"
end

put_sso_user

Параметри

Назва	Type	Location	Обов'язковий
tenantId	string	query	Yes
id	string	path	Yes
updateComments	boolean	query	No

Відповідь

Повертає: PutSSOUserAPIResponse

Приклад

put_sso_user Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_apisso_user_data = FastCommentsClient::UpdateAPISSOUserData.new # UpdateAPISSOUserData | 
opts = {
  update_comments: true # Boolean | 
}
begin
  
  result = api_instance.put_sso_user(tenant_id, id, update_apisso_user_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->put_sso_user: #{e}"
end

create_subscription

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateSubscriptionAPIResponse

Приклад

create_subscription Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_api_user_subscription_data = FastCommentsClient::CreateAPIUserSubscriptionData.new({url_id: 'url_id_example'}) # CreateAPIUserSubscriptionData | 
begin
  
  result = api_instance.create_subscription(tenant_id, create_api_user_subscription_data)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_subscription: #{e}"
end

delete_subscription

Параметри

Назва	Тип	Розміщення	Обов'язковий
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: DeleteSubscriptionAPIResponse

Приклад

Приклад delete_subscription

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.delete_subscription(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_subscription: #{e}"
end

get_subscriptions

Параметри

Назва	Тип	Location	Обов'язковий	Опис
tenantId	string	query	Так
userId	string	query	Ні

Відповідь

Повертає: GetSubscriptionsAPIResponse

Приклад

Приклад get_subscriptions

Copy

require 'time'
require 'fastcomments-client'
# налаштуйте авторизацію
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_subscriptions(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_subscriptions: #{e}"
end

update_subscription

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: UpdateSubscriptionAPIResponse

Приклад

Приклад update_subscription

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію ключем API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_subscription: #{e}"
end

get_tenant_daily_usages

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Yes
yearNumber	number	query	No
monthNumber	number	query	No
dayNumber	number	query	No
skip	number	query	No

Відповідь

Повертає: GetTenantDailyUsagesResponse

Приклад

Приклад get_tenant_daily_usages

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  year_number: 1.2, # Float | 
  month_number: 1.2, # Float | 
  day_number: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_daily_usages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_daily_usages: #{e}"
end

create_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateTenantPackageResponse

Приклад

create_tenant_package Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію ключем API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_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 | 
begin
  
  result = api_instance.create_tenant_package(tenant_id, create_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_package: #{e}"
end

delete_tenant_package

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

delete_tenant_package Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_package: #{e}"
end

get_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetTenantPackageResponse

Приклад

Приклад get_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_package(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_package: #{e}"
end

get_tenant_packages

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetTenantPackagesResponse

Приклад

Приклад get_tenant_packages

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_packages(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_packages: #{e}"
end

replace_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

replace_tenant_package Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_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 | 
begin
  
  result = api_instance.replace_tenant_package(tenant_id, id, replace_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_package: #{e}"
end

update_tenant_package

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_tenant_package

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_package_body = FastCommentsClient::UpdateTenantPackageBody.new # UpdateTenantPackageBody | 
begin
  
  result = api_instance.update_tenant_package(tenant_id, id, update_tenant_package_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_package: #{e}"
end

create_tenant_user

Параметри

Ім'я	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateTenantUserResponse

Приклад

Приклад create_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_user_body = FastCommentsClient::CreateTenantUserBody.new({username: 'username_example', email: 'email_example'}) # CreateTenantUserBody | 
begin
  
  result = api_instance.create_tenant_user(tenant_id, create_tenant_user_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant_user: #{e}"
end

delete_tenant_user

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Yes
id	string	path	Yes
deleteComments	string	query	No
commentDeleteMode	string	query	No

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад delete_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# налаштуйте авторизацію
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  delete_comments: 'delete_comments_example', # String | 
  comment_delete_mode: 'comment_delete_mode_example' # String | 
}
begin
  
  result = api_instance.delete_tenant_user(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant_user: #{e}"
end

get_tenant_user

Параметри

Назва	Тип	Розміщення	Обов'язково	Опис
tenantId	string	query	Yes
id	string	path	Yes

Відповідь

Повертає: GetTenantUserResponse

Приклад

Приклад get_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_user: #{e}"
end

get_tenant_users

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
skip	number	query	Ні

Відповідь

Повертає: GetTenantUsersResponse

Приклад

Приклад get_tenant_users

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenant_users(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant_users: #{e}"
end

replace_tenant_user

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
updateComments	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

replace_tenant_user Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
replace_tenant_user_body = FastCommentsClient::ReplaceTenantUserBody.new({username: 'username_example', email: 'email_example'}) # ReplaceTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.replace_tenant_user(tenant_id, id, replace_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->replace_tenant_user: #{e}"
end

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
id	string	path	Так
redirectURL	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад send_login_link

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  redirect_url: 'redirect_url_example' # String | 
}
begin
  
  result = api_instance.send_login_link(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->send_login_link: #{e}"
end

update_tenant_user

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
updateComments	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_tenant_user

Copy

require 'time'
require 'fastcomments-client'
# Налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштувати авторизацію API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_user_body = FastCommentsClient::UpdateTenantUserBody.new # UpdateTenantUserBody | 
opts = {
  update_comments: 'update_comments_example' # String | 
}
begin
  
  result = api_instance.update_tenant_user(tenant_id, id, update_tenant_user_body, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant_user: #{e}"
end

create_tenant

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: CreateTenantResponse

Приклад

create_tenant Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_tenant_body = FastCommentsClient::CreateTenantBody.new({name: 'name_example', domain_configuration: [FastCommentsClient::APIDomainConfiguration.new({id: 'id_example', domain: 'domain_example', created_at: Time.now})]}) # CreateTenantBody | 
begin
  
  result = api_instance.create_tenant(tenant_id, create_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_tenant: #{e}"
end

delete_tenant

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
sure	string	query	Ні

Відповідь

Повертає: APIEmptyResponse

Приклад

delete_tenant Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  sure: 'sure_example' # String | 
}
begin
  
  result = api_instance.delete_tenant(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_tenant: #{e}"
end

get_tenant

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetTenantResponse

Приклад

Приклад get_tenant

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_tenant(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenant: #{e}"
end

get_tenants

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
meta	string	query	Ні
skip	number	query	Ні

Відповідь

Повертає: GetTenantsResponse

Приклад

Приклад get_tenants

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  meta: 'meta_example', # String | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tenants(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tenants: #{e}"
end

update_tenant

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptyResponse

Приклад

Приклад update_tenant

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody | 
begin
  
  result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_tenant: #{e}"
end

change_ticket_state

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
userId	string	query	Так
id	string	path	Так

Відповідь

Повертає: ChangeTicketStateResponse

Приклад

Приклад change_ticket_state

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
id = 'id_example' # String | 
change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody | 
begin
  
  result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->change_ticket_state: #{e}"
end

create_ticket

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
userId	string	query	Так

Відповідь

Повертає: CreateTicketResponse

Приклад

Приклад create_ticket

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (defaults to nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody | 
begin
  
  result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_ticket: #{e}"
end

get_ticket

Параметри

Назва	Тип	Розташування	Обов'язковий
tenantId	string	query	Так
id	string	path	Так
userId	string	query	Ні

Відповідь

Повертає: GetTicketResponse

Приклад

Приклад get_ticket

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  user_id: 'user_id_example' # String | 
}
begin
  
  result = api_instance.get_ticket(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_ticket: #{e}"
end

get_tickets

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
userId	string	query	Ні
state	number	query	Ні
skip	number	query	Ні
limit	number	query	Ні

Response

Повертає: GetTicketsResponse

Приклад

Приклад get_tickets

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  state: 1.2, # Float | 
  skip: 1.2, # Float | 
  limit: 1.2 # Float | 
}
begin
  
  result = api_instance.get_tickets(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_tickets: #{e}"
end

get_translations

Параметри

Назва	Тип	Розташування	Обов'язково
namespace	string	path	Так
component	string	path	Так
locale	string	query	Ні
useFullTranslationIds	boolean	query	Ні

Відповідь

Повертає: GetTranslationsResponse

Приклад

Приклад get_translations

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
namespace = 'namespace_example' # String | 
component = 'component_example' # String | 
opts = {
  locale: 'locale_example', # String | 
  use_full_translation_ids: true # Boolean | 
}
begin
  
  result = api_instance.get_translations(namespace, component, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_translations: #{e}"
end

upload_image

Завантажити та змінити розмір зображення

Параметри

Name	Type	Location	Required	Description
tenantId	string	path	Так
sizePreset	string	query	Ні	Пресет розміру: "Default" (1000x1000px) або "CrossPlatform" (створює розміри для популярних пристроїв)
urlId	string	query	Ні	Ідентифікатор сторінки, з якої відбувається завантаження, для конфігурації

Відповідь

Повертає: UploadImageResponse

Приклад

Приклад upload_image

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
file = File.new('/path/to/some/file') # File | 
opts = {
  size_preset: FastCommentsClient::SizePreset::DEFAULT, # SizePreset | Пресет розміру: \"Default\" (1000x1000px) або \"CrossPlatform\" (створює розміри для популярних пристроїв)
  url_id: 'url_id_example' # String | Ідентифікатор сторінки, з якої відбувається завантаження, для конфігурації
}
begin
  
  result = api_instance.upload_image(tenant_id, file, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->upload_image: #{e}"
end

get_user_badge_progress_by_id

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

Приклад get_user_badge_progress_by_id

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_id(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_id: #{e}"
end

get_user_badge_progress_by_user_id

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так
userId	string	path	Так

Відповідь

Повертає: APIGetUserBadgeProgressResponse

Приклад

Приклад get_user_badge_progress_by_user_id

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
user_id = 'user_id_example' # String | 
begin
  
  result = api_instance.get_user_badge_progress_by_user_id(tenant_id, user_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_by_user_id: #{e}"
end

get_user_badge_progress_list

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
userId	string	query	No
limit	number	query	No
skip	number	query	No

Відповідь

Повертає: APIGetUserBadgeProgressListResponse

Приклад

Приклад використання get_user_badge_progress_list

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badge_progress_list(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge_progress_list: #{e}"
end

create_user_badge

Параметри

Назва	Тип	Розташування	Обов'язково	Опис
tenantId	string	query	Так

Відповідь

Повертає: APICreateUserBadgeResponse

Приклад

Приклад create_user_badge

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, напр. 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
create_user_badge_params = FastCommentsClient::CreateUserBadgeParams.new({user_id: 'user_id_example', badge_id: 'badge_id_example'}) # CreateUserBadgeParams | 
begin
  
  result = api_instance.create_user_badge(tenant_id, create_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_user_badge: #{e}"
end

delete_user_badge

Параметри

Назва	Тип	Розташування	Обов'язкове	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

Приклад delete_user_badge

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.delete_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_user_badge: #{e}"
end

get_user_badge

Параметри

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

Відповідь

Повертає: APIGetUserBadgeResponse

Приклад

get_user_badge Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію ключем API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user_badge(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badge: #{e}"
end

get_user_badges

Параметри

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

Відповідь

Повертає: APIGetUserBadgesResponse

Приклад

get_user_badges Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою ключа API: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для ключа API, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  badge_id: 'badge_id_example', # String | 
  type: 1.2, # Float | 
  displayed_on_comments: true, # Boolean | 
  limit: 1.2, # Float | 
  skip: 1.2 # Float | 
}
begin
  
  result = api_instance.get_user_badges(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user_badges: #{e}"
end

update_user_badge

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: APIEmptySuccessResponse

Приклад

update_user_badge Приклад

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за допомогою API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
update_user_badge_params = FastCommentsClient::UpdateUserBadgeParams.new # UpdateUserBadgeParams | 
begin
  
  result = api_instance.update_user_badge(tenant_id, id, update_user_badge_params)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->update_user_badge: #{e}"
end

get_user_notification_count

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: GetUserNotificationCountResponse

Приклад

Приклад get_user_notification_count

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notification_count: #{e}"
end

get_user_notifications

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
urlId	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	Ні
includeTenantNotifications	boolean	query	Ні
sso	string	query	Ні

Відповідь

Повертає: GetMyNotificationsResponse

Приклад

Приклад get_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  url_id: 'url_id_example', # String | Використовується для визначення, чи підписана поточна сторінка.
  page_size: 56, # Integer | 
  after_id: 'after_id_example', # String | 
  include_context: true, # Boolean | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  include_translations: true, # Boolean | 
  include_tenant_notifications: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.get_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_notifications: #{e}"
end

reset_user_notification_count

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

reset_user_notification_count Приклад

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # Рядок | 
opts = {
  sso: 'sso_example' # Рядок | 
}
begin
  
  result = api_instance.reset_user_notification_count(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notification_count: #{e}"
end

reset_user_notifications

Параметри

Name	Type	Location	Required
tenantId	string	query	Yes
afterId	string	query	No
afterCreatedAt	integer	query	No
unreadOnly	boolean	query	No
dmOnly	boolean	query	No
noDm	boolean	query	No
sso	string	query	No

Відповідь

Повертає: ResetUserNotificationsResponse

Приклад

Приклад reset_user_notifications

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
opts = {
  after_id: 'after_id_example', # String | 
  after_created_at: 789, # Integer | 
  unread_only: true, # Boolean | 
  dm_only: true, # Boolean | 
  no_dm: true, # Boolean | 
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.reset_user_notifications(tenant_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->reset_user_notifications: #{e}"
end

update_user_notification_comment_subscription_status

Увімкнути або вимкнути сповіщення для конкретного коментаря.

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
notificationId	string	path	Так
optedInOrOut	string	path	Так
commentId	string	query	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationCommentSubscriptionStatusResponse

Приклад

Приклад update_user_notification_comment_subscription_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
opted_in_or_out = 'in' # String | 
comment_id = 'comment_id_example' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_comment_subscription_status(tenant_id, notification_id, opted_in_or_out, comment_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_comment_subscription_status: #{e}"
end

update_user_notification_page_subscription_status

Увімкнути або вимкнути сповіщення для сторінки. Коли користувачі підписані на сторінку, створюються сповіщення для нових кореневих коментарів, а також

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
urlId	string	query	Так
url	string	query	Так
pageTitle	string	query	Так
subscribedOrUnsubscribed	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationPageSubscriptionStatusResponse

Приклад

update_user_notification_page_subscription_status Example

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
url = 'url_example' # String | 
page_title = 'page_title_example' # String | 
subscribed_or_unsubscribed = 'subscribe' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_page_subscription_status(tenant_id, url_id, url, page_title, subscribed_or_unsubscribed, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_page_subscription_status: #{e}"
end

update_user_notification_status

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
notificationId	string	path	Так
newStatus	string	path	Так
sso	string	query	Ні

Відповідь

Повертає: UpdateUserNotificationStatusResponse

Приклад

Приклад update_user_notification_status

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
notification_id = 'notification_id_example' # String | 
new_status = 'read' # String | 
opts = {
  sso: 'sso_example' # String | 
}
begin
  
  result = api_instance.update_user_notification_status(tenant_id, notification_id, new_status, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->update_user_notification_status: #{e}"
end

get_user_presence_statuses

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
urlIdWS	string	query	Так
userIds	string	query	Так

Відповідь

Повертає: GetUserPresenceStatusesResponse

Приклад

Приклад get_user_presence_statuses

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id_ws = 'url_id_ws_example' # String | 
user_ids = 'user_ids_example' # String | 
begin
  
  result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
end

search_users

Параметри

Name	Type	Location	Required
tenantId	string	path	Так
urlId	string	query	Так
usernameStartsWith	string	query	Ні
mentionGroupIds	array	query	Ні
sso	string	query	Ні
searchSection	string	query	Ні

Відповідь

Повертає: SearchUsersResult

Приклад

Приклад search_users

Copy

require 'time'
require 'fastcomments-client'
api_instance = FastCommentsClient::PublicApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  username_starts_with: 'username_starts_with_example', # String | 
  mention_group_ids: ['inner_example'], # Array<String> | 
  sso: 'sso_example', # String | 
  search_section: 'fast' # String | 
}
begin
  
  result = api_instance.search_users(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling PublicApi->search_users: #{e}"
end

get_user

Параметри

Name	Type	Location	Required	Description
tenantId	string	query	Так
id	string	path	Так

Відповідь

Повертає: GetUserResponse

Приклад

Приклад get_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
begin
  
  result = api_instance.get_user(tenant_id, id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_user: #{e}"
end

create_vote

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
commentId	string	query	Так
direction	string	query	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: VoteResponse

Приклад

Приклад create_vote

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
comment_id = 'comment_id_example' # String | 
direction = 'up' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.create_vote(tenant_id, comment_id, direction, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->create_vote: #{e}"
end

delete_vote

Параметри

Назва	Тип	Розташування	Обов'язково
tenantId	string	query	Так
id	string	path	Так
editKey	string	query	Ні

Відповідь

Повертає: VoteDeleteResponse

Приклад

Приклад delete_vote

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію API-ключа: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
id = 'id_example' # String | 
opts = {
  edit_key: 'edit_key_example' # String | 
}
begin
  
  result = api_instance.delete_vote(tenant_id, id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->delete_vote: #{e}"
end

get_votes

Параметри

Назва	Тип	Розташування	Обов'язковий	Опис
tenantId	string	query	Так
urlId	string	query	Так

Відповідь

Повертає: GetVotesResponse

Приклад

Приклад get_votes

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштування авторизації API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
begin
  
  result = api_instance.get_votes(tenant_id, url_id)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes: #{e}"
end

get_votes_for_user

Параметри

Name	Type	Location	Required
tenantId	string	query	Так
urlId	string	query	Так
userId	string	query	Ні
anonUserId	string	query	Ні

Відповідь

Повертає: GetVotesForUserResponse

Приклад

Приклад get_votes_for_user

Copy

require 'time'
require 'fastcomments-client'
# налаштування авторизації
FastCommentsClient.configure do |config|
  # Налаштуйте авторизацію за API-ключем: api_key
  config.api_key['x-api-key'] = 'YOUR API KEY'
  # Розкоментуйте наступний рядок, щоб встановити префікс для API-ключа, наприклад 'Bearer' (за замовчуванням nil)
  # config.api_key_prefix['x-api-key'] = 'Bearer'
end
api_instance = FastCommentsClient::DefaultApi.new
tenant_id = 'tenant_id_example' # String | 
url_id = 'url_id_example' # String | 
opts = {
  user_id: 'user_id_example', # String | 
  anon_user_id: 'anon_user_id_example' # String | 
}
begin
  
  result = api_instance.get_votes_for_user(tenant_id, url_id, opts)
  p result
rescue FastCommentsClient::ApiError => e
  puts "Error when calling DefaultApi->get_votes_for_user: #{e}"
end

Потрібна допомога?

Якщо у вас виникнуть проблеми або питання щодо Ruby SDK, будь ласка:

Участь у розробці

Внески вітаються! Будь ласка, відвідайте репозиторій на GitHub для отримання інструкцій щодо внесків.

Мова 🇺🇦 Українська

Початок роботи

Документація

Використання

Агрегація

Журнали аудиту

Аутентифікація

Блокування з коментаря

Перевірка заблокованих коментарів

Коментарі

Коментарі користувача

Конфігурації домену

Шаблони електронних листів

Журнал подій

Публікації стрічки

Позначення коментаря

GIF

Хештеги

Модерація

Модератори

Кількість сповіщень

Сповіщення

Реакції сторінки

Сторінки

Очікувані події вебхуків

Конфігурації запитань

Результати запитань

Агрегація результатів запитань

Користувачі SSO

Підписки

Щоденне використання тенанта

Пакети тенанта

Користувачі тенанта

Тенанти

Тікети

Переклади

Завантажити зображення

Прогрес значка користувача

Значки користувача

Сповіщення користувача

Статуси присутності користувача

Пошук користувачів

Користувачі

Голоси

FastComments SDK для Ruby

Репозиторій

Встановлення

Library Contents

Public vs Secured APIs

Швидкий старт

Використання автентифікованих API (DefaultApi)

Використання публічних API (PublicApi)

Використання модераційних API (ModerationApi)

Поширені проблеми

Примітки

Ідентифікатори трансляцій

SSO (Єдиний вхід)

Використання SSO

Простий SSO

Безпечний SSO

aggregate

Параметри

Відповідь

Приклад

get_audit_logs

Параметри

Відповідь

Приклад

logout_public

Відповідь

Приклад

block_from_comment_public

Параметри

Відповідь

Приклад

un_block_comment_public

Параметри

Відповідь

Приклад

checked_comments_for_blocked