FastComments Ruby SDK
Dette er den officielle Ruby SDK for FastComments.
Officiel Ruby SDK til FastComments API'en
Repository
AI-kodningsagenter 
Giv din kodeagent den FastComments‑kontekst, den har brug for – widgets, konfiguration, Secure SSO, REST‑API’en og SDK‑erne:
npx skills add fastcomments/skillsFungerer med Claude Code, Codex, Cursor, Copilot, Gemini og enhver anden agent, som skills CLI understøtter.
Installation
Add this line to your application's Gemfile:
gem 'fastcomments'And then execute:
bundle installOr install it yourself as:
gem install fastcommentsBiblioteksindhold
Dette bibliotek indeholder den genererede API‑klient og SSO‑værktøjerne, der gør arbejdet med API’en lettere.
Offentlige vs sikrede API’er
For API‑klienten findes der tre klasser, DefaultApi, PublicApi og ModerationApi. DefaultApi indeholder metoder, der kræver din API‑nøgle, og PublicApi indeholder API‑kald, der kan foretages direkte fra en browser/mobil enhed osv. uden autentifikation. ModerationApi indeholder metoderne, der driver moderator‑dashboardet.
ModerationApi leverer en omfattende suite af live‑ og hurtige moderations‑API’er. Hver ModerationApi‑metode accepterer en sso‑parameter og kan autentificere via SSO eller en FastComments.com‑session‑cookie.
Hurtig start
Brugen af godkendte API'er (DefaultApi)
Vigtigt: Du skal sætte din API-nøgle på ApiClient, før du laver godkendte anmodninger. Hvis du ikke gør det, vil anmodninger mislykkes med en 401-fejl.
require 'fastcomments'
# Create and configure the API client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# REQUIRED: Set your API key (get this from your FastComments dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Create the API instance with the configured client
api = FastCommentsClient::DefaultApi.new(api_client)
# Now you can make authenticated API calls
begin
# Example: Add an SSO user
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Common errors:
# - 401: API key is missing or invalid
# - 400: Request validation failed
endBrugen af offentlige API'er (PublicApi)
Offentlige slutpunkter kræver ikke godkendelse:
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
endBrugen af moderations-API'er (ModerationApi)
Moderationsmetoderne driver moderator‑dashboardet. Overgiv en sso‑token, så anmodningen foretages på vegne af en SSO-godkendt moderator:
require 'fastcomments'
moderation_api = FastCommentsClient::ModerationApi.new
begin
# Example: List comments in the moderation queue
response = moderation_api.get_api_comments(
sso: 'YOUR_MODERATOR_SSO_TOKEN'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
endAlmindelige problemer
- 401 "missing-api-key" fejl: Sørg for, at du sætter
config.api_key['x-api-key'] = 'YOUR_KEY'før du opretter DefaultApi‑instansen. - Forkert API‑klasse: Brug
DefaultApitil server‑side godkendte anmodninger,PublicApitil klient‑side/offentlige anmodninger, ogModerationApitil anmodninger fra moderator‑dashboardet. - Null API‑nøgle: SDK'en vil stille og roligt springe godkendelse over, hvis API‑nøglen er null, hvilket medfører 401‑fejl.
Noter
Broadcast-id'er
Du vil se, at du skal sende et broadcastId i nogle API-opkald. Når du modtager hændelser, får du dette ID tilbage, så du ved, at du skal ignorere hændelsen, hvis du har tænkt dig at anvende ændringer optimistisk på klienten
(hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være tilstrækkeligt unikt til ikke at forekomme to gange i en browsersession.
SSO (Single Sign-On)
For SSO-eksempler, se nedenfor.
SSO-brug
Simpel SSO
require 'fastcomments'
# Create Simple SSO token
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}"
# Use the SSO token to make an authenticated API call
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}"Sikker SSO
require 'fastcomments'
# Create Secure SSO token
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}"
# Use the SSO token to make an authenticated API call
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}"Aggregat
Aggregerer dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nej | |
| includeStats | boolean | query | Nej |
Svar
Returnerer: AggregateResponse
Eksempel
aggregate Eksempel
Copy 
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent revisionslog
Parametre
| Name | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nej | |
| skip | number | query | Nej | |
| order | string | query | Nej | |
| after | number | query | Nej | |
| before | number | query | Nej |
Svar
Returnerer: GetAuditLogsResponse
Eksempel
get_audit_logs Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Log ud (offentlig)
Svar
Returnerer: APIEmptyResponse
Eksempel
logout_public Eksempel
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
Blokér fra kommentar (offentlig)
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: BlockSuccess
Eksempel
block_from_comment_public Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8public_block_from_comment_params = FastCommentsClient::PublicBlockFromCommentParams.new({comment_ids: ['comment_ids_example']}) # PublicBlockFromCommentParams |
9opts = {
10 sso: 'sso_example' # String |
11}
12
13begin
14
15 result = api_instance.block_from_comment_public(tenant_id, comment_id, public_block_from_comment_params, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->block_from_comment_public: #{e}"
19end
20
Fjern blokering af kommentar (offentlig)
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UnblockSuccess
Eksempel
un_block_comment_public Eksempel
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
Kontrollerede kommentarer for blokeret
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | En kommasepareret liste over kommentar-id'er. |
| sso | string | query | Nej |
Svar
Returnerer: CheckBlockedCommentsResponse
Eksempel
checked_comments_for_blocked Eksempel
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 | En kommasepareret liste over kommentar-id'er.
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
Blokér bruger fra kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: BlockSuccess
Eksempel
block_user_from_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret kommentar (offentlig)
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: SaveCommentsResponseWithPresence
Eksempel
create_comment_public Eksempel
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
Slet kommentar
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: DeleteCommentResult
Eksempel
delete_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet kommentar (offentlig)
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPIDeleteCommentResponse
Eksempel
delete_comment_public Eksempel
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
Slet kommentar stemme
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteDeleteResponse
Eksempel
delete_comment_vote Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8vote_id = 'vote_id_example' # String |
9url_id = 'url_id_example' # String |
10broadcast_id = 'broadcast_id_example' # String |
11opts = {
12 edit_key: 'edit_key_example', # String |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.delete_comment_vote(tenant_id, comment_id, vote_id, url_id, broadcast_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->delete_comment_vote: #{e}"
22end
23
Markér kommentar
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: FlagCommentResponse
Eksempel
flag_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetCommentResponse
Eksempel
get_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent kommentar tekst
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPIGetCommentTextResponse
Eksempel
get_comment_text Eksempel
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
Hent kommentar stemme brugernavne
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentVoteUserNamesSuccessResponse
Eksempel
Eksempel på get_comment_vote_user_names
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
Hent kommentarer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nej | |
| limit | integer | query | Nej | |
| skip | integer | query | Nej | |
| asTree | boolean | query | Nej | |
| skipChildren | integer | query | Nej | |
| limitChildren | integer | query | Nej | |
| maxTreeDepth | integer | query | Nej | |
| urlId | string | query | Nej | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej | |
| contextUserId | string | query | Nej | |
| hashTag | string | query | Nej | |
| parentId | string | query | Nej | |
| direction | string | query | Nej | |
| fromDate | integer | query | Nej | |
| toDate | integer | query | Nej |
Svar
Returnerer: APIGetCommentsResponse
Eksempel
get_comments Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet for følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent kommentarer (offentlig)
req tenantId urlId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| urlId | string | forespørgsel | Ja | |
| page | integer | forespørgsel | Nej | |
| direction | string | forespørgsel | Nej | |
| sso | string | forespørgsel | Nej | |
| skip | integer | forespørgsel | Nej | |
| skipChildren | integer | forespørgsel | Nej | |
| limit | integer | forespørgsel | Nej | |
| limitChildren | integer | forespørgsel | Nej | |
| countChildren | boolean | forespørgsel | Nej | |
| fetchPageForCommentId | string | forespørgsel | Nej | |
| includeConfig | boolean | forespørgsel | Nej | |
| countAll | boolean | forespørgsel | Nej | |
| includei10n | boolean | forespørgsel | Nej | |
| locale | string | forespørgsel | Nej | |
| modules | string | forespørgsel | Nej | |
| isCrawler | boolean | forespørgsel | Nej | |
| includeNotificationCount | boolean | forespørgsel | Nej | |
| asTree | boolean | forespørgsel | Nej | |
| maxTreeDepth | integer | forespørgsel | Nej | |
| useFullTranslationIds | boolean | forespørgsel | Nej | |
| parentId | string | forespørgsel | Nej | |
| searchText | string | forespørgsel | Nej | |
| hashTags | array | forespørgsel | Nej | |
| userId | string | forespørgsel | Nej | |
| customConfigStr | string | forespørgsel | Nej | |
| afterCommentId | string | forespørgsel | Nej | |
| beforeCommentId | string | forespørgsel | Nej |
Svar
Returnerer: GetCommentsResponseWithPresencePublicComment
Eksempel
get_comments_public Eksempel
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
Lås kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på lock_comment
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
Fastgør kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel
pin_comment Eksempel
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
Gem kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Svar
Returnerer: APISaveCommentResponse
Eksempel
save_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. '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 |
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
Gem kommentarer bulk
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Respons
Returnerer: SaveCommentsBulkResponse
Eksempel
save_comments_bulk Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet foran følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Sæt kommentar tekst
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: PublicAPISetCommentTextResponse
Eksempel
set_comment_text Eksempel
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
Fjern blokering af bruger fra kommentar
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: UnblockSuccess
Eksempel
un_block_user_from_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Fjern markering af kommentar
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Respons
Returnerer: FlagCommentResponse
Eksempel
un_flag_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-autorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Fjern lås på kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
un_lock_comment Eksempel
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
Fjern fastgørelse af kommentar
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ChangeCommentPinStatusResponse
Eksempel
un_pin_comment Eksempel
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
Opdater kommentar
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_comment Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Stem kommentar
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: VoteResponse
Eksempel
vote_comment Eksempel
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
Hent kommentarer for bruger
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| userId | string | query | Nej | |
| direction | string | query | Nej | |
| repliesToUserId | string | query | Nej | |
| page | number | query | Nej | |
| includei10n | boolean | query | Nej | |
| locale | string | query | Nej | |
| isCrawler | boolean | query | Nej |
Svar
Returnerer: GetCommentsForUserResponse
Eksempel
get_comments_for_user Eksempel
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
Tilføj domænekonfiguration
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddDomainConfigResponse
Eksempel
add_domain_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra den følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet domænekonfiguration
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Svar
Returnerer: DeleteDomainConfigResponse
Eksempel
Eksempel på delete_domain_config
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # Streng |
14domain = 'domain_example' # Streng |
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
Hent domænekonfiguration
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Svar
Returnerer: GetDomainConfigResponse
Eksempel
get_domain_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent domænekonfigurationer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetDomainConfigsResponse
Eksempel
get_domain_configs Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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 domænekonfiguration
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Svar
Returnerer: PatchDomainConfigResponse
Eksempel
Eksempel på patch_domain_config
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Indsæt domænekonfiguration
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Svar
Returnerer: PutDomainConfigResponse
Eksempel
put_domain_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret email skabelon
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateEmailTemplateResponse
Eksempel
create_email_template Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API key-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet email skabelon
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_email_template Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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
Slet email skabelon render fejl
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_email_template_render_error Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent email skabelon
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetEmailTemplateResponse
Eksempel
get_email_template Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent email skabelon definitioner
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetEmailTemplateDefinitionsResponse
Eksempel
get_email_template_definitions Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent email skabelon render fejl
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplateRenderErrorsResponse
Eksempel
Eksempel på get_email_template_render_errors
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsætning af godkendelse
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14id = 'id_example' # String |
15opts = {
16 skip: 1.2 # Float |
17}
18
19begin
20
21 result = api_instance.get_email_template_render_errors(tenant_id, id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_email_template_render_errors: #{e}"
25end
26
Hent email skabeloner
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplatesResponse
Eksempel
get_email_templates Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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 skabelon
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nej |
Respons
Returnerer: RenderEmailTemplateResponse
Eksempel
render_email_template Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater email skabelon
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_email_template Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent hændelseslog
req tenantId urlId userIdWS
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel
get_event_log Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10opts = {
11 end_time: 789 # Integer |
12}
13
14begin
15
16 result = api_instance.get_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_event_log: #{e}"
20end
21
Hent global hændelseslog
req tenantId urlId userIdWS
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Nej |
Svar
Returnerer: GetEventLogResponse
Eksempel
get_global_event_log Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8user_id_ws = 'user_id_ws_example' # String |
9start_time = 789 # Integer |
10opts = {
11 end_time: 789 # Integer |
12}
13
14begin
15
16 result = api_instance.get_global_event_log(tenant_id, url_id, user_id_ws, start_time, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_global_event_log: #{e}"
20end
21
Opret feed indlæg
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nej | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| skipDupCheck | boolean | query | Nej |
Svar
Returnerer: CreateFeedPostsResponse
Eksempel
create_feed_post Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentar for følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret feed indlæg (offentlig)
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel
create_feed_post_public Eksempel
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
Slet feed indlæg (offentlig)
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: DeleteFeedPostPublicResponse
Eksempel
delete_feed_post_public Eksempel
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
Hent feed indlæg
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej |
Respons
Returnerer: GetFeedPostsResponse
Eksempel
get_feed_posts Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er nil)
8 # config.api_key_prefix['x-api-key'] = 'Bearer'
9end
10
11api_instance = FastCommentsClient::DefaultApi.new
12tenant_id = 'tenant_id_example' # String |
13opts = {
14 after_id: 'after_id_example', # String |
15 limit: 56, # Integer |
16 tags: ['inner_example'] # Array<String> |
17}
18
19begin
20
21 result = api_instance.get_feed_posts(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling DefaultApi->get_feed_posts: #{e}"
25end
26
Hent feed indlæg (offentlig)
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej | |
| sso | string | query | Nej | |
| isCrawler | boolean | query | Nej | |
| includeUserInfo | boolean | query | Nej |
Svar
Returnerer: PublicFeedPostsResponse
Eksempel
get_feed_posts_public Eksempel
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
Hent feed indlæg statistik
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: FeedPostsStatsResponse
Eksempel
get_feed_posts_stats Eksempel
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
Hent bruger reaktioner (offentlig)
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: UserReactsResponse
Eksempel
get_user_reacts_public Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 post_ids: ['inner_example'], # Array<String> |
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_user_reacts_public(tenant_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling PublicApi->get_user_reacts_public: #{e}"
18end
19
Reager feed indlæg (offentlig)
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ReactFeedPostResponse
Eksempel
react_feed_post_public Eksempel
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
Opdater feed indlæg
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_feed_post Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater feed indlæg (offentlig)
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostResponse
Eksempel
Eksempel på update_feed_post_public
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
Markér kommentar (offentlig)
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
flag_comment_public Eksempel
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
Hent gif stor
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| largeInternalURLSanitized | string | forespørgsel | Ja |
Svar
Returnerer: GifGetLargeResponse
Eksempel
get_gif_large Eksempel
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
Søg gif
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nej | |
| rating | string | query | Nej | |
| page | number | query | Nej |
Svar
Returnerer: GetGifsSearchResponse
Eksempel
get_gifs_search Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7search = 'search_example' # String |
8opts = {
9 locale: 'locale_example', # String |
10 rating: 'rating_example', # String |
11 page: 1.2 # Float |
12}
13
14begin
15
16 result = api_instance.get_gifs_search(tenant_id, search, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling PublicApi->get_gifs_search: #{e}"
20end
21
Hent trendende gif'er
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nej | |
| rating | string | query | Nej | |
| page | number | query | Nej |
Svar
Returnerer: GetGifsTrendingResponse
Eksempel
get_gifs_trending Eksempel
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
Tilføj hash tag
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateHashTagResponse
Eksempel
add_hash_tag Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren på følgende linje for at angive et præfiks til API-nøglen, f.eks. 'Bearer' (standard er nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14create_hash_tag_body = FastCommentsClient::CreateHashTagBody.new({tag: 'tag_example'}) # CreateHashTagBody |
15
16begin
17
18 result = api_instance.add_hash_tag(tenant_id, create_hash_tag_body)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Fejl ved kald af DefaultApi->add_hash_tag: #{e}"
22end
23
Tilføj hash tags bulk
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: BulkCreateHashTagsResponse
Eksempel
add_hash_tags_bulk Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentar fra følgende linje for at indstille et præfiks for API-nøglen, f.eks. '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
Slet hash tag
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_hash_tag Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle autorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (defaults to nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14tag = 'tag_example' # String |
15delete_hash_tag_request_body = FastCommentsClient::DeleteHashTagRequestBody.new # DeleteHashTagRequestBody |
16
17begin
18
19 result = api_instance.delete_hash_tag(tenant_id, tag, delete_hash_tag_request_body)
20 p result
21rescue FastCommentsClient::ApiError => e
22 puts "Error when calling DefaultApi->delete_hash_tag: #{e}"
23end
24
Hent hash tags
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej |
Svar
Returnerer: GetHashTagsResponse
Eksempel
get_hash_tags Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| tag | string | path | Ja |
Svar
Returnerer: UpdateHashTagResponse
Eksempel
patch_hash_tag Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle autorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet moderationsstemme
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteDeleteResponse
Eksempel
delete_moderation_vote Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # Streng |
7comment_id = 'comment_id_example' # Streng |
8vote_id = 'vote_id_example' # Streng |
9opts = {
10 broadcast_id: 'broadcast_id_example', # Streng |
11 sso: 'sso_example' # Streng |
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
Hent api kommentarer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | number | query | No | |
| count | number | query | No | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| sorts | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: ModerationAPIGetCommentsResponse
Eksempel
get_api_comments Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 page: 1.2, # Float |
9 count: 1.2, # Float |
10 text_search: 'text_search_example', # String |
11 by_ip_from_comment: 'by_ip_from_comment_example', # String |
12 filters: 'filters_example', # String |
13 search_filters: 'search_filters_example', # String |
14 sorts: 'sorts_example', # String |
15 demo: true, # Boolean |
16 sso: 'sso_example' # String |
17}
18
19begin
20
21 result = api_instance.get_api_comments(tenant_id, opts)
22 p result
23rescue FastCommentsClient::ApiError => e
24 puts "Error when calling ModerationApi->get_api_comments: #{e}"
25end
26
Hent api export status
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationExportStatusResponse
Eksempel
get_api_export_status Eksempel
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
Hent api ids
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Respons
Returnerer: ModerationAPIGetCommentIdsResponse
Eksempel
get_api_ids Eksempel
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 "Fejl ved kald af ModerationApi->get_api_ids: #{e}"
23end
24
Hent ban brugere fra kommentar
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Svar
Returnerer: GetBannedUsersFromCommentResponse
Eksempel
get_ban_users_from_comment Eksempel
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
Hent kommentar ban status
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentBanStatusResponse
Eksempel
get_comment_ban_status Eksempel
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
Hent kommentar børn
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: ModerationAPIChildCommentsResponse
Eksempel
get_comment_children Eksempel
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
Hent antal
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filter | string | query | Nej | |
| searchFilters | string | query | Nej | |
| demo | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICountCommentsResponse
Eksempel
get_count Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 text_search: 'text_search_example', # String |
9 by_ip_from_comment: 'by_ip_from_comment_example', # String |
10 filter: 'filter_example', # String |
11 search_filters: 'search_filters_example', # String |
12 demo: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.get_count(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling ModerationApi->get_count: #{e}"
22end
23
Hent antal
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: GetBannedUsersCountResponse
Eksempel
get_counts Eksempel
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
Hent logfiler
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Response
Returnerer: ModerationAPIGetLogsResponse
Eksempel
get_logs Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8opts = {
9 sso: 'sso_example' # String |
10}
11
12begin
13
14 result = api_instance.get_logs(tenant_id, comment_id, opts)
15 p result
16rescue FastCommentsClient::ApiError => e
17 puts "Error when calling ModerationApi->get_logs: #{e}"
18end
19
Hent manuelle badges
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetTenantManualBadgesResponse
Eksempel
get_manual_badges Eksempel
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
Hent manuelle badges for bruger
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nej | |
| commentId | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: GetUserManualBadgesResponse
Eksempel
get_manual_badges_for_user Eksempel
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
Hent moderations kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nej | |
| includeIP | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPICommentResponse
Eksempel
get_moderation_comment Eksempel
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
Hent moderations kommentar tekst
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentTextResponse
Eksempel
get_moderation_comment_text Eksempel
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
Hent pre ban resumé
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: PreBanSummary
Eksempel
get_pre_ban_summary Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # Streng |
7comment_id = 'comment_id_example' # Streng |
8opts = {
9 include_by_user_id_and_email: true, # Boolesk |
10 include_by_ip: true, # Boolesk |
11 include_by_email_domain: true, # Boolesk |
12 sso: 'sso_example' # Streng |
13}
14
15begin
16
17 result = api_instance.get_pre_ban_summary(tenant_id, comment_id, opts)
18 p result
19rescue FastCommentsClient::ApiError => e
20 puts "Error when calling ModerationApi->get_pre_ban_summary: #{e}"
21end
22
Hent søge kommentarer resumé
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationCommentSearchResponse
Eksempel
get_search_comments_summary Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 value: 'value_example', # String |
9 filters: 'filters_example', # String |
10 search_filters: 'search_filters_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.get_search_comments_summary(tenant_id, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->get_search_comments_summary: #{e}"
20end
21
Hent søge sider
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationPageSearchResponse
Eksempel
get_search_pages Eksempel
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
Hent søge sites
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: ModerationSiteSearchResponse
Eksempel
get_search_sites Eksempel
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
Hent søge forslag
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationSuggestResponse
Eksempel
get_search_suggest Eksempel
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
Hent søge brugere
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationUserSearchResponse
Eksempel
get_search_users Eksempel
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
Hent tillidsfaktor
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserTrustFactorResponse
Eksempel
get_trust_factor Eksempel
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
Hent bruger ban præference
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: APIModerateGetUserBanPreferencesResponse
Eksempel
get_user_ban_preference Eksempel
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 "Fejl ved kald af ModerationApi->get_user_ban_preference: #{e}"
17end
18
Hent bruger intern profil
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserInternalProfileResponse
Eksempel
get_user_internal_profile Eksempel
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 juster kommentar stemmer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: AdjustVotesResponse
Eksempel
post_adjust_comment_votes Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::ModerationApi.new
6tenant_id = 'tenant_id_example' # String |
7comment_id = 'comment_id_example' # String |
8adjust_comment_votes_params = FastCommentsClient::AdjustCommentVotesParams.new({adjust_vote_amount: 3.56}) # AdjustCommentVotesParams |
9opts = {
10 broadcast_id: 'broadcast_id_example', # String |
11 sso: 'sso_example' # String |
12}
13
14begin
15
16 result = api_instance.post_adjust_comment_votes(tenant_id, comment_id, adjust_comment_votes_params, opts)
17 p result
18rescue FastCommentsClient::ApiError => e
19 puts "Error when calling ModerationApi->post_adjust_comment_votes: #{e}"
20end
21
Post api export
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nej | |
| byIPFromComment | string | query | Nej | |
| filters | string | query | Nej | |
| searchFilters | string | query | Nej | |
| sorts | string | query | Nej | |
| sso | string | query | Nej |
Respons
Returnerer: ModerationExportResponse
Eksempel
post_api_export Eksempel
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 "Fejl ved kald af ModerationApi->post_api_export: #{e}"
22end
23
Post ban bruger fra kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| banEmail | boolean | query | Nej | |
| banEmailDomain | boolean | query | Nej | |
| banIP | boolean | query | Nej | |
| deleteAllUsersComments | boolean | query | Nej | |
| bannedUntil | string | query | Nej | |
| isShadowBan | boolean | query | Nej | |
| updateId | string | query | Nej | |
| banReason | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: BanUserFromCommentResult
Eksempel
post_ban_user_from_comment Eksempel
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 "Fejl ved kald af ModerationApi->post_ban_user_from_comment: #{e}"
26end
27
Post fjern ban bruger
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
post_ban_user_undo Eksempel
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 resumé
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Svar
Returnerer: BulkPreBanSummary
Eksempel
post_bulk_pre_ban_summary Eksempel
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 kommentarer efter ids
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ModerationAPIChildCommentsResponse
Eksempel
post_comments_by_ids Eksempel
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 markér kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
post_flag_comment Eksempel
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 fjern kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returns: PostRemoveCommentApiResponse
Eksempel
post_remove_comment Eksempel
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 gendan slettet kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
post_restore_deleted_comment Eksempel
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 sæt kommentar godkendelsesstatus
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: SetCommentApprovedResponse
Eksempel
post_set_comment_approval_status Eksempel
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 sæt kommentar gennemgangsstatus
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
post_set_comment_review_status Eksempel
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 sæt kommentar spam status
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| spam | boolean | query | Nej | |
| permNotSpam | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
post_set_comment_spam_status Eksempel
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 sæt kommentar tekst
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: SetCommentTextResponse
Eksempel
post_set_comment_text Eksempel
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 fjern markering kommentar
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
post_un_flag_comment Eksempel
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 stemme
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| direction | string | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteResponse
Eksempel
post_vote Eksempel
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 tildel badge
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: AwardUserBadgeResponse
Eksempel
put_award_badge Eksempel
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 luk tråd
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
put_close_thread Eksempel
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 fjern badge
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgeId | string | query | Ja | |
| userId | string | query | Nej | |
| commentId | string | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: RemoveUserBadgeResponse
Eksempel
put_remove_badge Eksempel
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 genåbn tråd
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
put_reopen_thread Eksempel
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
Sæt tillidsfaktor
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: SetUserTrustFactorResponse
Eksempel
set_trust_factor Eksempel
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
Opret moderator
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Returnerer: CreateModeratorResponse
Eksempel
create_moderator Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet moderator
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på delete_moderator
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommenteringen af følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent moderator
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetModeratorResponse
Eksempel
Eksempel på get_moderator
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent moderatorer
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Respons
Returnerer: GetModeratorsResponse
Eksempel
get_moderators Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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 invitation
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
send_invite Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater moderator
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIEmptyResponse
Eksempel
update_moderator Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer autorisation for API-nøgle: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Slet notifikationsantal
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på delete_notification_count
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent cachet notifikationsantal
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetCachedNotificationCountResponse
Eksempel
get_cached_notification_count Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent notifikationsantal
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| urlId | string | query | Nej | |
| fromCommentId | string | query | Nej | |
| viewed | boolean | query | Nej | |
| type | string | query | Nej |
Svar
Returnerer: GetNotificationCountResponse
Eksempel
get_notification_count Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent notifikationer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| urlId | string | query | Nej | |
| fromCommentId | string | query | Nej | |
| viewed | boolean | query | Nej | |
| type | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetNotificationsResponse
Eksempel
get_notifications Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater notifikation
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_notification Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af godkendelse
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret v1 side reaktion
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel
create_v1_page_react Eksempel
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 "Fejl ved kald til PublicApi->create_v1_page_react: #{e}"
18end
19
Opret v2 side reaktion
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nej |
Svar
Returnerer: CreateV1PageReact
Eksempel
create_v2_page_react Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8id = 'id_example' # String |
9opts = {
10 title: 'title_example' # String |
11}
12
13begin
14
15 result = api_instance.create_v2_page_react(tenant_id, url_id, id, opts)
16 p result
17rescue FastCommentsClient::ApiError => e
18 puts "Error when calling PublicApi->create_v2_page_react: #{e}"
19end
20
Slet v1 side reaktion
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: CreateV1PageReact
Eksempel
Eksempel på delete_v1_page_react
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.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
Slet v2 side reaktion
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Svar
Returnerer: CreateV1PageReact
Eksempel
delete_v2_page_react Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8id = 'id_example' # String |
9
10begin
11
12 result = api_instance.delete_v2_page_react(tenant_id, url_id, id)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->delete_v2_page_react: #{e}"
16end
17
Hent v1 side likes
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| urlId | string | forespørgsel | Ja |
Svar
Returnerer: GetV1PageLikes
Eksempel
get_v1_page_likes Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id = 'url_id_example' # String |
8
9begin
10
11 result = api_instance.get_v1_page_likes(tenant_id, url_id)
12 p result
13rescue FastCommentsClient::ApiError => e
14 puts "Error when calling PublicApi->get_v1_page_likes: #{e}"
15end
16
Hent v2 side reaktion brugere
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| urlId | string | forespørgsel | Ja | |
| id | string | forespørgsel | Ja |
Svar
Returnerer: GetV2PageReactUsersResponse
Eksempel
get_v2_page_react_users Eksempel
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
Hent v2 side reaktioner
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetV2PageReacts
Eksempel
get_v2_page_reacts Eksempel
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
Tilføj side
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddPageAPIResponse
Eksempel
add_page Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: 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 |
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
Slet side
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: DeletePageAPIResponse
Eksempel
delete_page Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentar-tegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent offline brugere
Tidligere kommentatorer på siden, som IKKE er online lige nu. Sorteret efter displayName. Brug dette efter at have udtømt /users/online for at gengive en "Medlemmer"-sektion. Cursor-paginering på commenterName: serveren gennemgår den delvise {tenantId, urlId, commenterName} indekser fra afterName fremad via $gt, ingen $skip-omkostning.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Side-URL-identifikator (renset på serversiden). |
| afterName | string | query | No | Cursor: send nextAfterName fra det forrige svar. |
| afterUserId | string | query | No | Cursor tiebreaker: send nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så navne-ligheder ikke udelader poster. |
Response
Returnerer: PageUsersOfflineResponse
Example
Eksempel på get_offline_users
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 | Side-URL-identifikator (renset på serversiden).
8opts = {
9 after_name: 'after_name_example', # String | Cursor: send nextAfterName fra det forrige svar.
10 after_user_id: 'after_user_id_example' # String | Cursor tiebreaker: send nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så navne-ligheder ikke udelader poster.
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
Hent online brugere
Nuværende online-seere af en side: personer hvis websocket-session er tilmeldt siden lige nu. Returnerer anonCount + totalCount (abonnenter for hele rummet, inklusive anonyme seere, som vi ikke opremser).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Side-URL-identifikator (renset på serversiden). |
| afterName | string | query | No | Cursor: angiv nextAfterName fra det forrige svar. |
| afterUserId | string | query | No | Cursor tiebreaker: angiv nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så poster med samme navn ikke bliver udeladt. |
Response
Returnerer: PageUsersOnlineResponse
Example
get_online_users Eksempel
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 | Side-URL-identifikator (renset på serversiden).
8opts = {
9 after_name: 'after_name_example', # String | Cursor: angiv nextAfterName fra det forrige svar.
10 after_user_id: 'after_user_id_example' # String | Cursor tiebreaker: angiv nextAfterUserId fra det forrige svar. Påkrævet når afterName er angivet, så poster med samme navn ikke bliver udeladt.
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
Hent side efter urlid
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetPageByURLIdAPIResponse
Eksempel
get_page_by_urlid Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Hent sider
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetPagesAPIResponse
Eksempel
get_pages Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent sider (offentlig)
Lister sider for en tenant. Bruges af FChat desktop-klienten til at udfylde dens rumliste.
Kræver, at enableFChat er true i den resulterende tilpassede konfiguration for hver side.
Sider, der kræver SSO, filtreres i forhold til den anmodende brugers gruppeadgang.
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| cursor | string | query | Nej | Opak pagineringscursor returneret som nextCursor fra en tidligere anmodning. Knyttet til samme sortBy. |
| limit | integer | query | Nej | 1..200, standard 50 |
| q | string | query | Nej | Valgfrit case-insensitivt titelpræfiksfilter. |
| sortBy | string | query | Nej | Sorteringsrækkefølge. updatedAt (standard, nyeste først), commentCount (flest kommentarer først), eller title (alfabetisk). |
| hasComments | boolean | query | Nej | Hvis true, returner kun sider med mindst én kommentar. |
Svar
Returnerer: GetPublicPagesResponse
Eksempel
get_pages_public Eksempel
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 pagineringscursor returneret som `nextCursor` fra en tidligere anmodning. Knyttet til samme `sortBy`.
9 limit: 56, # Integer | 1..200, standard 50
10 q: 'q_example', # String | Valgfrit case-insensitivt titelpræfiksfilter.
11 sort_by: FastCommentsClient::PagesSortBy::UPDATED_AT, # PagesSortBy | Sorteringsrækkefølge. `updatedAt` (standard, nyeste først), `commentCount` (flest kommentarer først), eller `title` (alfabetisk).
12 has_comments: true # Boolean | Hvis `true`, returner kun sider med mindst én kommentar.
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
Hent bruger info
Bulk-brugerinfo for en tenant. Givet userIds returneres visningsinfo fra User / SSOUser. Bruges af kommentar-widgeten til at berige brugere, der netop er dukket op via en presence-hændelse. Ingen sidesammenhæng: privatliv håndhæves ensartet (private profiler er maskeret).
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| ids | string | query | Ja | Komma-separerede userIds. |
Response
Returnerer: PageUsersInfoResponse
Eksempel
get_users_info Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7ids = 'ids_example' # String | Komma-separerede 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 side
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: PatchPageAPIResponse
Eksempel
patch_page Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet afventende webhook-hændelse
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på delete_pending_webhook_event
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. '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_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
Hent afventende webhook-hændelse antal
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| externalId | string | query | Nej | |
| eventType | string | query | Nej | |
| type | string | query | Nej | |
| domain | string | query | Nej | |
| attemptCountGT | number | query | Nej |
Svar
Returnerer: GetPendingWebhookEventCountResponse
Eksempel
get_pending_webhook_event_count Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer autorisation med API-nøgle: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren foran den følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Hent afventende webhook-hændelser
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| externalId | string | query | Nej | |
| eventType | string | query | Nej | |
| type | string | query | Nej | |
| domain | string | query | Nej | |
| attemptCountGT | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetPendingWebhookEventsResponse
Eksempel
get_pending_webhook_events Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer godkendelse med API-nøgle: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret spørgsmål konfiguration
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionConfigResponse
Eksempel
create_question_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet spørgsmål konfiguration
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_question_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent spørgsmål konfiguration
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionConfigResponse
Eksempel
get_question_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Hent spørgsmål konfigurationer
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionConfigsResponse
Eksempel
get_question_configs Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater spørgsmål konfiguration
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_question_config Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Opret spørgsmål resultat
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionResultResponse
Eksempel
create_question_result Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet spørgsmål resultat
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_question_result Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: 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_question_result(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_question_result: #{e}"
22end
23
Hent spørgsmål resultat
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionResultResponse
Eksempel
get_question_result Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent spørgsmål resultater
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nej | |
| userId | string | query | Nej | |
| startDate | string | query | Nej | |
| questionId | string | query | Nej | |
| questionIds | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionResultsResponse
Eksempel
get_question_results Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater spørgsmål resultat
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_question_result Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Aggregere spørgsmål resultater
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| questionId | string | query | No | |
| questionIds | array | query | No | |
| urlId | string | query | No | |
| timeBucket | string | query | No | |
| startDate | string | query | No | |
| forceRecalculate | boolean | query | No |
Svar
Returnerer: AggregateQuestionResultsResponse
Eksempel
aggregate_question_results Example
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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 aggregere spørgsmål resultater
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: BulkAggregateQuestionResultsResponse
Eksempel
bulk_aggregate_question_results Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Kombiner kommentarer med spørgsmål resultater
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nej | |
| questionIds | array | query | Nej | |
| urlId | string | query | Nej | |
| startDate | string | query | Nej | |
| forceRecalculate | boolean | query | Nej | |
| minValue | number | query | Nej | |
| maxValue | number | query | Nej | |
| limit | number | query | Nej |
Svar
Returnerer: CombineQuestionResultsWithCommentsResponse
Eksempel
combine_comments_with_question_results Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Tilføj sso bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: AddSSOUserAPIResponse
Eksempel
Eksempel på add_sso_user
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-autorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet sso bruger
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: DeleteSSOUserAPIResponse
Eksempel
delete_sso_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentarstegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent sso bruger efter email
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Svar
Returnerer: GetSSOUserByEmailAPIResponse
Eksempel
get_sso_user_by_email Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentar fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent sso bruger efter id
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetSSOUserByIdAPIResponse
Eksempel
get_sso_user_by_id Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Hent sso brugere
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nej |
Respons
Returnerer: GetSSOUsersResponse
Eksempel
get_sso_users Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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 bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PatchSSOUserAPIResponse
Eksempel
patch_sso_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommenteringen af følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Indsæt sso bruger
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PutSSOUserAPIResponse
Eksempel
put_sso_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentareringen af følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret abonnement
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateSubscriptionAPIResponse
Eksempel
create_subscription Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
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 |
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
Slet abonnement
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Respons
Returnerer: DeleteSubscriptionAPIResponse
Eksempel
delete_subscription Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Hent abonnementer
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetSubscriptionsAPIResponse
Eksempel
get_subscriptions Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater abonnement
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Response
Returnerer: UpdateSubscriptionAPIResponse
Eksempel
update_subscription Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent lejer daglige brug
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nej | |
| monthNumber | number | query | Nej | |
| dayNumber | number | query | Nej | |
| skip | number | query | Nej |
Respons
Returnerer: GetTenantDailyUsagesResponse
Eksempel
get_tenant_daily_usages Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. '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 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
Opret lejer pakke
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateTenantPackageResponse
Eksempel
create_tenant_package Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet lejer pakke
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_tenant_package Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent lejer pakke
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: GetTenantPackageResponse
Eksempel
get_tenant_package Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API key-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API key, f.eks. 'Bearer' (standard er 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
Hent lejer pakker
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantPackagesResponse
Eksempel
get_tenant_packages Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Erstat lejer pakke
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIEmptyResponse
Eksempel
replace_tenant_package Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater lejer pakke
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på update_tenant_package
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Opret lejer bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Returnerer: CreateTenantUserResponse
Eksempel
create_tenant_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet lejer bruger
Parametre
| Navn | Type | Placering | Obligatorisk | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på delete_tenant_user
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren af følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent lejer bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: GetTenantUserResponse
Eksempel
get_tenant_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent lejer brugere
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Respons
Returnerer: GetTenantUsersResponse
Eksempel
Eksempel på get_tenant_users
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Erstat lejer bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
replace_tenant_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Send login link
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
Eksempel på send_login_link
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentarstegnet fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater lejer bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
update_tenant_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret lejer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Returnerer: CreateTenantResponse
Eksempel
create_tenant Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet lejer
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nej |
Svar
Returnerer: APIEmptyResponse
Eksempel
delete_tenant Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-autorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks til API-nøglen, f.eks. 'Bearer' (standard er 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
Hent lejer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetTenantResponse
Eksempel
get_tenant Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer autorisation via API-nøgle: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommenteringen af følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent lejere
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantsResponse
Eksempel
get_tenants Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater lejer
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: APIEmptyResponse
Eksempel
update_tenant Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-autorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Ændr ticket status
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: ChangeTicketStateResponse
Eksempel
change_ticket_state Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentar fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret ticket
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Svar
Returnerer: CreateTicketResponse
Eksempel
create_ticket Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent ticket
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetTicketResponse
Eksempel
get_ticket Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent billetter
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| state | number | query | Nej | |
| skip | number | query | Nej | |
| limit | number | query | Nej |
Svar
Returnerer: GetTicketsResponse
Eksempel
get_tickets Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentar fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er nil)
9 # config.api_key_prefix['x-api-key'] = 'Bearer'
10end
11
12api_instance = FastCommentsClient::DefaultApi.new
13tenant_id = 'tenant_id_example' # String |
14opts = {
15 user_id: 'user_id_example', # String |
16 state: 1.2, # Float |
17 skip: 1.2, # Float |
18 limit: 1.2 # Float |
19}
20
21begin
22
23 result = api_instance.get_tickets(tenant_id, opts)
24 p result
25rescue FastCommentsClient::ApiError => e
26 puts "Error when calling DefaultApi->get_tickets: #{e}"
27end
28
Hent oversættelser
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nej | |
| useFullTranslationIds | boolean | query | Nej |
Respons
Returnerer: GetTranslationsResponse
Eksempel
get_translations Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6namespace = 'namespace_example' # Streng |
7component = 'component_example' # Streng |
8opts = {
9 locale: 'locale_example', # Streng |
10 use_full_translation_ids: true # Boolesk |
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 billede
Upload og ændre størrelse på et billede
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nej | Størrelsesforindstilling: "Default" (1000x1000px) eller "CrossPlatform" (opretter størrelser til populære enheder) |
| urlId | string | query | Nej | Side-id som uploaden sker fra, til konfiguration |
Svar
Returnerer: UploadImageResponse
Eksempel
upload_image Eksempel
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 | Størrelsesforindstilling: \"Default\" (1000x1000px) eller \"CrossPlatform\" (opretter størrelser til populære enheder)
10 url_id: 'url_id_example' # String | Side-id som uploaden sker fra, til konfiguration
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
Hent bruger badge fremdrift efter id
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel
get_user_badge_progress_by_id Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren foran følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent bruger badge fremdrift efter bruger id
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Svar
Returnerer: APIGetUserBadgeProgressResponse
Eksempel
get_user_badge_progress_by_user_id Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent bruger badge fremdrift liste
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| limit | number | query | Nej | |
| skip | number | query | Nej |
Response
Returnerer: APIGetUserBadgeProgressListResponse
Eksempel
get_user_badge_progress_list Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opret bruger badge
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: APICreateUserBadgeResponse
Eksempel
create_user_badge Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet bruger badge
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel
delete_user_badge Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Configure API key authorization: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. '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_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->delete_user_badge: #{e}"
22end
23
Hent bruger badge
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: APIGetUserBadgeResponse
Eksempel
get_user_badge Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: 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_user_badge(tenant_id, id)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling DefaultApi->get_user_badge: #{e}"
22end
23
Hent bruger badges
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| badgeId | string | query | Nej | |
| type | number | query | Nej | |
| displayedOnComments | boolean | query | Nej | |
| limit | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: APIGetUserBadgesResponse
Eksempel
get_user_badges Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisering: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren på følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Opdater bruger badge
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: APIEmptySuccessResponse
Eksempel
Eksempel på update_user_badge
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentartegnet på følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent bruger notifikationsantal
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserNotificationCountResponse
Eksempel
get_user_notification_count Eksempel
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
Hent bruger notifikationer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nej | Bruges til at afgøre, om den nuværende side er abonneret. |
| pageSize | integer | query | Nej | |
| afterId | string | query | Nej | |
| includeContext | boolean | query | Nej | |
| afterCreatedAt | integer | query | Nej | |
| unreadOnly | boolean | query | Nej | |
| dmOnly | boolean | query | Nej | |
| noDm | boolean | query | Nej | |
| includeTranslations | boolean | query | Nej | |
| includeTenantNotifications | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetMyNotificationsResponse
Eksempel
get_user_notifications Eksempel
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 | Bruges til at afgøre, om den nuværende side er abonneret.
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
Nulstil bruger notifikationsantal
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: ResetUserNotificationsResponse
Eksempel
reset_user_notification_count Eksempel
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
Nulstil bruger notifikationer
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| afterCreatedAt | integer | query | Nej | |
| unreadOnly | boolean | query | Nej | |
| dmOnly | boolean | query | Nej | |
| noDm | boolean | query | Nej | |
| sso | string | query | Nej |
Response
Returnerer: ResetUserNotificationsResponse
Eksempel
reset_user_notifications Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7opts = {
8 after_id: 'after_id_example', # String |
9 after_created_at: 789, # Integer |
10 unread_only: true, # Boolean |
11 dm_only: true, # Boolean |
12 no_dm: true, # Boolean |
13 sso: 'sso_example' # String |
14}
15
16begin
17
18 result = api_instance.reset_user_notifications(tenant_id, opts)
19 p result
20rescue FastCommentsClient::ApiError => e
21 puts "Error when calling PublicApi->reset_user_notifications: #{e}"
22end
23
Opdater bruger notifikation kommentar abonnementsstatus
Aktiver eller deaktiver notifikationer for en bestemt kommentar.
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationCommentSubscriptionStatusResponse
Eksempel
update_user_notification_comment_subscription_status Eksempel
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
Opdater bruger notifikation side abonnementsstatus
Aktivér eller deaktiver notifikationer for en side. Når brugere er abonneret på en side, oprettes der notifikationer for nye rodkommentarer, og også
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationPageSubscriptionStatusResponse
Eksempel
update_user_notification_page_subscription_status Eksempel
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
Opdater bruger notifikation status
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja | |
| notificationId | string | sti | Ja | |
| newStatus | string | sti | Ja | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: UpdateUserNotificationStatusResponse
Eksempel
update_user_notification_status Eksempel
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
Hent bruger tilstedeværelsesstatusser
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Respons
Returnerer: GetUserPresenceStatusesResponse
Eksempel
get_user_presence_statuses Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4
5api_instance = FastCommentsClient::PublicApi.new
6tenant_id = 'tenant_id_example' # String |
7url_id_ws = 'url_id_ws_example' # String |
8user_ids = 'user_ids_example' # String |
9
10begin
11
12 result = api_instance.get_user_presence_statuses(tenant_id, url_id_ws, user_ids)
13 p result
14rescue FastCommentsClient::ApiError => e
15 puts "Error when calling PublicApi->get_user_presence_statuses: #{e}"
16end
17
Søg brugere
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nej | |
| mentionGroupIds | array | query | Nej | |
| sso | string | query | Nej | |
| searchSection | string | query | Nej |
Svar
Returnerer: SearchUsersResult
Eksempel
search_users Eksempel
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
Hent bruger
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetUserResponse
Eksempel
get_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# Opsæt autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgle-godkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Opret stemme
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: VoteResponse
Eksempel
create_vote Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Slet stemme
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nej |
Svar
Returnerer: VoteDeleteResponse
Eksempel
delete_vote-eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsætning af autorisation
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard: 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
Hent stemmer
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Returnerer: GetVotesResponse
Eksempel
get_votes Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøgleautorisation: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at angive et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Hent stemmer for bruger
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: GetVotesForUserResponse
Eksempel
get_votes_for_user Eksempel
Copy
1
2require 'time'
3require 'fastcomments-client'
4# opsæt godkendelse
5FastCommentsClient.configure do |config|
6 # Konfigurer API-nøglegodkendelse: api_key
7 config.api_key['x-api-key'] = 'YOUR API KEY'
8 # Fjern kommentaren fra følgende linje for at sætte et præfiks for API-nøglen, f.eks. 'Bearer' (standard er 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
Brug for hjælp?
Hvis du støder på problemer eller har spørgsmål om Ruby SDK'et, så:
Bidrag
Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.