FastComments.com

FastComments Ruby SDK

Това е официалният Ruby SDK за FastComments.

Официален Ruby SDK за API на FastComments

Репозитория

Вижте в GitHub


Инсталиране Internal Link

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

Тази библиотека съдържа генерирания клиент за API и SSO инструменти, които улесняват работата с API.

Public vs Secured APIs

За клиентския API има три класа – DefaultApi, PublicApi и ModerationApi. DefaultApi съдържа методи, които изискват вашия API ключ, а PublicApi съдържа API повиквания, които могат да се направят директно от браузър/мобилно устройство/и т.н. без удостоверяване. ModerationApi съдържа методите, които захранват таблото за модератори.

ModerationApi предоставя обширен набор от живи и бързи API за модериране. Всеки метод на ModerationApi приема параметър sso и може да се удостоверява чрез SSO или с бисквитка от сесия на FastComments.com.

Бърз старт Internal Link

Използване на удостоверени API (DefaultApi)

Важно: Трябва да зададете вашия API ключ на ApiClient преди да правите удостоверени заявки. Ако не го направите, заявките ще се провалят с грешка 401.

require 'fastcomments'

# Create and configure the API client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Create the API instance with the configured client
api = FastCommentsClient::DefaultApi.new(api_client)

# Now you can make authenticated API calls
begin
  # Example: Add an SSO user
  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}"
  # Common errors:
  # - 401: API key is missing or invalid
  # - 400: Request validation failed
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
  # Example: List comments in the moderation queue
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Чести проблеми

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

Бележки Internal Link

Идентификатори на предавания

Ще видите, че трябва да предавате broadcastId в някои API повиквания. Когато получите събития, ще получите този ID обратно, така че да знаете да игнорирате събитието, ако планирате да приложите промените оптимистично на клиента (което вероятно ще искате да направите, тъй като осигурява най-доброто преживяване). Предайте тук UUID. ID-то трябва да е достатъчно уникално, за да не се появи два пъти в рамките на сесия на браузъра.

SSO (Еднократно влизане)

За примери за SSO, вижте по-долу.

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

Проста SSO

require 'fastcomments'

# Създаване на прост 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'

# Създаване на сигурен 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 Internal Link

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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
parentTenantIdstringqueryНе
includeStatsbooleanqueryНе

Отговор

Връща: AggregateResponse

Пример

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

get_audit_logs Internal Link

Параметри

NameТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
limitnumberqueryНе
skipnumberqueryНе
orderstringqueryНе
afternumberqueryНе
beforenumberqueryНе

Отговор

Връща: GetAuditLogsResponse

Пример

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

logout_public Internal Link

Отговор

Връща: APIEmptyResponse

Пример

Пример за logout_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6
7begin
8
9 result = api_instance.logout_public
10 p result
11rescue FastCommentsClient::ApiError => e
12 puts "Error when calling PublicApi->logout_public: #{e}"
13end
14

block_from_comment_public Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Отговор

Връща: BlockSuccess

Пример

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

un_block_comment_public Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Отговор

Връща: UnblockSuccess

Пример

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

checked_comments_for_blocked Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
commentIdsstringqueryДаСписък с идентификатори на коментари, разделени със запетаи.
ssostringqueryНе

Отговор

Връща: CheckBlockedCommentsResponse

Пример

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

block_user_from_comment Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе
anonUserIdstringqueryНе

Отговор

Връща: BlockSuccess

Пример

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

create_comment_public Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
broadcastIdstringqueryДа
sessionIdstringqueryНе
ssostringqueryНе

Отговор

Връща: SaveCommentsResponseWithPresence

Пример

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

delete_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
contextUserIdstringqueryНе
isLivebooleanqueryНе

Отговор

Връща: DeleteCommentResult

Пример

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

delete_comment_public Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
broadcastIdstringqueryДа
editKeystringqueryНе
ssostringqueryНе

Отговор

Връща: PublicAPIDeleteCommentResponse

Пример

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

delete_comment_vote Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
voteIdstringpathДа
urlIdstringqueryДа
broadcastIdstringqueryДа
editKeystringqueryНе
ssostringqueryНе

Отговор

Връща: VoteDeleteResponse

Пример

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

flag_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе
anonUserIdstringqueryНе

Отговор

Връща: FlagCommentResponse

Пример

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

get_comment Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIGetCommentResponse

Пример

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

get_comment_text Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
editKeystringqueryНе
ssostringqueryНе

Отговор

Връща: PublicAPIGetCommentTextResponse

Пример

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

get_comment_vote_user_names Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
dirintegerqueryДа
ssostringqueryНе

Отговор

Връща: GetCommentVoteUserNamesSuccessResponse

Пример

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

get_comments Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
pageintegerqueryНе
limitintegerqueryНе
skipintegerqueryНе
asTreebooleanqueryНе
skipChildrenintegerqueryНе
limitChildrenintegerqueryНе
maxTreeDepthintegerqueryНе
urlIdstringqueryНе
userIdstringqueryНе
anonUserIdstringqueryНе
contextUserIdstringqueryНе
hashTagstringqueryНе
parentIdstringqueryНе
directionstringqueryНе
fromDateintegerqueryНе
toDateintegerqueryНе

Отговор

Връща: APIGetCommentsResponse

Пример

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

get_comments_public Internal Link

req tenantId urlId

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
pageintegerqueryНе
directionstringqueryНе
ssostringqueryНе
skipintegerqueryНе
skipChildrenintegerqueryНе
limitintegerqueryНе
limitChildrenintegerqueryНе
countChildrenbooleanqueryНе
fetchPageForCommentIdstringqueryНе
includeConfigbooleanqueryНе
countAllbooleanqueryНе
includei10nbooleanqueryНе
localestringqueryНе
modulesstringqueryНе
isCrawlerbooleanqueryНе
includeNotificationCountbooleanqueryНе
asTreebooleanqueryНе
maxTreeDepthintegerqueryНе
useFullTranslationIdsbooleanqueryНе
parentIdstringqueryНе
searchTextstringqueryНе
hashTagsarrayqueryНе
userIdstringqueryНе
customConfigStrstringqueryНе
afterCommentIdstringqueryНе
beforeCommentIdstringqueryНе

Отговор

Връща: GetCommentsResponseWithPresencePublicComment

Пример

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

lock_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringпътДа
commentIdstringпътДа
broadcastIdstringзаявкаДа
ssostringзаявкаНе

Отговор

Връща: APIEmptyResponse

Пример

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

pin_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
broadcastIdstringqueryДа
ssostringqueryНе

Отговор

Връща: ChangeCommentPinStatusResponse

Пример

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

save_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
isLivebooleanqueryНе
doSpamCheckbooleanqueryНе
sendEmailsbooleanqueryНе
populateNotificationsbooleanqueryНе

Отговор

Връща: APISaveCommentResponse

Пример

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

save_comments_bulk Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
isLivebooleanqueryНе
doSpamCheckbooleanqueryНе
sendEmailsbooleanqueryНе
populateNotificationsbooleanqueryНе

Отговор

Връща: SaveCommentsBulkResponse

Пример

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

set_comment_text Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
broadcastIdstringqueryДа
editKeystringqueryНе
ssostringqueryНе

Отговор

Връща: PublicAPISetCommentTextResponse

Пример

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

un_block_user_from_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе
anonUserIdstringqueryНе

Отговор

Връща: UnblockSuccess

Пример

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

un_flag_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе
anonUserIdstringqueryНе

Отговор

Връща: FlagCommentResponse

Пример

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

un_lock_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
commentIdstringpathДа
broadcastIdstringqueryДа
ssostringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

un_pin_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
commentIdstringpathДа
broadcastIdstringqueryДа
ssostringqueryНе

Отговор

Връща: ChangeCommentPinStatusResponse

Пример

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

update_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
contextUserIdstringqueryНе
doSpamCheckbooleanqueryНе
isLivebooleanqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

vote_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
commentIdstringpathДа
urlIdstringqueryДа
broadcastIdstringqueryДа
sessionIdstringqueryНе
ssostringqueryНе

Отговор

Връща: VoteResponse

Пример

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

get_comments_for_user Internal Link

Параметри

NameTypeLocationRequiredDescription
userIdstringqueryNo
directionstringqueryNo
repliesToUserIdstringqueryNo
pagenumberqueryNo
includei10nbooleanqueryNo
localestringqueryNo
isCrawlerbooleanqueryNo

Отговор

Връща: GetCommentsForUserResponse

Пример

Пример за get_comments_for_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6opts = {
7 user_id: 'user_id_example', # String |
8 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
9 replies_to_user_id: 'replies_to_user_id_example', # String |
10 page: 1.2, # Float |
11 includei10n: true, # Boolean |
12 locale: 'locale_example', # String |
13 is_crawler: true # Boolean |
14}
15
16begin
17
18 result = api_instance.get_comments_for_user(opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->get_comments_for_user: #{e}"
22end
23

add_domain_config Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: AddDomainConfigResponse

Пример

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

delete_domain_config Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
domainstringpathДа

Отговор

Връща: DeleteDomainConfigResponse

Пример

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

get_domain_config Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
domainstringpathYes

Отговор

Връща: GetDomainConfigResponse

Пример

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

get_domain_configs Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: GetDomainConfigsResponse

Пример

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

patch_domain_config Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
domainToUpdatestringpathYes

Отговор

Връща: PatchDomainConfigResponse

Пример

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

put_domain_config Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
domainToUpdatestringpathДа

Отговор

Връща: PutDomainConfigResponse

Пример

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

create_email_template Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа

Отговор

Връща: CreateEmailTemplateResponse

Пример

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

delete_email_template Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

delete_email_template_render_error Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
errorIdstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

get_email_template Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetEmailTemplateResponse

Пример

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

get_email_template_definitions Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа

Отговор

Връща: GetEmailTemplateDefinitionsResponse

Пример

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

get_email_template_render_errors Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
skipnumberqueryНе

Отговор

Връща: GetEmailTemplateRenderErrorsResponse

Пример

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

get_email_templates Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
skipnumberqueryНе

Отговор

Връща: GetEmailTemplatesResponse

Пример

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

render_email_template Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
localestringqueryНе

Отговор

Връща: RenderEmailTemplateResponse

Пример

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

update_email_template Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

get_event_log Internal Link

req tenantId urlId userIdWS

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
userIdWSstringqueryДа
startTimeintegerqueryДа
endTimeintegerqueryНе

Отговор

Връща: GetEventLogResponse

Пример

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

get_global_event_log Internal Link

req tenantId urlId userIdWS

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
userIdWSstringqueryДа
startTimeintegerqueryДа
endTimeintegerqueryНе

Отговор

Връща: GetEventLogResponse

Пример

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

create_feed_post Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
broadcastIdstringqueryНе
isLivebooleanqueryНе
doSpamCheckbooleanqueryНе
skipDupCheckbooleanqueryНе

Отговор

Връща: CreateFeedPostsResponse

Пример

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

create_feed_post_public Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: CreateFeedPostResponse

Пример

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

delete_feed_post_public Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
postIdstringpathДа
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: DeleteFeedPostPublicResponse

Пример

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

get_feed_posts Internal Link

req tenantId afterId

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
afterIdstringqueryНе
limitintegerqueryНе
tagsarrayqueryНе

Отговор

Връща: GetFeedPostsResponse

Пример

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

get_feed_posts_public Internal Link


req tenantId afterId

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
afterIdstringqueryНе
limitintegerqueryНе
tagsarrayqueryНе
ssostringqueryНе
isCrawlerbooleanqueryНе
includeUserInfobooleanqueryНе

Отговор

Връща: PublicFeedPostsResponse

Пример

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

get_feed_posts_stats Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
postIdsarrayqueryДа
ssostringqueryНе

Отговор

Връща: FeedPostsStatsResponse

Пример

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

get_user_reacts_public Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
postIdsarrayqueryНе
ssostringqueryНе

Отговор

Връща: UserReactsResponse

Пример

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

react_feed_post_public Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
postIdstringpathДа
isUndobooleanqueryНе
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: ReactFeedPostResponse

Пример

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

update_feed_post Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

update_feed_post_public Internal Link

Параметри

ИмеTypeМестоположениеЗадължителноОписание
tenantIdstringpathДа
postIdstringpathДа
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: CreateFeedPostResponse

Пример

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

flag_comment_public Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
commentIdstringpathДа
isFlaggedbooleanqueryДа
ssostringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

get_gif_large Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
largeInternalURLSanitizedstringqueryДа

Отговор

Връща: GifGetLargeResponse

Пример

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

get_gifs_search Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
searchstringqueryДа
localestringqueryНе
ratingstringqueryНе
pagenumberqueryНе

Отговор

Връща: GetGifsSearchResponse

Пример

Пример за get_gifs_search
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7search = 'search_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 rating: 'rating_example', # String |
11 page: 1.2 # Float |
12}
13
14begin
15
16 result = api_instance.get_gifs_search(tenant_id, search, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_gifs_search: #{e}"
20end
21

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
localestringqueryНе
ratingstringqueryНе
pagenumberqueryНе

Отговор

Връща: GetGifsTrendingResponse

Пример

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

add_hash_tag Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateHashTagResponse

Пример

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

add_hash_tags_bulk Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: BulkCreateHashTagsResponse

Пример

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

delete_hash_tag Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
tagstringpathYes

Отговор

Връща: APIEmptyResponse

Пример

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

get_hash_tags Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
pagenumberqueryНе

Отговор

Връща: GetHashTagsResponse

Пример

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

patch_hash_tag Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
tagstringpathYes

Отговор

Връща: UpdateHashTagResponse

Пример

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

delete_moderation_vote Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
voteIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: VoteDeleteResponse

Пример

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

get_api_comments Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
pagenumberqueryНе
countnumberqueryНе
text-searchstringqueryНе
byIPFromCommentstringqueryНе
filtersstringqueryНе
searchFiltersstringqueryНе
sortsstringqueryНе
demobooleanqueryНе
ssostringqueryНе

Отговор

Връща: ModerationAPIGetCommentsResponse

Пример

Пример за get_api_comments
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 page: 1.2, # Float |
9 count: 1.2, # Float |
10 text_search: 'text_search_example', # String |
11 by_ip_from_comment: 'by_ip_from_comment_example', # String |
12 filters: 'filters_example', # String |
13 search_filters: 'search_filters_example', # String |
14 sorts: 'sorts_example', # String |
15 demo: true, # Boolean |
16 sso: 'sso_example' # String |
17}
18
19begin
20
21 result = api_instance.get_api_comments(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling ModerationApi->get_api_comments: #{e}"
25end
26

get_api_export_status Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
batchJobIdstringqueryНе
ssostringqueryНе

Отговор

Връща: ModerationExportStatusResponse

Пример

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

get_api_ids Internal Link

Параметри

ИмеТипЛокацияЗадължителноОписание
tenantIdstringqueryДа
text-searchstringqueryНе
byIPFromCommentstringqueryНе
filtersstringqueryНе
searchFiltersstringqueryНе
afterIdstringqueryНе
demobooleanqueryНе
ssostringqueryНе

Отговор

Връща: ModerationAPIGetCommentIdsResponse

Пример

get_api_ids Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filters: 'filters_example', # String |
11 search_filters: 'search_filters_example', # String |
12 after_id: 'after_id_example', # String |
13 demo: true, # Boolean |
14 sso: 'sso_example' # String |
15}
16
17begin
18
19 result = api_instance.get_api_ids(tenant_id, opts)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling ModerationApi->get_api_ids: #{e}"
23end
24

get_ban_users_from_comment Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Отговор

Връща: GetBannedUsersFromCommentResponse

Пример

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

get_comment_ban_status Internal Link

Parameters

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Response

Връща: GetCommentBanStatusResponse

Example

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

get_comment_children Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Отговор

Връща: ModerationAPIChildCommentsResponse

Пример

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

get_count Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Отговор

Връща: ModerationAPICountCommentsResponse

Пример

Пример за get_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filter: 'filter_example', # String |
11 search_filters: 'search_filters_example', # String |
12 demo: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.get_count(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->get_count: #{e}"
22end
23

get_counts Internal Link

Parameters

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
ssostringqueryНе

Response

Returns: GetBannedUsersCountResponse

Example

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

get_logs Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Отговор

Връща: ModerationAPIGetLogsResponse

Пример

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

get_manual_badges Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
ssostringqueryНе

Отговор

Връща: GetTenantManualBadgesResponse

Пример

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

get_manual_badges_for_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
badgesUserIdstringqueryНе
commentIdstringqueryНе
ssostringqueryНе

Отговор

Връща: GetUserManualBadgesResponse

Пример

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

get_moderation_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
includeEmailbooleanqueryНе
includeIPbooleanqueryНе
ssostringqueryНе

Отговор

Връща: ModerationAPICommentResponse

Пример

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

get_moderation_comment_text Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
ssostringqueryНе

Отговор

Връща: GetCommentTextResponse

Пример

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

get_pre_ban_summary Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Отговор

Връща: PreBanSummary

Пример

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

get_search_comments_summary Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
valuestringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
ssostringqueryNo

Response

Връща: ModerationCommentSearchResponse

Пример

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

get_search_pages Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
valuestringqueryНе
ssostringqueryНе

Отговор

Връща: ModerationPageSearchResponse

Пример

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

get_search_sites Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
valuestringqueryНе
ssostringqueryНе

Отговор

Връща: ModerationSiteSearchResponse

Пример

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

get_search_suggest Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
text-searchstringqueryНе
ssostringqueryНе

Отговор

Връща: ModerationSuggestResponse

Пример

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

get_search_users Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
valuestringqueryНе
ssostringqueryНе

Отговор

Връща: ModerationUserSearchResponse

Пример

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

get_trust_factor Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
userIdstringqueryNo
ssostringqueryNo

Отговор

Връща: GetUserTrustFactorResponse

Пример

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

get_user_ban_preference Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
ssostringqueryNo

Отговор

Връща: APIModerateGetUserBanPreferencesResponse

Пример

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

get_user_internal_profile Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringqueryНе
ssostringqueryНе

Отговор

Връща: GetUserInternalProfileResponse

Пример

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

post_adjust_comment_votes Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: AdjustVotesResponse

Пример

post_adjust_comment_votes Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Грешка при извикване ModerationApi->post_adjust_comment_votes: #{e}"
20end
21

post_api_export Internal Link

Parameters

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Response

Връща: ModerationExportResponse

Пример

post_api_export Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filters: 'filters_example', # String |
11 search_filters: 'search_filters_example', # String |
12 sorts: 'sorts_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.post_api_export(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->post_api_export: #{e}"
22end
23

post_ban_user_from_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringзапитванеДа
commentIdstringпътДа
banEmailbooleanзапитванеНе
banEmailDomainbooleanзапитванеНе
banIPbooleanзапитванеНе
deleteAllUsersCommentsbooleanзапитванеНе
bannedUntilstringзапитванеНе
isShadowBanbooleanзапитванеНе
updateIdstringзапитванеНе
banReasonstringзапитванеНе
ssostringзапитванеНе

Отговор

Връща: BanUserFromCommentResult

Пример

post_ban_user_from_comment Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 ban_email: true, # Boolean |
10 ban_email_domain: true, # Boolean |
11 ban_ip: true, # Boolean |
12 delete_all_users_comments: true, # Boolean |
13 banned_until: 'banned_until_example', # String |
14 is_shadow_ban: true, # Boolean |
15 update_id: 'update_id_example', # String |
16 ban_reason: 'ban_reason_example', # String |
17 sso: 'sso_example' # String |
18}
19
20begin
21
22 result = api_instance.post_ban_user_from_comment(tenant_id, comment_id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Грешка при извикване на ModerationApi->post_ban_user_from_comment: #{e}"
26end
27

post_ban_user_undo Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
ssostringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

post_bulk_pre_ban_summary Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Отговор

Връща: BulkPreBanSummary

Пример

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

post_comments_by_ids Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
ssostringqueryNo

Отговор

Връща: ModerationAPIChildCommentsResponse

Пример

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

post_flag_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: APIEmptyResponse

Пример

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

post_remove_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringзаявкаДа
commentIdstringпътДа
broadcastIdstringзаявкаНе
ssostringзаявкаНе

Отговор

Връща: PostRemoveCommentApiResponse

Пример

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

post_restore_deleted_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

post_set_comment_approval_status Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringpathДа
approvedbooleanqueryНе
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: SetCommentApprovedResponse

Пример

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

post_set_comment_review_status Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: APIEmptyResponse

Пример

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

post_set_comment_spam_status Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: APIEmptyResponse

Пример

post_set_comment_spam_status Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # Низ |
7comment_id = 'comment_id_example' # Низ |
8opts = {
9 spam: true, # Булево |
10 perm_not_spam: true, # Булево |
11 broadcast_id: 'broadcast_id_example', # Низ |
12 sso: 'sso_example' # Низ |
13}
14
15begin
16
17 result = api_instance.post_set_comment_spam_status(tenant_id, comment_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->post_set_comment_spam_status: #{e}"
21end
22

post_set_comment_text Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Returns: SetCommentTextResponse

Пример

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

post_un_flag_comment Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: APIEmptyResponse

Пример

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

post_vote Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Отговор

Връща: VoteResponse

Пример

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

put_award_badge Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
badgeIdstringqueryДа
userIdstringqueryНе
commentIdstringqueryНе
broadcastIdstringqueryНе
ssostringqueryНе

Отговор

Връща: AwardUserBadgeResponse

Пример

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

put_close_thread Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Отговор

Връща: APIEmptyResponse

Пример

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

put_remove_badge Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Response

Връща: RemoveUserBadgeResponse

Example

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

put_reopen_thread Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
urlIdstringqueryДа
ssostringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

put_reopen_thread Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # Низ |
7url_id = 'url_id_example' # Низ |
8opts = {
9 sso: 'sso_example' # Низ |
10}
11
12begin
13
14 result = api_instance.put_reopen_thread(tenant_id, url_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Грешка при извикване на ModerationApi->put_reopen_thread: #{e}"
18end
19

set_trust_factor Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Отговор

Връща: SetUserTrustFactorResponse

Пример

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

create_moderator Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateModeratorResponse

Пример

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

delete_moderator Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
sendEmailstringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

get_moderator Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetModeratorResponse

Пример

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

get_moderators Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
skipnumberqueryНе

Отговор

Връща: GetModeratorsResponse

Пример

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

send_invite Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
fromNamestringqueryДа

Response

Връща: APIEmptyResponse

Example

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

update_moderator Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

delete_notification_count Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

get_cached_notification_count Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetCachedNotificationCountResponse

Пример

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

get_notification_count Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryНе
urlIdstringqueryНе
fromCommentIdstringqueryНе
viewedbooleanqueryНе
typestringqueryНе

Отговор

Връща: GetNotificationCountResponse

Пример

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

get_notifications Internal Link

Parameters

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryНе
urlIdstringqueryНе
fromCommentIdstringqueryНе
viewedbooleanqueryНе
typestringqueryНе
skipnumberqueryНе

Отговор

Връща: GetNotificationsResponse

Пример

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

update_notification Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

create_v1_page_react Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
titlestringqueryНе

Отговор

Връща: CreateV1PageReact

Пример

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

create_v2_page_react Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
idstringqueryДа
titlestringqueryНе

Отговор

Връща: CreateV1PageReact

Пример

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

delete_v1_page_react Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
urlIdstringqueryДа

Отговор

Връща: CreateV1PageReact

Пример

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

delete_v2_page_react Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
idstringqueryДа

Отговор

Връща: CreateV1PageReact

Пример

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

get_v1_page_likes Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа

Отговор

Връща: GetV1PageLikes

Пример

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

get_v2_page_react_users Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
idstringqueryДа

Отговор

Връща: GetV2PageReactUsersResponse

Пример

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

get_v2_page_reacts Internal Link

Параметри

ИмеТипLocationЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа

Отговор

Връща: GetV2PageReacts

Пример

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

add_page Internal Link

Параметри

ИмеТипLocationЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: AddPageAPIResponse

Пример

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

delete_page Internal Link

Параметри

ИмеТипLocationЗадължителенОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: DeletePageAPIResponse

Пример

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

get_offline_users Internal Link


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

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathYes
urlIdstringqueryYesИдентификатор на URL на страницата (изчистен на сървъра).
afterNamestringqueryNoКурсор: подайте nextAfterName от предишния отговор.
afterUserIdstringqueryNoРазрешаване на равенства при курсора: подайте nextAfterUserId от предишния отговор. Задължително когато afterName е зададено, за да не се изпускат записи при еднакви имена.

Отговор

Връща: PageUsersOfflineResponse

Пример

get_offline_users Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | Идентификатор на URL на страницата (изчистен на сървъра).
8opts = {
9 after_name: 'after_name_example', # String | Курсор: подайте nextAfterName от предишния отговор.
10 after_user_id: 'after_user_id_example' # String | Разрешаване на равенства при курсора: подайте nextAfterUserId от предишния отговор. Задължително когато afterName е зададено, за да не се изпускат записи при еднакви имена.
11}
12
13begin
14
15 result = api_instance.get_offline_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_offline_users: #{e}"
19end
20

get_online_users Internal Link

Понастоящем онлайн зрители на страница: хора, чиито websocket сесии са абонирани за страницата в този момент. Връща anonCount + totalCount (абонати на стаята, включително анонимни зрители, които не изброяваме).

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathYes
urlIdstringqueryYesИдентификатор на URL на страницата (изчистен от сървъра).
afterNamestringqueryNoКурсор: предайте nextAfterName от предишния отговор.
afterUserIdstringqueryNoКурсор за разрешаване на равенства: предайте nextAfterUserId от предишния отговор. Задължително когато afterName е зададено, за да не се изпускат записи при еднакви имена.

Отговор

Връща: PageUsersOnlineResponse

Пример

Пример за get_online_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | Идентификатор на URL на страницата (изчистен от сървъра).
8opts = {
9 after_name: 'after_name_example', # String | Курсор: предайте nextAfterName от предишния отговор.
10 after_user_id: 'after_user_id_example' # String | Курсор за разрешаване на равенства: предайте nextAfterUserId от предишния отговор. Задължително когато afterName е зададено, за да не се изпускат записи при еднакви имена.
11}
12
13begin
14
15 result = api_instance.get_online_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_online_users: #{e}"
19end
20

get_page_by_urlid Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
urlIdstringqueryДа

Отговор

Връща: GetPageByURLIdAPIResponse

Пример

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

get_pages Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: GetPagesAPIResponse

Пример

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

get_pages_public Internal Link

Изброява страници за наемател. Използва се от десктоп клиента FChat за попълване на своя списък със стаи. Изисква enableFChat да бъде true в разрешената персонализирана конфигурация за всяка страница. Страниците, които изискват SSO, се филтрират въз основа на груповия достъп на потребителя, който прави заявката.

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
cursorstringqueryНеНепрозрачен курсор за пагинация, върнат като nextCursor от предишна заявка. Свързан със същия sortBy.
limitintegerqueryНе1..200, по подразбиране 50
qstringqueryНеНезадължителен регистронезависим филтър по префикс на заглавието.
sortBystringqueryНеРед на сортиране. updatedAt (по подразбиране, най-новите първи), commentCount (най-много коментари първи) или title (азбучно).
hasCommentsbooleanqueryНеАко е true, връща само страници с поне един коментар.

Отговор

Връща: GetPublicPagesResponse

Пример

get_pages_public Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 cursor: 'cursor_example', # String | Непрозрачен курсор за пагинация, върнат като `nextCursor` от предишна заявка. Свързан със същия `sortBy`.
9 limit: 56, # Integer | 1..200, по подразбиране 50
10 q: 'q_example', # String | Незадължителен регистронезависим филтър по префикс на заглавието.
11 sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Ред на сортиране. `updatedAt` (по подразбиране, най-новите първи), `commentCount` (най-много коментари първи) или `title` (азбучно).
12 has_comments: true # Boolean | Ако е true, връща само страници с поне един коментар.
13}
14
15begin
16
17 result = api_instance.get_pages_public(tenant_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->get_pages_public: #{e}"
21end
22

get_users_info Internal Link

Масова информация за потребители за един наемател. За дадени userIds връща информация за показване от User / SSOUser. Използва се от коментарния widget за обогатяване на потребители, които току-що се появиха чрез presence събитие. Няма контекст на страница: поверителността се прилага по единен начин (частните профили се маскират).

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathYes
idsstringqueryYesuserIds, разделени със запетая.

Отговор

Връща: PageUsersInfoResponse

Пример

Пример за get_users_info
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7ids = 'ids_example' # String | userIds, разделени със запетая.
8
9begin
10
11 result = api_instance.get_users_info(tenant_id, ids)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_users_info: #{e}"
15end
16

patch_page Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Response

Връща: PatchPageAPIResponse

Example

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

delete_pending_webhook_event Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Response

Връща: APIEmptyResponse

Пример

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

get_pending_webhook_event_count Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
commentIdstringqueryНе
externalIdstringqueryНе
eventTypestringqueryНе
typestringqueryНе
domainstringqueryНе
attemptCountGTnumberqueryНе

Отговор

Връща: GetPendingWebhookEventCountResponse

Пример

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

get_pending_webhook_events Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
commentIdstringqueryНе
externalIdstringqueryНе
eventTypestringqueryНе
typestringqueryНе
domainstringqueryНе
attemptCountGTnumberqueryНе
skipnumberqueryНе

Отговор

Връща: GetPendingWebhookEventsResponse

Пример

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

create_question_config Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateQuestionConfigResponse

Пример

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

delete_question_config Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Връща

Връща: APIEmptyResponse

Пример

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

get_question_config Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringзаявкаДа
idstringпътДа

Отговор

Връща: GetQuestionConfigResponse

Пример

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

get_question_configs Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
skipnumberqueryНе

Отговор

Връща: GetQuestionConfigsResponse

Пример

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

update_question_config Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

create_question_result Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateQuestionResultResponse

Пример

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

delete_question_result Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
idstringpathYes

Отговор

Връща: APIEmptyResponse

Пример

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

get_question_result Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetQuestionResultResponse

Пример

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

get_question_results Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
urlIdstringqueryНе
userIdstringqueryНе
startDatestringqueryНе
questionIdstringqueryНе
questionIdsstringqueryНе
skipnumberqueryНе

Отговор

Връща: GetQuestionResultsResponse

Пример

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

update_question_result Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Example

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

aggregate_question_results Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
questionIdstringqueryНе
questionIdsarrayqueryНе
urlIdstringqueryНе
timeBucketstringqueryНе
startDatestringqueryНе
forceRecalculatebooleanqueryНе

Отговор

Връща: AggregateQuestionResultsResponse

Пример

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

bulk_aggregate_question_results Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
forceRecalculatebooleanqueryНе

Отговор

Връща: BulkAggregateQuestionResultsResponse

Пример

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

combine_comments_with_question_results Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
questionIdstringqueryНе
questionIdsarrayqueryНе
urlIdstringqueryНе
startDatestringqueryНе
forceRecalculatebooleanqueryНе
minValuenumberqueryНе
maxValuenumberqueryНе
limitnumberqueryНе

Отговор

Връща: CombineQuestionResultsWithCommentsResponse

Пример

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

add_sso_user Internal Link

Параметри

ИмеTypeLocationЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: AddSSOUserAPIResponse

Пример

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

delete_sso_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
idstringpathYes
deleteCommentsbooleanqueryNo
commentDeleteModestringqueryNo

Отговор

Връща: DeleteSSOUserAPIResponse

Пример

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

get_sso_user_by_email Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
emailstringpathYes

Отговор

Връща: GetSSOUserByEmailAPIResponse

Пример

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

get_sso_user_by_id Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetSSOUserByIdAPIResponse

Пример

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

get_sso_users Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
skipintegerqueryНе

Отговор

Връща: GetSSOUsersResponse

Пример

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

patch_sso_user Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
updateCommentsbooleanqueryNo

Отговор

Връща: PatchSSOUserAPIResponse

Пример

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

put_sso_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
updateCommentsbooleanqueryНе

Отговор

Връща: PutSSOUserAPIResponse

Пример

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

create_subscription Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateSubscriptionAPIResponse

Пример

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

delete_subscription Internal Link

Параметри

ИмеТипМестоположениеЗадължителенОписание
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе

Отговор

Връща: DeleteSubscriptionAPIResponse

Пример

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

get_subscriptions Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryНе

Отговор

Връща: GetSubscriptionsAPIResponse

Пример

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

update_subscription Internal Link

Параметри

ИмеТипLocationЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе

Отговор

Връща: UpdateSubscriptionAPIResponse

Пример

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

get_tenant_daily_usages Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
yearNumbernumberqueryНе
monthNumbernumberqueryНе
dayNumbernumberqueryНе
skipnumberqueryНе

Отговор

Връща: GetTenantDailyUsagesResponse

Пример

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

create_tenant_package Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateTenantPackageResponse

Пример

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

delete_tenant_package Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
idstringpathYes

Отговор

Връща: APIEmptyResponse

Пример

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

get_tenant_package Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetTenantPackageResponse

Пример

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

get_tenant_packages Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
skipnumberqueryNo

Отговор

Връща: GetTenantPackagesResponse

Пример

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

replace_tenant_package Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

update_tenant_package Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

create_tenant_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: CreateTenantUserResponse

Пример

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

delete_tenant_user Internal Link


Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
deleteCommentsstringqueryНе
commentDeleteModestringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

get_tenant_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetTenantUserResponse

Пример

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

get_tenant_users Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
skipnumberqueryNo

Отговор

Връща: GetTenantUsersResponse

Пример

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

replace_tenant_user Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
updateCommentsstringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes
redirectURLstringqueryNo

Отговор

Връща: APIEmptyResponse

Пример

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

update_tenant_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
updateCommentsstringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

create_tenant Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа

Отговор

Връща: CreateTenantResponse

Пример

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

delete_tenant Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
surestringqueryНе

Отговор

Връща: APIEmptyResponse

Пример

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

get_tenant Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: GetTenantResponse

Пример

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

get_tenants Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
metastringqueryНе
skipnumberqueryНе

Отговор

Връща: GetTenantsResponse

Пример

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

update_tenant Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptyResponse

Пример

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

change_ticket_state Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
userIdstringqueryДа
idstringpathДа

Отговор

Връща: ChangeTicketStateResponse

Пример

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

create_ticket Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryДа

Отговор

Връща: CreateTicketResponse

Пример

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

get_ticket Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа
userIdstringqueryНе

Отговор

Връща: GetTicketResponse

Пример

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

get_tickets Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryНе
statenumberqueryНе
skipnumberqueryНе
limitnumberqueryНе

Отговор

Връща: GetTicketsResponse

Пример

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

get_translations Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
namespacestringpathДа
componentstringpathДа
localestringqueryНе
useFullTranslationIdsbooleanqueryНе

Отговор

Връща: GetTranslationsResponse

Пример

Пример за get_translations
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6namespace = 'namespace_example' # String |
7component = 'component_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 use_full_translation_ids: true # Boolean |
11}
12
13begin
14
15 result = api_instance.get_translations(namespace, component, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_translations: #{e}"
19end
20

upload_image Internal Link

Качване и преоразмеряване на изображение

Параметри

NameTypeLocationRequiredDescription
tenantIdstringpathДа
sizePresetstringqueryНеПреднастройка на размера: "Default" (1000x1000px) или "CrossPlatform" (създава размери за популярни устройства)
urlIdstringqueryНеID на страницата, от която се извършва качването, за конфигуриране

Отговор

Връща: UploadImageResponse

Пример

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

get_user_badge_progress_by_id Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Отговор

Връща: APIGetUserBadgeProgressResponse

Пример

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

get_user_badge_progress_by_user_id Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringpathДа

Отговор

Връща: APIGetUserBadgeProgressResponse

Пример

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

get_user_badge_progress_list Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryНе
limitnumberqueryНе
skipnumberqueryНе

Отговор

Връща: APIGetUserBadgeProgressListResponse

Пример

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

create_user_badge Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа

Отговор

Връща: APICreateUserBadgeResponse

Пример

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

delete_user_badge Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptySuccessResponse

Пример

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

get_user_badge Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIGetUserBadgeResponse

Пример

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

get_user_badges Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
userIdstringqueryНе
badgeIdstringqueryНе
typenumberqueryНе
displayedOnCommentsbooleanqueryНе
limitnumberqueryНе
skipnumberqueryНе

Отговор

Връща: APIGetUserBadgesResponse

Пример

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

update_user_badge Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа

Отговор

Връща: APIEmptySuccessResponse

Пример

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

get_user_notification_count Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
ssostringqueryНе

Отговор

Връща: GetUserNotificationCountResponse

Пример

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

get_user_notifications Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
urlIdstringqueryНеИзползва се за определяне дали текущата страница е абонирана.
pageSizeintegerqueryНе
afterIdstringqueryНе
includeContextbooleanqueryНе
afterCreatedAtintegerqueryНе
unreadOnlybooleanqueryНе
dmOnlybooleanqueryНе
noDmbooleanqueryНе
includeTranslationsbooleanqueryНе
includeTenantNotificationsbooleanqueryНе
ssostringqueryНе

Отговор

Връща: GetMyNotificationsResponse

Пример

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

reset_user_notification_count Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
ssostringqueryНе

Отговор

Връща: ResetUserNotificationsResponse

Пример

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

reset_user_notifications Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
afterIdstringqueryНе
afterCreatedAtintegerqueryНе
unreadOnlybooleanqueryНе
dmOnlybooleanqueryНе
noDmbooleanqueryНе
ssostringqueryНе

Отговор

Връща: ResetUserNotificationsResponse

Пример

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

update_user_notification_comment_subscription_status Internal Link

Активиране или деактивиране на уведомления за конкретен коментар.

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
notificationIdstringpathДа
optedInOrOutstringpathДа
commentIdstringqueryДа
ssostringqueryНе

Отговор

Връща: UpdateUserNotificationCommentSubscriptionStatusResponse

Пример

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

update_user_notification_page_subscription_status Internal Link

Активиране или деактивиране на известия за страница. Когато потребителите са абонирани за страница, се създават известия за нови основни коментари, както и

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
urlIdstringqueryДа
urlstringqueryДа
pageTitlestringqueryДа
subscribedOrUnsubscribedstringpathДа
ssostringqueryНе

Отговор

Връща: UpdateUserNotificationPageSubscriptionStatusResponse

Пример

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

update_user_notification_status Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
notificationIdstringpathДа
newStatusstringpathДа
ssostringqueryНе

Отговор

Връща: UpdateUserNotificationStatusResponse

Пример

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

get_user_presence_statuses Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
urlIdWSstringqueryДа
userIdsstringqueryДа

Отговор

Връща: GetUserPresenceStatusesResponse

Пример

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

search_users Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringpathДа
urlIdstringqueryДа
usernameStartsWithstringqueryНе
mentionGroupIdsarrayqueryНе
ssostringqueryНе
searchSectionstringqueryНе

Отговор

Връща: SearchUsersResult

Пример

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

get_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryYes
idstringpathYes

Отговор

Връща: GetUserResponse

Пример

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

create_vote Internal Link

Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
commentIdstringqueryДа
directionstringqueryДа
userIdstringqueryНе
anonUserIdstringqueryНе

Отговор

Връща: VoteResponse

Пример

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

delete_vote Internal Link


Параметри

NameTypeLocationRequiredDescription
tenantIdstringqueryДа
idstringpathДа
editKeystringqueryНе

Отговор

Връща: VoteDeleteResponse

Пример

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

get_votes Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
urlIdstringqueryДа

Отговор

Връща: GetVotesResponse

Пример

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

get_votes_for_user Internal Link

Параметри

ИмеТипМестоположениеЗадължителноОписание
tenantIdstringqueryДа
urlIdstringqueryДа
userIdstringqueryНе
anonUserIdstringqueryНе

Отговор

Връща: GetVotesForUserResponse

Пример

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

Нуждаете ли се от помощ?

Ако срещнете проблеми или имате въпроси относно Ruby SDK, моля:

Принос

Приноси са добре дошли! Моля, посетете репозитория в GitHub за указания за принос.