FastComments.com

FastComments SDK za Ruby


To je uradni Ruby SDK za FastComments.

Uradni Ruby SDK za FastComments API

Repozitorij

Oglejte si na GitHubu


Namestitev Internal Link

Add this line to your application's Gemfile:

gem 'fastcomments'

And then execute:

bundle install

Or install it yourself as:

gem install fastcomments

Library Contents

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

Public vs Secured APIs

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

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

Hitri začetek Internal Link

Uporaba avtenticiranih API-jev (DefaultApi)

Pomembno: Morate nastaviti svoj API ključ v ApiClient, preden izvedete avtenticirane zahteve. Če tega ne storite, bodo zahteve propadle z napako 401.

require 'fastcomments'

# Ustvari in konfiguriraj API odjemalca
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)

# ZAHTEVANO: Nastavite svoj API ključ (pridobite ga v nadzorni plošči FastComments)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'

# Ustvari instanco API-ja s konfiguriranim odjemalcem
api = FastCommentsClient::DefaultApi.new(api_client)

# Zdaj lahko izvajate avtenticirane klice API-ja
begin
  # Primer: Dodaj SSO uporabnika
  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}"
  # Pogoste napake:
  # - 401: API ključ manjka ali je neveljaven
  # - 400: Validacija zahteve je spodletela
end

Uporaba javnih API-jev (PublicApi)

Javni končni naslovi ne zahtevajo avtentikacije:

require 'fastcomments'

public_api = FastCommentsClient::PublicApi.new

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

Uporaba moderacijskih API-jev (ModerationApi)

Metode moderacije poganjajo nadzorno ploščo moderatorjev. Posredujte sso žeton, da je zahteva izvedena v imenu SSO‑avtenticiranega moderatorja:

require 'fastcomments'

moderation_api = FastCommentsClient::ModerationApi.new

begin
  # Primer: Naštej komentarje v moderacijski čakalni vrsti
  response = moderation_api.get_api_comments(
    sso: 'YOUR_MODERATOR_SSO_TOKEN'
  )
  puts response
rescue FastCommentsClient::ApiError => e
  puts e.message
end

Pogoste težave

  1. 401 napaka “missing-api-key”: Prepričajte se, da ste pred ustvarjanjem instance DefaultApi nastavili config.api_key['x-api-key'] = 'YOUR_KEY'.
  2. Napačen API razred: Uporabite DefaultApi za strežniške avtenticirane zahteve, PublicApi za odjemalske/javne zahteve in ModerationApi za zahteve nadzorne plošče moderatorja.
  3. Null API ključ: SDK bo tiho preskočil avtentikacijo, če je API ključ null, kar povzroči napake 401.

Opombe Internal Link

Identifikatorji oddaj

Videli boste, da morate v nekaterih klicih API posredovati broadcastId. Ko prejmete dogodke, boste ta ID dobili nazaj, tako da boste vedeli, da dogodek prezrete, če nameravate optimistično uporabiti spremembe na odjemalcu (kar boste verjetno želeli storiti, saj nudi najboljšo izkušnjo). Tukaj posredujte UUID. ID naj bo dovolj edinstven, da se ne pojavi dvakrat v seji brskalnika.

SSO (Enotna prijava)

Za primere SSO glejte spodaj.

Uporaba SSO Internal Link

Enostavno SSO

require 'fastcomments'

# Ustvari enostavni SSO žeton
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}"

# Uporabi SSO žeton za izvedbo avtoriziranega API klica
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

Zavarovano SSO

require 'fastcomments'

# Ustvari varen SSO žeton
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}"

# Uporabi SSO žeton za izvedbo avtoriziranega API klica
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)

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

puts "Status: #{response}"

aggregate Internal Link


Združuje dokumente z združevanjem (če je podan groupBy) in z izvajanjem več operacij. Podprte so različne operacije (npr. sum, countDistinct, avg itd.).

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
parentTenantIdstringqueryNe
includeStatsbooleanqueryNe

Odgovor

Vrne: AggregateResponse

Primer

Primer agregacije
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
limitnumberqueryNo
skipnumberqueryNo
orderstringqueryNo
afternumberqueryNo
beforenumberqueryNo

Odgovor

Vrača: GetAuditLogsResponse

Primer

Primer get_audit_logs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 limit: 1.2, # Float |
16 skip: 1.2, # Float |
17 order: FastCommentsClient::SORTDIR::ASC, # SORTDIR |
18 after: 1.2, # Float |
19 before: 1.2 # Float |
20}
21
22begin
23
24 result = api_instance.get_audit_logs(tenant_id, opts)
25 p result
26rescue FastCommentsClient::ApiError => e
27 puts "Error when calling DefaultApi->get_audit_logs: #{e}"
28end
29

logout_public Internal Link

Odgovor

Vrne: APIEmptyResponse

Primer

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

block_from_comment_public Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
commentIdstringpathDa
ssostringqueryNe

Odgovor

Vrača: BlockSuccess

Primer

Primer uporabe block_from_comment_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Niz |
7comment_id = 'comment_id_example' # Niz |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # Niz |
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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
ssostringqueryNe

Odgovor

Vrne: UnblockSuccess

Primer

un_block_comment_public Primer
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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpoizvedbaDa
commentIdsstringpoizvedbaDaSeznam ID-jev komentarjev, ločenih z vejico.
ssostringpoizvedbaNe

Odgovor

Vrne: CheckBlockedCommentsResponse

Primer

Primer 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 | Seznam ID-jev komentarjev, ločenih z vejico.
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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe
anonUserIdstringqueryNe

Odgovor

Vrne: BlockSuccess

Primer

Primer block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
sessionIdstringqueryNo
ssostringqueryNo

Odgovor

Vrača: SaveCommentsResponseWithPresence

Primer

create_comment_public Primer
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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
contextUserIdstringqueryNe
isLivebooleanqueryNe

Odziv

Vrne: DeleteCommentResult

Primer

Primer delete_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite prefiks za API ključ, npr. 'Bearer' (privzeto je 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
commentIdstringpathDa
broadcastIdstringqueryDa
editKeystringqueryNe
ssostringqueryNe

Odgovor

Vrača: PublicAPIDeleteCommentResponse

Primer

Primer 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathYes
commentIdstringpathYes
voteIdstringpathYes
urlIdstringqueryYes
broadcastIdstringqueryYes
editKeystringqueryNo
ssostringqueryNo

Odgovor

Vrne: VoteDeleteResponse

Primer

delete_comment_vote Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Niz |
7comment_id = 'comment_id_example' # Niz |
8vote_id = 'vote_id_example' # Niz |
9url_id = 'url_id_example' # Niz |
10broadcast_id = 'broadcast_id_example' # Niz |
11opts = {
12 edit_key: 'edit_key_example', # Niz |
13 sso: 'sso_example' # Niz |
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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe
anonUserIdstringqueryNe

Odgovor

Vrne: FlagCommentResponse

Primer

Primer flag_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIGetCommentResponse

Primer

get_comment Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
commentIdstringpathDa
editKeystringqueryNe
ssostringqueryNe

Odgovor

Vrne: PublicAPIGetCommentTextResponse

Primer

get_comment_text Primer
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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
commentIdstringpathDa
dirintegerqueryDa
ssostringqueryNe

Odziv

Vrne: GetCommentVoteUserNamesSuccessResponse

Primer

Primer 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
pageintegerqueryNe
limitintegerqueryNe
skipintegerqueryNe
asTreebooleanqueryNe
skipChildrenintegerqueryNe
limitChildrenintegerqueryNe
maxTreeDepthintegerqueryNe
urlIdstringqueryNe
userIdstringqueryNe
anonUserIdstringqueryNe
contextUserIdstringqueryNe
hashTagstringqueryNe
parentIdstringqueryNe
directionstringqueryNe
fromDateintegerqueryNe
toDateintegerqueryNe

Odgovor

Vrne: APIGetCommentsResponse

Primer

Primer get_comments
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 page: 56, # Integer |
16 limit: 56, # Integer |
17 skip: 56, # Integer |
18 as_tree: true, # Boolean |
19 skip_children: 56, # Integer |
20 limit_children: 56, # Integer |
21 max_tree_depth: 56, # Integer |
22 url_id: 'url_id_example', # String |
23 user_id: 'user_id_example', # String |
24 anon_user_id: 'anon_user_id_example', # String |
25 context_user_id: 'context_user_id_example', # String |
26 hash_tag: 'hash_tag_example', # String |
27 parent_id: 'parent_id_example', # String |
28 direction: FastCommentsClient::SortDirections::OF, # SortDirections |
29 from_date: 789, # Integer |
30 to_date: 789 # Integer |
31}
32
33begin
34
35 result = api_instance.get_comments(tenant_id, opts)
36 p result
37rescue FastCommentsClient::ApiError => e
38 puts "Error when calling DefaultApi->get_comments: #{e}"
39end
40

get_comments_public Internal Link

req tenantId urlId

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
urlIdstringqueryDa
pageintegerqueryNe
directionstringqueryNe
ssostringqueryNe
skipintegerqueryNe
skipChildrenintegerqueryNe
limitintegerqueryNe
limitChildrenintegerqueryNe
countChildrenbooleanqueryNe
fetchPageForCommentIdstringqueryNe
includeConfigbooleanqueryNe
countAllbooleanqueryNe
includei10nbooleanqueryNe
localestringqueryNe
modulesstringqueryNe
isCrawlerbooleanqueryNe
includeNotificationCountbooleanqueryNe
asTreebooleanqueryNe
maxTreeDepthintegerqueryNe
useFullTranslationIdsbooleanqueryNe
parentIdstringqueryNe
searchTextstringqueryNe
hashTagsarrayqueryNe
userIdstringqueryNe
customConfigStrstringqueryNe
afterCommentIdstringqueryNe
beforeCommentIdstringqueryNe

Odgovor

Vrača: GetCommentsResponseWithPresencePublicComment

Primer

Primer 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
commentIdstringpathDa
broadcastIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

Primer 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringpathDa
commentIdstringpathDa
broadcastIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: ChangeCommentPinStatusResponse

Primer

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

save_comment Internal Link


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
isLivebooleanqueryNe
doSpamCheckbooleanqueryNe
sendEmailsbooleanqueryNe
populateNotificationsbooleanqueryNe

Odgovor

Vrne: APISaveCommentResponse

Primer

Primer save_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTypeLokacijaObveznoOpis
tenantIdstringqueryDa
isLivebooleanqueryNe
doSpamCheckbooleanqueryNe
sendEmailsbooleanqueryNe
populateNotificationsbooleanqueryNe

Odgovor

Vrne: SaveCommentsBulkResponse

Primer

Primer save_comments_bulk
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavi avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringpathDa
commentIdstringpathDa
broadcastIdstringqueryDa
editKeystringqueryNe
ssostringqueryNe

Odziv

Vrne: PublicAPISetCommentTextResponse

Primer

Primer 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe
anonUserIdstringqueryNe

Odgovor

Vrne: UnblockSuccess

Primer

Primer un_block_user_from_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe
anonUserIdstringqueryNe

Odgovor

Vrne: FlagCommentResponse

Primer

un_flag_comment Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
commentIdstringpathDa
broadcastIdstringqueryDa
ssostringqueryNe

Odziv

Vrne: APIEmptyResponse

Primer

Primer 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


Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringpathDa
commentIdstringpathDa
broadcastIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: ChangeCommentPinStatusResponse

Primer

Primer 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
contextUserIdstringqueryNe
doSpamCheckbooleanqueryNe
isLivebooleanqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

Primer update_comment
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpotDa
commentIdstringpotDa
urlIdstringqueryDa
broadcastIdstringqueryDa
sessionIdstringqueryNe
ssostringqueryNe

Odgovor

Vrača: VoteResponse

Primer

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

get_comments_for_user Internal Link


Parametri

NameTypeLocationRequiredDescription
userIdstringqueryNe
directionstringqueryNe
repliesToUserIdstringqueryNe
pagenumberqueryNe
includei10nbooleanqueryNe
localestringqueryNe
isCrawlerbooleanqueryNe

Odgovor

Vrne: GetCommentsForUserResponse

Primer

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

add_domain_config Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Odgovor

Vrne: AddDomainConfigResponse

Primer

Primer add_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
domainstringpathDa

Odgovor

Vrne: DeleteDomainConfigResponse

Primer

delete_domain_config Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, če želite nastaviti predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14domain = 'domain_example' # String |
15
16begin
17
18 result = api_instance.delete_domain_config(tenant_id, domain)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_domain_config: #{e}"
22end
23

get_domain_config Internal Link

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
domainstringpathDa

Odgovor

Vrne: GetDomainConfigResponse

Primer

get_domain_config Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa

Odgovor

Vrne: GetDomainConfigsResponse

Primer

Primer get_domain_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, če želite nastaviti predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
domainToUpdatestringpathDa

Odgovor

Vrne: PatchDomainConfigResponse

Primer

Primer patch_domain_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
domainToUpdatestringpathDa

Odgovor

Vrne: PutDomainConfigResponse

Primer

put_domain_config Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Odziv

Vrne: CreateEmailTemplateResponse

Primer

Primer create_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo preko API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

delete_email_template Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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


Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa
errorIdstringpathDa

Odziv

Vrne: APIEmptyResponse

Primer

Primer delete_email_template_render_error
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
idstringpathYes

Odgovor

Vrne: GetEmailTemplateResponse

Primer

Primer get_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa

Odgovor

Vrne: GetEmailTemplateDefinitionsResponse

Primer

Primer get_email_template_definitions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
skipnumberqueryNe

Odgovor

Vrne: GetEmailTemplateRenderErrorsResponse

Primer

Primer get_email_template_render_errors
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # config.api_key_prefix['x-api-key'] = 'Bearer'
9end
10
11api_instance = FastCommentsClient::DefaultApi.new
12tenant_id = 'tenant_id_example' # String |
13id = 'id_example' # String |
14opts = {
15 skip: 1.2 # Float |
16}
17
18begin
19
20 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
24end
25

get_email_templates Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
skipnumberqueryNe

Odgovor

Vrne: GetEmailTemplatesResponse

Primer

Primer get_email_templates
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
localestringqueryNo

Odziv

Vrne: RenderEmailTemplateResponse

Primer

Primer render_email_template
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

update_email_template Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
urlIdstringqueryDa
userIdWSstringqueryDa
startTimeintegerqueryDa
endTimeintegerqueryNe

Odgovor

Vrne: GetEventLogResponse

Primer

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

get_global_event_log Internal Link

req tenantId urlId userIdWS

Parametri

ImeTypeLocationObveznoOpis
tenantIdstringpathDa
urlIdstringqueryDa
userIdWSstringqueryDa
startTimeintegerqueryDa
endTimeintegerqueryNe

Odgovor

Vrne: GetEventLogResponse

Primer

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

create_feed_post Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
broadcastIdstringqueryNe
isLivebooleanqueryNe
doSpamCheckbooleanqueryNe
skipDupCheckbooleanqueryNe

Odgovor

Vrne: CreateFeedPostsResponse

Primer

Primer create_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: CreateFeedPostResponse

Primer

Primer 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
postIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: DeleteFeedPostPublicResponse

Primer

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

get_feed_posts Internal Link

req tenantId afterId

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
afterIdstringqueryNe
limitintegerqueryNe
tagsarrayqueryNe

Odgovor

Vrne: GetFeedPostsResponse

Primer

get_feed_posts Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtentikacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
afterIdstringqueryNe
limitintegerqueryNe
tagsarrayqueryNe
ssostringqueryNe
isCrawlerbooleanqueryNe
includeUserInfobooleanqueryNe

Odziv

Vrača: PublicFeedPostsResponse

Primer

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

get_feed_posts_stats Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
postIdsarrayqueryDa
ssostringqueryNe

Odgovor

Vrne: FeedPostsStatsResponse

Primer

get_feed_posts_stats Primer
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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
postIdsarrayqueryNe
ssostringqueryNe

Odgovor

Vrne: UserReactsResponse

Primer

get_user_reacts_public Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Niz |
7opts = {
8 post_ids: ['inner_example'], # Polje<String> |
9 sso: 'sso_example' # Niz |
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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
postIdstringpathDa
isUndobooleanqueryNe
broadcastIdstringqueryNe
ssostringqueryNe

Odziv

Vrača: ReactFeedPostResponse

Primer

react_feed_post_public Primer
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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrača: APIEmptyResponse

Primer

Primer update_feed_post
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
postIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrača: CreateFeedPostResponse

Primer

Primer 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
isFlaggedbooleanqueryDa
ssostringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

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

get_gif_large Internal Link


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
largeInternalURLSanitizedstringqueryDa

Odgovor

Vrne: GifGetLargeResponse

Primer

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

get_gifs_search Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
searchstringqueryDa
localestringqueryNe
ratingstringqueryNe
pagenumberqueryNe

Odgovor

Vrne: GetGifsSearchResponse

Primer

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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
localestringqueryNe
ratingstringqueryNe
pagenumberqueryNe

Odgovor

Vrne: GetGifsTrendingResponse

Primer

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

add_hash_tag Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa

Odgovor

Vrne: CreateHashTagResponse

Primer

add_hash_tag Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavi overjanje
5FastCommentsClient.configure do |config|
6 # Nastavi overjanje z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Niz |
14create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
15
16begin
17
18 result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_hash_tag: #{e}"
22end
23

add_hash_tags_bulk Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa

Odgovor

Vrne: BulkCreateHashTagsResponse

Primer

add_hash_tags_bulk Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavi avtorizacijo
5FastCommentsClient.configure do |config|
6 # Nastavi avtorizacijo API ključa: 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 |
14bulk_create_hash_tags_body = FastCommentsClient::BulkCreateHashTagsBody.new({tags: [FastCommentsClient::BulkCreateHashTagsBodyTagsInner.new({tag: 'tag_example'})]}) # BulkCreateHashTagsBody |
15
16begin
17
18 result = api_instance.add_hash_tags_bulk(tenant_id, bulk_create_hash_tags_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->add_hash_tags_bulk: #{e}"
22end
23

delete_hash_tag Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringpoizvedbaDa
tagstringpotDa

Odgovor

Vrne: APIEmptyResponse

Primer

delete_hash_tag Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavi pooblastilo
5FastCommentsClient.configure do |config|
6 # Nastavi pooblastilo ključ API: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za ključ API, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14tag = 'tag_example' # String |
15delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody |
16
17begin
18
19 result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
23end
24

get_hash_tags Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
pagenumberqueryNe

Odgovor

Vrača: GetHashTagsResponse

Primer

Primer get_hash_tags
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeVrstaLokacijaPotrebnoOpis
tenantIdstringqueryDa
tagstringpathDa

Odziv

Returns: UpdateHashTagResponse

Primer

patch_hash_tag Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Nastavi avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14tag = 'tag_example' # String |
15update_hash_tag_body = FastCommentsClient::UpdateHashTagBody.new # UpdateHashTagBody |
16
17begin
18
19 result = api_instance.patch_hash_tag(tenant_id, tag, update_hash_tag_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->patch_hash_tag: #{e}"
23end
24

delete_moderation_vote Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
voteIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: VoteDeleteResponse

Primer

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

get_api_comments Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
pagenumberqueryNe
countnumberqueryNe
text-searchstringqueryNe
byIPFromCommentstringqueryNe
filtersstringqueryNe
searchFiltersstringqueryNe
sortsstringqueryNe
demobooleanqueryNe
ssostringqueryNe

Odgovor

Vrne: ModerationAPIGetCommentsResponse

Primer

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

get_api_export_status Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
batchJobIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: ModerationExportStatusResponse

Primer

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

get_api_ids Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
afterIdstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Odgovor

Vrne: ModerationAPIGetCommentIdsResponse

Primer

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

get_ban_users_from_comment Internal Link

Parameters

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
ssostringqueryNe

Odgovor

Vrne: GetBannedUsersFromCommentResponse

Primer

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

get_comment_ban_status Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
ssostringqueryNo

Odgovor

Vrne: GetCommentBanStatusResponse

Primer

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

get_comment_children Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
commentIdstringpathDa
ssostringqueryNe

Odgovor

Vrne: ModerationAPIChildCommentsResponse

Primer

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

get_count Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filterstringqueryNo
searchFiltersstringqueryNo
demobooleanqueryNo
ssostringqueryNo

Odgovor

Vrne: ModerationAPICountCommentsResponse

Primer

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

get_counts Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: GetBannedUsersCountResponse

Primer

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

get_logs Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
ssostringqueryNe

Odgovor

Vrne: ModerationAPIGetLogsResponse

Primer

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

get_manual_badges Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringpoizvedbaDa
ssostringpoizvedbaNe

Odgovor

Vrne: GetTenantManualBadgesResponse

Primer

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

get_manual_badges_for_user Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
badgesUserIdstringqueryNo
commentIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: GetUserManualBadgesResponse

Primer

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

get_moderation_comment Internal Link

Parameters

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
includeEmailbooleanqueryNo
includeIPbooleanqueryNo
ssostringqueryNo

Response

Vrne: ModerationAPICommentResponse

Primer

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

get_moderation_comment_text Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
ssostringqueryNe

Odgovor

Vrne: GetCommentTextResponse

Primer

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

get_pre_ban_summary Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Odgovor

Vrne: PreBanSummary

Primer

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

get_search_comments_summary Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
valuestringqueryNe
filtersstringqueryNe
searchFiltersstringqueryNe
ssostringqueryNe

Odgovor

Vrne: ModerationCommentSearchResponse

Primer

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

get_search_pages Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
valuestringqueryNe
ssostringqueryNe

Odgovor

Vrne: ModerationPageSearchResponse

Primer

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

get_search_sites Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
valuestringqueryNo
ssostringqueryNo

Odziv

Vrne: ModerationSiteSearchResponse

Primer

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

get_search_suggest Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
text-searchstringqueryNe
ssostringqueryNe

Odgovor

Vrne: ModerationSuggestResponse

Primer

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

get_search_users Internal Link

Parametri

ImeTipMestoObveznoOpis
tenantIdstringqueryDa
valuestringqueryNe
ssostringqueryNe

Odgovor

Vrne: ModerationUserSearchResponse

Primer

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

get_trust_factor Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
userIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: GetUserTrustFactorResponse

Primer

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

get_user_ban_preference Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
ssostringqueryNo

Odgovor

Vrne: APIModerateGetUserBanPreferencesResponse

Primer

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

get_user_internal_profile Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: GetUserInternalProfileResponse

Primer

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

post_adjust_comment_votes Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: AdjustVotesResponse

Primer

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

post_api_export Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
text-searchstringqueryNo
byIPFromCommentstringqueryNo
filtersstringqueryNo
searchFiltersstringqueryNo
sortsstringqueryNo
ssostringqueryNo

Odgovor

Vrne: ModerationExportResponse

Primer

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

post_ban_user_from_comment Internal Link

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
commentIdstringpathDa
banEmailbooleanqueryNe
banEmailDomainbooleanqueryNe
banIPbooleanqueryNe
deleteAllUsersCommentsbooleanqueryNe
bannedUntilstringqueryNe
isShadowBanbooleanqueryNe
updateIdstringqueryNe
banReasonstringqueryNe
ssostringqueryNe

Odgovor

Vrne: BanUserFromCommentResult

Primer

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

post_ban_user_undo Internal Link


Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

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

post_bulk_pre_ban_summary Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
includeByUserIdAndEmailbooleanqueryNo
includeByIPbooleanqueryNo
includeByEmailDomainbooleanqueryNo
ssostringqueryNo

Odgovor

Vrne: BulkPreBanSummary

Primer

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

post_comments_by_ids Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: ModerationAPIChildCommentsResponse

Primer

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

post_flag_comment Internal Link

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
commentIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Response

Vrne: APIEmptyResponse

Example

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

post_remove_comment Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: PostRemoveCommentApiResponse

Primer

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

post_restore_deleted_comment Internal Link

Parameters

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
broadcastIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: APIEmptyResponse

Primer

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

post_set_comment_approval_status Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
approvedbooleanqueryNe
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: SetCommentApprovedResponse

Primer

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

post_set_comment_review_status Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
reviewedbooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: APIEmptyResponse

Primer

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

post_set_comment_spam_status Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
commentIdstringpathYes
spambooleanqueryNo
permNotSpambooleanqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Odgovor

Returns: APIEmptyResponse

Primer

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

post_set_comment_text Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: SetCommentTextResponse

Primer

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

post_un_flag_comment Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringpathDa
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

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

post_vote Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
commentIdstringpathYes
directionstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Odziv

Vrne: VoteResponse

Primer

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

put_award_badge Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryDa
badgeIdstringqueryDa
userIdstringqueryNe
commentIdstringqueryNe
broadcastIdstringqueryNe
ssostringqueryNe

Odgovor

Vrne: AwardUserBadgeResponse

Primer

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

put_close_thread Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
urlIdstringqueryYes
ssostringqueryNo

Odgovor

Vrne: APIEmptyResponse

Primer

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

put_remove_badge Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
badgeIdstringqueryYes
userIdstringqueryNo
commentIdstringqueryNo
broadcastIdstringqueryNo
ssostringqueryNo

Odgovor

Vrne: RemoveUserBadgeResponse

Primer

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

put_reopen_thread Internal Link

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
urlIdstringqueryDa
ssostringqueryNe

Odgovor

Returns: APIEmptyResponse

Primer

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

set_trust_factor Internal Link

Parametri

ImeVrstaLokacijaObveznoOpis
tenantIdstringqueryYes
userIdstringqueryNo
trustFactorstringqueryNo
ssostringqueryNo

Odgovor

Vrne: SetUserTrustFactorResponse

Primer

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

create_moderator Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Odgovor

Vrne: CreateModeratorResponse

Primer

Primer create_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa
sendEmailstringqueryNe

Odziv

Vrne: APIEmptyResponse

Primer

delete_moderator Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: GetModeratorResponse

Primer

Primer get_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
skipnumberqueryNe

Odgovor

Vrne: GetModeratorsResponse

Primer

Primer get_moderators
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
fromNamestringqueryDa

Odziv

Vrne: APIEmptyResponse

Primer

Primer send_invite
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15from_name = 'from_name_example' # String |
16
17begin
18
19 result = api_instance.send_invite(tenant_id, id, from_name)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->send_invite: #{e}"
23end
24

update_moderator Internal Link


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

Primer update_moderator
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

delete_notification_count Example
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte spodnjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: GetCachedNotificationCountResponse

Primer

Primer get_cached_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
userIdstringqueryNe
urlIdstringqueryNe
fromCommentIdstringqueryNe
viewedbooleanqueryNe
typestringqueryNe

Odgovor

Vrača: GetNotificationCountResponse

Primer

Primer get_notification_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
userIdstringqueryNe
urlIdstringqueryNe
fromCommentIdstringqueryNe
viewedbooleanqueryNe
typestringqueryNe
skipnumberqueryNe

Odgovor

Vrne: GetNotificationsResponse

Primer

Primer get_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguracija avtorizacije API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone API ključa, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

Primer update_notification
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_notification_body = FastCommentsClient::UpdateNotificationBody.new # UpdateNotificationBody |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_notification(tenant_id, id, update_notification_body, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_notification: #{e}"
26end
27

create_v1_page_react Internal Link


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
urlIdstringqueryDa
titlestringqueryNe

Odgovor

Vrne: CreateV1PageReact

Primer

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

create_v2_page_react Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
urlIdstringqueryDa
idstringqueryDa
titlestringqueryNe

Odgovor

Vrača: CreateV1PageReact

Primer

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

delete_v1_page_react Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
urlIdstringqueryDa

Odgovor

Vrne: CreateV1PageReact

Primer

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

delete_v2_page_react Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
urlIdstringqueryDa
idstringqueryDa

Odziv

Vrne: CreateV1PageReact

Primer

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

get_v1_page_likes Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
urlIdstringqueryDa

Odgovor

Vrne: GetV1PageLikes

Primer

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

get_v2_page_react_users Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
urlIdstringqueryDa
idstringqueryDa

Odgovor

Vrne: GetV2PageReactUsersResponse

Primer

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

get_v2_page_reacts Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
urlIdstringqueryDa

Odgovor

Vrne: GetV2PageReacts

Primer

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

add_page Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa

Odgovor

Vrača: AddPageAPIResponse

Primer

add_page Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odziv

Vrne: DeletePageAPIResponse

Primer

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

get_offline_users Internal Link

Prejšnji komentatorji na strani, ki trenutno NISO na spletu. Razvrščeni po displayName. Uporabite to po izčrpanju /users/online za izris razdelka 'Člani'. Straničenje z kazalom na commenterName: strežnik prehodi delni {tenantId, urlId, commenterName} indeks od afterName naprej z uporabo $gt, brez stroška $skip.

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathYes
urlIdstringqueryYesIdentifikator URL strani (očiščen na strežniški strani).
afterNamestringqueryNoKazalec: pošljite nextAfterName iz prejšnjega odgovora.
afterUserIdstringqueryNoVeznik za izenačitve kazala: pošljite nextAfterUserId iz prejšnjega odgovora. Zahtevan, kadar je afterName nastavljen, da vnosi z enakimi imeni ne bodo izpuščeni.

Odgovor

Vrne: PageUsersOfflineResponse

Primer

Primer get_offline_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String | Identifikator URL strani (očiščen na strežniški strani).
8opts = {
9 after_name: 'after_name_example', # String | Kazalec: pošljite nextAfterName iz prejšnjega odgovora.
10 after_user_id: 'after_user_id_example' # String | Veznik za izenačitve kazala: pošljite nextAfterUserId iz prejšnjega odgovora. Zahtevan, kadar je afterName nastavljen, da vnosi z enakimi imeni ne bodo izpuščeni.
11}
12
13begin
14
15 result = api_instance.get_offline_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_offline_users: #{e}"
19end
20

get_online_users Internal Link

Trenutno prisotni gledalci strani: osebe, katerih websocket seja je trenutno naročena na to stran. Vrača anonCount + totalCount (naročniki v celotni sobi, vključno z anonimnimi gledalci, ki jih ne navajamo).

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathDa
urlIdstringqueryDaPage URL identifier (očisten na strežniški strani).
afterNamestringqueryNeKazalec: pošljite nextAfterName iz prejšnjega odgovora.
afterUserIdstringqueryNeKazalec za razrešitev izenačitev: pošljite nextAfterUserId iz prejšnjega odgovora. Zahtevano, ko je afterName nastavljeno, da se vnosi ob izenačenju imen ne izgubijo.

Response

Vrača: PageUsersOnlineResponse

Primer

get_online_users Primer
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 | Identifikator URL strani (očisten na strežniški strani).
8opts = {
9 after_name: 'after_name_example', # String | Kazalec: pošljite nextAfterName iz prejšnjega odgovora.
10 after_user_id: 'after_user_id_example' # String | Kazalec za razrešitev izenačitev: pošljite nextAfterUserId iz prejšnjega odgovora. Zahtevano, ko je afterName nastavljeno, da se vnosi ob izenačenju imen ne izgubijo.
11}
12
13begin
14
15 result = api_instance.get_online_users(tenant_id, url_id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->get_online_users: #{e}"
19end
20

get_page_by_urlid Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
urlIdstringqueryDa

Odgovor

Vrne: GetPageByURLIdAPIResponse

Primer

get_page_by_urlid Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa

Odgovor

Vrne: GetPagesAPIResponse

Primer

get_pages Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte spodnjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14
15begin
16
17 result = api_instance.get_pages(tenant_id)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling DefaultApi->get_pages: #{e}"
21end
22

get_pages_public Internal Link

Prikaže seznam strani za najemnika. Uporablja ga namizni odjemalec FChat za pripravo seznama sob. Zahteva, da je enableFChat nastavljen na true v razrešeni prilagojeni konfiguraciji za vsako stran. Strani, ki zahtevajo SSO, so filtrirane glede na skupinski dostop uporabnika, ki pošilja zahtevo.

Parameters

NameTypeLocationRequiredDescription
tenantIdstringpathYes
cursorstringqueryNoOpak kazalec paginacije, vrnjen kot nextCursor iz predhodne zahteve. Povezan z istim sortBy.
limitintegerqueryNo1..200, privzeto 50
qstringqueryNoNeobvezno filtiranje po začetku naslova, brez razlikovanja med velikimi in malimi črkami.
sortBystringqueryNoVrstni red sortiranja. updatedAt (privzeto, najnovejše prve), commentCount (največ komentarjev prve), ali title (po abecedi).
hasCommentsbooleanqueryNoČe je true, vrni samo strani z vsaj enim komentarjem.

Response

Vrača: GetPublicPagesResponse

Example

Primer get_pages_public
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 cursor: 'cursor_example', # String | Opak kazalec paginacije, vrnjen kot `nextCursor` iz predhodne zahteve. Povezan z istim `sortBy`.
9 limit: 56, # Integer | 1..200, privzeto 50
10 q: 'q_example', # String | Neobvezno filtiranje po začetku naslova, brez razlikovanja med velikimi in malimi črkami.
11 sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Vrstni red sortiranja. `updatedAt` (privzeto, najnovejše prve), `commentCount` (največ komentarjev prve), ali `title` (po abecedi).
12 has_comments: true # Boolean | Če je true, vrni samo strani z vsaj enim komentarjem.
13}
14
15begin
16
17 result = api_instance.get_pages_public(tenant_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling PublicApi->get_pages_public: #{e}"
21end
22

get_users_info Internal Link

Informacije o več uporabnikih za najemnika. Ob danih userIds vrne prikazne informacije iz User / SSOUser. Uporablja se v pripomočku za komentarje za obogatitev uporabnikov, ki so se pravkar pojavili prek dogodka prisotnosti. Brez konteksta strani: zasebnost se uveljavlja enotno (zasebni profili so skriti).

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathYes
idsstringqueryYesVejicami ločeni userIds.

Odgovor

Vrača: PageUsersInfoResponse

Primer

Primer get_users_info
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7ids = 'ids_example' # String | Vejicami ločeni userIds.
8
9begin
10
11 result = api_instance.get_users_info(tenant_id, ids)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_users_info: #{e}"
15end
16

patch_page Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Odgovor

Vrne: PatchPageAPIResponse

Primer

Primer patch_page
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrača: APIEmptyResponse

Primer

delete_pending_webhook_event Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15
16begin
17
18 result = api_instance.delete_pending_webhook_event(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_pending_webhook_event: #{e}"
22end
23

get_pending_webhook_event_count Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringqueryNe
externalIdstringqueryNe
eventTypestringqueryNe
typestringqueryNe
domainstringqueryNe
attemptCountGTnumberqueryNe

Odgovor

Vrne: GetPendingWebhookEventCountResponse

Primer

Primer get_pending_webhook_event_count
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
commentIdstringqueryNe
externalIdstringqueryNe
eventTypestringqueryNe
typestringqueryNe
domainstringqueryNe
attemptCountGTnumberqueryNe
skipnumberqueryNe

Odgovor

Vrne: GetPendingWebhookEventsResponse

Primer

Primer get_pending_webhook_events
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringpoizvedbaDa

Odgovor

Vrne: CreateQuestionConfigResponse

Primer

Primer create_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

Primer delete_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite prefiks za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odziv

Vrne: GetQuestionConfigResponse

Primer

Primer get_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
skipnumberqueryNe

Odgovor

Vrne: GetQuestionConfigsResponse

Primer

Primer get_question_configs
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

Primer update_question_config
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Odgovor

Vrne: CreateQuestionResultResponse

Primer

Primer create_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

delete_question_result Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: GetQuestionResultResponse

Primer

Primer get_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# setup authorization
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
urlIdstringqueryNe
userIdstringqueryNe
startDatestringqueryNe
questionIdstringqueryNe
questionIdsstringqueryNe
skipnumberqueryNe

Odgovor

Vrne: GetQuestionResultsResponse

Primer

Primer get_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguracija avtorizacije z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

Primer update_question_result
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
questionIdstringqueryNe
questionIdsarrayqueryNe
urlIdstringqueryNe
timeBucketstringqueryNe
startDatestringqueryNe
forceRecalculatebooleanqueryNe

Odgovor

Vrne: AggregateQuestionResultsResponse

Primer

aggregate_question_results Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
forceRecalculatebooleanqueryNe

Odgovor

Vrne: BulkAggregateQuestionResultsResponse

Primer

Primer bulk_aggregate_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
questionIdstringqueryNo
questionIdsarrayqueryNo
urlIdstringqueryNo
startDatestringqueryNo
forceRecalculatebooleanqueryNo
minValuenumberqueryNo
maxValuenumberqueryNo
limitnumberqueryNo

Odgovor

Vrača: CombineQuestionResultsWithCommentsResponse

Primer

Primer za combine_comments_with_question_results
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriranje avtorizacije z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Če odstranite komentar spodnje vrstice, lahko nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa

Odgovor

Vrne: AddSSOUserAPIResponse

Primer

Primer add_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa
deleteCommentsbooleanqueryNe
commentDeleteModestringqueryNe

Odgovor

Vrne: DeleteSSOUserAPIResponse

Primer

Primer delete_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 delete_comments: true, # Boolean |
17 comment_delete_mode: 'comment_delete_mode_example' # String |
18}
19
20begin
21
22 result = api_instance.delete_sso_user(tenant_id, id, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->delete_sso_user: #{e}"
26end
27

get_sso_user_by_email Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
emailstringpathDa

Odgovor

Vrne: GetSSOUserByEmailAPIResponse

Primer

Primer get_sso_user_by_email
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrača: GetSSOUserByIdAPIResponse

Primer

Primer get_sso_user_by_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
skipintegerqueryNe

Odgovor

Vrača: GetSSOUsersResponse

Primer

get_sso_users Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
updateCommentsbooleanqueryNe

Response

Vrne: PatchSSOUserAPIResponse

Primer

patch_sso_user Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
updateCommentsbooleanqueryNe

Odgovor

Vrne: PutSSOUserAPIResponse

Primer

Primer put_sso_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa

Odziv

Vrne: CreateSubscriptionAPIResponse

Primer

create_subscription Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe

Odgovor

Vrne: DeleteSubscriptionAPIResponse

Primer

delete_subscription Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
userIdstringqueryNe

Odgovor

Vrne: GetSubscriptionsAPIResponse

Primer

Primer get_subscriptions
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavi avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example' # String |
16}
17
18begin
19
20 result = api_instance.get_subscriptions(tenant_id, opts)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->get_subscriptions: #{e}"
24end
25

update_subscription Internal Link

Parametri

NameTypeLocationObveznoOpis
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe

Odgovor

Vrača: UpdateSubscriptionAPIResponse

Primer

Primer update_subscription
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_api_user_subscription_data = FastCommentsClient::UpdateAPIUserSubscriptionData.new # UpdateAPIUserSubscriptionData |
16opts = {
17 user_id: 'user_id_example' # String |
18}
19
20begin
21
22 result = api_instance.update_subscription(tenant_id, id, update_api_user_subscription_data, opts)
23 p result
24rescue FastCommentsClient::ApiError => e
25 puts "Error when calling DefaultApi->update_subscription: #{e}"
26end
27

get_tenant_daily_usages Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
yearNumbernumberqueryNe
monthNumbernumberqueryNe
dayNumbernumberqueryNe
skipnumberqueryNe

Odgovor

Vrača: GetTenantDailyUsagesResponse

Primer

Primer get_tenant_daily_usages
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parameters

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Response

Vrne: CreateTenantPackageResponse

Primer

Primer create_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

delete_tenant_package Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: GetTenantPackageResponse

Primer

Primer get_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
skipnumberqueryNe

Odgovor

Vrne: GetTenantPackagesResponse

Primer

get_tenant_packages Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrača: APIEmptyResponse

Primer

Primer replace_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptyResponse

Primer

Primer update_tenant_package
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo za API ključ: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa

Odgovor

Vrne: CreateTenantUserResponse

Primer

Primer create_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
deleteCommentsstringqueryNe
commentDeleteModestringqueryNe

Odgovor

Vrača: APIEmptyResponse

Primer

delete_tenant_user Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico za nastavitev predpone za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: GetTenantUserResponse

Primer

Primer get_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
skipnumberqueryNe

Odgovor

Vrača: GetTenantUsersResponse

Primer

Primer get_tenant_users
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
updateCommentsstringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

Primer replace_tenant_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
redirectURLstringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

Primer uporabe send_login_link
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa
updateCommentsstringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

update_tenant_user Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto: 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Odgovor

Vrača: CreateTenantResponse

Primer

create_tenant Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
surestringqueryNe

Odgovor

Vrne: APIEmptyResponse

Primer

delete_tenant Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrača: GetTenantResponse

Primer

Primer get_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfiguriraj avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLokacijaZahtevanoOpis
tenantIdstringqueryDa
metastringqueryNe
skipnumberqueryNe

Odgovor

Vrne: GetTenantsResponse

Primer

get_tenants Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# Nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryYes
idstringpathYes

Odgovor

Vrača: APIEmptyResponse

Primer

Primer update_tenant
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte spodnjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15update_tenant_body = FastCommentsClient::UpdateTenantBody.new # UpdateTenantBody |
16
17begin
18
19 result = api_instance.update_tenant(tenant_id, id, update_tenant_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->update_tenant: #{e}"
23end
24

change_ticket_state Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
userIdstringqueryDa
idstringpathDa

Odgovor

Vrne: ChangeTicketStateResponse

Primer

Primer change_ticket_state
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavite avtorizacijo
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte spodnjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15id = 'id_example' # String |
16change_ticket_state_body = FastCommentsClient::ChangeTicketStateBody.new({state: 37}) # ChangeTicketStateBody |
17
18begin
19
20 result = api_instance.change_ticket_state(tenant_id, user_id, id, change_ticket_state_body)
21 p result
22rescue FastCommentsClient::ApiError => e
23 puts "Error when calling DefaultApi->change_ticket_state: #{e}"
24end
25

create_ticket Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
userIdstringqueryDa

Odgovor

Vrne: CreateTicketResponse

Primer

Primer create_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14user_id = 'user_id_example' # String |
15create_ticket_body = FastCommentsClient::CreateTicketBody.new({subject: 'subject_example'}) # CreateTicketBody |
16
17begin
18
19 result = api_instance.create_ticket(tenant_id, user_id, create_ticket_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->create_ticket: #{e}"
23end
24

get_ticket Internal Link

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
idstringpathDa
userIdstringqueryNe

Odgovor

Vrača: GetTicketResponse

Primer

Primer get_ticket
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte spodnjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 user_id: 'user_id_example' # String |
17}
18
19begin
20
21 result = api_instance.get_ticket(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_ticket: #{e}"
25end
26

get_tickets Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
userIdstringqueryNe
statenumberqueryNe
skipnumberqueryNe
limitnumberqueryNe

Odziv

Vrne: GetTicketsResponse

Primer

get_tickets Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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', # Niz |
16 state: 1.2, # Plavajoče število |
17 skip: 1.2, # Plavajoče število |
18 limit: 1.2 # Plavajoče število |
19}
20
21begin
22
23 result = api_instance.get_tickets(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tickets: #{e}"
27end
28

get_translations Internal Link

Parametri

ImeTipLokacijaZahtevanoOpis
namespacestringpathDa
componentstringpathDa
localestringqueryNe
useFullTranslationIdsbooleanqueryNe

Odgovor

Vrne: GetTranslationsResponse

Primer

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

upload_image Internal Link

Naloži in spremeni velikost slike

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringpathDa
sizePresetstringqueryNePrednastavitev velikosti: "Default" (1000x1000px) ali "CrossPlatform" (ustvari velikosti za priljubljene naprave)
urlIdstringqueryNeID strani, iz katere poteka nalaganje, za konfiguracijo

Odgovor

Vrača: UploadImageResponse

Primer

Primer 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 | Prednastavitev velikosti: \"Default\" (1000x1000px) ali \"CrossPlatform\" (ustvari velikosti za priljubljene naprave)
10 url_id: 'url_id_example' # String | ID strani, iz katere poteka nalaganje, za konfiguracijo
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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIGetUserBadgeProgressResponse

Primer

get_user_badge_progress_by_id Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
userIdstringpathDa

Odgovor

Vrne: APIGetUserBadgeProgressResponse

Primer

Primer get_user_badge_progress_by_user_id
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
userIdstringqueryNe
limitnumberqueryNe
skipnumberqueryNe

Odziv

Vrne: APIGetUserBadgeProgressListResponse

Primer

Primer get_user_badge_progress_list
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 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


Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa

Odgovor

Vrne: APICreateUserBadgeResponse

Primer

Primer create_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptySuccessResponse

Primer

Primer delete_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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


Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIGetUserBadgeResponse

Primer

Primer get_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Niz |
14id = 'id_example' # Niz |
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

Parametri

ImeTipLokacijaZahtevanoOpis
tenantIdstringqueryDa
userIdstringqueryNe
badgeIdstringqueryNe
typenumberqueryNe
displayedOnCommentsbooleanqueryNe
limitnumberqueryNe
skipnumberqueryNe

Odgovor

Vrne: APIGetUserBadgesResponse

Primer

get_user_badges Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
idstringpathDa

Odgovor

Vrne: APIEmptySuccessResponse

Primer

Primer update_user_badge
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: GetUserNotificationCountResponse

Primer

Primer 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

Parametri

NameTipLokacijaObveznoOpis
tenantIdstringqueryDa
urlIdstringqueryNeUporablja se za določitev, ali je trenutna stran naročena.
pageSizeintegerqueryNe
afterIdstringqueryNe
includeContextbooleanqueryNe
afterCreatedAtintegerqueryNe
unreadOnlybooleanqueryNe
dmOnlybooleanqueryNe
noDmbooleanqueryNe
includeTranslationsbooleanqueryNe
includeTenantNotificationsbooleanqueryNe
ssostringqueryNe

Odgovor

Vrne: GetMyNotificationsResponse

Primer

Primer get_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 url_id: 'url_id_example', # String | Uporablja se za določitev, ali je trenutna stran naročena.
9 page_size: 56, # Integer |
10 after_id: 'after_id_example', # String |
11 include_context: true, # Boolean |
12 after_created_at: 789, # Integer |
13 unread_only: true, # Boolean |
14 dm_only: true, # Boolean |
15 no_dm: true, # Boolean |
16 include_translations: true, # Boolean |
17 include_tenant_notifications: true, # Boolean |
18 sso: 'sso_example' # String |
19}
20
21begin
22
23 result = api_instance.get_user_notifications(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling PublicApi->get_user_notifications: #{e}"
27end
28

reset_user_notification_count Internal Link


Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
ssostringqueryNe

Odgovor

Vrača: ResetUserNotificationsResponse

Primer

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

reset_user_notifications Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
afterIdstringqueryNe
afterCreatedAtintegerqueryNe
unreadOnlybooleanqueryNe
dmOnlybooleanqueryNe
noDmbooleanqueryNe
ssostringqueryNe

Odgovor

Vrne: ResetUserNotificationsResponse

Primer

Primer reset_user_notifications
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # Niz |
7opts = {
8 after_id: 'after_id_example', # Niz |
9 after_created_at: 789, # Celo število |
10 unread_only: true, # Logična vrednost |
11 dm_only: true, # Logična vrednost |
12 no_dm: true, # Logična vrednost |
13 sso: 'sso_example' # Niz |
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

Omogoči ali onemogoči obvestila za določen komentar.

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
notificationIdstringpathDa
optedInOrOutstringpathDa
commentIdstringqueryDa
ssostringqueryNe

Odgovor

Vrne: UpdateUserNotificationCommentSubscriptionStatusResponse

Primer

update_user_notification_comment_subscription_status Primer
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


Omogočite ali onemogočite obvestila za stran. Ko so uporabniki naročeni na stran, se ustvarijo obvestila za nove korenske komentarje, in tudi

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
urlIdstringqueryDa
urlstringqueryDa
pageTitlestringqueryDa
subscribedOrUnsubscribedstringpathDa
ssostringqueryNe

Odgovor

Vrača: UpdateUserNotificationPageSubscriptionStatusResponse

Primer

Primer 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
notificationIdstringpathDa
newStatusstringpathDa
ssostringqueryNe

Odgovor

Vrne: UpdateUserNotificationStatusResponse

Primer

Primer 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
urlIdWSstringqueryDa
userIdsstringqueryDa

Odgovor

Vrne: GetUserPresenceStatusesResponse

Primer

Primer 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 "Napaka pri klicu PublicApi->get_user_presence_statuses: #{e}"
16end
17

search_users Internal Link

Parametri

NameTypeLocationRequiredDescription
tenantIdstringpathDa
urlIdstringqueryDa
usernameStartsWithstringqueryNe
mentionGroupIdsarrayqueryNe
ssostringqueryNe
searchSectionstringqueryNe

Odgovor

Vrne: SearchUsersResult

Primer

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

get_user Internal Link

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryYes
idstringpathYes

Odgovor

Vrne: GetUserResponse

Primer

get_user Primer
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
commentIdstringqueryDa
directionstringqueryDa
userIdstringqueryNe
anonUserIdstringqueryNe

Odgovor

Vrne: VoteResponse

Primer

Primer create_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
idstringpathDa
editKeystringqueryNe

Odgovor

Vrne: VoteDeleteResponse

Primer

Primer delete_vote
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo z API ključem: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

NameTypeLocationRequiredDescription
tenantIdstringqueryDa
urlIdstringqueryDa

Odgovor

Vrne: GetVotesResponse

Primer

Primer get_votes
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Parametri

ImeTipLokacijaObveznoOpis
tenantIdstringqueryDa
urlIdstringqueryDa
userIdstringqueryNe
anonUserIdstringqueryNe

Odgovor

Vrne: GetVotesForUserResponse

Primer

Primer get_votes_for_user
Copy Copy
1
2require 'time'
3require 'fastcomments-client'
4# nastavitev avtorizacije
5FastCommentsClient.configure do |config|
6 # Konfigurirajte avtorizacijo API ključa: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Odkomentirajte naslednjo vrstico, da nastavite predpono za API ključ, npr. 'Bearer' (privzeto 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

Potrebujete pomoč?

Če naletite na kakršne koli težave ali imate vprašanja glede Ruby SDK, prosimo:

Prispevanje

Prispevki so dobrodošli! Prosimo, obiščite GitHub repozitorij za smernice o prispevkih.