FastComments.com

FastComments Ruby SDK

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

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

Репозитория

Вижте в GitHub


Инсталация Internal Link

Добавете този ред в Gemfile-а на вашето приложение:

gem 'fastcomments'

И след това изпълнете:

bundle install

Или го инсталирайте сами като:

gem install fastcomments

Съдържание на библиотеката

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

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

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

Бърз старт Internal Link

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

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

require 'fastcomments-client'

# Създаване и конфигуриране на API клиента
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# ЗАДЪЛЖИТЕЛНО: Задайте вашия API ключ (вземете го от таблото на FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Създаване на екземпляр на API с конфигурирания клиент
api = FastCommentsClient::DefaultApi.new(api_client)

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

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

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

Използване на публични API (PublicApi)

Публичните крайни точки не изискват удостоверяване:

require 'fastcomments-client'

public_api = FastCommentsClient::PublicApi.new

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

Често срещани проблеми

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

Бележки Internal Link

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

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

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

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

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


Просто SSO

require 'fastcomments'
require 'fastcomments-client'

# Създаване на токен за Simple SSO
user = FastComments::SSO::SimpleSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  avatar: 'https://example.com/avatar.jpg'
)

sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token

puts "SSO Token: #{token}"

# Използване на SSO токена за извършване на автентифицирано API повикване
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

response = public_api.get_comments_public(
  tenant_id: 'your-tenant-id',
  url_id: 'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

Защитено SSO

require 'fastcomments'
require 'fastcomments-client'

# Създаване на токен за Secure SSO
user = FastComments::SSO::SecureSSOUserData.new(
  user_id: 'user-123',
  email: 'user@example.com',
  username: 'johndoe',
  avatar: 'https://example.com/avatar.jpg'
)

api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token

puts "Secure SSO Token: #{token}"

# Използване на SSO токена за извършване на автентифицирано API повикване
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

response = public_api.get_comments_public(
  tenant_id: 'your-tenant-id',
  url_id: 'your-page-url-id',
  sso: token
)

puts "Status: #{response}"

aggregate Internal Link

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

Параметри

Име Тип Локация Задължително Описание
tenantId string query Yes
parentTenantId string query No
includeStats boolean query No

Отговор

Връща: AggregationResponse

Пример

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

get_audit_logs Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
limit number query Не
skip number query Не
order string query Не
after number query Не
before number query Не

Отговор

Връща: GetAuditLogs200Response

Пример

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

block_from_comment_public Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
commentId string path Да
sso string query Не

Отговор

Връща: BlockFromCommentPublic200Response

Пример

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

un_block_comment_public Internal Link

Параметри

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

Отговор

Връща: UnBlockCommentPublic200Response

Пример

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

checked_comments_for_blocked Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
commentIds string query Да Списък с идентификатори на коментари, разделени със запетаи.
sso string query Не

Отговор

Връща: CheckedCommentsForBlocked200Response

Пример

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

block_user_from_comment Internal Link

Параметри

Име Тип Местоположение Задължителен Описание
tenantId string query Да
id string path Да
userId string query Не
anonUserId string query Не

Отговор

Връща: BlockFromCommentPublic200Response

Пример

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

create_comment_public Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
urlId string query Да
broadcastId string query Да
sessionId string query Не
sso string query Не

Отговор

Връща: CreateCommentPublic200Response

Пример

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

delete_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
contextUserId string query Не
isLive boolean query Не

Отговор

Връща: DeleteComment200Response

Пример

Пример за delete_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройване на авторизация
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Разкоментирайте следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
editKey string query Не
sso string query Не

Отговор

Връща: DeleteCommentPublic200Response

Пример

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

delete_comment_vote Internal Link

Параметри

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

Отговор

Връща: DeleteCommentVote200Response

Пример

Пример за delete_comment_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
userId string query Не
anonUserId string query Не

Отговор

Връща: FlagComment200Response

Пример

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

get_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetComment200Response

Пример

get_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 |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
editKey string query Не
sso string query Не

Отговор

Връща: GetCommentText200Response

Пример

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

get_comment_vote_user_names Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
dir integer query Да
sso string query Не

Отговор

Връща: GetCommentVoteUserNames200Response

Пример

Пример за get_comment_vote_user_names
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8dir = 56 # Integer |
9opts = {
10 sso: 'sso_example' # String |
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

Параметри

Name Type Location Required Description
tenantId string query Да
page integer query Не
limit integer query Не
skip integer query Не
asTree boolean query Не
skipChildren integer query Не
limitChildren integer query Не
maxTreeDepth integer query Не
urlId string query Не
userId string query Не
anonUserId string query Не
contextUserId string query Не
hashTag string query Не
parentId string query Не
direction string query Не

Отговор

Връща: GetComments200Response

Пример

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

get_comments_public Internal Link

req tenantId urlId

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
urlId string query Да
page integer query Не
direction string query Не
sso string query Не
skip integer query Не
skipChildren integer query Не
limit integer query Не
limitChildren integer query Не
countChildren boolean query Не
fetchPageForCommentId string query Не
includeConfig boolean query Не
countAll boolean query Не
includei10n boolean query Не
locale string query Не
modules string query Не
isCrawler boolean query Не
includeNotificationCount boolean query Не
asTree boolean query Не
maxTreeDepth integer query Не
useFullTranslationIds boolean query Не
parentId string query Не
searchText string query Не
hashTags array query Не
userId string query Не
customConfigStr string query Не
afterCommentId string query Не
beforeCommentId string query Не

Отговор

Връща: GetCommentsPublic200Response

Пример

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

lock_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Не

Отговор

Връща: LockComment200Response

Пример

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

pin_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
sso string query Не

Отговор

Връща: PinComment200Response

Пример

Пример за pin_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Низ |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
isLive boolean query Не
doSpamCheck boolean query Не
sendEmails boolean query Не
populateNotifications boolean query Не

Отговор

Връща: SaveComment200Response

Пример

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

save_comments_bulk Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
isLive boolean query Не
doSpamCheck boolean query Не
sendEmails boolean query Не
populateNotifications boolean query Не

Отговор

Връща: Array&lt;SaveComment200Response&gt;

Пример

Пример за save_comments_bulk
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_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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
commentId string path Да
broadcastId string query Да
editKey string query Не
sso string query Не

Отговор

Връща: SetCommentText200Response

Пример

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

un_block_user_from_comment Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes
id string path Yes
userId string query No
anonUserId string query No

Отговор

Връща: UnBlockCommentPublic200Response

Пример

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

un_flag_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes
userId string query No
anonUserId string query No

Отговор

Връща: FlagComment200Response

Пример

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

un_lock_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string път Да
commentId string път Да
broadcastId string заявка Да
sso string заявка Не

Отговор

Връща: LockComment200Response

Пример

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

un_pin_comment Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Yes
commentId string path Yes
broadcastId string query Yes
sso string query No

Отговор

Връща: PinComment200Response

Пример

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

update_comment Internal Link

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за update_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизацията
5FastCommentsClient.configure do |config|
6 # 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 |
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

Параметри

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

Отговор

Връща: VoteComment200Response

Пример

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

add_domain_config Internal Link

Параметри

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

Response

Връща: AddDomainConfig200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
domain string path Да

Отговор

Връща: DeleteDomainConfig200Response

Пример

Пример за 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' # Низ |
14domain = 'domain_example' # Низ |
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

Параметри

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

Отговор

Връща: GetDomainConfig200Response

Пример

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

get_domain_configs Internal Link


Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: GetDomainConfigs200Response

Пример

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

patch_domain_config Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
domainToUpdate string path Да

Отговор

Връща: GetDomainConfig200Response

Пример

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

put_domain_config Internal Link

Параметри

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

Отговор

Връща: GetDomainConfig200Response

Пример

Пример за put_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка на авторизацията
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Разкоментирайте следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain_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

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: CreateEmailTemplate200Response

Пример

Пример за create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на упълномощаване
5FastCommentsClient.configure do |config|
6 # Конфигуриране на упълномощаване с 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

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

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

delete_email_template_render_error Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes
errorId string path Yes

Отговор

Връща: FlagCommentPublic200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetEmailTemplate200Response

Пример

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

Параметри

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

Отговор

Връща: GetEmailTemplateDefinitions200Response

Пример

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

get_email_template_render_errors Internal Link

Параметри

Име Type Location Задължително Описание
tenantId string query Да
id string path Да
skip number query Не

Отговор

Връща: GetEmailTemplateRenderErrors200Response

Пример

Пример get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизация
5FastCommentsClient.configure do |config|
6 # Конфигуриране на авторизация с API ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Разкоментирайте следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Низ |
14id = 'id_example' # Низ |
15opts = {
16 skip: 1.2 # Число с плаваща запетая |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
skip number query Не

Отговор

Връща: GetEmailTemplates200Response

Пример

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

render_email_template Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes
locale string query No

Отговор

Връща: RenderEmailTemplate200Response

Пример

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

update_email_template Internal Link

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за update_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 |
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

Параметри

Name Type Location Required Description
tenantId string path Да
urlId string query Да
userIdWS string query Да
startTime integer query Да
endTime integer query Да

Отговор

Връща: GetEventLog200Response

Пример

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

get_global_event_log Internal Link

req tenantId urlId userIdWS

Параметри

Name Type Location Required Description
tenantId string path Да
urlId string query Да
userIdWS string query Да
startTime integer query Да
endTime integer query Да

Отговор

Връща: GetEventLog200Response

Пример

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

create_feed_post Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
broadcastId string query Не
isLive boolean query Не
doSpamCheck boolean query Не
skipDupCheck boolean query Не

Отговор

Връща: CreateFeedPost200Response

Пример

Пример за create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройване на авторизацията
5FastCommentsClient.configure do |config|
6 # Конфигуриране на 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
broadcastId string query Не
sso string query Не

Отговор

Връща: CreateFeedPostPublic200Response

Пример

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

delete_feed_post_public Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
postId string path Да
broadcastId string query Не
sso string query Не

Отговор

Връща: DeleteFeedPostPublic200Response

Пример

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

заявка tenantId afterId

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
afterId string query Не
limit integer query Не
tags array query Не

Отговор

Връща: GetFeedPosts200Response

Пример

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

get_feed_posts_public Internal Link

req tenantId afterId

Параметри

Име Тип Местоположение Задължително Описание
tenantId string path Да
afterId string query Не
limit integer query Не
tags array query Не
sso string query Не
isCrawler boolean query Не
includeUserInfo boolean query Не

Отговор

Връща: GetFeedPostsPublic200Response

Пример

Пример get_feed_posts_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Низ |
7opts = {
8 after_id: 'after_id_example', # Низ |
9 limit: 56, # Цяло число |
10 tags: ['inner_example'], # Масив<String> |
11 sso: 'sso_example', # Низ |
12 is_crawler: true, # Булев |
13 include_user_info: true # Булев |
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

Параметри

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

Отговор

Връща: GetFeedPostsStats200Response

Пример

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

get_user_reacts_public Internal Link

Параметри

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

Отговор

Връща: GetUserReactsPublic200Response

Пример

Пример на get_user_reacts_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Низ |
7opts = {
8 post_ids: ['inner_example'], # Масив<String> |
9 sso: 'sso_example' # Низ |
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

Параметри

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

Отговор

Връща: ReactFeedPostPublic200Response

Пример

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

update_feed_post Internal Link

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

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

update_feed_post_public Internal Link

Параметри

Name Type Location Required Description
tenantId string път Да
postId string път Да
broadcastId string заявка Не
sso string заявка Не

Отговор

Връща: CreateFeedPostPublic200Response

Пример

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

flag_comment_public Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
commentId string path Да
isFlagged boolean query Да
sso string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

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

add_hash_tag Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Не

Отговор

Връща: AddHashTag200Response

Пример

Пример за 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
13opts = {
14 tenant_id: 'tenant_id_example', # String |
15 create_hash_tag_body: FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
16}
17
18begin
19
20 result = api_instance.add_hash_tag(opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
24end
25

add_hash_tags_bulk Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Не

Отговор

Връща: AddHashTagsBulk200Response

Пример

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

delete_hash_tag Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tag string path Да
tenantId string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

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

get_hash_tags Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
page number query Не

Отговор

Връща: GetHashTags200Response

Пример

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

Параметри

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

Отговор

Връща: PatchHashTag200Response

Пример

Пример за patch_hash_tag
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройване на авторизация
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 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
13tag = 'tag_example' # String |
14opts = {
15 tenant_id: 'tenant_id_example', # String |
16 update_hash_tag_body: FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
17}
18
19begin
20
21 result = api_instance.patch_hash_tag(tag, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
25end
26

create_moderator Internal Link

Параметри

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

Отговор

Връща: CreateModerator200Response

Пример

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

delete_moderator Internal Link

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за delete_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизация
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Окоментирайте следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране е nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetModerator200Response

Пример

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

Параметри

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

Отговор

Връща: GetModerators200Response

Пример

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

send_invite Internal Link

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизацията
5FastCommentsClient.configure do |config|
6 # Конфигуриране на API ключ за авторизация: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Премахнете коментара от следния ред, за да зададете префикс за API ключа, например 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Низ |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes

Отговор

Връща: FlagCommentPublic200Response

Пример

update_moderator Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройване на авторизация
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Премахнете коментарa от следния ред за да зададете префикс за 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

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetCachedNotificationCount200Response

Пример

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

get_notification_count Internal Link


Параметри

Име Тип Местоположение Задължително Описание
tenantId string заявка Да
userId string заявка Не
urlId string заявка Не
fromCommentId string заявка Не
viewed boolean заявка Не
type string заявка Не

Отговор

Връща: GetNotificationCount200Response

Пример

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 # Разкоментирайте следния ред, за да зададете префикс за 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}
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
userId string query Не
urlId string query Не
fromCommentId string query Не
viewed boolean query Не
type string query Не
skip number query Не

Отговор

Връща: GetNotifications200Response

Пример

get_notifications Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизация
5FastCommentsClient.configure do |config|
6 # Конфигуриране на 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes
userId string query No

Отговор

Връща: FlagCommentPublic200Response

Пример

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

add_page Internal Link

Параметри

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

Отговор

Връща: AddPageAPIResponse

Пример

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

delete_page Internal Link

Параметри

Име Тип Location Задължителен Описание
tenantId string query Да
id string path Да

Отговор

Връща: DeletePageAPIResponse

Пример

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

get_page_by_urlid Internal Link

Параметри

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

Отговор

Връща: GetPageByURLIdAPIResponse

Пример

Пример за get_page_by_urlid
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройване на авторизация
5FastCommentsClient.configure do |config|
6 # 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

Параметри

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

Отговор

Връща: GetPagesAPIResponse

Пример

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

patch_page Internal Link

Parameters

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

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


Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за delete_pending_webhook_event
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройване на удостоверяване
5FastCommentsClient.configure do |config|
6 # Конфигуриране на удостоверяване с API ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Премахнете коментара от следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Низ |
14id = 'id_example' # Низ |
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

Параметри

Име Тип Местоположение Задължителен Описание
tenantId string query Да
commentId string query Не
externalId string query Не
eventType string query Не
type string query Не
domain string query Не
attemptCountGT number query Не

Отговор

Връща: GetPendingWebhookEventCount200Response

Пример

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

get_pending_webhook_events Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
commentId string query Не
externalId string query Не
eventType string query Не
type string query Не
domain string query Не
attemptCountGT number query Не
skip number query Не

Отговор

Връща: GetPendingWebhookEvents200Response

Пример

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

create_question_config Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да

Отговор

Връща: CreateQuestionConfig200Response

Пример

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

delete_question_config Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

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

get_question_config Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetQuestionConfig200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
skip number query Не

Отговор

Връща: GetQuestionConfigs200Response

Пример

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

update_question_config Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

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

create_question_result Internal Link

Параметри

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

Отговор

Връща: CreateQuestionResult200Response

Пример

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

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за delete_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизация
5FastCommentsClient.configure do |config|
6 # Конфигуриране на авторизация с API ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Разкоментирайте следния ред, за да зададете префикс за API ключа, напр. '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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetQuestionResult200Response

Пример

get_question_result Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на удостоверяване
5FastCommentsClient.configure do |config|
6 # Конфигуриране на удостоверяване чрез API ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Разкоментирайте следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
urlId string query Не
userId string query Не
startDate string query Не
questionId string query Не
questionIds string query Не
skip number query Не

Отговор

Връща: GetQuestionResults200Response

Пример

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

update_question_result Internal Link

Parameters

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

Response

Връща: FlagCommentPublic200Response

Пример

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

aggregate_question_results Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
questionId string query Не
questionIds array query Не
urlId string query Не
timeBucket string query Не
startDate string query Не
forceRecalculate boolean query Не

Отговор

Връща: AggregateQuestionResults200Response

Пример

Пример за aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройване на авторизацията
5FastCommentsClient.configure do |config|
6 # 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

Параметри

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

Отговор

Връща: BulkAggregateQuestionResults200Response

Пример

Пример за bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на удостоверяване
5FastCommentsClient.configure do |config|
6 # 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 |
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

Параметри

Name Type Location Required Description
tenantId string query Да
questionId string query Не
questionIds array query Не
urlId string query Не
startDate string query Не
forceRecalculate boolean query Не
minValue number query Не
maxValue number query Не
limit number query Не

Отговор

Връща: CombineCommentsWithQuestionResults200Response

Пример

Пример за combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на удостоверяване
5FastCommentsClient.configure do |config|
6 # Конфигуриране на удостоверяване чрез 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

Параметри

Име Type Location Задължително Описание
tenantId string query Да

Отговор

Връща: AddSSOUserAPIResponse

Пример

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

delete_sso_user Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes
deleteComments boolean query No
commentDeleteMode string query No

Отговор

Връща: 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
email string path Yes

Отговор

Връща: 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

Параметри

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

Отговор

Връща: 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

Параметри

Име Тип Локация Задължително Описание
tenantId string query Да
skip integer query Не

Отговор

Връща: GetSSOUsers200Response

Пример

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

patch_sso_user Internal Link

Параметри

Name Type Location Required Description
tenantId string query Yes
id string path Yes
updateComments boolean query No

Отговор

Връща: 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
updateComments boolean query Не

Отговор

Връща: PutSSOUserAPIResponse

Пример

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

create_subscription Internal Link

Параметри

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

Отговор

Връща: CreateSubscriptionAPIResponse

Пример

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

delete_subscription Internal Link

Параметри

Име Тип Местоположение Задължителен Описание
tenantId string query Да
id string path Да
userId string query Не

Отговор

Връща: DeleteSubscriptionAPIResponse

Пример

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

get_subscriptions Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
userId string query Не

Отговор

Връща: GetSubscriptionsAPIResponse

Пример

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

get_tenant_daily_usages Internal Link

Параметри

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

Отговор

Връща: GetTenantDailyUsages200Response

Пример

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

create_tenant_package Internal Link

Параметри

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

Отговор

Връща: CreateTenantPackage200Response

Пример

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

delete_tenant_package Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

delete_tenant_package Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройване на авторизацията
5FastCommentsClient.configure do |config|
6 # Конфигуриране на авторизацията чрез 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetTenantPackage200Response

Пример

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

get_tenant_packages Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да
skip number query Не

Отговор

Връща: GetTenantPackages200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes

Отговор

Връща: FlagCommentPublic200Response

Пример

replace_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 |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: FlagCommentPublic200Response

Пример

Пример за update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизацията
5FastCommentsClient.configure do |config|
6 # Конфигуриране на авторизация с API ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # 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

Параметри

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

Отговор

Връща: CreateTenantUser200Response

Пример

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

delete_tenant_user Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
deleteComments string query Не
commentDeleteMode string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

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

Параметри

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

Отговор

Връща: GetTenantUser200Response

Пример

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

get_tenant_users Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
skip number query Не

Отговор

Връща: GetTenantUsers200Response

Пример

get_tenant_users Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на удостоверяване
5FastCommentsClient.configure do |config|
6 # 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 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

Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
redirectURL string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

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

update_tenant_user Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
updateComments string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

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

create_tenant Internal Link

Параметри

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

Отговор

Връща: CreateTenant200Response

Пример

create_tenant Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизацията
5FastCommentsClient.configure do |config|
6 # Конфигуриране на авторизация чрез API ключ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Премахнете коментара от следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да
sure string query Не

Отговор

Връща: FlagCommentPublic200Response

Пример

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

get_tenant Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetTenant200Response

Пример

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

get_tenants Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да
meta string query Не
skip number query Не

Отговор

Връща: GetTenants200Response

Пример

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

update_tenant Internal Link


Параметри

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

Отговор

Връща: FlagCommentPublic200Response

Пример

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

upload_image Internal Link

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

Параметри

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

Отговор

Връща: UploadImageResponse

Пример

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

get_user_badge_progress_by_id Internal Link

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
id string path Yes

Отговор

Връща: GetUserBadgeProgressById200Response

Пример

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

get_user_badge_progress_by_user_id Internal Link

Параметри

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

Отговор

Връща: GetUserBadgeProgressById200Response

Пример

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

get_user_badge_progress_list Internal Link

Параметри

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

Отговор

Връща: GetUserBadgeProgressList200Response

Пример

get_user_badge_progress_list Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на авторизацията
5FastCommentsClient.configure do |config|
6 # 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 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

Параметри

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

Отговор

Връща: CreateUserBadge200Response

Пример

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: UpdateUserBadge200Response

Пример

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

get_user_badge Internal Link

Параметри

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

Отговор

Връща: GetUserBadge200Response

Пример

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

get_user_badges Internal Link

Параметри

Name Type Location Required Description
tenantId string query Да
userId string query Не
badgeId string query Не
type number query Не
displayedOnComments boolean query Не
limit number query Не
skip number query Не

Отговор

Връща: GetUserBadges200Response

Пример

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

Параметри

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

Response

Връща: UpdateUserBadge200Response

Пример

update_user_badge Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на удостоверяване
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Разкоментирайте следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
sso string query Не

Отговор

Връща: GetUserNotificationCount200Response

Пример

get_user_notification_count Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
pageSize integer query Не
afterId string query Не
includeContext boolean query Не
afterCreatedAt integer query Не
unreadOnly boolean query Не
dmOnly boolean query Не
noDm boolean query Не
includeTranslations boolean query Не
sso string query Не

Отговор

Връща: GetUserNotifications200Response

Пример

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

reset_user_notification_count Internal Link

Параметри

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

Отговор

Връща: ResetUserNotifications200Response

Пример

Пример за reset_user_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Низ |
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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Yes
afterId string query No
afterCreatedAt integer query No
unreadOnly boolean query No
dmOnly boolean query No
noDm boolean query No
sso string query No

Отговор

Връща: ResetUserNotifications200Response

Пример

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

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
notificationId string path Да
optedInOrOut string path Да
commentId string query Да
sso string query Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

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

update_user_notification_page_subscription_status Internal Link

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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
urlId string query Да
url string query Да
pageTitle string query Да
subscribedOrUnsubscribed string path Да
sso string query Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

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

update_user_notification_status Internal Link

Параметри

Име Тип Локация Задължително Описание
tenantId string query Да
notificationId string path Да
newStatus string path Да
sso string query Не

Отговор

Връща: UpdateUserNotificationStatus200Response

Пример

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

get_user_presence_statuses Internal Link

Параметри

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

Отговор

Връща: GetUserPresenceStatuses200Response

Пример

Пример за get_user_presence_statuses
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # 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

Параметри

Name Type Location Required Description
tenantId string path Да
urlId string query Да
usernameStartsWith string query Да
mentionGroupIds array query Не
sso string query Не

Отговор

Връща: SearchUsers200Response

Пример

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

get_user Internal Link

Параметри

Име Тип Location Задължително Описание
tenantId string query Да
id string path Да

Отговор

Връща: GetUser200Response

Пример

get_user Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на удостоверяване
5FastCommentsClient.configure do |config|
6 # Конфигуриране на удостоверяване с 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(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

Параметри

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

Отговор

Връща: VoteComment200Response

Пример

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

delete_vote Internal Link

Параметри

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

Отговор

Връща: DeleteCommentVote200Response

Пример

Пример за delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# настройка на упълномощаването
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Премахнете коментара от следния ред, за да зададете префикс за API ключа, напр. 'Bearer' (по подразбиране: nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
urlId string query Да

Отговор

Връща: GetVotes200Response

Пример

Пример за get_votes
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_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

Параметри

Име Тип Местоположение Задължително Описание
tenantId string query Да
urlId string query Да
userId string query Не
anonUserId string query Не

Отговор

Връща: GetVotesForUser200Response

Пример

get_votes_for_user Пример
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Настройка на удостоверяване
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 за указания за принос.